Skip to content

Commit

Permalink
DOCS-2033: Add gripper example snippets
Browse files Browse the repository at this point in the history
  • Loading branch information
JessamyT committed Jun 8, 2024
1 parent d14702e commit 2e27bc3
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions lib/src/components/gripper/gripper.dart
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,31 @@ abstract class Gripper extends Resource {
static const Subtype subtype = Subtype(resourceNamespaceRDK, resourceTypeComponent, 'gripper');

/// Open the [Gripper]
///
/// ```
/// await myGripper.open();
/// ```
Future<void> open({Map<String, dynamic>? extra});

/// Close the [Gripper]
///
/// ```
/// await myGripper.grab();
/// ```
Future<void> grab({Map<String, dynamic>? extra});

/// Stop all motion of the [Gripper]. It is assumed the [Gripper] stops immediately
///
/// ```
/// await myGripper.stop();
/// ```
Future<void> stop({Map<String, dynamic>? extra});

/// If the [Gripper] is currently moving
///
/// ```
/// var isItMoving = await myGripper.isMoving();
/// ```
Future<bool> isMoving();

/// Get the [ResourceName] for the [Gripper] with the given [name]
Expand Down

0 comments on commit 2e27bc3

Please sign in to comment.