0x88xx

0x8800 - Temperature

Type: s16

Name: temperature (1)

Temperature value is in (°C * 100)

JSON

[number] // Unit: Celsius

0x8801 - Pressure

Type: u32

Name: pressure (1)

Pressure value is in (hPa * 1000000)

JSON

[number] // Unit: hPa

0x8802 - Humidity

Type: u16

Name: humidity (1)

Humidity value is in (percentage * 10)

JSON

[number] // percentage

0x8803 - Light Intensity

Type: u16

Name: light-intensity (1)

Light intensity (illuminance) value in Lux.

0x8806 - Pressure Hysteresis

Type: u16

Name: pressure-hysteresis (4)

JSON

[number] // Unit: hPa

This value configures pressure hysteresis. Set to 0 to disable pressure hysteresis.

Max value: 4096

Pressure unit: hPa

0x8807 - TMP116 ID

Type: bytearray(8)

Name: tmp116-id (14)

Unique, factory-programmed 64-bit ID stored in TMP116 EEPROM that enables NIST traceability, ensuring the sensor meets high-accuracy standards verified against calibrated, ISO/IEC 17025 accredited equipment.

0x8808 - CO2

Type: u16

Name: co2 (14)

CO2 in ppm.

0x8809 - ToF Distance

Type: u16

Name: tof-distance (17)

Distance measured by ToF sensor in mm.

0x8810 - Motion

Type: u8

Name: motion (1)

Motion state with cause. A value other than 0 indicates motion.

Extensions are not used when motion is reported as timestamped data.

Value

Description

0x00

Not in motion

0x01

Motion (unknown cause)

0x10

Motion due to accelerometer channel 1

0x11

Motion due to accelerometer channel 2

0x20

Motion due to PIR sensor active

Extensions

Offset

Type

Description

Dictionary Version

1:4

u32

Transition Counter

4

5

u8

Flags

4

Flags bit

Name

Description

7:1

-

Reserved

0

Transition

Set on motion state transition (zero -> nonzero, nonzero -> zero)

JSON

{
  "transitionCounter": [number],
  "isTransition": [boolean]
}

The Transition Counter is incremented every time motion state changes from zero to non-zero and non-zero to zero. This counter can be used to detect missing motion events.

The Transition flag is set when motion is reported and there is a transition in motion state since last time it was reported.

0x8813 - Total Minutes In Motion

Type: u32

Name: total-minutes-in-motion (1)

Total minutes device remained in motion. It will increase till 0xFFFFFFFF and stay there.

0x8820 - Accelerometer Data

Offset

Field

Description

0:1

AX

0 degree = -1g, 90 degrees = 0g, 180 degrees = 1g

2:3

AY

0 degree = -1g, 90 degrees = 0g, 180 degrees = 1g

4:5

AZ

0 degree = -1g, 90 degrees = 0g, 180 degrees = 1g

6:7

MG

Calculated acceleration vector in mg (mill g)

Note

If AX, AY, AZ is 999, it means: Angle measurement not active.

Note

If MG is 0xFFFF, it means: Calculated acceleration vector: An error or unavailable.

Name: accelerometer-data (1)

JSON

{
  "ax": [number],
  "ay": [number],
  "az": [number],
  "mg": [number]
}

0x8830 - Hall Effect

Type: u8

Name: hall-effect (1)

For devices that need to report hall effect state in real-time.

Value

Description

0

Inactive

1

Active

Extensions

Offset

Type

Description

Dictionary Version

1:6

u48

Previous state time (ms)

13

JSON

{
  "previousStateTime": [number]
}

The previousStateTime is number of milliseconds Hall Effect was in previous state. This can be useful to very accurately measure how long it takes for the sensor to pass magnets.

0x8831 - Hall Effect Counter

Type: u32

Name: hall-effect-counter (1)

Total hall effect interrupt count. It will increase till 0xFFFFFFFF and return to 0 and again increase to 0xFFFFFFFF and repeat sequence.

0x8832 - RPM

Type: u16

Name: rpm (12)

RPM measurement.

0x8833 - Hall Effect 2

Name: hall-effect-2 (17)

Offset

Field

Description

0

STATE

0: Inactive, 1 active

1:3

PST

Previous State Time (in ms), unsigned 24-bit. The value saturates at 0xFFFFFF.

For devices that need to report hall effect state in real-time. PST is the number of milliseconds Hall Effect was in the previous state. This can be useful to very accurately measure how long it takes for the sensor to pass magnets.

JSON

{
  "state": 1,
  "previousStateTime": 450
}

0x8840 - Mains Voltage

Type: u32

Name: mains-voltage (3)

Voltage value is in (V * 1000)

0x8841 - Mains Current

Type: s32

Name: mains-current (3)

Current value is in (A * 10000)

0x8842 - Mains Power

Type: s32

Name: mains-power (3)

Power value is in (W * 10000)

0x8850 - EnOcean Config (BETA)

Name: enocean-config (9)

Offset

Type

Description

0

u8

Mode

1

u8

Priority: 0-4

Mode

Description

0

Disabled

1

Enabled (no authentication)

JSON:

JSON Property

Type

Description

mode

number

Mode

priority

number

Priority

JSON Example (press/release):

{
  "mode": 1,
  "priority": 2
}

0x8858 - EnOcean PTM 215B Data (BETA)

Name: enocean-ptm-215b-data (9)

Note

This is typically reported as an event. The event sequence number is the least significant byte of the 32-bit Sequence Counter in the EnOcean data telegram payload.

Note

Optional Data bytes in EnOcean data telegram payload is ignored.

Offset

Type

Description

0

u8

Switch Status

1:4

u32

Sequence Counter

Switch Status bits

Description

7:5

Reserved (shall be 0b000)

4

B1: 0 = No Action, 1 = Action.

3

B0: 0 = No Action, 1 = Action.

2

A1: 0 = No Action, 1 = Action.

1

A0: 0 = No Action, 1 = Action.

0

ACTION TYPE: 0 = Release Action, 1 = Press Action.

JSON:

JSON Property

Type

Description

button

string

Button ID: “B1”, “B0”, “A1” or “A0”

action

string

Button Action: “press” or “release”

seq

number

Sequence Counter

JSON Example (press/release):

{
  "button": "B1",
  "action": "press",
  "seq": 12    
}
{
  "button": "B1",
  "action": "release",
  "seq": 13
}

0x8860 - Salto Config

Type: json-object

Name: salto-config (11)

This is used to set the Salto configuration. Set to NULL do disable.

JSON Property

Type

Optional

Description

endpoint

string

No

SHIP endpoint

apiKey

string

No

SHIP API Key. Redacted when reading.

doorGpf

number

Yes

General purpose field to use door config. Default value: 1.

userGpf

number

Yes

General purpose field to use user config. Default value: 1.

Note

apiKey is redacted when reading the value.

Example configuration:

{
  "endpoint": "https://desktop-b838adn:8100",
  "apiKey": "mysecretkey123",
  "doorGpf": 1,
  "userGpf": 1
}

0x8861 - Salto Endpoint (BETA)

Type: UTF8

Name: salto-endpoint (11)

Note

Deprecated.

0x8862 - Salto Rssi Threshold (BETA)

Type: sbyte

Name: salto-rssi-threshold (11)

Note

Deprecated.

Default RSSI threshold used to trigger door opening.

0x8863 - Salto Office Mode Rssi Threshold (BETA)

Type: sbyte

Name: salto-office-mode-rssi-threshold (11)

Note

Deprecated.

Default RSSI threshold used to trigger office mode disabling.

0x8864 - Salto Office Mode Rssi Hysteresis (BETA)

Type: byte

Name: salto-office-mode-rssi-hysteresis (11)

Note

Deprecated.

Default RSSI hysteresis used to re-enable office mode.

0x8865 - Salto Sync

Type: void

Name: salto-sync (17)

Sync Salto door/user configuration with Salto Space.