![]() |
API
2.2
TSmarT Software Library
|
Configuration for XBee 802. More...
#include <tsmart_xbee_802.h>
Data Fields | |
tsmart_xbee_802_flag_t | api |
tsmart_xbee_802_kind_dev_t | kind_dev |
uint8_t | channel |
uint16_t | pan_id |
uint8_t | baud_rate |
tsmart_xbee_802_flow_control_t | flow_control |
uint8_t | power_level |
tsmart_xbee_802_flag_t | aes_enable |
uint8_t | aes_key [PR_TSMART_XBEE_802_AES_KEY_SIZE] |
uint8_t | aes_key_size |
uint32_t | dest_addr_h |
uint32_t | dest_addr_l |
uint16_t | my |
uint8_t | tx_retries |
tsmart_xbee_802_sleep_mode_t | sleep |
tsmart_xbee_802_flag_t | sleep_option |
uint16_t | cyclic_period |
uint16_t | timer_before_sleep |
int16_t | n_scan_channels |
uint8_t | scan_channels_time |
uint32_t | eflexibility |
uint32_t | cflexibility |
Configuration for XBee 802.
tsmart_xbee_802_flag_t aes_enable |
Enable or disable the AES Encryption option:
The default value for this parameter is: disable
uint8_t aes_key[PR_TSMART_XBEE_802_AES_KEY_SIZE] |
Sets AES key(16 bytes as maximum value) The default value for this parameter is: 0
uint8_t aes_key_size |
Sets AES key size The default value for this parameter is: 16
This parameter enable or disable the API mode:
The default value for this parameter is: enable
uint8_t baud_rate |
Sets the baud rate:
The default value for this parameter is: 3
uint32_t cflexibility |
Configure association in coordinator. This parameter shall be filled with the following values:
The default value for this parameter is: TSMART_XBEE_802_FLEX1
uint8_t channel |
Channel. This value must be set in hexadecimal value:
The default value for this parameter is: 0x0c
uint16_t cyclic_period |
Sleep period for cyclic sleeping remote nodes. Range: 1 - 0xFFFF [x 1 ms] The default value for this parameter is: 0x1388
uint32_t dest_addr_h |
Destination address high, in hexadecimal format: e.g: 0x0013a200 The default value for this parameter is: 0x00000000
uint32_t dest_addr_l |
Destination address low, in hexadecimal format: e.g: 0x406055FF The default value for this parameter is: 0x00000000
uint32_t eflexibility |
Configure association in end device. This parameter shall be filled with the following values:
The default value for this parameter is: (TSMART_XBEE_802_FLEX0 | TSMART_XBEE_802_FLEX1 | TSMART_XBEE_802_FLEX3).
tsmart_xbee_802_flow_control_t flow_control |
Specifies whether the hardware flow control mode is enabled or disabled. This parameter shall be selected amongst the following values:
The default value for this parameter is: TSMART_XBEE_802_FLOW_CONTROL_DISABLE
tsmart_xbee_802_kind_dev_t kind_dev |
Define what kind of device it will be:
The default value for this parameter is: End-device
uint16_t my |
Specifies the kind of XBee address: 16-bit or 64-bit:
int16_t n_scan_channels |
This parameter specify what channels will be scanned for active and energy Scans and during end-device association and coordinator startup. This field shall be filled in this way.
The default value for this parameter is: 0x1FFE.
uint16_t pan_id |
PAN ID. It's possible use one the next range: 0x0000 to 0xFFFF
uint8_t power_level |
This parameter configures the value of the power signal:
The default value for this parameter is: 4
uint8_t scan_channels_time |
This parameter shall be defined in different way if the device is:
The default value for this parameter is: 4.
Sleep mode. This parameter shall be selected amongst the following values:
The default value for this parameter is: TSMART_XBEE_802_OFF
tsmart_xbee_802_flag_t sleep_option |
Sleep mode option about poll wake up:
The default value for this parameter is: TSMART_XBEE_802_DISABLE
uint16_t timer_before_sleep |
Time period of inactivity (no serial or RF data is sent or received), before activating sleep mode. Timer_before_sleep parameter is only valid with cyclic sleep settings (sleep = TSMART_XBEE_802_CYCLIC or TSMART_XBEE_802_CYCLIC_PIN). Available range: 1 - 0xFFFF [x 1 ms] The default value for this parameter is: 0x0001
uint8_t tx_retries |
Maximum number of retries that the module will execute in addition of the 3 set by the default, it shall be: 0-6 retries provided by the 802.15.4. The default value for this parameter is: 0