spirit.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/
 
#ifndef SPIRIT_H
#define SPIRIT_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define SPIRIT_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.tx_pin  = MIKROBUS( mikrobus, MIKROBUS_TX ); \
  cfg.rx_pin  = MIKROBUS( mikrobus, MIKROBUS_RX ); \
  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
  cfg.cmd = MIKROBUS( mikrobus, MIKROBUS_CS ); \
  cfg.shd = MIKROBUS( mikrobus, MIKROBUS_PWM )
#define SPIRIT_MODULE_POWER_ON   1
#define SPIRIT_MODULE_POWER_OFF  0
#define DRV_RX_BUFFER_SIZE 500
#define DRV_TX_BUFFER_SIZE 200
#define SPIRIT_OPERATING_MODE     0x01
#define SPIRIT_COMMAND_MODE       0x00
 
#define SPIRIT_MODULE_WAKE_UP     0x01
#define SPIRIT_MODULE_SHUTDOWN    0x00
#define SPIRIT_CMD_ENTER_COMMAND_MODE    "+++"
#define SPIRIT_CMD_ENTER_OPERATING_MODE  "ATO"
#define SPIRIT_CMD_READ_MODULE_VERSION   "AT/V"
#define SPIRIT_CMD_READ_ALL_CONFIG_REG   "AT/S"
#define SPIRIT_CMD_STORE_CURRENT_CONFIG  "AT/C"
#define SPIRIT_CMD_RESET_CONFIG          "ATR"
#define SPIRIT_CMD_RESET_MODULE          "ATZ"
#define SPIRIT_CMD_READ_INFO_PER             "ATI0"
#define SPIRIT_CMD_READ_INFO_PSSI            "ATI1"
#define SPIRIT_CMD_READ_INFO_LQI             "ATI2"
#define SPIRIT_CMD_READ_INFO_PQI             "ATI3"
#define SPIRIT_CMD_READ_INFO_SQI             "ATI4"
#define SPIRIT_CMD_READ_INFO_PACKET_COUNT    "ATI5"
#define SPIRIT_CMD_READ_INFO_PACKETS_LOST    "ATI6"
#define SPIRIT_CMD_CFG_BAUD_RATE               "ATS00"
#define SPIRIT_CMD_CFG_FREQUENCY               "ATS01"
#define SPIRIT_CMD_CFG_DATA_RATE               "ATS02"
#define SPIRIT_CMD_CFG_MODULATION              "ATS03"
#define SPIRIT_CMD_CFG_OUTPUT_POWER            "ATS04"
#define SPIRIT_CMD_CFG_FREQ_DEVIATION          "ATS05"
#define SPIRIT_CMD_CFG_RX_FILTER               "ATS06"
#define SPIRIT_CMD_CFG_CS_MODE                 "ATS07"
#define SPIRIT_CMD_CFG_RSSI_THRESHOLD          "ATS08"
#define SPIRIT_CMD_CFG_PREAMBLE_LEN            "ATS09"
#define SPIRIT_CMD_CFG_SYNC_LENGTH             "ATS10"
#define SPIRIT_CMD_CFG_SYNC_VALUE              "ATS11"
#define SPIRIT_CMD_CFG_CRC_MODE                "ATS12"
#define SPIRIT_CMD_CFG_WHITENING               "ATS13"
#define SPIRIT_CMD_CFG_FEC                     "ATS14"
#define SPIRIT_CMD_CFG_SOURCE_ADDR             "ATS15"
#define SPIRIT_CMD_CFG_DESTINATION_ADDR        "ATS16"
#define SPIRIT_CMD_CFG_MULTICAST_ADDR          "ATS17"
#define SPIRIT_CMD_CFG_BROADCAST_ADDR          "ATS18"
#define SPIRIT_CMD_CFG_FILTER_CRC              "ATS19"
#define SPIRIT_CMD_CFG_FILTER_SOURCE           "ATS20"
#define SPIRIT_CMD_CFG_FILTER_DESTINATION      "ATS21"
#define SPIRIT_CMD_CFG_FILTER_MULTICAST        "ATS22"
#define SPIRIT_CMD_CFG_FILTER_BROADCAST        "ATS23"
#define SPIRIT_CMD_CFG_TXRX_LED                "ATS24"
#define SPIRIT_CMD_CFG_ESCAPE_SEQ              "ATS26"
#define SPIRIT_CMD_CFG_SOURCE_FILT_MASK        "ATS27"
#define SPIRIT_CMD_CFG_PAYLOAD_SIZE            "ATS28"
#define SPIRIT_PCFG_ENABLE    "1"
#define SPIRIT_PCFG_DISABLE   "0"
#define SPIRIT_PCFG_BAUD_RATE_9600     "9600"
#define SPIRIT_PCFG_BAUD_RATE_19200    "19200"
#define SPIRIT_PCFG_BAUD_RATE_38400    "38400"
#define SPIRIT_PCFG_BAUD_RATE_56000    "56000"
#define SPIRIT_PCFG_BAUD_RATE_57600    "57600"
#define SPIRIT_PCFG_BAUD_RATE_115200   "115200"
#define SPIRIT_PCFG_BAUD_RATE_128000   "128000"
#define SPIRIT_PCFG_BAUD_RATE_256000   "256000"
#define SPIRIT_PCFG_CSMODE_STATIC_SENSING          "0"
#define SPIRIT_PCFG_CSMODE_DYNAMIC_SENSING_6dB     "1"
#define SPIRIT_PCFG_CSMODE_DYNAMIC_SENSING_12dB    "2"
#define SPIRIT_PCFG_CSMODE_DYNAMIC_SENSING_18dB    "3"
#define SPIRIT_PCFG_CRCMODE_POLY_0x07       "1"
#define SPIRIT_PCFG_CRCMODE_POLY_0x8005     "2"
#define SPIRIT_PCFG_CRCMODE_POLY_0x1021     "3"
#define SPIRIT_PCFG_CRCMODE_POLY_0x864CFB   "4"
#define SPIRIT_PCFG_TXRXLED_DISABLED        "0"
#define SPIRIT_PCFG_TXRXLED_OPEN_DRAIN      "1"
#define SPIRIT_PCFG_TXRXLED_PUSH_PULL       "2"
#define SPIRIT_PCFG_MODULATION_2_FSK        "0"
#define SPIRIT_PCFG_MODULATION_GFSK05       "1"
#define SPIRIT_PCFG_MODULATION_GFSK1        "2"
#define SPIRIT_PCFG_MODULATION_GMSK         "3"
#define SPIRIT_PCFG_MODULATION_OOK          "4"
#define SPIRIT_PCFG_MODULATION_ASK          "5"
#define SPIRIT_CMD_SET_RF_TEST_MODE_DISABLE  "AT/T0"
#define SPIRIT_CMD_SET_RF_TEST_MODE_PN9      "AT/T1"
#define SPIRIT_CMD_SET_RF_TEST_MODE_CW       "AT/T2"
typedef struct
{
    // Output pins
    digital_out_t rst;     
    digital_out_t cmd;       
    digital_out_t shd;     
    // Modules
    uart_t uart;                                    
    // Buffers
    char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];         
    char uart_tx_buffer[ DRV_TX_BUFFER_SIZE ];         
} spirit_t;
 
typedef struct
{
    // Communication gpio pins
    
    pin_name_t rx_pin;                                  
    pin_name_t tx_pin;                                  
    // Additional gpio pins
    
    pin_name_t rst;        
    pin_name_t cmd;          
    pin_name_t shd;        
    // Static variable
    
    uint32_t          baud_rate;                        
    bool              uart_blocking;                    
    uart_data_bits_t  data_bit;                         
    uart_parity_t     parity_bit;                       
    uart_stop_bits_t  stop_bit;                         
} spirit_cfg_t;
 
typedef enum
{
   SPIRIT_OK = 0,
   SPIRIT_ERROR = -1
 
} spirit_return_value_t;
 
void spirit_cfg_setup ( spirit_cfg_t *cfg );
 
err_t spirit_init ( spirit_t *ctx, spirit_cfg_t *cfg );
 
void spirit_power_module ( spirit_t *ctx, uint8_t power_state );
 
void spirit_reset ( spirit_t *ctx );
 
void spirit_set_mode ( spirit_t *ctx, uint8_t mode );
 
void spirit_generic_write ( spirit_t *ctx, char *data_buf, uint16_t len );
 
int32_t spirit_generic_read ( spirit_t *ctx, char *data_buf, uint16_t max_len );
 
void spirit_send_cmd ( spirit_t *ctx, char *cmd );
 
void spirit_send_cmd_with_parameter ( spirit_t *ctx, char *at_cmd_buf, char *param_buf );
 
void spirit_send_cmd_check ( spirit_t *ctx, char *at_cmd_buf );
 
void spirit_send_cmd_parameter_check ( spirit_t *ctx, char *at_cmd_buf );
 
#ifdef __cplusplus
}
#endif
#endif // SPIRIT_H
 
 // spirit
 
// ------------------------------------------------------------------------ END