xbee
XBee commands.
xbee execute XBEE-ID AT-COMMAND [value]
Execute an AT command in an XBee node.
Parameters
XBEE-ID
The XBee identifier (MAC or node identifier) of the XBee to execute the command.
Syntax: STRING
AT-COMMAND
The AT command to execute.
Syntax: STRING
value
The value of the command to execute.
Syntax: Decimal number, hexadecimal number with prefix 0x, or string between quotes.
Optional: True
xbee get XBEE-ID PARAMETER [decimal]
Read a parameter from an XBee node.
Parameters
XBEE-ID
The XBee identifier (MAC or node identifier) of the XBee to read the parameter from.
Syntax: STRING
PARAMETER
The parameter name to read.
Syntax: STRING
decimal
Show the read value in decimal, otherwise in hexadecimal.
Syntax: BOOLEAN
Default: False
Optional: True
xbee network clear
Clear the XBee network cache.
Parameters
None
xbee network export EXPORTDIR [description STRING] [name STRING]
Export the XBee network to a file.
Parameters
EXPORTDIR
Absolute path of the directory to create the xnet file.
Syntax: STRING
description
A brief description of the network.
Syntax: STRING
Optional: True
name
The name for the XBee network.
Syntax: STRING
Optional: True
xbee network discover [async]
Discover the XBee network.
Parameters
async
Leave the discovery process in background and returns the prompt inmediately
Syntax: BOOLEAN
Default: False
Optional: True
xbee network show
Show network cache in table format.
Parameters
None
xbee set XBEE-ID PARAMETER VALUE [no-apply] [no-save]
Write a parameter value in a XBee node.
Parameters
XBEE-ID
The XBee identifier (MAC or node identifier) of the XBee to write the parameter to.
Syntax: STRING
PARAMETER
The parameter name to write.
Syntax: STRING
VALUE
The new value of the parameter.
Syntax: Decimal number, hexadecimal number with prefix 0x, or string between quotes.
no-apply
Do not apply the change.
Syntax: BOOLEAN
Default: False
Optional: True
no-save
Do not write to flash the change.
Syntax: BOOLEAN
Default: False
Optional: True
xbee update XBEE-ID PROFILE
Update the XBee with a profile.
Parameters
XBEE-ID
The XBee identifier (MAC or node identifier) of the XBee to update.
Syntax: STRING
PROFILE
The path to the profile to update.
Syntax: STRING
PDF
