Connect Data Types

Connect Stack API Reference

Messages are waiting for transmission.

One or more incoming messages are processed.

The radio is currently powered on. On sleepy devices, the radio is turned off when not in use. On non-sleepy devices, i.e., EMBER_STAR_COORDINATOR, EMBER_STAR_RANGE_EXTENDER, EMBER_STAR_END_DEVICE, or EMBER_MAC_MODE_DEVICE, the radio is always on.

The node is currently trying to associate to a Connect network.

The node is currently performing a MAC-level scanning procedure.

The child is a range extender.

The child is a sleepy end device.

The node has data pending for the child.

The child supports AES-based security.

Every packet that comes in over the radio (except MAC ACKs).

Every packet that goes out over the radio (except MAC ACKs).

Incoming MAC layer unicasts.

Incoming MAC layer broadcasts.

Outgoing MAC layer unicasts that do not require an ACK.

Outgoing MAC layer unicasts that required an ACK, for which an ACK was received (possibly after retrying).

Outgoing MAC layer unicasts that required an ACK, for which an ACK was never received (even after retrying).

Outgoing MAC layer packets which were never transmitted because clear channel assessment always returned busy.

Outgoing MAC layer unicast retries. This does not count the initial transmission. Note a single MAC transmission can result in multiple retries.

Outgoing MAC layer broadcasts

Outgoing MAC layer broadcasts which were never transmitted because clear channel assessment always returned busy.

Outgoing MAC layer messages which were not transmitted due to security error e.g. because security key was not set.

Dropped incoming MAC layer packets (out of memory)

Dropped incoming MAC layer packets (invalid frame counter)

Dropped incoming MAC layer packets (can't decrypt)

Outgoing Network layer forwarded packets

Incoming Network layer data frames correctly processed

Dropped incoming Network layer packets (wrong source node)

Dropped incoming Network layer packets (can't forward)

NCP UART in data packet

NCP UART in management packet

NCP UART in frame errors

NCP UART out data packet

NCP UART out management packet

NCP UART out frame errors

ASHv3 ACK frame sent

ASHv3 ACK frame received

ASHv3 NACK frame sent

ASHv3 NACK frame received

ASHv3 resends of frames that were not acked

ASHv3 number of bytes sent

ASHv3 number of bytes received

ASHv3 number of valid bytes received

ASHv3 number of payload bytes sent

A placeholder giving the number of Ember counter types.

The event is not scheduled to run.

The execution time is in approximate milliseconds.

The execution time is in 'binary' quarter seconds (256 timer ticks).

The execution time is in 'binary' minutes (65536 timer ticks).

The event is scheduled to run at the earliest opportunity.

No address on this field.

Short addressing mode.

Long addressing mode.

No options.

The packet should be sent out encrypted.

An acknowledgment should be requested for the outgoing packet.

The packet should be sent with high priority. High priority messages are added to the head of transmit queue, other messages are added to the tail.

The packet should be sent via the indirect queue. This option only applies to nodes with EMBER_MAC_MODE_DEVICE or EMBER_MAC_MODE_SLEEPY_DEVICE node type.

The node is not associated with a network in any way.

The node is currently attempting to join a network.

The node is joined to a network.

Device is not in network.

Extended star mode device: Will relay messages and can act as a parent to range extender and end device nodes. A node can be started as a coordinator using the emberFormNetwork() API.

Extended star mode device: Will relay messages and can act as a parent to end device nodes. Joins to a coordinator. A node can be started as a range extender using the emberJoinNetwork() or emberJoinNetworkExtended() API.

Extended star mode device: Communicates only with its parent and will not relay messages. A node can be started as an end device using the emberJoinNetwork() or emberJoinNetworkExtended() API.

Extended star mode device: An end device whose radio is turned off when not communicating to save power. The application must call emberPollForData() to receive messages. A node can be started as a sleepy end device using the emberJoinNetwork() or emberJoinNetworkExtended() API.

Direct mode device: A device able to send and receive messages from other devices in range on the same PAN ID, with no star topology restrictions. Such device does not relay messages. A node can be started as a direct device by using the emberJoinCommissioned() API.

MAC mode device: A device able to send and receive MAC-level messages. A node can be started as a MAC mode device by using the emberJoinCommissioned(), the emberJoinNetworkExtended() or the emberMacFormNetwork() API.

MAC mode device: A sleepy device able to send and receive MAC-level messages. The radio on the device is turned off when not communicating. The application must call emberPollForData() to receive messages. A node can be started as a sleepy MAC mode device by using the emberJoinCommissioned() API or the emberJoinNetworkExtended() API.