From 2e27bc3d2caa1487d172388c2b24de5de55bb3a7 Mon Sep 17 00:00:00 2001 From: JessamyT Date: Fri, 7 Jun 2024 17:22:53 -0700 Subject: [PATCH] DOCS-2033: Add gripper example snippets --- lib/src/components/gripper/gripper.dart | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/lib/src/components/gripper/gripper.dart b/lib/src/components/gripper/gripper.dart index 8410cade11a..47b1b17516d 100644 --- a/lib/src/components/gripper/gripper.dart +++ b/lib/src/components/gripper/gripper.dart @@ -7,15 +7,31 @@ abstract class Gripper extends Resource { static const Subtype subtype = Subtype(resourceNamespaceRDK, resourceTypeComponent, 'gripper'); /// Open the [Gripper] + /// + /// ``` + /// await myGripper.open(); + /// ``` Future open({Map? extra}); /// Close the [Gripper] + /// + /// ``` + /// await myGripper.grab(); + /// ``` Future grab({Map? extra}); /// Stop all motion of the [Gripper]. It is assumed the [Gripper] stops immediately + /// + /// ``` + /// await myGripper.stop(); + /// ``` Future stop({Map? extra}); /// If the [Gripper] is currently moving + /// + /// ``` + /// var isItMoving = await myGripper.isMoving(); + /// ``` Future isMoving(); /// Get the [ResourceName] for the [Gripper] with the given [name]