nanobeacon  2.1.0.0
nanobeacon.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef NANOBEACON_H
29 #define NANOBEACON_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_uart.h"
48 
69 #define NANOBEACON_OPCODE_READY 0x01
70 #define NANOBEACON_OPCODE_READY_ACK 0x80
71 #define NANOBEACON_OPCODE_READY_NACK 0x81
72 #define NANOBEACON_OPCODE_RATE 0x02
73 #define NANOBEACON_OPCODE_READ_REG 0x03
74 #define NANOBEACON_OPCODE_READ_REG_RESP 0x83
75 #define NANOBEACON_OPCODE_WRITE_REG 0x04
76 #define NANOBEACON_OPCODE_WRITE_REG_RESP 0x84
77 #define NANOBEACON_OPCODE_READ_MEM 0x05
78 #define NANOBEACON_OPCODE_READ_MEM_RESP 0x85
79 #define NANOBEACON_OPCODE_WRITE_MEM 0x06
80 #define NANOBEACON_OPCODE_WRITE_MEM_RESP 0x86
81 #define NANOBEACON_OPCODE_READ_EFUSE 0x07
82 #define NANOBEACON_OPCODE_READ_EFUSE_RESP 0x87
83 #define NANOBEACON_OPCODE_WRITE_EFUSE 0x08
84 #define NANOBEACON_OPCODE_WRITE_EFUSE_RESP 0x88
85 
90 #define NANOBEACON_PACKET_HEADER 0xAE
91 #define NANOBEACON_PACKET_TAIL 0xEA
92 #define NANOBEACON_PAYLOAD_READY 0xAA
93 #define NANOBEACON_PACKET_PAYLOAD_SIZE 128
94 #define NANOBEACON_TIMEOUT_MS 3000
95 #define NANOBEACON_CHECK_COMM_NUM_TRIES 5
96 
102 #define NANOBEACON_TX_DRV_BUFFER_SIZE ( NANOBEACON_PACKET_PAYLOAD_SIZE + 4 )
103 #define NANOBEACON_RX_DRV_BUFFER_SIZE ( NANOBEACON_PACKET_PAYLOAD_SIZE + 4 )
104  // nanobeacon_cmd
106 
121 #define NANOBEACON_MAP_MIKROBUS( cfg, mikrobus ) \
122  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
123  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
124  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
125  cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST ); \
126  cfg.dq = MIKROBUS( mikrobus, MIKROBUS_PWM );
127  // nanobeacon_map // nanobeacon
130 
135 typedef struct
136 {
137  uint8_t opcode;
138  uint8_t payload_len;
139  uint8_t payload[ NANOBEACON_PACKET_PAYLOAD_SIZE ];
142 
147 typedef struct
148 {
149  // Output pins
150  digital_out_t en;
151  digital_out_t dq;
153  // Input pins
154  digital_in_t an;
156  // Modules
157  uart_t uart;
159  // Buffers
160  uint8_t uart_rx_buffer[ NANOBEACON_RX_DRV_BUFFER_SIZE ];
161  uint8_t uart_tx_buffer[ NANOBEACON_TX_DRV_BUFFER_SIZE ];
163 } nanobeacon_t;
164 
169 typedef struct
170 {
171  // Communication gpio pins
172  pin_name_t rx_pin;
173  pin_name_t tx_pin;
175  // Additional gpio pins
176  pin_name_t an;
177  pin_name_t en;
178  pin_name_t dq;
180  // Static variable
181  uint32_t baud_rate;
183  uart_data_bits_t data_bit;
184  uart_parity_t parity_bit;
185  uart_stop_bits_t stop_bit;
188 
193 typedef enum
194 {
196  NANOBEACON_ERROR = -1
197 
199 
216 
231 
244 err_t nanobeacon_generic_write ( nanobeacon_t *ctx, uint8_t *data_in, uint16_t len );
245 
258 err_t nanobeacon_generic_read ( nanobeacon_t *ctx, uint8_t *data_out, uint16_t len );
259 
269 
279 void nanobeacon_set_en_pin ( nanobeacon_t *ctx, uint8_t state );
280 
290 void nanobeacon_set_dq_pin ( nanobeacon_t *ctx, uint8_t state );
291 
301 
315 
329 
341 
354 err_t nanobeacon_write_reg ( nanobeacon_t *ctx, uint16_t address, uint32_t data_in );
355 
368 err_t nanobeacon_read_reg ( nanobeacon_t *ctx, uint16_t address, uint32_t *data_out );
369 
382 err_t nanobeacon_write_mem ( nanobeacon_t *ctx, uint16_t address, uint32_t data_in );
383 
396 err_t nanobeacon_read_mem ( nanobeacon_t *ctx, uint16_t address, uint32_t *data_out );
397 
410 err_t nanobeacon_write_efuse ( nanobeacon_t *ctx, uint8_t aid, uint16_t data_in );
411 
424 err_t nanobeacon_read_efuse ( nanobeacon_t *ctx, uint8_t aid, uint16_t *data_out );
425 
438 err_t nanobeacon_set_advertising ( uint8_t *mac_address, uint16_t interval, uint8_t *adv_raw_data, uint8_t len );
439 
451 
463 
464 #ifdef __cplusplus
465 }
466 #endif
467 #endif // NANOBEACON_H
468  // nanobeacon
470 
471 // ------------------------------------------------------------------------ END
nanobeacon_t::dq
digital_out_t dq
Definition: nanobeacon.h:151
nanobeacon_restart_device
void nanobeacon_restart_device(nanobeacon_t *ctx)
NanoBeacon restart device function.
nanobeacon_cfg_t::an
pin_name_t an
Definition: nanobeacon.h:176
nanobeacon_cfg_t::rx_pin
pin_name_t rx_pin
Definition: nanobeacon.h:172
nanobeacon_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: nanobeacon.h:184
nanobeacon_t::en
digital_out_t en
Definition: nanobeacon.h:150
nanobeacon_packet_t
NanoBeacon Click packet object.
Definition: nanobeacon.h:136
nanobeacon_return_value_t
nanobeacon_return_value_t
NanoBeacon Click return value data.
Definition: nanobeacon.h:194
nanobeacon_set_en_pin
void nanobeacon_set_en_pin(nanobeacon_t *ctx, uint8_t state)
NanoBeacon set EN pin function.
nanobeacon_init
err_t nanobeacon_init(nanobeacon_t *ctx, nanobeacon_cfg_t *cfg)
NanoBeacon initialization function.
nanobeacon_set_advertising
err_t nanobeacon_set_advertising(uint8_t *mac_address, uint16_t interval, uint8_t *adv_raw_data, uint8_t len)
NanoBeacon set advertising function.
nanobeacon_cfg_t::en
pin_name_t en
Definition: nanobeacon.h:177
nanobeacon_check_communication
err_t nanobeacon_check_communication(nanobeacon_t *ctx)
NanoBeacon check communication function.
nanobeacon_cfg_t
NanoBeacon Click configuration object.
Definition: nanobeacon.h:170
nanobeacon_write_mem
err_t nanobeacon_write_mem(nanobeacon_t *ctx, uint16_t address, uint32_t data_in)
NanoBeacon write mem function.
nanobeacon_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: nanobeacon.h:185
nanobeacon_t::uart
uart_t uart
Definition: nanobeacon.h:157
NANOBEACON_RX_DRV_BUFFER_SIZE
#define NANOBEACON_RX_DRV_BUFFER_SIZE
Definition: nanobeacon.h:103
nanobeacon_cfg_t::dq
pin_name_t dq
Definition: nanobeacon.h:178
NANOBEACON_OK
@ NANOBEACON_OK
Definition: nanobeacon.h:195
nanobeacon_cfg_setup
void nanobeacon_cfg_setup(nanobeacon_cfg_t *cfg)
NanoBeacon configuration object setup function.
nanobeacon_write_reg
err_t nanobeacon_write_reg(nanobeacon_t *ctx, uint16_t address, uint32_t data_in)
NanoBeacon write reg function.
nanobeacon_set_dq_pin
void nanobeacon_set_dq_pin(nanobeacon_t *ctx, uint8_t state)
NanoBeacon set DQ pin function.
nanobeacon_generic_write
err_t nanobeacon_generic_write(nanobeacon_t *ctx, uint8_t *data_in, uint16_t len)
NanoBeacon data writing function.
nanobeacon_send_packet
err_t nanobeacon_send_packet(nanobeacon_t *ctx, nanobeacon_packet_t pkt_in)
NanoBeacon send packet function.
NANOBEACON_ERROR
@ NANOBEACON_ERROR
Definition: nanobeacon.h:196
nanobeacon_generic_read
err_t nanobeacon_generic_read(nanobeacon_t *ctx, uint8_t *data_out, uint16_t len)
NanoBeacon data reading function.
nanobeacon_read_mem
err_t nanobeacon_read_mem(nanobeacon_t *ctx, uint16_t address, uint32_t *data_out)
NanoBeacon read mem function.
nanobeacon_packet_t::payload_len
uint8_t payload_len
Definition: nanobeacon.h:138
nanobeacon_read_efuse
err_t nanobeacon_read_efuse(nanobeacon_t *ctx, uint8_t aid, uint16_t *data_out)
NanoBeacon read efuse function.
nanobeacon_read_packet
err_t nanobeacon_read_packet(nanobeacon_t *ctx, nanobeacon_packet_t *pkt_out)
NanoBeacon read packet function.
nanobeacon_load_adv_to_ram
err_t nanobeacon_load_adv_to_ram(nanobeacon_t *ctx)
NanoBeacon load adv to ram function.
nanobeacon_cfg_t::uart_blocking
bool uart_blocking
Definition: nanobeacon.h:182
nanobeacon_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: nanobeacon.h:183
nanobeacon_cfg_t::tx_pin
pin_name_t tx_pin
Definition: nanobeacon.h:173
nanobeacon_cfg_t::baud_rate
uint32_t baud_rate
Definition: nanobeacon.h:181
NANOBEACON_TX_DRV_BUFFER_SIZE
#define NANOBEACON_TX_DRV_BUFFER_SIZE
NanoBeacon driver buffer size.
Definition: nanobeacon.h:102
nanobeacon_packet_t::opcode
uint8_t opcode
Definition: nanobeacon.h:137
nanobeacon_t
NanoBeacon Click context object.
Definition: nanobeacon.h:148
nanobeacon_get_an_pin
uint8_t nanobeacon_get_an_pin(nanobeacon_t *ctx)
NanoBeacon get an pin function.
nanobeacon_read_reg
err_t nanobeacon_read_reg(nanobeacon_t *ctx, uint16_t address, uint32_t *data_out)
NanoBeacon read reg function.
nanobeacon_write_efuse
err_t nanobeacon_write_efuse(nanobeacon_t *ctx, uint8_t aid, uint16_t data_in)
NanoBeacon write efuse function.
nanobeacon_start_advertising
err_t nanobeacon_start_advertising(nanobeacon_t *ctx)
NanoBeacon start advertising function.
NANOBEACON_PACKET_PAYLOAD_SIZE
#define NANOBEACON_PACKET_PAYLOAD_SIZE
Definition: nanobeacon.h:93
nanobeacon_t::an
digital_in_t an
Definition: nanobeacon.h:154