sensors

Documentation

Overview

Package sensors contains a gRPC based sensors service client

Package sensors implements a sensors service.

Package sensors contains a gRPC based sensors service server

Index

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

Constants

const SubtypeName = resource.SubtypeName("sensors")

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 sensor service resource subtype.

Functions

func FindFirstName

func FindFirstName(r robot.Robot) string

FindFirstName returns name of first sensors service found.

func Named

func Named(name string) resource.Name

Named is a helper for getting the named sensor's typed resource name. RSDK-347 Implements senors's Named.

func NewServer

func NewServer(s subtype.Service) pb.SensorsServiceServer

NewServer constructs a sensors gRPC service server.

func NewUnimplementedInterfaceError

func NewUnimplementedInterfaceError(actual interface{}) error

NewUnimplementedInterfaceError is used when there is a failed interface check.

func WrapWithReconfigurable

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

WrapWithReconfigurable wraps a Sensors service as a Reconfigurable.

Types

type Readings

type Readings struct {
	Name     resource.Name
	Readings map[string]interface{}
}

A Readings ties both the sensor name and its reading together.

type Service

type Service interface {
	Sensors(ctx context.Context, extra map[string]interface{}) ([]resource.Name, error)
	Readings(ctx context.Context, sensorNames []resource.Name, extra map[string]interface{}) ([]Readings, error)
	resource.Generic
}

A Service centralizes all sensors into one place.

func FirstFromRobot

func FirstFromRobot(r robot.Robot) (Service, error)

FirstFromRobot returns the first sensor service in this robot.

func FromRobot

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

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

func NewClientFromConn

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

NewClientFromConn constructs a new Client from connection passed in.