baseremotecontrol

Documentation

Overview

Package baseremotecontrol implements a remote control for a base.

Index

• Constants
• Variables
• func Named(name string) resource.Name
• func WrapWithReconfigurable(s interface{}, name resource.Name) (resource.Reconfigurable, error)
• type Service

Constants

const SubtypeName = resource.SubtypeName("base_remote_control")

SubtypeName is the name of the type of service.

Variables

var Subtype = resource.NewSubtype(
	resource.ResourceNamespaceRDK,
	resource.ResourceTypeService,
	SubtypeName,
)

Subtype is a constant that identifies the remote control resource subtype.

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.

func WrapWithReconfigurable

func WrapWithReconfigurable(s interface{}, name resource.Name) (resource.Reconfigurable, error)

WrapWithReconfigurable wraps a BaseRemoteControl as a Reconfigurable.

Types

type Service

type Service interface {
	// 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.