Class CreateOperationControlPayload

Namespace

Bonsai.Harp

Assembly

Bonsai.Harp.dll

Represents an operator that creates a message payload that stores the configuration mode of the device.

public class CreateOperationControlPayload

Inheritance

object

CreateOperationControlPayload

Derived

CreateTimestampedOperationControlPayload

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

DumpRegisters

Gets or sets a value that specifies whether the device should report the content of all registers on initialization.

public bool DumpRegisters { get; set; }

Property Value

bool

Heartbeat

Gets or sets a value that specifies whether the device should report the content of the seconds register each second.

public EnableFlag Heartbeat { get; set; }

Property Value

EnableFlag

MuteReplies

Gets or sets a value that specifies whether the replies to all commands will be muted, i.e. not sent by the device.

public bool MuteReplies { get; set; }

Property Value

bool

OperationLed

Gets or sets a value that specifies whether the device state LED should report the operation mode of the device.

public LedState OperationLed { get; set; }

Property Value

LedState

OperationMode

Gets or sets a value that specifies the operation mode of the device.

public OperationMode OperationMode { get; set; }

Property Value

OperationMode

VisualIndicators

Gets or sets a value that specifies the state of all visual indicators on the device.

public LedState VisualIndicators { get; set; }

Property Value

LedState

Methods

GetMessage(MessageType)

Creates a message that stores the configuration mode of the device.

public HarpMessage GetMessage(MessageType messageType)

Parameters

messageType MessageType

Specifies the type of the created message.

Returns

HarpMessage

A new message for the OperationControl register.

GetPayload()

Creates a message payload for the OperationControl register.

public OperationControlPayload GetPayload()

Returns

OperationControlPayload

The created message payload value.