|author||Nikhil Zinjurde <firstname.lastname@example.org>||Wed Sep 07 13:39:30 2016 +0530|
|committer||Nikhil Zinjurde <email@example.com>||Wed Sep 07 13:39:30 2016 +0530|
Add Contributor's guide link in README.md Signed-off-by: Nikhil Zinjurde <firstname.lastname@example.org>
Button gateway application runs on Ci40 board, which acts as a gateway for MikroE boards. One of the MikroE boards acts as awalwm2m client to simulate button, and another one also acts as awalwm2m client to simulate led. Gateway application observes any button presses on former board, and whenever there is a change, gateway application gets a notification for the same, and take further actions. After receiving notification for button change, gateway application
Gateway application serves two purposes:
|Object Name||Object ID||Resource Name||Resource ID|
|Revision||Changes from previous revision|
|0.9.0||External Beta Trial Release|
Prior to running button gateway application, make sure that:
NOTE: Please do "ps" on console to see "specific" process is running or not.
Button Gateway documentation is available as a Doxygen presentation which is generated via the following process.
Install Doxygen :
sudo apt-get install doxygen
Generate the documentation:
$ button-gateway: mkdir build $ button-gateway/build: cd build $ button-gateway/build: cmake ../docs $ button-gateway/build: make docs
The output can be found in the build/html directory and viewed by opening index.html with your web browser.
Button Application is getting started as a daemon. Although we could also start it from the command line as :
Output looks something similar to this :
Button Gateway Application ------------------------ Client session established Server session established Wait until device is provisioned Waiting... Gateway is provisioned. Waiting for config data Waiting for config data Failed to read config file Try to connect to Flow Server for 5 more trials.. Device registration successful Defining flow objects on server Defining flow objects on client Waiting for constrained device 'ButtonDevice' to be up Constrained device ButtonDevice registered Waiting for constrained device 'LedDevice' to be up Constrained device LedDevice registered Written 1 to server. Set 1 on client. Message sent to user = 12:36:10 18-03-2016 LED on Written 0 to server. Set 0 on client. Message sent to user = 12:36:11 18-03-2016 LED off
We welcome all contributions to this project and we give credit where it's due. Anything from enhancing functionality to improving documentation and bug reporting - it's all good.
For more details about the Contributor's guidelines, refer to the contributor guide.