Difference between revisions of "IoTGateway/SDK"

From ESS-WIKI
Jump to: navigation, search
(Creating a New Network Type)
(Overview)
 
(13 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
=Overview=
 
=Overview=
:This tutorial is designed for software programmers who want to learn the basics of '''''WSN API SDK''''' and its architectural concepts. <br />
+
:This tutorial is designed for software programmers who want to learn the basics of '''''WSN API SDK''''' and its architectural concepts. This tutorial will give you enough understanding on all the necessary components of '''''WSN API SDK''''' with suitable examples.
This tutorial will give you enough understanding on all the necessary components of '''''WSN API SDK''''' with suitable examples.
 
 
<br /><br />
 
<br /><br />
  
 
[[File:WsnAPIFramework.jpg|500x350px|WSN API Software Stack]]
 
[[File:WsnAPIFramework.jpg|500x350px|WSN API Software Stack]]
  
 +
=Documentation=
 +
[[IoTGateway/SDK/WirelessSensorNetworkSDK|'''<big><big>Advantech Sensor Format in JSON</big></big>''']]
 +
<br />
 +
 +
=Install WSN SDK=
 +
You can get the latest Wireless Sensor Network Software Development Kit(SDK)  version from:
 +
*[[WISE-3310/IoTGwWSNSDKDownload|WSN API SDK for WISE-3310]]
 +
 +
1. Copy the WSN SDK to your Target Device ( ex: WISE-3310 )
 +
 +
2. Unzip the SDK
 +
    #unzip sennet-wise_3310-1.2.00.0280.zip
 +
    [[File:Installation WSN SDK 1.jpg|761×73px|unzip]]
  
 +
3. To install the wsn sdk & select target folder ( Recommend use the Default "/usr/lib/" setting <- Enter )
 +
    #./sennet-wise_3310-1.2.00.0280.run
 +
    [[File:Installation WSN SDK 2.jpg|761×99px|installer]]
  
=Documentation=
+
4. Completed the Installation
[[IoTGateway/SDK/WirelessSensorNetworkSDK|'''<big><big>Wireless Sensor Network (WSN) API SDK</big></big>''']]
+
    [[File:Installation WSN SDK 3.jpg|761×772px|Completed]]
  
<br />
+
5. You can then run the wsn demo application
 +
    #sampleSNManagerAPI
 +
    [[File:Installation WSN SDK 4.jpg|745×665px|sample]]
  
=Getting Started=
 
 
[[IoTGateway/SDK/InstallationOfWsnSDK|'''<big><big>Installation of Wireless Sensor Network (WSN) SDK</big></big>''']]
 
[[IoTGateway/SDK/InstallationOfWsnSDK|'''<big><big>Installation of Wireless Sensor Network (WSN) SDK</big></big>''']]
 
<br /><br />
 
<br /><br />
  
=Using WSN API SDK=
+
=Sample Code Use Case=
[[IoTGateway/SDK/SampleCodeOfWsnSDK|'''<big><big>Sample Code of WSN API SDK</big></big>''']]
+
==Sample Code of WSN API SDK==
<br /><br />
+
=Note=
 +
'''Please disable "cagnet" to run the sample code. Because the COM port can be used by one program only.'''
 +
#/ect/init.d/saagent stop
 +
 
 +
=Abstrac=
 +
The following example shows how to use the '''"WSN API SDK"'''.  The sample code for the command line tool to perform get/set IoT gateway(WISE-3310) and Sensor Hub(WISE-1020)s' status.
 +
 
 +
=Sample Code=
 +
[[IoTGW/WSNApiSDK/SampleCode/C|Sample Code]] demonstrates how to use the WSN API SDK to manage IoTGW and Sensor Hubs.
 +
 
 +
 
 +
[[IoTGW/SDK/SampleCodeUseCase|'''<big><big>Use Case</big></big>''']]
 +
==Sample Code of WSN APIMux SDK==
 +
'''<big><big>Abstrac</big></big>'''<br />
 +
 
 +
The following example shows how to use the '''"WSN APIMux SDK"'''.  The sample code for the command line tool to perform get/set IoT gateway(WISE-3310) and Sensor Hub(WISE-1020)s' status.<br />
 +
WSN APIMux SDK only supports '''SN_Manager_GetData''' and '''SN_Manager_SetData''' two functions.
 +
 
 +
 
 +
=Sample Code=
 +
[[IoTGW/WSNApiMuxSDK/SampleCode/C|Sample Code]] demonstrates how to use the WSN API Mux SDK to manage IoTGW and Sensor Hubs.
 +
 
 +
=Sample Code Use Case=
 +
[[IoTGW/SDK/APIMuxSampleCodeUseCase|'''<big><big>Use Case</big></big>''']]
  
 
=Creating a New Network Type=
 
=Creating a New Network Type=

Latest revision as of 03:17, 18 August 2016

Overview

This tutorial is designed for software programmers who want to learn the basics of WSN API SDK and its architectural concepts. This tutorial will give you enough understanding on all the necessary components of WSN API SDK with suitable examples.



WSN API Software Stack

Documentation

Advantech Sensor Format in JSON

Install WSN SDK

You can get the latest Wireless Sensor Network Software Development Kit(SDK) version from:

1. Copy the WSN SDK to your Target Device ( ex: WISE-3310 )
2. Unzip the SDK 
   #unzip sennet-wise_3310-1.2.00.0280.zip
   unzip
3. To install the wsn sdk & select target folder ( Recommend use the Default "/usr/lib/" setting <- Enter )
   #./sennet-wise_3310-1.2.00.0280.run
   installer
4. Completed the Installation
   Completed
5. You can then run the wsn demo application
   #sampleSNManagerAPI
    sample

Installation of Wireless Sensor Network (WSN) SDK

Sample Code Use Case

Sample Code of WSN API SDK

Note

Please disable "cagnet" to run the sample code. Because the COM port can be used by one program only.
#/ect/init.d/saagent stop

Abstrac

The following example shows how to use the "WSN API SDK". The sample code for the command line tool to perform get/set IoT gateway(WISE-3310) and Sensor Hub(WISE-1020)s' status.

Sample Code

Sample Code demonstrates how to use the WSN API SDK to manage IoTGW and Sensor Hubs.


Use Case

Sample Code of WSN APIMux SDK

Abstrac

The following example shows how to use the "WSN APIMux SDK". The sample code for the command line tool to perform get/set IoT gateway(WISE-3310) and Sensor Hub(WISE-1020)s' status.
WSN APIMux SDK only supports SN_Manager_GetData and SN_Manager_SetData two functions.


Sample Code

Sample Code demonstrates how to use the WSN API Mux SDK to manage IoTGW and Sensor Hubs.

Sample Code Use Case

Use Case

Creating a New Network Type

Network Abstraction Layer Interface