Edit

Base remote control service API

The base remote control service API allows you to get a list of inputs from the controller that are being monitored for that control mode.

The SLAM service supports the following methods:

Method Name	Description
`ControllerInputs`	Get a list of inputs from the controller that are being monitored for that control mode.
`Reconfigure`	Reconfigure this resource.
`DoCommand`	Execute model-specific commands that are not otherwise defined by the service API.
`GetResourceName`	Get the `ResourceName` for this instance of the generic service with the given name.
`Close`	Close out of all remote control related systems.

API

ControllerInputs

Get a list of inputs from the controller that are being monitored for that control mode.

Parameters:

None.

Returns:

([]input.Control): A list of inputs from the controller that are being monitored for that control mode.

Example:

// Get the list of inputs from the controller that are being monitored for that control mode.
inputs := baseRCService.ControllerInputs()

For more information, see the Go SDK Docs.

Reconfigure

Reconfigure this resource. Reconfigure must reconfigure the resource atomically and in place.

Parameters:

ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
deps (Dependencies): The resource dependencies.
conf (Config): The resource configuration.

Returns:

(error): An error, if one occurred.

For more information, see the Go SDK Docs.

DoCommand

Execute model-specific commands that are not otherwise defined by the service API. Most models do not implement DoCommand. Any available model-specific commands should be covered in the model’s documentation. If you are implementing your own base remote control service and want to add features that have no corresponding built-in API method, you can implement them with DoCommand.

Parameters:

ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
cmd (map[string]interface{}): The command to execute.

Returns:

(map[string]interface{}): The command response.
(error): An error, if one occurred.

Example:

myBaseRemoteControlSvc, err := baseremotecontrol.FromRobot(machine, "my_base_remote_control_svc")

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

For more information, see the Go SDK Docs.

GetResourceName

Get the ResourceName for this instance of the generic service with the given name.

Parameters:

None.

Returns:

(Name)

Example:

baseRCService, err := baseremotecontrol.FromRobot(machine, "my_baseRCService_svc")

err := baseRCService.Name()

For more information, see the Go SDK Docs.

Close

Close out of all remote control related systems.

Parameters:

ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.

Returns:

(error): An error, if one occurred.

Example:

baseRCService, err := baseremotecontrol.FromRobot(machine, "my_baseRCService_svc")

err := baseRCService.Close(context.Background())

For more information, see the Go SDK Docs.

Was this page helpful?

Glad to hear it! If you have any other feedback please let us know:

We're sorry about that. To help us improve, please tell us what we can do better:

Thank you!