baseremotecontrol

Documentation

Overview

Package baseremotecontrol implements a remote control for a base. For more information, see the base remote control service docs.

Index

• Constants
• Variables
• func Named(name string) resource.Name
• type Service
  • func FromRobot(r robot.Robot, name string) (Service, error)

Constants

const SubtypeName = "base_remote_control"

SubtypeName is the name of the type of service.

Variables

var API = resource.APINamespaceRDK.WithServiceType(SubtypeName)

API is a variable that identifies the remote control resource API.

Functions

func Named

func Named(name string) resource.Name

Named is a helper for getting the named base remote control service's typed resource name.

Types

type Service

type Service interface {
	resource.Resource
	// Close out of all remote control related systems.
	Close(ctx context.Context) error
	// controllerInputs returns the list of inputs from the controller that are being monitored for that control mode.
	ControllerInputs() []input.Control
}

A Service is the basis for the base remote control. For more information, see the base remote control service docs.

Close example:

// Close out of all remote control-related systems.
err := baseRCService.Close(context.Background())

ControllerInputs example:

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

func FromRobot

func FromRobot(r robot.Robot, name string) (Service, error)

FromRobot is a helper for getting the named base remote control service from the given Robot.