AlpacaSwitchSetSwitch Method

Sets a switch controller device to the specified state, true or false.

Definition

Namespace: ASCOM.Alpaca.Clients
Assembly: ASCOM.Alpaca (in ASCOM.Alpaca.dll) Version: 3.0.0-rc.1+86c25ce733aebb4d8b1b8a62e84770ea5e972bea
C#
public void SetSwitch(
	short id,
	bool state
)

Parameters

id  Int16
The device number (0 to MaxSwitch - 1)
state  Boolean
The required control state

Implements

ISwitchV2SetSwitch(Int16, Boolean)

Remarks

See this link for the canonical definition, which may include further information and implementation requirements: Canonical Definition

Exceptions

NotImplementedExceptionIf CanWrite(Int16) is false.
InvalidValueExceptionIf id is outside the range 0 to MaxSwitch - 1
NotConnectedExceptionWhen Connected is False.
DriverExceptionAn error occurred that is not described by one of the more specific ASCOM exceptions. Include sufficient detail in the message text to enable the issue to be accurately diagnosed by someone other than yourself.

Version Information

.NET Standard

Supported in: 2.0

See Also