spirit1.h

#ifndef __SPIRIT1_H
#define __SPIRIT1_H

#include <stdint.h>
#include <FreeRTOS.h>
#include <task.h>
#include <semphr.h>
#include <queue.h>

#ifdef __cplusplus
extern "C" {
#endif
/* ---- data structures ---- */
typedef struct                 // received packet structure
{
   uint8_t*  data_ptr;  // pointer to data (why not directly store data ?)
   uint8_t*  err_ptr;   // pointer to manchester error pattern
   float     rssi;      // [dBm] Received Signal Strength Indicator
   uint8_t   lqi;       // [S/N] Link Quality Indicator (signal-to-noise)
   uint8_t   pqi;       // [bits] Preamble Quality Indicator ?
   uint8_t   sqi;       // [bits] SYNCword quality Indicator
} rcv_packet_str;

/* -------- defines -------- */

/* Maximum allowable by SPIRIT1 Library TX power settings. */
/* Constants taken from SPIRIT_Radio.h: */
/* #define IS_PAPOWER_DBM(PATABLE)      ((PATABLE)>= (-31) && (PATABLE)<=(12)) */

#define SPIRIT1_LIB_MAX_POWER (+12.0F)
#define SPIRIT1_LIB_MIN_POWER (-31.0F)

/* --- Spirit task opcodes --- */
typedef enum
{
   SP1_COPY_OGN_PKT = 1,    // Copy packet data in OGN format
   SP1_CHG_CHANNEL,         // Change active channel
   SP1_START_CW,            // Start transmitting continuous wave
   SP1_STOP_CW,             // Stop transmitting continuous wave
   SP1_START_RX,            // Start receiving on current channel
   SP1_TX_PACKET,           // Transmitting buffered packet on current channel
   SP1_TX_PACKET_LBT,       // Transmitting buffered packet on current channel with Listen Before Talk 
                            // and random TX timing 
   SP1_INT_GPIO0_IRQ        // internal message 
}sp1_opcode_types;

typedef enum
{
   SP1_OUT_PKT_READY   = 1,  // Received packet in OGN format
}sp1_out_opcode_types;


/* --- SPIRIT1 related functions --- */
void Spirit1_Config(void);
void vTaskSP1(void* pvParameters);
xQueueHandle* Get_SP1Queue();
void Spirit1EnterShutdown(void);

#ifdef __cplusplus
}
#endif

#endif /* __SPIRIT1_H */