API for configuring and manipulating XBEE 2 Click driver. More...

Topics
	XBEE 2 Device Settings
	Settings for registers of XBEE 2 Click driver.

	XBEE 2 MikroBUS Map
	MikroBUS pin mapping of XBEE 2 Click driver.

Functions
void	xbee2_cfg_setup (xbee2_cfg_t *cfg)
	XBEE 2 configuration object setup function.

err_t	xbee2_init (xbee2_t ctx, xbee2_cfg_t cfg)
	XBEE 2 initialization function.

err_t	xbee2_generic_write (xbee2_t ctx, char data_in, uint16_t len)
	XBEE 2 data writing function.

err_t	xbee2_generic_read (xbee2_t ctx, char data_out, uint16_t len)
	XBEE 2 data reading function.

void	xbee2_set_rts_pin (xbee2_t *ctx, uint8_t state)
	XBEE 2 set rts pin function.

void	xbee2_set_rst_pin (xbee2_t *ctx, uint8_t state)
	XBEE 2 set rst pin function.

void	xbee2_set_cs_pin (xbee2_t *ctx, uint8_t state)
	XBEE 2 set cs pin function.

uint8_t	xbee2_get_cts_pin (xbee2_t *ctx)
	XBEE 2 get cts pin function.

uint8_t	xbee2_get_att_dtr_pin (xbee2_t *ctx)
	XBEE 2 get att_dtr pin function.

err_t	xbee2_write_command (xbee2_t ctx, char data_buf)
	XBEE 2 write command function.

void	xbee2_hw_reset (xbee2_t *ctx)
	XBEE 2 hw reset function.

err_t	xbee2_enter_command_mode (xbee2_t *ctx)
	XBEE 2 enter command mode function.

err_t	xbee2_exit_command_mode (xbee2_t *ctx)
	XBEE 2 exit command mode function.

err_t	xbee2_factory_reset (xbee2_t *ctx)
	XBEE 2 factory reset function.

err_t	xbee2_get_serial_number (xbee2_t *ctx)
	XBEE 2 get serial number function.

err_t	xbee2_set_device_name (xbee2_t ctx, char dev_name)
	XBEE 2 set device name function.

err_t	xbee2_set_destination_address (xbee2_t ctx, char dest_addr_high, char *dest_addr_low)
	XBEE 2 set destination address function.

err_t	xbee2_set_api_mode (xbee2_t *ctx, uint8_t api_mode)
	XBEE 2 set api mode function.

err_t	xbee2_set_device_role (xbee2_t *ctx, uint8_t dev_role)
	XBEE 2 set device role function.

err_t	xbee2_apply_changes (xbee2_t *ctx)
	XBEE 2 apply changes function.

err_t	xbee2_save_changes (xbee2_t *ctx)
	XBEE 2 save changes function.

Detailed Description

API for configuring and manipulating XBEE 2 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

◆ xbee2_apply_changes()

err_t xbee2_apply_changes ( xbee2_t * ctx )

XBEE 2 apply changes function.

This function applies changes by sending the AC command.

Parameters

[in] ctx : Click context object. See xbee2_t object definition for detailed explanation.

Returns

>=0 - Success,
<0 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ xbee2_cfg_setup()

void xbee2_cfg_setup ( xbee2_cfg_t * cfg )

XBEE 2 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out] cfg : Click configuration structure. See xbee2_cfg_t object definition for detailed explanation.

Returns: Nothing.

Note: The all used pins will be set to unconnected state.

◆ xbee2_enter_command_mode()

err_t xbee2_enter_command_mode ( xbee2_t * ctx )

XBEE 2 enter command mode function.

This function is used to enter to command mode by issuing the command character (CC).

Parameters

[in] ctx : Click context object. See xbee2_t object definition for detailed explanation.

Returns

>=0 - Success,
<0 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ xbee2_exit_command_mode()

err_t xbee2_exit_command_mode ( xbee2_t * ctx )

XBEE 2 exit command mode function.

This function is used to exits to command mode by issuing the exit command (CN).

Parameters

[in] ctx : Click context object. See xbee2_t object definition for detailed explanation.

Returns

>=0 - Success,
<0 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ xbee2_factory_reset()

err_t xbee2_factory_reset ( xbee2_t * ctx )

XBEE 2 factory reset function.

This function factory resets the device.

Parameters

[in] ctx : Click context object. See xbee2_t object definition for detailed explanation.

Returns

>=0 - Success,
<0 - Error. See #err_t definition for detailed explanation.

Note: xbee2_save_changes( ) must be called after to save the changes enacted with factory reset.

◆ xbee2_generic_read()

err_t xbee2_generic_read	(	xbee2_t *	ctx,
		char *	data_out,
		uint16_t	len )

XBEE 2 data reading function.

This function reads a desired number of data bytes by using UART serial interface.

Parameters

[in]	ctx	: Click context object. See xbee2_t object definition for detailed explanation.
[out]	data_out	: Output read data.
[in]	len	: Number of bytes to be read.

Returns

>0 - Number of data bytes read,
<=0 - Error/Empty Ring buffer. See #err_t definition for detailed explanation.

Note: None.

◆ xbee2_generic_write()

err_t xbee2_generic_write	(	xbee2_t *	ctx,
		char *	data_in,
		uint16_t	len )

XBEE 2 data writing function.

This function writes a desired number of data bytes by using UART serial interface.

Parameters

[in]	ctx	: Click context object. See xbee2_t object definition for detailed explanation.
[in]	data_in	: Data buffer for sending.
[in]	len	: Number of bytes for sending.

Returns

>=0 - Success,
<0 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ xbee2_get_att_dtr_pin()

uint8_t xbee2_get_att_dtr_pin ( xbee2_t * ctx )

XBEE 2 get att_dtr pin function.

This function returns the SPI Attention or UART Data Present indicator Or Sleep Control line (ATT_DTR) pin logic state.

Parameters

[in] ctx : Click context object. See xbee2_t object definition for detailed explanation.

Returns: Pin logic state.

Note: None.

◆ xbee2_get_cts_pin()

uint8_t xbee2_get_cts_pin ( xbee2_t * ctx )

XBEE 2 get cts pin function.

This function returns the clear to send (CTS) pin logic state.

Parameters

[in] ctx : Click context object. See xbee2_t object definition for detailed explanation.

Returns: Pin logic state.

Note: None.

◆ xbee2_get_serial_number()

err_t xbee2_get_serial_number ( xbee2_t * ctx )

XBEE 2 get serial number function.

This function sends a get serial number command.

Parameters

[in] ctx : Click context object. See xbee2_t object definition for detailed explanation.

Returns

>=0 - Success,
<0 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ xbee2_hw_reset()

void xbee2_hw_reset ( xbee2_t * ctx )

XBEE 2 hw reset function.

This function resets the module by toggling the RST pin.

Parameters

[in] ctx : Click context object. See xbee2_t object definition for detailed explanation.

Returns: None.

Note: None.

◆ xbee2_init()

err_t xbee2_init	(	xbee2_t *	ctx,
		xbee2_cfg_t *	cfg )

XBEE 2 initialization function.

This function initializes all necessary pins and peripherals used for this click board.

Parameters

[out]	ctx	: Click context object. See xbee2_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See xbee2_cfg_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ xbee2_save_changes()

err_t xbee2_save_changes ( xbee2_t * ctx )

XBEE 2 save changes function.

This function saves changes by sending the WR command.

Parameters

[in] ctx : Click context object. See xbee2_t object definition for detailed explanation.

Returns

>=0 - Success,
<0 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ xbee2_set_api_mode()

err_t xbee2_set_api_mode	(	xbee2_t *	ctx,
		uint8_t	api_mode )

XBEE 2 set api mode function.

This function sets the api mode.

Parameters

[in]	ctx	: Click context object. See xbee2_t object definition for detailed explanation.
[in]	api_mode	: `0` - Transparent mode, `1` - API mode without ESC. `2` - API mode with ESC.

Returns

>=0 - Success,
<0 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ xbee2_set_cs_pin()

void xbee2_set_cs_pin	(	xbee2_t *	ctx,
		uint8_t	state )

XBEE 2 set cs pin function.

This function sets the chip select (CS) pin to a desired state.

Parameters

[in]	ctx	: Click context object. See xbee2_t object definition for detailed explanation.
[in]	state	: Pin logic state.

Returns: None.

Note: None.

◆ 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.

This function sets the destination address high and low bytes.

Parameters

[in]	ctx	: Click context object. See xbee2_t object definition for detailed explanation.
[in]	dest_addr_high	: Destination address high bytes as hex string ( up to 8 characters ).
[in]	dest_addr_low	: Destination address low bytes as hex string ( up to 8 characters ).

Returns

>=0 - Success,
<0 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ xbee2_set_device_name()

err_t xbee2_set_device_name	(	xbee2_t *	ctx,
		char *	dev_name )

XBEE 2 set device name function.

This function sets the device name (node identifier).

Parameters

[in]	ctx	: Click context object. See xbee2_t object definition for detailed explanation.
[in]	dev_name	: Device name ( up to 20 characters ).

Returns

>=0 - Success,
<0 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ xbee2_set_device_role()

err_t xbee2_set_device_role	(	xbee2_t *	ctx,
		uint8_t	dev_role )

XBEE 2 set device role function.

This function sets the device role which determines whether the device should form or join a network.

Parameters

[in]	ctx	: Click context object. See xbee2_t object definition for detailed explanation.
[in]	dev_role	: `0` - Join network, `1` - Form network.

Returns

>=0 - Success,
<0 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ xbee2_set_rst_pin()

void xbee2_set_rst_pin	(	xbee2_t *	ctx,
		uint8_t	state )

XBEE 2 set rst pin function.

This function sets the reset (RST) pin to a desired state.

Parameters

[in]	ctx	: Click context object. See xbee2_t object definition for detailed explanation.
[in]	state	: Pin logic state.

Returns: None.

Note: None.

◆ xbee2_set_rts_pin()

void xbee2_set_rts_pin	(	xbee2_t *	ctx,
		uint8_t	state )

XBEE 2 set rts pin function.

This function sets the request to send (RTS) pin to a desired state.

Parameters

[in]	ctx	: Click context object. See xbee2_t object definition for detailed explanation.
[in]	state	: Pin logic state.

Returns: None.

Note: None.

◆ xbee2_write_command()

err_t xbee2_write_command	(	xbee2_t *	ctx,
		char *	data_buf )

XBEE 2 write command function.

This function sends a desired AT command with the CR byte appended to.

Parameters

[in]	ctx	: Click context object. See xbee2_t object definition for detailed explanation.
[in]	data_buf	: Command string.

Returns

>=0 - Success,
<0 - Error. See #err_t definition for detailed explanation.

Note: None.

Topics

Functions

Detailed Description

Function Documentation

◆ xbee2_apply_changes()

◆ xbee2_cfg_setup()

◆ xbee2_enter_command_mode()

◆ xbee2_exit_command_mode()

◆ xbee2_factory_reset()

◆ xbee2_generic_read()

◆ xbee2_generic_write()

◆ xbee2_get_att_dtr_pin()

◆ xbee2_get_cts_pin()

◆ xbee2_get_serial_number()

◆ xbee2_hw_reset()

◆ xbee2_init()

◆ xbee2_save_changes()

◆ xbee2_set_api_mode()

◆ xbee2_set_cs_pin()

◆ xbee2_set_destination_address()

◆ xbee2_set_device_name()

◆ xbee2_set_device_role()

◆ xbee2_set_rst_pin()

◆ xbee2_set_rts_pin()

◆ xbee2_write_command()