uwahoimodem.h

Go to the documentation of this file.

//
// Copyright (c) 2019 Regents of the SIGNET lab, University of Padova.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// 1. Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
// 2. Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
// 3. Neither the name of the University of Padova (SIGNET lab) nor the
//    names of its contributors may be used to endorse or promote products
//    derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
#ifndef UWAHOIMODEM_H
#define UWAHOIMODEM_H
 
#include <uwconnector.h>
#include <uwinterpreterahoi.h>
#include <uwmodem.h>
 
#include <atomic>
#include <condition_variable>
#include <memory>
#include <mutex>
#include <thread>
#include <vector>
 
class UwAhoiModem : public UwModem
{
public:
    enum class ModemState { AVAILABLE = 0, TRANSMITTING, CONFIGURING };
 
    enum class TransmissionState { TX_IDLE = 0, TX_WAITING };
 
    UwAhoiModem();
 
    virtual ~UwAhoiModem();
 
    virtual void recv(Packet *p);
 
    virtual int recvSyncClMsg(ClMessage *m);
 
    virtual int command(int argc, const char *const *argv);
 
private:
    virtual void startTx(Packet *p);
 
    virtual void startRx(Packet *p);
 
    virtual void endRx(Packet *p);
 
    virtual void start();
 
    virtual void stop();
 
    virtual void transmittingData();
 
    virtual void receivingData();
 
    void updateStatus(std::shared_ptr<ahoi::packet_t> packet);
 
    ahoi::packet_t fillAhoiPkt(Packet *p);
 
    void createRxPacket(Packet *p);
 
    bool parseFooter(std::shared_ptr<ahoi::footer_t> footer);
 
    bool storePacketInfo(std::shared_ptr<ahoi::packet_t> header, Packet *p);
 
    void updateSN();
 
    std::unique_ptr<UwConnector> p_connector;
 
    std::unique_ptr<UwInterpreterAhoi> p_interpreter;
 
    ModemState status; 
    TransmissionState tx_status; 
    std::mutex status_m;
    std::mutex tx_status_m;
    std::mutex tx_queue_m;
    std::condition_variable status_cv;
    std::condition_variable tx_status_cv;
    std::condition_variable tx_queue_cv;
    std::atomic<bool> receiving;
    std::atomic<bool> transmitting;
    std::thread rx_thread;
    std::thread tx_thread;
    std::string rx_payload;
    const static std::chrono::milliseconds MODEM_TIMEOUT;
 
    static uint MAX_RETX; 
    static uint8_t sn; 
    double virtual_time_ref; 
    static const double EPSILON_S;
 
    std::chrono::milliseconds WAIT_DELIVERY;
 
    static uint WAIT_DELIVERY_INT;
 
    ahoi::packet_t tmpPacket;
 
    uint id;
 
    int parity_bit;
    int stop_bit;
    int flow_control;
    int baud_rate;
 
    // Parameters values retrieved from each packet footer
    uint power;
    uint rssi;
    uint bit_errors;
    uint agc_mean;
    uint agc_min;
    uint agc_max;
};
 
#endif