ZigBeeNet Stack Documentation: configServer.h File Reference

The file describes the public interface and parameters of Config Server. It is intended for reading/writing the stack parameters.

Enumeration Type Documentation

enum CS_MemoryId_t

IDs of the memory area in Config Server.

Enumerator:

CS_NEIB_TABLE_ID
CS_NWK_DATA_REQ_BUFFER_ID
CS_NWK_DATA_IND_BUFFER_ID
CS_APS_DATA_REQ_BUFFER_ID
CS_APS_ACK_FRAME_BUFFER_ID
CS_ASSOCIATE_RESPONSE_BUFFER_ID
CS_NWK_PAN_DESCRIPTOR_BUFFER_ID
CS_MAC_PAN_DESCRIPTOR_BUFFER_ID
CS_DUPLICATE_REJECTION_TABLE_ID
CS_MAC_FRAME_RX_BUFFER_ID
CS_APS_GROUP_TABLE_ID
CS_ROUTE_TABLE_ID
CS_ADDRESS_MAP_TABLE_ID
CS_ROUTE_DISCOVERY_TABLE_ID

Definition at line 309 of file configServer.h.

enum CS_ParameterId_t

IDs of the parameters in Config Server.

Enumerator:

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_UID_ID
CS_INDIRECT_POLL_RATE_ID
CS_AUTONETWORK_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_ACTIVE_PERIOD_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_ROUTE_TABLE_SIZE_ID
CS_ADDRESS_MAP_TABLE_SIZE_ID
CS_ROUTE_DISCOVERY_TABLE_SIZE_ID
CS_MAC_TRANSACTION_TIME_ID
CS_DTR_WAKEUP_ID
CS_NWK_LOGICAL_CHANNEL_ID
CS_NWK_PANID_ID

Definition at line 239 of file configServer.h.

Function Documentation

void CS_GetMemory	(	CS_MemoryId_t	memoryId,
		void **	memoryPtr
	)

Gets allocated memory specified by memory identifier.

Parameters:

`[in]`	memoryId	- memory area Id
`[out]`	memoryPtr	- pointer to the memory

void CS_Init ( void )

Inits the Config Server.

Config server gets values from defines and reads from persistence data server

void CS_PdsDefaultValue ( void )

Set persist default value.

void CS_ReadParameter	(	CS_ParameterId_t	parameterId,
		void *	parameterValue
	)

Reads a parameter value specified by parameter identifier from Config Server.

Parameters:

`[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.

Parameters:

`[in]`	parameterId	- ID of the parameter being written
`[in]`	parameterValue	- Value of the parameter being written

configServer.h File Reference

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

Function Documentation


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_UID_ID, CS_INDIRECT_POLL_RATE_ID, CS_AUTONETWORK_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_ACTIVE_PERIOD_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_ROUTE_TABLE_SIZE_ID, CS_ADDRESS_MAP_TABLE_SIZE_ID, CS_ROUTE_DISCOVERY_TABLE_SIZE_ID, CS_MAC_TRANSACTION_TIME_ID, CS_DTR_WAKEUP_ID, CS_NWK_LOGICAL_CHANNEL_ID, CS_NWK_PANID_ID }
	IDs of the parameters in Config Server. More...
enum	CS_MemoryId_t { CS_NEIB_TABLE_ID, CS_NWK_DATA_REQ_BUFFER_ID, CS_NWK_DATA_IND_BUFFER_ID, CS_APS_DATA_REQ_BUFFER_ID, CS_APS_ACK_FRAME_BUFFER_ID, CS_ASSOCIATE_RESPONSE_BUFFER_ID, CS_NWK_PAN_DESCRIPTOR_BUFFER_ID, CS_MAC_PAN_DESCRIPTOR_BUFFER_ID, CS_DUPLICATE_REJECTION_TABLE_ID, CS_MAC_FRAME_RX_BUFFER_ID, CS_APS_GROUP_TABLE_ID, CS_ROUTE_TABLE_ID, CS_ADDRESS_MAP_TABLE_ID, CS_ROUTE_DISCOVERY_TABLE_ID }
	IDs of the memory area in Config Server. More...
Functions
void	CS_Init (void)
	Inits the Config Server.
void	CS_GetMemory (CS_MemoryId_t memoryId, void **memoryPtr)
	Gets allocated memory specified by memory identifier.
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.
void	CS_PdsDefaultValue (void)
	Set persist default value.