A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::lorawan::EndDeviceLoraPhy Class Referenceabstract

Class representing a LoRa transceiver. More...

#include "end-device-lora-phy.h"

+ Inheritance diagram for ns3::lorawan::EndDeviceLoraPhy:
+ Collaboration diagram for ns3::lorawan::EndDeviceLoraPhy:

Public Types

enum  State { SLEEP , STANDBY , TX , RX }
 An enumeration of the possible states of an EndDeviceLoraPhy. More...
 
- Public Types inherited from ns3::lorawan::LoraPhy
typedef Callback< void, Ptr< const Packet > > RxFailedCallback
 Type definition for a callback for when a packet reception fails.
 
typedef Callback< void, Ptr< const Packet > > RxOkCallback
 Type definition for a callback for when a packet is correctly received.
 
typedef Callback< void, Ptr< const Packet > > TxFinishedCallback
 Type definition for a callback to call when a packet has finished sending.
 

Public Member Functions

 EndDeviceLoraPhy ()
 Default constructor.
 
 ~EndDeviceLoraPhy () override
 Destructor.
 
void EndReceive (Ptr< Packet > packet, Ptr< LoraInterferenceHelper::Event > event) override=0
 Finish reception of a packet.
 
uint8_t GetSpreadingFactor () const
 Get the Spreading Factor this end device is listening for.
 
EndDeviceLoraPhy::State GetState ()
 Return the state this end device is currently in.
 
bool IsOnFrequency (double frequencyMHz) override
 Whether this device is listening on the specified frequency or not.
 
bool IsTransmitting () override
 Whether this device is transmitting or not.
 
void RegisterListener (EndDeviceLoraPhyListener *listener)
 Add the input listener to the list of objects to be notified of PHY-level events.
 
void Send (Ptr< Packet > packet, LoraTxParameters txParams, double frequencyMHz, double txPowerDbm) override=0
 Instruct the PHY to send a packet according to some parameters.
 
void SetFrequency (double frequencyMHz)
 Set the frequency this end device will listen on.
 
void SetSpreadingFactor (uint8_t sf)
 Set the Spreading Factor this end device will listen for.
 
void StartReceive (Ptr< Packet > packet, double rxPowerDbm, uint8_t sf, Time duration, double frequencyMHz) override=0
 Start receiving a packet.
 
void SwitchToSleep ()
 Switch to the SLEEP state.
 
void SwitchToStandby ()
 Switch to the STANDBY state.
 
void UnregisterListener (EndDeviceLoraPhyListener *listener)
 Remove the input listener from the list of objects to be notified of PHY-level events.
 
- Public Member Functions inherited from ns3::lorawan::LoraPhy
 LoraPhy ()
 Default constructor.
 
 ~LoraPhy () override
 Destructor.
 
virtual void EndReceive (Ptr< Packet > packet, Ptr< LoraInterferenceHelper::Event > event)=0
 Finish reception of a packet.
 
Ptr< LoraChannelGetChannel () const
 Get the channel instance associated to this PHY.
 
Ptr< NetDeviceGetDevice () const
 Get the NetDevice associated to this PHY.
 
Ptr< MobilityModelGetMobility ()
 Get the mobility model associated to this PHY.
 
virtual bool IsOnFrequency (double frequency)=0
 Whether this device is listening on the specified frequency or not.
 
virtual bool IsTransmitting ()=0
 Whether this device is transmitting or not.
 
virtual void Send (Ptr< Packet > packet, LoraTxParameters txParams, double frequencyMHz, double txPowerDbm)=0
 Instruct the PHY to send a packet according to some parameters.
 
void SetChannel (Ptr< LoraChannel > channel)
 Set the LoraChannel instance PHY transmits on.
 
void SetDevice (Ptr< NetDevice > device)
 Set the NetDevice that owns this PHY.
 
void SetMobility (Ptr< MobilityModel > mobility)
 Set the mobility model associated to this PHY.
 
void SetReceiveFailedCallback (RxFailedCallback callback)
 Set the callback to call upon failed reception of a packet we were previously locked on.
 
void SetReceiveOkCallback (RxOkCallback callback)
 Set the callback to call upon successful reception of a packet.
 
void SetTxFinishedCallback (TxFinishedCallback callback)
 Set the callback to call after transmission of a packet.
 
virtual void StartReceive (Ptr< Packet > packet, double rxPowerDbm, uint8_t sf, Time duration, double frequencyMHz)=0
 Start receiving a packet.
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor.
 
 ~Object () override
 Destructor.
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together.
 
void Dispose ()
 Dispose of this Object.
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one.
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object.
 
template<typename T >
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated Object.
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object.
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId.
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object.
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one.
 
bool IsInitialized () const
 Check if the object has been initialized.
 
void UnidirectionalAggregateObject (Ptr< Object > other)
 Aggregate an Object to another Object.
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor.
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor.
 
uint32_t GetReferenceCount () const
 Get the reference count of the object.
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator.
 
void Ref () const
 Increment the reference count.
 
void Unref () const
 Decrement the reference count.
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor.
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful.
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising errors.
 
virtual TypeId GetInstanceTypeId () const =0
 Get the most derived TypeId for this Object.
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful.
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors.
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context.
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context.
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context.
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context.
 

Static Public Member Functions

static TypeId GetTypeId ()
 Register this type.
 
- Static Public Member Functions inherited from ns3::lorawan::LoraPhy
static Time GetOnAirTime (Ptr< Packet > packet, LoraTxParameters txParams)
 Compute the time that a packet with certain characteristics will take to be transmitted.
 
static Time GetTSym (LoraTxParameters txParams)
 Compute the symbol time from spreading factor and bandwidth.
 
static TypeId GetTypeId ()
 Register this type.
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId ()
 Register this type.
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID.
 

Static Public Attributes

static const double sensitivity [6] = {-124, -127, -130, -133, -135, -137}
 The sensitivity vector of this device to different SFs.
 

Protected Types

typedef std::vector< EndDeviceLoraPhyListener * > Listeners
 typedef for a list of EndDeviceLoraPhyListener.
 
typedef std::vector< EndDeviceLoraPhyListener * >::iterator ListenersI
 typedef for a list of EndDeviceLoraPhyListener iterator.
 

Protected Member Functions

void SwitchToRx ()
 Switch to the RX state.
 
void SwitchToTx (double txPowerDbm)
 Switch to the TX state.
 
void TxFinished (Ptr< const Packet > packet) override
 Signals the end of a transmission by the EndDeviceLoraPhy.
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object.
 
virtual void DoDispose ()
 Destructor implementation.
 
virtual void DoInitialize ()
 Initialize() implementation.
 
virtual void NotifyNewAggregate ()
 Notify all Objects aggregated to this one of a new Object being aggregated.
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes.
 
virtual void NotifyConstructionCompleted ()
 Notifier called once the ObjectBase is fully constructed.
 

Protected Attributes

double m_frequency
 The frequency this device is listening on.
 
Listeners m_listeners
 PHY listeners.
 
uint8_t m_sf
 The Spreading Factor this device is listening for.
 
TracedValue< Statem_state
 The state this PHY is currently in.
 
TracedCallback< Ptr< const Packet >, uint32_tm_wrongFrequency
 Trace source for when a packet is lost because it was transmitted on a frequency different from the one this EndDeviceLoraPhy was configured to listen on.
 
TracedCallback< Ptr< const Packet >, uint32_tm_wrongSf
 Trace source for when a packet is lost because it was using a spreading factor different from the one this EndDeviceLoraPhy was configured to listen for.
 
- Protected Attributes inherited from ns3::lorawan::LoraPhy
Ptr< LoraChannelm_channel
 The channel this PHY transmits on.
 
Ptr< NetDevicem_device
 The net device this PHY is attached to.
 
TracedCallback< Ptr< const Packet >, uint32_tm_interferedPacket
 The trace source fired when a packet cannot be correctly received because of interference.
 
LoraInterferenceHelper m_interference
 The LoraInterferenceHelper associated to this PHY.
 
TracedCallback< Ptr< const Packet > > m_phyRxBeginTrace
 The trace source fired when a packet begins the reception process from the medium.
 
TracedCallback< Ptr< const Packet > > m_phyRxEndTrace
 The trace source fired when a packet reception ends.
 
RxFailedCallback m_rxFailedCallback
 The callback to perform upon failed reception of a packet we were locked on.
 
RxOkCallback m_rxOkCallback
 The callback to perform upon correct reception of a packet.
 
TracedCallback< Ptr< const Packet >, uint32_tm_startSending
 The trace source fired when a packet is sent.
 
TracedCallback< Ptr< const Packet >, uint32_tm_successfullyReceivedPacket
 The trace source fired when a packet was correctly received.
 
TxFinishedCallback m_txFinishedCallback
 The callback to perform upon the end of a transmission.
 
TracedCallback< Ptr< const Packet >, uint32_tm_underSensitivity
 The trace source fired when a packet cannot be received because its power is below the sensitivity threshold.
 

Additional Inherited Members

Detailed Description

Class representing a LoRa transceiver.

This class inherits some functionality by LoraPhy, like the GetOnAirTime function, and extends it to represent the behavior of a LoRa chip, like the SX1272.

Additional behaviors featured in this class include a State member variable that expresses the current state of the device (SLEEP, TX, RX or STANDBY), and a frequency and Spreading Factor this device is listening to when in STANDBY mode. After transmission and reception, the device returns automatically to STANDBY mode. The decision of when to go into SLEEP mode is delegateed to an upper layer, which can modify the state of the device through the public SwitchToSleep and SwitchToStandby methods. In SLEEP mode, the device cannot lock on a packet and start reception.

Peculiarities about the error model and about how errors are handled are supposed to be handled by classes extending this one, like SimpleEndDeviceLoraPhy or SpectrumEndDeviceLoraPhy. These classes need to

Definition at line 107 of file end-device-lora-phy.h.

Member Typedef Documentation

◆ Listeners

typedef for a list of EndDeviceLoraPhyListener.

Definition at line 284 of file end-device-lora-phy.h.

◆ ListenersI

typedef std::vector<EndDeviceLoraPhyListener*>::iterator ns3::lorawan::EndDeviceLoraPhy::ListenersI
protected

typedef for a list of EndDeviceLoraPhyListener iterator.

Definition at line 288 of file end-device-lora-phy.h.

Member Enumeration Documentation

◆ State

An enumeration of the possible states of an EndDeviceLoraPhy.

It makes sense to define a state for End Devices since there's only one demodulator which can either send, receive, stay idle or go in a deep sleep state.

Enumerator
SLEEP 

The PHY layer is sleeping.

During sleep, the device is not listening for incoming messages.

STANDBY 

The PHY layer is in STANDBY.

When the PHY is in this state, it's listening to the channel, and it's also ready to transmit data passed to it by the MAC layer.

TX 

The PHY layer is sending a packet.

During transmission, the device cannot receive any packet or send any additional packet.

RX 

The PHY layer is receiving a packet.

While the device is locked on an incoming packet, transmission is not possible.

Definition at line 116 of file end-device-lora-phy.h.

Constructor & Destructor Documentation

◆ EndDeviceLoraPhy()

ns3::lorawan::EndDeviceLoraPhy::EndDeviceLoraPhy ( )

Default constructor.

Definition at line 74 of file end-device-lora-phy.cc.

◆ ~EndDeviceLoraPhy()

ns3::lorawan::EndDeviceLoraPhy::~EndDeviceLoraPhy ( )
override

Destructor.

Definition at line 81 of file end-device-lora-phy.cc.

Member Function Documentation

◆ EndReceive()

void ns3::lorawan::EndDeviceLoraPhy::EndReceive ( Ptr< Packet packet,
Ptr< LoraInterferenceHelper::Event event 
)
overridepure virtual

Finish reception of a packet.

This method is scheduled by StartReceive, based on the packet duration. By passing a LoraInterferenceHelper Event to this method, the class will be able to identify the packet that is being received among all those that were registered as interference by StartReceive.

Parameters
packetThe received packet.
eventThe event that is tied to this packet in the LoraInterferenceHelper.

Implements ns3::lorawan::LoraPhy.

Implemented in ns3::lorawan::SimpleEndDeviceLoraPhy.

◆ GetSpreadingFactor()

uint8_t ns3::lorawan::EndDeviceLoraPhy::GetSpreadingFactor ( ) const

Get the Spreading Factor this end device is listening for.

Returns
The Spreading Factor we are listening for.

Definition at line 97 of file end-device-lora-phy.cc.

References m_sf.

◆ GetState()

EndDeviceLoraPhy::State ns3::lorawan::EndDeviceLoraPhy::GetState ( )

Return the state this end device is currently in.

Returns
The state this EndDeviceLoraPhy is currently in.

Definition at line 197 of file end-device-lora-phy.cc.

References m_state, and NS_LOG_FUNCTION_NOARGS.

Referenced by ns3::lorawan::ClassAEndDeviceLorawanMac::CloseSecondReceiveWindow(), PhyConnectivityTest::DoRun(), and ns3::lorawan::ClassAEndDeviceLorawanMac::OpenSecondReceiveWindow().

+ Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::lorawan::EndDeviceLoraPhy::GetTypeId ( )
static

Register this type.

Returns
The object TypeId.

Definition at line 47 of file end-device-lora-phy.cc.

References m_state, m_wrongFrequency, m_wrongSf, ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ IsOnFrequency()

bool ns3::lorawan::EndDeviceLoraPhy::IsOnFrequency ( double  frequency)
overridevirtual

Whether this device is listening on the specified frequency or not.

Parameters
frequencyThe frequency to query.
Returns
True if the device is listening on that frequency, false otherwise.

Implements ns3::lorawan::LoraPhy.

Definition at line 109 of file end-device-lora-phy.cc.

References m_frequency.

Referenced by ns3::lorawan::SimpleEndDeviceLoraPhy::StartReceive().

+ Here is the caller graph for this function:

◆ IsTransmitting()

bool ns3::lorawan::EndDeviceLoraPhy::IsTransmitting ( )
overridevirtual

Whether this device is transmitting or not.

Returns
True if the device is currently transmitting a packet, false otherwise.

Implements ns3::lorawan::LoraPhy.

Definition at line 103 of file end-device-lora-phy.cc.

References m_state, and TX.

◆ RegisterListener()

void ns3::lorawan::EndDeviceLoraPhy::RegisterListener ( EndDeviceLoraPhyListener listener)

Add the input listener to the list of objects to be notified of PHY-level events.

Parameters
listenerThe new listener.

Definition at line 205 of file end-device-lora-phy.cc.

References m_listeners.

◆ Send()

void ns3::lorawan::EndDeviceLoraPhy::Send ( Ptr< Packet packet,
LoraTxParameters  txParams,
double  frequencyMHz,
double  txPowerDbm 
)
overridepure virtual

Instruct the PHY to send a packet according to some parameters.

Parameters
packetThe packet to send.
txParamsThe desired transmission parameters.
frequencyMHzThe frequency on which to transmit.
txPowerDbmThe power in dBm with which to transmit the packet.

Implements ns3::lorawan::LoraPhy.

Implemented in ns3::lorawan::SimpleEndDeviceLoraPhy.

◆ SetFrequency()

void ns3::lorawan::EndDeviceLoraPhy::SetFrequency ( double  frequencyMHz)

Set the frequency this end device will listen on.

Should a packet be transmitted on a frequency different than that the EndDeviceLoraPhy is listening on, the packet will be discarded.

Parameters
frequencyMHzThe frequency [MHz] to listen to.

Definition at line 115 of file end-device-lora-phy.cc.

References m_frequency.

Referenced by PhyConnectivityTest::Reset().

+ Here is the caller graph for this function:

◆ SetSpreadingFactor()

void ns3::lorawan::EndDeviceLoraPhy::SetSpreadingFactor ( uint8_t  sf)

Set the Spreading Factor this end device will listen for.

The EndDeviceLoraPhy object will not be able to lock on transmissions that use a different spreading factor than the one it's listening for.

Parameters
sfThe spreading factor to listen for.

Definition at line 91 of file end-device-lora-phy.cc.

References m_sf.

Referenced by PhyConnectivityTest::DoRun(), and PhyConnectivityTest::Reset().

+ Here is the caller graph for this function:

◆ StartReceive()

void ns3::lorawan::EndDeviceLoraPhy::StartReceive ( Ptr< Packet packet,
double  rxPowerDbm,
uint8_t  sf,
Time  duration,
double  frequencyMHz 
)
overridepure virtual

Start receiving a packet.

This method is typically called by LoraChannel.

Parameters
packetThe packet that is arriving at this PHY layer.
rxPowerDbmThe power of the arriving packet (assumed to be constant for the whole reception).
sfThe Spreading Factor of the arriving packet.
durationThe on air time of this packet.
frequencyMHzThe frequency this packet is being transmitted on.

Implements ns3::lorawan::LoraPhy.

Implemented in ns3::lorawan::SimpleEndDeviceLoraPhy.

◆ SwitchToRx()

void ns3::lorawan::EndDeviceLoraPhy::SwitchToRx ( )
protected

Switch to the RX state.

Definition at line 149 of file end-device-lora-phy.cc.

References m_listeners, m_state, NS_ASSERT, NS_LOG_FUNCTION_NOARGS, RX, and STANDBY.

Referenced by ns3::lorawan::SimpleEndDeviceLoraPhy::StartReceive().

+ Here is the caller graph for this function:

◆ SwitchToSleep()

void ns3::lorawan::EndDeviceLoraPhy::SwitchToSleep ( )

Switch to the SLEEP state.

Definition at line 181 of file end-device-lora-phy.cc.

References m_listeners, m_state, NS_ASSERT, NS_LOG_FUNCTION_NOARGS, SLEEP, and STANDBY.

Referenced by PhyConnectivityTest::DoRun().

+ Here is the caller graph for this function:

◆ SwitchToStandby()

void ns3::lorawan::EndDeviceLoraPhy::SwitchToStandby ( )

Switch to the STANDBY state.

Definition at line 135 of file end-device-lora-phy.cc.

References m_listeners, m_state, NS_LOG_FUNCTION_NOARGS, and STANDBY.

Referenced by ns3::lorawan::SimpleEndDeviceLoraPhy::EndReceive(), PhyConnectivityTest::Reset(), and TxFinished().

+ Here is the caller graph for this function:

◆ SwitchToTx()

void ns3::lorawan::EndDeviceLoraPhy::SwitchToTx ( double  txPowerDbm)
protected

Switch to the TX state.

Parameters
txPowerDbmThe transmission power [dBm].

Definition at line 165 of file end-device-lora-phy.cc.

References m_listeners, m_state, NS_ASSERT, NS_LOG_FUNCTION_NOARGS, RX, and TX.

Referenced by ns3::lorawan::SimpleEndDeviceLoraPhy::Send().

+ Here is the caller graph for this function:

◆ TxFinished()

void ns3::lorawan::EndDeviceLoraPhy::TxFinished ( Ptr< const Packet packet)
overrideprotectedvirtual

Signals the end of a transmission by the EndDeviceLoraPhy.

Parameters
packetA pointer to the Packet transmitted.

Implements ns3::lorawan::LoraPhy.

Definition at line 121 of file end-device-lora-phy.cc.

References ns3::Callback< R, UArgs >::IsNull(), ns3::lorawan::LoraPhy::m_txFinishedCallback, NS_LOG_FUNCTION, and SwitchToStandby().

Referenced by ns3::lorawan::SimpleEndDeviceLoraPhy::Send().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ UnregisterListener()

void ns3::lorawan::EndDeviceLoraPhy::UnregisterListener ( EndDeviceLoraPhyListener listener)

Remove the input listener from the list of objects to be notified of PHY-level events.

Parameters
listenerThe listener to be unregistered.

Definition at line 211 of file end-device-lora-phy.cc.

References m_listeners.

Member Data Documentation

◆ m_frequency

double ns3::lorawan::EndDeviceLoraPhy::m_frequency
protected

The frequency this device is listening on.

Definition at line 277 of file end-device-lora-phy.h.

Referenced by IsOnFrequency(), SetFrequency(), and ns3::lorawan::SimpleEndDeviceLoraPhy::StartReceive().

◆ m_listeners

Listeners ns3::lorawan::EndDeviceLoraPhy::m_listeners
protected

◆ m_sf

uint8_t ns3::lorawan::EndDeviceLoraPhy::m_sf
protected

The Spreading Factor this device is listening for.

Definition at line 279 of file end-device-lora-phy.h.

Referenced by GetSpreadingFactor(), SetSpreadingFactor(), and ns3::lorawan::SimpleEndDeviceLoraPhy::StartReceive().

◆ m_state

TracedValue<State> ns3::lorawan::EndDeviceLoraPhy::m_state
protected

◆ m_wrongFrequency

TracedCallback<Ptr<const Packet>, uint32_t> ns3::lorawan::EndDeviceLoraPhy::m_wrongFrequency
protected

Trace source for when a packet is lost because it was transmitted on a frequency different from the one this EndDeviceLoraPhy was configured to listen on.

Definition at line 270 of file end-device-lora-phy.h.

Referenced by GetTypeId(), and ns3::lorawan::SimpleEndDeviceLoraPhy::StartReceive().

◆ m_wrongSf

TracedCallback<Ptr<const Packet>, uint32_t> ns3::lorawan::EndDeviceLoraPhy::m_wrongSf
protected

Trace source for when a packet is lost because it was using a spreading factor different from the one this EndDeviceLoraPhy was configured to listen for.

Definition at line 263 of file end-device-lora-phy.h.

Referenced by GetTypeId(), and ns3::lorawan::SimpleEndDeviceLoraPhy::StartReceive().

◆ sensitivity

const double ns3::lorawan::EndDeviceLoraPhy::sensitivity = {-124, -127, -130, -133, -135, -137}
static

The sensitivity vector of this device to different SFs.

Definition at line 237 of file end-device-lora-phy.h.

Referenced by ns3::lorawan::SimpleEndDeviceLoraPhy::StartReceive().


The documentation for this class was generated from the following files: