TinyLoRa.h

Go to the documentation of this file.

#ifndef TINY_LORA_H
#define TINY_LORA_H

#include <Arduino.h>
#if defined(ARDUINO_ARCH_AVR)
#include <avr/pgmspace.h>
#elif defined(ARDUINO_ARCH_ESP32)
#include <pgmspace.h>
#endif

// uncomment for debug output
// #define DEBUG

typedef enum rfm_channels {
  CH0,
  CH1,
  CH2,
  CH3,
  CH4,
  CH5,
  CH6,
  CH7,
  MULTI,
} rfm_channels_t;

typedef enum rfm_datarates {
  SF7BW125,
  SF7BW250,
  SF8BW125,
  SF9BW125,
  SF10BW125,
  SF11BW125,
  SF12BW125,
} rfm_datarates_t;

#if !defined(EU863) && !defined(AU915) && !defined(AS920)
#define US902 
#endif
//#define EU863 ///< Used in Europe
//#define AU915 ///< Used in Australia
//#define AS920 ///< Used in Asia

#define RFM9x_VER 0x12 

/* RFM Modes */
#define MODE_SLEEP 0x00 
#define MODE_LORA 0x80  
#define MODE_STDBY 0x01 
#define MODE_TX 0x83    

/* RFM Registers */
#define REG_PA_CONFIG 0x09    
#define REG_PA_DAC 0x4D       
#define REG_PREAMBLE_MSB 0x20 
#define REG_PREAMBLE_LSB 0x21 
#define REG_FRF_MSB 0x06      
#define REG_FRF_MID 0x07      
#define REG_FRF_LSB 0x08      
#define REG_FEI_LSB 0x1E      
#define REG_FEI_MSB 0x1D      
#define REG_MODEM_CONFIG 0x26 
#define REG_VER 0x42          

/**************************************************************************/
/**************************************************************************/
class TinyLoRa {
public:
  uint8_t txrandomNum;   
  uint16_t frameCounter; 
  void setChannel(rfm_channels_t channel);
  void setDatarate(rfm_datarates_t datarate);
  void setPower(int8_t Tx_Power = 17);
  TinyLoRa(int8_t rfm_dio0, int8_t rfm_nss, int8_t rfm_rst);
  bool begin(void);
  void sendData(unsigned char *Data, unsigned char Data_Length,
                unsigned int Frame_Counter_Tx, uint8_t Frame_Port = 1);

private:
  uint8_t randomNum;
  int8_t _cs, _irq, _rst;
  bool _isMultiChan;
  unsigned char _rfmMSB, _rfmMID, _rfmLSB, _sf, _bw, _modemcfg;
  static const unsigned char LoRa_Frequency[8][3];
  static const unsigned char S_Table[16][16];
  void RFM_Send_Package(unsigned char *RFM_Tx_Package,
                        unsigned char Package_Length);
  void RFM_Write(unsigned char RFM_Address, unsigned char RFM_Data);
  uint8_t RFM_Read(uint8_t RFM_Address);
  void Encrypt_Payload(unsigned char *Data, unsigned char Data_Length,
                       unsigned int Frame_Counter, unsigned char Direction);
  void Calculate_MIC(unsigned char *Data, unsigned char *Final_MIC,
                     unsigned char Data_Length, unsigned int Frame_Counter,
                     unsigned char Direction);
  void Generate_Keys(unsigned char *K1, unsigned char *K2);
  void Shift_Left(unsigned char *Data);
  void XOR(unsigned char *New_Data, unsigned char *Old_Data);
  void AES_Encrypt(unsigned char *Data, unsigned char *Key);
  void AES_Add_Round_Key(unsigned char *Round_Key, unsigned char (*State)[4]);
  unsigned char AES_Sub_Byte(unsigned char Byte);
  void AES_Shift_Rows(unsigned char (*State)[4]);
  void AES_Mix_Collums(unsigned char (*State)[4]);
  void AES_Calculate_Round_Key(unsigned char Round, unsigned char *Round_Key);
};

#endif