pub struct ImageTransfer {
logical_name: ObisCode,
image_block_size: u32,
image_transferred_blocks_status: Vec<u8>,
image_first_not_transferred_block_number: u32,
image_transfer_enabled: bool,
image_transfer_status: u8,
image_to_activate_info: Vec<ImageToActivateInfo>,
}Expand description
Image transfer interface class (class_id = 18, version = 0) per
IEC 62056-6-2 §4.4.6. Drives the firmware image transfer process
(initiate → block transfer → verify → activate).
All four methods can be invoked only while image_transfer_enabled is true.
Fields§
§logical_name: ObisCode§image_block_size: u32§image_transferred_blocks_status: Vec<u8>§image_first_not_transferred_block_number: u32§image_transfer_enabled: bool§image_transfer_status: u8§image_to_activate_info: Vec<ImageToActivateInfo>Implementations§
Source§impl ImageTransfer
impl ImageTransfer
Sourcepub fn new(config: ImageTransferConfig) -> Self
pub fn new(config: ImageTransferConfig) -> Self
Builds a new ImageTransfer from its configuration.
fn ensure_enabled(&self) -> Result<(), String>
Sourcefn image_transfer_initiate(
&mut self,
_data: CosemDataType,
) -> Result<CosemDataType, String>
fn image_transfer_initiate( &mut self, _data: CosemDataType, ) -> Result<CosemDataType, String>
Method 1: image_transfer_initiate — starts a new transfer, clearing the
block status (IEC 62056-6-2 §4.4.6.5). Parameter is
structure { image_identifier: octet-string, image_size: double-long-unsigned }.
Sourcefn image_block_transfer(
&mut self,
data: CosemDataType,
) -> Result<CosemDataType, String>
fn image_block_transfer( &mut self, data: CosemDataType, ) -> Result<CosemDataType, String>
Method 2: image_block_transfer — transfers one block, marking it as
received. Parameter is structure { image_block_number: double-long-unsigned, image_block_value: octet-string }.
Sourcefn image_verify(
&mut self,
_data: CosemDataType,
) -> Result<CosemDataType, String>
fn image_verify( &mut self, _data: CosemDataType, ) -> Result<CosemDataType, String>
Method 3: image_verify — verifies the transferred image. Parameter is
integer (0).
Sourcefn image_activate(
&mut self,
_data: CosemDataType,
) -> Result<CosemDataType, String>
fn image_activate( &mut self, _data: CosemDataType, ) -> Result<CosemDataType, String>
Method 4: image_activate — activates the verified image. Parameter is
integer (0).
Sourcefn set_block_transferred(&mut self, block_number: u32)
fn set_block_transferred(&mut self, block_number: u32)
Sets the bit for block_number (MSB-first), growing the bit-string as needed.
Sourcefn first_clear_bit(&self) -> u32
fn first_clear_bit(&self) -> u32
Returns the number of the first block whose bit is still clear.
Trait Implementations§
Source§impl Clone for ImageTransfer
impl Clone for ImageTransfer
Source§fn clone(&self) -> ImageTransfer
fn clone(&self) -> ImageTransfer
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for ImageTransfer
impl Debug for ImageTransfer
Source§impl<'de> Deserialize<'de> for ImageTransfer
impl<'de> Deserialize<'de> for ImageTransfer
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Source§impl InterfaceClass for ImageTransfer
impl InterfaceClass for ImageTransfer
Source§fn logical_name(&self) -> &ObisCode
fn logical_name(&self) -> &ObisCode
Source§fn attributes(&self) -> Vec<(u8, CosemDataType)>
fn attributes(&self) -> Vec<(u8, CosemDataType)>
(attribute_id, value) pairs.