Eric.liang at 05:46, 19 June 2018

2018-06-19T05:46:05Z

Eric.liang at 05:45, 19 June 2018

2018-06-19T05:45:51Z

Eric.liang: Created page with "= Introduction = :WiseSnail is the short name of Wise Sensor Network Abstract Interactive Layer. It is a layer to define the topology and behavior of sensor network. A comple..."

2018-06-19T05:32:05Z

Created page with "= Introduction = :WiseSnail is the short name of Wise Sensor Network Abstract Interactive Layer. It is a layer to define the topology and behavior of sensor network. A comple..."

New page

= Introduction =

:WiseSnail is the short name of Wise Sensor Network Abstract Interactive Layer. It is a layer to define the topology and behavior of sensor network. A complete device represented in WiseSnail includes one virtual gateway, one sensor connectivity interface and several sensor devices. WiseSnail provides a form-like array which we call it infospec array to define tha parameters of sensor device. And a form-like data array updates your real time data. So, you can easy to represent your device by creating several arrays.

= Design intention =

[[File:WiseSnail designintention.png|frameless|right|500px|WiseSnail designintention.png]]

:We refer the data handle flow on Wise-PaaS to design a data layout like right picture. There are two arrays, interface and sensor device, to implement the behavior of gateway. Each variable array includes several tags. A tag is a variable to indicate the parameter on interface or sensor device. So, we have two register functions and assign into two arrays to generate tags.<br/>

= Hardware requirements =

:'''CPU architecture'''
::
*x86
::*arm
:'''Minimum ram size'''
::
*256kb and above.

= OS =

:
*Ubuntu ( 14.04, 16.04 )
:*Yocto ( 1.5.3 Dora )
:*OpenWRT

= External library dependency requirements =

#[https://www.openssl.org/ OpenSSL]
#[http://www.eclipse.org/paho/ Paho]
#[https://mosquitto.org/ Mosquitto]

= Source Code =

:'''GitHub'''<br/>
::[https://github.com/ADVANTECH-Corp/WiseSnail.git https://github.com/ADVANTECH-Corp/WiseSnail.git]
:'''Source tree'''<br/>

::
{| class="wikitable" style="width: 50%"
|-
| inc
| header files
|-
| library
| includes [[IoTGateway/AdvJSON|AdvJSON]], AdvLog, WiseCore
|-
| sample
| a simple sample to test library.
|-
| source
| source files
|}

= Configure =

:'''Optional'''

::
{| class="wikitable" style="width: 50%"
|-
| --disable-paho
| Disable Paho support.
|-
| --disable-mosquitto
| Disable Mosquitto support.
|}

:'''Compile'''<br/>
::You can perform the following steps to build this library.

::
{| class="wikitable" style="width: 100%"
|-
|
./configure<br/>'''Or'''<br/>./configure --host=<your cross compiler> --prefix=<install path><br/><br/>make<br/>make install

|}

:'''Compile script'''<br/>
::This script combines compile steps and version control handling.

::
{| class="wikitable" style="width: 100%"
|-
|
./snailconf.sh<br/>'''Or'''<br/>./snailconf.sh --host=<your cross compiler> --prefix=<install path>

|}

:'''Build sample'''
::Enter the folder of sample,and make it directly. You can change the MQTT library by editing makefile.

= Capability =

:<syntaxhighlight lang="C">
#define MAX_DEVICES 16 //The Maximum number of sensor device
#define MAX_ITEMS 16 //The Maximum number of sensor value
#define MAX_CMDS 16 //The Maximum number of command that can be processed in one second.
</syntaxhighlight>
{|
|-
|
|}

= Structures =

== Data Type ==

{|
|-
| '''Description'''<div style="margin-left:0.847cm; margin-right:0cm">
We provide several types to describe the type of data.
</div>
|-
|

<syntaxhighlight lang="C">
WISE_VALUE //for numeric value
WISE_FLOAT //for floating point
WISE_STRING //for string
WISE_BOOL //for boolean
WISE_CUSTOMIZE //for a customize value, use the following type definition
WISE_BASE64 // a base64 format data.
</syntaxhighlight>
|}

== Infospec ==

{|
|-
| '''Description'''<div style="margin-left:0.847cm; margin-right:0cm">
The infospec structure defines your parameters in sensor device. Those parameter structures will represented in Wise-Paas like a tag. It includes two callback function pointers. You can use the callback pointers to define your own get and set function. The button on Wise-Paas for GPIO will be differed from whether the set function is assigned or not. If the set function is assigned, the value is writable by users on Wise-Paas.
</div>
|-
|

<syntaxhighlight lang="C">
struct WiseSnail_InfoSpec{
WiseSnail_DataType type;
char *name;
char *unit;
union {
float value;
char *string;
WiseSnail_RAW *raw;
};
float min;
float max;
char *resourcetype;
WiseSnail_SetValue setValue;
WiseSnail_GetValue getValue;
WiseSnail_FormatType format;
};
</syntaxhighlight>
|-
| '''Example'''
|-
|

<syntaxhighlight lang="C">
{
WISE_VALUE, //WiseSnail_DataType
"Temperature", //name
"Cel", //unit
0, //value or string
-100, //min
200, //max
"ucum.Cel", //resourcetype, optional
NULL, //set function
NULL //get function
}
</syntaxhighlight>
|}

== Data ==

{|
|-
| '''Description'''<div style="margin-left:0.847cm; margin-right:0cm">
The data structure defines your value you want to update in sensor device. The cliendId and infomation is for internal used and will be assigned while your callback function(like set) is called.
</div>
|-
|

<syntaxhighlight lang="C">
struct WiseSnail_Data{
WiseSnail_DataType type;
char *name;
union {
float value;
char *string;
WiseSnail_RAW *raw;
};
WiseSnail_FormatType format;
char *clientId; //internal
WiseSnail_InfoSpec *info; //internal
}
</syntaxhighlight>
|-
| '''Example'''
|-
|

<syntaxhighlight lang="C">
{
WISE_VALUE, //WiseSnail_DataType
"Temperature", //name
100 //value or string
}
</syntaxhighlight>
|}

== Callbacks ==

{|
|-
| '''Set Callback'''
|-
|
typedef int (*WiseSnail_SetValue)(WiseSnail_Data *data);

|-
| '''Get Callback'''
|-
|
typedef int (*WiseSnail_GetValue)(WiseSnail_Data *data);

|-
| '''Sleep callback'''
|-
|
typedef void (*WiseSnail_SleepOneSecond)(void);

|}

= Functions =

== Initial & Uninitial ==

*'''WiseSnail_Init'''
<div style="margin-left:0.847cm;margin-right:0cm;">
{| class="wikitable"
|-
| void '''WiseSnail_Init'''(char *'''productionName''', char *'''wanIp''', unsigned char *'''parentMac''', WiseSnail_InfoSpec *'''infospec''', int '''count''');
|}
<div style="margin-left:0.847cm;margin-right:0cm;">
{| class="wikitable" width="50%"
|-
! Parameter
! Description
|-
| align="center" width="40%" | productionName
| Name for device.
|-
| align="center" | wanIp
| Ip address.
|-
| align="center" | parentMac
| The mac address of parent device.
|-
| align="center" | infospec
| Optional parameter array.
|-
| align="center" | count
| The size of infospec.
|}
</div></div>
*'''WiseSnail_Uninit'''
<div style="margin-left:0.847cm;margin-right:0cm;">
{| class="wikitable"
|-
| void '''WiseSnail_Uninit'''();
|}
<div style="margin-left:0.847cm;margin-right:0cm;">
{| class="wikitable" width="50%"
|-
! Parameter
! Description
|-
| align="center" width="40%" | None
| None
|}
</div></div>
== Register ==

*'''WiseSnail_RegisterInterface'''

::One instance only includes one interface.
<div style="margin-left:0.847cm;margin-right:0cm;">
{| class="wikitable"
|-
| void '''WiseSnail_RegisterInterface'''(char *'''ifMac''', char *'''ifName''', int '''ifNumber''', WiseSnail_InfoSpec *'''infospec''', int '''count''');
|}
<div style="margin-left:0.847cm;margin-right:0cm;">
{| class="wikitable" width="50%"
|-
! Parameter
! Description
|-
| align="center" width="40%" | ifMac
| The mac address of interface.
|-
| align="center" | ifName
| The name of interface.
|-
| align="center" | ifNumber
| The index number of interface.
|-
| align="center" | infospec
| Interface parameter array.
|-
| align="center" | count
| The size of infospec.
|}
</div></div>
*'''WiseSnail_RegisterSensor'''

::The maximum number of sensor devcie, please refer to MAX_DEVICES.
<div style="margin-left:0.847cm;margin-right:0cm;">
{| class="wikitable"
|-
| void '''WiseSnail_RegisterSensor'''(char *'''deviceMac''', char *'''defaultName''', WiseSnail_InfoSpec *'''infospec''', int '''count''');
|}
<div style="margin-left:0.847cm;margin-right:0cm;">
{| class="wikitable" width="50%"
|-
! Parameter
! Description
|-
| align="center" width="40%" | deviceMac
| The mac address of sensor device.
|-
| align="center" | defaultName
| The default name of sensor device.
|-
| align="center" | infospec
| Sensor device parameter array.
|-
| align="center" | count
| The size of infospec.
|}
</div></div>
== Connect ==

*'''WiseSnail_Connect'''
<div style="margin-left:0.847cm;margin-right:0cm;">
{| class="wikitable"
|-
| int '''WiseSnail_Connect'''(char *'''server_url''', int '''port''', char *'''username''', char *'''password''', WiseSnail_InfoSpec *'''infospec''', int '''count''');
|}
<div style="margin-left:0.847cm;margin-right:0cm;">
{| class="wikitable" width="50%"
|-
! Parameter
! Description
|-
| align="center" width="40%" | server_url
| The address of mqtt broker.
|-
| align="center" | port
| The port of mqtt broker.
|-
| align="center" | username
| The username of mqtt broker.("" for none)
|-
| align="center" | password
| The password of mqtt broker.("" for none)
|-
| align="center" | infospec
| Connect parameter array.
|-
| align="center" | count
| The size of infospec.
|}
</div></div>
== Update ==

*'''WiseSnail_Update'''

::You can update your data from this function by assigning a data array.
<div style="margin-left:0.847cm; margin-right:0cm">
{| class="wikitable"
|-
| void '''WiseSnail_Update'''(char *'''deviceMac''', WiseSnail_Data* '''data''', int '''count''');
|}
<div style="margin-left:0.847cm; margin-right:0cm">
{| class="wikitable" width="50%"
|-
! Parameter
! Description
|-
| align="center" width="40%" | deviceMac
| The mac of device which you will update.
|-
| align="center" | data
| Data array.
|-
| align="center" | count
| The size of data.
|}
</div></div>
== Main Handle Loop function ==

*'''WiseSnail_MainLoop'''

::This is a very important function. It includes main logic and error handling. The interval of sleepOneSec must be one second.<br/>
::You also can run an external timer, but this function must be executed per one second.
<div style="margin-left:0.847cm; margin-right:0cm">
{| class="wikitable"
|-
| void '''WiseSnail_MainLoop'''(WiseSnail_SleepOneSecond '''sleepOneSec''');
|}
<div style="margin-left:0.847cm; margin-right:0cm">
{| class="wikitable" width="50%"
|-
! Parameter
! Description
|-
| align="center" width="40%" | sleepOneSec
| a callback function for sleep one second.
|}
</div></div>
= Sample<span style="font-size:x-small">(pseudo code)</span> =

<syntaxhighlight lang="C">

WiseSnail_InfoSpec interface[] = {
{
WISE_BOOL,
"/Info/reset",
"",
0,
0,
1,
"",
Reset
}
};

void SetGPIO_1(WiseSnail_Data*data) {
printf("(GPIO 1) = %d\r\n",data->value);
}

void SetGPIO_2(WiseSnail_Data*data) {
printf("(GPIO 2) = %d\r\n",data->value);
}

/***********************CUSTOMIZE VALUE FOR BASE64*******************************/
char rawData[128] = "ABCDE";
WiseSnail_RAW rawItem = {
.data = rawData,
.len = 5
};

int SetRAW(WiseSnail_Data *data) {
if(data->type == WISE_CUSTOMIZE) {
memcpy(&rawItem, data->raw, sizeof(rawItem));
}
}

int GetRAW(WiseSnail_Data *data) {
if(data->type == WISE_CUSTOMIZE) {
memcpy(data->raw, &rawItem, sizeof(rawItem));
}
}
/********************************************************************************/

WiseSnail_InfoSpec infospec[] = {
{
WISE_STRING,
"/Info/Name",
"",
.string = "SenHub1", // Device Name of SenHub (*)
0,
0,
"",
//SetSHName,
.getValue = GetSHName
},
{
WISE_VALUE, //type
"Temperature", //name
"Cel", //unit
0, //value[union]
-100, //min
200, //max
"ucum.Cel" //resourceType
},
{
WISE_VALUE, //type
"Humidity", //name
"%", //unit
0, //value[union]
0, //min
100, //max
"ucum.%" //resourceType
},
{
WISE_IO_BOOL,
"GPIO1",
"",
0,
0,
1,
"",
SetGPIO_1
},
{
WISE_IO_BOOL,
"GPIO2",
"",
0,
0,
1,
"",
SetGPIO_2
},
{
WISE_CUSTOMIZE,
"RAW",
"",
.raw = &rawItem,
0,
1,
"",
SetRAW,
GetRAW,
WISE_BASE64
}
};

WiseSnail_Data data[] = {
{
WISE_VALUE, //type
"Temperature", //name
100 //value
},
{
WISE_VALUE, //type
"Humidity", //name
55 //value
},
{
WISE_CUSTOMIZE,
"RAW",
.raw = &rawItem,
WISE_BASE64
}
};

void sleepOneSecond() {
sleep(1);
}

#define SERVER_ADDRESS "rmm.wise-paas.com"

int main() {
//initial
WiseSnail_Init("IotGW",NULL, NULL, NULL, 0);
WiseSnail_RegisterInterface("000E4CAB1234", "Ethernet", -1, interface, 1);

if(WiseSnail_Connect(SERVER_ADDRESS, 1883, "", "", NULL, 0) == 0) {
//
// no succesful connection to broker
//
return -1;
} else {
WiseSnail_RegisterSensor("000E4C000000", "OnBoard", infospec, sizeof(infospec)/sizeof(WiseSnail_InfoSpec));
}

int count = 0;
int second = 0;
for(;;) {
if(second == 0) {
/*HDC1050_GetSensorData(&Temperature, &Humidity);
data[0].value = Temperature;
data[1].value = Humidity;
*/

if(data[0].value < 100) {
data[0].value++;
} else {
data[0].value = 0;
}

if(data[1].value < 100) {
data[1].value++;
} else {
data[1].value = 0;
}

printf("\r\n****** \033[33mSend update.\033[0m ******\r\n");
WiseSnail_Update("000E4C000000", data, 2);
count++;
}

WiseSnail_MainLoop(sleepOneSecond);
second = (second+1)%5;
}
return 0;
}
</syntaxhighlight>

@@ Line 1: / Line 1: @@
 = Introduction =
-:AgentLite is a layer to define the topology and behavior of sensor network. A complete device represented in WiseSnail includes one virtual gateway, one sensor connectivity interface and several sensor devices. WiseSnail provides a form-like array which we call it infospec array to define tha parameters of sensor device. And a form-like data array updates your real time data. So, you can easy to represent your device by creating several arrays.
+:AgentLite is a layer to define the topology and behavior of sensor network. A complete device represented in WiseSnail includes one virtual gateway, one sensor connectivity interface and several sensor devices. AgentLite provides a form-like array which we call it infospec array to define tha parameters of sensor device. And a form-like data array updates your real time data. So, you can easy to represent your device by creating several arrays.
 = Design intention =

IoTGateway/AgentLite RMM3.3 - Revision history

Eric.liang at 05:46, 19 June 2018

Eric.liang at 05:45, 19 June 2018

Eric.liang: Created page with "= Introduction = :WiseSnail is the short name of Wise Sensor Network Abstract Interactive Layer. It is a layer to define the topology and behavior of sensor network. A comple..."