Topics | |
LR-WPAN common parameters | |
LrWpan module tests | |
Classes | |
class | ns3::lrwpan::BeaconPayloadHeader |
Implements the header for the MAC payload beacon frame according to the IEEE 802.15.4-2011 Std. More... | |
class | ns3::lrwpan::CapabilityField |
Represent the Capability Information Field. More... | |
class | ns3::lrwpan::CommandPayloadHeader |
Implements the header for the MAC payload command frame according to the IEEE 802.15.4-2011 Std. More... | |
struct | ns3::lrwpan::EdPower |
Helper structure to manage the power measurement during ED. More... | |
class | ns3::lrwpan::GtsFields |
Represent the GTS information fields. More... | |
class | ns3::lrwpan::LrWpanCsmaCa |
This class is a helper for the LrWpanMac to manage the Csma/CA state machine according to IEEE 802.15.4-2006, section 7.5.1.4. More... | |
class | ns3::lrwpan::LrWpanErrorModel |
Model the error rate for IEEE 802.15.4 2.4 GHz AWGN channel for OQPSK the model description can be found in IEEE Std 802.15.4-2006, section E.4.1.7. More... | |
class | ns3::LrWpanHelper |
helps to manage and create IEEE 802.15.4 NetDevice objects More... | |
class | ns3::lrwpan::LrWpanInterferenceHelper |
This class provides helper functions for LrWpan interference handling. More... | |
class | ns3::lrwpan::LrWpanLqiTag |
Represent the LQI (Link Quality Estination). More... | |
class | ns3::lrwpan::LrWpanMac |
Class that implements the LR-WPAN MAC state machine. More... | |
class | ns3::lrwpan::LrWpanMacHeader |
Represent the Mac Header with the Frame Control and Sequence Number fields. More... | |
class | ns3::lrwpan::LrWpanMacTrailer |
Represent the Mac Trailer with the Frame Check Sequence field. More... | |
class | ns3::lrwpan::LrWpanNetDevice |
Network layer to device interface. More... | |
class | ns3::lrwpan::LrWpanPhy |
Make LrWpanPhy a SpectrumPhy so we can enable the eventual modeling of device interference. More... | |
class | ns3::lrwpan::LrWpanSpectrumModelInitializer |
Helper class used to automatically initialize the LrWpan Spectrum Model objects. More... | |
struct | ns3::lrwpan::LrWpanSpectrumSignalParameters |
Signal parameters for LrWpan. More... | |
class | ns3::lrwpan::LrWpanSpectrumValueHelper |
This class defines all functions to create spectrum model for LrWpan. More... | |
struct | ns3::lrwpan::MacPibAttributes |
IEEE802.15.4-2011 PHY PIB Attributes Table 52 in section 6.4.2. More... | |
struct | ns3::lrwpan::McpsDataConfirmParams |
MCPS-DATA.confirm params. More... | |
struct | ns3::lrwpan::McpsDataIndicationParams |
MCPS-DATA.indication params. More... | |
struct | ns3::lrwpan::McpsDataRequestParams |
MCPS-DATA.request params. More... | |
struct | ns3::lrwpan::MlmeAssociateConfirmParams |
MLME-ASSOCIATE.confirm params. More... | |
struct | ns3::lrwpan::MlmeAssociateIndicationParams |
MLME-ASSOCIATE.indication params. More... | |
struct | ns3::lrwpan::MlmeAssociateRequestParams |
MLME-ASSOCIATE.request params. More... | |
struct | ns3::lrwpan::MlmeAssociateResponseParams |
MLME-ASSOCIATE.response params. More... | |
struct | ns3::lrwpan::MlmeBeaconNotifyIndicationParams |
MLME-BEACON-NOTIFY.indication params. More... | |
struct | ns3::lrwpan::MlmeCommStatusIndicationParams |
MLME-COMM-STATUS.indication params. More... | |
struct | ns3::lrwpan::MlmeOrphanIndicationParams |
MLME-ORPHAN.indication params. More... | |
struct | ns3::lrwpan::MlmeOrphanResponseParams |
MLME-ORPHAN.response params. More... | |
struct | ns3::lrwpan::MlmePollConfirmParams |
MLME-START.confirm params. More... | |
struct | ns3::lrwpan::MlmePollRequestParams |
MLME-POLL.request params. More... | |
struct | ns3::lrwpan::MlmeScanConfirmParams |
MLME-SCAN.confirm params. More... | |
struct | ns3::lrwpan::MlmeScanRequestParams |
MLME-SCAN.request params. More... | |
struct | ns3::lrwpan::MlmeSetConfirmParams |
MLME-SET.confirm params. More... | |
struct | ns3::lrwpan::MlmeStartConfirmParams |
MLME-START.confirm params. More... | |
struct | ns3::lrwpan::MlmeStartRequestParams |
MLME-START.request params. More... | |
struct | ns3::lrwpan::MlmeSyncLossIndicationParams |
MLME-SYNC-LOSS.indication params. More... | |
struct | ns3::lrwpan::MlmeSyncRequestParams |
MLME-SYNC.request params. More... | |
struct | ns3::zigbee::NetworkDescriptor |
Network Descriptor, Zigbee Specification r22.1.0, 3.2.2.4, Table 3-12. More... | |
struct | ns3::zigbee::NldeDataIndicationParams |
NLDE-DATA.indication params. More... | |
struct | ns3::lrwpan::PanDescriptor |
PAN Descriptor, Table 17 IEEE 802.15.4-2011. More... | |
class | ns3::lrwpan::PendingAddrFields |
Represent the Pending Address Specification field. More... | |
struct | ns3::lrwpan::PhyDataAndSymbolRates |
This data structure provides the Bit rate and Symbol rate for a given channel See IEEE802.15.4-2006 Table 1 and 2 in section 6.1.1 and 6.1.2. More... | |
struct | ns3::lrwpan::PhyPibAttributes |
IEEE802.15.4-2006 PHY PIB Attributes Table 23 in section 6.4.2. More... | |
struct | ns3::lrwpan::PhyPpduHeaderSymbolNumber |
This data structure provides number of symbols for the PPDU headers: SHR and PHR See IEEE802.15.4-2006 Figure 16, Table 19 and 20 in section 6.3. More... | |
class | ns3::lrwpan::SuperframeField |
Represent the Superframe Specification information field. More... | |
class | ns3::zigbee::SuperframeInformation |
Represent the Superframe Specification information field. More... | |
Typedefs | |
typedef Callback< void, MacState > | ns3::lrwpan::LrWpanMacStateCallback |
This method informs the MAC whether the channel is idle or busy. | |
typedef Callback< void, uint32_t > | ns3::lrwpan::LrWpanMacTransCostCallback |
This method informs the transaction cost in a slotted CSMA-CA data transmission. | |
typedef void(* | ns3::lrwpan::TracedValueCallback::MacState) (MacState oldValue, MacState newValue) |
TracedValue callback signature for MacState. | |
using | ns3::lrwpan::McpsDataConfirmCallback = Callback<void, McpsDataConfirmParams> |
This callback is called after a McpsDataRequest has been called from the higher layer. | |
using | ns3::lrwpan::McpsDataIndicationCallback = Callback<void, McpsDataIndicationParams, Ptr<Packet>> |
This callback is called after a Mcps has successfully received a frame and wants to deliver it to the higher layer. | |
using | ns3::lrwpan::MlmeAssociateConfirmCallback = Callback<void, MlmeAssociateConfirmParams> |
This callback is called after a MlmeAssociateRequest has been called from the higher layer. | |
using | ns3::lrwpan::MlmeAssociateIndicationCallback = Callback<void, MlmeAssociateIndicationParams> |
This callback is called after a Mlme has successfully received a command frame and wants to deliver it to the higher layer. | |
using | ns3::lrwpan::MlmeBeaconNotifyIndicationCallback = Callback<void, MlmeBeaconNotifyIndicationParams> |
This callback is called after a Mlme has successfully received a beacon frame and wants to deliver it to the higher layer. | |
using | ns3::lrwpan::MlmeCommStatusIndicationCallback = Callback<void, MlmeCommStatusIndicationParams> |
This callback is called by the MLME and issued to its next higher layer following a transmission instigated through a response primitive. | |
using | ns3::lrwpan::MlmeGetConfirmCallback |
This callback is called after a MlmeGetRequest has been called from the higher layer to get a PIB. | |
using | ns3::lrwpan::MlmeOrphanIndicationCallback = Callback<void, MlmeOrphanIndicationParams> |
This callback is called by the MLME and issued to its next higher layer following the reception of a orphan notification. | |
using | ns3::lrwpan::MlmePollConfirmCallback = Callback<void, MlmePollConfirmParams> |
This callback is called after a Mlme-Poll.Request has been called from the higher layer. | |
using | ns3::lrwpan::MlmeScanConfirmCallback = Callback<void, MlmeScanConfirmParams> |
This callback is called after a MlmeScanRequest has been called from the higher layer. | |
using | ns3::lrwpan::MlmeSetConfirmCallback = Callback<void, MlmeSetConfirmParams> |
This callback is called after a MlmeSetRequest has been called from the higher layer to set a PIB. | |
using | ns3::lrwpan::MlmeStartConfirmCallback = Callback<void, MlmeStartConfirmParams> |
This callback is called after a MlmeStartRequest has been called from the higher layer. | |
using | ns3::lrwpan::MlmeSyncLossIndicationCallback = Callback<void, MlmeSyncLossIndicationParams> |
This callback is called to indicate the loss of synchronization with a coordinator. | |
typedef Callback< void, PhyEnumeration > | ns3::lrwpan::PdDataConfirmCallback |
This method implements the PD SAP: PdDataConfirm. | |
typedef Callback< void, uint32_t, Ptr< Packet >, uint8_t > | ns3::lrwpan::PdDataIndicationCallback |
This method implements the PD SAP: PdDataIndication. | |
typedef void(* | ns3::lrwpan::TracedValueCallback::PhyEnumeration) (PhyEnumeration oldValue, PhyEnumeration newValue) |
TracedValue callback signature for PhyEnumeration. | |
typedef Callback< void, PhyEnumeration > | ns3::lrwpan::PlmeCcaConfirmCallback |
This method implements the PD SAP: PlmeCcaConfirm. | |
typedef Callback< void, PhyEnumeration, uint8_t > | ns3::lrwpan::PlmeEdConfirmCallback |
This method implements the PD SAP: PlmeEdConfirm. | |
typedef Callback< void, PhyEnumeration, PhyPibAttributeIdentifier, Ptr< PhyPibAttributes > > | ns3::lrwpan::PlmeGetAttributeConfirmCallback |
This method implements the PD SAP: PlmeGetAttributeConfirm. | |
typedef Callback< void, PhyEnumeration, PhyPibAttributeIdentifier > | ns3::lrwpan::PlmeSetAttributeConfirmCallback |
This method implements the PD SAP: PlmeSetAttributeConfirm. | |
typedef Callback< void, PhyEnumeration > | ns3::lrwpan::PlmeSetTRXStateConfirmCallback |
This method implements the PD SAP: PlmeSetTRXStateConfirm. | |
typedef void(* | ns3::lrwpan::TracedValueCallback::SuperframeStatus) (SuperframeStatus oldValue, SuperframeStatus newValue) |
TracedValue callback signature for SuperframeStatus. | |
Variables | |
class ns3::lrwpan::LrWpanSpectrumModelInitializer | ns3::lrwpan::g_LrWpanSpectrumModelInitializerInstance |
Global object used to initialize the LrWpan Spectrum Model. | |
This section documents the API of the IEEE 802.15.4-related models. For a generic functional description, please refer to the ns-3 manual.
typedef Callback<void, MacState> ns3::lrwpan::LrWpanMacStateCallback |
This method informs the MAC whether the channel is idle or busy.
Definition at line 33 of file lr-wpan-csmaca.h.
typedef Callback<void, uint32_t> ns3::lrwpan::LrWpanMacTransCostCallback |
This method informs the transaction cost in a slotted CSMA-CA data transmission.
i.e. Reports number of symbols (time) it would take slotted CSMA-CA to process the current transaction. 1 Transaction = 2 CCA + frame transmission (PPDU) + turnaroudtime or Ack time (optional) + IFS See IEEE 802.15.4-2011 (Sections 5.1.1.1 and 5.1.1.4)
Definition at line 42 of file lr-wpan-csmaca.h.
TracedValue callback signature for MacState.
[in] | oldValue | original value of the traced variable |
[in] | newValue | new value of the traced variable |
Definition at line 134 of file lr-wpan-mac.h.
using ns3::lrwpan::McpsDataConfirmCallback = Callback<void, McpsDataConfirmParams> |
This callback is called after a McpsDataRequest has been called from the higher layer.
It returns a status of the outcome of the transmission request
Definition at line 527 of file lr-wpan-mac-base.h.
using ns3::lrwpan::McpsDataIndicationCallback = Callback<void, McpsDataIndicationParams, Ptr<Packet>> |
This callback is called after a Mcps has successfully received a frame and wants to deliver it to the higher layer.
Definition at line 538 of file lr-wpan-mac-base.h.
This callback is called after a MlmeAssociateRequest has been called from the higher layer.
It returns a status of the outcome of the association request
Definition at line 597 of file lr-wpan-mac-base.h.
This callback is called after a Mlme has successfully received a command frame and wants to deliver it to the higher layer.
Security related parameters and not handle. See 802.15.4-2011 6.2.2.2.
Definition at line 549 of file lr-wpan-mac-base.h.
using ns3::lrwpan::MlmeBeaconNotifyIndicationCallback = Callback<void, MlmeBeaconNotifyIndicationParams> |
This callback is called after a Mlme has successfully received a beacon frame and wants to deliver it to the higher layer.
Definition at line 608 of file lr-wpan-mac-base.h.
using ns3::lrwpan::MlmeCommStatusIndicationCallback = Callback<void, MlmeCommStatusIndicationParams> |
This callback is called by the MLME and issued to its next higher layer following a transmission instigated through a response primitive.
Security related parameters and not handle. See 802.15.4-2011 6.2.4.2
Definition at line 560 of file lr-wpan-mac-base.h.
This callback is called after a MlmeGetRequest has been called from the higher layer to get a PIB.
It returns a status of the outcome of the write attempt.
Definition at line 637 of file lr-wpan-mac-base.h.
This callback is called by the MLME and issued to its next higher layer following the reception of a orphan notification.
Security related parameters and not handle. See 802.15.4-2011 6.2.7.1
Definition at line 571 of file lr-wpan-mac-base.h.
using ns3::lrwpan::MlmePollConfirmCallback = Callback<void, MlmePollConfirmParams> |
This callback is called after a Mlme-Poll.Request has been called from the higher layer.
It returns a status of the outcome of the transmission request
Definition at line 647 of file lr-wpan-mac-base.h.
using ns3::lrwpan::MlmeScanConfirmCallback = Callback<void, MlmeScanConfirmParams> |
This callback is called after a MlmeScanRequest has been called from the higher layer.
It returns a status of the outcome of the scan.
Definition at line 588 of file lr-wpan-mac-base.h.
using ns3::lrwpan::MlmeSetConfirmCallback = Callback<void, MlmeSetConfirmParams> |
This callback is called after a MlmeSetRequest has been called from the higher layer to set a PIB.
It returns a status of the outcome of the write attempt.
Definition at line 628 of file lr-wpan-mac-base.h.
using ns3::lrwpan::MlmeStartConfirmCallback = Callback<void, MlmeStartConfirmParams> |
This callback is called after a MlmeStartRequest has been called from the higher layer.
It returns a status of the outcome of the transmission request
Definition at line 580 of file lr-wpan-mac-base.h.
This callback is called to indicate the loss of synchronization with a coordinator.
Definition at line 619 of file lr-wpan-mac-base.h.
typedef Callback<void, PhyEnumeration> ns3::lrwpan::PdDataConfirmCallback |
This method implements the PD SAP: PdDataConfirm.
status | the status to be transmitted |
Definition at line 204 of file lr-wpan-phy.h.
typedef Callback<void, uint32_t, Ptr<Packet>, uint8_t> ns3::lrwpan::PdDataIndicationCallback |
This method implements the PD SAP: PdDataIndication.
psduLength | number of bytes in the PSDU |
p | the packet to be transmitted |
lqi | Link quality (LQI) value measured during reception of the PPDU |
Definition at line 195 of file lr-wpan-phy.h.
typedef void(* ns3::lrwpan::TracedValueCallback::PhyEnumeration) (PhyEnumeration oldValue, PhyEnumeration newValue) |
TracedValue callback signature for PhyEnumeration.
[in] | oldValue | original value of the traced variable |
[in] | newValue | new value of the traced variable |
Definition at line 147 of file lr-wpan-phy.h.
typedef Callback<void, PhyEnumeration> ns3::lrwpan::PlmeCcaConfirmCallback |
This method implements the PD SAP: PlmeCcaConfirm.
status | the status of CCA |
Definition at line 213 of file lr-wpan-phy.h.
typedef Callback<void, PhyEnumeration, uint8_t> ns3::lrwpan::PlmeEdConfirmCallback |
This method implements the PD SAP: PlmeEdConfirm.
status | the status of ED |
energyLevel | the energy level of ED |
Definition at line 223 of file lr-wpan-phy.h.
typedef Callback<void, PhyEnumeration, PhyPibAttributeIdentifier, Ptr<PhyPibAttributes> > ns3::lrwpan::PlmeGetAttributeConfirmCallback |
This method implements the PD SAP: PlmeGetAttributeConfirm.
status | the status of PlmeGetAttributeRequest |
id | the identifier of attribute |
attribute | the pointer to attribute struct |
Definition at line 235 of file lr-wpan-phy.h.
typedef Callback<void, PhyEnumeration, PhyPibAttributeIdentifier> ns3::lrwpan::PlmeSetAttributeConfirmCallback |
This method implements the PD SAP: PlmeSetAttributeConfirm.
status | the status of PlmeSetAttributeRequest |
id | the identifier of attribute |
Definition at line 254 of file lr-wpan-phy.h.
typedef Callback<void, PhyEnumeration> ns3::lrwpan::PlmeSetTRXStateConfirmCallback |
This method implements the PD SAP: PlmeSetTRXStateConfirm.
status | the status of PlmeSetTRXStateRequest |
Definition at line 244 of file lr-wpan-phy.h.
typedef void(* ns3::lrwpan::TracedValueCallback::SuperframeStatus) (SuperframeStatus oldValue, SuperframeStatus newValue) |
TracedValue callback signature for SuperframeStatus.
[in] | oldValue | original value of the traced variable |
[in] | newValue | new value of the traced variable |
Definition at line 143 of file lr-wpan-mac.h.
table 80 of 802.15.4
Enumerator | |
---|---|
NO_PANID_ADDR | |
ADDR_MODE_RESERVED | |
SHORT_ADDR | |
EXT_ADDR |
Definition at line 86 of file lr-wpan-mac-base.h.
The device Capabilities.
Enumerator | |
---|---|
RFD | Reduced Functional Device (RFD) |
FFD | Full Functional Device (FFD) |
Definition at line 33 of file lr-wpan-fields.h.
IEEE 802.15.4-2006 PHY and MAC PIB Attribute Identifiers Table 23 and Table 86.
Note: Attribute identifiers use standardized values.
Definition at line 245 of file lr-wpan-mac-base.h.
MAC states.
Definition at line 63 of file lr-wpan-mac.h.
|
strong |
The status of a confirm or an indication primitive as a result of a previous request.
Represent the value of status in IEEE 802.15.4-2011 primitives. (Tables 6, 12, 18, 20, 31, 33, 35, 37, 39, 47)
Status codes values only appear in IEEE 802.15.4-2006, Table 78 See also NXP JN5169 IEEE 802.15.4 Stack User Guide (Table 6: Status Enumerations and Section 6.1.23)
Definition at line 39 of file lr-wpan-mac-base.h.
Table 30 of IEEE 802.15.4-2011.
Enumerator | |
---|---|
MLMESCAN_ED | |
MLMESCAN_ACTIVE | |
MLMESCAN_PASSIVE | |
MLMESCAN_ORPHAN |
Definition at line 99 of file lr-wpan-mac-base.h.
Indicates a pending MAC primitive.
Definition at line 115 of file lr-wpan-mac.h.
IEEE802.15.4-2006 PHY Emumerations Table 18 in section 6.2.3.
Definition at line 103 of file lr-wpan-phy.h.
This Phy option will be used to index various Tables in IEEE802.15.4-2011.
Definition at line 83 of file lr-wpan-phy.h.
IEEE802.15.4-2006 PHY PIB Attribute Identifiers Table 23 in section 6.4.2.
Enumerator | |
---|---|
phyCurrentChannel | |
phyChannelsSupported | |
phyTransmitPower | |
phyCCAMode | |
phyCurrentPage | |
phyMaxFrameDuration | |
phySHRDuration | |
phySymbolsPerOctet |
Definition at line 155 of file lr-wpan-phy.h.
Superframe status.
Enumerator | |
---|---|
BEACON | The Beacon transmission or reception Period. |
CAP | Contention Access Period. |
CFP | Contention Free Period. |
INACTIVE | Inactive Period or unslotted CSMA-CA. |
Definition at line 91 of file lr-wpan-mac.h.
Superframe type.
Enumerator | |
---|---|
OUTGOING | Outgoing Superframe. |
INCOMING | Incoming Superframe. |
Definition at line 104 of file lr-wpan-mac.h.
Tx options.
Enumerator | |
---|---|
TX_OPTION_NONE | TX_OPTION_NONE. |
TX_OPTION_ACK | TX_OPTION_ACK. |
TX_OPTION_GTS | TX_OPTION_GTS. |
TX_OPTION_INDIRECT | TX_OPTION_INDIRECT. |
Definition at line 50 of file lr-wpan-mac.h.
class ns3::lrwpan::LrWpanSpectrumModelInitializer ns3::lrwpan::g_LrWpanSpectrumModelInitializerInstance |
Global object used to initialize the LrWpan Spectrum Model.