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 serviceServer.

Index

• Constants
• Variables
• func Named(name string) resource.Name
• func NamesFromRobot(r robot.Robot) []string
• func NewRPCServiceServer(coll resource.APIResourceCollection[Sensor]) interface{}
• type ReadingRecord
• type ReadingRecords
• type Sensor
  • func FromRobot(r robot.Robot, name string) (Sensor, error)
  • func NewClientFromConn(ctx context.Context, conn rpc.ClientConn, remoteName string, ...) (Sensor, error)

Constants

const SubtypeName = "sensor"

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

Variables

var API = resource.APINamespaceRDK.WithComponentType(SubtypeName)

API is a variable that identifies the component resource API.

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 NewRPCServiceServer

func NewRPCServiceServer(coll resource.APIResourceCollection[Sensor]) interface{}

NewRPCServiceServer constructs an sensor gRPC service serviceServer.

Types

type ReadingRecord

type ReadingRecord struct {
	ReadingName string
	Reading     interface{}
}

ReadingRecord a single analog reading.

type ReadingRecords

type ReadingRecords struct {
	Readings []ReadingRecord
}

ReadingRecords a collection of ReadingRecord.

type Sensor

type Sensor interface {
	resource.Resource
	// 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)
}

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,
	remoteName string,
	name resource.Name,
	logger golog.Logger,
) (Sensor, error)

NewClientFromConn constructs a new Client from connection passed in.