Class AuxLedPower

Namespace

Harp.LedArray

Assembly

Harp.LedArray.dll

Represents a register that sets the power to be applied to auxiliary LED, between 1 and 120.

public class AuxLedPower

Inheritance

object

AuxLedPower

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Fields

Address

Represents the address of the AuxLedPower register. This field is constant.

public const int Address = 62

Field Value

int

RegisterLength

Represents the length of the AuxLedPower register. This field is constant.

public const int RegisterLength = 1

Field Value

int

RegisterType

Represents the payload type of the AuxLedPower register. This field is constant.

public const PayloadType RegisterType = U8

Field Value

PayloadType

Methods

FromPayload(MessageType, byte)

Returns a Harp message for the AuxLedPower register.

public static HarpMessage FromPayload(MessageType messageType, byte value)

Parameters

messageType MessageType

The type of the Harp message.

value byte

The value to be stored in the message payload.

Returns

HarpMessage

A HarpMessage object for the AuxLedPower register with the specified message type and payload.

FromPayload(double, MessageType, byte)

Returns a timestamped Harp message for the AuxLedPower register.

public static HarpMessage FromPayload(double timestamp, MessageType messageType, byte value)

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value byte

The value to be stored in the message payload.

Returns

HarpMessage

A HarpMessage object for the AuxLedPower register with the specified message type, timestamp, and payload.

GetPayload(HarpMessage)

Returns the payload data for AuxLedPower register messages.

public static byte GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

byte

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for AuxLedPower register messages.

public static Timestamped<byte> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<byte>

A value representing the timestamped message payload.