Class SwitchClient

constructor

• new SwitchClient(
      client: RobotClient,
      name: string,
      options?: Options,
  ): SwitchClient

  Parameters

  • client: RobotClient
  • name: string
  • options: Options = {}

  Returns SwitchClient

callOptions

Readonlyname

doCommand

• doCommand(command: Struct, callOptions?: CallOptions): Promise<JsonValue>

  Send/Receive arbitrary commands to the resource.

  Parameters

  • command: Struct

    The command to execute.
  • callOptions: CallOptions = ...

  Returns Promise<JsonValue>

getNumberOfPositions

• getNumberOfPositions(extra?: {}, callOptions?: CallOptions): Promise<number>

  Get the total number of positions available on the switch.

  Parameters

  • extra: {} = {}
  • callOptions: CallOptions = ...

  Returns Promise<number>

getPosition

• getPosition(extra?: {}, callOptions?: CallOptions): Promise<number>

  Get the current position of the switch.

  Parameters

  • extra: {} = {}
  • callOptions: CallOptions = ...

  Returns Promise<number>

setPosition

• setPosition(
      position: number,
      extra?: {},
      callOptions?: CallOptions,
  ): Promise<void>

  Set the switch to a specific position.

  Parameters

  • position: number
  • extra: {} = {}
  • callOptions: CallOptions = ...

  Returns Promise<void>