View source for W2MExampleWiki

The Advantech IoT Sensor Data Format

draft-adv-iot-sensor-format-06

Abstract

<div style="margin-left:0cm;margin-right:0cm;">This document defines a IoT sensor data format for use in Advantech sensor device, WIESE Cloud, and Big data analysis. </div>

<div style="margin-left:0cm;margin-right:0cm;">Introduction</div>

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 Node (SenNode)''': A sensor node is capable of performing some processing, gathering sensory information and communicating with other connected nodes in the network. A sensor node 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 nodes 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.


'''Interface Description(if)''': The Interface Description parameter defines the REST interface for that type of resources.



{| style="border-spacing:0;width:14.75cm;"
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| Interface
|| if=
|| Methods
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| Link List
|| core.ll
|| GET
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| Batch
|| core.b
|| GET, PUT, POST (where applicable)
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| Linked Batch
|| core.lb
|| GET, PUT, POST, DELETE (where applicable)
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| Sensor
|| core.s
|| GET
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| Parameter
|| core.p
|| GET, PUT
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| Read-only Parameter
|| core.rp
|| GET
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| {{anchor|OLELINK5}} {{anchor|OLELINK12}} Actuator
|| core.a
|| GET, PUT, POST
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| {{anchor|OLELINK20}} {{anchor|OLELINK21}} Binding
|| core.bnd
|| GET, POST, DELETE
|-
|}
'''Link List''': The Link List interface is used to retrieve (GET) a list of resources on a web server.

'''Batch''': The Batch interface is used to manipulate a collection of sub-resources at the same time.

'''Linked Batch''': Contrary to the basic Batch which is a collection statically defined by the web server, a Linked Batch is dynamically controlled by a web client.

'''Sensor''': The Sensor interface allows the value of a sensor resource to be read (GET).

'''Parameter''': The Parameter interface allows configurable parameters and other information to be modeled as a resource.

'''Read-only Parameter''': The Read-only Parameter interface allows configuration parameters to be read (GET) but not set.

'''Actuator''': Examples of actuators include for example LEDs, relays, motor controllers and light dimmers. The current value of the actuator can be read (GET) or a new actuator value set (PUT).

'''Binding''':The Binding interface is used to manipulate a binding table.


'''Path Template (Path)''' : The path template includes a possible index {#} parameter, and possible fixed path segments. <span style="color:#ff0000;">The index {#} allows for multiple instances of this type of resource, and can be any string.</span>






'''IPSO Application Framework'''

<div style="margin-left:0cm;margin-right:0cm;">The IPSO Application Framework makes use of IETF standards as building blocks for a simple and efficient RESTful design model for IP smart objects. The framework may be used over either HTTP or CoAP web transfer protocols.</div>

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

'''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.


{| style="border-spacing:0;width:14.75cm;"
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| Function Set
|| Root Path
|| Resource Type
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#ff0000;">General Purpose IO</span>
|| <span style="color:#ff0000;">/gpio</span>
|| <span style="color:#ff0000;">ipso.gpio</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| Power
|| /pwr
|| ipso.pwr
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| Load Control
|| /load
|| ipso.load
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#ff0000;">Sensors</span>
|| <span style="color:#ff0000;">/sen</span>
|| <span style="color:#ff0000;">ipso.sen</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#ff0000;">Light Control</span>
|| <span style="color:#ff0000;">/lt</span>
|| <span style="color:#ff0000;">ipso.lt</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| Message
|| /msg
|| ipso.msg
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| Location
|| /loc
|| ipso.loc
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| Configuration
|| /cfg
|| ipso.cfg
|-
|}


'''Media Types for Sensor Markup Language (SENML)'''


'''Semantics'''


{| style="border-spacing:0;width:15.032cm;"
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| SenML
|| JSON
|| Type
|| Description
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#000000;">Base Name</span>
|| <span style="color:#000000;">bn</span>
|| <span style="color:#000000;">String</span>
|| <span style="color:#000000;">This is a string that is prepended to the names found in the entries</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#000000;">Base Time</span>
|| <span style="color:#000000;">bt</span>
|| <span style="color:#000000;">Number</span>
|| <span style="color:#000000;">A base time that is added to the time found in an entry</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#000000;">Base Units</span>
|| <span style="color:#000000;">bu</span>
|| <span style="color:#000000;">Number</span>
|| <span style="color:#000000;">A base unit that is assumed for all entries, unless otherwise indicated</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#000000;">Version</span>
|| <span style="color:#000000;">ver</span>
|| <span style="color:#000000;">Number</span>
|| <span style="color:#000000;">Version number of media type format</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#000000;">Measurement or Parameters</span>
|| <span style="color:#000000;">e</span>
|| <span style="color:#000000;">Array</span>
|| <span style="color:#000000;">Array of values for sensor measurements or other generic parameters</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#000000;">Name</span>
|| <span style="color:#000000;">n</span>
|| <span style="color:#000000;">String</span>
|| <span style="color:#000000;">Name of the sensor or parameter</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| Units
|| U
|| String
|| Units for a measurement value
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| Value
|| v
|| Number
|| <span style="color:#000000;">Value of the entry</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| String Value
|| sv
|| String
| style="color:#000000;" | 
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| Boolean Value
|| bv
|| Boolean
| style="color:#000000;" | 
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| Value Sum
|| s
|| Floating point
|| <span style="color:#000000;">Integrated sum of the values over time</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| Time
|| t
|| Number
|| <span style="color:#000000;">Time when value was recorded</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| Update Time
|| ut
|| Number
|| <span style="color:#000000;">Update time. A time in seconds that represents the maximum time before this sensor will provide an updated reading for a measurement.</span>
|-
|}


'''The Data Type of Sensor Data Format'''



{| style="border-spacing:0;width:9.834cm;"
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| Data Type (type)
|| SenML Field
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| b (boolean)
|| bv
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| s (string)
|| s
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| e (enum)
|| e
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| i (integer)
|| v
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| d (decimal)
|| v
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| h(hexadecimal)
|| s
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| o(octet-stream)
|| s
|-
|}


Example:

{“n”: 


'''The Unified Code for Units of Measure (UCUM)'''

'''http://unitsofmeasure.org/ucum.html'''


{| style="border-spacing:0;width:9.832cm;"
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| Symbol
|| Description
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| m
|| meter
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| kg
|| kilogram
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#000000;">s</span>
|| <span style="color:#000000;">second</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#000000;">A</span>
|| <span style="color:#000000;">ampere</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#000000;">K</span>
|| <span style="color:#000000;">kelvin</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#000000;">cd</span>
|| <span style="color:#000000;">candela</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#000000;">mol</span>
|| <span style="color:#000000;">mole</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#000000;">Hz</span>
|| <span style="color:#000000;">hertz</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#000000;">rad</span>
|| <span style="color:#000000;">radian</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#000000;">sr</span>
|| <span style="color:#000000;">steradian</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#000000;">N</span>
|| <span style="color:#000000;">newton</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#000000;">Pa</span>
|| <span style="color:#000000;">pascal</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#000000;">J</span>
|| <span style="color:#000000;">joule</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#000000;">W</span>
|| <span style="color:#000000;">watt</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#000000;">C</span>
|| <span style="color:#000000;">coulomb</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#000000;">V</span>
|| <span style="color:#000000;">volt</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| F
|| farad
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| Ohm
|| ohm
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| S
|| siemens
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| Wb
|| weber
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| T
|| tesla
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| H
|| henry
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#000000;">Cel</span>
|| <span style="color:#000000;">degrees Celsius</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#000000;">lm</span>
|| <span style="color:#000000;">lumen</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#000000;">lx</span>
|| <span style="color:#000000;">lux</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#000000;">Bq</span>
|| <span style="color:#000000;">becquerel</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#000000;">Gy</span>
|| <span style="color:#000000;">gray</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#000000;">Sv</span>
|| <span style="color:#000000;">sievert</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#000000;">kat</span>
|| <span style="color:#000000;">katal</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#000000;">pH</span>
|| <span style="color:#000000;">pH acidity</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#000000;">%</span>
|| <span style="color:#000000;">Value of a switch. A value of 0.0 indicates the switch is off while 100.0 indicates on.</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#000000;">count</span>
|| <span style="color:#000000;">counter value</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#000000;">%RH</span>
|| <span style="color:#000000;">Relative Humidity</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#000000;">m2</span>
|| <span style="color:#000000;">area</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#000000;">l</span>
|| <span style="color:#000000;">volume in liters</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#000000;">m/s</span>
|| <span style="color:#000000;">velocity</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#000000;">m/s2</span>
|| <span style="color:#000000;">acceleration</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#000000;">l/s</span>
|| <span style="color:#000000;">flow rate in liters per second</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#000000;">W/m2</span>
|| <span style="color:#000000;">irradiance</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#000000;">cd/m2</span>
|| <span style="color:#000000;">luminance</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#000000;">Bspl</span>
|| <span style="color:#000000;">bel sound pressure level</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#000000;">bit/s</span>
|| <span style="color:#000000;">bits per second</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| <span style="color:#000000;">lat</span>
|| <span style="color:#000000;">degrees latitude. Assumed to be in WGS84 unless another reference frame is known for the sensor.</span>
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| lon
|| degrees longitude. Assumed to be in WGS84 unless another reference frame is known for the sensor.
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| %EL
|| remaining battery energy level in percents
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| EL
|| remaining battery energy level in seconds
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| beet/m
|| Heart rate in beets per minute
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| beets
|| Cumulative number of heart beats
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| h
|| Hour.
|-
|}






'''IoTS'''

'''SUSI Thermal Protect API (3):'''

<span style="color:#ff0000;">'''[SUSI API]'''</span>* uint32_t SUSI_API SusiThermalProtectionGetCaps(uint32_t Id, uint32_t ItemId, uint32_t *pValue)
* uint32_t SUSI_API SusiThermalProtectionSetConfig(uint32_t Id, SusiThermalProtect *pConfig)
* uint32_t SUSI_API SusiThermalProtectionGetConfig(uint32_t Id, SusiThermalProtect *pConfig)



<div style="color:#ff0000;"></div>

<span style="color:#ff0000;">'''[Path Definition]'''</span>

'''Id:'''

<div style="margin-left:1.609cm;margin-right:0cm;">{{anchor|Ref353960676}} {{anchor|Toc401561559}} '''Table 29 Thermal Protection ID'''</div>


{| style="border-spacing:0;width:13.691cm;"
|- style="background-color:#ffffff;border-top:1.5pt solid #000001;border-bottom:1.5pt solid #000001;border-left:none;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| <span style="color:#00000a;">'''Id'''</span>
|| <span style="color:#00000a;">'''Description'''</span>
|-
| style="background-color:#ffffff;border-top:0.75pt solid #000001;border-bottom:0.75pt solid #000001;border-left:none;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;" | SUSI_ID_THERMAL_PROTECT_1
| style="background-color:#ffffff;border-top:0.75pt solid #000001;border-bottom:0.75pt solid #000001;border-left:none;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;" | Thermal protection zone 1
|-
| style="background-color:#ffffff;border-top:0.75pt solid #000001;border-bottom:0.75pt solid #000001;border-left:none;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;" | SUSI_ID_THERMAL_PROTECT_2
| style="background-color:#ffffff;border-top:0.75pt solid #000001;border-bottom:0.75pt solid #000001;border-left:none;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;" | Thermal protection zone 2
|-
| style="background-color:#ffffff;border-top:0.75pt solid #000001;border-bottom:0.75pt solid #000001;border-left:none;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;" | SUSI_ID_THERMAL_PROTECT_3
| style="background-color:#ffffff;border-top:0.75pt solid #000001;border-bottom:0.75pt solid #000001;border-left:none;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;" | Thermal protection zone 3
|-
| style="background-color:#ffffff;border-top:0.75pt solid #000001;border-bottom:1.5pt solid #000001;border-left:none;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;" | SUSI_ID_THERMAL_PROTECT_4
| style="background-color:#ffffff;border-top:0.75pt solid #000001;border-bottom:1.5pt solid #000001;border-left:none;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;" | Thermal protection zone 4
|-
|}
<div style="color:#ff0000;"></div>


{| style="border-spacing:0;width:14.75cm;"
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
| align=center| '''Description'''
| align=center| '''{#}'''
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| Thermal protection zone 1
|| Zone1
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| Thermal protection zone 2
|| Zone2
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| Thermal protection zone 3
|| Zone3
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| Thermal protection zone 4
|| Zone4
|-
|}
<div style="color:#ff0000;"></div>

'''ItemId:'''

<div style="margin-left:1.609cm;margin-right:0cm;">{{anchor|Ref353960496}} {{anchor|Toc401561560}} '''Table 30 Thermal Protection capabilities item Id'''</div>


{| style="border-spacing:0;width:13.691cm;"
|- style="background-color:#ffffff;border-top:1.5pt solid #000001;border-bottom:1.5pt solid #000001;border-left:none;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| <span style="color:#00000a;">'''Item Id'''</span>
|| <span style="color:#00000a;">'''Description'''</span>
|-
| style="background-color:#ffffff;border-top:0.75pt solid #000001;border-bottom:0.75pt solid #000001;border-left:none;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;" | SUSI_ID_TP_EVENT_SUPPORT_FLAGS
| style="background-color:#ffffff;border-top:0.75pt solid #000001;border-bottom:0.75pt solid #000001;border-left:none;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;" | Event support flags
|-
| style="background-color:#ffffff;border-top:0.75pt solid #000001;border-bottom:0.75pt solid #000001;border-left:none;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;" | SUSI_ID_TP_EVENT_TRIGGER_MAXIMUM
| style="background-color:#ffffff;border-top:0.75pt solid #000001;border-bottom:0.75pt solid #000001;border-left:none;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;" | The maximum temperature to trigger event
|-
| style="background-color:#ffffff;border-top:0.75pt solid #000001;border-bottom:0.75pt solid #000001;border-left:none;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;" | SUSI_ID_TP_EVENT_TRIGGER_MINIMUM
| style="background-color:#ffffff;border-top:0.75pt solid #000001;border-bottom:0.75pt solid #000001;border-left:none;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;" | The minimum temperature to trigger event
|-
| style="background-color:#ffffff;border-top:0.75pt solid #000001;border-bottom:0.75pt solid #000001;border-left:none;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;" | SUSI_ID_TP_EVENT_CLEAR_MAXIMUM
| style="background-color:#ffffff;border-top:0.75pt solid #000001;border-bottom:0.75pt solid #000001;border-left:none;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;" | The maximum temperature to clear event
|-
| style="background-color:#ffffff;border-top:0.75pt solid #000001;border-bottom:1.5pt solid #000001;border-left:none;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;" | SUSI_ID_TP_EVENT_CLEAR_MINIMUM
| style="background-color:#ffffff;border-top:0.75pt solid #000001;border-bottom:1.5pt solid #000001;border-left:none;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;" | The minimum temperature to clear event
|-
|}
<div style="color:#ff0000;"></div>

<div style="color:#ff0000;"></div>


{| style="border-spacing:0;width:14.75cm;"
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
| align=center| '''Description'''
| align=center| '''{#}'''
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| Support shutdown event
|| shutdownon
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| Support throttle event
|| throttleon
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| Support power off event
|| poweroffon
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| The maximum temperature to trigger event
|| maxtt
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| The minimum temperature to trigger event
|| mintt
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| The maximum temperature to clear event
|| maxtc
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| The minimum temperature to clear event
|| mintc
|-
|}
<div style="color:#ff0000;"></div>

'''pConfig:'''

<span style="color:#0000ff;">typedef</span> <span style="color:#0000ff;">struct</span> <span style="color:#010001;">_SusiThermalProtect</span>{

<span style="color:#010001;">uint32_t</span> <span style="color:#010001;">SourceId</span><nowiki>;</nowiki>

<span style="color:#010001;">uint32_t</span> <span style="color:#010001;">EventType</span><nowiki>;</nowiki>

<span style="color:#010001;">uint32_t</span> <span style="color:#010001;">SendEventTemperature</span><nowiki>;</nowiki>

<span style="color:#010001;">uint32_t</span> <span style="color:#010001;">ClearEventTemperature</span><nowiki>;</nowiki>

} <span style="color:#010001;">SusiThermalProtect</span>, *<span style="color:#010001;">PSusiThermalProtect</span><nowiki>;</nowiki>


{| style="border-spacing:0;width:14.75cm;"
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
| align=center| '''Description'''
| align=center| '''{#}'''
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| SourceId
|| srcid
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| EventType
|| et
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| SendEventTemperature
|| set
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| ClearEventTemperature
|| cet
|-
|}
<div style="color:#ff0000;"></div>

{<span style="color:#ff0000;"><nowiki>#</nowiki></span>}/{<span style="color:#ff0000;"><nowiki>#</nowiki></span>}: Id/ItemId

{<span style="color:#ff0000;"><nowiki>#</nowiki></span>}/{<span style="color:#ff0000;"><nowiki>#</nowiki></span>}: Id/Config

<span style="color:#ff0000;">'''[Restful Api]'''</span>


{| style="border-spacing:0;width:15.032cm;"
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
| colspan="5" | Endpoint : http://IP/MAC Address
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| Path (RD)
|| RT
|| IF
|| Type
|| Unit
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| /tp/caps/{#}/{#}
|| tp.caps
|| rp
|| i
|| 
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| /tp/caps/zone1/shutdownon
|| tp.caps.zone1.shutdownon
|| rp
|| i
|| 
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| /tp/cfg/{#}/{#}
|| tp.cfg
|| a
|| i
|| 
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| /tp/cfg/zone1/srcid
|| tp.cfg.zone1.srcid
|| a
|| i
|| 
|-
|}














<div style="text-align:center;">'''Appendix A:'''</div>

<div style="text-align:center;">Restful Api for ISS and JSON</div>

<span style="color:#ff0000;">RD:</span>

POST https://susiissad.management.intelligentsystems.azure.net

/core

/Devices('AIMB-214')

/Microsoft.IntelligentSystems.Services.InvokeAction

?api-version=2014-06-30 HTTP/1.1


{| style="border-spacing:0;width:15.032cm;"
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| Host:
|| susiissad.management.intelligentsystems.azure.net
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| x-ms-iot-account:
|| susiissad
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| Authorization:
|| ApiKey nAdAqlaBM1dj61peni03ZEFj+r88uCAEA6cM2L+/fsE=
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| Accept:
|| application/json;core=verbose
|- style="border:0.5pt solid #00000a;padding-top:0cm;padding-bottom:0cm;padding-left:0.199cm;padding-right:0.191cm;"
|| Content-Type:
|| application/json
|-
|}
<span style="color:#ff0000;">JSON:</span>

{

"Path":"Advantech.EssSusi.DeviceModel.V4/Device('AIMB-214')",

"Action":"Advantech.EssSusi.DeviceModel.V4.SetFanSpeed",

"Parameters":"{

\"fanSpeed\":

{

CpuFanSpeed:2000,

SysFanSpeed:3000

}

}"

}




<div style="text-align:center;">'''Appendix B:'''</div>

<div style="text-align:center;">Restful Api for SenML and JSON</div>


{

"Platform Information": {

"e": [

{

"n": "Boot up times",

"v": 687,

"Id": -1879048191

},

{

"n": "Running time (hours)",

"v": 621,

"Id": -1879048190

},

{

"n": "Board name",

"sv": "DS-570",

"Id": -1879044095

},

{

"n": "BIOS revision",

"sv": "V1.10",

"Id": -1879044092

},

{

"n": "Driver version",

"sv": "4.0.12777",

"Id": -1878982656

},

{

"n": "Library version",

"sv": "4.0.12777",

"Id": -1878982655

},

{

"n": "Firmware version",

"sv": "19.14.512",

"Id": -1878982654

}

],

"bn": "Platform Information",

"Id": -1879048192,

"bt": 1276020076,

"bu": "Info",

"ver": 1

},

"Hardware Monitor": {

"Fan Speed": {},

"Id": 100000,

"Case Open": {},

"Temperature": {

"e": [

{

"n": "CPU",

"v": 46.0,

"min": 0.0,

"max": 100.0,

"Id": 131072

},

{

"n": "Chipset",

"v": 41.0,

"min": 0.0,

"max": 100.0,

"Id": 131073

},

{

"n": "System",

"v": 42.0,

"min": 0.0,

"max": 100.0,

"Id": 131074

}

],

"bn": "Temperature",

"Id": 131327,

"bt": 1276020076,

"bu": "Cel",

"ver": 1

},

"Voltage": {

"e": [

{

"n": "3.3V",

"v": 3.284,

"min": 0.0,

"max": 15.0,

"Id": 135171

},

{

"n": "5V",

"v": 5.02,

"min": 0.0,

"max": 15.0,

"Id": 135172

},

{

"n": "12V",

"v": 12.052,

"min": 0.0,

"max": 15.0,

"Id": 135173

},

{

"n": "5V Standby",

"v": 5.014,

"min": 0.0,

"max": 15.0,

"Id": 135174

},

{

"n": "CMOS Battery",

"v": 2.92,

"min": 0.0,

"max": 15.0,

"Id": 135176

}

],

"bn": "Voltage",

"Id": 135423,

"bt": 1276020076,

"bu": "V",

"ver": 1

},

"Current": {}

}

}


<div style="text-align:center;">'''Appendix C:'''</div>

<div style="text-align:center;">Restful Api for SenML and JSON Version2</div>


{

"Platform Information": {

"e": [

{

"n": "Boot up times",

"v": 687,

"Id": -1879048191

},

{}

],

"bn": "Platform Information",

"Id": -1879048192,

"bt": 1276020076,

"bu": "Info",

"ver": 1

},

"Hardware Monitor": {

"e": [

{

"Fan Speed": {

"e": [

{

"n": "CPU",

"v": 1000

},

{}

],

"bn": "Fan Speed",

"Id": 131327,

"bt": 1276020076,

"bu": "RPM",

"ver": 1

},

"Temperature": {

"e": [

{

"n": "CPU",

"v": 46,

"min": 0,

"max": 100,

"Id": 131072

},

{}

],

"bn": "Temperature",

"Id": 131327,

"bt": 1276020076,

"bu": "Cel",

"ver": 1

},

"Voltage": {

"e": [

{

"n": "3.3V",

"v": 3.284,

"min": 0,

"max": 15,

"Id": 135171

},

{}

],

"bn": "Voltage",

"Id": 135423,

"bt": 1276020076,

"bu": "V",

"ver": 1

},

"Current": {},

"Case Open": {}

},

{}

],

"bn": "Hardware Monitor",

"Id": 100000,

"bt": 1276020076,

"bu": "HWM",

"ver": 1

}

}