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>

  Example

  import { Struct } from '@viamrobotics/sdk';
  
  const result = await resource.doCommand(
    Struct.fromJson({
      myCommand: { key: 'value' },
    })
  );
  Copy

getNumberOfPositions

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

  Get the total number of positions available on the switch.

  Parameters

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

  Returns Promise<number>

  Example

  const mySwitch = new VIAM.SwitchClient(machine, 'my_switch');
  
  // Get the number of available positions
  const numPositions = await mySwitch.getNumberOfPositions();
  console.log('Number of positions:', numPositions);
  Copy

  For more information, see Switch API.

getPosition

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

  Get the current position of the switch.

  Parameters

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

  Returns Promise<number>

  Example

  const mySwitch = new VIAM.SwitchClient(machine, 'my_switch');
  
  // Update the switch to position 1
  await mySwitch.setPosition(1);
  
  // Get the current set position
  const pos1 = await mySwitch.getPosition();
  
  // Update the switch to position 0
  await mySwitch.setPosition(0);
  
  // Get the current set position
  const pos2 = await mySwitch.getPosition();
  Copy

  For more information, see Switch API.

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>

  Example

  const mySwitch = new VIAM.SwitchClient(machine, 'my_switch');
  
  // Update the switch from its current position to position 1
  await mySwitch.setPosition(1);
  
  // Update the switch from its current position to position 0
  await mySwitch.setPosition(0);
  Copy

  For more information, see Switch API.