Class Mortor0AccumulatedSteps
- Namespace
- Harp.StepperDriver
- Assembly
- Harp.StepperDriver.dll
Represents a register that contains the accumulated number of steps of motor 0. Write a value to set the current number of accumulated steps.
public class Mortor0AccumulatedSteps
- Inheritance
-
Mortor0AccumulatedSteps
- Inherited Members
Fields
Address
Represents the address of the Mortor0AccumulatedSteps register. This field is constant.
public const int Address = 91
Field Value
RegisterLength
Represents the length of the Mortor0AccumulatedSteps register. This field is constant.
public const int RegisterLength = 1
Field Value
RegisterType
Represents the payload type of the Mortor0AccumulatedSteps register. This field is constant.
public const PayloadType RegisterType = S32
Field Value
Methods
FromPayload(MessageType, int)
Returns a Harp message for the Mortor0AccumulatedSteps register.
public static HarpMessage FromPayload(MessageType messageType, int value)
Parameters
messageType
MessageTypeThe type of the Harp message.
value
intThe value to be stored in the message payload.
Returns
- HarpMessage
A HarpMessage object for the Mortor0AccumulatedSteps register with the specified message type and payload.
FromPayload(double, MessageType, int)
Returns a timestamped Harp message for the Mortor0AccumulatedSteps register.
public static HarpMessage FromPayload(double timestamp, MessageType messageType, int value)
Parameters
timestamp
doubleThe timestamp of the message payload, in seconds.
messageType
MessageTypeThe type of the Harp message.
value
intThe value to be stored in the message payload.
Returns
- HarpMessage
A HarpMessage object for the Mortor0AccumulatedSteps register with the specified message type, timestamp, and payload.
GetPayload(HarpMessage)
Returns the payload data for Mortor0AccumulatedSteps register messages.
public static int GetPayload(HarpMessage message)
Parameters
message
HarpMessageA HarpMessage object representing the register message.
Returns
- int
A value representing the message payload.
GetTimestampedPayload(HarpMessage)
Returns the timestamped payload data for Mortor0AccumulatedSteps register messages.
public static Timestamped<int> GetTimestampedPayload(HarpMessage message)
Parameters
message
HarpMessageA HarpMessage object representing the register message.
Returns
- Timestamped<int>
A value representing the timestamped message payload.