xbee3  2.1.0.0
xbee3.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 XBEE3_H
29 #define XBEE3_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 XBEE3_ENTER_CMD_MODE "+++"
70 #define XBEE3_EXIT_CMD_MODE "CN"
71 #define XBEE3_FACTORY_RESET "RE"
72 #define XBEE3_SET_NODE_IDENTIFIER "NI"
73 #define XBEE3_GET_SERIAL_NUMBER "SH,SL"
74 #define XBEE3_SET_DEST_ADDR_HIGH "DH"
75 #define XBEE3_SET_DEST_ADDR_LOW "DL"
76 #define XBEE3_APPLY_CHANGES "AC"
77 #define XBEE3_API_MODE "AP"
78 #define XBEE3_SAVE_CHANGES "WR"
79 #define XBEE3_CMD_AT "AT"
80 #define XBEE3_DELIMITER ","
81 #define XBEE3_CARRIAGE_RETURN "\r"
82 
87 #define XBEE3_MODE_TRANSPARENT 0
88 #define XBEE3_MODE_API_WITHOUT_ESC 1
89 #define XBEE3_MODE_API_WITH_ESC 2
90 
95 #define XBEE3_BROADCAST_DEST_ADDRESS_HIGH "00000000"
96 #define XBEE3_BROADCAST_DEST_ADDRESS_LOW "0000FFFF"
97 
102 #define XBEE3_RSP_OK "OK"
103 #define XBEE3_RSP_ERROR "ERROR"
104 
110 #define DRV_BUFFER_SIZE 200
111  // xbee3_cmd
113 
128 #define XBEE3_MAP_MIKROBUS( cfg, mikrobus ) \
129  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
130  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
131  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_AN ); \
132  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
133  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
134  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
135  cfg.att_dtr = MIKROBUS( mikrobus, MIKROBUS_INT );
136  // xbee3_map // xbee3
139 
144 typedef struct
145 {
146  // Output pins
147  digital_out_t rts;
148  digital_out_t rst;
149  digital_out_t cs;
151  // Input pins
152  digital_in_t cts;
153  digital_in_t att_dtr;
155  // Modules
156  uart_t uart;
158  // Buffers
159  char uart_rx_buffer[ DRV_BUFFER_SIZE ];
160  char uart_tx_buffer[ DRV_BUFFER_SIZE ];
162 } xbee3_t;
163 
168 typedef struct
169 {
170  // Communication gpio pins
171  pin_name_t rx_pin;
172  pin_name_t tx_pin;
174  // Additional gpio pins
175  pin_name_t rts;
176  pin_name_t rst;
177  pin_name_t cs;
178  pin_name_t cts;
179  pin_name_t att_dtr;
181  // Static variable
182  uint32_t baud_rate;
184  uart_data_bits_t data_bit;
185  uart_parity_t parity_bit;
186  uart_stop_bits_t stop_bit;
188 } xbee3_cfg_t;
189 
194 typedef enum
195 {
196  XBEE3_OK = 0,
197  XBEE3_ERROR = -1
198 
200 
217 
231 err_t xbee3_init ( xbee3_t *ctx, xbee3_cfg_t *cfg );
232 
245 err_t xbee3_generic_write ( xbee3_t *ctx, char *data_in, uint16_t len );
246 
259 err_t xbee3_generic_read ( xbee3_t *ctx, char *data_out, uint16_t len );
260 
270 void xbee3_set_rts_pin ( xbee3_t *ctx, uint8_t state );
271 
281 void xbee3_set_rst_pin ( xbee3_t *ctx, uint8_t state );
282 
292 void xbee3_set_cs_pin ( xbee3_t *ctx, uint8_t state );
293 
302 uint8_t xbee3_get_cts_pin ( xbee3_t *ctx );
303 
314 
326 err_t xbee3_write_command ( xbee3_t *ctx, char *data_buf );
327 
336 void xbee3_hw_reset ( xbee3_t *ctx );
337 
349 
361 
373 
385 
397 err_t xbee3_set_device_name ( xbee3_t *ctx, char *dev_name );
398 
411 err_t xbee3_set_destination_address ( xbee3_t *ctx, char *dest_addr_high, char *dest_addr_low );
412 
426 err_t xbee3_set_api_mode ( xbee3_t *ctx, uint8_t api_mode );
427 
439 
451 
452 #ifdef __cplusplus
453 }
454 #endif
455 #endif // XBEE3_H
456  // xbee3
458 
459 // ------------------------------------------------------------------------ END
xbee3_cfg_t::baud_rate
uint32_t baud_rate
Definition: xbee3.h:182
xbee3_init
err_t xbee3_init(xbee3_t *ctx, xbee3_cfg_t *cfg)
XBEE 3 initialization function.
xbee3_save_changes
err_t xbee3_save_changes(xbee3_t *ctx)
XBEE 3 save changes function.
xbee3_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: xbee3.h:186
xbee3_cfg_t::rx_pin
pin_name_t rx_pin
Definition: xbee3.h:171
xbee3_t::cs
digital_out_t cs
Definition: xbee3.h:149
xbee3_return_value_t
xbee3_return_value_t
XBEE 3 Click return value data.
Definition: xbee3.h:195
xbee3_t::cts
digital_in_t cts
Definition: xbee3.h:152
xbee3_get_serial_number
err_t xbee3_get_serial_number(xbee3_t *ctx)
XBEE 3 get serial number function.
xbee3_set_cs_pin
void xbee3_set_cs_pin(xbee3_t *ctx, uint8_t state)
XBEE 3 set cs pin function.
xbee3_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: xbee3.h:184
xbee3_cfg_t::cts
pin_name_t cts
Definition: xbee3.h:178
xbee3_cfg_setup
void xbee3_cfg_setup(xbee3_cfg_t *cfg)
XBEE 3 configuration object setup function.
xbee3_exit_command_mode
err_t xbee3_exit_command_mode(xbee3_t *ctx)
XBEE 3 exit command mode function.
xbee3_cfg_t
XBEE 3 Click configuration object.
Definition: xbee3.h:169
xbee3_cfg_t::uart_blocking
bool uart_blocking
Definition: xbee3.h:183
xbee3_generic_read
err_t xbee3_generic_read(xbee3_t *ctx, char *data_out, uint16_t len)
XBEE 3 data reading function.
xbee3_get_att_dtr_pin
uint8_t xbee3_get_att_dtr_pin(xbee3_t *ctx)
XBEE 3 get att_dtr pin function.
xbee3_apply_changes
err_t xbee3_apply_changes(xbee3_t *ctx)
XBEE 3 apply changes function.
xbee3_t::rts
digital_out_t rts
Definition: xbee3.h:147
xbee3_get_cts_pin
uint8_t xbee3_get_cts_pin(xbee3_t *ctx)
XBEE 3 get cts pin function.
xbee3_cfg_t::tx_pin
pin_name_t tx_pin
Definition: xbee3.h:172
xbee3_set_device_name
err_t xbee3_set_device_name(xbee3_t *ctx, char *dev_name)
XBEE 3 set device name function.
xbee3_t::uart
uart_t uart
Definition: xbee3.h:156
DRV_BUFFER_SIZE
#define DRV_BUFFER_SIZE
XBEE 3 driver buffer size.
Definition: xbee3.h:110
xbee3_cfg_t::rst
pin_name_t rst
Definition: xbee3.h:176
xbee3_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: xbee3.h:185
xbee3_cfg_t::rts
pin_name_t rts
Definition: xbee3.h:175
XBEE3_ERROR
@ XBEE3_ERROR
Definition: xbee3.h:197
xbee3_set_rst_pin
void xbee3_set_rst_pin(xbee3_t *ctx, uint8_t state)
XBEE 3 set rst pin function.
xbee3_set_rts_pin
void xbee3_set_rts_pin(xbee3_t *ctx, uint8_t state)
XBEE 3 set rts pin function.
xbee3_hw_reset
void xbee3_hw_reset(xbee3_t *ctx)
XBEE 3 hw reset function.
xbee3_set_api_mode
err_t xbee3_set_api_mode(xbee3_t *ctx, uint8_t api_mode)
XBEE 3 set api mode function.
xbee3_cfg_t::att_dtr
pin_name_t att_dtr
Definition: xbee3.h:179
xbee3_generic_write
err_t xbee3_generic_write(xbee3_t *ctx, char *data_in, uint16_t len)
XBEE 3 data writing function.
xbee3_cfg_t::cs
pin_name_t cs
Definition: xbee3.h:177
xbee3_factory_reset
err_t xbee3_factory_reset(xbee3_t *ctx)
XBEE 3 factory reset function.
xbee3_write_command
err_t xbee3_write_command(xbee3_t *ctx, char *data_buf)
XBEE 3 write command function.
xbee3_set_destination_address
err_t xbee3_set_destination_address(xbee3_t *ctx, char *dest_addr_high, char *dest_addr_low)
XBEE 3 set destination address function.
xbee3_enter_command_mode
err_t xbee3_enter_command_mode(xbee3_t *ctx)
XBEE 3 enter command mode function.
XBEE3_OK
@ XBEE3_OK
Definition: xbee3.h:196
xbee3_t::att_dtr
digital_in_t att_dtr
Definition: xbee3.h:153
xbee3_t
XBEE 3 Click context object.
Definition: xbee3.h:145
xbee3_t::rst
digital_out_t rst
Definition: xbee3.h:148