Plugin Commands: OTA Server#

Sends an OTA Image Notify message to the specified destination indicating a new version of an image is available for download.

• destination - INT16U - The node ID (can be a broadcast address) to which this OTA Notify message should be sent

• endpoint - INT8U - Target endpoint for the OTA Notify message (only really meaningful for non-broadcast target destination).

• payloadType - INT8U - Used to specify which parameters you want included in the OTA Notify cluster command payload (0 = jitter value only; 1 = jitter and manufacturer id; 2 = jitter, mfr id, and device id; 3 = jitter, mfr id, device id, and firmware version)

• jitter - INT8U - Corresponds to QueryJitter parameter in the OTA Upgrade cluster specification. The parameter indicates whether the client receiving Image Notify Command should send in Query Next Image Request command or not.

• manuf-id - INT16U - Manufacturer ID for the image being advertised (should match the mfr ID in the OTA file's header)

• imageTypeId - INT16U - Image type ID for the image being advertised (should match the image type ID from the OTA file's header)

• version - INT32U - Firmware version of the image being advertised (should match the version from the OTA file's header)

Sets the policy used by the ota-server Policy Plugin when it receives an image block request.

• policyValue - INT8U - 0: Send block (default), 1: Delay download once for 2 minutes, 2: Always abort download after first block

• period - INT16U - The minimum block period in milliseconds.

Sets the modulus number of blocks to not respond to. This is used in testing to simulate a device that fails to receive certain blocks from an Image Page Request message.

• modulus - INT8U - The block modulus number to skip sending when responding to an Image Page Request. E.g. if 2, every other block will not be sent. 0 turns the feature off.

Sets whether the Page Request feature is supported or not.

• pageRequestSupported - INT8U - 1 if Page Request is supported, 0 if unsupported

Prints the polices used by the OTA Server Policy Plugin

Sets the policy used by the OTA Server Policy Plugin when it receives a query request from the client.

• policyValue - INT8U - 0: Upgrade if server has newer (default), 1: Downgrade if server has older, 2: Reinstall if server has same, 3: No next version (no next image is available for download)

Sets the policy used by the OTA Server Policy Plugin when it receives an upgrade end request

• policyValue - INT8U - 0: Upgrade Now (default), 1: Upgrade in 2 minutes, 2: Ask me later to upgrade, 3: Abort Upgrade (send default response)

Instruct a device to upgrade now.

• nodeId - INT16U - Short destination to send message

• endpoint - INT8U - Endpoint destination to send message

• mfrId - INT16U - Manufacturer ID for the image (0xFFFF for wildcard)

• imageType - INT16U - Image type for the image (0xFFFF for wildcard)

• fileVersion - INT32U - File version for the image (0xFFFFFFFF for wildcard)