Class Encoders

Namespace

Harp.StepperDriver

Assembly

Harp.StepperDriver.dll

Represents a register that contains the quadrature encoder readings.

public class Encoders

Inheritance

object

Encoders

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 Encoders register. This field is constant.

public const int Address = 77

Field Value

int

RegisterLength

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

public const int RegisterLength = 3

Field Value

int

RegisterType

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

public const PayloadType RegisterType = S16

Field Value

PayloadType

Methods

FromPayload(MessageType, EncodersPayload)

Returns a Harp message for the Encoders register.

public static HarpMessage FromPayload(MessageType messageType, EncodersPayload value)

Parameters

messageType MessageType

The type of the Harp message.

value EncodersPayload

The value to be stored in the message payload.

Returns

HarpMessage

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

FromPayload(double, MessageType, EncodersPayload)

Returns a timestamped Harp message for the Encoders register.

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

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value EncodersPayload

The value to be stored in the message payload.

Returns

HarpMessage

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

GetPayload(HarpMessage)

Returns the payload data for Encoders register messages.

public static EncodersPayload GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

EncodersPayload

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for Encoders register messages.

public static Timestamped<EncodersPayload> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<EncodersPayload>

A value representing the timestamped message payload.