ThingseeWiki

Thingsee IoT Platform Technical Documentation

User Tools

Site Tools


messages:thingsee_messages_environment_profile

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
messages:thingsee_messages_environment_profile [2019/02/21 19:03]
tmuvee ↷ Page moved from thingsee_messages:thingsee_messages_environment_profile to messages:thingsee_messages_environment_profile
messages:thingsee_messages_environment_profile [2019/02/22 06:33] (current)
tmuvee
Line 1: Line 1:
-<​markdown>​ +====== ​Thingsee Environment Profile (12) ======
-Thingsee Environment Profile (12)+
  
-## Weather info 12100+===== Weather info 12100 =====
  
 Air pressure is given as pascals, relative humidity as percentage, temperature as Celsius and light as lux. Air pressure is given as pascals, relative humidity as percentage, temperature as Celsius and light as lux.
  
-``` +<​Code:​js>​
-// JSON+
 { {
   "​airp"​ : Number, //optional   "​airp"​ : Number, //optional
Line 14: Line 12:
   "​lght"​ : Number ​ //optional   "​lght"​ : Number ​ //optional
 } }
-```+</​Code>​
  
 Example Example
  
-``` +<​Code:​js>​{
-// JSON +
-{+
   "​airp"​ : 102092.358, ​ // 1020 hPa   "​airp"​ : 102092.358, ​ // 1020 hPa
   "​humd"​ : 67.2,        // 67.2 %, relative humidity   "​humd"​ : 67.2,        // 67.2 %, relative humidity
Line 26: Line 22:
   "​lght"​ : 270          // 270 lux   "​lght"​ : 270          // 270 lux
 } }
-```+</​Code>​
  
-## Magneto switch info 12101+===== Magneto switch info 12101 =====
  
 Magneto switch (hall sensor) can be used to detected open doors, windows etc objects where magnetic field is changed. Magneto switch (hall sensor) can be used to detected open doors, windows etc objects where magnetic field is changed.
  
-``` +<​Code:​js>​
-// JSON+
 { {
   "​hall" ​     : Number, ​ // required   "​hall" ​     : Number, ​ // required
   "​hallCount"​ : Number ​  // optional   "​hallCount"​ : Number ​  // optional
 } }
-```+</​Code>​
  
  
 Example Example
  
-``` +<​Code:​js>​
-// JSON+
 { {
   "​hall" ​     : 0   "​hall" ​     : 0
   "​hallCount"​ : 2   "​hallCount"​ : 2
 } }
-```+</​Code>​
  
 **hall** value defines the current, or last known, state of hall sensor. **hall** value defines the current, or last known, state of hall sensor.
  
-* 0 = open +  ​* 0 = open 
-* 1 = closed+  * 1 = closed
  
 **hallCount** is the number of detected state changes during a measurement period. For example, value 2 indicates that the sensor went from state A -> B -> A one time. This value can be used to count how many times window/door has been opened, and to determine its start and end states. **hallCount** is the number of detected state changes during a measurement period. For example, value 2 indicates that the sensor went from state A -> B -> A one time. This value can be used to count how many times window/door has been opened, and to determine its start and end states.
  
-### Leakage resistance data 12102+===== Leakage resistance data 12102 =====
  
 Resistance given as ADC reading from leakage sensor. Unit is ohms. Resistance given as ADC reading from leakage sensor. Unit is ohms.
  
-``` +<​Code:​js>​
-// JSON+
 { {
   "​resistance":​ 1023   "​resistance":​ 1023
 } }
-```+</​Code>​
  
-## Environment sensor configuration 12200+===== Environment sensor configuration 12200 =====
  
-```+<​Code:​js>​
 [{ [{
   "​tsmId" ​     : 12200, //ID of message content   "​tsmId" ​     : 12200, //ID of message content
Line 83: Line 76:
   "​leakageMode"​ : 0 // optional   "​leakageMode"​ : 0 // optional
 }] }]
-```+</​Code>​
  
 This message can be used to remotely configure how sensor configures its behaviour and reports sensor values. This message can be used to remotely configure how sensor configures its behaviour and reports sensor values.
Line 89: Line 82:
 **accelerometerMode** selects mode of operation of accelerometer. If this value is omitted from 12200 message, accelerometer mode is not changed and device reports back current setting. If mode is unsupported by device firmware, default mode '​0'​ is used instead. Different modes supported are: **accelerometerMode** selects mode of operation of accelerometer. If this value is omitted from 12200 message, accelerometer mode is not changed and device reports back current setting. If mode is unsupported by device firmware, default mode '​0'​ is used instead. Different modes supported are:
  
-'​-1':​ Accelerometer disabled. +  * '​-1':​ Accelerometer disabled. 
-'​0':​ Orientation mode. Device reports its 3D orientation with "1111 Thing orientation info" message. +  ​* ​'​0':​ Orientation mode. Device reports its 3D orientation with "1111 Thing orientation info" message. 
-'​1':​ Machine monitoring mode. Device reports vibration histogram with "16100 Vibration info" message. Device may also report its 3D orientation with "1111 Thing orientation info" message. +  ​* ​'​1':​ Machine monitoring mode. Device reports vibration histogram with "16100 Vibration info" message. Device may also report its 3D orientation with "1111 Thing orientation info" message. 
-'​2':​ Machine monitoring mode, same messages as mode '​1'​. Only reports measurement periods where activity was detected.+  ​* ​'​2':​ Machine monitoring mode, same messages as mode '​1'​. Only reports measurement periods where activity was detected.
  
 **weatherMode** select mode of operation of weather sensors (see Weather info 12100). If this value is omitted from 12200 message, weather mode is not changed and device reports back current setting. If mode is unsupported by device firmware, default mode '​0'​ is used instead. Different modes supported are: **weatherMode** select mode of operation of weather sensors (see Weather info 12100). If this value is omitted from 12200 message, weather mode is not changed and device reports back current setting. If mode is unsupported by device firmware, default mode '​0'​ is used instead. Different modes supported are:
  
-'​-1':​ Weather sensor reporting disabled. +  * '​-1':​ Weather sensor reporting disabled. 
-'​0':​ Report weather information at report interval rate.+  ​* ​'​0':​ Report weather information at report interval rate.
  
 **hallMode** select mode of operation of magnetic/​hall switch sensor (see Magneto switch info 12101). If this value is omitted from 12200 message, hall mode is not changed and device reports back current setting. If mode is unsupported by device firmware, default mode '​0'​ is used instead. Different modes supported are: **hallMode** select mode of operation of magnetic/​hall switch sensor (see Magneto switch info 12101). If this value is omitted from 12200 message, hall mode is not changed and device reports back current setting. If mode is unsupported by device firmware, default mode '​0'​ is used instead. Different modes supported are:
  
-'​-1':​ Magnetic/​hall sensor reporting disabled. +  * '​-1':​ Magnetic/​hall sensor reporting disabled. 
-'​0':​ Report magnetic/​hall information at report interval rate. +  ​* ​'​0':​ Report magnetic/​hall information at report interval rate. 
-'​1':​ Report only changes.+  ​* ​'​1':​ Report only changes.
  
 **leakageMode** select mode of operation of leakage resistance sensor (see Leakage resistance info 12102). If this value is omitted from 12200 message, leakage mode is not changed and device reports back current setting. If mode is unsupported by device firmware, default mode '​-1'​ is used instead. Different modes supported are: **leakageMode** select mode of operation of leakage resistance sensor (see Leakage resistance info 12102). If this value is omitted from 12200 message, leakage mode is not changed and device reports back current setting. If mode is unsupported by device firmware, default mode '​-1'​ is used instead. Different modes supported are:
  
-'​-1':​ Leakage sensor reporting disabled. +  * '​-1':​ Leakage sensor reporting disabled. 
-'​0':​ Report leakage information at report interval rate.+  ​* ​'​0':​ Report leakage information at report interval rate.
  
 A sensor application must reply with the same message (applied configuration values) with an **tsmEv : 31**. A sensor application must reply with the same message (applied configuration values) with an **tsmEv : 31**.
Line 114: Line 107:
 **Example response** **Example response**
  
-```+<​Code:​js>​
 [{ [{
   "​tsmId" ​     : 12200, //ID of message content   "​tsmId" ​     : 12200, //ID of message content
Line 123: Line 116:
   "​accelerometerMode"​ : 0   "​accelerometerMode"​ : 0
 }] }]
-``` +</Code>
- +
-</markdown>+
messages/thingsee_messages_environment_profile.txt · Last modified: 2019/02/22 06:33 by tmuvee