esp32-ogn-tracker/main/hal.h

240 wiersze
7.2 KiB
C++

#ifndef __HAL_H__
#define __HAL_H__
#include <stdint.h>
#include "freertos/FreeRTOS.h"
#include "freertos/semphr.h"
#include "freertos/task.h"
#include "freertos/queue.h"
#include "freertos/event_groups.h"
#include "fifo.h"
// ============================================================================================================
#define WITH_ESP32
// #define WITH_AUTOCR // we do the auto-CR after LF thus take care to disable CRLF in ESP-IDF
#define WITH_OGN1 // OGN protocol version 1/2
#define OGN_Packet OGN1_Packet
#define HARDWARE_ID 0x02
#define SOFTWARE_ID 0x01
#define USE_BLOCK_SPI // use block SPI interface for RF chip
#define I2C_SPEED 1000000 // [Hz] bit rate on the I2C (nominally up to 400000)
#include "config.h" // user options
#ifdef WITH_BT_SPP
#include "bt.h"
#endif
// ============================================================================================================
extern FIFO<uint8_t, 8> KeyBuffer;
// ============================================================================================================
extern uint8_t PowerMode; // 0=sleep/minimal power, 1=comprimize, 2=full power
// ============================================================================================================
#ifdef WITH_U8G2_OLED
#include "u8g2.h"
#endif
#ifdef WITH_ST7789
#include "st7789.h"
#endif
extern uint8_t BARO_I2C;
#ifdef WITH_MAVLINK
const uint8_t MAV_SysID = 1; // System-ID for MAVlink messages we send out
extern uint8_t MAV_Seq; // sequence number for MAVlink message sent out
#endif
// ============================================================================================================
extern SemaphoreHandle_t CONS_Mutex; // console port Mutex
extern SemaphoreHandle_t I2C_Mutex; // I2C port Mutex (OLED and Baro)
uint64_t getUniqueID(void); // get some unique ID of the CPU/chip
uint32_t getUniqueAddress(void); // get unique 24-bit address for the transmitted IF
#include "parameters.h"
extern FlashParameters Parameters;
#ifdef WITH_LORAWAN
#include "lorawan.h"
extern LoRaWANnode WANdev;
#endif
void CONS_UART_Init (void);
int CONS_UART_Read (uint8_t &Byte); // non-blocking
void CONS_UART_Write (char Byte); // blocking
int CONS_UART_Free (void); // how many bytes can be written to the transmit buffer
int CONS_UART_Full (void); // how many bytes already in the transmit buffer
void CONS_UART_SetBaudrate(int BaudRate);
int GPS_UART_Read (uint8_t &Byte); // non-blocking
void GPS_UART_Write (char Byte); // blocking
void GPS_UART_Flush (int MaxWait ); // wait for data to be pushed out
void GPS_UART_SetBaudrate(int BaudRate);
bool GPS_PPS_isOn(void);
#ifdef WITH_GPS_ENABLE
void GPS_ENABLE(void);
void GPS_DISABLE(void);
#endif
// #ifdef WITH_AERO
int AERO_UART_Read (uint8_t &Byte); // non-blocking
void AERO_UART_Write (char Byte); // blocking
void AERO_UART_SetBaudrate(int BaudRate);
// #endif
void RFM_TransferBlock(uint8_t *Data, uint8_t Len);
void RFM_RESET(uint8_t On); // RF module reset
bool RFM_IRQ_isOn(void); // query the IRQ state
void RFM_Delay(int ms); // [ms] idle delay
#ifdef WITH_SX1262
void RFM_Busy_SetInput(void);
bool RFM_Busy_isOn(void);
#endif
#ifdef WITH_OLED
int OLED_DisplayON(uint8_t ON, uint8_t DispIdx=0); // when OFF then low-power mode
int OLED_DisplayINV(uint8_t INV, uint8_t DispIdx=0);
int OLED_SetContrast(uint8_t Contrast, uint8_t DispIdx=0);
int OLED_PutLine(uint8_t Line, const char *Text, uint8_t DispIdx=0);
#endif
#ifdef WITH_U8G2_OLED
extern u8g2_t U8G2_OLED;
#endif
#ifdef WITH_SD
esp_err_t SD_Mount(void);
void SD_Unmount();
bool SD_isMounted();
int SD_getSectors(void);
int SD_getSectorSize(void);
#endif
#ifdef WITH_BEEPER
#ifdef WITH_KNOB
extern volatile uint8_t KNOB_Tick;
#else
const uint8_t KNOB_Tick=15; // for now, when there is no knob
#endif
const uint8_t Play_Vol_0 = 0x00;
const uint8_t Play_Vol_1 = 0x40;
const uint8_t Play_Vol_2 = 0x80;
const uint8_t Play_Vol_3 = 0xC0;
const uint8_t Play_Oct_0 = 0x00;
const uint8_t Play_Oct_1 = 0x10;
const uint8_t Play_Oct_2 = 0x20;
const uint8_t Play_Oct_3 = 0x30;
void Play(uint8_t Note, uint8_t Len); // put anote to play in the queue
uint8_t Play_Busy(void); // check is the queue is empty or still busy playing ?
void Play_TimerCheck(void); // every ms serve the note playing
void Beep(uint16_t Freq, uint8_t Duty, uint8_t DoubleAmpl);
void Beep_Note(uint8_t Note);
#endif // WITH_BEEPER
#ifdef WITH_SOUND
const uint32_t Sound_SampleRate = 16000;
void Sound_PlaySilence(uint16_t Len);
void Sound_PlayU8(const uint8_t *Data, uint16_t Len);
void Sound_PlayS8(const int8_t *Data, uint16_t Len, uint8_t Vol=8);
void Sound_Beep(int16_t Freq, uint16_t Len, int16_t Ampl);
#endif
#ifdef WITH_VARIO
extern uint8_t Vario_Note;
extern uint16_t Vario_Period;
extern uint16_t Vario_Fill;
#endif
void LED_PCB_On (void); // LED on the PCB for vizual indications
void LED_PCB_Off (void);
void LED_PCB_Flash(uint8_t Time=100); // Flash the PCB LED for a period of [ms]
#ifdef WITH_LED_TX
void LED_TX_On (void);
void LED_TX_Off (void);
void LED_TX_Flash (uint8_t Time=100);
#endif
#ifdef WITH_LED_RX
void LED_TX_On (void);
void LED_TX_Off (void);
void LED_RX_Flash(uint8_t Time=100);
#endif
void LED_TimerCheck(uint8_t Ticks=1);
bool Button_isPressed(void);
// extern bool Button_SleepRequest;
int32_t Button_TimerCheck(uint8_t Ticks=1);
void IO_Configuration(void); // Configure I/O
int NVS_Init(void); // initialize non-volatile-storage in the Flash
#ifdef WITH_SPIFFS
int SPIFFS_Register(const char *Path="/spiffs", const char *Label="intlog", size_t MaxOpenFiles=5);
int SPIFFS_Info(size_t &Total, size_t &Used, const char *Label="intlog");
#endif
uint8_t I2C_Read (uint8_t Bus, uint8_t Addr, uint8_t Reg, uint8_t *Data, uint8_t Len, uint8_t Wait=10);
uint8_t I2C_Write(uint8_t Bus, uint8_t Addr, uint8_t Reg, uint8_t *Data, uint8_t Len, uint8_t Wait=10);
inline uint8_t I2C_Write(uint8_t Bus, uint8_t Addr, uint8_t Reg, uint8_t Byte, uint8_t Wait=10)
{ return I2C_Write(Bus, Addr, Reg, &Byte, 1, Wait); }
template <class Type>
inline uint8_t I2C_Write(uint8_t Bus, uint8_t Addr, uint8_t Reg, Type &Object, uint8_t Wait=10)
{ return I2C_Write(Bus, Addr, Reg, (uint8_t *)&Object, sizeof(Type), Wait); }
template <class Type>
inline uint8_t I2C_Read (uint8_t Bus, uint8_t Addr, uint8_t Reg, Type &Object, uint8_t Wait=10)
{ return I2C_Read (Bus, Addr, Reg, (uint8_t *)&Object, sizeof(Type), Wait); }
uint8_t I2C_Restart(uint8_t Bus);
uint16_t BatterySense(int Samples=4); // [mV]
#ifdef WITH_TBEAM
uint16_t KnobSense (int Samples=4); // [ADC]
#endif
#ifdef WITH_BQ
#include "bq24295.h"
extern BQ24295 BQ;
#endif
#ifdef WITH_AXP
#include "axp192.h"
// extern SemaphoreHandle_t AXP_Mutex;
extern AXP192 AXP;
#endif
#ifdef WITH_SLEEP
void Sleep(void);
#endif
#ifdef __cplusplus
extern "C"
#endif
void vTaskTICK(void* pvParameters);
#endif // __HAL_H__