|
|
|
Z-Stack API Reference
8.31.00.00
|
#include <zstack.h>
Structure to send a system config write request. Each config field has 2 parts to it, the actual value field and its "has_" field. The "has_" field must be set to "true" for the value field to be valid. For example, the pollRate field is valid only if the has_pollRate field is set to true.
| uint16_t apsAckWaitDuration |
APS Ack Waite Duration
| uint8_t apsFrameRetries |
APS Frame Retries
| uint8_t bcastDeliveryTime |
Broadcast Delivery Time
| uint8_t bcastRetries |
Broadcast Retries
| uint16_t bindingTime |
Binding Time
| uint32_t chanList |
Channel List (bitmap) - Channels are defined in the following: 0 : 868 MHz (0x00000001), 1 - 10 : 915 MHz (0x000007FE), 11 - 26 : 2.4 GHz (0x07FFF800)
| uint8_t concentratorDiscTime |
Concentrator Discovery Time value in seconds
| bool concentratorEnable |
True to enable the Concentrator, false to disable
| bool disablePollRate |
Set to true to indicate the stack to stop polling completly (this overwrites EndDeviceTimeout stack requirements). Set to False to restore the current polling configuration.
| zstack_LongAddr_t extendedPANID |
64 bit extended PAN ID (APS USE)
| bool has_apsAckWaitDuration |
Set to true if apsAckWaitDuration is available, false if not
| bool has_apsFrameRetries |
Set to true if apsFrameRetries is available, false if not
| bool has_bcastDeliveryTime |
Set to true if bcastDeliveryTime is available, false if not
| bool has_bcastRetries |
Set to true if bcastRetries is available, false if not
| bool has_bindingTime |
Set to true if bindingTime is available, false if not
| bool has_chanList |
Set to true if chanList is available, false if not
| bool has_concentratorDiscTime |
Set to true if concentratorEnable is available, false if not
| bool has_concentratorEnable |
Set to true if concentratorEnable is available, false if not
| bool has_disablePollRate |
Set to true if disablePollRate is available. If this is enabled, then has_pollRate has no effect
| bool has_extendedPANID |
Set to true if extendedPANID is available, false if not
| bool has_ieeeAddr |
Set to true if ieeeAddr is available, false if not
| bool has_indirectMsgTimeout |
Set to true if indirectMsgTimeout is available, false if not
| bool has_macRxOnIdle |
Set to true if macRxOnIdle is available, false if not
| bool has_maxMissingMacAckLinkFailure |
Set to true if maxMissingMacAckLinkFailure is available, false if not
| bool has_multicastRadius |
Set to true if chanList is available, false if not
| bool has_nwkUseMultiCast |
Set to true if nwkUseMultiCast is available, false if not
| bool has_panID |
Set to true if panID is available, false if not
| bool has_passiveAckTimeout |
Set to true if passiveAckTimeout is available, false if not
| bool has_pollRate |
Set to true if pollRate and pollRateType is available, false if not
| bool has_preConfigKey |
Set to true if preConfigKey is available, false if not
| bool has_preConfigKeyEnable |
Set to true if preConfigKeyEnable is available, false if not
| bool has_routeExpiryTime |
Set to true if routeExpiryTime is available, false if not
| bool has_securityModeEnable |
Set to true if securityModeEnable is available, false if not
| bool has_snifferFeature |
Set to true if snifferFeature is available, false if not
| bool has_useDefaultTCLK |
Set to true if useDefaultTCLK is available, false if not
| bool has_userDesc |
Set to true if userDesc is available, false if not
| zstack_LongAddr_t ieeeAddr |
64 bit extended IEEE address
| uint8_t indirectMsgTimeout |
Indirect Message Timeout
| bool macRxOnIdle |
the MAC's RxOnIdle parameter
| uint8_t maxMissingMacAckLinkFailure |
End Device frames to its parent failure before forcing link failure (not applicable for routers)
| uint8_t multicastRadius |
Multicast radius
| uint8_t n_preConfigKey |
length of pPreConfigKey
| uint8_t n_userDesc |
Size of the User Descriptor (16 bytes max)
| bool nwkUseMultiCast |
True to enable the use of Multicast messaging
| uint16_t panID |
PAN ID
| uint8_t passiveAckTimeout |
Passive Ack Timeout
| uint32_t pollRate |
End Device Poll Rate to set to pollRateType (not applicable for routers), in milliseconds. This must be bigger than MINIMUM_APP_POLL_RATE, when setting application poll rate as: POLL_RATE_TYPE_DEFAULT, POLL_RATE_TYPE_APP_1 and POLL_RATE_TYPE_APP_2
| uint16_t pollRateType |
Poll rate type to be set. This field is a bitmask. The poll associated to the operations set in this bitmask parameter will be set to the pollRate parameter. POLL_RATE_TYPE_DEFAULT 0x0001 Default pollrate to be used when no other stack operation is done. POLL_RATE_TYPE_APP_1 0x0002 Application defined poll rate POLL_RATE_TYPE_APP_2 0x0004 Application defined poll rate POLL_RATE_TYPE_JOIN_REJOIN 0x0008 Poll rate used by the stack during join/rejoin operations POLL_RATE_TYPE_QUEUED 0x0010 Poll rate used by the stack when expecting a response or retrieving all queued messages from parent. POLL_RATE_TYPE_RESPONSE 0x0020 Poll rate used by the stack when expecting a response. POLL_RATE_TYPE_GENERIC_1_SEC 0x1000 1 second poll rate used by the stack (cannot be modified) POLL_RATE_DISABLED 0x4000 State to not perform poll rate. This is used by the stack (cannot be modified) POLL_RATE_RX_ON_TRUE 0x8000 Indicates if ZED is RxOnIdle, device will not poll unless Parent request it as keep alive method (cannot be modified)
| uint8_t* pPreConfigKey |
Pointer to the PreConfig Key (16 bytes)
| bool preConfigKeyEnable |
Pre Config Key Enable
| uint8_t* pUserDesc |
Pointer to the User Descriptor
| uint8_t routeExpiryTime |
Route Expiry Time
| bool securityModeEnable |
Security Mode Enable (nwk)
| bool snifferFeature |
True to enable the Sniffer Feature, false to disable
| bool useDefaultTCLK |
Enable the use of the preconfig Trust Center Link Key