Switch API

The switch API allows you to give commands to your switch components for reading the state of a physical switch that has multiple discrete positions. A simple switch has two positions, and a knob could have any number of positions.

The switch component supports the following methods:

Establish a connection

To get started using Viam’s SDKs to connect to and control your switch and the rest of your machine, go to your machine’s page on the Viam app, Navigate to the CONNECT tab’s Code sample page, select your preferred programming language, and copy the sample code.

To show your machine’s API key in the sample code, toggle Include API key.

When executed, this sample code creates a connection to your machine as a client.

The following examples assume you have an switch called "my_switch" configured as a component of your machine. If your switch has a different name, change the name in the code.

Import the switch package for the SDK you are using:

import (
  "go.viam.com/rdk/components/switch"
)

API

SetPosition

Set the position of the switch. Position must be within the valid range for the switch type.

GetPosition

Return the current position of the switch.

GetNumberOfPositions

Return the number of valid positions for this switch.

DoCommand

Execute model-specific commands that are not otherwise defined by the component API. For built-in models, model-specific commands are covered with each model’s documentation. If you are implementing your own switch and add features that have no built-in API method, you can access them with DoCommand.

mySwitch, err := switch.FromRobot(machine, "my_switch")

command := map[string]interface{}{"cmd": "test", "data1": 500}
result, err := mySwitch.DoCommand(context.Background(), command)

Close

Safely shut down the resource and prevent further use.

mySwitch, err := switch.FromRobot(machine, "my_switch")

err = mySwitch.Close(context.Background())