Difference between revisions of "IoTGateway/WiseSnail"

From ESS-WIKI
Jump to: navigation, search
(Initial & Uninitial)
(Callbacks)
Line 78: Line 78:
 
{|
 
{|
 
|-
 
|-
| Set Callback
+
| '''Set Callback'''
 
|-
 
|-
 
|  
 
|  
 
   typedef int (*WiseSnail_SetValue)(WiseSnail_Data *data);
 
   typedef int (*WiseSnail_SetValue)(WiseSnail_Data *data);
 
|-
 
|-
| Get Callback
+
| '''Get Callback'''
 
|-
 
|-
 
|  
 
|  

Revision as of 06:15, 5 September 2016

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 hubs. WiseSnail provides a form-like array which we call it infospec array to define tha parameters of sensor hub. And a form-like data array updates your real time data. So, you can easy to represent your device by creating several arrays.

Structures

Infospec

Description

The infospec structure defines your parameters in sensor hub. Those parameter structures will represented in Wise-Paas like a tag. this structure includes two callback functions. You can use the callbacks to define your own get and set function. The parameter button on Wise-Paas will different by whether the set function is defined or not. If the set function is defined, the value is writeable by users on Wise-Paas.

   struct WiseSnail_InfoSpec{
     WiseSnail_DataType type;
     char *name;
     char *unit;
     union {
       float value;
       char *string;
     };
     float min;
     float max;
     char *resourcetype;
     WiseSnail_SetValue setValue;
     WiseSnail_GetValue getValue;
   };
Example
   {
     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
   }

Data

Description

The data structure defines your value you want to update in sensor hub. the cliendId and info is for internal used and will be assigned while your callback function(like set) is called.

   struct WiseSnail_Data{
     WiseSnail_DataType type;
     char *name;
     union {
       float value;
       char *string;
     };
     char *clientId;              //internal
     WiseSnail_InfoSpec *info;    //internal
   }
Example
   {
     WISE_VALUE,                  //WiseSnail_DataType 
     "Temperature",               //name
     100                          //value or string
   }

Callbacks

Set Callback
 typedef int (*WiseSnail_SetValue)(WiseSnail_Data *data);
Get Callback
 typedef int (*WiseSnail_GetValue)(WiseSnail_Data *data);

Functions

Initial & Uninitial

WiseSnail_Init
void WiseSnail_Init(char *productionName, char *wanIp, unsigned char *parentMac, WiseSnail_InfoSpec *infospec, int count);
Parameter Description
productionName name for device.
wanIp ip address in ip base.
parentMac the mac address of parent device.
infospec optional parameter array
count the size of infospec
WiseSnail_Uninit
void WiseSnail_Uninit();
Parameter Description
None None

Register

Connect

Update

Tool

Loop function

Demo