bletx.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 BLETX_H
#define BLETX_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_i2c_master.h"
 
 
#define BLETX_SEL_INTERFACE_I2C                                 0
#define BLETX_SEL_INTERFACE_UART                                1
 
#define BLETX_SEL_BAUD_RATE_9600                             9600
#define BLETX_SEL_BAUD_RATE_115200                         115200 
 
 // bletx_sel
 
#define BLETX_REG_SETTING_1                                0x01
#define BLETX_REG_SETTING_2                                0x02
#define BLETX_REG_SETTING_3                                0x03
#define BLETX_REG_SETTING_4                                0x04
#define BLETX_REG_SETTING_5                                0x05
#define BLETX_REG_SETTING_6                                0x06
#define BLETX_REG_PREAMBLE                                 0x07
#define BLETX_REG_ACCESS_ADDRESS_0                         0x08
#define BLETX_REG_ACCESS_ADDRESS_1                         0x09
#define BLETX_REG_ACCESS_ADDRESS_2                         0x0A
#define BLETX_REG_ACCESS_ADDRESS_3                         0x0B
#define BLETX_REG_PDU_HEADER_0                             0x0C
#define BLETX_REG_PDU_HEADER_1                             0x0D
#define BLETX_REG_PDU_ADV_ADDR_0                           0x0E
#define BLETX_REG_PDU_ADV_ADDR_1                           0x0F
#define BLETX_REG_PDU_ADV_ADDR_2                           0x10
#define BLETX_REG_PDU_ADV_ADDR_3                           0x11
#define BLETX_REG_PDU_ADV_ADDR_4                           0x12
#define BLETX_REG_PDU_ADV_ADDR_5                           0x13
#define BLETX_REG_PDU_ADV_DATA_START                       0x14
#define BLETX_REG_PDU_ADV_EDDYSTONE_DATA                   0x17
#define BLETX_REG_PDU_ADV_EDDYSTONE_UID                    0x2F
#define BLETX_REG_CRC_0                                    0x33
#define BLETX_REG_CRC_1                                    0x34
#define BLETX_REG_CRC_2                                    0x35
#define BLETX_REG_MODE                                     0x36
#define BLETX_REG_SOFT_RESET                               0x3F
 
 // bletx_reg
 
#define BLETX_AD_TYPE_FLAGS                                0x01
#define BLETX_AD_TYPE_FLAGS_CLASS_UUID_16                  0x02
#define BLETX_AD_TYPE_FLAGS_COMPLETE_UUID_16               0x03
#define BLETX_AD_TYPE_FLAGS_SHORT_LOCAL_NAME               0x08
#define BLETX_AD_TYPE_FLAGS_COMPLETE_LOCAL_NAME            0x09
#define BLETX_AD_TYPE_FLAGS_TX_POWER_LEVEL                 0x0A
#define BLETX_AD_TYPE_FLAGS_CLASS_OF_DEVICE                0x0D
#define BLETX_AD_TYPE_FLAGS_SIMPLE_PAIR_HASH_C             0x0E
#define BLETX_AD_TYPE_FLAGS_DEVICE_ID                      0x10
#define BLETX_AD_TYPE_FLAGS_SERVICE_DATA_UUID_16           0x16
#define BLETX_AD_TYPE_FLAGS_PUBLIC_TARGET_ADDR             0x17
#define BLETX_AD_TYPE_FLAGS_RANDOM_TARGET_ADDR             0x18 
#define BLETX_AD_TYPE_FLAGS_APPEARANCE                     0x19
#define BLETX_AD_TYPE_FLAGS_ADVERTISING_INTERVAL           0x1A
#define BLETX_AD_TYPE_FLAGS_BLE_DEVICE_ADDR                0x1B
#define BLETX_AD_TYPE_FLAGS_RANDOM_LE_ROLE                 0x1C
#define BLETX_AD_TYPE_FLAGS_URI                            0x24
#define BLETX_AD_TYPE_FLAGS_INDOOR_POSITIONING             0x25
#define BLETX_AD_TYPE_FLAGS_TRANSPORT_DISCOVERY            0x26
#define BLETX_AD_TYPE_FLAGS_BROADCAST_CODE                 0x2D
#define BLETX_AD_TYPE_FLAGS_MANUFACTURER_SPEC_DATA         0xFF
 
#define BLETX_SOFT_RESET_CMD                               0xAA
 
#define BLETX_PREAMBLE                                     0xAA
   
#define BLETX_HEADER_PDU_TYPE_ADV_IND                      0x00
#define BLETX_HEADER_PDU_TYPE_ADV_NONCONN_IND              0x02
#define BLETX_HEADER_PDU_TYPE_ADV_SCAN_IND                 0x06
    
#define BLETX_TX_POWER_LVL_MODE_LOWEST                     0x00
#define BLETX_TX_POWER_LVL_MODE_LOW                        0x01
#define BLETX_TX_POWER_LVL_MODE_MEDIUM                     0x02
#define BLETX_TX_POWER_LVL_MODE_HIGH                       0x03
 
#define BLETX_ADV_DELAY_ENABLE                             0x80
#define BLETX_ADV_DELAY_DISABLE                            0x00
 
#define BLETX_CRC_ENABLE                                   0x80
#define BLETX_CRC_DISABLE                                  0x00
 
#define BLETX_WHITE_ENABLE                                 0x40
#define BLETX_WHITE_DISABLE                                0x00
    
#define BLETX_CHARACTER_CODES_DOT_COM                      0x07
#define BLETX_CHARACTER_CODES_DOT_ORG                      0x08
#define BLETX_CHARACTER_CODES_DOT_EDU                      0x09
#define BLETX_CHARACTER_CODES_DOT_NET                      0x0A
#define BLETX_CHARACTER_CODES_DOT_INFO                     0x0B
#define BLETX_CHARACTER_CODES_DOT_BIZ                      0x0C
#define BLETX_CHARACTER_CODES_DOT_GOV                      0x0D
    
#define BLETX_EDDYSTONE_SPEC_DATA_HTTP_WWW                 0x00
#define BLETX_EDDYSTONE_SPEC_DATA_HTTPS_WWW                0x01
#define BLETX_EDDYSTONE_SPEC_DATA_HTTP                     0x02
#define BLETX_EDDYSTONE_SPEC_DATA_HTTPS                    0x03
#define BLETX_EDDYSTONE_SPEC_DATA_UDI                      0x63
#define BLETX_EDDYSTONE_SPEC_DATA_TLM                      0x63
    
#define BLETX_EDDYSTONE_SERVICE_UUID                       0xAAFE
#define BLETX_EDDYSTONE_SERVICE_DATA_TYPE_VALUE            0x16
  
#define BLETX_EDDYSTONE_FRAME_TYPE_UID                     0x00
#define BLETX_EDDYSTONE_FRAME_TYPE_URL                     0x10
#define BLETX_EDDYSTONE_FRAME_TYPE_TLM                     0x20
#define BLETX_EDDYSTONE_FRAME_TYPE_EID                     0x30
 
#define BLETX_SET_DEV_ADDR                                 0x28
 
#define BLETX_ACCESS_ADDRESS                               0xD6BE898Eul
 
 // bletx_set
 
#define BLETX_MAP_MIKROBUS( cfg, mikrobus )       \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.ui = MIKROBUS( mikrobus, MIKROBUS_CS );   \
    cfg.s1 = MIKROBUS( mikrobus, MIKROBUS_AN );   \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST );  \
    cfg.s0 = MIKROBUS( mikrobus, MIKROBUS_PWM ) 
 
 // bletx_map
 // bletx
 
typedef struct
{
    // Output pins
    digital_out_t  ui;     
    digital_out_t  s0;     
    digital_out_t  s1;     
    digital_out_t  rst;    
    // Modules
    i2c_master_t i2c;      
    // I2C slave address
    uint8_t slave_address; 
} bletx_t;
 
typedef struct
{
    pin_name_t  scl;        
    pin_name_t  sda;        
    pin_name_t  ui;         
    pin_name_t  s0;         
    pin_name_t  s1;         
    pin_name_t  rst;        
    uint32_t  i2c_speed;    
    uint8_t   i2c_address;  
} bletx_cfg_t;
 
typedef struct
{                              
    uint8_t   adv_ch_1_frequency;
    uint8_t   adv_ch_2_frequency; 
    uint8_t   adv_ch_3_frequency; 
    uint8_t   tx_output_power; 
    uint8_t   txdata_loop;
    uint8_t   txdata_cw;
    uint8_t   eventnum;
    uint8_t   advdelay_enb;
    uint16_t  avdintvl_interval_ms;
    uint8_t   crc_enb;
    uint8_t   white_enb;
    uint8_t   pdu_len;
    uint8_t   uuid[ 6 ];
 
} bletx_adv_cfg_t;
 
typedef struct
{                              
    uint8_t   preamble;
    uint32_t  access_address; 
    uint16_t  pdu_header; 
    uint8_t   adv_addr[ 6 ]; 
    uint8_t   adv_data[ 32 ]; 
    uint32_t  crc; 
 
} bletx_create_adv_data_packet_t;
 
typedef struct
{                              
    uint8_t   length_of_service_list;
    uint8_t   param_service_list; 
    uint16_t  eddystone_id; 
    uint8_t   length_of_service_data; 
    uint8_t   service_data; 
    uint8_t   frame_type_url; 
    uint8_t   power; 
    uint8_t   spec_data;
    uint8_t   advdata_url[ 32 ];
    uint8_t   domain;
    uint8_t   name_space_id[ 10 ];
    uint8_t   instance_id[ 6 ];
    uint8_t   tlm_version;
    uint16_t  battery_voltage;
    float     beacon_temperature;
    uint32_t  pdu_count;
    uint32_t  time_since_reboot;
 
} bletx_eddystone_data_t;
 
typedef enum
{
    ADVCH1_37_Ch_2402_MHz = 0x00,
    ADVCH1_37_Ch_2480_MHz = 0x30,
    ADVCH1_38_Ch_2426_MHz = 0x10,
    ADVCH1_39_Ch_2480_MHz = 0x20,
    ADVCH2_37_Ch_2402_MHz = 0x00,
    ADVCH2_38_Ch_2426_MHz = 0x04,
    ADVCH2_39_Ch_2480_MHz = 0x08,
    ADVCH2_NO_TX_OUTPUT   = 0x0C,
    ADVCH3_37_Ch_2402_MHz = 0x00,
    ADVCH3_38_Ch_2426_MHz = 0x01,
    ADVCH3_39_Ch_2480_MHz = 0x02,
    ADVCH3_NO_TX_OUTPUT   = 0x03
 
} bletx_advch_value_t;
 
typedef enum
{
    TX_POWER_0_dBm = 0x00,
    TX_POWER_MINUS_3_dBm,
    TX_POWER_MINUS_6_dBm,
    TX_POWER_MINUS_9_dBm,
    TX_POWER_MINUS_12_dBm,
    TX_POWER_MINUS_15_dBm,
    TX_POWER_MINUS_20_dBm,
    TX_POWER_MINUS_32_dBm
 
} bletx_tx_output_power_value_t;
 
typedef enum
{
    BURST_TRANSMISSION = 0x00,
    CONTINUOUS_TRANSMISSION = 0x10,
    GFSK = 0x00,
    CONTINUOUS_WAVE = 0x08
 
} bletx_txdata_value_t;
 
typedef enum
{
    ADVERTISING_EVENT_REPEAT = 0x00,
    ADVERTISING_EVENT_1_TIME,
    ADVERTISING_EVENT_2_TIME,
    ADVERTISING_EVENT_3_TIME,
    ADVERTISING_EVENT_4_TIME,
    ADVERTISING_EVENT_5_TIME,
    ADVERTISING_EVENT_6_TIME,
    ADVERTISING_EVENT_7_TIME
 
} bletx_eventnum_value_t;
 
typedef enum
{
    BLETX_OK = 0,
    BLETX_ERROR = -1
 
} bletx_return_value_t;
 
void bletx_cfg_setup ( bletx_cfg_t *cfg );
 
err_t bletx_init ( bletx_t *ctx, bletx_cfg_t *cfg );
 
err_t bletx_default_cfg ( bletx_t *ctx );
 
err_t bletx_power_down ( bletx_t *ctx );
 
err_t bletx_power_up ( bletx_t *ctx );
 
err_t bletx_hw_reset ( bletx_t *ctx );
 
err_t bletx_soft_reset ( bletx_t *ctx );
 
err_t bletx_interface_selection ( bletx_t *ctx, uint8_t sel_interface );
 
err_t bletx_slave_address_selection ( bletx_t *ctx, uint8_t sel_slave_address ) ;
 
err_t bletx_baud_rate_selection ( bletx_t *ctx, uint32_t sel_baud_rate );
 
err_t bletx_generic_write ( bletx_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t bletx_generic_read ( bletx_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
err_t bletx_start_advertising ( bletx_t *ctx );
 
err_t bletx_stop_advertising ( bletx_t *ctx );
 
err_t bletx_set_cfg_adv_channel ( bletx_t *ctx, bletx_advch_value_t advch_data );
 
err_t bletx_set_output_power ( bletx_t *ctx, bletx_tx_output_power_value_t power_data );
 
err_t bletx_set_tx_data ( bletx_t *ctx, bletx_txdata_value_t txdata_data );
 
err_t bletx_set_eventnum ( bletx_t *ctx, bletx_eventnum_value_t eventnum_data );
 
err_t bletx_set_adv_delay ( bletx_t *ctx, float adv_delay_ms );
 
err_t bletx_set_configuration ( bletx_t *ctx, bletx_adv_cfg_t adv_cfg );
 
err_t bletx_create_adv_data_packet ( bletx_t *ctx, bletx_create_adv_data_packet_t adv_data_packet );
 
err_t bletx_create_eddystone_uri ( bletx_t *ctx, bletx_eddystone_data_t adv_data );
 
err_t bletx_create_eddystone_uid ( bletx_t *ctx, bletx_eddystone_data_t adv_data );
 
err_t bletx_create_eddystone_tlm ( bletx_t *ctx, bletx_eddystone_data_t adv_data );
 
#ifdef __cplusplus
}
#endif
#endif // BLETX_H
 
 // bletx
 
// ------------------------------------------------------------------------ END