Classes
struct	ApsdeDataConfirmParams
	Zigbee Specification r22.1.0, Section 2.2.4.1.2 APSDE-DATA.confirm params. More...

struct	ApsdeDataIndicationParams
	Zigbee Specification r22.1.0, Section 2.2.4.1.3 APSDE-DATA.indications params. More...

struct	ApsdeDataRequestParams
	Zigbee Specification r22.1.0, Section 2.2.4.1.1 APSDE-DATA.request params. More...

struct	ApsmeBindConfirmParams
	Zigbee Specification r22.1.0, Sections 2.2.4.3.2 and 2.2.4.3.4 APSME-BIND.confirm and APSME-UNBIND.confirm params. More...

struct	ApsmeBindRequestParams
	Zigbee Specification r22.1.0, Sections 2.2.4.3.1 and 2.2.4.3.3 APSME-BIND.request and APSME-UNBIND.request params. More...

struct	ApsmeGroupConfirmParams
	Zigbee Specification r22.1.0, Section 2.2.4.5.2 and 2.2.4.5.4 APSME-ADD-GROUP.confirm and APSME-REMOVE-GROUP.confirm params. More...

struct	ApsmeGroupRequestParams
	Zigbee Specification r22.1.0, Section 2.2.4.5.1 and 2.2.4.5.3 APSME-ADD-GROUP.request and APSME-REMOVE-GROUP.request params. More...

struct	ApsmeRemoveAllGroupsConfirmParams
	Zigbee Specification r22.1.0, Section 2.2.4.5.6 APSME-REMOVE-ALL-GROUPS.request params. More...

class	BindingTable
	APS Binding Table See Zigbee specification r22.1.0, Table 2-134 Similar to the z-boss implementation, the binding table is divided in two portions: The source part and the destination part. More...

class	BroadcastTransactionRecord
	A broadcast Transaction Record (BTR) As described in Table 3-70. More...

class	BroadcastTransactionTable
	The Broadcast Transaction Table (BTT) The BTT is used to keep track of data broadcast transactions. More...

class	CapabilityInformation
	Represent the the Capability Information Bit fields See zigbe Specification r22.1.0, Table 3-62. More...

struct	ChannelList
	Channel List Structure. More...

class	DstBindingEntry
	Binding Table entry: Destination portion of the table. More...

class	NeighborTable
	The network layer Network Table See Zigbee specification r22.1.0, 3.6.1.5. More...

class	NeighborTableEntry
	The Network layer Neighbor Table Entry See Zigbee specification r22.1.0, Table 3-63. More...

struct	NetFormPendingParamsGen
	A group of pending parameters arranged into a structure during the execution of a NLME-NETWORK-FORMATION.request primitive. More...

struct	NetworkDescriptor
	Network Descriptor, Zigbee Specification r22.1.0, 3.2.2.4, Table 3-12. More...

struct	NldeDataConfirmParams
	NLDE-DATA.confirm params. More...

struct	NldeDataIndicationParams
	NLDE-DATA.indication params. More...

struct	NldeDataRequestParams
	NLDE-DATA.request params. More...

struct	NlmeDirectJoinConfirmParams
	NLME-DIRECT-JOIN.confirm params. More...

struct	NlmeDirectJoinRequestParams
	NLME-DIRECT-JOIN.request params. More...

struct	NlmeJoinConfirmParams
	NLME-JOIN.confirm params. More...

struct	NlmeJoinIndicationParams
	NLME-JOIN.indication params. More...

struct	NlmeJoinRequestParams
	NLME-JOIN.request params. More...

struct	NlmeNetworkDiscoveryConfirmParams
	NLME-NETWORK-DISCOVERY.confirm params. More...

struct	NlmeNetworkDiscoveryRequestParams
	NLME-NETWORK-DISCOVERY.request params. More...

struct	NlmeNetworkFormationConfirmParams
	NLME-NETWORK-FORMATION.confirm params. More...

struct	NlmeNetworkFormationRequestParams
	NLME-NETWORK-FORMATION.request params. More...

struct	NlmeRouteDiscoveryConfirmParams
	NLME-ROUTE-DISCOVERY.confirm params. More...

struct	NlmeRouteDiscoveryRequestParams
	NLME-ROUTE-DISCOVERY.request params. More...

struct	NlmeStartRouterConfirmParams
	NLME-START-ROUTER.confirm params. More...

struct	NlmeStartRouterRequestParams
	NLME-START-ROUTER.request params. More...

class	PanIdTable
	A table that keeps record of neighbors devices NWK extended PAN ids (64 bits) and their related 16 bit MAC pan id. More...

class	RouteDiscoveryTable
	The network layer Route Discovery Table See Zigbee specification r22.1.0, 3.6.3.2. More...

class	RouteDiscoveryTableEntry
	The Network layer Route Discovery Table Entry See Zigbee specification r22.1.0, Table 3-68. More...

class	RoutingTable
	The network layer Routing Table. More...

class	RoutingTableEntry
	Routing table entry Zigbee Specification r22.1.0, Table 3-66. More...

class	RreqRetryTable
	A table storing information about upcoming route request retries. More...

class	RreqRetryTableEntry
	The route request retry table entry. More...

class	SrcBindingEntry
	Binding Table entry: Source portion of the table. More...

class	SuperframeInformation
	Represent the Superframe Specification information field. More...

class	ZigbeeAps
	Zigbee Specification r22.1.0, Section 2.2.3 Class that implements the Zigbee Specification Application Support Sub-layer (APS). More...

class	ZigbeeApsHeader
	Defines the APS header use by data transfer and commands issued from the APS layer. More...

class	ZigbeeApsTxOptions
	Helper class used to craft the transmission options bitmap used by the APSDE-DATA.request. More...

class	ZigbeeBeaconPayload
	Represents the payload portion of a beacon frame. More...

class	ZigbeeGroupTable
	The Zigbee Group Table Zigbee Specification r22.1.0, Section 2.2.8.3 and 3.6.6.1 The group table is a special table that is accessible by both the Zigbee NWK and APS layers. More...

class	ZigbeeNwk
	Class that implements the Zigbee Specification Network Layer. More...

class	ZigbeeNwkHeader
	Represent the NWK Header with the Frame Control and Routing fields Zigbee Specification r22.1.0, General NPDU Frame Format (Section 3.3.1) More...

class	ZigbeePayloadRouteReplyCommand
	Represent a variable portion of the zigbee payload header that includes the route reply command. More...

class	ZigbeePayloadRouteRequestCommand
	Represent a variable portion of the zigbee payload header that includes the route request command. More...

class	ZigbeePayloadType
	Represent the static portion of the zigbee payload header that describes the payload command type. More...

class	ZigbeeStack
	Zigbee protocol stack to device interface. More...

class	ZigbeeStackContainer
	Holds a vector of ns3::ZigbeeStack pointers. More...

Typedefs
typedef Callback< void, ApsdeDataConfirmParams >	ApsdeDataConfirmCallback
	This callback is called to confirm a successfully transmission of an ASDU.

typedef Callback< void, ApsdeDataIndicationParams, Ptr< Packet > >	ApsdeDataIndicationCallback
	This callback is called after a ASDU has successfully received and APS push it to deliver it to the next higher layer (typically the application framework).

typedef Callback< void, ApsmeGroupConfirmParams >	ApsmeAddGroupConfirmCallback
	This callback is called to confirm a successfully addition of a group address and or endPoint into the group table.

typedef Callback< void, ApsmeBindConfirmParams >	ApsmeBindConfirmCallback
	This callback is called to confirm a successfully addition of a destination into the binding table.

typedef Callback< void, ApsmeRemoveAllGroupsConfirmParams >	ApsmeRemoveAllGroupsConfirmCallback
	This callback is called to confirm a successfully removal of an endpoint from all the the groups.

typedef Callback< void, ApsmeGroupConfirmParams >	ApsmeRemoveGroupConfirmCallback
	This callback is called to confirm a successfully removal of a group address and or endPoint from the group table.

typedef Callback< void, ApsmeBindConfirmParams >	ApsmeUnbindConfirmCallback
	This callback is called to confirm a successfully unbind request performed into the binding table.

typedef Callback< void, NldeDataConfirmParams >	NldeDataConfirmCallback
	This callback is used to notify the next higher layer with a confirmation in response to a previously issued NLDE-DATA.request.

typedef Callback< void, NldeDataIndicationParams, Ptr< Packet > >	NldeDataIndicationCallback
	This callback is called after a NSDU has successfully received and NWK push it to deliver it to the next higher layer.

typedef Callback< void, NlmeDirectJoinConfirmParams >	NlmeDirectJoinConfirmCallback
	This callback is used to notify the next higher layer with a confirmation in response to a previously issued NLME-DIRECT-JOIN.request.

typedef Callback< void, NlmeJoinConfirmParams >	NlmeJoinConfirmCallback
	This callback is used to notify the next higher layer with a confirmation in response to a previously issued NLME-JOIN.request.

typedef Callback< void, NlmeJoinIndicationParams >	NlmeJoinIndicationCallback
	This callback is used to notify the next higher layer with an indication that a new device has successfully joined its network by association or rejoining.

typedef Callback< void, NlmeNetworkDiscoveryConfirmParams >	NlmeNetworkDiscoveryConfirmCallback
	This callback is used to notify the next higher layer with a confirmation in response to a previously issued NLME-NETWORK-DISCOVERY.request.

typedef Callback< void, NlmeNetworkFormationConfirmParams >	NlmeNetworkFormationConfirmCallback
	This callback is used to notify the next higher layer with a confirmation in response to a previously issued NLME-NETWORK-FORMATION.request.

typedef Callback< void, NlmeRouteDiscoveryConfirmParams >	NlmeRouteDiscoveryConfirmCallback
	This callback is used to notify the next higher layer with a confirmation in response to a previously issued NLME-ROUTE-DISCOVERY.request.

typedef Callback< void, NlmeStartRouterConfirmParams >	NlmeStartRouterConfirmCallback
	This callback is used to notify the next higher layer with a confirmation in response to a previously issued NLME-START-ROUTER.request.

Enumerations
enum	AddrAllocMethod { DISTRIBUTED_ALLOC = 0x00 , STOCHASTIC_ALLOC = 0x02 }
	Use to describe the method used to assign addresses in the NWK layer. More...

enum	AddressMode { NO_ADDRESS = 0x00 , MCST = 0x01 , UCST_BCST = 0x02 }
	Table 3.2 (Address Mode) NLDE-DATA-Request parameters. More...

enum	ApsDeliveryMode : uint8_t { APS_UCST = 0x00 , APS_BCST = 0x02 , APS_GROUP_ADDRESSING = 0x03 }
	Values of the Delivery Mode Sub-Field. More...

enum class	ApsDstAddressMode : std::uint8_t { ApsDstAddressMode::DST_ADDR_AND_DST_ENDPOINT_NOT_PRESENT = 0x00 , ApsDstAddressMode::GROUP_ADDR_DST_ENDPOINT_NOT_PRESENT = 0x01 , ApsDstAddressMode::DST_ADDR16_DST_ENDPOINT_PRESENT = 0x02 , ApsDstAddressMode::DST_ADDR64_DST_ENDPOINT_PRESENT = 0x03 , ApsDstAddressMode::DST_ADDR64_DST_ENDPOINT_NOT_PRESENT = 0x04 }
	APS Destination Address Mode, Zigbee Specification r22.1.0 Table 2-2 APSDE-DATA.request Parameters See Table 2-4 APSDE-DATA.indication Parameters. More...

enum class	ApsDstAddressModeBind : std::uint8_t { GROUP_ADDR_DST_ENDPOINT_NOT_PRESENT = 0x01 , DST_ADDR64_DST_ENDPOINT_PRESENT = 0x03 }
	APS Destination Address Mode for Binding Zigbee Specification r22.1.0, Table 2-6 APSME-BIND.request Parameters. More...

enum	ApsFragmentation : uint8_t { NOT_FRAGMENTED = 0x00 , FIRST_FRAGMENT = 0x01 , OTHER_FRAGMENT = 0x02 }
	Table 2-22 Values of the Fragmentation Sub-Field Zigbee Specification r22.1.0, Table 2-22. More...

enum	ApsFrameType : uint8_t { APS_DATA = 0x00 , APS_COMMAND = 0x01 , APS_ACK = 0x02 , APS_INTERPAN_APS = 0x03 }
	Values of the Frame Type Sub-Field. More...

enum class	ApsSecurityStatus : std::uint8_t { ApsSecurityStatus::UNSECURED = 0x00 , ApsSecurityStatus::SECURED_NWK_KEY = 0x01 , ApsSecurityStatus::SECURED_LINK_KEY = 0x02 }
	APS Security status See Zigbee Specification r22.1.0, Table 2-4 APSDE-DATA.indication Parameters. More...

enum class	ApsSrcAddressMode : std::uint8_t { ApsSrcAddressMode::SRC_ADDR16_SRC_ENDPOINT_PRESENT = 0x02 , ApsSrcAddressMode::SRC_ADDR64_SRC_ENDPOINT_PRESENT = 0x03 , ApsSrcAddressMode::SRC_ADDR64_SRC_ENDPOINT_NOT_PRESENT = 0x04 }
	APS Source Address Mode, Zigbee Specification r22.1.0 See Table 2-4 APSDE-DATA.indication Parameters. More...

enum class	ApsStatus : std::uint8_t { ApsStatus::SUCCESS = 0x00 , ApsStatus::ASDU_TOO_LONG = 0xa0 , ApsStatus::DEFRAG_DEFERRED = 0xa1 , ApsStatus::DEFRAG_UNSUPPORTED = 0xa2 , ApsStatus::ILLEGAL_REQUEST = 0xa3 , ApsStatus::INVALID_BINDING = 0xa4 , ApsStatus::INVALID_GROUP = 0xa5 , ApsStatus::INVALID_PARAMETER = 0xa6 , ApsStatus::NO_ACK = 0xa7 , ApsStatus::NO_BOUND_DEVICE = 0xa8 , ApsStatus::NO_SHORT_ADDRESS = 0xa9 , ApsStatus::NOT_SUPPORTED = 0xaa , ApsStatus::SECURED_LINK_KEY = 0xab , ApsStatus::SECURED_NWK_KEY = 0xac , ApsStatus::SECURITY_FAIL = 0xad , ApsStatus::TABLE_FULL = 0xae , ApsStatus::UNSECURED = 0xaf , ApsStatus::UNSUPPORTED_ATTRIBUTE = 0xb0 }
	APS Sub-layer Status Values See Zigbee Specification r22.1.0, Table 2-27. More...

enum class	BindingTableStatus : std::uint8_t { BOUND = 0 , UNBOUND = 1 , TABLE_FULL = 2 , ENTRY_EXISTS = 3 , ENTRY_NOT_FOUND = 4 }
	The status resulting of interactions with the binding table. More...

enum	DiscoverRouteType { SUPPRESS_ROUTE_DISCOVERY = 0x00 , ENABLE_ROUTE_DISCOVERY = 0x01 }
	Zigbee Specification r22.1.0, Values of the discover route sub-field (Table 3-47) More...

enum	JoiningMethod { ASSOCIATION = 0x00 , DIRECT_OR_REJOIN = 0x01 , REJOINING = 0x02 , CHANGE_CHANNEL = 0x03 }
	Use to describe the parameter that controls the method of joining the network. More...

enum	MacDeviceType { ENDDEVICE = 0 , ROUTER = 1 }
	The device Type Zigbee Specification r22.1.0 (Table 3-62 or Table 3-63) More...

enum	ManyToOne { NO_MANY_TO_ONE = 0 , ROUTE_RECORD = 1 , NO_ROUTE_RECORD = 2 }
	Zigbee Specification 3.4.1.3.1 , Table 3-50 Values of the many to one command option field. More...

enum	MulticastMode { NONMEMBER = 0 , MEMBER = 1 }
	Zigbee Specification r22.1.0, Multicast Mode Sub-Field (Table 3-7) More...

enum	NetworkStatusCode : std::uint8_t { NO_ROUTE_AVAILABLE = 0x00 , TREE_LINK_FAILURE = 0x01 , NON_TREE_LINK_FAILURE = 0x02 , LOW_BATTERY = 0x03 , NO_ROUTING_CAPACITY = 0x04 , NO_INDIRECT_CAPACITY = 0x05 , INDIRECT_TRANSACTION_EXPIRY = 0x06 , TARGET_DEVICE_UNAVAILABLE = 0x07 , TARGET_ADDRESS_UNALLOCATED = 0x08 , PARENT_LINK_FAILURE = 0x09 , VALIDATE_ROUTE = 0x0a , SOURCE_ROUTE_FAILURE = 0x0b , MANY_TO_ONE_ROUTE_FAILURE = 0x0c , ADDRESS_CONFLICT = 0x0d , VERIFY_ADDRESS = 0x0e , PAN_IDENTIFIER_UPDATE = 0x0f , NETWORK_ADDRESS_UPDATE = 0x10 , BAD_FRAME_COUNTER = 0x11 , BAD_KEY_SEQUENCE_NUMBER = 0x12 , UNKNOWN_COMMAND = 0x13 }
	Status codes for network status command frame and route discovery failures. More...

enum	NwkCommandType { ROUTE_REQ_CMD = 0x01 , ROUTE_REP_CMD = 0x02 , NWK_STATUS_CMD = 0X03 , LEAVE_CMD = 0x04 , ROUTE_RECORD_CMD = 0x05 , REJOIN_REQ_CMD = 0x06 , REJOIN_RESP_CMD = 0x07 , LINK_STATUS_CMD = 0x08 , NWK_REPORT_CMD = 0x09 , NWK_UPDATE_CMD = 0x0a , TIMEOUT_REQ_CMD = 0x0b , TIMEOUT_RESP_CMD = 0x0c , LINK_POWER_DELTA_CMD = 0x0d }
	Zigbee Specification, Payload command types. More...

enum	NwkDeviceType { ZIGBEE_COORDINATOR = 0x0 , ZIGBEE_ROUTER = 0x01 , ZIGBEE_ENDDEVICE = 0x02 }
	The network layer device type. More...

enum	NwkStatus : std::uint8_t { SUCCESS = 0 , FULL_CAPACITY = 0x01 , ACCESS_DENIED = 0x02 , COUNTER_ERROR = 0xdb , IMPROPER_KEY_TYPE = 0xdc , IMPROPER_SECURITY_LEVEL = 0xdd , UNSUPPORTED_LEGACY = 0xde , UNSUPPORTED_SECURITY = 0xdf , BEACON_LOSS = 0xe0 , CHANNEL_ACCESS_FAILURE = 0xe1 , DENIED = 0xe2 , DISABLE_TRX_FAILURE = 0xe3 , SECURITY_ERROR = 0xe4 , FRAME_TOO_LONG = 0xe5 , INVALID_GTS = 0xe6 , INVALID_HANDLE = 0xe7 , INVALID_PARAMETER_MAC = 0xe8 , NO_ACK = 0xe9 , NO_BEACON = 0xea , NO_DATA = 0xeb , NO_SHORT_ADDRESS = 0xec , OUT_OF_CAP = 0xed , PAN_ID_CONFLICT = 0xee , REALIGMENT = 0xef , TRANSACTION_EXPIRED = 0xf0 , TRANSACTION_OVERFLOW = 0xf1 , TX_ACTIVE = 0xf2 , UNAVAILABLE_KEY = 0xf3 , INVALID_ADDRESS = 0xf5 , ON_TIME_TOO_LONG = 0xf6 , PAST_TIME = 0xf7 , TRACKING_OFF = 0xf8 , INVALID_INDEX = 0xf9 , READ_ONLY = 0xfb , SUPERFRAME_OVERLAP = 0xfd , INVALID_PARAMETER = 0xc1 , INVALID_REQUEST = 0xc2 , NOT_PERMITED = 0xc3 , STARTUP_FAILURE = 0xc4 , ALREADY_PRESENT = 0xc5 , SYNC_FAILURE = 0xc6 , NEIGHBOR_TABLE_FULL = 0xc7 , UNKNOWN_DEVICE = 0xc8 , UNSUPPORTED_ATTRIBUTE = 0xc9 , NO_NETWORKS = 0xca , MAX_FRM_COUNTER = 0xcc , NO_KEY = 0xcd , BAD_CCM_OUTPUT = 0xce , ROUTE_DISCOVERY_FAILED = 0xd0 , ROUTE_ERROR = 0xd1 , BT_TABLE_FULL = 0xd2 , FRAME_NOT_BUFFERED = 0xd3 , INVALID_INTERFACE = 0xd5 , LIMIT_REACHED = 0xd6 , SCAN_IN_PROGRESS = 0xd7 }
	Network layer status values Combines Zigbee Specification r22.1.0 Table 3-73 and and IEEE 802.15.4-2006 Table 78. More...

enum	NwkType { DATA = 0 , NWK_COMMAND = 1 , INTER_PAN = 3 }
	Zigbee Specification r22.1.0, Values of the frame Type Sub-field (Table 3-46) More...

enum	PendingPrimitiveNwk : std::uint8_t { NLDE_NLME_NONE = 0 , NLME_NETWORK_FORMATION = 1 , NLME_DIRECT_JOIN = 2 , NLME_JOIN = 3 , NLME_START_ROUTER = 4 , NLME_NET_DISCV = 5 , NLME_JOIN_INDICATION = 6 , NLME_ROUTE_DISCOVERY = 7 , NLDE_DATA = 8 }
	Indicates a pending NWK primitive. More...

enum	PowerSource { OTHER_POWER_SOURCE = 0 , MAINPOWER = 1 }
	The power source capabilities. More...

enum	Relationship { NBR_PARENT = 0x0 , NBR_CHILD = 0x01 , NBR_SIBLING = 0x02 , NBR_NONE = 0x03 , NBR_PREV_CHILD = 0x04 , NBR_UNAUTH_CHILD = 0x05 }
	The relationship between the neighbor and the current device. More...

enum	RouteDiscoveryStatus : std::uint8_t { ROUTE_FOUND = 0x01 , ROUTE_NOT_FOUND = 0x02 , TABLE_FULL = 0x03 , ROUTE_UPDATED = 0x04 , NO_DISCOVER_ROUTE = 0x05 , DISCOVER_UNDERWAY = 0x06 , MANY_TO_ONE_ROUTE = 0x07 , NO_ROUTE_CHANGE = 0x08 }
	The status returned while attempting to find the next hop in route towards a specific destination or a many-to-one route request attempt. More...

enum	RouteStatus { ROUTE_ACTIVE = 0x0 , ROUTE_DISCOVERY_UNDERWAY = 0x1 , ROUTE_DISCOVER_FAILED = 0x2 , ROUTE_INACTIVE = 0x3 , ROUTE_VALIDATION_UNDERWAY = 0x4 }
	Route record states. More...

enum	StackProfile { ZIGBEE = 0x01 , ZIGBEE_PRO = 0x02 }
	Use to describe the identifier of the zigbee stack profile. More...

Functions
std::ostream &	operator<< (std::ostream &os, const NwkStatus &state)
	Overloaded operator to print the value of a NwkStatus.

std::ostream &	operator<< (std::ostream &os, const std::vector< uint8_t > &vec)
	Overloaded operator to print uint8_t vectors.

std::ostream &	operator<< (std::ostream &os, const uint8_t &num)

Variables
static constexpr uint32_t	ALL_CHANNELS = 0x07FFF800
	Bitmap representing all channels (11~26) LSB b0-b26, b27-b31 MSB Page 0 in Zigbee (250kbps O-QPSK)

static const double	RequestedTimeoutField [15] {0.166667, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192, 16384}
	Requested Timeout Field See Zigbee Specification r22.1.0, 3.4.11.3.1.

Typedef Documentation

◆ NldeDataConfirmCallback

typedef Callback<void, NldeDataConfirmParams> ns3::zigbee::NldeDataConfirmCallback

This callback is used to notify the next higher layer with a confirmation in response to a previously issued NLDE-DATA.request.

Definition at line 628 of file zigbee-nwk.h.

◆ NldeDataIndicationCallback

typedef Callback<void, NldeDataIndicationParams, Ptr<Packet> > ns3::zigbee::NldeDataIndicationCallback

This callback is called after a NSDU has successfully received and NWK push it to deliver it to the next higher layer.

Definition at line 619 of file zigbee-nwk.h.

◆ NlmeDirectJoinConfirmCallback

typedef Callback<void, NlmeDirectJoinConfirmParams> ns3::zigbee::NlmeDirectJoinConfirmCallback

This callback is used to notify the next higher layer with a confirmation in response to a previously issued NLME-DIRECT-JOIN.request.

Definition at line 660 of file zigbee-nwk.h.

◆ NlmeJoinConfirmCallback

typedef Callback<void, NlmeJoinConfirmParams> ns3::zigbee::NlmeJoinConfirmCallback

This callback is used to notify the next higher layer with a confirmation in response to a previously issued NLME-JOIN.request.

Definition at line 668 of file zigbee-nwk.h.

◆ NlmeJoinIndicationCallback

typedef Callback<void, NlmeJoinIndicationParams> ns3::zigbee::NlmeJoinIndicationCallback

This callback is used to notify the next higher layer with an indication that a new device has successfully joined its network by association or rejoining.

Definition at line 676 of file zigbee-nwk.h.

◆ NlmeNetworkDiscoveryConfirmCallback

typedef Callback<void, NlmeNetworkDiscoveryConfirmParams> ns3::zigbee::NlmeNetworkDiscoveryConfirmCallback

This callback is used to notify the next higher layer with a confirmation in response to a previously issued NLME-NETWORK-DISCOVERY.request.

Definition at line 644 of file zigbee-nwk.h.

◆ NlmeNetworkFormationConfirmCallback

typedef Callback<void, NlmeNetworkFormationConfirmParams> ns3::zigbee::NlmeNetworkFormationConfirmCallback

This callback is used to notify the next higher layer with a confirmation in response to a previously issued NLME-NETWORK-FORMATION.request.

Definition at line 636 of file zigbee-nwk.h.

◆ NlmeRouteDiscoveryConfirmCallback

typedef Callback<void, NlmeRouteDiscoveryConfirmParams> ns3::zigbee::NlmeRouteDiscoveryConfirmCallback

This callback is used to notify the next higher layer with a confirmation in response to a previously issued NLME-ROUTE-DISCOVERY.request.

Definition at line 652 of file zigbee-nwk.h.

◆ NlmeStartRouterConfirmCallback

typedef Callback<void, NlmeStartRouterConfirmParams> ns3::zigbee::NlmeStartRouterConfirmCallback

This callback is used to notify the next higher layer with a confirmation in response to a previously issued NLME-START-ROUTER.request.

Definition at line 684 of file zigbee-nwk.h.

Enumeration Type Documentation

◆ AddrAllocMethod

enum ns3::zigbee::AddrAllocMethod

Use to describe the method used to assign addresses in the NWK layer.

See Zigbee specification r22.1.0, Table 3-58

Enumerator
DISTRIBUTED_ALLOC	Distributed address allocation (Zigbee Specification r22.1.0 Section 3.6.1.6)
STOCHASTIC_ALLOC	Stochastic address allocation (Zigbee Specification r22.1.0 Section 3.6.1.7)

Definition at line 86 of file zigbee-nwk.h.

◆ AddressMode

enum ns3::zigbee::AddressMode

Table 3.2 (Address Mode) NLDE-DATA-Request parameters.

Enumerator
NO_ADDRESS	No destination address.
MCST	Multicast Address mode.
UCST_BCST	Unicast or Broadcast address mode.

Definition at line 75 of file zigbee-nwk.h.

◆ ApsDstAddressModeBind

enum class ns3::zigbee::ApsDstAddressModeBind : std::uint8_t

strong

APS Destination Address Mode for Binding Zigbee Specification r22.1.0, Table 2-6 APSME-BIND.request Parameters.

Enumerator
GROUP_ADDR_DST_ENDPOINT_NOT_PRESENT
DST_ADDR64_DST_ENDPOINT_PRESENT

Definition at line 35 of file zigbee-aps-tables.h.

◆ BindingTableStatus

enum class ns3::zigbee::BindingTableStatus : std::uint8_t

strong

The status resulting of interactions with the binding table.

Enumerator
BOUND
UNBOUND
TABLE_FULL
ENTRY_EXISTS
ENTRY_NOT_FOUND

Definition at line 46 of file zigbee-aps-tables.h.

◆ DiscoverRouteType

enum ns3::zigbee::DiscoverRouteType

Zigbee Specification r22.1.0, Values of the discover route sub-field (Table 3-47)

Enumerator
SUPPRESS_ROUTE_DISCOVERY	Suppress route discovery.
ENABLE_ROUTE_DISCOVERY	Enable route discovery.

Definition at line 37 of file zigbee-nwk-header.h.

◆ JoiningMethod

enum ns3::zigbee::JoiningMethod

Use to describe the parameter that controls the method of joining the network.

See Zigbee specification r22.1.0, Table 3-21

Enumerator
ASSOCIATION	The device is requesting to join a network through association.
DIRECT_OR_REJOIN	The device is joining directly or rejoining using the orphaning procedure.
REJOINING	The device is joining the network using the rejoining procedure.
CHANGE_CHANNEL	The device is to change the operational network channel to that identified in the ScanChannel parameter.

Definition at line 107 of file zigbee-nwk.h.

◆ ManyToOne

enum ns3::zigbee::ManyToOne

Zigbee Specification 3.4.1.3.1 , Table 3-50 Values of the many to one command option field.

Enumerator
NO_MANY_TO_ONE
ROUTE_RECORD
NO_ROUTE_RECORD

Definition at line 46 of file zigbee-nwk-payload-header.h.

◆ MulticastMode

enum ns3::zigbee::MulticastMode

Zigbee Specification r22.1.0, Multicast Mode Sub-Field (Table 3-7)

Enumerator
NONMEMBER	Non member multicast mode.
MEMBER	Member multicast mode.

Definition at line 46 of file zigbee-nwk-header.h.

◆ NetworkStatusCode

enum ns3::zigbee::NetworkStatusCode : std::uint8_t

Status codes for network status command frame and route discovery failures.

Enumerator
NO_ROUTE_AVAILABLE	No route available.
TREE_LINK_FAILURE	Tree link failure.
NON_TREE_LINK_FAILURE	Non tree link failure.
LOW_BATTERY	Low battery.
NO_ROUTING_CAPACITY	No routing capacity.
NO_INDIRECT_CAPACITY	No indirect capacity.
INDIRECT_TRANSACTION_EXPIRY	Indirect transaction expiry.
TARGET_DEVICE_UNAVAILABLE	Target device unavailable.
TARGET_ADDRESS_UNALLOCATED	Target address unallocated.
PARENT_LINK_FAILURE	Parent link failure.
VALIDATE_ROUTE	Validate route.
SOURCE_ROUTE_FAILURE	Source route failure.
MANY_TO_ONE_ROUTE_FAILURE	Many to one route failure.
ADDRESS_CONFLICT	Address conflict.
VERIFY_ADDRESS	Verify address.
PAN_IDENTIFIER_UPDATE	PAN identifier update.
NETWORK_ADDRESS_UPDATE	Network address update.
BAD_FRAME_COUNTER	Bad frame counter.
BAD_KEY_SEQUENCE_NUMBER	Bad key sequence number.
UNKNOWN_COMMAND	Unknown command.

Definition at line 244 of file zigbee-nwk.h.

◆ NwkCommandType

enum ns3::zigbee::NwkCommandType

Zigbee Specification, Payload command types.

Enumerator
ROUTE_REQ_CMD	Route request command.
ROUTE_REP_CMD	Route response command.
NWK_STATUS_CMD	Network status command.
LEAVE_CMD	Leave network command.
ROUTE_RECORD_CMD	Route record command.
REJOIN_REQ_CMD	Rejoin request command.
REJOIN_RESP_CMD	Rejoin response command.
LINK_STATUS_CMD	Link status command.
NWK_REPORT_CMD	Network report command.
NWK_UPDATE_CMD	Network update command.
TIMEOUT_REQ_CMD	Time out request command.
TIMEOUT_RESP_CMD	Time out response command.
LINK_POWER_DELTA_CMD	Link power delta command.

Definition at line 25 of file zigbee-nwk-payload-header.h.

◆ NwkStatus

enum ns3::zigbee::NwkStatus : std::uint8_t

Network layer status values Combines Zigbee Specification r22.1.0 Table 3-73 and and IEEE 802.15.4-2006 Table 78.

Used to report the resulting status of various NWK operations.

Note: UNSUPPORTED_ATTRIBUTE, LIMIT_REACHED, SCAN_IN_PROGRESS

Enumerator
SUCCESS	The operation was completed successfully.
FULL_CAPACITY	PAN at capacity. Association Status field (std. 2006, Table 83).
ACCESS_DENIED	PAN access denied. Association Status field (std. 2006, Table 83).
COUNTER_ERROR	The frame counter of the received frame is invalid.
IMPROPER_KEY_TYPE	The key is not allowed to be used with that frame type.
IMPROPER_SECURITY_LEVEL	Insufficient security level expected by the recipient.
UNSUPPORTED_LEGACY	Deprecated security used in IEEE 802.15.4-2003.
UNSUPPORTED_SECURITY	The security applied is not supported.
BEACON_LOSS	The beacon was lost following a synchronization request.
CHANNEL_ACCESS_FAILURE	A Tx could not take place due to activity in the CH.
DENIED	The GTS request has been denied by the PAN coordinator.
DISABLE_TRX_FAILURE	The attempt to disable the transceier has failed.
SECURITY_ERROR	Cryptographic process of the frame failed(FAILED_SECURITY_CHECK).
FRAME_TOO_LONG	Frame more than aMaxPHYPacketSize or too large for CAP or GTS.
INVALID_GTS	Missing GTS transmit or undefined direction.
INVALID_HANDLE	When purging from TX queue handle was not found.
INVALID_PARAMETER_MAC	Invalid parameter in response to a request passed to the MAC.
NO_ACK	No acknowledgment was received after macMaxFrameRetries.
NO_BEACON	A scan operation failed to find any network beacons.
NO_DATA	No response data were available following a request.
NO_SHORT_ADDRESS	Failure due to unallocated 16-bit short address.
OUT_OF_CAP	(Deprecated) See IEEE 802.15.4-2003
PAN_ID_CONFLICT	PAN id conflict detected and informed to the coordinator.
REALIGMENT	A coordinator realigment command has been received.
TRANSACTION_EXPIRED	The transaction expired and its information discarded.
TRANSACTION_OVERFLOW	There is no capacity to store the transaction.
TX_ACTIVE	The transceiver was already enabled.
UNAVAILABLE_KEY	Unavailable key, unknown or blacklisted.
INVALID_ADDRESS	Invalid source or destination address.
ON_TIME_TOO_LONG	RX enable request fail due to syms. longer than Bcn. interval
PAST_TIME	Rx enable request fail due to lack of time in superframe.
TRACKING_OFF	This device is currently not tracking beacons.
INVALID_INDEX	A MAC PIB write failed because specified index is out of range.
READ_ONLY	SET/GET request issued for a read only attribute.
SUPERFRAME_OVERLAP	Coordinator sperframe and this device superframe tx overlap.
INVALID_PARAMETER	Invalid Parameter (Zigbee specification r22.1.0)
INVALID_REQUEST	Invalid request (Zigbee specification r22.1.0)
NOT_PERMITED	Not permitted (Zigbee specification r22.1.0)
STARTUP_FAILURE	Startup failure (Zigbee specification r22.1.0)
ALREADY_PRESENT	Already present (Zigbee specification r22.1.0)
SYNC_FAILURE	Sync Failure (Zigbee specification r22.1.0)
NEIGHBOR_TABLE_FULL	Neighbor table full (Zigbee specification r22.1.0)
UNKNOWN_DEVICE	Unknown device (Zigbee specification r22.1.0)
UNSUPPORTED_ATTRIBUTE	Unsupported attribute (Zigbee specification r22.1.0)
NO_NETWORKS	No network (Zigbee specification r22.1.0)
MAX_FRM_COUNTER	Max Frame counter (IEEE 802.15.4, Zigbee specification r22.1.0)
NO_KEY	No Key (Zigbee specification r22.1.0)
BAD_CCM_OUTPUT	Bad ccm output (IEEE 802.15.4, Zigbee specification r22.1.0)
ROUTE_DISCOVERY_FAILED	Route discovery failed (Zigbee specification r22.1.0)
ROUTE_ERROR	Route error (Zigbee specification r22.1.0)
BT_TABLE_FULL	Bt table full (Zigbee specification r22.1.0)
FRAME_NOT_BUFFERED	Frame not buffered (Zigbee specification r22.1.0)
INVALID_INTERFACE	Invalid interface (Zigbee specification r22.1.0)
LIMIT_REACHED	Limit reached during network scan (IEEE 802.15.4-2011)
SCAN_IN_PROGRESS	The dev was scanning during this call (IEEE 802.5.4)

Definition at line 151 of file zigbee-nwk.h.

◆ NwkType

enum ns3::zigbee::NwkType

Zigbee Specification r22.1.0, Values of the frame Type Sub-field (Table 3-46)

Enumerator
DATA	Data frame type.
NWK_COMMAND	Network command frame type.
INTER_PAN	Inter-Pan frame type.

Definition at line 27 of file zigbee-nwk-header.h.

◆ PendingPrimitiveNwk

enum ns3::zigbee::PendingPrimitiveNwk : std::uint8_t

Indicates a pending NWK primitive.

Enumerator
NLDE_NLME_NONE	No pending primitive.
NLME_NETWORK_FORMATION	Pending NLME-NETWORK-FORMATION.request primitive.
NLME_DIRECT_JOIN	Pending NLME-DIRECT-JOIN.request primitive.
NLME_JOIN	Pending NLME-JOIN.request primitive.
NLME_START_ROUTER	Pending NLME-START-ROUTER.request primitive.
NLME_NET_DISCV	Pending NLME-NETWORK-DISCOVERY.request primitive.
NLME_JOIN_INDICATION	Pending NLME-JOIN.indication primitive.
NLME_ROUTE_DISCOVERY	Pending NLME-ROUTE-DISCOVERY.request primitive.
NLDE_DATA	Pending NLDE-DATA.request primitive.

Definition at line 57 of file zigbee-nwk.h.

◆ RouteDiscoveryStatus

enum ns3::zigbee::RouteDiscoveryStatus : std::uint8_t

The status returned while attempting to find the next hop in route towards a specific destination or a many-to-one route request attempt.

Enumerator
ROUTE_FOUND	The next hop toward the destination was found in our routing table or neighbor table (Mesh route).
ROUTE_NOT_FOUND	The next hop was not found. A new entry is is registered in the routing table with DISCOVER_UNDERWAY status(Mesh route).
TABLE_FULL	Either the routing or neighbor table are full.
ROUTE_UPDATED	A route was found and updated with a better route (Mesh route or Many-To-One route)
NO_DISCOVER_ROUTE	We are currently not allowed to perform a route discovery for this route (RouteDiscover flag in network header is false).
DISCOVER_UNDERWAY	The route was found in the tables but currently has no next hop. i.e. A previous attempt was already made is currently awaiting for a response (hence the route discover is underway).
MANY_TO_ONE_ROUTE	A new Many-To-One route was created.
NO_ROUTE_CHANGE	No route entry was created or updated during a Many-To-One process.

Definition at line 121 of file zigbee-nwk.h.

◆ StackProfile

enum ns3::zigbee::StackProfile

Use to describe the identifier of the zigbee stack profile.

Enumerator

ZIGBEE

Zigbee stack profile 0x01 (a.k.a.

Zigbee 2006, Zigbee 2007, Zigbee)

ZIGBEE_PRO

Zigbee stack profile 0x02 (Zigbee Pro, also known as r22.1.0, 3.0)

Definition at line 97 of file zigbee-nwk.h.

Function Documentation

◆ operator<<() [1/3]

std::ostream & ns3::zigbee::operator<<	(	std::ostream &	os,
		const NwkStatus &	state )

Overloaded operator to print the value of a NwkStatus.

Parameters

os	The output stream
state	The text value of the NWK state

Returns: The output stream with text value of the NWK state

Definition at line 3383 of file zigbee-nwk.cc.

References ACCESS_DENIED, ALREADY_PRESENT, BAD_CCM_OUTPUT, BEACON_LOSS, BT_TABLE_FULL, CHANNEL_ACCESS_FAILURE, COUNTER_ERROR, DENIED, DISABLE_TRX_FAILURE, FRAME_NOT_BUFFERED, FRAME_TOO_LONG, FULL_CAPACITY, IMPROPER_KEY_TYPE, IMPROPER_SECURITY_LEVEL, INVALID_ADDRESS, INVALID_GTS, INVALID_HANDLE, INVALID_INDEX, INVALID_INTERFACE, INVALID_PARAMETER, INVALID_PARAMETER_MAC, INVALID_REQUEST, LIMIT_REACHED, MAX_FRM_COUNTER, NEIGHBOR_TABLE_FULL, NO_ACK, NO_BEACON, NO_DATA, NO_KEY, NO_NETWORKS, NO_SHORT_ADDRESS, NOT_PERMITED, ON_TIME_TOO_LONG, OUT_OF_CAP, PAN_ID_CONFLICT, PAST_TIME, READ_ONLY, REALIGMENT, ROUTE_DISCOVERY_FAILED, ROUTE_ERROR, SCAN_IN_PROGRESS, SECURITY_ERROR, STARTUP_FAILURE, SUCCESS, SUPERFRAME_OVERLAP, SYNC_FAILURE, TRACKING_OFF, TRANSACTION_EXPIRED, TRANSACTION_OVERFLOW, TX_ACTIVE, UNAVAILABLE_KEY, UNKNOWN_DEVICE, UNSUPPORTED_ATTRIBUTE, UNSUPPORTED_LEGACY, and UNSUPPORTED_SECURITY.

◆ operator<<() [2/3]

std::ostream & ns3::zigbee::operator<<	(	std::ostream &	os,
		const std::vector< uint8_t > &	vec )

Overloaded operator to print uint8_t vectors.

Parameters

os	The output stream
vec	The uint8_t vector to print

Returns: The output stream with the text value of the uint8_t vector members

Definition at line 3557 of file zigbee-nwk.cc.

◆ operator<<() [3/3]

std::ostream & ns3::zigbee::operator<<	(	std::ostream &	os,
		const uint8_t &	num )

Parameters

os	The output stream
num	The uint8_t number to print

Returns: The output stream with the text value of the uint8_t number

Definition at line 3564 of file zigbee-nwk.cc.

Variable Documentation

◆ ALL_CHANNELS

uint32_t ns3::zigbee::ALL_CHANNELS = 0x07FFF800

staticconstexpr

Bitmap representing all channels (11~26) LSB b0-b26, b27-b31 MSB Page 0 in Zigbee (250kbps O-QPSK)

Definition at line 48 of file zigbee-nwk.h.

Referenced by ns3::zigbee::ChannelList::ChannelList(), and ZigbeeRreqRetryTestCase::DoRun().

Classes

Typedefs

Enumerations

Functions

Variables

Typedef Documentation

◆ NldeDataConfirmCallback

◆ NldeDataIndicationCallback

◆ NlmeDirectJoinConfirmCallback

◆ NlmeJoinConfirmCallback

◆ NlmeJoinIndicationCallback

◆ NlmeNetworkDiscoveryConfirmCallback

◆ NlmeNetworkFormationConfirmCallback

◆ NlmeRouteDiscoveryConfirmCallback

◆ NlmeStartRouterConfirmCallback

Enumeration Type Documentation

◆ AddrAllocMethod

◆ AddressMode

◆ ApsDstAddressModeBind

◆ BindingTableStatus

◆ DiscoverRouteType

◆ JoiningMethod

◆ ManyToOne

◆ MulticastMode

◆ NetworkStatusCode

◆ NwkCommandType

◆ NwkStatus

◆ NwkType

◆ PendingPrimitiveNwk

◆ RouteDiscoveryStatus

◆ StackProfile

Function Documentation

◆ operator<<() [1/3]

◆ operator<<() [2/3]

◆ operator<<() [3/3]

Variable Documentation

◆ ALL_CHANNELS