lora-end-device-status.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018 University of Padova
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Authors: Martina Capuzzo <capuzzom@dei.unipd.it>
 *          Davide Magrin <magrinda@dei.unipd.it>
 *
 * Modified by: Bastien Tauran <bastien.tauran@viveris.fr>
 */
 
#ifndef LORA_END_DEVICE_STATUS_H
#define LORA_END_DEVICE_STATUS_H
 
#include "lora-device-address.h"
#include "lora-frame-header.h"
#include "lorawan-mac-end-device-class-a.h"
#include "lorawan-mac-header.h"
 
#include "ns3/ipv4-header.h"
#include "ns3/net-device.h"
#include "ns3/object.h"
#include "ns3/pointer.h"
 
#include <iostream>
#include <list>
#include <map>
#include <ostream>
#include <stdint.h>
#include <utility>
 
namespace ns3
{

 
/*
 * Diagram of the end-device-status data structure. One instance of this class
 * for each ED, that will be identified by its address.
 *
 * Public Access:
 *
 *  (ED address) --- Current device parameters:
 *                   - First Receive Window SF and DRRe
 *                   - First Receive Window frequency
 *                   - Second Window SF and DR
 *                   - Second Receive Window frequency
 *               --- Reply
 *                   - Need for reply (true/false)
 *                   - Updated reply
 *               --- Received Packets
 *                   - Received packets list (see below).
 *
 *
 * Private Access:
 *
 *  (Received packets list) - List of gateways that received the packet (see below)
 *                          - SF of the received packet
 *                          - Frequency of the received packet
 *                          - Bandwidth of the received packet
 *
 *  (Gateway list) - Time at which the packet was received
 *                 - Reception power
 */
 
class LoraEndDeviceStatus : public Object
{
  public:
    /********************/
    /* Reply management */
    /********************/

    struct Reply
    {
        // The Mac Header to attach to the reply packet.
        LorawanMacHeader macHeader;
 
        // The Frame Header to attach to the reply packet.
        LoraFrameHeader frameHeader;
 
        // The data packet that will be sent as a reply.
        Ptr<Packet> payload;
 
        // Whether or not this device needs a reply
        bool needsReply = false;
    };

    bool NeedsReply(void);

    Ptr<Packet> GetCompleteReplyPacket(void);

    LorawanMacHeader GetReplyMacHeader(void);

    LoraFrameHeader GetReplyFrameHeader(void);

    Ptr<Packet> GetReplyPayload(void);
 
    /***********************************/
    /* Received packet list management */
    /***********************************/

    struct PacketInfoPerGw
    {
        Address gwAddress; 
        Time receivedTime; 
        double rxPower;    
    };
 
    // List of gateways, with relative information
    typedef std::map<Address, PacketInfoPerGw> GatewayList;

    struct ReceivedPacketInfo
    {
        // Members
        Ptr<const Packet> packet = 0; 
        GatewayList gwList;           
        uint8_t sf;
        double frequency;
    };
 
    typedef std::list<std::pair<Ptr<const Packet>, ReceivedPacketInfo>> ReceivedPacketList;
 
    /*******************************************/
    /* Proper LoraEndDeviceStatus class definition */
    /*******************************************/
 
    static TypeId GetTypeId(void);
 
    LoraEndDeviceStatus();
    LoraEndDeviceStatus(LoraDeviceAddress endDeviceAddress,
                        Ptr<LorawanMacEndDeviceClassA> endDeviceMac);
    virtual ~LoraEndDeviceStatus();

    uint8_t GetModcod(void);

    uint8_t GetBeamId(void);

    uint8_t GetFirstReceiveWindowSpreadingFactor(void);

    double GetFirstReceiveWindowFrequency(void);

    uint8_t GetSecondReceiveWindowOffset(void);

    double GetSecondReceiveWindowFrequency(void);

    ReceivedPacketList GetReceivedPacketList(void);

    void SetModcod(uint8_t modcod);

    void SetBeamId(uint8_t beamId);

    void SetFirstReceiveWindowSpreadingFactor(uint8_t sf);

    void SetFirstReceiveWindowFrequency(double frequency);

    void SetSecondReceiveWindowOffset(uint8_t offset);

    void SetSecondReceiveWindowFrequency(double frequency);

    void SetReplyMacHeader(LorawanMacHeader macHeader);

    void SetReplyFrameHeader(LoraFrameHeader frameHeader);

    void SetReplyPayload(Ptr<Packet> replyPayload);
 
    Ptr<LorawanMacEndDeviceClassA> GetMac(void);

    //  Other methods  //

    void InsertReceivedPacket(Ptr<const Packet> receivedPacket, const Address& gwAddress);

    Ptr<const Packet> GetLastPacketReceivedFromDevice(void);

    LoraEndDeviceStatus::ReceivedPacketInfo GetLastReceivedPacketInfo(void);

    void InitializeReply(void);

    void AddMACCommand(Ptr<LorawanMacCommand> macCommand);

    void UpdateGatewayData(GatewayList gwList, Address gwAddress, double rcvPower);

    bool HasReceiveWindowOpportunityScheduled();
 
    void SetReceiveWindowOpportunity(EventId event);
 
    void RemoveReceiveWindowOpportunity(void);

    std::map<double, Address> GetPowerGatewayMap(void);
 
    struct Reply m_reply; //<! Next reply intended for this device
 
    LoraDeviceAddress m_endDeviceAddress; //<! The address of this device
 
    friend std::ostream& operator<<(std::ostream& os, const LoraEndDeviceStatus& status);
 
  private:
    // Receive window data
    uint8_t m_modcod;
    uint8_t m_beamId;
    Address m_utAddress;
    uint8_t m_firstReceiveWindowSpreadingFactor = 0;
    double m_firstReceiveWindowFrequency = 0;
    uint8_t m_secondReceiveWindowOffset = 0;
    double m_secondReceiveWindowFrequency = 869.525;
    EventId m_receiveWindowEvent;
 
    ReceivedPacketList m_receivedPacketList; //<! List of received packets
 
    // NOTE Using this attribute is 'cheating', since we are assuming perfect
    // synchronization between the info at the device and at the network server
    Ptr<LorawanMacEndDeviceClassA> m_mac; 
};
} // namespace ns3
 
#endif /* LORA_END_DEVICE_STATUS_H */