Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Custom Templates are possible for Direct Message Types. You can read more about message types and standard templates here. If you need more data than provides a standard template, you are able to create your own template. For doing this you need to use a special Templating Language, which is being processed by Templating Engine.

...

Info

String attributes should be wrapped in quotes.

Attribute

Template Usage

Type

Description

message_trace_id

Code Block
languagejson
"{message_trace_id}"

str

message trace id UUID format

message_time

Code Block
languagejson
"{message_time}"

str

time of receiving a message from a base station

received_time

Code Block
languagejson
"{received_time}"

str

time of receiving a message by the Nwave cloud

device_id

Code Block
languagejson
"{device_id}"

str

device ID in hex format

device_id_dec

Code Block
languagejson
{device_id_dec}

int

device ID in decimal format

signal

Code Block
languagejson
{signal}

float

message signal level

data

Code Block
languagejson
"{data}"

str

raw message payload in hex format

station_id

Code Block
languagejson
{station_id}

int

ID of a station that got the message

custom_id

Code Block
languagejson
"{custom_id}"

str

bound position custom ID or '?' if a custom ID was not set

latitude

Code Block
languagejson
{latitude}

float

latitude parameter of a position

longitude

Code Block
languagejson
{longitude}

float

longitude parameter of a position

floor_number

Code Block
languagejson
{floor_number}

int

position's floor number

network_id

Code Block
languagejson
"{network_id}"

str

network ID of a position

zone_id

Code Block
languagejson
{zone_id}

int

decimal zone ID of a position

group_id

Code Block
languagejson
{group_id}

int

decimal group ID of a position

group_name

Code Block
languagejson
"{group_name}"

str

group name which a position belongs to

group_inner_id

Code Block
languagejson
{group_inner_id}

int

inner ID of a position in a group

Distinct Attributes

Attributes that are different for each message type are accessible under the parsed key.

Message Type

Attribute

Template Usage

Type

Description

Status Change

voltage_V

Code Block
languagejson
{parsed["voltage_V"]}

float

device’s battery voltage

parking_session_iterator

Code Block
languagejson
{parsed["parking_session_iterator"]}

int

a number which is incremented after every occupancy

Not available for LoRa sensors

occupation_status

Code Block
languagejson
{parsed["occupation_status"]}

boolean

“true” if a sensor is occupied, otherwise - “false”

previous_occupancy_status_duration_min

Code Block
languagejson
{parsed["previous_occupancy_status_duration_min"]}

int

duration of a sensor previous state, this field can help if the previous message was not received by any station

Heartbeat

voltage_V

Code Block
languagejson
{parsed["voltage_V"]}

float

device’s battery voltage

parking_session_iterator

Code Block
languagejson
{parsed["parking_session_iterator"]}

int

a number which is incremented after every occupancy

Not available for LoRa sensors

occupation_status

Code Block
languagejson
{parsed["occupation_status"]}

boolean

“true” if a sensor is occupied, otherwise - “false”

heartbeat_message_counter

Code Block
languagejson
{parsed["heartbeat_message_counter"]}

int

number of heartbeat messages sent during an unchanged occupancy state

User Registration

voltage_V

Code Block
languagejson
{parsed["voltage_V"]}

float

device’s battery voltage

parking_session_iterator

Code Block
languagejson
{parsed["parking_session_iterator"]}

int

a number which is incremented after every occupancy

Not available for LoRa sensors

occupation_status

Code Block
languagejson
{parsed["occupation_status"]}

boolean

“true” if a sensor is occupied, otherwise - “false”

user_ID

Code Block
languagejson
"{parsed["user_ID"]}"

str

an ID of Bluetooth tag which was used for authorization