twr_cmwx1zzabz.h

#ifndef _TWR_CMWX1ZZABZ_H
#define _TWR_CMWX1ZZABZ_H
 
#include <twr_scheduler.h>
#include <twr_gpio.h>
#include <twr_uart.h>
 
 
 
#define TWR_CMWX1ZZABZ_TX_MAX_PACKET_SIZE 230
 
#define TWR_CMWX1ZZABZ_TX_FIFO_BUFFER_SIZE (TWR_CMWX1ZZABZ_TX_MAX_PACKET_SIZE + 25)
#define TWR_CMWX1ZZABZ_RX_FIFO_BUFFER_SIZE 220
#define TWR_CMWX1ZZABZ_CUSTOM_COMMAND_BUFFER_SIZE 32
#define TWR_CMWX1ZZABZ_FW_VERSION_BUFFER_SIZE 64
 
 
 
 
typedef enum
{
    TWR_CMWX1ZZABZ_EVENT_READY = 0,
 
    TWR_CMWX1ZZABZ_EVENT_ERROR = 1,
 
    TWR_CMWX1ZZABZ_EVENT_SEND_MESSAGE_START = 2,
 
    TWR_CMWX1ZZABZ_EVENT_SEND_MESSAGE_DONE = 3,
 
    TWR_CMWX1ZZABZ_EVENT_CONFIG_SAVE_DONE = 4,
 
    TWR_CMWX1ZZABZ_EVENT_JOIN_SUCCESS = 5,
 
    TWR_CMWX1ZZABZ_EVENT_JOIN_ERROR = 6,
 
    TWR_CMWX1ZZABZ_EVENT_MESSAGE_RECEIVED = 7,
 
    TWR_CMWX1ZZABZ_EVENT_MESSAGE_RETRANSMISSION = 8,
 
    TWR_CMWX1ZZABZ_EVENT_MESSAGE_CONFIRMED = 9,
 
    TWR_CMWX1ZZABZ_EVENT_MESSAGE_NOT_CONFIRMED = 10,
 
    TWR_CMWX1ZZABZ_EVENT_RFQ = 11,
 
    TWR_CMWX1ZZABZ_EVENT_FRAME_COUNTER = 12,
 
    TWR_CMWX1ZZABZ_EVENT_LINK_CHECK_OK = 13,
 
    TWR_CMWX1ZZABZ_EVENT_LINK_CHECK_NOK = 14,
 
    TWR_CMWX1ZZABZ_EVENT_MODEM_FACTORY_RESET = 15,
 
    TWR_CMWX1ZZABZ_EVENT_CUSTOM_AT = 16
 
} twr_cmwx1zzabz_event_t;
 
 
typedef struct twr_cmwx1zzabz_t twr_cmwx1zzabz_t;
 
 
typedef enum
{
    TWR_CMWX1ZZABZ_CONFIG_MODE_ABP = 0,
    TWR_CMWX1ZZABZ_CONFIG_MODE_OTAA = 1
 
} twr_cmwx1zzabz_config_mode_t;
 
 
typedef enum
{
    TWR_CMWX1ZZABZ_CONFIG_BAND_AS923 = 0,
    TWR_CMWX1ZZABZ_CONFIG_BAND_AU915 = 1,
    TWR_CMWX1ZZABZ_CONFIG_BAND_EU868 = 5,
    TWR_CMWX1ZZABZ_CONFIG_BAND_KR920 = 6,
    TWR_CMWX1ZZABZ_CONFIG_BAND_IN865 = 7,
    TWR_CMWX1ZZABZ_CONFIG_BAND_US915 = 8
 
} twr_cmwx1zzabz_config_band_t;
 
 
typedef enum
{
    TWR_CMWX1ZZABZ_CONFIG_CLASS_A = 0,
    TWR_CMWX1ZZABZ_CONFIG_CLASS_C = 2
 
} twr_cmwx1zzabz_config_class_t;
 
 
typedef enum
{
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_AS923_SF12_125KHZ = 0,
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_AS923_SF11_125KHZ = 1,
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_AS923_SF10_125KHZ = 2,
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_AS923_SF9_125KHZ = 3,
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_AS923_SF8_125KHZ = 4,
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_AS923_SF7_125KHZ = 5,
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_AS923_SF7_250KHZ = 6,
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_AS923_FSK_50KBPS = 7,
 
} twr_cmwx1zzabz_config_datarate_as923_t;
 
 
typedef enum
{
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_AU915_SF12_125KHZ = 0,
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_AU915_SF11_125KHZ = 1,
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_AU915_SF10_125KHZ = 2,
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_AU915_SF9_125KHZ = 3,
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_AU915_SF8_125KHZ = 4,
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_AU915_SF7_125KHZ = 5,
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_AU915_SF8_500KHZ = 6,
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_AU915_SF12_500KHZ = 8,
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_AU915_SF11_500KHZ = 9,
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_AU915_SF10_500KHZ = 10,
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_AU915_SF9_500KHZ = 11,
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_AU915_SF8_500KHZ_2 = 12,
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_AU915_SF7_500KHZ = 13
 
} twr_cmwx1zzabz_config_datarate_au915_t;
 
 
 
typedef enum
{
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_EU868_SF12_125KHZ = 0,
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_EU868_SF11_125KHZ = 1,
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_EU868_SF10_125KHZ = 2,
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_EU868_SF9_125KHZ = 3,
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_EU868_SF8_125KHZ = 4,
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_EU868_SF7_125KHZ = 5,
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_EU868_SF7_250KHZ = 6,
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_EU868_FSK_50KBPS = 7
 
} twr_cmwx1zzabz_config_datarate_eu868_t;
 
 
typedef enum
{
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_KR920_SF12_125KHZ = 0,
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_KR920_SF11_125KHZ = 1,
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_KR920_SF10_125KHZ = 2,
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_KR920_SF9_125KHZ = 3,
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_KR920_SF8_125KHZ = 4,
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_KR920_SF7_125KHZ = 5
 
} twr_cmwx1zzabz_config_datarate_kr920_t;
 
 
typedef enum
{
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_US915_SF10_125KHZ = 0,
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_US915_SF9_125KHZ = 1,
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_US915_SF8_125KHZ = 2,
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_US915_SF7_125KHZ = 3,
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_US915_SF8_500KHZ = 4,
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_US915_SF12_500KHZ = 8,
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_US915_SF11_500KHZ = 9,
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_US915_SF10_500KHZ = 10,
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_US915_SF9_500KHZ = 11,
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_US915_SF8_500KHZ_2 = 12,
    TWR_CMWX1ZZABZ_CONFIG_DATARATE_US915_SF7_500KHZ = 13
 
} twr_cmwx1zzabz_config_datarate_us915_t;
 
 
typedef enum
{
    TWR_CMWX1ZZABZ_CONFIG_INDEX_DEVADDR = 0,
    TWR_CMWX1ZZABZ_CONFIG_INDEX_DEVEUI = 1,
    TWR_CMWX1ZZABZ_CONFIG_INDEX_APPEUI = 2,
    TWR_CMWX1ZZABZ_CONFIG_INDEX_NWKSKEY = 3,
    TWR_CMWX1ZZABZ_CONFIG_INDEX_APPSKEY = 4,
    TWR_CMWX1ZZABZ_CONFIG_INDEX_APPKEY = 5,
    TWR_CMWX1ZZABZ_CONFIG_INDEX_BAND = 6,
    TWR_CMWX1ZZABZ_CONFIG_INDEX_MODE = 7,
    TWR_CMWX1ZZABZ_CONFIG_INDEX_CLASS = 8,
    TWR_CMWX1ZZABZ_CONFIG_INDEX_RX2 = 9,
    TWR_CMWX1ZZABZ_CONFIG_INDEX_NWK = 10,
    TWR_CMWX1ZZABZ_CONFIG_INDEX_ADAPTIVE_DATARATE = 11,
    TWR_CMWX1ZZABZ_CONFIG_INDEX_DATARATE = 12,
    TWR_CMWX1ZZABZ_CONFIG_INDEX_REP = 13,
    TWR_CMWX1ZZABZ_CONFIG_INDEX_RTYNUM = 14,
    TWR_CMWX1ZZABZ_CONFIG_INDEX_LAST_ITEM
 
} twr_cmwx1zzabz_config_index_t;
 
typedef enum
{
    TWR_CMWX1ZZABZ_STATE_READY,
    TWR_CMWX1ZZABZ_STATE_ERROR,
    TWR_CMWX1ZZABZ_STATE_INITIALIZE,
    TWR_CMWX1ZZABZ_STATE_INITIALIZE_AT_RESPONSE,
    TWR_CMWX1ZZABZ_STATE_IDLE,
    TWR_CMWX1ZZABZ_STATE_INITIALIZE_COMMAND_SEND,
    TWR_CMWX1ZZABZ_STATE_INITIALIZE_COMMAND_RESPONSE,
 
    TWR_CMWX1ZZABZ_STATE_CONFIG_SAVE_SEND,
    TWR_CMWX1ZZABZ_STATE_CONFIG_SAVE_RESPONSE,
 
    TWR_CMWX1ZZABZ_STATE_SEND_MESSAGE_COMMAND,
    TWR_CMWX1ZZABZ_STATE_SEND_MESSAGE_CONFIRMED_COMMAND,
    TWR_CMWX1ZZABZ_STATE_SEND_MESSAGE_RESPONSE,
 
    TWR_CMWX1ZZABZ_STATE_JOIN_SEND,
    TWR_CMWX1ZZABZ_STATE_JOIN_RESPONSE,
 
    TWR_CMWX1ZZABZ_STATE_CUSTOM_COMMAND_SEND,
    TWR_CMWX1ZZABZ_STATE_CUSTOM_COMMAND_RESPONSE,
 
    TWR_CMWX1ZZABZ_STATE_LINK_CHECK_SEND,
    TWR_CMWX1ZZABZ_STATE_LINK_CHECK_RESPONSE,
    TWR_CMWX1ZZABZ_STATE_LINK_CHECK_RESPONSE_ANS,
 
    TWR_CMWX1ZZABZ_STATE_RECEIVE,
    TWR_CMWX1ZZABZ_STATE_RECOVER_BAUDRATE_UART,
    TWR_CMWX1ZZABZ_STATE_RECOVER_BAUDRATE_REBOOT
 
} twr_cmwx1zzabz_state_t;
 
typedef struct
{
    twr_cmwx1zzabz_config_band_t band;
    twr_cmwx1zzabz_config_mode_t mode;
    twr_cmwx1zzabz_config_class_t class;
    char devaddr[8 + 1];
    char deveui[16 + 1];
    char appeui[16 + 1];
    char nwkskey[32 + 1];
    char appskey[32 + 1];
    char appkey[32 + 1];
    uint32_t rx2_frequency;
    uint8_t rx2_datarate;
    uint8_t nwk_public;
    bool adaptive_datarate;
    uint8_t datarate;
    uint8_t repetition_unconfirmed;
    uint8_t repetition_confirmed;
 
} twr_cmwx1zzabz_config;
 
struct twr_cmwx1zzabz_t
{
    twr_scheduler_task_id_t _task_id;
    twr_uart_channel_t _uart_channel;
    twr_cmwx1zzabz_state_t _state;
    twr_cmwx1zzabz_state_t _state_after_sleep;
    twr_fifo_t _tx_fifo;
    twr_fifo_t _rx_fifo;
    uint8_t _tx_fifo_buffer[TWR_CMWX1ZZABZ_TX_FIFO_BUFFER_SIZE];
    uint8_t _rx_fifo_buffer[TWR_CMWX1ZZABZ_RX_FIFO_BUFFER_SIZE];
    void (*_event_handler)(twr_cmwx1zzabz_t *, twr_cmwx1zzabz_event_t, void *);
    void *_event_param;
    char _command[TWR_CMWX1ZZABZ_TX_FIFO_BUFFER_SIZE];
    char _response[TWR_CMWX1ZZABZ_RX_FIFO_BUFFER_SIZE];
    uint8_t _response_length;
    uint8_t _message_buffer[TWR_CMWX1ZZABZ_TX_MAX_PACKET_SIZE];
    size_t _message_length;
    uint8_t _message_port;
    uint8_t _init_command_index;
    uint8_t _save_command_index;
    bool _save_flag;
    uint32_t _save_config_mask;
    twr_cmwx1zzabz_config _config;
    bool _join_command;
    bool _link_check_command;
    bool _custom_command;
    char _custom_command_buf[TWR_CMWX1ZZABZ_CUSTOM_COMMAND_BUFFER_SIZE];
    uint8_t _tx_port;
    bool _debug;
 
    char _fw_version[TWR_CMWX1ZZABZ_FW_VERSION_BUFFER_SIZE];
 
    int32_t _cmd_rfq_rssi;
    int32_t _cmd_rfq_snr;
 
    uint32_t _cmd_frmcnt_uplink;
    uint32_t _cmd_frmcnt_downlink;
 
    uint8_t _cmd_link_check_margin;
    uint8_t _cmd_link_check_gwcnt;
 
    twr_tick_t _timeout;
};
 
 
 
void twr_cmwx1zzabz_init(twr_cmwx1zzabz_t *self, twr_uart_channel_t uart_channel);
 
 
void twr_cmwx1zzabz_deinit(twr_cmwx1zzabz_t *self);
 
 
void twr_cmwx1zzabz_reboot(twr_cmwx1zzabz_t *self);
 
 
void twr_cmwx1zzabz_set_event_handler(twr_cmwx1zzabz_t *self, void (*event_handler)(twr_cmwx1zzabz_t *, twr_cmwx1zzabz_event_t, void *), void *event_param);
 
 
bool twr_cmwx1zzabz_is_ready(twr_cmwx1zzabz_t *self);
 
 
bool twr_cmwx1zzabz_send_message(twr_cmwx1zzabz_t *self, const void *buffer, size_t length);
 
 
bool twr_cmwx1zzabz_send_message_confirmed(twr_cmwx1zzabz_t *self, const void *buffer, size_t length);
 
 
void twr_cmwx1zzabz_set_devaddr(twr_cmwx1zzabz_t *self, char *devaddr);
 
 
void twr_cmwx1zzabz_get_devaddr(twr_cmwx1zzabz_t *self, char *devaddr);
 
 
void twr_cmwx1zzabz_set_deveui(twr_cmwx1zzabz_t *self, char *deveui);
 
 
void twr_cmwx1zzabz_get_deveui(twr_cmwx1zzabz_t *self, char *deveui);
 
 
void twr_cmwx1zzabz_set_appeui(twr_cmwx1zzabz_t *self, char *appeui);
 
 
void twr_cmwx1zzabz_get_appeui(twr_cmwx1zzabz_t *self, char *appeui);
 
 
void twr_cmwx1zzabz_set_nwkskey(twr_cmwx1zzabz_t *self, char *nwkskey);
 
 
void twr_cmwx1zzabz_get_nwkskey(twr_cmwx1zzabz_t *self, char *nwkskey);
 
 
void twr_cmwx1zzabz_set_appskey(twr_cmwx1zzabz_t *self, char *appskey);
 
 
void twr_cmwx1zzabz_get_appskey(twr_cmwx1zzabz_t *self, char *appskey);
 
 
void twr_cmwx1zzabz_set_appkey(twr_cmwx1zzabz_t *self, char *appkey);
 
 
void twr_cmwx1zzabz_get_appkey(twr_cmwx1zzabz_t *self, char *appkey);
 
 
void twr_cmwx1zzabz_set_band(twr_cmwx1zzabz_t *self, twr_cmwx1zzabz_config_band_t band);
 
 
twr_cmwx1zzabz_config_band_t twr_cmwx1zzabz_get_band(twr_cmwx1zzabz_t *self);
 
 
void twr_cmwx1zzabz_set_mode(twr_cmwx1zzabz_t *self, twr_cmwx1zzabz_config_mode_t mode);
 
 
twr_cmwx1zzabz_config_mode_t twr_cmwx1zzabz_get_mode(twr_cmwx1zzabz_t *self);
 
 
void twr_cmwx1zzabz_set_class(twr_cmwx1zzabz_t *self, twr_cmwx1zzabz_config_class_t class);
 
 
twr_cmwx1zzabz_config_class_t twr_cmwx1zzabz_get_class(twr_cmwx1zzabz_t *self);
 
 
void twr_cmwx1zzabz_join(twr_cmwx1zzabz_t *self);
 
 
uint8_t twr_cmwx1zzabz_get_received_message_port(twr_cmwx1zzabz_t *self);
 
 
uint32_t twr_cmwx1zzabz_get_received_message_length(twr_cmwx1zzabz_t *self);
 
 
uint32_t twr_cmwx1zzabz_get_received_message_data(twr_cmwx1zzabz_t *self, uint8_t *buffer, uint32_t buffer_size);
 
 
void twr_cmwx1zzabz_set_port(twr_cmwx1zzabz_t *self, uint8_t port);
 
 
uint8_t twr_cmwx1zzabz_get_port(twr_cmwx1zzabz_t *self);
 
 
void twr_cmwx1zzabz_set_rx2(twr_cmwx1zzabz_t *self, uint32_t frequency, uint8_t datarate);
 
 
void twr_cmwx1zzabz_get_rx2(twr_cmwx1zzabz_t *self, uint32_t *frequency, uint8_t *datarate);
 
 
void twr_cmwx1zzabz_set_nwk_public(twr_cmwx1zzabz_t *self, uint8_t public);
 
 
uint8_t twr_cmwx1zzabz_get_nwk_public(twr_cmwx1zzabz_t *self);
 
 
void twr_cmwx1zzabz_set_adaptive_datarate(twr_cmwx1zzabz_t *self, bool enable);
 
 
bool twr_cmwx1zzabz_get_adaptive_datarate(twr_cmwx1zzabz_t *self);
 
 
void twr_cmwx1zzabz_set_datarate(twr_cmwx1zzabz_t *self, uint8_t datarate);
 
 
uint8_t twr_cmwx1zzabz_get_datarate(twr_cmwx1zzabz_t *self);
 
 
void twr_cmwx1zzabz_set_debug(twr_cmwx1zzabz_t *self, bool debug);
 
 
char *twr_cmwx1zzabz_get_error_command(twr_cmwx1zzabz_t *self);
 
 
char *twr_cmwx1zzabz_get_error_response(twr_cmwx1zzabz_t *self);
 
 
bool twr_cmwx1zzabz_custom_at(twr_cmwx1zzabz_t *self, char *at_command);
 
 
bool twr_cmwx1zzabz_rfq(twr_cmwx1zzabz_t *self);
 
 
bool twr_cmwx1zzabz_get_rfq(twr_cmwx1zzabz_t *self, int32_t *rssi, int32_t *snr);
 
 
bool twr_cmwx1zzabz_frame_counter(twr_cmwx1zzabz_t *self);
 
 
bool twr_cmwx1zzabz_get_frame_counter(twr_cmwx1zzabz_t *self, uint32_t *uplink, uint32_t *downlink);
 
 
bool twr_cmwx1zzabz_link_check(twr_cmwx1zzabz_t *self);
 
 
bool twr_cmwx1zzabz_get_link_check(twr_cmwx1zzabz_t *self, uint8_t *margin, uint8_t *gateway_count);
 
 
bool twr_cmwx1zzabz_factory_reset(twr_cmwx1zzabz_t *self);
 
 
char *twr_cmwx1zzabz_get_fw_version(twr_cmwx1zzabz_t *self);
 
 
void twr_cmwx1zzabz_set_repeat_unconfirmed(twr_cmwx1zzabz_t *self, uint8_t repeat);
 
 
uint8_t twr_cmwx1zzabz_get_repeat_unconfirmed(twr_cmwx1zzabz_t *self);
 
 
void twr_cmwx1zzabz_set_repeat_confirmed(twr_cmwx1zzabz_t *self, uint8_t repeat);
 
 
uint8_t twr_cmwx1zzabz_get_repeat_confirmed(twr_cmwx1zzabz_t *self);
 
 
#endif // _TWR_CMWX1ZZABZ_H