xbee3.h File Reference

This file contains API for XBEE 3 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"

Go to the source code of this file.

Data Structures
struct	xbee3_t
	XBEE 3 Click context object. More...
struct	xbee3_cfg_t
	XBEE 3 Click configuration object. More...

Macros
#define	XBEE3_ENTER_CMD_MODE   "+++"
	XBEE 3 list of AT commands.
#define	XBEE3_EXIT_CMD_MODE   "CN"
#define	XBEE3_FACTORY_RESET   "RE"
#define	XBEE3_SET_NODE_IDENTIFIER   "NI"
#define	XBEE3_GET_SERIAL_NUMBER   "SH,SL"
#define	XBEE3_SET_DEST_ADDR_HIGH   "DH"
#define	XBEE3_SET_DEST_ADDR_LOW   "DL"
#define	XBEE3_APPLY_CHANGES   "AC"
#define	XBEE3_API_MODE   "AP"
#define	XBEE3_SAVE_CHANGES   "WR"
#define	XBEE3_CMD_AT   "AT"
#define	XBEE3_DELIMITER   ","
#define	XBEE3_CARRIAGE_RETURN   "\r"
#define	XBEE3_MODE_TRANSPARENT   0
	XBEE 3 mode settings.
#define	XBEE3_MODE_API_WITHOUT_ESC   1
#define	XBEE3_MODE_API_WITH_ESC   2
#define	XBEE3_BROADCAST_DEST_ADDRESS_HIGH   "00000000"
	XBEE 3 destination address settings.
#define	XBEE3_BROADCAST_DEST_ADDRESS_LOW   "0000FFFF"
#define	XBEE3_RSP_OK   "OK"
	XBEE 3 device response for AT commands.
#define	XBEE3_RSP_ERROR   "ERROR"
#define	DRV_BUFFER_SIZE   200
	XBEE 3 driver buffer size.
#define	XBEE3_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	xbee3_return_value_t { XBEE3_OK = 0 , XBEE3_ERROR = -1 }
	XBEE 3 Click return value data. More...

Functions
void	xbee3_cfg_setup (xbee3_cfg_t *cfg)
	XBEE 3 configuration object setup function.
err_t	xbee3_init (xbee3_t *ctx, xbee3_cfg_t *cfg)
	XBEE 3 initialization function.
err_t	xbee3_generic_write (xbee3_t *ctx, char *data_in, uint16_t len)
	XBEE 3 data writing function.
err_t	xbee3_generic_read (xbee3_t *ctx, char *data_out, uint16_t len)
	XBEE 3 data reading function.
void	xbee3_set_rts_pin (xbee3_t *ctx, uint8_t state)
	XBEE 3 set rts pin function.
void	xbee3_set_rst_pin (xbee3_t *ctx, uint8_t state)
	XBEE 3 set rst pin function.
void	xbee3_set_cs_pin (xbee3_t *ctx, uint8_t state)
	XBEE 3 set cs pin function.
uint8_t	xbee3_get_cts_pin (xbee3_t *ctx)
	XBEE 3 get cts pin function.
uint8_t	xbee3_get_att_dtr_pin (xbee3_t *ctx)
	XBEE 3 get att_dtr pin function.
err_t	xbee3_write_command (xbee3_t *ctx, char *data_buf)
	XBEE 3 write command function.
void	xbee3_hw_reset (xbee3_t *ctx)
	XBEE 3 hw reset function.
err_t	xbee3_enter_command_mode (xbee3_t *ctx)
	XBEE 3 enter command mode function.
err_t	xbee3_exit_command_mode (xbee3_t *ctx)
	XBEE 3 exit command mode function.
err_t	xbee3_factory_reset (xbee3_t *ctx)
	XBEE 3 factory reset function.
err_t	xbee3_get_serial_number (xbee3_t *ctx)
	XBEE 3 get serial number function.
err_t	xbee3_set_device_name (xbee3_t *ctx, char *dev_name)
	XBEE 3 set device name function.
err_t	xbee3_set_destination_address (xbee3_t *ctx, char *dest_addr_high, char *dest_addr_low)
	XBEE 3 set destination address function.
err_t	xbee3_set_api_mode (xbee3_t *ctx, uint8_t api_mode)
	XBEE 3 set api mode function.
err_t	xbee3_apply_changes (xbee3_t *ctx)
	XBEE 3 apply changes function.
err_t	xbee3_save_changes (xbee3_t *ctx)
	XBEE 3 save changes function.

Detailed Description

This file contains API for XBEE 3 Click Driver.

Enumeration Type Documentation

xbee3_return_value_t

enum xbee3_return_value_t

XBEE 3 Click return value data.

Predefined enum values for driver return values.

Enumerator
XBEE3_OK
XBEE3_ERROR