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 "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_uart.h"
38 
59 #define XBEE2_ENTER_CMD_MODE "+++"
60 #define XBEE2_EXIT_CMD_MODE "CN"
61 #define XBEE2_FACTORY_RESET "RE"
62 #define XBEE2_SET_NODE_IDENTIFIER "NI"
63 #define XBEE2_GET_SERIAL_NUMBER "SH,SL"
64 #define XBEE2_SET_DEST_ADDR_HIGH "DH"
65 #define XBEE2_SET_DEST_ADDR_LOW "DL"
66 #define XBEE2_APPLY_CHANGES "AC"
67 #define XBEE2_API_MODE "AP"
68 #define XBEE2_DEV_ROLE "CE"
69 #define XBEE2_SAVE_CHANGES "WR"
70 #define XBEE2_CMD_AT "AT"
71 #define XBEE2_DELIMITER ","
72 #define XBEE2_CARRIAGE_RETURN "\r"
73 
78 #define XBEE2_MODE_TRANSPARENT 0
79 #define XBEE2_MODE_API_WITHOUT_ESC 1
80 #define XBEE2_MODE_API_WITH_ESC 2
81 
86 #define XBEE2_DEVICE_ROLE_JOIN_NETWORK 0
87 #define XBEE2_DEVICE_ROLE_FORM_NETWORK 1
88 
93 #define XBEE2_BROADCAST_DEST_ADDRESS_HIGH "00000000"
94 #define XBEE2_BROADCAST_DEST_ADDRESS_LOW "0000FFFF"
95 
100 #define XBEE2_RSP_OK "OK"
101 #define XBEE2_RSP_ERROR "ERROR"
102 
108 #define DRV_BUFFER_SIZE 200
109  // xbee2_cmd
111 
126 #define XBEE2_MAP_MIKROBUS( cfg, mikrobus ) \
127  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
128  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
129  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_AN ); \
130  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
131  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
132  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
133  cfg.att_dtr = MIKROBUS( mikrobus, MIKROBUS_INT );
134  // xbee2_map // xbee2
137 
142 typedef struct
143 {
144  // Output pins
145  digital_out_t rts;
146  digital_out_t rst;
147  digital_out_t cs;
149  // Input pins
150  digital_in_t cts;
151  digital_in_t att_dtr;
153  // Modules
154  uart_t uart;
156  // Buffers
157  char uart_rx_buffer[ DRV_BUFFER_SIZE ];
158  char uart_tx_buffer[ DRV_BUFFER_SIZE ];
160 } xbee2_t;
161 
166 typedef struct
167 {
168  // Communication gpio pins
169  pin_name_t rx_pin;
170  pin_name_t tx_pin;
172  // Additional gpio pins
173  pin_name_t rts;
174  pin_name_t rst;
175  pin_name_t cs;
176  pin_name_t cts;
177  pin_name_t att_dtr;
179  // Static variable
180  uint32_t baud_rate;
182  uart_data_bits_t data_bit;
183  uart_parity_t parity_bit;
184  uart_stop_bits_t stop_bit;
186 } xbee2_cfg_t;
187 
192 typedef enum
193 {
194  XBEE2_OK = 0,
195  XBEE2_ERROR = -1
196 
198 
215 
229 err_t xbee2_init ( xbee2_t *ctx, xbee2_cfg_t *cfg );
230 
243 err_t xbee2_generic_write ( xbee2_t *ctx, char *data_in, uint16_t len );
244 
257 err_t xbee2_generic_read ( xbee2_t *ctx, char *data_out, uint16_t len );
258 
268 void xbee2_set_rts_pin ( xbee2_t *ctx, uint8_t state );
269 
279 void xbee2_set_rst_pin ( xbee2_t *ctx, uint8_t state );
280 
290 void xbee2_set_cs_pin ( xbee2_t *ctx, uint8_t state );
291 
300 uint8_t xbee2_get_cts_pin ( xbee2_t *ctx );
301 
312 
324 err_t xbee2_write_command ( xbee2_t *ctx, char *data_buf );
325 
334 void xbee2_hw_reset ( xbee2_t *ctx );
335 
347 
359 
371 
383 
395 err_t xbee2_set_device_name ( xbee2_t *ctx, char *dev_name );
396 
409 err_t xbee2_set_destination_address ( xbee2_t *ctx, char *dest_addr_high, char *dest_addr_low );
410 
424 err_t xbee2_set_api_mode ( xbee2_t *ctx, uint8_t api_mode );
425 
438 err_t xbee2_set_device_role ( xbee2_t *ctx, uint8_t dev_role );
439 
451 
463 
464 #ifdef __cplusplus
465 }
466 #endif
467 #endif // XBEE2_H
468  // xbee2
470 
471 // ------------------------------------------------------------------------ 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:169
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:194
xbee2_t::uart
uart_t uart
Definition: xbee2.h:154
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:167
xbee2_t::cs
digital_out_t cs
Definition: xbee2.h:147
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:175
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:151
DRV_BUFFER_SIZE
#define DRV_BUFFER_SIZE
XBEE 2 driver buffer size.
Definition: xbee2.h:108
xbee2_cfg_t::uart_blocking
bool uart_blocking
Definition: xbee2.h:181
xbee2_cfg_t::tx_pin
pin_name_t tx_pin
Definition: xbee2.h:170
XBEE2_ERROR
@ XBEE2_ERROR
Definition: xbee2.h:195
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:180
xbee2_t
XBEE 2 Click context object.
Definition: xbee2.h:143
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:145
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:173
xbee2_t::rst
digital_out_t rst
Definition: xbee2.h:146
xbee2_return_value_t
xbee2_return_value_t
XBEE 2 Click return value data.
Definition: xbee2.h:193
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:184
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:177
xbee2_cfg_t::rst
pin_name_t rst
Definition: xbee2.h:174
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:183
xbee2_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: xbee2.h:182
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:150
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:176