Package com.viam.sdk.core.component.sensor

Class Sensor

java.lang.Object

com.viam.sdk.core.resource.Resource

com.viam.sdk.core.component.Component

com.viam.sdk.core.component.sensor.Sensor

Direct Known Subclasses:

SensorRPCClient

public abstract class Sensor
extends Component

Sensor represents a physical sensing device that can provide measurement readings

Nested Class Summary

Nested classes/interfaces inherited from class com.viam.sdk.core.resource.Resource

Resource.Reconfigurable, Resource.Stoppable

Field Summary

Fields

Modifier and Type	Field	Description
static final Subtype	SUBTYPE

Constructor Summary

Constructors

Constructor	Description
Sensor(String name)

Method Summary

Modifier and Type	Method	Description
static Sensor	fromRobot(RobotClient robot, String name)	Get the component with the provided name from the provided robot.
abstract Common.GetReadingsResponse	getReadings(Optional<com.google.protobuf.Struct> extra)
static Common.ResourceName	named(String name)	Get the ResourceName of the component

Methods inherited from class com.viam.sdk.core.component.Component

getGeometries

Methods inherited from class com.viam.sdk.core.resource.Resource

close, createStatus, doCommand, getName, getSubtype, named

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SUBTYPE

public static final Subtype SUBTYPE

Constructor Details

Sensor

public Sensor(String name)

Method Details

named

public static Common.ResourceName named(String name)

Get the ResourceName of the component

Parameters:

name - the name of the component

Returns:

the component's ResourceName

fromRobot

public static Sensor fromRobot(RobotClient robot,
 String name)

Get the component with the provided name from the provided robot.

Parameters:

robot - the RobotClient

name - the name of the component

Returns:

the component

getReadings

public abstract Common.GetReadingsResponse getReadings(Optional<com.google.protobuf.Struct> extra)