Pleora Technologies Inc. eBUS SDK v6.2.8.5877 API



PvDfwPayload Class Reference

Currently only used to generate reset and device ID DFW records from firmware update files. More...

Public Member Functions

 PvDfwPayload (const PvString &aFilename)
 Constructor. More...
 
 PvDfwPayload (uint8_t *aBuffer, uint32_t aBufferLength)
 Constructor. More...
 
virtual ~PvDfwPayload ()
 Destructor.
 

Static Public Member Functions

static PvResult GetResetRecord (const PvString &aFirmwareFilename, uint8_t *aBuffer, uint32_t aBufferLength, uint32_t &aBytesWritten)
 Generates a reset record from a firmware update file. More...
 
static PvResult GetDeviceIdRecord (const PvString &aFirmwareFilename, const PvString &aNewDeviceId, uint8_t *aBuffer, uint32_t aBufferLength, uint32_t &aBytesWritten)
 Generates a reset record from a firmware update file. More...
 

Detailed Description

Currently only used to generate reset and device ID DFW records from firmware update files.

This class may eventually be instantiated to perform DFW files manipulation. However, for the time being it only provides a fixed set of static functions used to generate ready-to-use DFW records.

Constructor & Destructor Documentation

◆ PvDfwPayload() [1/2]

PvDfwPayload::PvDfwPayload ( const PvString aFilename)

Constructor.

Use this constructor to work with a payload file.

Parameters
[in]aFilenameFilename of the payload file to work on.

◆ PvDfwPayload() [2/2]

PvDfwPayload::PvDfwPayload ( uint8_t *  aBuffer,
uint32_t  aBufferLength 
)

Constructor.

Use this constructor to work with a payload memory buffer.

Parameters
[in]aBufferPointer to the buffer of the payload to work on.
[in]aBufferLengthBuffer length in bytes.

Member Function Documentation

◆ GetDeviceIdRecord()

PvResult PvDfwPayload::GetDeviceIdRecord ( const PvString aFirmwareFilename,
const PvString aNewDeviceId,
uint8_t *  aBuffer,
uint32_t  aBufferLength,
uint32_t &  aBytesWritten 
)
static

Generates a reset record from a firmware update file.

Parameters
[in]aFirmwareFilenameName of the firmware file to read the version and attributes from.
[in]aNewDeviceId
[in]aBufferMemory buffer where to write the reset record.
[in]aBufferLengthLength of the memory buffer, in bytes.
[out]aBytesWrittenHow many effective bytes were written to the buffer.
Returns
PvResult::Code::OK

◆ GetResetRecord()

PvResult PvDfwPayload::GetResetRecord ( const PvString aFirmwareFilename,
uint8_t *  aBuffer,
uint32_t  aBufferLength,
uint32_t &  aBytesWritten 
)
static

Generates a reset record from a firmware update file.

Parameters
[in]aFirmwareFilenameName of the firmware file to read the version and attributes from.
[in]aBufferMemory buffer where to write the reset record.
[in]aBufferLengthLength of the memory buffer, in bytes.
[out]aBytesWrittenHow many effective bytes were written to the buffer.
Returns
PvResult::Code::OK

The documentation for this class was generated from the following files:

Copyright (c) 2002-2021 Pleora Technologies Inc.
www.pleora.com