TheThingsNetwork.h

Go to the documentation of this file.

/*******************************************************************************
 *
 * ttn-esp32 - The Things Network device library for ESP-IDF / SX127x
 *
 * Copyright (c) 2018-2021 Manuel Bleichenbacher
 *
 * Licensed under MIT License
 * https://opensource.org/licenses/MIT
 *
 * High-level C++ API for ttn-esp32.
 *******************************************************************************/
 
#ifndef _THETHINGSNETWORK_H_
#define _THETHINGSNETWORK_H_
 
#include "ttn.h"
 
typedef ttn_port_t port_t;
 
enum TTNResponseCode
{
    kTTNErrorTransmissionFailed = TTN_ERROR_TRANSMISSION_FAILED,
    kTTNErrorUnexpected = TTN_ERROR_UNEXPECTED,
    kTTNSuccessfulTransmission = TTN_SUCCESSFUL_TRANSMISSION,
    kTTNSuccessfulReceive = TTN_SUCCESSFUL_RECEIVE
};
 
enum TTNRxTxWindow
{
    kTTNIdleWindow = TTN_WINDOW_IDLE,
    kTTNTxWindow = TTN_WINDOW_TX,
    kTTNRx1Window = TTN_WINDOW_RX1,
    kTTNRx2Window = TTN_WINDOW_RX2
};
 
enum TTNSpreadingFactor
{
    kTTNSFNone = TTN_SF_NONE,
    kTTNFSK = TTN_FSK,
    kTTNSF7 = TTN_SF7,
    kTTNSF8 = TTN_SF8,
    kTTNSF9 = TTN_SF9,
    kTTNSF10 = TTN_SF10,
    kTTNSF11 = TTN_SF11,
    kTTNSF12 = TTN_SF12
};
 
enum TTNBandwidth
{
    kTTNBWNone = TTN_BW_NONE,
    kTTNBW125 = TTN_BW_125,
    kTTNBW250 = TTN_BW_250,
    kTTNBW500 = TTN_BW_500
};
 
enum TTNDataRate
{
    kTTNDataRate_AS923_SF12 = 0,
    kTTNDataRate_AS923_SF11 = 1,
    kTTNDataRate_AS923_SF10 = 2,
    kTTNDataRate_AS923_SF9 = 3,
    kTTNDataRate_AS923_SF8 = 4,
    kTTNDataRate_AS923_SF7_BW125 = 5,
    kTTNDataRate_AS923_SF7_BW250 = 6,
    kTTNDataRate_AS923_FSK = 7,
 
    kTTNDataRate_AU915_SF12 = 0,
    kTTNDataRate_AU915_SF11 = 1,
    kTTNDataRate_AU915_SF10 = 2,
    kTTNDataRate_AU915_SF9 = 3,
    kTTNDataRate_AU915_SF8 = 4,
    kTTNDataRate_AU915_SF7 = 5,
    kTTNDataRate_AU915_SF8_BW500 = 6,
    kTTNDataRate_AU915_SF12_BW500 = 8,
    kTTNDataRate_AU915_SF11_BW500 = 9,
    kTTNDataRate_AU915_SF10_BW500 = 10,
    kTTNDataRate_AU915_SF9_BW500 = 11,
    kTTNDataRate_AU915_SF8_BW500_DR12 = 12,
    kTTNDataRate_AU915_SF7_BW500 = 13,
 
    kTTNDataRate_EU868_SF12 = 0,
    kTTNDataRate_EU868_SF11 = 1,
    kTTNDataRate_EU868_SF10 = 2,
    kTTNDataRate_EU868_SF9 = 3,
    kTTNDataRate_EU868_SF8 = 4,
    kTTNDataRate_EU868_SF7_BW125 = 5,
    kTTNDataRate_EU868_SF7_BW250 = 6,
    kTTNDataRate_EU868_FSK = 7,
 
    kTTNDataRate_IN866_SF12 = 0,
    kTTNDataRate_IN866_SF11 = 1,
    kTTNDataRate_IN866_SF10 = 2,
    kTTNDataRate_IN866_SF9 = 3,
    kTTNDataRate_IN866_SF8 = 4,
    kTTNDataRate_IN866_SF7 = 5,
    kTTNDataRate_IN866_FSK = 7,
 
    kTTNDataRate_KR920_SF12 = 0,
    kTTNDataRate_KR920_SF11 = 1,
    kTTNDataRate_KR920_SF10 = 2,
    kTTNDataRate_KR920_SF9 = 3,
    kTTNDataRate_KR920_SF8 = 4,
    kTTNDataRate_KR920_SF7 = 5,
 
    kTTNDataRate_US915_SF10 = 0,
    kTTNDataRate_US915_SF9 = 1,
    kTTNDataRate_US915_SF8 = 2,
    kTTNDataRate_US915_SF7 = 3,
    kTTNDataRate_US915_SF8_BW500 = 4,
    kTTNDataRate_US915_SF12_BW500 = 8,
    kTTNDataRate_US915_SF11_BW500 = 9,
    kTTNDataRate_US915_SF10_BW500 = 10,
    kTTNDataRate_US915_SF9_BW500 = 11,
    kTTNDataRate_US915_SF8_BW500_DR12 = 12,
    kTTNDataRate_US915_SF7_BW500 = 13,
 
    kTTNDRJoinDdefault
};
 
struct TTNRFSettings
{
    TTNSpreadingFactor spreadingFactor;
    TTNBandwidth bandwidth;
    uint32_t frequency;
};
 
typedef void (*TTNMessageCallback)(const uint8_t *payload, size_t length, ttn_port_t port);
 
class TheThingsNetwork
{
  public:
    TheThingsNetwork()
    {
        ttn_init();
    }
 
    ~TheThingsNetwork()
    {
    }
 
    void configurePins(spi_host_device_t spi_host, uint8_t nss, uint8_t rxtx, uint8_t rst, uint8_t dio0, uint8_t dio1)
    {
        ttn_configure_pins(spi_host, nss, rxtx, rst, dio0, dio1);
    }
 
    void setSubband(int band)
    {
        ttn_set_subband(band);
    }
 
    bool provision(const char *devEui, const char *appEui, const char *appKey)
    {
        return ttn_provision(devEui, appEui, appKey);
    }
 
    bool provisionTransiently(const char *devEui, const char *appEui, const char *appKey)
    {
        return ttn_provision_transiently(devEui, appEui, appKey);
    }
 
    bool provisionWithMAC(const char *appEui, const char *appKey)
    {
        return ttn_provision_with_mac(appEui, appKey);
    }
 
    void startProvisioningTask()
    {
        ttn_start_provisioning_task();
    }
 
    void waitForProvisioning()
    {
        ttn_wait_for_provisioning();
    }
 
    bool join()
    {
        return ttn_join();
    }
 
    bool join(const char *devEui, const char *appEui, const char *appKey)
    {
        return ttn_join_with_keys(devEui, appEui, appKey);
    }
 
    bool resumeAfterDeepSleep()
    {
        return ttn_resume_after_deep_sleep();
    }
 
    bool resumeAfterPowerOff(int off_duration)
    {
        return ttn_resume_after_power_off(off_duration);
    }
 
    void prepareForDeepSleep()
    {
        ttn_prepare_for_deep_sleep();
    }
 
    void prepareForPowerOff()
    {
        ttn_prepare_for_power_off();
    }
 
    void waitForIdle()
    {
        ttn_wait_for_idle();
    }
 
    TickType_t busyDuration()
    {
        return ttn_busy_duration();
    }
 
    void shutdown()
    {
        ttn_shutdown();
    }
 
    TTNResponseCode transmitMessage(const uint8_t *payload, size_t length, ttn_port_t port = 1, bool confirm = false)
    {
        return static_cast<TTNResponseCode>(ttn_transmit_message(payload, length, port, confirm));
    }
 
    void onMessage(TTNMessageCallback callback)
    {
        ttn_on_message(callback);
    }
 
    bool isProvisioned()
    {
        return ttn_is_provisioned();
    }
 
    void setRSSICal(int8_t rssiCal)
    {
        ttn_set_rssi_cal(rssiCal);
    }
 
    bool adrEnabled()
    {
        return ttn_adr_enabled();
    }
 
    void setAdrEnabled(bool enabled)
    {
        ttn_set_adr_enabled(enabled);
    }
 
    void setDataRate(TTNDataRate data_rate)
    {
        ttn_set_data_rate(static_cast<ttn_data_rate_t>(data_rate));
    }
 
    void setMaxTxPower(int tx_pow)
    {
        ttn_set_max_tx_pow(tx_pow);
    }
 
    TTNRxTxWindow rxTxWindow()
    {
        return static_cast<TTNRxTxWindow>(ttn_rx_tx_window());
    }
 
    TTNRFSettings getRFSettings(TTNRxTxWindow window);
 
    TTNRFSettings txSettings()
    {
        return getRFSettings(kTTNTxWindow);
    }
 
    TTNRFSettings rx1Settings()
    {
        return getRFSettings(kTTNRx1Window);
    }
 
    TTNRFSettings rx2Settings()
    {
        return getRFSettings(kTTNRx2Window);
    }
 
    int rssi()
    {
        return ttn_rssi();
    }
};
 
#endif