ttn.h

/*******************************************************************************
 *
 * 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 TTN_C_H
#define TTN_C_H
 
#include "driver/spi_master.h"
#include <stdint.h>
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#define TTN_NOT_CONNECTED 0xff
 
    typedef uint8_t ttn_port_t;
 
    typedef enum
    {
        TTN_ERROR_TRANSMISSION_FAILED = -1,
        TTN_ERROR_UNEXPECTED = -10,
        TTN_SUCCESSFUL_TRANSMISSION = 1,
        TTN_SUCCESSFUL_RECEIVE = 2
    } ttn_response_code_t;
 
    typedef enum
    {
        TTN_WINDOW_IDLE = 0,
        TTN_WINDOW_TX = 1,
        TTN_WINDOW_RX1 = 2,
        TTN_WINDOW_RX2 = 3
    } ttn_rx_tx_window_t;
 
    typedef enum
    {
        TTN_SF_NONE = 0,
        TTN_FSK = 1,
        TTN_SF7 = 2,
        TTN_SF8 = 3,
        TTN_SF9 = 4,
        TTN_SF10 = 5,
        TTN_SF11 = 6,
        TTN_SF12 = 7
    } ttn_spreading_factor_t;
 
    typedef enum
    {
        TTN_BW_NONE = 0,
        TTN_BW_125 = 1,
        TTN_BW_250 = 2,
        TTN_BW_500 = 3
    } ttn_bandwidth_t;
 
    typedef enum
    {
        TTN_DR_AS923_SF12 = 0,
        TTN_DR_AS923_SF11 = 1,
        TTN_DR_AS923_SF10 = 2,
        TTN_DR_AS923_SF9 = 3,
        TTN_DR_AS923_SF8 = 4,
        TTN_DR_AS923_SF7_BW125 = 5,
        TTN_DR_AS923_SF7_BW250 = 6,
        TTN_DR_AS923_FSK = 7,
 
        TTN_DR_AU915_SF12 = 0,
        TTN_DR_AU915_SF11 = 1,
        TTN_DR_AU915_SF10 = 2,
        TTN_DR_AU915_SF9 = 3,
        TTN_DR_AU915_SF8 = 4,
        TTN_DR_AU915_SF7 = 5,
        TTN_DR_AU915_SF8_BW500 = 6,
        TTN_DR_AU915_SF12_BW500 = 8,
        TTN_DR_AU915_SF11_BW500 = 9,
        TTN_DR_AU915_SF10_BW500 = 10,
        TTN_DR_AU915_SF9_BW500 = 11,
        TTN_DR_AU915_SF8_BW500_DR12 = 12,
        TTN_DR_AU915_SF7_BW500 = 13,
 
        TTN_DR_EU868_SF12 = 0,
        TTN_DR_EU868_SF11 = 1,
        TTN_DR_EU868_SF10 = 2,
        TTN_DR_EU868_SF9 = 3,
        TTN_DR_EU868_SF8 = 4,
        TTN_DR_EU868_SF7_BW125 = 5,
        TTN_DR_EU868_SF7_BW250 = 6,
        TTN_DR_EU868_FSK = 7,
 
        TTN_DR_IN866_SF12 = 0,
        TTN_DR_IN866_SF11 = 1,
        TTN_DR_IN866_SF10 = 2,
        TTN_DR_IN866_SF9 = 3,
        TTN_DR_IN866_SF8 = 4,
        TTN_DR_IN866_SF7 = 5,
        TTN_DR_IN866_FSK = 7,
 
        TTN_DR_KR920_SF12 = 0,
        TTN_DR_KR920_SF11 = 1,
        TTN_DR_KR920_SF10 = 2,
        TTN_DR_KR920_SF9 = 3,
        TTN_DR_KR920_SF8 = 4,
        TTN_DR_KR920_SF7 = 5,
 
        TTN_DR_US915_SF10 = 0,
        TTN_DR_US915_SF9 = 1,
        TTN_DR_US915_SF8 = 2,
        TTN_DR_US915_SF7 = 3,
        TTN_DR_US915_SF8_BW500 = 4,
        TTN_DR_US915_SF12_BW500 = 8,
        TTN_DR_US915_SF11_BW500 = 9,
        TTN_DR_US915_SF10_BW500 = 10,
        TTN_DR_US915_SF9_BW500 = 11,
        TTN_DR_US915_SF8_BW500_DR12 = 12,
        TTN_DR_US915_SF7_BW500 = 13,
 
        TTN_DR_JOIN_DEFAULT = 255
    } ttn_data_rate_t;
 
    typedef struct
    {
        ttn_spreading_factor_t spreading_factor;
        ttn_bandwidth_t bandwidth;
        uint32_t frequency;
    } ttn_rf_settings_t;
 
    typedef void (*ttn_message_cb)(const uint8_t *payload, size_t length, ttn_port_t port);
 
    void ttn_init(void);
 
    void ttn_configure_pins(spi_host_device_t spi_host, uint8_t nss, uint8_t rxtx, uint8_t rst, uint8_t dio0,
                            uint8_t dio1);
 
    void ttn_set_subband(int band);
 
    bool ttn_provision(const char *dev_eui, const char *app_eui, const char *app_key);
 
    bool ttn_provision_transiently(const char *dev_eui, const char *app_eui, const char *app_key);
 
    bool ttn_provision_with_mac(const char *app_eui, const char *app_key);
 
    void ttn_start_provisioning_task(void);
 
    void ttn_wait_for_provisioning(void);
 
    bool ttn_join(void);
 
    bool ttn_join_with_keys(const char *dev_eui, const char *app_eui, const char *app_key);
 
    bool ttn_resume_after_deep_sleep(void);
 
    bool ttn_resume_after_power_off(int off_duration);
 
    void ttn_prepare_for_deep_sleep(void);
 
    void ttn_prepare_for_power_off(void);
 
    void ttn_wait_for_idle(void);
 
    TickType_t ttn_busy_duration(void);
 
    void ttn_shutdown(void);
 
    ttn_response_code_t ttn_transmit_message(const uint8_t *payload, size_t length, ttn_port_t port, bool confirm);
 
    void ttn_on_message(ttn_message_cb callback);
 
    bool ttn_is_provisioned(void);
 
    void ttn_set_rssi_cal(int8_t rssi_cal);
 
    bool ttn_adr_enabled(void);
 
    void ttn_set_adr_enabled(bool enabled);
 
    void ttn_set_data_rate(ttn_data_rate_t data_rate);
 
    void ttn_set_max_tx_pow(int tx_pow);
 
    ttn_rx_tx_window_t ttn_rx_tx_window(void);
 
    ttn_rf_settings_t ttn_get_rf_settings(ttn_rx_tx_window_t window);
 
    ttn_rf_settings_t ttn_tx_settings(void);
 
    ttn_rf_settings_t ttn_rx1_settings(void);
 
    ttn_rf_settings_t ttn_rx2_settings(void);
 
    int ttn_rssi();
 
#ifdef __cplusplus
}
#endif
 
#endif