#include <types.h>
Go to the source code of this file.
Defines | |
| #define | CS_DEVICE_TYPE DEVICE_TYPE_ROUTER |
| Type of device. | |
| #define | CS_NEIB_TABLE_SIZE 7 |
| The size of neighbour table. | |
| #define | CS_MAX_CHILDREN_AMOUNT 6 |
| Maximum number of children that a given device (coordinator or router) may have. | |
| #define | CS_MAX_CHILDREN_ROUTER_AMOUNT 2 |
| Maximum number of routers among the children of one device. | |
| #define | CS_MAX_NETWORK_DEPTH 5 |
| Maximum depth of a network. | |
| #define | CS_CHANNEL_MASK 0x00010000L |
| Channel mask to be used by the application. | |
| #define | CS_CHANNEL_PAGE 0 |
| Number of channel page to be used. Ignored in the case of AT86RF230/230B/231 RF chip. | |
| #define | CS_UID 0x0000000000000000LL |
| Determines the device UID. | |
| #define | CS_EXT_PANID CS_UID |
| Extended PAN ID of the network to which the device should join. | |
| #define | CS_NWK_EXT_PANID 0LL |
| Extended PAN ID used in commissioning feature. | |
| #define | CS_NWK_UNIQUE_ADDR false |
| Determines whether or not the static addressing mode will be used. | |
| #define | CS_NWK_ADDR 0xFFFF |
| Device's short address if CS_NWK_UNIQUE_ADDR=true, otherwise neglected. | |
| #define | CS_END_DEVICE_SLEEP_PERIOD 10000L |
| End Device sleep period. | |
| #define | CS_ENCRYPTION_TIME 119 |
| Encryption time of maximum-size packet in ms. Decryption time is equal to encryption time. | |
| #define | CS_MAX_AIR_SPEED 5 |
| Duration of the maximum-size packet transmission. | |
| #define | CS_PACKET_PROCESS_INSIDE 7 |
| Duration of internal processing of the maximum-size packet (without encryption). | |
| #define | CS_ACK_TIMEOUT (4 * ((CS_ENCRYPTION_TIME * 2) + (CS_MAX_NETWORK_DEPTH * 100))) |
| APS acknowledgement timeout. | |
| #define | CS_INDIRECT_POLL_RATE (CS_ACK_TIMEOUT >> 1) |
| Time of polling own parent by end device. | |
| #define | CS_RF_TX_POWER 0 |
| #define | CS_SCAN_DURATION 0x05 |
| #define | CS_PERMIT_DURATION 0xff |
| The Permit duration parameter directly affect the asscociation permit on MAC layer. 0xff means "always on", 0x00 means "always off". | |
| #define | CS_SOFT_RESET_REASON 0 |
| #define | CS_NWK_USE_MULTICAST false |
| Determines the value of nwkUseMulticast attribute in NIB. | |
| #define | CS_COMPLEX_DESCRIPTOR_AVAILABLE false |
| Specifies whether a complex descriptor is available on this device. | |
| #define | CS_USER_DESCRIPTOR_AVAILABLE false |
| #define | CS_DUPLICATE_REJECTION_TABLE_SIZE 5 |
| Size of the APS Duplicate Rejection Table. According to ZigBee standard, should be not less than 1. | |
| #define | CS_APS_GROUP_TABLE_ENDPOINTS_AMOUNT 1 |
| Maximum amount of end points in one record in the APS Group Table. | |
| #define | CS_APS_GROUP_TABLE_GROUPS_AMOUNT 1 |
| Maximum amount of groups in the APS Group Table. | |
| #define | CS_ROUTE_TABLE_SIZE 5 |
| Maximum amount of records in the NWK Route Table. | |
| #define | CS_ADDRESS_MAP_TABLE_SIZE 5 |
| Maximum amount of records in the NWK Address Map Table. | |
| #define | CS_ROUTE_DISCOVERY_TABLE_SIZE 3 |
| Maximum amount of records in the NWK Route Discovery Table. | |
| #define | CS_APS_TRUST_CENTER_ADDRESS 0xAAAAAAAAAAAAAAAALL |
| Default address of the Trust Center. | |
| #define | CS_ZDO_SECURITY_STATUS PRECONFIGURED_NETWORK_KEY |
| ZDO security status. | |
| #define | CS_NETWORK_KEY {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0} |
| Default value of the network key. | |
Enumerations | |
| enum | CS_ParameterId_t { CS_NEIB_TABLE_SIZE_ID, CS_MAX_CHILDREN_AMOUNT_ID, CS_MAX_CHILDREN_ROUTER_AMOUNT_ID, CS_MAX_NETWORK_DEPTH_ID, CS_ADDRESS_ASSIGNMENT_METHOD_ID, CS_NWK_DATA_REQ_BUFFER_SIZE_ID, CS_NWK_DATA_IND_BUFFER_SIZE_ID, CS_APS_DATA_REQ_BUFFER_SIZE_ID, CS_APS_ACK_FRAME_BUFFER_SIZE_ID, CS_PROTOCOL_VERSION_ID, CS_STACK_PROFILE_ID, CS_SCAN_DURATION_ID, CS_PERMIT_DURATION_ID, CS_NWK_EXT_PANID_ID, CS_EXT_PANID_ID, CS_NWK_ADDR_ID, CS_NWK_UNIQUE_ADDR_ID, CS_CHANNEL_MASK_ID, CS_CHANNEL_PAGE_ID, CS_UID_ID, CS_INDIRECT_POLL_RATE_ID, CS_DEVICE_TYPE_ID, CS_DUPLICATE_REJECTION_TABLE_SIZE_ID, CS_ACK_TIMEOUT_ID, CS_MAC_FRAME_RX_BUFFER_SIZE_ID, CS_APS_GROUP_TABLE_ENDPOINTS_AMOUNT_ID, CS_APS_GROUP_TABLE_GROUPS_AMOUNT_ID, CS_END_DEVICE_SLEEP_PERIOD_ID, CS_RX_ON_WHEN_IDLE_ID, CS_RF_TX_POWER_ID, CS_SOFT_RESET_REASON_ID, CS_NWK_USE_MULTICAST_ID, CS_COMPLEX_DESCRIPTOR_AVAILABLE_ID, CS_USER_DESCRIPTOR_AVAILABLE_ID, CS_ROUTE_TABLE_SIZE_ID, CS_ADDRESS_MAP_TABLE_SIZE_ID, CS_ROUTE_DISCOVERY_TABLE_SIZE_ID, CS_ROUTE_DISCOVERY_OBJ_SIZE_ID, CS_BTT_SIZE_ID, CS_NWK_MAX_LINK_STATUS_FAILURES_ID, CS_NWK_END_DEVICE_MAX_FAILURES_ID, CS_MAC_TRANSACTION_TIME_ID, CS_DTR_WAKEUP_ID, CS_NWK_LOGICAL_CHANNEL_ID, CS_NWK_PANID_ID, CS_MAX_FRAME_TRANSMISSION_TIME_ID, CS_ZDP_USER_DESCRIPTOR_ID, CS_NWK_PREDEFINED_PANID_ID, CS_MANUFACTURER_CODE_ID, CS_AUTO_POLL_ID, CS_SECURITY_ON_ID, CS_NETWORK_KEY_ID, CS_SECURITY_LEVEL_ID, CS_SECURITY_ALL_FRAMES_ID, CS_APS_SECURITY_BUFFERS_AMOUNT_ID, CS_APS_SECURITY_TIMEOUT_PERIOD_ID, CS_APS_TRUST_CENTER_ADDRESS_ID, CS_ZDO_SECURITY_STATUS_ID, CS_MAX_TC_AUTHENTIC_PROCESS_AMOUNT_ID } |
| IDs of the parameters in Config Server. More... | |
Functions | |
| void | CS_ReadParameter (CS_ParameterId_t parameterId, void *parameterValue) |
| Reads a parameter value specified by parameter identifier from Config Server. | |
| void | CS_WriteParameter (CS_ParameterId_t parameterId, void *parameterValue) |
| Writes a parameter value specified by parameter identifier to Config Server. | |
The file describes the public interface and parameters of Config Server. It is intended for reading/writing the stack parameters. To keep the default values unchanged, the user is recommended to redefine needed values in the application's Makefiles or via the environment variables.
Copyright (c) 2008 , Atmel Corporation. All rights reserved. Licensed under Atmel's Limited License Agreement (BitCloudTM).
Definition in file configServer.h.
| #define CS_DEVICE_TYPE DEVICE_TYPE_ROUTER |
Type of device.
May be chosen from:
0 = DEVICE_TYPE_COORDINATOR
1 = DEVICE_TYPE_ROUTER
2 = DEVICE_TYPE_END_DEVICE
Definition at line 89 of file configServer.h.
| #define CS_NEIB_TABLE_SIZE 7 |
The size of neighbour table.
Upper-bounds the maximum possible amount of child devices. Determines the maximum possible amount of beacons to be saved. The parameter should exceed CS_MAX_CHILDREN_AMOUNT at least by 1
Definition at line 96 of file configServer.h.
| #define CS_MAX_CHILDREN_AMOUNT 6 |
Maximum number of children that a given device (coordinator or router) may have.
Definition at line 100 of file configServer.h.
| #define CS_MAX_CHILDREN_ROUTER_AMOUNT 2 |
Maximum number of routers among the children of one device.
The maximum number of end devices is equal to CS_MAX_CHILDREN_AMOUNT - CS_MAX_CHILDREN_ROUTER_AMOUNT
Definition at line 105 of file configServer.h.
| #define CS_MAX_NETWORK_DEPTH 5 |
Maximum depth of a network.
The maximum number of hops that a packet may travel is twice that large.
Definition at line 110 of file configServer.h.
| #define CS_CHANNEL_MASK 0x00010000L |
Channel mask to be used by the application.
Determines the channel(s) on which the device may operate
Definition at line 145 of file configServer.h.
| #define CS_CHANNEL_PAGE 0 |
Number of channel page to be used. Ignored in the case of AT86RF230/230B/231 RF chip.
Definition at line 149 of file configServer.h.
| #define CS_UID 0x0000000000000000LL |
Determines the device UID.
Should be unique for each device in a network. If set to 0, the stack will use the value from the UID chip (if present).
Definition at line 157 of file configServer.h.
| #define CS_EXT_PANID CS_UID |
Extended PAN ID of the network to which the device should join.
For a coordinator, this is an extended PAN ID of a network to be started.
Definition at line 162 of file configServer.h.
| #define CS_NWK_EXT_PANID 0LL |
Extended PAN ID used in commissioning feature.
Determines the extended PAN ID of a network where a device may start without having to join.
Definition at line 167 of file configServer.h.
| #define CS_NWK_UNIQUE_ADDR false |
Determines whether or not the static addressing mode will be used.
If set to true, the CS_NWK_ADDR will be used as the device's short address
Otherwise, the stochastic addressing mode will be employed.
Definition at line 173 of file configServer.h.
| #define CS_NWK_ADDR 0xFFFF |
Device's short address if CS_NWK_UNIQUE_ADDR=true, otherwise neglected.
Definition at line 177 of file configServer.h.
| #define CS_END_DEVICE_SLEEP_PERIOD 10000L |
End Device sleep period.
It is used by a parent for tracking that an End Device lives. For an End Device, this parameter sets its own sleep period. For router, it should be maximum over all sleep periods in a network
Definition at line 184 of file configServer.h.
| #define CS_ENCRYPTION_TIME 119 |
Encryption time of maximum-size packet in ms. Decryption time is equal to encryption time.
Definition at line 193 of file configServer.h.
| #define CS_MAX_AIR_SPEED 5 |
| #define CS_PACKET_PROCESS_INSIDE 7 |
Duration of internal processing of the maximum-size packet (without encryption).
Definition at line 214 of file configServer.h.
| #define CS_ACK_TIMEOUT (4 * ((CS_ENCRYPTION_TIME * 2) + (CS_MAX_NETWORK_DEPTH * 100))) |
| #define CS_INDIRECT_POLL_RATE (CS_ACK_TIMEOUT >> 1) |
Time of polling own parent by end device.
The parameter should be at least 2 times less than CS_ACK_TIMEOUT
Definition at line 225 of file configServer.h.
| #define CS_RF_TX_POWER 0 |
Definition at line 230 of file configServer.h.
| #define CS_SCAN_DURATION 0x05 |
Definition at line 233 of file configServer.h.
| #define CS_PERMIT_DURATION 0xff |
The Permit duration parameter directly affect the asscociation permit on MAC layer. 0xff means "always on", 0x00 means "always off".
Definition at line 238 of file configServer.h.
| #define CS_SOFT_RESET_REASON 0 |
Definition at line 241 of file configServer.h.
| #define CS_NWK_USE_MULTICAST false |
Determines the value of nwkUseMulticast attribute in NIB.
Enables or disables the multicast transmission mode on NWK layer. Recommended to be set to false.
Definition at line 246 of file configServer.h.
| #define CS_COMPLEX_DESCRIPTOR_AVAILABLE false |
Specifies whether a complex descriptor is available on this device.
Definition at line 251 of file configServer.h.
| #define CS_USER_DESCRIPTOR_AVAILABLE false |
Specifies whether a user descriptor is available on this device.
Definition at line 256 of file configServer.h.
| #define CS_DUPLICATE_REJECTION_TABLE_SIZE 5 |
Size of the APS Duplicate Rejection Table. According to ZigBee standard, should be not less than 1.
Definition at line 272 of file configServer.h.
| #define CS_APS_GROUP_TABLE_ENDPOINTS_AMOUNT 1 |
Maximum amount of end points in one record in the APS Group Table.
Definition at line 276 of file configServer.h.
| #define CS_APS_GROUP_TABLE_GROUPS_AMOUNT 1 |
| #define CS_ROUTE_TABLE_SIZE 5 |
| #define CS_ADDRESS_MAP_TABLE_SIZE 5 |
Maximum amount of records in the NWK Address Map Table.
Definition at line 288 of file configServer.h.
| #define CS_ROUTE_DISCOVERY_TABLE_SIZE 3 |
Maximum amount of records in the NWK Route Discovery Table.
Definition at line 292 of file configServer.h.
| #define CS_APS_TRUST_CENTER_ADDRESS 0xAAAAAAAAAAAAAAAALL |
| #define CS_ZDO_SECURITY_STATUS PRECONFIGURED_NETWORK_KEY |
ZDO security status.
May be chosen among:
0 - preconfigured network key
3 - not preconfigured.
Definition at line 388 of file configServer.h.
| #define CS_NETWORK_KEY {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0} |
| enum CS_ParameterId_t |
IDs of the parameters in Config Server.
Definition at line 459 of file configServer.h.
| void CS_ReadParameter | ( | CS_ParameterId_t | parameterId, | |
| void * | parameterValue | |||
| ) |
Reads a parameter value specified by parameter identifier from Config Server.
| [in] | parameterId | - ID of the parameter being read |
| [out] | parameterValue | - Value of the parameter being read |
| void CS_WriteParameter | ( | CS_ParameterId_t | parameterId, | |
| void * | parameterValue | |||
| ) |
Writes a parameter value specified by parameter identifier to Config Server.
If the parameter is in persistense data server it also is saved there.
| [in] | parameterId | - ID of the parameter being written |
| [in] | parameterValue | - Value of the parameter being written |
1.5.1-p1