Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

HTTP Template is a rule of building an outgoing HTTP request. A template specified a rule of building request method, URL, HTTP headers, and request body. A template is applied to an incoming message from devices, which has been parsed and enriched by information about the device. For the convenient building of templates, Nwave created a special template language which will be explained further in this document.

...

  • message_trace_id - a message trace id;

  • message_time - a time of receiving a message from a base stationsstation;

  • received_time - a time of receiving a message by the Nwave cloud;

  • device_id - a device ID in decimal hex format;

  • modemdevice_id_dec - a device ID in hex decimal format;

  • signal - a message signal level;

  • data - a raw message payload in hex format;

  • station_id - an ID of a station which that got the message;

  • custom_id - a bound position custom ID or '?' if a custom ID was not set;

  • latitude - a latitude parameter of a position;

  • longitude - a longitude parameter of a position;

  • level - position's level (e.g. ground, 1st);

  • network_id - a network ID of a position;

  • zone_id - a decimal zone ID of a position;

  • group_id - a decimal group ID of a position;

  • group_name - a group name which a position belongs to;

  • group_inner_id - an inner ID of a position in a group;

  • parsed - a parsed message. It contains different data, depending on device type, firmware type, and message type.

Parking sensor parsed message objects

...

  • voltage_V - device’s battery voltage;

  • parking_session_iterator - a number which is incremented after every occupancy;

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

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

...

For retrieving a value of any field from source data you need to use source data field name surrounded by braces. This rule works for all fields except of for parsed data fields. For retrieving any value from parsed data you need to use the following format: {parsed['<field name>']}.

...

HTTP template suites are used for uniting HTTP templates, which are applied to different (or the same) message types. Also, HTTP Template Suites are data routing entities. You can configure data routing from a device’s zone or a group only to an HTTP Template Suite, but not to an individual HTTP Template.

...