Connect Data Types#

Definitions of Connect data types used by various Connect API functions.

See ember-types.h for source code.

Modules#

EmberNetworkParameters

EmberIncomingMessage

EmberOutgoingMessage

EmberMacAddress

EmberMacFrame

EmberIncomingMacMessage

EmberOutgoingMacMessage

EmberKeyData

EventActions

Event_s

EventQueue_s

EmberEventControl

EmberEventData_S

EmberTaskControl

Enumerations#

enum
EMBER_UNKNOWN_DEVICE = 0
EMBER_STAR_COORDINATOR = 1
EMBER_STAR_RANGE_EXTENDER = 2
EMBER_STAR_END_DEVICE = 3
EMBER_STAR_SLEEPY_END_DEVICE = 4
EMBER_DIRECT_DEVICE = 5
EMBER_MAC_MODE_DEVICE = 6
EMBER_MAC_MODE_SLEEPY_DEVICE = 7
}

Define the possible types of nodes and the roles that a node might play in a network.

enum
EMBER_NO_NETWORK
EMBER_JOINING_NETWORK
EMBER_JOINED_NETWORK
EMBER_RADIO_TEST
}

Defines the possible join states for a node.

enum
EMBER_CHILD_FLAGS_DEVICE_IS_RANGE_EXTENDER_BIT = 0x02
EMBER_CHILD_FLAGS_DEVICE_IS_SLEEPY_BIT = 0x04
EMBER_CHILD_FLAGS_HAVE_PENDING_DATA_BIT = 0x08
EMBER_CHILD_FLAGS_AES_SECURITY_CAPABLE_BIT = 0x10
EMBER_CHILD_FLAG_DEVICE_IS_EXTENDED_BIT = 0x20
}

Child flags.

enum
EMBER_OPTIONS_NONE = 0x00
EMBER_OPTIONS_SECURITY_ENABLED = 0x01
EMBER_OPTIONS_ACK_REQUESTED = 0x02
EMBER_OPTIONS_HIGH_PRIORITY = 0x04
EMBER_OPTIONS_INDIRECT = 0x08
}

Message options.

enum
EMBER_MAC_ADDRESS_MODE_NONE = 0x00
EMBER_MAC_ADDRESS_MODE_SHORT = 0x02
EMBER_MAC_ADDRESS_MODE_LONG = 0x03
}

802.15.4 addressing mode.

enum
EMBER_EVENT_INACTIVE = 0
EMBER_EVENT_MS_TIME
EMBER_EVENT_QS_TIME
EMBER_EVENT_MINUTE_TIME
EMBER_EVENT_ZERO_DELAY
}

Either marks an event as inactive or specifies the units for the event execution time.

enum
@2 {
EMBER_OUTGOING_MESSAGES = 0x0001
EMBER_INCOMING_MESSAGES = 0x0002
EMBER_RADIO_IS_ON = 0x0004
EMBER_ASSOCIATING = 0x0008
EMBER_SCANNING = 0x0010
}

Define tasks that prevent the stack from sleeping.

enum
EMBER_COUNTER_PHY_IN_PACKETS
EMBER_COUNTER_PHY_OUT_PACKETS
EMBER_COUNTER_MAC_IN_UNICAST
EMBER_COUNTER_MAC_IN_BROADCAST
EMBER_COUNTER_MAC_OUT_UNICAST_NO_ACK
EMBER_COUNTER_MAC_OUT_UNICAST_ACK_SUCCESS
EMBER_COUNTER_MAC_OUT_UNICAST_ACK_FAIL
EMBER_COUNTER_MAC_OUT_UNICAST_CCA_FAIL
EMBER_COUNTER_MAC_OUT_UNICAST_RETRY
EMBER_COUNTER_MAC_OUT_BROADCAST
EMBER_COUNTER_MAC_OUT_BROADCAST_CCA_FAIL
EMBER_COUNTER_MAC_OUT_ENCRYPT_FAIL
EMBER_COUNTER_MAC_DROP_IN_MEMORY
EMBER_COUNTER_MAC_DROP_IN_FRAME_COUNTER
EMBER_COUNTER_MAC_DROP_IN_DECRYPT
EMBER_COUNTER_NWK_OUT_FORWARDING
EMBER_COUNTER_NWK_IN_SUCCESS
EMBER_COUNTER_NWK_DROP_IN_WRONG_SOURCE
EMBER_COUNTER_NWK_DROP_IN_FORWARDING
EMBER_COUNTER_UART_IN_DATA
EMBER_COUNTER_UART_IN_MANAGEMENT
EMBER_COUNTER_UART_IN_FAIL
EMBER_COUNTER_UART_OUT_DATA
EMBER_COUNTER_UART_OUT_MANAGEMENT
EMBER_COUNTER_UART_OUT_FAIL
EMBER_COUNTER_ROUTE_2_HOP_LOOP
EMBER_COUNTER_BUFFER_ALLOCATION_FAIL
EMBER_ASH_V3_ACK_SENT
EMBER_ASH_V3_ACK_RECEIVED
EMBER_ASH_V3_NACK_SENT
EMBER_ASH_V3_NACK_RECEIVED
EMBER_ASH_V3_RESEND
EMBER_ASH_V3_BYTES_SENT
EMBER_ASH_V3_TOTAL_BYTES_RECEIVED
EMBER_ASH_V3_VALID_BYTES_RECEIVED
EMBER_ASH_V3_PAYLOAD_BYTES_SENT
EMBER_COUNTER_TYPE_COUNT
}

Define the event counters that can be requested from the application using emberGetCounter()

enum
EMBER_RADIO_CONFIGURATOR
EMBER_STANDARD_PHY_2_4GHZ
EMBER_STANDARD_PHY_915MHZ
EMBER_STANDARD_PHY_863MHZ
}

Define the PHY configuration of connect stack.

enum
EMBER_CAL_TEMP_VCO = 0x00000001
EMBER_CAL_IRCAL = 0x00010000
EMBER_CAL_ALL = 0x00010001
}

Define the type of calibration requested.

enum
TX_STREAM_PN9
TX_STREAM_CW
}

Radio Stream mode.

Typedefs#

typedef uint8_t
EmberEUI64[EUI64_SIZE]

EUI 64-bit ID (IEEE 802.15.4 long address).

typedef uint16_t

IEEE 802.15.4 node ID. Also known as short address.

typedef uint16_t

IEEE 802.15.4 PAN ID.

typedef uint16_t

Message length in bytes.

typedef uint8_t

An identifier for a task.

typedef struct Event_s
typedef struct EventQueue_s

An event queue is currently just a list of events ordered by execution time.

typedef const struct EmberEventData_S

Complete events with a control and a handler procedure.

typedef uint16_t

Buffers used by the memory buffer system.

Functions#

uint8_t *
emberKeyContents(EmberKeyData *key)

This macro allows the programmer to gain access to the key data bytes of the EmberKeyData structure.

Macros#

#define

Size of an extended PAN identifier in bytes (8).

#define

Size of EUI64 (an IEEE address) in bytes (8).

#define

Size of an encryption key in bytes (16).

#define

A distinguished network ID that will never be assigned to any node. Used to indicate the absence of a node ID.

#define

Broadcast address.

#define

Special short address indicating the node should use long addressing as source address.

#define

The coordinator short address.

#define

Enumeration Documentation#

EmberNodeType#

EmberNodeType

Define the possible types of nodes and the roles that a node might play in a network.

Enumerator
EMBER_UNKNOWN_DEVICE
EMBER_STAR_COORDINATOR
EMBER_STAR_RANGE_EXTENDER
EMBER_STAR_END_DEVICE
EMBER_STAR_SLEEPY_END_DEVICE
EMBER_DIRECT_DEVICE
EMBER_MAC_MODE_DEVICE
EMBER_MAC_MODE_SLEEPY_DEVICE

Definition at line 106 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/stack/include/ember-types.h

EmberNetworkStatus#

EmberNetworkStatus

Defines the possible join states for a node.

Enumerator
EMBER_NO_NETWORK
EMBER_JOINING_NETWORK
EMBER_JOINED_NETWORK
EMBER_RADIO_TEST

Definition at line 162 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/stack/include/ember-types.h

EmberChildFlags#

EmberChildFlags

Child flags.

Enumerator
EMBER_CHILD_FLAGS_DEVICE_IS_RANGE_EXTENDER_BIT
EMBER_CHILD_FLAGS_DEVICE_IS_SLEEPY_BIT
EMBER_CHILD_FLAGS_HAVE_PENDING_DATA_BIT
EMBER_CHILD_FLAGS_AES_SECURITY_CAPABLE_BIT
EMBER_CHILD_FLAG_DEVICE_IS_EXTENDED_BIT

Definition at line 198 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/stack/include/ember-types.h

EmberMessageOptions#

EmberMessageOptions

Message options.

Enumerator
EMBER_OPTIONS_NONE
EMBER_OPTIONS_SECURITY_ENABLED
EMBER_OPTIONS_ACK_REQUESTED
EMBER_OPTIONS_HIGH_PRIORITY
EMBER_OPTIONS_INDIRECT

Definition at line 225 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/stack/include/ember-types.h

EmberMacAddressMode#

EmberMacAddressMode

802.15.4 addressing mode.

Enumerator
EMBER_MAC_ADDRESS_MODE_NONE
EMBER_MAC_ADDRESS_MODE_SHORT
EMBER_MAC_ADDRESS_MODE_LONG

Definition at line 338 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/stack/include/ember-types.h

EmberEventUnits#

EmberEventUnits

Either marks an event as inactive or specifies the units for the event execution time.

Enumerator
EMBER_EVENT_INACTIVE
EMBER_EVENT_MS_TIME
EMBER_EVENT_QS_TIME
EMBER_EVENT_MINUTE_TIME
EMBER_EVENT_ZERO_DELAY

Definition at line 521 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/stack/include/ember-types.h

@2#

@2

Define tasks that prevent the stack from sleeping.

Enumerator
EMBER_OUTGOING_MESSAGES
EMBER_INCOMING_MESSAGES
EMBER_RADIO_IS_ON
EMBER_ASSOCIATING
EMBER_SCANNING

Definition at line 623 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/stack/include/ember-types.h

EmberCounterType#

EmberCounterType

Define the event counters that can be requested from the application using emberGetCounter()

Enumerator
EMBER_COUNTER_PHY_IN_PACKETS
EMBER_COUNTER_PHY_OUT_PACKETS
EMBER_COUNTER_MAC_IN_UNICAST
EMBER_COUNTER_MAC_IN_BROADCAST
EMBER_COUNTER_MAC_OUT_UNICAST_NO_ACK
EMBER_COUNTER_MAC_OUT_UNICAST_ACK_SUCCESS
EMBER_COUNTER_MAC_OUT_UNICAST_ACK_FAIL
EMBER_COUNTER_MAC_OUT_UNICAST_CCA_FAIL
EMBER_COUNTER_MAC_OUT_UNICAST_RETRY
EMBER_COUNTER_MAC_OUT_BROADCAST
EMBER_COUNTER_MAC_OUT_BROADCAST_CCA_FAIL
EMBER_COUNTER_MAC_OUT_ENCRYPT_FAIL
EMBER_COUNTER_MAC_DROP_IN_MEMORY
EMBER_COUNTER_MAC_DROP_IN_FRAME_COUNTER
EMBER_COUNTER_MAC_DROP_IN_DECRYPT
EMBER_COUNTER_NWK_OUT_FORWARDING
EMBER_COUNTER_NWK_IN_SUCCESS
EMBER_COUNTER_NWK_DROP_IN_WRONG_SOURCE
EMBER_COUNTER_NWK_DROP_IN_FORWARDING
EMBER_COUNTER_UART_IN_DATA
EMBER_COUNTER_UART_IN_MANAGEMENT
EMBER_COUNTER_UART_IN_FAIL
EMBER_COUNTER_UART_OUT_DATA
EMBER_COUNTER_UART_OUT_MANAGEMENT
EMBER_COUNTER_UART_OUT_FAIL
EMBER_COUNTER_ROUTE_2_HOP_LOOP
EMBER_COUNTER_BUFFER_ALLOCATION_FAIL
EMBER_ASH_V3_ACK_SENT
EMBER_ASH_V3_ACK_RECEIVED
EMBER_ASH_V3_NACK_SENT
EMBER_ASH_V3_NACK_RECEIVED
EMBER_ASH_V3_RESEND
EMBER_ASH_V3_BYTES_SENT
EMBER_ASH_V3_TOTAL_BYTES_RECEIVED
EMBER_ASH_V3_VALID_BYTES_RECEIVED
EMBER_ASH_V3_PAYLOAD_BYTES_SENT
EMBER_COUNTER_TYPE_COUNT

Definition at line 646 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/stack/include/ember-types.h

EmberPhyType#

EmberPhyType

Define the PHY configuration of connect stack.

Enumerator
EMBER_RADIO_CONFIGURATOR
EMBER_STANDARD_PHY_2_4GHZ
EMBER_STANDARD_PHY_915MHZ
EMBER_STANDARD_PHY_863MHZ

Definition at line 765 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/stack/include/ember-types.h

EmberCalType#

EmberCalType

Define the type of calibration requested.

Enumerator
EMBER_CAL_TEMP_VCO
EMBER_CAL_IRCAL
EMBER_CAL_ALL

Definition at line 788 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/stack/include/ember-types.h

EmberTxStreamParameters#

EmberTxStreamParameters

Radio Stream mode.

Enumerator
TX_STREAM_PN9
TX_STREAM_CW

Definition at line 874 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/stack/include/ember-types.h

Typedef Documentation#

EmberEUI64#

typedef uint8_t EmberEUI64[EUI64_SIZE] [EUI64_SIZE]

EUI 64-bit ID (IEEE 802.15.4 long address).


Definition at line 73 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/stack/include/ember-types.h

EmberNodeId#

typedef uint16_t EmberNodeId

IEEE 802.15.4 node ID. Also known as short address.


Definition at line 78 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/stack/include/ember-types.h

EmberPanId#

typedef uint16_t EmberPanId

IEEE 802.15.4 PAN ID.


Definition at line 83 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/stack/include/ember-types.h

EmberMessageLength#

typedef uint16_t EmberMessageLength

Message length in bytes.


Definition at line 219 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/stack/include/ember-types.h

EmberTaskId#

typedef uint8_t EmberTaskId

An identifier for a task.


Definition at line 540 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/stack/include/ember-types.h

Event#

typedef struct Event_s Event

Definition at line 567 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/stack/include/ember-types.h

EventQueue#

typedef struct EventQueue_s EventQueue

An event queue is currently just a list of events ordered by execution time.


Definition at line 575 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/stack/include/ember-types.h

EmberEventData#

typedef const struct EmberEventData_S EmberEventData

Complete events with a control and a handler procedure.

An application typically creates an array of events along with their handlers. The main loop passes the array to emberRunEvents() to call the handlers of any events whose time has arrived.


Definition at line 606 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/stack/include/ember-types.h

EmberBuffer#

typedef uint16_t EmberBuffer

Buffers used by the memory buffer system.


Definition at line 759 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/stack/include/ember-types.h

Function Documentation#

emberKeyContents#

uint8_t * emberKeyContents (EmberKeyData *key)

This macro allows the programmer to gain access to the key data bytes of the EmberKeyData structure.

Parameters
[in]key

A Pointer to an EmberKeyData structure.

Returns

  • uint8_t* Returns a pointer to the first byte of the key data.


Definition at line 511 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/stack/include/ember-types.h

Macro Definition Documentation#

EXTENDED_PAN_ID_SIZE#

#define EXTENDED_PAN_ID_SIZE
Value:
8

Size of an extended PAN identifier in bytes (8).


Definition at line 58 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/stack/include/ember-types.h

EUI64_SIZE#

#define EUI64_SIZE
Value:
8

Size of EUI64 (an IEEE address) in bytes (8).


Definition at line 63 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/stack/include/ember-types.h

EMBER_ENCRYPTION_KEY_SIZE#

#define EMBER_ENCRYPTION_KEY_SIZE
Value:
16

Size of an encryption key in bytes (16).


Definition at line 68 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/stack/include/ember-types.h

EMBER_NULL_NODE_ID#

#define EMBER_NULL_NODE_ID
Value:
0xFFFFu

A distinguished network ID that will never be assigned to any node. Used to indicate the absence of a node ID.


Definition at line 89 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/stack/include/ember-types.h

EMBER_BROADCAST_ADDRESS#

#define EMBER_BROADCAST_ADDRESS
Value:
0xFFFF

Broadcast address.


Definition at line 92 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/stack/include/ember-types.h

EMBER_USE_LONG_ADDRESS#

#define EMBER_USE_LONG_ADDRESS
Value:
0xFFFE

Special short address indicating the node should use long addressing as source address.


Definition at line 96 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/stack/include/ember-types.h

EMBER_COORDINATOR_ADDRESS#

#define EMBER_COORDINATOR_ADDRESS
Value:
0x0000

The coordinator short address.


Definition at line 99 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/stack/include/ember-types.h

EMBER_CAL_INVALID_VALUE#

#define EMBER_CAL_INVALID_VALUE
Value:
(0xFFFFFFFF)

Definition at line 804 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/stack/include/ember-types.h