A sample policy file that implements the callbacks for the Zigbee Over-the-air bootload cluster server.

License#

The licensor of this software is Silicon Laboratories Inc. Your use of this software is governed by the terms of Silicon Labs Master Software License Agreement (MSLA) available at www.silabs.com/about-us/legal/master-software-license-agreement. This software is distributed to you in Source Code format and is governed by the sections of the MSLA applicable to Source Code.

/***************************************************************************/
#define OTA_SERVER_NO_RATE_LIMITING_FOR_CLIENT          0
#define OTA_SERVER_CLIENT_USES_MILLISECONDS             1
#define OTA_SERVER_CLIENT_USES_SECONDS                  2
#define OTA_SERVER_DISCOVER_CLIENT_DELAY_UNITS          3
#ifdef EMBER_TEST
 #define OTA_SERVER_DO_NOT_OVERRIDE_CLIENT_DELAY_UNITS  0xFF
#endif

uint8_t emberAfPluginOtaServerPolicyGetClientDelayUnits(EmberNodeId clientNodeId,
                                                        EmberEUI64 clientEui64);
 // end of name API

uint8_t emberAfOtaServerImageBlockRequestCallback(EmberAfImageBlockRequestCallbackStruct* data);
 // end of ota_server_policy_cb // end of name Callbacks // end of ota-server-policy

void emAfOtaServerPolicyPrint(void);

void emAfOtaServerSetQueryPolicy(uint8_t value);
void emAfOtaServerSetBlockRequestPolicy(uint8_t value);
void emAfOtaServerSetUpgradePolicy(uint8_t value);

bool emAfServerPageRequestTickCallback(uint16_t relativeOffset, uint8_t blockSize);
void emAfSetPageRequestMissedBlockModulus(uint16_t modulus);
void emAfOtaServerSetPageRequestPolicy(uint8_t value);
void emAfOtaServerPolicySetMinBlockRequestPeriod(uint16_t minBlockRequestPeriodMS);

API#

uint8_t

emberAfPluginOtaServerPolicyGetClientDelayUnits(EmberNodeId clientNodeId, EmberEUI64 clientEui64)

GetClientDelayUnits.

Callbacks#

uint8_t

emberAfOtaServerImageBlockRequestCallback(EmberAfImageBlockRequestCallbackStruct *data)

Macros#

#define

OTA_SERVER_NO_RATE_LIMITING_FOR_CLIENT 0

#define

OTA_SERVER_CLIENT_USES_MILLISECONDS 1

#define

OTA_SERVER_CLIENT_USES_SECONDS 2

#define

OTA_SERVER_DISCOVER_CLIENT_DELAY_UNITS 3

Functions#

void

emAfOtaServerPolicyPrint(void)

void

emAfOtaServerSetQueryPolicy(uint8_t value)

void

emAfOtaServerSetBlockRequestPolicy(uint8_t value)

void

emAfOtaServerSetUpgradePolicy(uint8_t value)

bool

emAfServerPageRequestTickCallback(uint16_t relativeOffset, uint8_t blockSize)

void

emAfSetPageRequestMissedBlockModulus(uint16_t modulus)

void

emAfOtaServerSetPageRequestPolicy(uint8_t value)

void

emAfOtaServerPolicySetMinBlockRequestPeriod(uint16_t minBlockRequestPeriodMS)

API Documentation#

emberAfPluginOtaServerPolicyGetClientDelayUnits#

uint8_t emberAfPluginOtaServerPolicyGetClientDelayUnits (EmberNodeId clientNodeId, EmberEUI64 clientEui64)

GetClientDelayUnits.

Parameters

Type	Direction	Argument Name	Description
EmberNodeId	N/A	clientNodeId	Ver.: always
EmberEUI64	N/A	clientEui64	Ver.: always

Called when the server receives an Image Block Request from a client that supports rate limiting using the Minimum Block Period feature. This callback gives the server a chance to decide which units the client uses for the Minimum Block Period, seconds or milliseconds. The server can also return OTA_SERVER_DISCOVER_CLIENT_DELAY_UNITS, which causes the plugin code to test the client by sending it a preset delay value. The length of time the client delays determines which units it uses. For more information on this feature, see the plugin option descriptions under the OTA Server plugin.

For return values, see ota-server-policy.h. An unknown return value will result in the same behavior as if OTA_SERVER_CLIENT_USES_MILLISECONDS had been returned.

Callbacks Documentation#

emberAfOtaServerImageBlockRequestCallback#

uint8_t emberAfOtaServerImageBlockRequestCallback (EmberAfImageBlockRequestCallbackStruct * data)

Parameters

Type	Direction	Argument Name	Description
EmberAfImageBlockRequestCallbackStruct *	N/A	data

Function Documentation#

emAfOtaServerPolicyPrint#

void emAfOtaServerPolicyPrint (void )

Parameters

Type	Direction	Argument Name	Description
void	N/A

emAfOtaServerSetQueryPolicy#

void emAfOtaServerSetQueryPolicy (uint8_t value)

Parameters

Type	Direction	Argument Name	Description
uint8_t	N/A	value

emAfOtaServerSetBlockRequestPolicy#

void emAfOtaServerSetBlockRequestPolicy (uint8_t value)

Parameters

Type	Direction	Argument Name	Description
uint8_t	N/A	value

emAfOtaServerSetUpgradePolicy#

void emAfOtaServerSetUpgradePolicy (uint8_t value)

Parameters

Type	Direction	Argument Name	Description
uint8_t	N/A	value

emAfServerPageRequestTickCallback#

bool emAfServerPageRequestTickCallback (uint16_t relativeOffset, uint8_t blockSize)

Parameters

Type	Direction	Argument Name	Description
uint16_t	N/A	relativeOffset
uint8_t	N/A	blockSize

emAfSetPageRequestMissedBlockModulus#

void emAfSetPageRequestMissedBlockModulus (uint16_t modulus)

Parameters

Type	Direction	Argument Name	Description
uint16_t	N/A	modulus

emAfOtaServerSetPageRequestPolicy#

void emAfOtaServerSetPageRequestPolicy (uint8_t value)

Parameters

Type	Direction	Argument Name	Description
uint8_t	N/A	value

emAfOtaServerPolicySetMinBlockRequestPeriod#

void emAfOtaServerPolicySetMinBlockRequestPeriod (uint16_t minBlockRequestPeriodMS)

Parameters

Type	Direction	Argument Name	Description
uint16_t	N/A	minBlockRequestPeriodMS