Class MotorOverVoltageDetection

Namespace

Harp.StepperDriver

Assembly

Harp.StepperDriver.dll

Represents a register that contains a bit mask specifying the motor where the over voltage detection and protection mechanism occurred, which can happen when the there's a quick deceleration from a high velocity or when the motor stalls (not implemented).

public class MotorOverVoltageDetection

Inheritance

object

MotorOverVoltageDetection

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

public const int Address = 75

Field Value

int

RegisterLength

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

public const int RegisterLength = 1

Field Value

int

RegisterType

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

public const PayloadType RegisterType = U8

Field Value

PayloadType

Methods

FromPayload(MessageType, StepperMotors)

Returns a Harp message for the MotorOverVoltageDetection register.

public static HarpMessage FromPayload(MessageType messageType, StepperMotors value)

Parameters

messageType MessageType

The type of the Harp message.

value StepperMotors

The value to be stored in the message payload.

Returns

HarpMessage

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

FromPayload(double, MessageType, StepperMotors)

Returns a timestamped Harp message for the MotorOverVoltageDetection register.

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

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value StepperMotors

The value to be stored in the message payload.

Returns

HarpMessage

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

GetPayload(HarpMessage)

Returns the payload data for MotorOverVoltageDetection register messages.

public static StepperMotors GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

StepperMotors

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for MotorOverVoltageDetection register messages.

public static Timestamped<StepperMotors> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<StepperMotors>

A value representing the timestamped message payload.