Revision as of 03:59, 18 August 2016

Abstract

Overview

Introduction

Terminology

This specification makes use of the following additional terminology:

IoT Gateway (IoTGW): It integrates technologies and protocols for networking, embedded control, enterprise-grade security, and easy manageability on which application-specific software can run. Connectivity up to the WISE Cloud and down to sensors and existing controllers embedded in the system. Pre-process filtering and gathering of selected data for delivery.

Sensor Hub (SenHub): A sensor hub is capable of performing some processing, gathering sensory information and communicating with other connected hubs in the network. A sensor hub should be small in size, consume extremely low energy, operate in high volumetric densities, be autonomous and operate unattended, and be adaptive to the environment. As sensor hubs are typically very small electronic devices, they can only be equipped with a limited power source.

Sensor (Sen): Sensor is hardware device that produce a measurable response to a change in a physical condition like temperature or pressure. Sensor measures physical data of the parameter to be monitored.

Resource Type(rt): Each root resource of a function set is assigned a Resource Type parameter, therefore making it possible to discover it. The Resource Type parameter defines the value that MUST be included in the rt= field of the sensor.

IPSO Application Framework

HTTP, REST, XML, JSON, COAP and other key components of web technology are powerful mechanisms in an Internet of Things application.

Note: The objective of the Alliance is not to define technologies, but to document the use of IP-based technologies defined at the standard organizations such as IETF with focus on support by the Alliance of various use cases.

Function Sets: The framework is organized into groups of resource types called Function Sets. A Function Set has a recommended root path, under which its sub-resources are organized. Each Function Set is assigned a Resource Type parameter, therefore making it possible to discover it.

IPSO Smart Object

The object model from OMA LWM2M is reused to define application level IPSO Smart Objects. This enables the OMA Name Authority (OMNA) to be used to register new objects, and enables existing LWM2M compliant device libraries and server software to be used as an infrastructure for IPSO Smart Objects

Media Types for Sensor Markup Language (SENML)

Semantics

The Data Type of Sensor Data Type

Advantech Sensor Semantics

Example

{"n":"Room Temp","u":"Cel","v":0,"min":0,"max":100,"asm":"r","type":"d","rt":"ucum.Cel","st":"ipso","exten":"sid=3303"}

Application Program Interface (API)

Event of Callback

typedef enum {
 // Interface: 1000 ~ 1999
 SN_Inf_UpdateInterface_Data   = 1000, // Update Interface data
 
 // Sensor Hub: 2000 ~ 2999
 SN_SenHub_Register         = 2000, // A SenHub connected
 SN_SenHub_SendInfoSpec     = 2001, // Report the resource information of SenHub
 SN_SenHub_AutoReportData   = 2002, // Auto report data value of SenHub
 SN_SenHub_Disconnect       = 2003, // A SenHub disconnected  
 
 SN_SetResult	             = 3000, // Return the result of setting value
} SN_EVENT_ID;

Command ID

typedef enum {
SN_Set_ReportSNManagerDataCbf = 3000, // Set Event Callback function point  
} SN_CTL_ID;

Return Code Definition

typedef enum {
SN_ER_NOT_IMPLEMENT = -13,      // Dose Not Support this command (501)
SN_ER_TIMEOUT  = -12            // Request Timeout  (408)
SN_ER_SYS_BUSY  = -11           // System is busy (503) 
SN_ER_VALUE_OUT_OF_RANGE = -10  // Value is out of range (416)
SN_ER_SYNTAX_ERROR = -9         // Format is correct but syntax error (422)
SN_ER_FORMAT_ERROR = -8         // Format error (415) =
SN_ER_REQUEST_ERROR = -7        // Request error (400)
SN_ER_RESOURCE_LOSE  = -6       // Resource is lose (410)
SN_ER_RESOURCE_LOCKED = -5,     // Resource is in setting (426)
SN_ER_NOT_FOUND = -4,           // Resource Not Found (404)
SN_ER_WRITE_ONLY = -3,          // Write Only (405) 
SN_ER_READ_ONLY = -2,           // Read Only (405)
SN_ER_FAILED = -1,              // Failed (500)</div>
SN_OK = 0,                      // Successfully (200)</div>
SN_INITILIZED = 1,              // Library had initilized</div>
} SN_CODE;

Structure Definition

typedef struct _SenHubInfo
{
 char sMAC[MAX_SN_MAC];               // MAC: remove '-' and ':'
 char sHostName[MAX_SN_HOSTNAME];     // WISE1020-MAC(4)
 char sSN[MAX_SN_SNO];                // MAC: remove '-' and ':'
 char sProduct[MAX_SN_PRODUCT_NAME];  // WISE1020
 void *pExtened;                      // Reserve for extension
}SenHubInfo;

Sensor Network Manager API Definition

Syntax

SNMCODE SN_Manager_Initialize( );

Description

This function initializes the Sensor Network Manager API Library. You must call this function before using this module.

Parameters

None

Return Values

SNM__OK: Successfully to initialize the Sensor Network Manager module.

SNM_FAILED: Failed to initialize the Sensor Network Manager module.

Syntax

SNMCODE SN_Manager_Uninitialize();

Description

This function uninitialized the Sensor Network Manager Module. You must call this function before closing this module to release resources.

Parameters

None

Return Values

Syntax

SNMCODE SN_Manager_GetCapability(char ** ppzDataBuffer, int *pnLen );

Description

Parameters

*pnLen

[out] the length of the data in ppzDataBuffer

Return Values

Example:

Condition

"IoTGW": {
  "WSN": {
   "WSN0": { 
      "Info": {
         "e": [{"n":"SenHubList","sv":"","asm":"r"},
               {"n":"Topology","sv":"","asm":"r"},
               {"n":"Health","v":100,"asm":"r"},
               {"n":"Name","sv":"WSN0","asm":"r"}
              ],
       "bn":"Info"
      },
  "bn":"0000852CF4B7B0E8",
  "ver":1
 },   
  "WSN1": {
    "Info": {
        "e": [{"n":"SenHubList","sv":"","asm":"r"},
              {"n":"Topology","sv":"","asm":"r"},
              {"n":"Health","v":100,"asm":"r"},
              {"n":"Name","sv":"WSN1","asm":"r"}],
     "bn":"Info"
    },
   "bn":"0000852CF4B7B0E7",
   "ver":1
  },
 "bn":"WSN"
 },
 "ver": 1
}

Syntax

SNMCODE SN_Manager_ActionProc( const int nCtlId,

Description

Parameters

pParam1

[in] the point to parameter 1 ( data type depend on SN_CTL_ID)

*pParam2

[in] the point to parameter 2 ( data type depend on SN_CTL_ID)

*pPev1

[in] reserved for later use. Must be ?ULL??

[in] reserved for later use. Must be ?ULL??

Return Values

Example:

*pParam1: ReportSNManagerDataCbf

the ReportSNManagerDataCbf that specify the callback function to be used to notify event.

Syntax

typedef int (*Template:Anchor Template:Anchor ReportSNManagerDataCbf) ( const int Template:Anchor nEventID,

Description

Parameters

pzDataBuffer

[in] the point to data with JSON format

Template:Anchor Template:Anchor Template:Anchor nDataLen

Template:Anchor Template:Anchor Template:Anchor [in] the length of the data in pzDataBuffer

Template:Anchor Template:Anchor **Template:Anchor Template:Anchor Template:Anchor ppOutParam

[out] Template:Anchor User can Template:Anchor Template:Anchor Template:Anchor specify the address or context value when ?{anchor|OLELINK220}} Template:Anchor Template:Anchor SN_SenHub_Register??event called,

Template:Anchor Template:Anchor *Template:Anchor Template:Anchor Template:Anchor Template:Anchor pParam1

[in] the point of data. The data type depends on ?N Event ID??

*pRev1

[in] reserved for later use.

Template:Anchor Template:Anchor Template:Anchor Return Values

Example of Event Code:

1. SN_Inf_UpdateInterface_Data:

"IoTGW": {

"WSN": {

"WSN0"{

"Info": {

"e": [{"n":"SenHubList","sv":"Template:Anchor Template:Anchor Template:Anchor 0000000EC6F0F830 ,0000000EC6F0F831"},

{"n":"Neighbor","sv":"0000000EC6F0F830"},

{"n":"Health","v":60}],

"bn":"Info"

}

"bn":"0000852CF4B7B0E8",

"ver":1

},

"bn":"WSN"

},

"ver": 1

[out] the point that storage the user specify address or context value.

"SenData": {

 {"n":"Name","sv":"Room","asm":"rw"},

{"n":"IoTGW","sv":"0000852CF4B7B0E8","asm":"r"}],

"ver": 1

[in] the point of address or context value that pass by user at SN_SenHub_Register event.