standardbots 2.20241119.1__py3-none-any.whl → 2.20250128.1__py3-none-any.whl

standardbots/auto_generated/apis.py

@@ -66,7 +66,9 @@ class RequestManager:
         return {
             "Content-Type": "application/json",
             "Authorization": "Bearer " + self.token,
+            # Include both for backwards-compatibility purposes.
             "robot_kind": self.robot_kind.value,
+            "robot-kind": self.robot_kind.value,
         }
 
     def close(self):
@@ -74,6 +76,55 @@ class RequestManager:
 
 class Default:
     _request_manager: RequestManager
+    class Calibration:
+        def __init__(self, request_manager: RequestManager):
+            self._request_manager = request_manager
+
+
+        def get_active_calibration(
+            self,
+        ) -> Response[
+            Union[
+                models.ActiveCalibrationResponse,
+                models.ErrorResponse,
+                None
+            ],
+            models.ActiveCalibrationResponse
+        ]:
+            """
+            Get the active calibration for the robot.
+
+            """
+            path = "/api/v1/calibration/active"
+            try:
+                response = self._request_manager.request(
+                    "GET",
+                    path,
+                    headers=self._request_manager.json_headers(),
+                )
+                parsed = None
+                if response.status == 200:
+                    parsed = models.parse_active_calibration_response(json.loads(response.data))
+
+                is_user_error = response.status >= 400 and response.status <= 500
+                is_unavailable = response.status == 503
+                if parsed is None and (is_user_error or is_unavailable):
+                    parsed = models.parse_error_response(json.loads(response.data))
+
+                return Response(
+                    parsed,
+                    response.status,
+                    response
+                )
+            except urllib3.exceptions.MaxRetryError:
+                return Response(
+                    models.ErrorResponse(
+                        error=models.ErrorEnum.InternalServerError,
+                        message="Connection Refused"
+                    ),
+                    503,
+                    None
+                )
     class Equipment:
         def __init__(self, request_manager: RequestManager):
             self._request_manager = request_manager
@@ -186,7 +237,7 @@ class Default:
             return self.control_gripper(
                 body=models.GripperCommandRequest(
                     kind=models.GripperKindEnum.DhCgi,
-                    dh_pgc=models.DHCGIGripperCommandRequest(
+                    dh_cgi=models.DHCGIGripperCommandRequest(
                         target_diameter, target_force, target_speed
                     ),
                 ),
@@ -380,12 +431,14 @@ class Default:
                     None
                 )
 
+    calibration: Calibration
     equipment: Equipment
     sensors: Sensors
     space: Space
 
     def __init__(self, request_manager: RequestManager):
         self._request_manager = request_manager
+        self.calibration = Default.Calibration(request_manager)
         self.equipment = Default.Equipment(request_manager)
         self.sensors = Default.Sensors(request_manager)
         self.space = Default.Space(request_manager)
@@ -711,7 +764,7 @@ class Camera:
             None
         ]:
             """
-            Retrieve the latest RGB frame from the camera.
+            Retrieve the latest RGB frame from the camera. In JPEG format.
             """
             path = "/api/v1/camera/frame/rgb"
             try:
@@ -930,6 +983,113 @@ class Faults:
         self._request_manager = request_manager
         self.user_faults = Faults.UserFaults(request_manager)
 
+class General:
+    _request_manager: RequestManager
+    class BotIdentity:
+        def __init__(self, request_manager: RequestManager):
+            self._request_manager = request_manager
+
+
+        def bot_identity(
+            self,
+        ) -> Response[
+            Union[
+                models.BotIdentityData,
+                models.ErrorResponse,
+                None
+            ],
+            models.BotIdentityData
+        ]:
+            """
+            Get information about the robot&#x27;s identity.
+            """
+            path = "/api/v1/identity/bot_identity"
+            try:
+                response = self._request_manager.request(
+                    "GET",
+                    path,
+                    headers=self._request_manager.json_headers(),
+                )
+                parsed = None
+                if response.status == 200:
+                    parsed = models.parse_bot_identity_data(json.loads(response.data))
+
+                is_user_error = response.status >= 400 and response.status <= 500
+                is_unavailable = response.status == 503
+                if parsed is None and (is_user_error or is_unavailable):
+                    parsed = models.parse_error_response(json.loads(response.data))
+
+                return Response(
+                    parsed,
+                    response.status,
+                    response
+                )
+            except urllib3.exceptions.MaxRetryError:
+                return Response(
+                    models.ErrorResponse(
+                        error=models.ErrorEnum.InternalServerError,
+                        message="Connection Refused"
+                    ),
+                    503,
+                    None
+                )
+    class Joints:
+        def __init__(self, request_manager: RequestManager):
+            self._request_manager = request_manager
+
+
+        def get_joints_state(
+            self,
+        ) -> Response[
+            Union[
+                models.JointsStateResponse,
+                models.ErrorResponse,
+                None
+            ],
+            models.JointsStateResponse
+        ]:
+            """
+            Retrieves information about the state of each joint
+            """
+            path = "/api/v1/joints"
+            try:
+                response = self._request_manager.request(
+                    "GET",
+                    path,
+                    headers=self._request_manager.json_headers(),
+                )
+                parsed = None
+                if response.status == 200:
+                    parsed = models.parse_joints_state_response(json.loads(response.data))
+
+                is_user_error = response.status >= 400 and response.status <= 500
+                is_unavailable = response.status == 503
+                if parsed is None and (is_user_error or is_unavailable):
+                    parsed = models.parse_error_response(json.loads(response.data))
+
+                return Response(
+                    parsed,
+                    response.status,
+                    response
+                )
+            except urllib3.exceptions.MaxRetryError:
+                return Response(
+                    models.ErrorResponse(
+                        error=models.ErrorEnum.InternalServerError,
+                        message="Connection Refused"
+                    ),
+                    503,
+                    None
+                )
+
+    bot_identity: BotIdentity
+    joints: Joints
+
+    def __init__(self, request_manager: RequestManager):
+        self._request_manager = request_manager
+        self.bot_identity = General.BotIdentity(request_manager)
+        self.joints = General.Joints(request_manager)
+
 class ChatGPT:
     _request_manager: RequestManager
     class Data:
@@ -1134,63 +1294,6 @@ class IO:
         self.control = IO.Control(request_manager)
         self.status = IO.Status(request_manager)
 
-class General:
-    _request_manager: RequestManager
-    class Joints:
-        def __init__(self, request_manager: RequestManager):
-            self._request_manager = request_manager
-
-
-        def get_joints_state(
-            self,
-        ) -> Response[
-            Union[
-                models.JointsStateResponse,
-                models.ErrorResponse,
-                None
-            ],
-            models.JointsStateResponse
-        ]:
-            """
-            Retrieves information about the state of each joint
-            """
-            path = "/api/v1/joints"
-            try:
-                response = self._request_manager.request(
-                    "GET",
-                    path,
-                    headers=self._request_manager.json_headers(),
-                )
-                parsed = None
-                if response.status == 200:
-                    parsed = models.parse_joints_state_response(json.loads(response.data))
-
-                is_user_error = response.status >= 400 and response.status <= 500
-                is_unavailable = response.status == 503
-                if parsed is None and (is_user_error or is_unavailable):
-                    parsed = models.parse_error_response(json.loads(response.data))
-
-                return Response(
-                    parsed,
-                    response.status,
-                    response
-                )
-            except urllib3.exceptions.MaxRetryError:
-                return Response(
-                    models.ErrorResponse(
-                        error=models.ErrorEnum.InternalServerError,
-                        message="Connection Refused"
-                    ),
-                    503,
-                    None
-                )
-
-    joints: Joints
-
-    def __init__(self, request_manager: RequestManager):
-        self._request_manager = request_manager
-        self.joints = General.Joints(request_manager)
-
 class Poses:
     _request_manager: RequestManager
     class ConstructPose:
@@ -1660,15 +1763,15 @@ class Recovery:
             self,
         ) -> Response[
             Union[
-                models.RecoveryStatusResponse,
+                models.FailureStateResponse,
                 models.ErrorResponse,
                 models.ErrorResponse,
                 None
             ],
-            models.RecoveryStatusResponse
+            models.FailureStateResponse
         ]:
             """
-            Recovers the robot from a fault state.
+            Attempts to recover the robot from a fault state. Inspect the response to determine if additional recovery actions are required.
 
             """
             path = "/api/v1/recovery/recover"
@@ -1680,7 +1783,7 @@ class Recovery:
                 )
                 parsed = None
                 if response.status == 200:
-                    parsed = models.parse_recovery_status_response(json.loads(response.data))
+                    parsed = models.parse_failure_state_response(json.loads(response.data))
                 if response.status == 400:
                     parsed = models.parse_error_response(json.loads(response.data))
 
@@ -2491,9 +2594,9 @@ class StandardBotsRobot(Default):
     movement: Movement
     camera: Camera
     faults: Faults
+    general: General
     chat_gpt: ChatGPT
     io: IO
-    general: General
     poses: Poses
     recovery: Recovery
     ros: ROS
@@ -2515,9 +2618,9 @@ class StandardBotsRobot(Default):
         self.movement = Movement(self._request_manager)
         self.camera = Camera(self._request_manager)
         self.faults = Faults(self._request_manager)
+        self.general = General(self._request_manager)
         self.chat_gpt = ChatGPT(self._request_manager)
         self.io = IO(self._request_manager)
-        self.general = General(self._request_manager)
         self.poses = Poses(self._request_manager)
         self.recovery = Recovery(self._request_manager)
         self.ros = ROS(self._request_manager)