Giter VIP home page Giter VIP logo

rdkcentral / zilker-sdk Goto Github PK

View Code? Open in Web Editor NEW
3.0 8.0 7.0 2.22 MB

The zilker-sdk component provides various services for an IoT framework to have the specific functionalities that can be accessed via APIs. Most of these services consume and generate events that any process can listen for.

License: Apache License 2.0

CMake 3.06% Shell 1.59% Groovy 0.03% C 77.02% C++ 0.04% JavaScript 0.29% Java 17.81% Makefile 0.05% FreeMarker 0.12%

zilker-sdk's Introduction

Overview

This project is an SDK that can compile and run, however requires cloud connectivity and actual device integrations (Zigbee, BLE, Z-Wave, etc).

To create a working solution, the SDK consumer would:

  • Implement a 'channel' (in commService) to connect to their cloud and translate our internal device data model and service control.
  • Implement some device subsystems to deviceService and corresponding device drivers. This SDK includes device drivers which sit upon ZHAL (Zigbee Hardware Abstraction Layer) to aid in the that effort.

Directory structure:

  • 3rdParty : 3rd-party dependencies
  • branding : default and customer-specific configuration/settings
  • buildTools : build configurations for cmake
  • source : core source-code tree
  • tools : helpers & generators local to this tree

Refer to README files within the respective areas for additional building details.

Architecture

arch

Eash Service provides a layer of functionality that can be accessed via an api (generated code). Most services consume and produce events (generated code) that any process can listen for.

  • automation : Leverage littlesheens https://github.com/Comcast/littlesheens.git to invoke actions based upon events.

  • backupRestore : Periodically create a tarball of local configuration data so it can be stored externally (ideally the cloud). In the event of a restore, this will expand the tarball and inform each service of the location of the old configuration for importing.

  • comm : Communication layer to the cloud. Supports the concept of multiple channels to allow one or more cloud couplings.

  • device : Interaction with various devices (Zigbee, BLE, Wifi, etc).

  • props : Store and maintain Key/Value pairs for runtime options or basic configuration.

  • rdkIntegration : Listen for events from the RDK dbus

  • watchdog : Launch processes, restart them on failure

  • ipcGenerator : Not a service, but a utility to generate the API layers of services (IPC and Events).

  • ZITH : Not a service, but a utility that provides a mocked zigbee controller.

Additional Resources

  • Refer to the BUILDING.md file for details on setting up the environment and building the source code
  • See GUIDE.md for a step-by-step guide to using and testing this SDK

zilker-sdk's People

Contributors

scthunderbolt avatar jelderton avatar

Stargazers

erfeng avatar  avatar  avatar

Watchers

James Cloos avatar Micah Koch avatar LE COZ Cedric avatar rdkcmf avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.