Modules#

OTA Server Policy

OTA Server Policy#

API and Callbacks for the OTA Server Policy Component.

Silicon Labs implementation of the server policies for the Zigbee Over-the-air bootload cluster (a multi-hop, application bootloader). This controls when a client can upgrade, when new images are made available, and which version the client will download and install. This component should be expanded to support the developer's own server policy.

API#

uint8_t
emberAfPluginOtaServerPolicyGetClientDelayUnits(EmberNodeId clientNodeId, EmberEUI64 clientEui64)

GetClientDelayUnits.

API Documentation#

emberAfPluginOtaServerPolicyGetClientDelayUnits#

uint8_t emberAfPluginOtaServerPolicyGetClientDelayUnits (EmberNodeId clientNodeId, EmberEUI64 clientEui64)

GetClientDelayUnits.

Parameters
N/AclientNodeId

Ver.: always

N/AclientEui64

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.


Definition at line 69 of file app/framework/plugin/ota-server-policy/ota-server-policy.h

Macro Definition Documentation#

OTA_SERVER_NO_RATE_LIMITING_FOR_CLIENT#

#define OTA_SERVER_NO_RATE_LIMITING_FOR_CLIENT
Value:
0

Definition at line 38 of file app/framework/plugin/ota-server-policy/ota-server-policy.h

OTA_SERVER_CLIENT_USES_MILLISECONDS#

#define OTA_SERVER_CLIENT_USES_MILLISECONDS
Value:
1

Definition at line 39 of file app/framework/plugin/ota-server-policy/ota-server-policy.h

OTA_SERVER_CLIENT_USES_SECONDS#

#define OTA_SERVER_CLIENT_USES_SECONDS
Value:
2

Definition at line 40 of file app/framework/plugin/ota-server-policy/ota-server-policy.h

OTA_SERVER_DISCOVER_CLIENT_DELAY_UNITS#

#define OTA_SERVER_DISCOVER_CLIENT_DELAY_UNITS
Value:
3

Definition at line 41 of file app/framework/plugin/ota-server-policy/ota-server-policy.h