lora-adr-component.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2017 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
 *
 * Author: Matteo Perin <matteo.perin.2@studenti.unipd.2>
 *
 * Modified by: Bastien Tauran <bastien.tauran@viveris.fr>
 */
 
#ifndef LORA_ADR_COMPONENT_H
#define LORA_ADR_COMPONENT_H
 
#include "lora-network-controller-components.h"
#include "lora-network-status.h"
 
#include <ns3/object.h>
#include <ns3/packet.h>
 
namespace ns3
{
 
// LinkAdrRequest commands management //
 
class LoraAdrComponent : public LoraNetworkControllerComponent
{
    enum CombiningMethod
    {
        AVERAGE,
        MAXIMUM,
        MINIMUM,
    };
 
  public:
    static TypeId GetTypeId(void);
 
    // Constructor
    LoraAdrComponent();
    // Destructor
    virtual ~LoraAdrComponent();
 
    void OnReceivedPacket(Ptr<const Packet> packet,
                          Ptr<LoraEndDeviceStatus> status,
                          Ptr<LoraNetworkStatus> networkStatus);
 
    void BeforeSendingReply(Ptr<LoraEndDeviceStatus> status, Ptr<LoraNetworkStatus> networkStatus);
 
    void OnFailedReply(Ptr<LoraEndDeviceStatus> status, Ptr<LoraNetworkStatus> networkStatus);
 
  private:
    void AdrImplementation(uint8_t* newDataRate,
                           uint8_t* newTxPower,
                           Ptr<LoraEndDeviceStatus> status);
 
    uint8_t SfToDr(uint8_t sf);
 
    double RxPowerToSNR(double transmissionPower);
 
    double GetMinTxFromGateways(LoraEndDeviceStatus::GatewayList gwList);
 
    double GetMaxTxFromGateways(LoraEndDeviceStatus::GatewayList gwList);
 
    double GetAverageTxFromGateways(LoraEndDeviceStatus::GatewayList gwList);
 
    double GetReceivedPower(LoraEndDeviceStatus::GatewayList gwList);
 
    double GetMinSNR(LoraEndDeviceStatus::ReceivedPacketList packetList, int historyRange);
 
    double GetMaxSNR(LoraEndDeviceStatus::ReceivedPacketList packetList, int historyRange);
 
    double GetAverageSNR(LoraEndDeviceStatus::ReceivedPacketList packetList, int historyRange);
 
    int GetTxPowerIndex(int txPower);
 
    // TX power from gateways policy
    enum CombiningMethod tpAveraging;
 
    // Number of previous packets to consider
    int historyRange;
 
    // Received SNR history policy
    enum CombiningMethod historyAveraging;
 
    // SF lower limit
    const int min_spreadingFactor = 7;
 
    // Minimum transmission power (dBm) (Europe)
    const int min_transmissionPower = 2;
 
    // Maximum transmission power (dBm) (Europe)
    const int max_transmissionPower = 14;
 
    // Device specific SNR margin (dB)
    //  const int offset = 10;
 
    // Bandwidth (Hz)
    const int B = 125000;
 
    // Noise Figure (dB)
    const int NF = 6;
 
    // Vector containing the required SNR for the 6 allowed SF levels
    // ranging from 7 to 12 (the SNR values are in dB).
    double treshold[6] = {-20.0, -17.5, -15.0, -12.5, -10.0, -7.5};
 
    bool m_toggleTxPower;
};
} // namespace ns3
 
#endif