Connect Data Types#
Definitions of Connect data types used by various Connect API functions.
See ember-types.h for source code.
Modules#
Enumerations#
Define the possible types of nodes and the roles that a node might play in a network.
Defines the possible join states for a node.
Child flags.
Message options.
802.15.4 addressing mode.
Either marks an event as inactive or specifies the units for the event execution time.
Define tasks that prevent the stack from sleeping.
Define the event counters that can be requested from the application using emberGetCounter()
Define the PHY configuration of connect stack.
Define the type of calibration requested.
Typedefs#
EUI 64-bit ID (IEEE 802.15.4 long address).
IEEE 802.15.4 node ID. Also known as short address.
IEEE 802.15.4 PAN ID.
Message length in bytes.
An identifier for a task.
An event queue is currently just a list of events ordered by execution time.
Complete events with a control and a handler procedure.
Buffers used by the memory buffer system.
Functions#
This macro allows the programmer to gain access to the key data bytes of the EmberKeyData structure.
Macros#
Size of an extended PAN identifier in bytes (8).
Size of EUI64 (an IEEE address) in bytes (8).
Size of an encryption key in bytes (16).
A distinguished network ID that will never be assigned to any node. Used to indicate the absence of a node ID.
Broadcast address.
Special short address indicating the node should use long addressing as source address.
The coordinator short address.
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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).
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.
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.
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.
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.
540
of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/stack/include/ember-types.h
Event#
typedef struct Event_s Event
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.
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.
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.
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.
[in] | key | A Pointer to an EmberKeyData structure. |
Returns
uint8_t* Returns a pointer to the first byte of the key data.
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_SIZEValue:
8
Size of an extended PAN identifier in bytes (8).
58
of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/stack/include/ember-types.h
EUI64_SIZE#
#define EUI64_SIZEValue:
8
Size of EUI64 (an IEEE address) in bytes (8).
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_SIZEValue:
16
Size of an encryption key in bytes (16).
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_IDValue:
0xFFFFu
A distinguished network ID that will never be assigned to any node. Used to indicate the absence of a node ID.
89
of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/stack/include/ember-types.h
EMBER_BROADCAST_ADDRESS#
#define EMBER_BROADCAST_ADDRESSValue:
0xFFFF
Broadcast address.
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_ADDRESSValue:
0xFFFE
Special short address indicating the node should use long addressing as source address.
96
of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/stack/include/ember-types.h
EMBER_COORDINATOR_ADDRESS#
#define EMBER_COORDINATOR_ADDRESSValue:
0x0000
The coordinator short address.
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_VALUEValue:
(0xFFFFFFFF)
804
of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/stack/include/ember-types.h