Class Pwm0Frequency
- Namespace
- Harp.OutputExpander
- Assembly
- Harp.OutputExpander.dll
Represents a register that sets the frequency of PWM0 (Hz).
public class Pwm0Frequency
- Inheritance
-
Pwm0Frequency
- Inherited Members
Fields
Address
Represents the address of the Pwm0Frequency register. This field is constant.
public const int Address = 42
Field Value
RegisterLength
Represents the length of the Pwm0Frequency register. This field is constant.
public const int RegisterLength = 1
Field Value
RegisterType
Represents the payload type of the Pwm0Frequency register. This field is constant.
public const PayloadType RegisterType = Float
Field Value
Methods
FromPayload(MessageType, float)
Returns a Harp message for the Pwm0Frequency register.
public static HarpMessage FromPayload(MessageType messageType, float value)
Parameters
messageType
MessageTypeThe type of the Harp message.
value
floatThe value to be stored in the message payload.
Returns
- HarpMessage
A HarpMessage object for the Pwm0Frequency register with the specified message type and payload.
FromPayload(double, MessageType, float)
Returns a timestamped Harp message for the Pwm0Frequency register.
public static HarpMessage FromPayload(double timestamp, MessageType messageType, float value)
Parameters
timestamp
doubleThe timestamp of the message payload, in seconds.
messageType
MessageTypeThe type of the Harp message.
value
floatThe value to be stored in the message payload.
Returns
- HarpMessage
A HarpMessage object for the Pwm0Frequency register with the specified message type, timestamp, and payload.
GetPayload(HarpMessage)
Returns the payload data for Pwm0Frequency register messages.
public static float GetPayload(HarpMessage message)
Parameters
message
HarpMessageA HarpMessage object representing the register message.
Returns
- float
A value representing the message payload.
GetTimestampedPayload(HarpMessage)
Returns the timestamped payload data for Pwm0Frequency register messages.
public static Timestamped<float> GetTimestampedPayload(HarpMessage message)
Parameters
message
HarpMessageA HarpMessage object representing the register message.
Returns
- Timestamped<float>
A value representing the timestamped message payload.