LoraSA/lib/comms/comms.h

#ifndef __COMMS_H
#define __COMMS_H

#include <HardwareSerial.h>
#include <LoRaBoards.h>

#include <LiLyGo.h>
#include <bus.h>
#include <config.h>

#ifndef SCAN_MAX_RESULT_KHZ_SCALE
// kHz scale: round frequency, so it fits into 2 bytes
// 2500000 / 40 = 62500, scale 40 fits 2.5GHz into two bytes
#define SCAN_MAX_RESULT_KHZ_SCALE 40
#endif

enum MessageType
{
    WRAP = 0,
    SCAN,
    SCAN_RESULT,
    SCAN_MAX_RESULT,
    SCAN_HEADING_MAX,
    CONFIG_TASK,
    HEADING,
    _MAX_MESSAGE_TYPE = HEADING
};

enum ConfigTaskType
{
    GET = 0,
    SET,
    GETSET_SUCCESS,
    SET_FAIL,
    _MAX_CONFIG_TASK_TYPE = SET_FAIL
};

struct Wrapper
{
    int32_t length;
    uint16_t crc;
};

struct ScanTask
{
    int64_t count;
    int64_t delay;
};

struct ScanTaskResult
{
    size_t sz;
    uint32_t *freqs_khz;
    int16_t *rssis;
    int16_t *rssis2;
    int16_t prssi;
    int16_t heading_min;
    int16_t heading_max;
};

struct ConfigTask
{
    String *key;
    String *value;
    ConfigTaskType task_type;
};

struct Heading
{
    int16_t heading;
};

struct Message
{
    MessageType type;
    union
    {
        Wrapper wrap;
        ConfigTask config;
        ScanTask scan;
        ScanTaskResult dump;
        Heading heading;
    } payload;

    ~Message();
};

struct Endpoint
{
    union
    {

        struct
        {
            uint8_t loop : 1, // self
                uart0 : 1, uart1 : 1,
                lora : 1, // rx or tx_lora, depending on is_host
                host : 1; // USB
        };
        uint8_t addr;
    };
};

struct RoutedMessage
{
    Endpoint from;
    Endpoint to;
    Message *message;
};

struct Comms
{
    String name;
    Stream &serial;
    Message **received;
    size_t received_sz;
    size_t received_pos;

    Message *wrap;

    Comms(String name, Stream &serial)
        : name(name), serial(serial), received(NULL), received_sz(0), received_pos(0),
          wrap(NULL) {};

    virtual size_t available();
    virtual bool send(Message &) = 0;
    virtual Message *receive();

    virtual void _onReceive() = 0;
    virtual bool _messageArrived(Message &);

    static bool initComms(Config &);
};

struct NoopComms : Comms
{
    NoopComms() : Comms("no-op", Uart0) {};

    virtual bool send(Message &) { return true; };
    virtual void _onReceive() {};
};

struct ReadlineComms : Comms
{
    String partialPacket;

    ReadlineComms(String name, Stream &serial)
        : Comms(name, serial), partialPacket("") {};

    virtual bool send(Message &) override;

    virtual void _onReceive() override;
};

extern Comms *HostComms;

extern Comms *Comms0;

extern Comms *Comms1;

struct LoRaStats
{
    uint64_t t0;
    int64_t rssi_60;
    int64_t snr_60;

    int16_t last_rssi;
    int16_t last_snr;

    int64_t messages_60;
    int64_t errors_60;

    LoRaStats()
        : t0(0), rssi_60(0), snr_60(0), last_rssi(0), last_snr(0), messages_60(0),
          errors_60(0)
    {
    }
};

struct RadioComms
{
    String name;
    RADIO_TYPE &radio;
    LoRaConfig &loraCfg;

    LoRaStats stats;

    RadioComms(String name, RADIO_TYPE &radio, LoRaConfig &cfg)
        : name(name), radio(radio), loraCfg(cfg), stats()
    {
    }

    Message **received;

    int16_t configureRadio();
    int16_t send(Message &);
    Message *receive(uint16_t timeout_ms);
};

uint16_t crc16(uint16_t poly, uint16_t c, size_t sz, uint8_t *v);

/*
 * Given halflife (i.e. time it takes the accumulator to decay to 50%), compute
 * the updated cumulate at new time. That is, acc_now = decay(acc_t, inc).
 */
int64_t updateExpDecay(uint16_t halflife, int64_t acc, uint64_t t, uint64_t now,
                       int64_t inc);

extern RadioComms *RxComms;
extern RadioComms *TxComms;

#endif