xbee2  2.1.0.0
xbee2.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 XBEE2_H
29 #define XBEE2_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 XBEE2_ENTER_CMD_MODE "+++"
70 #define XBEE2_EXIT_CMD_MODE "CN"
71 #define XBEE2_FACTORY_RESET "RE"
72 #define XBEE2_SET_NODE_IDENTIFIER "NI"
73 #define XBEE2_GET_SERIAL_NUMBER "SH,SL"
74 #define XBEE2_SET_DEST_ADDR_HIGH "DH"
75 #define XBEE2_SET_DEST_ADDR_LOW "DL"
76 #define XBEE2_APPLY_CHANGES "AC"
77 #define XBEE2_API_MODE "AP"
78 #define XBEE2_DEV_ROLE "CE"
79 #define XBEE2_SAVE_CHANGES "WR"
80 #define XBEE2_CMD_AT "AT"
81 #define XBEE2_DELIMITER ","
82 #define XBEE2_CARRIAGE_RETURN "\r"
83 
88 #define XBEE2_MODE_TRANSPARENT 0
89 #define XBEE2_MODE_API_WITHOUT_ESC 1
90 #define XBEE2_MODE_API_WITH_ESC 2
91 
96 #define XBEE2_DEVICE_ROLE_JOIN_NETWORK 0
97 #define XBEE2_DEVICE_ROLE_FORM_NETWORK 1
98 
103 #define XBEE2_BROADCAST_DEST_ADDRESS_HIGH "00000000"
104 #define XBEE2_BROADCAST_DEST_ADDRESS_LOW "0000FFFF"
105 
110 #define XBEE2_RSP_OK "OK"
111 #define XBEE2_RSP_ERROR "ERROR"
112 
118 #define DRV_BUFFER_SIZE 200
119  // xbee2_cmd
121 
136 #define XBEE2_MAP_MIKROBUS( cfg, mikrobus ) \
137  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
138  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
139  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_AN ); \
140  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
141  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
142  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
143  cfg.att_dtr = MIKROBUS( mikrobus, MIKROBUS_INT );
144  // xbee2_map // xbee2
147 
152 typedef struct
153 {
154  // Output pins
155  digital_out_t rts;
156  digital_out_t rst;
157  digital_out_t cs;
159  // Input pins
160  digital_in_t cts;
161  digital_in_t att_dtr;
163  // Modules
164  uart_t uart;
166  // Buffers
167  char uart_rx_buffer[ DRV_BUFFER_SIZE ];
168  char uart_tx_buffer[ DRV_BUFFER_SIZE ];
170 } xbee2_t;
171 
176 typedef struct
177 {
178  // Communication gpio pins
179  pin_name_t rx_pin;
180  pin_name_t tx_pin;
182  // Additional gpio pins
183  pin_name_t rts;
184  pin_name_t rst;
185  pin_name_t cs;
186  pin_name_t cts;
187  pin_name_t att_dtr;
189  // Static variable
190  uint32_t baud_rate;
192  uart_data_bits_t data_bit;
193  uart_parity_t parity_bit;
194  uart_stop_bits_t stop_bit;
196 } xbee2_cfg_t;
197 
202 typedef enum
203 {
204  XBEE2_OK = 0,
205  XBEE2_ERROR = -1
206 
208 
225 
239 err_t xbee2_init ( xbee2_t *ctx, xbee2_cfg_t *cfg );
240 
253 err_t xbee2_generic_write ( xbee2_t *ctx, char *data_in, uint16_t len );
254 
267 err_t xbee2_generic_read ( xbee2_t *ctx, char *data_out, uint16_t len );
268 
278 void xbee2_set_rts_pin ( xbee2_t *ctx, uint8_t state );
279 
289 void xbee2_set_rst_pin ( xbee2_t *ctx, uint8_t state );
290 
300 void xbee2_set_cs_pin ( xbee2_t *ctx, uint8_t state );
301 
310 uint8_t xbee2_get_cts_pin ( xbee2_t *ctx );
311 
322 
334 err_t xbee2_write_command ( xbee2_t *ctx, char *data_buf );
335 
344 void xbee2_hw_reset ( xbee2_t *ctx );
345 
357 
369 
381 
393 
405 err_t xbee2_set_device_name ( xbee2_t *ctx, char *dev_name );
406 
419 err_t xbee2_set_destination_address ( xbee2_t *ctx, char *dest_addr_high, char *dest_addr_low );
420 
434 err_t xbee2_set_api_mode ( xbee2_t *ctx, uint8_t api_mode );
435 
448 err_t xbee2_set_device_role ( xbee2_t *ctx, uint8_t dev_role );
449 
461 
473 
474 #ifdef __cplusplus
475 }
476 #endif
477 #endif // XBEE2_H
478  // xbee2
480 
481 // ------------------------------------------------------------------------ END
xbee2_hw_reset
void xbee2_hw_reset(xbee2_t *ctx)
XBEE 2 hw reset function.
xbee2_cfg_t::rx_pin
pin_name_t rx_pin
Definition: xbee2.h:179
xbee2_generic_read
err_t xbee2_generic_read(xbee2_t *ctx, char *data_out, uint16_t len)
XBEE 2 data reading function.
xbee2_set_device_role
err_t xbee2_set_device_role(xbee2_t *ctx, uint8_t dev_role)
XBEE 2 set device role function.
xbee2_enter_command_mode
err_t xbee2_enter_command_mode(xbee2_t *ctx)
XBEE 2 enter command mode function.
XBEE2_OK
@ XBEE2_OK
Definition: xbee2.h:204
xbee2_t::uart
uart_t uart
Definition: xbee2.h:164
xbee2_exit_command_mode
err_t xbee2_exit_command_mode(xbee2_t *ctx)
XBEE 2 exit command mode function.
xbee2_cfg_t
XBEE 2 Click configuration object.
Definition: xbee2.h:177
xbee2_t::cs
digital_out_t cs
Definition: xbee2.h:157
xbee2_set_rts_pin
void xbee2_set_rts_pin(xbee2_t *ctx, uint8_t state)
XBEE 2 set rts pin function.
xbee2_write_command
err_t xbee2_write_command(xbee2_t *ctx, char *data_buf)
XBEE 2 write command function.
xbee2_save_changes
err_t xbee2_save_changes(xbee2_t *ctx)
XBEE 2 save changes function.
xbee2_set_cs_pin
void xbee2_set_cs_pin(xbee2_t *ctx, uint8_t state)
XBEE 2 set cs pin function.
xbee2_cfg_t::cs
pin_name_t cs
Definition: xbee2.h:185
xbee2_init
err_t xbee2_init(xbee2_t *ctx, xbee2_cfg_t *cfg)
XBEE 2 initialization function.
xbee2_apply_changes
err_t xbee2_apply_changes(xbee2_t *ctx)
XBEE 2 apply changes function.
xbee2_t::att_dtr
digital_in_t att_dtr
Definition: xbee2.h:161
DRV_BUFFER_SIZE
#define DRV_BUFFER_SIZE
XBEE 2 driver buffer size.
Definition: xbee2.h:118
xbee2_cfg_t::uart_blocking
bool uart_blocking
Definition: xbee2.h:191
xbee2_cfg_t::tx_pin
pin_name_t tx_pin
Definition: xbee2.h:180
XBEE2_ERROR
@ XBEE2_ERROR
Definition: xbee2.h:205
xbee2_cfg_setup
void xbee2_cfg_setup(xbee2_cfg_t *cfg)
XBEE 2 configuration object setup function.
xbee2_get_serial_number
err_t xbee2_get_serial_number(xbee2_t *ctx)
XBEE 2 get serial number function.
xbee2_cfg_t::baud_rate
uint32_t baud_rate
Definition: xbee2.h:190
xbee2_t
XBEE 2 Click context object.
Definition: xbee2.h:153
xbee2_get_cts_pin
uint8_t xbee2_get_cts_pin(xbee2_t *ctx)
XBEE 2 get cts pin function.
xbee2_set_api_mode
err_t xbee2_set_api_mode(xbee2_t *ctx, uint8_t api_mode)
XBEE 2 set api mode function.
xbee2_t::rts
digital_out_t rts
Definition: xbee2.h:155
xbee2_get_att_dtr_pin
uint8_t xbee2_get_att_dtr_pin(xbee2_t *ctx)
XBEE 2 get att_dtr pin function.
xbee2_cfg_t::rts
pin_name_t rts
Definition: xbee2.h:183
xbee2_t::rst
digital_out_t rst
Definition: xbee2.h:156
xbee2_return_value_t
xbee2_return_value_t
XBEE 2 Click return value data.
Definition: xbee2.h:203
xbee2_set_device_name
err_t xbee2_set_device_name(xbee2_t *ctx, char *dev_name)
XBEE 2 set device name function.
xbee2_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: xbee2.h:194
xbee2_set_rst_pin
void xbee2_set_rst_pin(xbee2_t *ctx, uint8_t state)
XBEE 2 set rst pin function.
xbee2_cfg_t::att_dtr
pin_name_t att_dtr
Definition: xbee2.h:187
xbee2_cfg_t::rst
pin_name_t rst
Definition: xbee2.h:184
xbee2_set_destination_address
err_t xbee2_set_destination_address(xbee2_t *ctx, char *dest_addr_high, char *dest_addr_low)
XBEE 2 set destination address function.
xbee2_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: xbee2.h:193
xbee2_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: xbee2.h:192
xbee2_generic_write
err_t xbee2_generic_write(xbee2_t *ctx, char *data_in, uint16_t len)
XBEE 2 data writing function.
xbee2_t::cts
digital_in_t cts
Definition: xbee2.h:160
xbee2_factory_reset
err_t xbee2_factory_reset(xbee2_t *ctx)
XBEE 2 factory reset function.
xbee2_cfg_t::cts
pin_name_t cts
Definition: xbee2.h:186