Microcontroller Wireless Solutions


Network Layer Constants

Data Structures

struct  NodeDesc_tag
struct  pairing_table_tag

Typedefs

typedef enum nwk_enum_tag nwk_enum_t
typedef struct NodeDesc_tag node_desc_t
typedef enum nib_attribute_tag nib_attribute_t
typedef struct pairing_table_tag pairing_table_t
typedef enum nwk_addr_mode_tag nwk_addr_mode_t
typedef enum nwk_agility_mode_tag nwk_agility_mode_t
typedef enum dev_type_tag dev_type_t
typedef enum profile_id_tag profile_id_t

Enumerations

enum  nwk_enum_tag {
  NWK_SUCCESS = 0x00,
  NWK_NO_ORG_CAPACITY = 0xb0,
  NWK_NO_REC_CAPACITY = 0xb1,
  NWK_NO_PAIRING = 0xb2,
  NWK_NO_RESPONSE = 0xb3,
  NWK_NOT_PERMITTED = 0xb4,
  NWK_DUPLICATE_PAIRING = 0xb5,
  NWK_FRAME_COUNTER_EXPIRED = 0xb6,
  NWK_DISCOVERY_ERROR = 0xb7,
  NWK_DISCOVERY_TIMEOUT = 0xb8,
  NWK_SECURITY_TIMEOUT = 0xb9,
  NWK_SECURITY_FAILURE = 0xba,
  NWK_INVALID_PARAMETER = 0xe8,
  NWK_UNSUPPORTED_ATTRIBUTE = 0xf4,
  NWK_INVALID_INDEX = 0xf9,
  NWK_MAC_CHANNEL_ACCESS_FAILURE = 0xE1,
  NWK_MAC_DISABLE_TRX_FAILURE = 0xE3,
  NWK_MAC_FRAME_TOO_LONG = 0xE5,
  NWK_MAC_INVALID_GTS = 0xE6,
  NWK_MAC_INVALID_HANDLE = 0xE7,
  NWK_MAC_NO_ACK = 0xE9,
  NWK_MAC_NO_BEACON = 0xEA,
  NWK_MAC_NO_DATA = 0xEB,
  NWK_MAC_NO_SHORT_ADDRESS = 0xEC,
  NWK_MAC_OUT_OF_CAP = 0xED,
  NWK_MAC_PAN_ID_CONFLICT = 0xEE,
  NWK_MAC_REALIGNMENT = 0xEF,
  NWK_MAC_TRANSACTION_EXPIRED = 0xF0,
  NWK_MAC_TRANSACTION_OVERFLOW = 0xF1,
  NWK_MAC_TX_ACTIVE = 0xF2,
  NWK_MAC_INVALID_ADDRESS = 0xF5
}
enum  nib_attribute_tag {
  nwkActivePeriod = 0x60,
  nwkBaseChannel = 0x61,
  nwkDiscoveryLQIThreshold = 0x62,
  nwkDiscoveryRepetitionInterval = 0x63,
  nwkDutyCycle = 0x64,
  nwkFrameCounter = 0x65,
  nwkIndicateDiscoveryRequests = 0x66,
  nwkInPowerSave = 0x67,
  nwkPairingTable = 0x68,
  nwkMaxDiscoveryRepetitions = 0x69,
  nwkMaxFirstAttemptCSMABackoffs = 0x6a,
  nwkMaxFirstAttemptFrameRetries = 0x6b,
  nwkMaxReportedNodeDescriptors = 0x6c,
  nwkResponseWaitTime = 0x6d,
  nwkScanDuration = 0x6e,
  nwkUserString = 0x6f,
  nwkPrivateIeeeAddr = 0x70,
  nwkPrivateVendorIdentifier = 0x71,
  nwkPrivateVendorString = 0x72,
  nwkPrivateNodeCapabilities = 0x73,
  nwkPrivatePanIdentifier = 0x74,
  nwkPrivateShortAddress = 0x75,
  nwkPrivateMaxPairingTableEntries = 0x76,
  nwkPrivateChAgEnabled = 0x77,
  nwkPrivateChAgScanInterval = 0x78,
  nwkPrivateChAgEdThreshold = 0x79
}
enum  nwk_addr_mode_tag {
  NWK_ADDR_MODE_16 = 0,
  NWK_ADDR_MODE_64 = 1
}
enum  nwk_agility_mode_tag {
  AG_ONE_SHOT = 0,
  AG_PERIODIC = 1,
  AG_STOP = 2
}
enum  dev_type_tag {
  DEV_TYPE_RESERVED = 0x00,
  DEV_TYPE_REMOTE_CONTROL = 0x01,
  DEV_TYPE_TELEVISION = 0x02,
  DEV_TYPE_PROJECTON = 0x03,
  DEV_TYPE_PLAYER = 0x04,
  DEV_TYPE_RECORDER = 0x05,
  DEV_TYPE_VIDEO = 0x06,
  DEV_TYPE_AUDIO = 0x07,
  DEV_TYPE_AV_RECORDER = 0x08,
  DEV_TYPE_SET_TOP_BOX = 0x09,
  DEV_TYPE_HOME_THEATER = 0x0A,
  DEV_TYPE_MEDIA_CENTER = 0x0B,
  DEV_TYPE_GAME_CONSOLE = 0x0C,
  DEV_TYPE_SAT_RADIO = 0x0D,
  DEV_TYPE_IR_EXTENDER = 0x0E,
  DEV_TYPE_MONITOR = 0x0F,
  DEV_TYPE_GENERIC = 0xFE,
  DEV_TYPE_WILDCARD = 0xFF
}
enum  profile_id_tag {
  PROFILE_ID_RESERVED_00 = 0x00,
  PROFILE_ID_ZRC = 0x01,
  PROFILE_ID_VENDOR_DATA = 0xFE,
  PROFILE_ID_WILDCARD = 0xFF
}

Detailed Description

These constants define the characteristics of the RF4CE layer.


Typedef Documentation

typedef enum dev_type_tag dev_type_t

Device types as defined by 094950r00ZB_RF4CE-Device-Type-List.pdf

Network Information Base attributes as defined by 094945r00ZB_RF4CE-Specification.pdf

typedef struct NodeDesc_tag node_desc_t

Elements of the NodeDesc type as defined by 094945r00ZB_RF4CE-Specification.pdf

Enumeration identifiying the address mode as defined by 094945r00ZB_RF4CE-Specification.pdf

Enumeration used for implementation-specific channel agility

typedef enum nwk_enum_tag nwk_enum_t

NWK enumerations as defined by 094945r00ZB_RF4CE-Specification.pdf, Table 45 - NWK enumerations description

Structure implementing the pairing table entry as defined by 094945r00ZB_RF4CE-Specification.pdf

Profile IDs as defined by 094951r00ZB_RF4CE-Profile-ID-List.pdf


Enumeration Type Documentation

Device types as defined by 094950r00ZB_RF4CE-Device-Type-List.pdf

Definition at line 407 of file rf4ce.h.

Network Information Base attributes as defined by 094945r00ZB_RF4CE-Specification.pdf

Enumerator:
nwkActivePeriod 

The active period of a device in MAC symbols.

nwkBaseChannel 

The logical channel that was chosen when the RC PAN was formed.

nwkDiscoveryLQIThreshold 

The LQI threshold below which discovery requests will be rejected.

nwkDiscoveryRepetitionInterval 

The interval at which discovery attempts are made on all channels.

nwkDutyCycle 

The duty cycle of a device in MAC symbols. A value of 0x000000 indicates the device is not using power saving.

nwkFrameCounter 

The frame counter added to the transmitted NPDU.

nwkIndicateDiscoveryRequests 

Indicates whether the NLME indicates the reception of discovery request command frames to the application. TRUE indicates that the NLME notifies the application.

nwkInPowerSave 

The power save mode of the node. TRUE indicates that the device is operating in power save mode.

nwkPairingTable 

List of pairing table entries (see Table 41) The pairing table managed by the device.

nwkMaxDiscoveryRepetitions 

The maximum number of discovery attempts made at the nwkDiscoveryRepetitionInterval rate.

nwkMaxFirstAttemptCSMABackoffs 

The maximum number of backoffs the MAC CSMACA algorithm will attempt before declaring a channel access failure for the first transmission attempt.

nwkMaxFirstAttemptFrameRetries 

The maximum number of MAC retries allowed after a transmission failure for the first transmission attempt.

nwkMaxReportedNodeDescriptors 

The maximum number of node descriptors that can be obtained before reporting to the application.

nwkResponseWaitTime 

The maximum time in MAC symbols, a device shall wait for a response command frame following a request command frame.

nwkScanDuration 

A measure of the duration of a scanning operation, according to [R1].

nwkUserString 

The user defined character string used to identify this node.

nwkPrivateIeeeAddr 

Private/Proprietary PIB value used for set/get primitive IEEE address

nwkPrivateVendorIdentifier 

Vendor identifier

nwkPrivateVendorString 

Vendor string

nwkPrivateNodeCapabilities 

Node capabilities (security and node type bits are read-only)

nwkPrivatePanIdentifier 

Target Pan Identifier (read-only)

nwkPrivateShortAddress 

Target Short address (read-only)

nwkPrivateMaxPairingTableEntries 

Private NIB Maximum number of allowed pairing table entries (set only); used for testing

nwkPrivateChAgEnabled 

Channel agility feature enabled - read-only

nwkPrivateChAgScanInterval 

Channel agility scan interval

nwkPrivateChAgEdThreshold 

Channel agility ED threshold value

Definition at line 259 of file rf4ce.h.

Enumeration identifiying the address mode as defined by 094945r00ZB_RF4CE-Specification.pdf

Enumerator:
NWK_ADDR_MODE_16 

Address mode 16-bit network address

NWK_ADDR_MODE_64 

Address mode 64-bit IEEE address

Definition at line 377 of file rf4ce.h.

Enumeration used for implementation-specific channel agility

Enumerator:
AG_ONE_SHOT 

One shot scan type for channel agility.

AG_PERIODIC 

Periodic scan

AG_STOP 

Stop channel agility.

Definition at line 391 of file rf4ce.h.

NWK enumerations as defined by 094945r00ZB_RF4CE-Specification.pdf, Table 45 - NWK enumerations description

Enumerator:
NWK_SUCCESS 

The requested operation was completed successfully.

NWK_NO_ORG_CAPACITY 

A pairing link cannot be established since the originator node has reached its maximum number of entries in its pairing table.

NWK_NO_REC_CAPACITY 

A pairing link cannot be established since the recipient node has reached its maximum number of entries in its pairing table.

NWK_NO_PAIRING 

A pairing table entry could not be found that corresponds to the supplied pairing reference.

NWK_NO_RESPONSE 

A response frame was not received within nwkResponseWaitTime.

NWK_NOT_PERMITTED 

A pairing request was denied by the recipient node or an attempt to update a security link key was not possible due to one or more nodes not supporting security.

NWK_DUPLICATE_PAIRING 

A duplicate pairing table entry was detected following the receipt of a pairing request command frame.

NWK_FRAME_COUNTER_EXPIRED 

The frame counter has reached its maximum value.

NWK_DISCOVERY_ERROR 

Too many unique matched discovery request or valid response command frames were received than requested.

NWK_DISCOVERY_TIMEOUT 

No discovery request or response command frames were received during discovery.

NWK_SECURITY_TIMEOUT 

The security link key exchange or recovery procedure did not complete within the required time.

NWK_SECURITY_FAILURE 

A security link key was not successfully established between both ends of a pairing link.

NWK_INVALID_PARAMETER 

A parameter in the primitive is either not supported or is out of the valid range.

NWK_UNSUPPORTED_ATTRIBUTE 

A SET/GET request was issued with the identifier of a NIB attribute that is not supported.

NWK_INVALID_INDEX 

An attempt to write to a NIB attribute that is in a table failed because the specified table index was out of range.

NWK_MAC_CHANNEL_ACCESS_FAILURE 

Enumerations from MAC layer A transmission could not take place due to activity on the channel, i.e., the CSMA-CA mechanism has failed.

NWK_MAC_DISABLE_TRX_FAILURE 

The attempt to disable the transceiver has failed.

NWK_MAC_FRAME_TOO_LONG 

The frame resulting from secure processing has a length that is greater than aMACMaxFrameSize.

NWK_MAC_INVALID_GTS 

The requested GTS transmission failed because the specified GTS either did not have a transmit GTS direction or was not defined.

NWK_MAC_INVALID_HANDLE 

A request to purge an MSDU from the transaction queue was made using an MSDU handle that was not found in the transaction table.

NWK_MAC_NO_ACK 

No acknowledgment was received after aMaxFrameRetries.

NWK_MAC_NO_BEACON 

A scan operation failed to find any network beacons.

NWK_MAC_NO_DATA 

No response data were available following a request.

NWK_MAC_NO_SHORT_ADDRESS 

The operation failed because a short address was not allocated.

NWK_MAC_OUT_OF_CAP 

A receiver enable request was unsuccessful because it could not be completed within the CAP.

NWK_MAC_PAN_ID_CONFLICT 

A PAN identifier conflict has been detected and communicated to the PAN coordinator.

NWK_MAC_REALIGNMENT 

A coordinator realignment command has been received.

NWK_MAC_TRANSACTION_EXPIRED 

The transaction has expired and its information discarded.

NWK_MAC_TRANSACTION_OVERFLOW 

There is no capacity to store the transaction.

NWK_MAC_TX_ACTIVE 

The transceiver was in the transmitter enabled state when the receiver was requested to be enabled.

NWK_MAC_INVALID_ADDRESS 

A request to send data was unsuccessful because neither the source address parameters nor the destination address parameters were present.

Definition at line 126 of file rf4ce.h.

Profile IDs as defined by 094951r00ZB_RF4CE-Profile-ID-List.pdf

Enumerator:
PROFILE_ID_ZRC 

Consumer Electronics Remote control

PROFILE_ID_WILDCARD 

Wildcard profile id

Definition at line 436 of file rf4ce.h.