Difference between revisions of "Device-Node.js SDK"
From ESS-WIKI
Eric.liang (talk | contribs) |
Eric.liang (talk | contribs) |
||
| Line 46: | Line 46: | ||
#Rename the '''Simple-plugin_temp.js''' by your applicaton name | #Rename the '''Simple-plugin_temp.js''' by your applicaton name | ||
| − | #Chang the plugin path in '''config/agent_config.json | + | #Chang the plugin path in '''config/agent_config.json : ''''''<span style="color:#0000FF;">plugin</span>''' |
| − | + | #<span style="color:#0000FF;">'''InitPlugin'''</span>: InitPlugin => Refer < InitTest > in '''Simple-plugin_test.js''' | |
| − | # | + | #<span style="color:#0000FF;">'''AutoReport'''</span>: start auto report interval callback function; Implement to call send data in this=> Refer < AutoUpdateTest > in Simple-plugin_test.js |
| − | #'''InitPlugin''': InitPlugin => Refer < InitTest > in Simple-plugin_test.js | + | #<span style="color:#0000FF;">'''setSenseData'''</span>: DeviceOn server or others apps to set sensor value to the service. This callback function will be called and you need to implement a set function with your application at this. |
| − | #'''AutoReport''': start auto report interval callback function; Implement to call send data in this=> Refer < AutoUpdateTest > in Simple-plugin_test.js | + | #<span style="color:#0000FF;">'''sendEventTest'''</span>: You can refer to "sendEventTest" to trigger a event alarm to local MQTT Broker and transfer to DeviceOn server. |
| − | #'''setSenseData''': DeviceOn server or others apps to set sensor value to the service. This callback function will be called and you need to implement a set function with your application at this. | ||
| − | #'''sendEventTest''': You can refer to "sendEventTest" to trigger a event alarm to local MQTT Broker and transfer to DeviceOn server. | ||
Revision as of 06:06, 1 October 2019
Contents
Introduction
This is a EdgeSense southbound device service SDK in node.js. User can use this SDK to easy to develop your application to integrate with EdgeSense Core System.
Device-Node.js SDK
Requirement
- MQTT broker V1.0.3 ( Ubuntu 16.04 ) / V1.0.4 ( Windows )
- AgentLite-Node.js
- Node.js >= 5.x
How To
Demo
1. == Download == $git clone git@advgitlab.eastasia.cloudapp.azure.com:EdgeSense-Open/device-template-node.js.git 2. == Install packages == $npm install 3. == Run == $node index.js
Development
config
agent_config.json
- DeivceNam: <XXX> Name of application - ServiceType: <xxx> Category of application - Description: A brief description - version: version of application - plugin: path of main entry program => ./module/<xxx>.js
log.json
confinuration of advlog-node.js
http://advgitlab.eastasia.cloudapp.azure.com/EdgeSense-Open/advlog-node.js
Plugin
- Rename the Simple-plugin_temp.js by your applicaton name
- Chang the plugin path in config/agent_config.json : 'plugin'
- InitPlugin: InitPlugin => Refer < InitTest > in Simple-plugin_test.js
- AutoReport: start auto report interval callback function; Implement to call send data in this=> Refer < AutoUpdateTest > in Simple-plugin_test.js
- setSenseData: DeviceOn server or others apps to set sensor value to the service. This callback function will be called and you need to implement a set function with your application at this.
- sendEventTest: You can refer to "sendEventTest" to trigger a event alarm to local MQTT Broker and transfer to DeviceOn server.