uwevologicss2cmodem.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 UWEVOLOGICSS2CSMODEM_H
#define UWEVOLOGICSS2CSMODEM_H
 
#include <uwconnector.h>
#include <uwinterpreters2c.h>
#include <uwmodem.h>
 
#include <atomic>
#include <condition_variable>
#include <memory>
#include <mutex>
#include <thread>
#include <vector>
#include <map>
 
typedef std::map<int, double> TransmissionDurationLUT;
 
enum class ModemState { AVAILABLE, BUSY, RESET, QUIT, DEAF, NOISE, LISTEN };
 
class UwEvoLogicsS2CModem : public UwModem
{
    enum class Config {
        ATL_GET,
        ATL_SET,
        ATAL_GET,
        ATAL_SET,
        MODEM_STATUS,
        CURR_SETTINGS,
        UNKNOWN
    };
 
public:
    enum class TransmissionMode { BURST = 0, IM = 1 };
 
    enum class TransmissionState { TX_IDLE = 0, TX_PENDING };
 
    UwEvoLogicsS2CModem();
 
    virtual ~UwEvoLogicsS2CModem();
 
    virtual void recv(Packet *p);
 
    virtual int command(int argc, const char *const *argv);
 
    virtual int recvSyncClMsg(ClMessage *m);
 
    virtual double getTxDuration(Packet *p);
 
    virtual bool configure(Config cmd);
 
    virtual void initializeLUT();
 
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(UwInterpreterS2C::Response cmd);
 
    void setFailedTx(Packet *p);
 
    void createRxPacket(Packet *p);
 
    std::unique_ptr<UwConnector> p_connector;
    std::unique_ptr<UwInterpreterS2C> 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::atomic<bool> im_status_updated;
    std::thread rx_thread;
    std::thread tx_thread;
    std::string rx_payload;
    const static std::chrono::milliseconds MODEM_TIMEOUT;
    const static std::chrono::milliseconds WAIT_DELIVERY_IM;
    const static std::chrono::seconds WAIT_DELIVERY_BURST;
 
    TransmissionMode tx_mode; 
    bool ack_mode; 
    double virtual_time_ref; 
    int curr_source_level; 
    int n_rx_failed; 
    int pend_source_level; 
    bool source_level_change; 
    TransmissionDurationLUT size2dur_; 
    std::string txdur_file_name_; 
    char txdur_token_separator_; 
    bool initLUT_; 
    static const double EPSILON_S;
    static uint MAX_N_STATUS_QUERIES;
};
 
#endif