Namespace: types

Type Definitions

types.FieldObject

Field definition. Certain type-specific properties are required.

Properties:

Name	Type	Argument	Description
name	String		Unique name for the field within a Message
type	String		A valid field type value from FieldType
description	String	<optional>	Optional description
size	number	<optional>	Type-specific requirement/interpretation
optional	boolean	<optional>	Flag allowing optional presence of the field
fixed	boolean	<optional>	Type-specific optional flag for fixed-size string, data or array
items	Array.<String>	<optional>	Required for enum type only
fields	Array.<Field>	<optional>	Required for array and bitkeylist types

types.FieldTypeObject

Enumeration of types (placeholder)

types.MessageObject

Message definition. Typically include 1 or more Field but could represent a 2-byte command.

Properties:

Name	Type	Argument	Description
messageKey	number		Directionally-unique within Service [0..255]. 2nd byte of raw payload sent over-the-air.
name	String		Unique within Service
description	String	<optional>	Optional description
fields	Array.<Field>		List of Fields comprising the message content

types.NimoCodecObject

NIM Codec definition

Properties:

Name	Type	Description
nimoCodecKey	Object	Common tag indicating NIM codec definition Properties Name Type Description services Array.<Service> The list of Service definitions

types.ServiceObject

Service definition must have at least 1 Message in uplink or downlink. Message keys can be reused between uplink or downlink though the intent is to match downlink command with uplink response.

Properties:

Name	Type	Argument	Description
serviceKey	number		Unique within NimCodec [0..255]. 1st byte of raw payload sent over-the-air. 0..15 reserved for system use.
name	String		Unique within NimCodec
description	String	<optional>	Optional description
uplinkMessages	Array.<Message>	<optional>	Mobile-Originated Messages
downlinkMessages	Array.<Message>	<optional>	Mobile-Terminated Messages