sensor

package
v0.0.6 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 15, 2022 License: AGPL-3.0 Imports: 15 Imported by: 0

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

View Source
const SubtypeName = resource.SubtypeName("sensor")

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

Variables

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

NewServer constructs an sensor gRPC service subtypeServer.

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 {
	// GetReadings return data specific to the type of sensor and can be of any type.
	GetReadings(ctx context.Context) ([]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.

Directories

Path Synopsis
Package ds18b20 implements a 1-wire temperature sensor
Package ds18b20 implements a 1-wire temperature sensor
Package fake implements a fake Sensor.
Package fake implements a fake Sensor.
Package register registers all relevant Sensors
Package register registers all relevant Sensors
Package ultrasonic implements an ultrasonic sensor based of the yahboom ultrasonic sensor
Package ultrasonic implements an ultrasonic sensor based of the yahboom ultrasonic sensor

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL