sensor

Documentation

Overview

Package sensor contains a gRPC based sensor client.

Package sensor defines an abstract sensing device that can provide measurement readings.

Package sensor contains a gRPC based Sensor service subtypeServer.

Index

• Constants
• Variables
• func Named(name string) resource.Name
• func NamesFromRobot(r robot.Robot) []string
• func NewServer(s subtype.Service) pb.SensorServiceServer
• func NewUnimplementedInterfaceError(actual interface{}) error
• func WrapWithReconfigurable(r interface{}) (resource.Reconfigurable, error)
• type Sensor
  • func FromRobot(r robot.Robot, name string) (Sensor, error)
  • func NewClientFromConn(ctx context.Context, conn rpc.ClientConn, name string, logger golog.Logger) Sensor

Constants

const SubtypeName = resource.SubtypeName("sensor")

SubtypeName is a constant that identifies the component resource subtype string "Sensor".

Variables

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

Subtype is a constant that identifies the component resource subtype.

Functions

func Named

func Named(name string) resource.Name

Named is a helper for getting the named Sensor's typed resource name.

func NamesFromRobot

func NamesFromRobot(r robot.Robot) []string

NamesFromRobot is a helper for getting all sensor names from the given Robot.

func NewServer

func NewServer(s subtype.Service) pb.SensorServiceServer

NewServer constructs an sensor gRPC service subtypeServer.

func NewUnimplementedInterfaceError

func NewUnimplementedInterfaceError(actual interface{}) error

NewUnimplementedInterfaceError is used when there is a failed interface check.

func WrapWithReconfigurable

func WrapWithReconfigurable(r interface{}) (resource.Reconfigurable, error)

WrapWithReconfigurable converts a regular Sensor implementation to a reconfigurableSensor. If Sensor is already a reconfigurableSensor, then nothing is done.

Types

type Sensor

type Sensor interface {
	// Readings return data specific to the type of sensor and can be of any type.
	Readings(ctx context.Context, extra map[string]interface{}) (map[string]interface{}, error)
	generic.Generic
}

A Sensor represents a general purpose sensors that can give arbitrary readings of some thing that it is sensing.

func FromRobot

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

FromRobot is a helper for getting the named Sensor from the given Robot.

func NewClientFromConn

func NewClientFromConn(ctx context.Context, conn rpc.ClientConn, name string, logger golog.Logger) Sensor

NewClientFromConn constructs a new Client from connection passed in.