lriot.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 LRIOT_H
#define LRIOT_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_spi_master.h"
#include "spi_specifics.h"
#include "common/lr1110_bootloader_types.h"
#include "common/lr1110_types.h"
#include "transceiver/lr1110_crypto_engine_types.h"
#include "transceiver/lr1110_gnss_types.h"
#include "transceiver/lr1110_radio_types.h"
#include "transceiver/lr1110_system_types.h"
#include "transceiver/lr1110_wifi_types.h"
#include "modem/lr1110_modem_lorawan_types.h"
#include "modem/lr1110_modem_wifi_types.h"
#include "modem/lr1110_modem_gnss_types.h"
#include "modem/lr1110_modem_helper_types.h"
#include "modem/lr1110_modem_system_types.h"
 
#define LRIOT_TEMP_INT_VREF                     1.35
#define LRIOT_TEMP_VOLTAGE_AT_25C               0.7295
#define LRIOT_TEMP_RESOLUTION                   2047.0
#define LRIOT_TEMP_NOMINAL                      25
#define LRIOT_TEMP_SLOPE                        -1.7
#define LRIOT_TEMP_SLOPE_DIVIDEND               1000.0
 
#define LRIOT_TCXO_DELAY_2SEC                   0xFFFA
 
#define LRIOT_GNSS_SCAN_MAX_SATELLITES          16
#define LRIOT_GNSS_SCAN_RESULTS_BUF_LEN         256
#define LRIOT_GNSS_SCAN_DISPLAY_ALL             0
 
#define LRIOT_WIFI_SCAN_MAX_RESULTS             12
#define LRIOT_WIFI_SCAN_DISPLAY_ALL             0
 
#define LRIOT_LORA_PKT_PAYLOAD_LEN              64
#define LRIOT_LORA_DEFAULT_FREQ                 868100000ul
 
#define LRIOT_UPDATE_FIRMWARE                   0
 
#define LRIOT_TRANSCEIVER_FIRMWARE              0
#define LRIOT_MODEM_FIRMWARE                    1
#define LRIOT_FIRMWARE_SELECTOR                 LRIOT_TRANSCEIVER_FIRMWARE
 
#define LRIOT_SET_DATA_SAMPLE_EDGE              SET_SPI_DATA_SAMPLE_EDGE
#define LRIOT_SET_DATA_SAMPLE_MIDDLE            SET_SPI_DATA_SAMPLE_MIDDLE
 
 // lriot_set
 
#define LRIOT_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
    cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.rst  = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.bsy  = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
#define LRIOT_MAP_MIKROBUS( cfg, mikrobus ) \ …
 
 // lriot_map
 // lriot
 
typedef struct 
{
#if ( LRIOT_FIRMWARE_SELECTOR == LRIOT_TRANSCEIVE_FIRMWARE )
    lr1110_wifi_signal_type_scan_t  signal_type;
    lr1110_wifi_channel_mask_t      channels;     
    lr1110_wifi_mode_t              scan_mode;
#else
    lr1110_modem_wifi_signal_type_scan_t  signal_type;
    lr1110_modem_wifi_channel_t           channels;     
    lr1110_modem_wifi_mode_t              scan_mode;
    lr1110_modem_wifi_result_format_t     result_format;
#endif
    uint8_t  max_results;
    uint8_t  nb_scan_per_channel;
    uint16_t timeout_in_ms;
    bool     abort_on_timeout;
    
} lriot_wifi_settings_t;
typedef struct  {…};
 
typedef struct 
{
#if ( LRIOT_FIRMWARE_SELECTOR == LRIOT_TRANSCEIVE_FIRMWARE )
    lr1110_wifi_extended_full_result_t scan_results[ LRIOT_WIFI_SCAN_MAX_RESULTS ];
    lr1110_wifi_cumulative_timings_t   timings;
#else  
    lr1110_modem_wifi_extended_full_result_t scan_results[ LRIOT_WIFI_SCAN_MAX_RESULTS ];
    lr1110_modem_wifi_cumulative_timings_t   timings;
#endif
    uint8_t num_wifi_results;
    
} lriot_wifi_scan_results_t;
typedef struct  {…};
 
typedef struct 
{
    uint8_t                             num_satellites;
#if ( LRIOT_FIRMWARE_SELECTOR == LRIOT_TRANSCEIVE_FIRMWARE )
    lr1110_gnss_detected_satellite_t        satellite_id_cnr_doppler[ LRIOT_GNSS_SCAN_MAX_SATELLITES ];   
#else  
    lr1110_modem_gnss_detected_satellite_t  satellite_id_cnr[ LRIOT_GNSS_SCAN_MAX_SATELLITES ];  
#endif
    uint8_t                             scan_results[ LRIOT_GNSS_SCAN_RESULTS_BUF_LEN ];
    uint16_t                            scan_results_len;
    uint8_t                             destination_id;
    
} lriot_gnss_scan_results_t;
typedef struct  {…};
 
typedef struct 
{
#if ( LRIOT_FIRMWARE_SELECTOR == LRIOT_TRANSCEIVE_FIRMWARE )
    lr1110_system_version_t     version;
    lr1110_system_uid_t         uid;
    lr1110_system_join_eui_t    join_eui;
    lr1110_system_pin_t         pin;
#else
    lr1110_modem_version_t      version;
    lr1110_modem_chip_eui_t     chip_eui;
    lr1110_modem_join_eui_t     join_eui;
    lr1110_modem_dev_eui_t      dev_eui;
    uint32_t                    pin;
#endif
    
} lriot_chip_info_t;
typedef struct  {…};
 
typedef struct
{
    int8_t rssi_pkt_in_dbm;         
    int8_t snr_pkt_in_db;           
    int8_t signal_rssi_pkt_in_dbm;  
} lriot_lora_packet_status_t;
typedef struct {…};
 
typedef struct
{
    // Output pins
    digital_out_t  rst;             
    // Input pins
    digital_in_t   bsy;             
    digital_in_t   int_pin;         
    pin_name_t     bsy_pin_name;    
    // Modules
    spi_master_t   spi;             
    pin_name_t     chip_select;     
    lriot_wifi_settings_t wifi_settings; 
} lriot_t;
typedef struct {…};
 
typedef struct
{
    // Communication gpio pins
    pin_name_t  miso;               
    pin_name_t  mosi;               
    pin_name_t  sck;                
    pin_name_t  cs;                 
    // Additional gpio pins
    pin_name_t  rst;                
    pin_name_t  bsy;                
    pin_name_t  int_pin;            
    // static variable
    uint32_t                           spi_speed;       
    spi_master_mode_t                  spi_mode;        
    spi_master_chip_select_polarity_t  cs_polarity;     
} lriot_cfg_t;
typedef struct {…};
 
typedef enum
{
    LRIOT_OK = 0,
    LRIOT_ERROR = -1
 
} lriot_return_value_t;
typedef enum {…};
 
void lriot_cfg_setup ( lriot_cfg_t *cfg );
 
err_t lriot_init ( lriot_t *ctx, lriot_cfg_t *cfg );
 
err_t lriot_default_cfg ( lriot_t *ctx );
 
void lriot_set_rst_pin ( lriot_t *ctx, uint8_t state );
 
uint8_t lriot_get_busy_pin ( lriot_t *ctx );
 
uint8_t lriot_get_int_pin ( lriot_t *ctx );
 
err_t lriot_get_chip_info ( lriot_t *ctx, lriot_chip_info_t *info );
 
#if ( LRIOT_FIRMWARE_SELECTOR == LRIOT_TRANSCEIVE_FIRMWARE )
err_t lriot_get_temperature ( lriot_t *ctx, float *temperature );
 
err_t lriot_send_lora_message ( lriot_t *ctx, uint8_t *message );
 
err_t lriot_read_lora_message ( lriot_t *ctx, lriot_lora_packet_status_t *pkt_status, uint8_t *message );
#endif
 
err_t lriot_get_wifi_scan_results ( lriot_t *ctx, lriot_wifi_scan_results_t *results );
 
err_t lriot_get_gnss_scan_results ( lriot_t *ctx, lriot_gnss_scan_results_t *results );
 
err_t lriot_update_firmware ( lriot_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // LRIOT_H
 
 // lriot
 
// ------------------------------------------------------------------------ END