EmberAfOtaHeader Struct Reference
This structure is an in-memory representation of the Over-the-air header data that resides on disk. It is not a byte-for-byte copy.
#include <
af-types.h
>
Data Fields |
|
| uint16_t | headerVersion |
| uint16_t | headerLength |
| uint16_t | fieldControl |
| uint16_t | manufacturerId |
| uint16_t | imageTypeId |
| uint32_t | firmwareVersion |
| uint16_t | zigbeeStackVersion |
| uint8_t | headerString [ EMBER_AF_OTA_MAX_HEADER_STRING_LENGTH +1] |
|
The spec. does NOT require that the string be NULL terminated in the header stored on disk. Therefore we make sure we can support a 32-character string without a NULL terminator by adding +1 in the data structure.
|
|
| uint32_t | imageSize |
|
When reading the header this will be the complete length of the file. When writing the header, this must be set to the length of the MFG image data portion including all tags.
|
|
| uint8_t | securityCredentials |
|
The remaining four fields are optional. The field control should be checked to determine if their values are valid.
|
|
| union { | |
| uint8_t EUI64 [ EUI64_SIZE ] | |
| uint8_t UID [ UID_SIZE ] | |
| } | upgradeFileDestination |
| uint16_t | minimumHardwareVersion |
| uint16_t | maximumHardwareVersion |
This structure is an in-memory representation of the Over-the-air header data that resides on disk. It is not a byte-for-byte copy.
Field Documentation
| uint8_t EmberAfOtaHeader::EUI64[ EUI64_SIZE ] |
| uint16_t EmberAfOtaHeader::fieldControl |
| uint32_t EmberAfOtaHeader::firmwareVersion |
| uint16_t EmberAfOtaHeader::headerLength |
| uint8_t EmberAfOtaHeader::headerString[ EMBER_AF_OTA_MAX_HEADER_STRING_LENGTH +1] |
The spec. does NOT require that the string be NULL terminated in the header stored on disk. Therefore we make sure we can support a 32-character string without a NULL terminator by adding +1 in the data structure.
| uint16_t EmberAfOtaHeader::headerVersion |
| uint32_t EmberAfOtaHeader::imageSize |
When reading the header this will be the complete length of the file. When writing the header, this must be set to the length of the MFG image data portion including all tags.
| uint16_t EmberAfOtaHeader::imageTypeId |
| uint16_t EmberAfOtaHeader::manufacturerId |
| uint16_t EmberAfOtaHeader::maximumHardwareVersion |
| uint16_t EmberAfOtaHeader::minimumHardwareVersion |
| uint8_t EmberAfOtaHeader::securityCredentials |
The remaining four fields are optional. The field control should be checked to determine if their values are valid.
| uint8_t EmberAfOtaHeader::UID[ UID_SIZE ] |
| union { ... } EmberAfOtaHeader::upgradeFileDestination |
| uint16_t EmberAfOtaHeader::zigbeeStackVersion |
The documentation for this struct was generated from the following file:
-
af-types.h