User`s manual

73
ZigBee Requests/Responses
add_device
Adds the device to the list of known devices and to devices.ini. Additionally, if the XBee
on the gateway is a coordinator and a link key or installation code is provided, the link
key for the device will be added to the link key table of the XBee. This will allow the
remote device to join the network. An optional join time can be specified which will
temporarily enable node joining on the network.
Parameter Type Description
device_address MAC 64-bit extended address of the remote device to be added.
join_time (optional) int Number of seconds for which node joining w
ill be enabled on the
network once the device has been added locally. If not provided,
node joining behavior will not be affected.
link_key (optional) int, base16
o
r base64.
The link key of the remote device.
installation_code (optional) string,
base1
6 or
base64.
The installation code of the remote device. If link_key is also pro-
vided, installation_code will be ignored. If provided as
a string
any non hex characters will be stripped before generating the
link key to allow formatting characters to be included in
installation_code.
add_device Parameters:
add_device_response Parameters:
:
Parameter Type Description
device_address MAC 64-bit extended address of the remote device that was added.
join_time (optional) int Only present if given as a parameter to the add_device request.
remove_device
Removes a device from the list of known devices and from endoints.ini. Additionally, if
the XBee on the gateway is a coordinator, the link key for that device will be removed
from the link key table of the XBee. Once the device is removed a ZDO
Mgmt_Leave_req is sent to the device.