Device-Node.js SDK - Revision history

Eric.liang at 03:36, 5 February 2021

2021-02-05T03:36:09Z

Eric.liang at 09:54, 5 January 2021

2021-01-05T09:54:45Z

Eric.liang at 09:51, 5 January 2021

2021-01-05T09:51:16Z

Eric.liang at 09:43, 5 January 2021

2021-01-05T09:43:10Z

Eric.liang at 01:37, 8 May 2020

2020-05-08T01:37:13Z

Eric.liang at 01:34, 8 May 2020

2020-05-08T01:34:41Z

Eric.liang at 01:34, 8 May 2020

2020-05-08T01:34:14Z

Eric.liang at 01:25, 8 May 2020

2020-05-08T01:25:33Z

Eric.liang at 01:24, 8 May 2020

2020-05-08T01:24:26Z

Eric.liang at 01:23, 8 May 2020

2020-05-08T01:23:43Z

@@ Line 21: / Line 21: @@
 . == Run ==
-$node index_plugin.js</pre>
+$node plugin_index.js</pre>
 == Development ==

@@ Line 78: / Line 78: @@
 #Rename the '''[https://gitlab.edgecenter.io/edgesense-open/device-template-node.js/-/blob/master/module/pluginClassTemp.js pluginClassTemp.js]&nbsp;''' by your applicaton name
-#Chang the plugin path in '''config/agent_config.json&nbsp;:&nbsp;''''''<span style="color:#0000FF;">plugin</span>'''
+#Chang the plugin path in index_plugin.js'''&nbsp;:&nbsp;'''var&nbsp;agentplugin&nbsp;=&nbsp;require('./module/pluginClassTest.js');
 #<span style="color:#0000FF;">'''InitPlugin'''</span>: InitPlugin&nbsp; => Refer &lt; InitTest &gt; in '''pluginClassTest.js'''
 #<span style="color:#0000FF;">'''AutoReport'''</span>: start auto report callback function by interval; To implement send data in this function=> Refer &lt; AutoUpdateTest &gt; in&nbsp;&nbsp;Simple-plugin_test.js

@@ Line 21: / Line 21: @@
 . == Run ==
-$node index.js</pre>
+$node index_plugin.js</pre>
 == Development ==

@@ Line 77: / Line 77: @@
 === Plugin ===
-#Rename the '''Simple-plugin_temp.js''' by your applicaton name
+#Rename the '''[https://gitlab.edgecenter.io/edgesense-open/device-template-node.js/-/blob/master/module/pluginClassTemp.js pluginClassTemp.js]&nbsp;''' by your applicaton name
 #Chang the plugin path in '''config/agent_config.json&nbsp;:&nbsp;''''''<span style="color:#0000FF;">plugin</span>'''
-#<span style="color:#0000FF;">'''InitPlugin'''</span>: InitPlugin&nbsp; => Refer &lt; InitTest &gt; in '''Simple-plugin_test.js'''
+#<span style="color:#0000FF;">'''InitPlugin'''</span>: InitPlugin&nbsp; => Refer &lt; InitTest &gt; in '''pluginClassTest.js'''
-#<span style="color:#0000FF;">'''AutoReport'''</span>: start auto report interval callback function; Implement to call send data in this=> Refer &lt; AutoUpdateTest &gt; in&nbsp;&nbsp;Simple-plugin_test.js
+#<span style="color:#0000FF;">'''AutoReport'''</span>: start auto report callback function by interval; To implement send data in this function=> Refer &lt; AutoUpdateTest &gt; in&nbsp;&nbsp;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.
+#<span style="color:#0000FF;">'''setSenseData'''</span>: DeviceOn server or other apps&nbsp;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.
-#<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.
+#<span style="color:#0000FF;">'''sendEvent'''</span>: You can refer to "sendEventTest" in pluginClassTest.js to trigger an event alarm to the local MQTT Broker and transfer to DeviceOn server.
 = Note =
 *If the plugin needs to send&nbsp;OPTS to DeviceOn, OPTS can not be assigned to 0 in plugin's&nbsp;capability. OPTS must&nbsp;set timestamps according to your application.

@@ Line 84: / Line 84: @@
 #<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.
-== Note ==
+= Note =
-*If plugin need to send&nbsp;OPTS to DeviceOn, OPTS can not be assigned to 0 in plugin's&nbsp;capability. OPTS need to use current timestamp.
+*If the plugin needs to send&nbsp;OPTS to DeviceOn, OPTS can not be assigned to 0 in plugin's&nbsp;capability. OPTS must&nbsp;set timestamps according to your application.

@@ Line 29: / Line 29: @@
 ==== agent_config.json ====
 <pre>  - DeivceNam: <XXX> Name of application
-&nbsp; - ServiceType: <xxx> Category of application
+  - ServiceType: <xxx> Category of application
-&nbsp; - Description: A brief description
+  - Description: A brief description
    - version: version of application
    - plugin: path of main entry program => ./module/<xxx>.js
 </pre>

@@ Line 12: / Line 12: @@
 = How To =
-== Demo &nbsp;1,&nbsp;2,&nbsp;3 ==
+== How To Run -&nbsp;SamplePlugin&nbsp;&nbsp;Setp: 1&nbsp;->&nbsp;2 ->&nbsp;3 ==
 <pre>1. == Download ==
 $git clone git@gitlab.edgecenter.io:edgesense-open/device-template-node.js.git sdk-sample

@@ Line 57: / Line 57: @@
 '''Debug Level'''
+<pre>0: NONE
-: NONE
+: ERROR - consloe.error
+: WARN     - console.warn
-=== 2: ERROR - consloe.error ===
+: INFO       - consloe.log ( Default )
+: DEBUG   - consloe.debug
-=== 3: WARN&nbsp; &nbsp; &nbsp;- console.warn ===
+: TRACE    - consloe.trace</pre>
 === Plugin ===