sx1276.h

Go to the documentation of this file.

#ifndef SX1276_H
#define SX1276_H
 
#include "driver/spi_master.h"
#include "esp_err.h"
 
#include <stdbool.h>
#include <stdint.h>
 
// ============================================================================
// SX1276 Register Definitions
// ============================================================================
#define SX1276_REG_FIFO                 0x00
#define SX1276_REG_OP_MODE              0x01
#define SX1276_REG_FRF_MSB              0x06
#define SX1276_REG_FRF_MID              0x07
#define SX1276_REG_FRF_LSB              0x08
#define SX1276_REG_PA_CONFIG            0x09
#define SX1276_REG_PA_RAMP              0x0A
#define SX1276_REG_OCP                  0x0B
#define SX1276_REG_LNA                  0x0C
#define SX1276_REG_FIFO_ADDR_PTR        0x0D
#define SX1276_REG_FIFO_TX_BASE_ADDR    0x0E
#define SX1276_REG_FIFO_RX_BASE_ADDR    0x0F
#define SX1276_REG_FIFO_RX_CURRENT_ADDR 0x10
#define SX1276_REG_IRQ_FLAGS_MASK       0x11
#define SX1276_REG_IRQ_FLAGS            0x12
#define SX1276_REG_RX_NB_BYTES          0x13
#define SX1276_REG_PKT_SNR_VALUE        0x19
#define SX1276_REG_PKT_RSSI_VALUE       0x1A
#define SX1276_REG_MODEM_CONFIG_1       0x1D
#define SX1276_REG_MODEM_CONFIG_2       0x1E
#define SX1276_REG_SYMB_TIMEOUT_LSB     0x1F
#define SX1276_REG_PREAMBLE_MSB         0x20
#define SX1276_REG_PREAMBLE_LSB         0x21
#define SX1276_REG_PAYLOAD_LENGTH       0x22
#define SX1276_REG_MAX_PAYLOAD_LENGTH   0x23
#define SX1276_REG_HOP_PERIOD           0x24
#define SX1276_REG_FIFO_RX_BYTE_ADDR    0x25
#define SX1276_REG_MODEM_CONFIG_3       0x26
#define SX1276_REG_DETECTION_OPTIMIZE   0x31
#define SX1276_REG_DETECTION_THRESHOLD  0x37
#define SX1276_REG_SYNC_WORD            0x39
#define SX1276_REG_DIO_MAPPING_1        0x40
#define SX1276_REG_DIO_MAPPING_2        0x41
#define SX1276_REG_VERSION              0x42
#define SX1276_REG_PA_DAC               0x4D
 
// ============================================================================
// SX1276 Operating Modes
// ============================================================================
#define SX1276_MODE_SLEEP         0x00
#define SX1276_MODE_STDBY         0x01
#define SX1276_MODE_FSTX          0x02
#define SX1276_MODE_TX            0x03
#define SX1276_MODE_FSRX          0x04
#define SX1276_MODE_RX_CONTINUOUS 0x05
#define SX1276_MODE_RX_SINGLE     0x06
#define SX1276_MODE_CAD           0x07
 
#define SX1276_MODE_LORA 0x80
 
// ============================================================================
// SX1276 IRQ Flags
// ============================================================================
#define SX1276_IRQ_CAD_DETECTED        0x01
#define SX1276_IRQ_FHSS_CHANGE_CHANNEL 0x02
#define SX1276_IRQ_CAD_DONE            0x04
#define SX1276_IRQ_TX_DONE             0x08
#define SX1276_IRQ_VALID_HEADER        0x10
#define SX1276_IRQ_PAYLOAD_CRC_ERROR   0x20
#define SX1276_IRQ_RX_DONE             0x40
#define SX1276_IRQ_RX_TIMEOUT          0x80
 
// ============================================================================
// SX1276 Configuration Structures
// ============================================================================
typedef struct
{
    int pin_miso;
    int pin_mosi;
    int pin_sck;
    int pin_cs;
    int pin_rst;
    int pin_dio0;
    int pin_dio1;
    int pin_dio2;
    spi_host_device_t spi_host;
} sx1276_config_t;
 
typedef struct
{
    uint32_t frequency;
    uint8_t spreading_factor; // 6-12
    uint8_t bandwidth;        // 0=125kHz, 1=250kHz, 2=500kHz
    uint8_t coding_rate;      // 1=4/5, 2=4/6, 3=4/7, 4=4/8
    uint8_t tx_power;         // dBm
    bool crc_on;
    bool implicit_header;
    uint8_t sync_word; // 0x34 for LoRaWAN public, 0x12 for private
} sx1276_lora_config_t;
 
// ============================================================================
// SX1276 API
// ============================================================================
 
esp_err_t sx1276_init(const sx1276_config_t* config);
 
esp_err_t sx1276_configure_lora(const sx1276_lora_config_t* config);
 
esp_err_t sx1276_set_mode(uint8_t mode);
 
esp_err_t sx1276_transmit(const uint8_t* data, uint8_t len);
 
esp_err_t sx1276_start_receive(void);
 
esp_err_t sx1276_read_received(uint8_t* data, uint8_t* len, uint8_t max_len);
 
bool sx1276_is_tx_done(void);
 
bool sx1276_is_rx_done(void);
 
void sx1276_clear_irq(void);
 
uint8_t sx1276_get_irq_flags(void);
 
uint8_t sx1276_read_reg(uint8_t reg);
 
void sx1276_write_reg(uint8_t reg, uint8_t value);
 
void sx1276_reset(void);
 
#endif // SX1276_H