Connect Data Types
Definitions of Connect data types used by various Connect API functions. More...
Data Structures |
|
struct | EmberNetworkParameters |
Hold network parameters.
More...
|
|
struct | EmberIncomingMessage |
An instance of this structure is passed to
emberIncomingMessageHandler()
. It describes the incoming message.
More...
|
|
struct | EmberOutgoingMessage |
An instance of this structure is passed to
emberMessageSentHandler()
. It describes the outgoing packet.
More...
|
|
struct | EmberMacAddress |
A structure that stores an 802.15.4 address.
More...
|
|
struct | EmberMacFrame |
A structure that describes the addressing fields of a 802.15.4 frame.
More...
|
|
struct | EmberIncomingMacMessage |
An instance of this structure is passed to
emberIncomingMacMessageHandler()
. It describes the incoming MAC frame.
More...
|
|
struct | EmberOutgoingMacMessage |
An instance of this structure is passed to
emberMacMessageSentHandler()
. It describes the outgoing MAC frame.
More...
|
|
struct | EmberKeyData |
This data structure contains the security key, most prominently used by
emberSetSecurityKey
.
More...
|
|
struct | EventActions |
The static part of an event. Each event can be used with only one event queue.
More...
|
|
struct | Event_s |
struct | EventQueue_s |
An event queue is currently just a list of events ordered by execution time.
More...
|
|
struct | EmberEventControl |
Control structure for events.
More...
|
|
struct | EmberEventData_S |
Complete events with a control and a handler procedure.
More...
|
|
struct | EmberTaskControl |
Control structure for tasks.
More...
|
|
Macros |
|
#define | EXTENDED_PAN_ID_SIZE 8 |
Size of an extended PAN identifier in bytes (8).
More...
|
|
#define | EUI64_SIZE 8 |
Size of EUI64 (an IEEE address) in bytes (8).
More...
|
|
#define | EMBER_ENCRYPTION_KEY_SIZE 16 |
Size of an encryption key in bytes (16).
More...
|
|
#define | EMBER_NULL_NODE_ID 0xFFFF |
A distinguished network ID that will never be assigned to any node. Used to indicate the absence of a node ID.
More...
|
|
#define | EMBER_BROADCAST_ADDRESS 0xFFFF |
Broadcast address.
More...
|
|
#define | EMBER_USE_LONG_ADDRESS 0xFFFE |
Special short address indicating the node should use long addressing as source address.
More...
|
|
#define | EMBER_COORDINATOR_ADDRESS 0x0000 |
The coordinator short address.
More...
|
|
#define | EMBER_CAL_INVALID_VALUE (0xFFFFFFFF) |
Typedefs |
|
typedef uint8_t | EmberEUI64 [ EUI64_SIZE ] |
EUI 64-bit ID (IEEE 802.15.4 long address).
More...
|
|
typedef uint16_t | EmberNodeId |
IEEE 802.15.4 node ID. Also known as short address.
More...
|
|
typedef uint16_t | EmberPanId |
IEEE 802.15.4 PAN ID.
More...
|
|
typedef uint8_t | EmberMessageLength |
Message length in bytes.
More...
|
|
typedef uint8_t | EmberTaskId |
An identifier for a task.
More...
|
|
typedef struct Event_s | Event |
typedef struct EventQueue_s | EventQueue |
An event queue is currently just a list of events ordered by execution time.
More...
|
|
typedef PGM struct EmberEventData_S | EmberEventData |
typedef uint16_t | EmberBuffer |
Buffers used by the memory buffer system.
More...
|
|
Functions |
|
uint8_t * | emberKeyContents ( EmberKeyData *key) |
This macro allows the programmer to gain access to the key data bytes of the
EmberKeyData
structure.
More...
|
|
Detailed Description
Definitions of Connect data types used by various Connect API functions.
See
ember-types.h
for source code.
Macro Definition Documentation
◆ EMBER_BROADCAST_ADDRESS
#define EMBER_BROADCAST_ADDRESS 0xFFFF |
Broadcast address.
Definition at line
75
of file
ember-types.h
.
◆ EMBER_CAL_INVALID_VALUE
#define EMBER_CAL_INVALID_VALUE (0xFFFFFFFF) |
Definition at line
787
of file
ember-types.h
.
◆ EMBER_COORDINATOR_ADDRESS
#define EMBER_COORDINATOR_ADDRESS 0x0000 |
The coordinator short address.
Definition at line
82
of file
ember-types.h
.
◆ EMBER_ENCRYPTION_KEY_SIZE
#define EMBER_ENCRYPTION_KEY_SIZE 16 |
Size of an encryption key in bytes (16).
Definition at line
51
of file
ember-types.h
.
◆ EMBER_NULL_NODE_ID
#define EMBER_NULL_NODE_ID 0xFFFF |
A distinguished network ID that will never be assigned to any node. Used to indicate the absence of a node ID.
Definition at line
72
of file
ember-types.h
.
◆ EMBER_USE_LONG_ADDRESS
#define EMBER_USE_LONG_ADDRESS 0xFFFE |
Special short address indicating the node should use long addressing as source address.
Definition at line
79
of file
ember-types.h
.
◆ EUI64_SIZE
#define EUI64_SIZE 8 |
Size of EUI64 (an IEEE address) in bytes (8).
Definition at line
46
of file
ember-types.h
.
◆ EXTENDED_PAN_ID_SIZE
#define EXTENDED_PAN_ID_SIZE 8 |
Size of an extended PAN identifier in bytes (8).
Definition at line
41
of file
ember-types.h
.
Typedef Documentation
◆ EmberBuffer
typedef uint16_t EmberBuffer |
Buffers used by the memory buffer system.
Definition at line
742
of file
ember-types.h
.
◆ EmberEUI64
typedef uint8_t EmberEUI64[ EUI64_SIZE ] |
EUI 64-bit ID (IEEE 802.15.4 long address).
Definition at line
56
of file
ember-types.h
.
◆ EmberEventData
typedef PGM struct EmberEventData_S EmberEventData |
◆ EmberMessageLength
typedef uint8_t EmberMessageLength |
Message length in bytes.
Definition at line
202
of file
ember-types.h
.
◆ EmberNodeId
typedef uint16_t EmberNodeId |
IEEE 802.15.4 node ID. Also known as short address.
Definition at line
61
of file
ember-types.h
.
◆ EmberPanId
typedef uint16_t EmberPanId |
IEEE 802.15.4 PAN ID.
Definition at line
66
of file
ember-types.h
.
◆ EmberTaskId
typedef uint8_t EmberTaskId |
An identifier for a task.
Definition at line
523
of file
ember-types.h
.
◆ Event
◆ EventQueue
typedef struct EventQueue_s EventQueue |
An event queue is currently just a list of events ordered by execution time.
Enumeration Type Documentation
◆ anonymous enum
anonymous enum |
Define tasks that prevent the stack from sleeping.
Enumerator | |
---|---|
EMBER_OUTGOING_MESSAGES |
Messages are waiting for transmission. |
EMBER_INCOMING_MESSAGES |
One or more incoming messages are processed. |
EMBER_RADIO_IS_ON |
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. |
EMBER_ASSOCIATING |
The node is currently trying to associate to a Connect network. |
EMBER_SCANNING |
The node is currently performing a MAC-level scanning procedure. |
Definition at line
606
of file
ember-types.h
.
◆ EmberCalType
enum EmberCalType |
◆ EmberChildFlags
enum EmberChildFlags |
Child flags.
Definition at line
181
of file
ember-types.h
.
◆ EmberCounterType
enum EmberCounterType |
Define the event counters that can be requested from the application using emberGetCounter()
Definition at line
629
of file
ember-types.h
.
◆ EmberEventUnits
enum EmberEventUnits |
Either marks an event as inactive or specifies the units for the event execution time.
Definition at line
504
of file
ember-types.h
.
◆ EmberMacAddressMode
enum EmberMacAddressMode |
◆ EmberMessageOptions
enum EmberMessageOptions |
Message options.
Enumerator | |
---|---|
EMBER_OPTIONS_NONE |
No options. |
EMBER_OPTIONS_SECURITY_ENABLED |
The packet should be sent out encrypted. |
EMBER_OPTIONS_ACK_REQUESTED |
An acknowledgment should be requested for the outgoing packet. |
EMBER_OPTIONS_HIGH_PRIORITY |
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. |
EMBER_OPTIONS_INDIRECT |
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. |
Definition at line
208
of file
ember-types.h
.
◆ EmberNetworkStatus
enum EmberNetworkStatus |
Defines the possible join states for a node.
Definition at line
145
of file
ember-types.h
.
◆ EmberNodeType
enum EmberNodeType |
Define the possible types of nodes and the roles that a node might play in a network.
Enumerator | |
---|---|
EMBER_UNKNOWN_DEVICE |
Device is not in network. |
EMBER_STAR_COORDINATOR |
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. |
EMBER_STAR_RANGE_EXTENDER |
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. |
EMBER_STAR_END_DEVICE |
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. |
EMBER_STAR_SLEEPY_END_DEVICE |
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. |
EMBER_DIRECT_DEVICE |
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. |
EMBER_MAC_MODE_DEVICE |
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. |
EMBER_MAC_MODE_SLEEPY_DEVICE |
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. |
Definition at line
89
of file
ember-types.h
.
◆ EmberPhyType
enum EmberPhyType |
Define the PHY configuration of connect stack.
Definition at line
748
of file
ember-types.h
.
◆ EmberTxStreamParameters
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.