nanobeacon.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 NANOBEACON_H
#define NANOBEACON_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 NANOBEACON_OPCODE_READY             0x01
#define NANOBEACON_OPCODE_READY_ACK         0x80
#define NANOBEACON_OPCODE_READY_NACK        0x81
#define NANOBEACON_OPCODE_RATE              0x02
#define NANOBEACON_OPCODE_READ_REG          0x03
#define NANOBEACON_OPCODE_READ_REG_RESP     0x83
#define NANOBEACON_OPCODE_WRITE_REG         0x04
#define NANOBEACON_OPCODE_WRITE_REG_RESP    0x84
#define NANOBEACON_OPCODE_READ_MEM          0x05
#define NANOBEACON_OPCODE_READ_MEM_RESP     0x85
#define NANOBEACON_OPCODE_WRITE_MEM         0x06
#define NANOBEACON_OPCODE_WRITE_MEM_RESP    0x86
#define NANOBEACON_OPCODE_READ_EFUSE        0x07
#define NANOBEACON_OPCODE_READ_EFUSE_RESP   0x87
#define NANOBEACON_OPCODE_WRITE_EFUSE       0x08
#define NANOBEACON_OPCODE_WRITE_EFUSE_RESP  0x88
 
#define NANOBEACON_PACKET_HEADER            0xAE
#define NANOBEACON_PACKET_TAIL              0xEA
#define NANOBEACON_PAYLOAD_READY            0xAA
#define NANOBEACON_PACKET_PAYLOAD_SIZE      128
#define NANOBEACON_TIMEOUT_MS               3000
#define NANOBEACON_CHECK_COMM_NUM_TRIES     5
 
#define NANOBEACON_TX_DRV_BUFFER_SIZE       ( NANOBEACON_PACKET_PAYLOAD_SIZE + 4 )
#define NANOBEACON_RX_DRV_BUFFER_SIZE       ( NANOBEACON_PACKET_PAYLOAD_SIZE + 4 )
 
 // nanobeacon_cmd
 
#define NANOBEACON_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.dq = MIKROBUS( mikrobus, MIKROBUS_PWM );
 
 // nanobeacon_map
 // nanobeacon
 
typedef struct
{
    uint8_t opcode;         
    uint8_t payload_len;    
    uint8_t payload[ NANOBEACON_PACKET_PAYLOAD_SIZE ];  
} nanobeacon_packet_t;
 
typedef struct
{
    // Output pins
    digital_out_t en;       
    digital_out_t dq;       
    // Input pins
    digital_in_t an;        
    // Modules
    uart_t uart;            
    // Buffers
    uint8_t uart_rx_buffer[ NANOBEACON_RX_DRV_BUFFER_SIZE ];    
    uint8_t uart_tx_buffer[ NANOBEACON_TX_DRV_BUFFER_SIZE ];    
} nanobeacon_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;      
    pin_name_t tx_pin;      
    // Additional gpio pins
    pin_name_t an;          
    pin_name_t en;          
    pin_name_t dq;          
    // 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;          
} nanobeacon_cfg_t;
 
typedef enum
{
    NANOBEACON_OK = 0,
    NANOBEACON_ERROR = -1
 
} nanobeacon_return_value_t;
 
void nanobeacon_cfg_setup ( nanobeacon_cfg_t *cfg );
 
err_t nanobeacon_init ( nanobeacon_t *ctx, nanobeacon_cfg_t *cfg );
 
err_t nanobeacon_generic_write ( nanobeacon_t *ctx, uint8_t *data_in, uint16_t len );
 
err_t nanobeacon_generic_read ( nanobeacon_t *ctx, uint8_t *data_out, uint16_t len );
 
uint8_t nanobeacon_get_an_pin ( nanobeacon_t *ctx );
 
void nanobeacon_set_en_pin ( nanobeacon_t *ctx, uint8_t state );
 
void nanobeacon_set_dq_pin ( nanobeacon_t *ctx, uint8_t state );
 
void nanobeacon_restart_device ( nanobeacon_t *ctx );
 
err_t nanobeacon_send_packet ( nanobeacon_t *ctx, nanobeacon_packet_t pkt_in );
 
err_t nanobeacon_read_packet ( nanobeacon_t *ctx, nanobeacon_packet_t *pkt_out );
 
err_t nanobeacon_check_communication ( nanobeacon_t *ctx );
 
err_t nanobeacon_write_reg ( nanobeacon_t *ctx, uint16_t address, uint32_t data_in );
 
err_t nanobeacon_read_reg ( nanobeacon_t *ctx, uint16_t address, uint32_t *data_out );
 
err_t nanobeacon_write_mem ( nanobeacon_t *ctx, uint16_t address, uint32_t data_in );
 
err_t nanobeacon_read_mem ( nanobeacon_t *ctx, uint16_t address, uint32_t *data_out );
 
err_t nanobeacon_write_efuse ( nanobeacon_t *ctx, uint8_t aid, uint16_t data_in );
 
err_t nanobeacon_read_efuse ( nanobeacon_t *ctx, uint8_t aid, uint16_t *data_out );
 
err_t nanobeacon_set_advertising ( uint8_t *mac_address, uint16_t interval, uint8_t *adv_raw_data, uint8_t len );
 
err_t nanobeacon_load_adv_to_ram ( nanobeacon_t *ctx );
 
err_t nanobeacon_start_advertising ( nanobeacon_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // NANOBEACON_H
 
 // nanobeacon
 
// ------------------------------------------------------------------------ END