bletiny.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 BLETINY_H
#define BLETINY_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"
#include "drv_analog_in.h"
 
#define BLETINY_CMD_ATR             "ATr"
#define BLETINY_CMD_ATZ             "ATZ"
#define BLETINY_CMD_GAPDISCONNECT   "AT+GAPDISCONNECT"
#define BLETINY_CMD_ATI             "ATI"
#define BLETINY_CMD_ATRI            "ATrI"
#define BLETINY_CMD_BDADDR          "AT+BDADDR"
#define BLETINY_CMD_RSSI            "AT+RSSI"
#define BLETINY_CMD_CHECK_MEM       "AT+MEM=0"
#define BLETINY_CMD_CLEAR_MEM       "AT+MEM=0,"
 
 // bletiny_reg
 
#define BLETINY_RSP_OK              "OK"
#define BLETINY_RSP_ERROR           "ERROR"
#define BLETINY_CONNECTED           "+CONNECTED"
#define BLETINY_DISCONNECTED        "+DISCONNECTED"
 
#define BLETINY_SPI_CFG_SPEED_2MHZ  0
#define BLETINY_SPI_CFG_SPEED_4MHZ  1
#define BLETINY_SPI_CFG_SPEED_8MHZ  2
#define BLETINY_SPI_CFG_MODE0       0
#define BLETINY_SPI_CFG_MODE1       1
#define BLETINY_SPI_CFG_MODE2       2
#define BLETINY_SPI_CFG_MODE3       3
 
#define BLETINY_I2C_CFG_SPEED_100KHZ    100
#define BLETINY_I2C_CFG_SPEED_400KHZ    400
#define BLETINY_I2C_CFG_REG_LEN_1BYTE   8
#define BLETINY_I2C_CFG_REG_LEN_1BYTES  16
 
#define DRV_BUFFER_SIZE             500
 
 // bletiny_set
 
#define BLETINY_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.tx_pin  = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin  = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST );
 
 // bletiny_map
 // bletiny
 
typedef struct
{
    // Output pins
    digital_out_t rst;                      
    // Modules
    uart_t uart;                            
    // Buffers
    char uart_rx_buffer[ DRV_BUFFER_SIZE ]; 
    char uart_tx_buffer[ DRV_BUFFER_SIZE ]; 
} bletiny_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;                                  
    pin_name_t tx_pin;                                  
    // Additional gpio pins
    pin_name_t rst;        
    // 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;                                               
} bletiny_cfg_t;
 
typedef enum
{
   BLETINY_OK = 0,
   BLETINY_ERROR = -1,
   BLETINY_ERROR_TIMEOUT = -2,
   BLETINY_ERROR_RETURN = -3,
   BLETINY_ERROR_UNKNOWN = -4
 
} bletiny_return_value_t;
 
void bletiny_cfg_setup ( bletiny_cfg_t *cfg );
 
err_t bletiny_init ( bletiny_t *ctx, bletiny_cfg_t *cfg );
 
err_t bletiny_default_cfg ( bletiny_t *ctx );
 
err_t bletiny_generic_write ( bletiny_t *ctx, char *data_buf, uint16_t len );
 
err_t bletiny_generic_read ( bletiny_t *ctx, char *data_buf, uint16_t max_len );
 
void bletiny_send_cmd ( bletiny_t *ctx, char *cmd );
 
void bletiny_spi_config ( bletiny_t *ctx, uint8_t speed, uint8_t mode );
 
err_t bletiny_spi_write ( bletiny_t *ctx, char *data_buf, uint8_t len );
 
err_t bletiny_spi_read ( bletiny_t *ctx, char *data_buf, uint8_t len );
 
err_t bletiny_spi_write_then_read ( bletiny_t *ctx, uint8_t *data_write, uint8_t write_len, char *data_read, uint8_t read_len );
 
void bletiny_i2c_config ( bletiny_t *ctx, uint8_t speed, uint8_t reg_len );
 
err_t bletiny_i2c_write ( bletiny_t *ctx, uint8_t slave_address, uint16_t reg, uint8_t reg_data );
 
err_t bletiny_i2c_read ( bletiny_t *ctx,  uint8_t slave_address, uint16_t reg, uint8_t *data_buf, uint8_t len );
 
#ifdef __cplusplus
}
#endif
#endif // BLETINY_H
 
 // bletiny
 
// ------------------------------------------------------------------------ END