
Image transfer
This object manages downloading and activating a software or firmware image in a meter. It exposes block transfer progress separately from image verification and activation.
When to use it
Use it to deliver a firmware update, resume missing blocks and check that the image is ready before activation.
See the DLMS client example for an image-update workflow.
Attributes
1. Logical name
The OBIS code that identifies this object instance in the meter. Use it to distinguish this instance from other objects of the same class.
2. Image block size
Reports the size in bytes of the blocks used to transfer the image. The final block may be shorter.
The meter determines the supported block size; do not assume this attribute is writable. Transfer blocks must also fit within the negotiated PDU limits.
3. Transferred blocks status
Shows which image blocks have been received, with one bit for each block.
A zero bit marks a missing block. The first block is represented by the leftmost bit of the bit string.
4. First not transferred block number
Identifies the first block still missing, helping a client resume an interrupted transfer.
Block numbering starts at zero.
5. Image transfer enabled
Controls whether image transfer operations are allowed.
6. Image transfer status
Reports the current stage or result of transfer, verification and activation.
7. Image to Activate Info
A meter can have only one active firmware image at a time. However, the firmware may consist of multiple components, such as communication and metrology modules.
GXDLMSActivationInfo provides information about the firmware images available for activation. It can also be used to identify individual firmware components and their versions, depending on the meter implementation.
Actions
1. Image transfer initiate
Initiate image transfer. This method initiates a new image update. Some meters expect the image identifier to be the exact name the meter manufacturer has given. Some meters accept any name as an image identifier.
2. Image blocktransfer
Move image blocks to the device. The image must be verified and activated after the image blocks are transferred.
3. Image verify.
Verify image.
4. Image activate
Activate image. Meters usually reboot after this action is executed and don't reply anymore. Image activation might take a long time before it's done. Execution time depends on the meter model and it varies a lot.