API

Vibration info 16100

{
  "tsmId"          : 16100,
  "tsmEv"          : 10,
  "activityLevel"  : 34,
  "energyLevel"    : 400,
  "histogram0"     : 2,   // > 128mG
  "histogram1"     : 14,  // > 300mG
  "histogram2"     : 45,  // > 500mG
  "histogram3"     : 23,  // > 1G
  "histogram4"     : 2,   // > 2G
  "histogram5"     : 1,   // > 3G
  "histogram6"     : 0,   // > 4G
  "histogram7"     : 0,   // > 8G
  "histogram8"     : 0,   // > 12G
  "histogram9"     : 0    // > 16G
}

• activityLevel percentage of detected activity during measurement period.
• energyLevel cumulative sum of detected impact vector above threshold during measurement period. This value doesn’t have units, instead it is indicative value depending on the actual use-case.
• histogram of detected impact vectors during measurement period. The following values will be used as a default
  • histogram0 count of impacts above approx. 128mG
  • histogram1 count of impacts above approx. 300mG
  • histogram2 count of impacts above approx. 500mG
  • histogram3 count of impacts above approx. 1G
  • histogram4 count of impacts above approx. 2G
  • histogram5 count of impacts above approx. 3G
  • histogram6 count of impacts above approx. 4G
  • histogram7 count of impacts above approx. 8G
  • histogram8 count of impacts above approx. 12G
  • histogram9 count of impacts above approx. 16G

Accelerometer sensor configuration 16200

[{
  "tsmId"                      : 16200,
  "transactionId"              : 199882211,
  "intervalMultiplier"         : 1,
  "accelerometerMode"          : 1,
  "orientationHysteresis"      : 5,
  "energyLevelThreshold"       : 1,
  "activityLevelThreshold"     : 0.001,
  "impactThreshold"            : 1,
  "fullScale"                  : 8
}]

This message can be used to remotely configure the accelerometer 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 accelerator 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 accelerator sensor is configured to run at measurement interval of 5 minutes.
• acceleratorMode select mode of operation of accelerator sensor (default: 1). If mode is unsupported by device firmware, default mode ‘1’ is used instead. Different modes supported are:
  • ‘0’: Accelerometer disabled.
  • ‘1’: Orientation mode. Device reports its 3D orientation with "1111 Thing orientation info" message. Orientation is measured at measurement interval and reported immediately if angle between current orientation and previously reported orientation differs more than orientationHysteresis. If there is no significant changes to orientation, orientation is reported at reporting interval.
  • ‘2’: 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. Only reports measurement periods where activity was detected.
• orientationHysteresis is absolute angular reporting threshold for orientation given as degrees value (default: 5 degrees). If orientation vector changes over this many degrees compared to previously reported value, then new orientation is reported.
• energyLevelThreshold is energy level reporting threshold for "16100 Vibration info" message (default: 1). If energyLevel is equal or greater than this value, "16100 Vibration info" event is sent.
• activityLevelThreshold is activity level reporting threshold for "16100 Vibration info" message (default: 0.001 %). If activityLevel is equal or greater than this value, "16100 Vibration info" event is sent.
• impactThreshold is reporting impact threshold for "16100 Vibration info" message (default: 1 mG). If impact equal or greater than this value is observed during measurement period, "16100" Vibration info" event is sent.
• fullScale is full-scale setting for accelerometer (default: 8G). If value is not supported by device, closest supported value is selected.

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"                 : 16200,           //ID of message content
  "tsmEv"                 : 30,              //config request
  "tsmDstTuid"            : "TSPDXXSERIAL1", //destination thing
  "transactionId"         : 2147
}]

Example request to change mode of operation

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

Example response

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