FirmwareUpgradeConfiguration class

Available extensions

Constructors

FirmwareUpgradeConfiguration.new({Duration estimatedSwapTime = const Duration(seconds: 0), bool eraseAppSettings = true, int pipelineDepth = 1, ImageUploadAlignment byteAlignment = ImageUploadAlignment.fourByte, int reassemblyBufferSize = 0, FirmwareUpgradeMode firmwareUpgradeMode = FirmwareUpgradeMode.confirmOnly})
const

Properties

byteAlignment ImageUploadAlignment
Necessary to set when Pipeline Length is larger than 1 (SMP Pipelining Enabled) to predict offset jumps as multiple packets are sent.
final
eraseAppSettings bool
If enabled, after successful upload but before test/confirm/reset phase, an Erase App Settings Command will be sent and awaited before proceeding.
final
estimatedSwapTime Duration
Estimated time required for swapping images, in seconds. If the mode is set to .testAndConfirm, the manager will try to reconnect after this time. 0 by default.
final
firmwareUpgradeMode FirmwareUpgradeMode
Previously set directly in FirmwareUpgradeManager, it has since been moved here, to the Configuration. It modifies the steps after upload step in Firmware Upgrade that need to be performed for the Upgrade process to be considered Successful.
final
hashCode int
The hash code for this object.
no setterinherited
pipelineDepth int
If set to a value larger than 1, this enables SMP Pipelining, wherein multiple packets of data ('chunks') are sent at once before awaiting a response, which can lead to a big increase in transfer speed if the receiving hardware supports this feature.
final
reassemblyBufferSize int
If set, it is used instead of the MTU Size as the maximum size of the packet. It is designed to be used with a size larger than the MTU, meaning larger Data chunks per Sequence Number, trusting the reassembly Buffer on the receiving side to merge it all back. Thus, increasing transfer speeds.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
proto() ProtoFirmwareUpgradeConfiguration

Available on FirmwareUpgradeConfiguration, provided by the FirmwareUpgradeConfigurationToModel extension

toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited