Table of Contents

Class FirmwareInfo

Namespace
Geotab.Checkmate.ObjectModel
Assembly
Geotab.Checkmate.ObjectModel.dll

Information about a GoDevice firmware.

public class FirmwareInfo : ApiEntity, IIdentifiable
Inheritance
FirmwareInfo
Implements
Inherited Members

Constructors

FirmwareInfo()

Initializes a new instance of the FirmwareInfo class. Serializer constructor.

public FirmwareInfo()

FirmwareInfo(Id?, int?, int?, byte?, byte?, bool?, byte[]?, string?, bool?, int?, bool, Id?, bool)

Initializes a new instance of the FirmwareInfo class. Creates a new instance of. FirmwareInfo

public FirmwareInfo(Id? id, int? productId, int? subsystemId, byte? major, byte? minor, bool? isDefault, byte[]? firmware, string? comments, bool? isActive, int? channel, bool isBridgeVersion, Id? bridgeFirmwareId = null, bool isRecoveryMode = false)

Parameters

id Id

The current item's Id. NULL if it's new.

productId int?

The product ID.

subsystemId int?

The subsystem Id.

major byte?

The major version.

minor byte?

The minor version.

isDefault bool?

Indicates if this is the default firmware for the product ID.

firmware byte[]

A byte array that represents the firmware binary.

comments string

Any additional information associated with this firmware.

isActive bool?

Indicates if this firmware is active.

channel int?

The firmware channel.

isBridgeVersion bool

Indicates if this firmware is a bridge version.

bridgeFirmwareId Id

The Id of a firmware of type bridge the instance must upgrade to.

isRecoveryMode bool

Indicates if recovery mode enabled for this firmware version.

Properties

BridgeFirmwareId

Gets or sets the Bridge Firmware Id. The Id of a firmware of type bridge the instance must upgrade to.

public Id? BridgeFirmwareId { get; set; }

Property Value

Id

The bridge firmware id or null.

Channel

Gets or sets the firmware channel.

public int? Channel { get; set; }

Property Value

int?

The firmware channel.

Comments

Gets or sets any additional information about this firmware. Used for informational purposes only.

public string? Comments { get; set; }

Property Value

string

The comments.

Firmware

Gets or sets a byte array representing the binary firmware image.

public byte[]? Firmware { get; set; }

Property Value

byte[]

The binary firmware image.

IsActive

Gets or sets a value indicating if this firmware is active.

public bool? IsActive { get; set; }

Property Value

bool?

True if this firmware is active, false otherwise.

IsBridgeVersion

Gets or sets a value indicating whether the firmware is a bridge version.

public bool IsBridgeVersion { get; set; }

Property Value

bool

True if this firmware is bridge version, false otherwise.

IsDefault

Gets or sets a value indicating whether this is the default for the current product ID.

public bool? IsDefault { get; set; }

Property Value

bool?

True if this is the default for the current product ID, false otherwise.

IsRecoveryMode

Gets or sets a value indicating whether recovery mode is enabled for the firmware version.

public bool IsRecoveryMode { get; set; }

Property Value

bool

True if this firmware enable recovery mode on the device, false otherwise.

Major

Gets or sets major revision number.

public byte? Major { get; set; }

Property Value

byte?

The major revision number.

Minor

Gets or sets minor revision number.

public byte? Minor { get; set; }

Property Value

byte?

The minor revision number.

ProductId

Gets or sets product ID.

public int? ProductId { get; set; }

Property Value

int?

The product ID.

SubsystemId

Gets or sets Subsystem ID.

public int? SubsystemId { get; set; }

Property Value

int?

The subsystem Id.

Methods

ToString()

FirmwareInfo in a formatted string

public override string ToString()

Returns

string

The formatted string.

See Also

Entity