Skip to content

freebirdjs/freebird-base

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

freebird-base

Base classes used in freebird framework.

NPM

Travis branch npm npm


Documentation

Please visit the Wiki.


Overview

freebird-base provides three base classes used by freebird IoT framework. These classes are abstractions of the network controller, network device, and real appliance, respectively.

Class Description Example
Netcore A network controller responsible for message transportation and network management. A zigbee coordinator or a BLE central controller.
Device A wired/wireless machine in the network. A zigbee end-device, a BLE peripheral, a MQTT client, or a CoAP server(LWM2M client).
Gadget Something specific and functional in our life. A temperature sensor, a light switch, or a barometer.
  • If you are a freebird user, you may only care about the APIs of Device and Gadget classes.
  • If you are a freebird netcore implementer who likes to create a netcore to manage your network with the freebird framework, then Workflow of Designing Your Own Netcore will be a good place for you to start.

Installation

$ npm install freebird-base --save


License

Licensed under MIT.



About

Netcore, Device, and Gadget base classes in freebird.js

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages