RobotClient class
gRPC client for a Robot. This class should be used for all interactions with a robot.
Obtain an instance of this client by using the function: RobotClient.atAddress(...)
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- isConnected → bool
-
Check if the client is connected to the robot.
no setter
-
resourceNames
↔ List<
ResourceName> -
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
close(
) → Future< void> - Close the connection to the Robot. This should be done to release resources on the robot.
-
getCloudMetadata(
) → Future< CloudMetadata> -
getResource<
T> (ResourceName name) → T - Get a connected resource by its ResourceName
-
getStream(
String name) → StreamClient - Get a WebRTC stream client with the given name
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
refresh(
) → Future< void> - Refresh the resources of this robot
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
atAddress(
String url, RobotClientOptions options) → Future< RobotClient> - Connect to a robot at the specified address with the provided options.