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 "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_uart.h"
38 
59 #define XBEE3_ENTER_CMD_MODE "+++"
60 #define XBEE3_EXIT_CMD_MODE "CN"
61 #define XBEE3_FACTORY_RESET "RE"
62 #define XBEE3_SET_NODE_IDENTIFIER "NI"
63 #define XBEE3_GET_SERIAL_NUMBER "SH,SL"
64 #define XBEE3_SET_DEST_ADDR_HIGH "DH"
65 #define XBEE3_SET_DEST_ADDR_LOW "DL"
66 #define XBEE3_APPLY_CHANGES "AC"
67 #define XBEE3_API_MODE "AP"
68 #define XBEE3_SAVE_CHANGES "WR"
69 #define XBEE3_CMD_AT "AT"
70 #define XBEE3_DELIMITER ","
71 #define XBEE3_CARRIAGE_RETURN "\r"
72 
77 #define XBEE3_MODE_TRANSPARENT 0
78 #define XBEE3_MODE_API_WITHOUT_ESC 1
79 #define XBEE3_MODE_API_WITH_ESC 2
80 
85 #define XBEE3_BROADCAST_DEST_ADDRESS_HIGH "00000000"
86 #define XBEE3_BROADCAST_DEST_ADDRESS_LOW "0000FFFF"
87 
92 #define XBEE3_RSP_OK "OK"
93 #define XBEE3_RSP_ERROR "ERROR"
94 
100 #define DRV_BUFFER_SIZE 200
101  // xbee3_cmd
103 
118 #define XBEE3_MAP_MIKROBUS( cfg, mikrobus ) \
119  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
120  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
121  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_AN ); \
122  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
123  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
124  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
125  cfg.att_dtr = MIKROBUS( mikrobus, MIKROBUS_INT );
126  // xbee3_map // xbee3
129 
134 typedef struct
135 {
136  // Output pins
137  digital_out_t rts;
138  digital_out_t rst;
139  digital_out_t cs;
141  // Input pins
142  digital_in_t cts;
143  digital_in_t att_dtr;
145  // Modules
146  uart_t uart;
148  // Buffers
149  char uart_rx_buffer[ DRV_BUFFER_SIZE ];
150  char uart_tx_buffer[ DRV_BUFFER_SIZE ];
152 } xbee3_t;
153 
158 typedef struct
159 {
160  // Communication gpio pins
161  pin_name_t rx_pin;
162  pin_name_t tx_pin;
164  // Additional gpio pins
165  pin_name_t rts;
166  pin_name_t rst;
167  pin_name_t cs;
168  pin_name_t cts;
169  pin_name_t att_dtr;
171  // Static variable
172  uint32_t baud_rate;
174  uart_data_bits_t data_bit;
175  uart_parity_t parity_bit;
176  uart_stop_bits_t stop_bit;
178 } xbee3_cfg_t;
179 
184 typedef enum
185 {
186  XBEE3_OK = 0,
187  XBEE3_ERROR = -1
188 
190 
207 
221 err_t xbee3_init ( xbee3_t *ctx, xbee3_cfg_t *cfg );
222 
235 err_t xbee3_generic_write ( xbee3_t *ctx, char *data_in, uint16_t len );
236 
249 err_t xbee3_generic_read ( xbee3_t *ctx, char *data_out, uint16_t len );
250 
260 void xbee3_set_rts_pin ( xbee3_t *ctx, uint8_t state );
261 
271 void xbee3_set_rst_pin ( xbee3_t *ctx, uint8_t state );
272 
282 void xbee3_set_cs_pin ( xbee3_t *ctx, uint8_t state );
283 
292 uint8_t xbee3_get_cts_pin ( xbee3_t *ctx );
293 
304 
316 err_t xbee3_write_command ( xbee3_t *ctx, char *data_buf );
317 
326 void xbee3_hw_reset ( xbee3_t *ctx );
327 
339 
351 
363 
375 
387 err_t xbee3_set_device_name ( xbee3_t *ctx, char *dev_name );
388 
401 err_t xbee3_set_destination_address ( xbee3_t *ctx, char *dest_addr_high, char *dest_addr_low );
402 
416 err_t xbee3_set_api_mode ( xbee3_t *ctx, uint8_t api_mode );
417 
429 
441 
442 #ifdef __cplusplus
443 }
444 #endif
445 #endif // XBEE3_H
446  // xbee3
448 
449 // ------------------------------------------------------------------------ END
xbee3_cfg_t::baud_rate
uint32_t baud_rate
Definition: xbee3.h:172
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:176
xbee3_cfg_t::rx_pin
pin_name_t rx_pin
Definition: xbee3.h:161
xbee3_t::cs
digital_out_t cs
Definition: xbee3.h:139
xbee3_return_value_t
xbee3_return_value_t
XBEE 3 Click return value data.
Definition: xbee3.h:185
xbee3_t::cts
digital_in_t cts
Definition: xbee3.h:142
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:174
xbee3_cfg_t::cts
pin_name_t cts
Definition: xbee3.h:168
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:159
xbee3_cfg_t::uart_blocking
bool uart_blocking
Definition: xbee3.h:173
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:137
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:162
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:146
DRV_BUFFER_SIZE
#define DRV_BUFFER_SIZE
XBEE 3 driver buffer size.
Definition: xbee3.h:100
xbee3_cfg_t::rst
pin_name_t rst
Definition: xbee3.h:166
xbee3_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: xbee3.h:175
xbee3_cfg_t::rts
pin_name_t rts
Definition: xbee3.h:165
XBEE3_ERROR
@ XBEE3_ERROR
Definition: xbee3.h:187
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:169
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:167
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:186
xbee3_t::att_dtr
digital_in_t att_dtr
Definition: xbee3.h:143
xbee3_t
XBEE 3 Click context object.
Definition: xbee3.h:135
xbee3_t::rst
digital_out_t rst
Definition: xbee3.h:138