Difference between revisions of "Device-Node.js SDK"

From ESS-WIKI
Jump to: navigation, search
(One intermediate revision by the same user not shown)
Line 14: Line 14:
 
== Demo  1, 2, 3 ==
 
== Demo  1, 2, 3 ==
 
<pre>1. == Download ==
 
<pre>1. == Download ==
$git clone git@advgitlab.eastasia.cloudapp.azure.com:EdgeSense-Open/device-template-node.js.git <project name>
+
$git clone git@advgitlab.eastasia.cloudapp.azure.com:EdgeSense-Open/device-template-node.js.git sdk-sample
$cd <project name>
+
$cd sdk-sample
  
 
2. == Install packages ==
 
2. == Install packages ==

Revision as of 09:14, 15 February 2020

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

Pre-Requirement

  • MQTT Broker ( Download ) : Please install the MQTT Broker on target platform.
  • Node.js >= 5.x: Please install above 5.x Nodejs on target platform.

How To

Demo  1, 2, 3

1. == Download ==
$git clone git@advgitlab.eastasia.cloudapp.azure.com:EdgeSense-Open/device-template-node.js.git sdk-sample
$cd sdk-sample

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

  1. Rename the Simple-plugin_temp.js by your applicaton name
  2. Chang the plugin path in config/agent_config.json : 'plugin'
  3. InitPlugin: InitPlugin  => Refer < InitTest > in Simple-plugin_test.js
  4. AutoReport: start auto report interval callback function; Implement to call send data in this=> Refer < AutoUpdateTest > in  Simple-plugin_test.js
  5. 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.
  6. sendEventTest: You can refer to "sendEventTest" to trigger a event alarm to local MQTT Broker and transfer to DeviceOn server.