iotexpresslink.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 IOTEXPRESSLINK_H
#define IOTEXPRESSLINK_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"
 
#define IOTEXPRESSLINK_CMD_AT                       "AT"
#define IOTEXPRESSLINK_CMD_CONNECT                  "AT+CONNECT"
#define IOTEXPRESSLINK_CMD_CONNECT_CHECK            "AT+CONNECT?"
#define IOTEXPRESSLINK_CMD_DISCONNECT               "AT+DISCONNECT"
#define IOTEXPRESSLINK_CMD_SLEEP                    "AT+SLEEP"
#define IOTEXPRESSLINK_CMD_CONFMODE                 "AT+CONFMODE"
#define IOTEXPRESSLINK_CMD_RESET                    "AT+RESET"
#define IOTEXPRESSLINK_CMD_FACTORY_RESET            "AT+FACTORY_RESET"
#define IOTEXPRESSLINK_CMD_SEND                     "AT+SEND"
#define IOTEXPRESSLINK_CMD_GET                      "AT+GET"
#define IOTEXPRESSLINK_CMD_SUBSCRIBE                "AT+SUBSCRIBE"
#define IOTEXPRESSLINK_CMD_UNSUBSCRIBE              "AT+UNSUBSCRIBE"
#define IOTEXPRESSLINK_CMD_CONF                     "AT+CONF"
#define IOTEXPRESSLINK_CMD_CONF_CHECK               "AT+CONF?"
#define IOTEXPRESSLINK_CMD_EVENT                    "AT+EVENT?"
#define IOTEXPRESSLINK_CMD_TIME                     "AT+TIME"
#define IOTEXPRESSLINK_CMD_WHERE                    "AT+WHERE"
#define IOTEXPRESSLINK_CMD_SEPARATOR                " "
#define IOTEXPRESSLINK_CMD_SIGN_EQUAL               "="
 
#define IOTEXPRESSLINK_CONF_KEY_ABOUT               "About"
#define IOTEXPRESSLINK_CONF_KEY_VERSION             "Version"
#define IOTEXPRESSLINK_CONF_KEY_TECH_SPEC           "TechSpec"
#define IOTEXPRESSLINK_CONF_KEY_THING_NAME          "ThingName"
#define IOTEXPRESSLINK_CONF_KEY_CERTIFICATE         "Certificate"
#define IOTEXPRESSLINK_CONF_KEY_CUSTOM_NAME         "CustomName"
#define IOTEXPRESSLINK_CONF_KEY_ENDPOINT            "Endpoint"
#define IOTEXPRESSLINK_CONF_KEY_ROOT_CA             "RootCA"
#define IOTEXPRESSLINK_CONF_KEY_DEFENDER            "Defender"
#define IOTEXPRESSLINK_CONF_KEY_HOTA_CERTIFICATE    "HOTAcertificate"
#define IOTEXPRESSLINK_CONF_KEY_OTA_CERTIFICATE     "OTAcertificate"
#define IOTEXPRESSLINK_CONF_KEY_SSID                "SSID"
#define IOTEXPRESSLINK_CONF_KEY_PASSPHRASE          "Passphrase"
#define IOTEXPRESSLINK_CONF_KEY_APN                 "APN"
#define IOTEXPRESSLINK_CONF_KEY_QOS                 "QOS"
#define IOTEXPRESSLINK_CONF_KEY_TOPIC               "Topic"
 
#define IOTEXPRESSLINK_RSP_OK                       "OK"
#define IOTEXPRESSLINK_RSP_ERR                      "ERR"
 
#define IOTEXPRESSLINK_TX_DRV_BUFFER_SIZE           300
#define IOTEXPRESSLINK_RX_DRV_BUFFER_SIZE           1000
 
 // iotexpresslink_cmd
 
#define IOTEXPRESSLINK_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.wake = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.event = MIKROBUS( mikrobus, MIKROBUS_INT );
 
 // iotexpresslink_map
 // iotexpresslink
 
typedef struct
{
    // Output pins
    digital_out_t rst;          
    // Input pins
    digital_in_t event;         
    digital_in_t wake;          
    // Modules
    uart_t uart;                
    // Buffers
    uint8_t uart_rx_buffer[ IOTEXPRESSLINK_RX_DRV_BUFFER_SIZE ];    
    uint8_t uart_tx_buffer[ IOTEXPRESSLINK_TX_DRV_BUFFER_SIZE ];    
} iotexpresslink_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 event;           
    pin_name_t wake;            
    // 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;      
} iotexpresslink_cfg_t;
 
typedef enum
{
    IOTEXPRESSLINK_OK = 0,
    IOTEXPRESSLINK_ERROR = -1,
    IOTEXPRESSLINK_ERROR_TIMEOUT = -2,
    IOTEXPRESSLINK_ERROR_CMD = -3,
    IOTEXPRESSLINK_ERROR_UNKNOWN = -4
 
} iotexpresslink_return_value_t;
 
void iotexpresslink_cfg_setup ( iotexpresslink_cfg_t *cfg );
 
err_t iotexpresslink_init ( iotexpresslink_t *ctx, iotexpresslink_cfg_t *cfg );
 
err_t iotexpresslink_generic_write ( iotexpresslink_t *ctx, uint8_t *data_in, uint16_t len );
 
err_t iotexpresslink_generic_read ( iotexpresslink_t *ctx, uint8_t *data_out, uint16_t len );
 
void iotexpresslink_send_cmd ( iotexpresslink_t *ctx, uint8_t *cmd );
 
void iotexpresslink_enable_device ( iotexpresslink_t *ctx );
 
void iotexpresslink_disable_device ( iotexpresslink_t *ctx );
 
void iotexpresslink_reset_device ( iotexpresslink_t *ctx );
 
uint8_t iotexpresslink_get_event_pin ( iotexpresslink_t *ctx );
 
uint8_t iotexpresslink_get_wake_pin ( iotexpresslink_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // IOTEXPRESSLINK_H
 
 // iotexpresslink
 
// ------------------------------------------------------------------------ END