Thingsee Environment Profile (12000-12999)

Weather info 12100

Air pressure is given as pascals, relative humidity as percentage, temperature as Celsius and light as light-level.

{
  "airp" : Number, //optional
  "humd" : Number, //optional
  "temp" : Number, //optional
  "lght" : Number  //optional
}

Example

{
  "airp" : 102092.358,  // 1020 hPa
  "humd" : 67.2,        // 67.2 %, relative humidity
  "temp" : 22.5,        // 22.5 °C
  "lght" : 270          // 270
}

Magneto switch info 12101

Magneto switch (hall sensor) can be used to detected open doors, windows etc objects where magnetic field is changed.

{
  "hall"      : Number,  // required
  "hallCount" : Number   // optional
}

Example

{
  "hall"      : 0
  "hallCount" : 2
}

hall value defines the current, or last known, state of hall sensor.

  • 0 = open
  • 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.

Leakage resistance data 12102

Resistance given as ADC reading from leakage sensor. Unit is ohms.

{
  "resistance": 1023
}

Environment sensor configuration 12200

[{
  "tsmId"             : 12200,
  "transactionId"     : 199882211,
  "accelerometerMode" : 0,
  "weatherMode"       : 0,
  "hallMode"          : 0,
  "leakageMode"       : 0
}]

This message can be used to remotely configure how sensor configures its behaviour and reports sensor values.

Optional fields:

  • transactionId is an integer value in range 0 to 2147483647. Transaction ID is reported back as is.

Configuration fields:

  • accelerometerMode selects mode of operation of accelerometer. If mode is unsupported by device firmware, default mode ‘0’ is used instead. Different modes supported are:
    • ‘-1’: Accelerometer disabled.
    • ‘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.
    • ‘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 mode is unsupported by device firmware, default mode ‘0’ is used instead. Different modes supported are:
    • ‘-1’: Weather sensor reporting disabled.
    • ‘0’: Report weather information at report interval rate.
  • hallMode select mode of operation of magnetic/hall switch sensor (see Magneto switch info 12101). If mode is unsupported by device firmware, default mode ‘0’ is used instead. Different modes supported are:
    • ‘-1’: Magnetic/hall sensor reporting disabled.
    • ‘0’: Report magnetic/hall information at report interval rate.
    • ‘1’: Report only changes.
  • leakageMode select mode of operation of leakage resistance sensor (see Leakage resistance info 12102). If mode is unsupported by device firmware, default mode ‘0’ is used instead. Different modes supported are:
    • ‘0’: Leakage sensor reporting disabled.
    • ‘1’: Report leakage information at report interval rate.

If any configuration field is omitted from configuration message, device reports back current setting.

A sensor application must reply with the same message (applied configuration values) with an tsmEv : 31.

Example request to read current configuration

[{
  "tsmId"             : 12200,           //ID of message content
  "tsmEv"             : 30,              //config request
  "tsmDstTuid"        : "TSPDXXSERIAL1", //destination thing
  "transactionId"     : 2147
}]

Example request to change accelerometer mode

[{
  "tsmId"             : 12200,           //ID of message content
  "tsmEv"             : 30,              //config request
  "tsmDstTuid"        : "TSPDXXSERIAL1", //destination thing
  "transactionId"     : 2147,
  "accelerometerMode" : 2
}]

Example response

[{
  "tsmId"             : 12200, //ID of message content
  "tsmEv"             : 31,   //config update response
  "tsmTs"             : 1492604004, //message timestamp
  "tsmTuid"           : "TSPDXXSERIAL1", //originating thing
  "transactionId"     : 2147,
  "accelerometerMode" : 2,
  "weatherMode"       : -1,
  "hallMode"          : 2,
  "leakageMode        : 0
}]

Weather sensor configuration 12210

[{
  "tsmId"                 : 12210,
  "transactionId"         : 199882211,
  "intervalMultiplier"    : 1,
  "weatherMode"           : 1,
  "temperatureHysteresis" : 0.5,
  "humidityHysteresis"    : 2,
  "pressureHysteresis"    : 20,
  "lightHysteresis"       : 100
}]

This message can be used to remotely configure the weather sensors.

Optional fields:

  • transactionId is an integer value in range 0 to 2147483647. Transaction ID is reported back as is.

Configuration fields:

  • intervalMultiplier is used to multiply measurement interval for weather sensors (default: 1). For example, if measurement interval is configured at 60 seconds (with Sensor Application Interval Configuration (1500) message) and multiplier is 5, then weather sensors are configured to run at measurement interval of 5 minutes.
  • weatherMode select mode of operation of weather sensors (default: 1). If mode is unsupported by device firmware, default mode ‘1’ is used instead. Different modes supported are:
    • ‘0’: Weather sensors are disabled.
    • ‘1’: Weather sensors are enabled. Measurements are performed at measurement interval and significant changes to previosly reported values are reported immediately. Thresholds for immediate reporting are configured with settings temperatureHysteresis, humidityHysteresis, pressureHysteresis and lightHysteresis. If there is no significant changes to measured values, weather sensor values are reported at reporting interval.
  • temperatureHysteresis is absolute reporting threshold for temperature given as degrees Celsius value (default: 0.5 °C).
  • humidityHysteresis is absolute reporting threshold for humidity given as relative humidity percentage value (default: 2 RH-%).
  • pressureHysteresis is absolute reporting threshold for pressure given as Pascal value (default: 20 Pa).
  • lightHysteresis is absolute reporting threshold for light-level (default: 100).

If any configuration field is omitted from configuration message, device reports back current setting.

A sensor application must reply with the same message (applied configuration values) with an tsmEv : 31.

Example request to read current configuration

[{
  "tsmId"                 : 12210,           //ID of message content
  "tsmEv"                 : 30,              //config request
  "tsmDstTuid"            : "TSPDXXSERIAL1", //destination thing
  "transactionId"         : 2147
}]

Example request to change temperature hysteresis

[{
  "tsmId"                 : 12210,           //ID of message content
  "tsmEv"                 : 30,              //config request
  "tsmDstTuid"            : "TSPDXXSERIAL1", //destination thing
  "transactionId"         : 2147,
  "temperatureHysteresis" : 5
}]

Example response

[{
  "tsmId"                 : 12210, //ID of message content
  "tsmEv"                 : 31,   //config update response
  "tsmTs"                 : 1492604004, //message timestamp
  "tsmTuid"               : "TSPDXXSERIAL1", //originating thing
  "transactionId"         : 2147,
  "intervalMultiplier"    : 1,
  "weatherMode"           : 1,
  "temperatureHysteresis" : 5,
  "humidityHysteresis"    : 2,
  "pressureHysteresis"    : 20,
  "lightHysteresis"       : 100
}]

Magneto switch sensor configuration 12211

[{
  "tsmId"                 : 12211,
  "transactionId"         : 199882211,
  "intervalMultiplier"    : 1,
  "hallMode"              : 1
}]

This message can be used to remotely configure the magneto switch (hall) sensor.

Optional fields:

  • transactionId is an integer value in range 0 to 2147483647. Transaction ID is reported back as is.

Configuration fields:

  • intervalMultiplier is used to multiply measurement interval for magneto switch sensor (default: 1). For example, if measurement interval is configured at 60 seconds (with Sensor Application Interval Configuration (1500) message) and multiplier is 5, then magneto switch sensor is configured to run at measurement interval of 5 minutes.
  • hallMode select mode of operation of magneto switch sensor (default: 1). If mode is unsupported by device firmware, default mode ‘1’ is used instead. Different modes supported are:
    • ‘0’: Magneto switch sensor are disabled.
    • ‘1’: Magneto switch sensor are enabled. Sensor state is tracked over period of measurement interval and any state change is then reported immediately. If there is no state change, current state is reported at reporting interval.

If any configuration field is omitted from configuration message, device reports back current setting.

A sensor application must reply with the same message (applied configuration values) with an tsmEv : 31.

Example request to read current configuration

[{
  "tsmId"                 : 12211,           //ID of message content
  "tsmEv"                 : 30,              //config request
  "tsmDstTuid"            : "TSPDXXSERIAL1", //destination thing
  "transactionId"         : 2147
}]

Example request to change mode of operation

[{
  "tsmId"                 : 12211,           //ID of message content
  "tsmEv"                 : 30,              //config request
  "tsmDstTuid"            : "TSPDXXSERIAL1", //destination thing
  "transactionId"         : 2147,
  "hallMode"              : 1
}]

Example response

[{
  "tsmId"                 : 12211, //ID of message content
  "tsmEv"                 : 31,   //config update response
  "tsmTs"                 : 1492604004, //message timestamp
  "tsmTuid"               : "TSPDXXSERIAL1", //originating thing
  "transactionId"         : 2147,
  "intervalMultiplier"    : 1,
  "hallMode"              : 1
}]

Leakage sensor configuration 12212

[{
  "tsmId"                 : 12212,
  "transactionId"         : 199882211,
  "intervalMultiplier"    : 1,
  "leakageMode"           : 1,
  "resistanceHysteresis"  : 10000
}]

This message can be used to remotely configure the leakage resistance sensor.

Optional fields:

  • transactionId is an integer value in range 0 to 2147483647. Transaction ID is reported back as is.

Configuration fields:

  • intervalMultiplier is used to multiply measurement interval for resistance sensor (default: 1). For example, if measurement interval is configured at 60 seconds (with Sensor Application Interval Configuration (1500) message) and multiplier is 5, then resistance sensor is configured to run at measurement interval of 5 minutes.
  • leakageMode select mode of operation of leakage resistance sensor (default: 0). If mode is unsupported by device firmware, default mode ‘0’ is used instead. Different modes supported are:
    • ‘0’: Leakage sensor disabled.
    • ‘1’: Leakage sensor enabled. Leakage sensor is measured at measurement interval and reported immediately if value differs to previously reported more than resistanceHysteresis. If there is no significant changes to resistance value, resistance is reported at reporting interval.
  • resistanceHysteresis is absolute reporting threshold for resistance given as Ohm value (default: 10000 Ohm).

If any configuration field is omitted from configuration message, device reports back current setting.

A sensor application must reply with the same message (applied configuration values) with an tsmEv : 31.

Example request to read current configuration

[{
  "tsmId"                 : 12212,           //ID of message content
  "tsmEv"                 : 30,              //config request
  "tsmDstTuid"            : "TSPDXXSERIAL1", //destination thing
  "transactionId"         : 2147
}]

Example request to change mode of operation

[{
  "tsmId"                 : 12212,           //ID of message content
  "tsmEv"                 : 30,              //config request
  "tsmDstTuid"            : "TSPDXXSERIAL1", //destination thing
  "transactionId"         : 2147,
  "leakageMode"           : 1
}]

Example response

[{
  "tsmId"                 : 12212, //ID of message content
  "tsmEv"                 : 31,   //config update response
  "tsmTs"                 : 1492604004, //message timestamp
  "tsmTuid"               : "TSPDXXSERIAL1", //originating thing
  "transactionId"         : 2147,
  "intervalMultiplier"    : 1,
  "leakageMode"           : 1,
  "resistanceHysteresis"  : 10000
}]
Previous
Next