bosdyn-client 5.0.1__py3-none-any.whl → 5.0.1.2__py3-none-any.whl

bosdyn/client/audio_visual.py

@@ -145,6 +145,98 @@ class AudioVisualClient(BaseClient):
                                error_from_response=_stop_behavior_error, copy_request=False,
                                **kwargs)
 
+    def add_or_modify_behavior(self, name, behavior, **kwargs):
+        """Add or modify an AudioVisualBehavior.
+
+        Args:
+            name: The name of the behavior to add.
+            behavior: The AudioVisualBehavior proto to add.
+
+        Returns:
+            The LiveAudioVisualBehavior proto that was just added or modified.
+
+        Raises:
+            RpcError: Problem communicating with the robot.
+            PermanentBehaviorError: The behavior specified is permanent and cannot be modified.
+            InvalidBehaviorError: The request contained a behavior with invalid fields.
+        """
+        # Clamp and normalize colors in the behavior before sending the request.
+        led_sequence_group = getattr(behavior, "led_sequence_group", None)
+        if led_sequence_group is not None:
+            behavior.led_sequence_group.CopyFrom(check_color(led_sequence_group))
+
+        req = audio_visual_pb2.AddOrModifyBehaviorRequest(name=name, behavior=behavior)
+        return self.call(self._stub.AddOrModifyBehavior, req,
+                         value_from_response=_get_live_behavior,
+                         error_from_response=_add_or_modify_behavior_error, copy_request=False,
+                         **kwargs)
+
+    def add_or_modify_behavior_async(self, name, behavior, **kwargs):
+        """Add or modify an AudioVisualBehavior.
+
+        Args:
+            name: The name of the behavior to add.
+            behavior: The AudioVisualBehavior proto to add.
+
+        Returns:
+            The LiveAudioVisualBehavior proto that was just added or modified.
+
+        Raises:
+            RpcError: Problem communicating with the robot.
+            PermanentBehaviorError: The behavior specified is permanent and cannot be modified.
+            InvalidBehaviorError: The request contained a behavior with invalid fields.
+        """
+        # Clamp and normalize colors in the behavior before sending the request.
+        led_sequence_group = getattr(behavior, "led_sequence_group", None)
+        if led_sequence_group is not None:
+            behavior.led_sequence_group.CopyFrom(check_color(led_sequence_group))
+
+        req = audio_visual_pb2.AddOrModifyBehaviorRequest(name=name, behavior=behavior)
+        return self.call_async(self._stub.AddOrModifyBehavior, req,
+                               value_from_response=_get_live_behavior,
+                               error_from_response=_add_or_modify_behavior_error,
+                               copy_request=False, **kwargs)
+
+    def delete_behaviors(self, behavior_names, **kwargs):
+        """Delete an AudioVisualBehavior.
+
+        Args:
+            behavior_names: A list of behavior names to delete.
+
+        Returns:
+            A list of LiveAudioVisualBehavior protos that were deleted.
+
+        Raises:
+            RpcError: Problem communicating with the robot.
+            DoesNotExistError: A specified behavior name has not been added to the system.
+            PermanentBehaviorError: A specified behavior is permanent and cannot be deleted.
+        """
+
+        req = audio_visual_pb2.DeleteBehaviorsRequest(behavior_names=behavior_names)
+        return self.call(self._stub.DeleteBehaviors, req,
+                         value_from_response=_get_deleted_behaviors,
+                         error_from_response=_delete_behaviors_error, copy_request=False, **kwargs)
+
+    def delete_behaviors_async(self, behavior_names, **kwargs):
+        """Async version of delete_behaviors().
+
+        Args:
+            behavior_names: A list of behavior names to delete.
+
+        Returns:
+            A list of LiveAudioVisualBehavior protos that were deleted.
+
+        Raises:
+            RpcError: Problem communicating with the robot.
+            DoesNotExistError: A specified behavior name has not been added to the system.
+            PermanentBehaviorError: A specified behavior is permanent and cannot be deleted.
+        """
+
+        req = audio_visual_pb2.DeleteBehaviorsRequest(behavior_names=behavior_names)
+        return self.call_async(self._stub.DeleteBehaviors, req,
+                               value_from_response=_get_deleted_behaviors,
+                               error_from_response=_delete_behaviors_error, copy_request=False,
+                               **kwargs)
 
     def list_behaviors(self, **kwargs):
         """List all currently added AudioVisualBehaviors.
@@ -301,6 +393,9 @@ def _get_live_behavior(response):
     return response.live_behavior
 
 
+def _get_deleted_behaviors(response):
+    return response.deleted_behaviors
+
 
 _AUDIO_VISUAL_RUN_BEHAVIOR_STATUS_TO_ERROR = collections.defaultdict(
     lambda: (AudioVisualResponseError, None))
@@ -317,6 +412,25 @@ _AUDIO_VISUAL_STOP_BEHAVIOR_STATUS_TO_ERROR.update({
     audio_visual_pb2.StopBehaviorResponse.STATUS_INVALID_CLIENT: error_pair(InvalidClientError)
 })
 
+_AUDIO_VISUAL_ADD_OR_MODIFY_BEHAVIOR_STATUS_TO_ERROR = collections.defaultdict(
+    lambda: (AudioVisualResponseError, None))
+_AUDIO_VISUAL_ADD_OR_MODIFY_BEHAVIOR_STATUS_TO_ERROR.update({
+    audio_visual_pb2.AddOrModifyBehaviorResponse.STATUS_SUCCESS: (None, None),
+    audio_visual_pb2.AddOrModifyBehaviorResponse.STATUS_INVALID:
+        error_pair(InvalidBehaviorError),
+    audio_visual_pb2.AddOrModifyBehaviorResponse.STATUS_MODIFY_PERMANENT:
+        error_pair(PermanentBehaviorError),
+})
+
+_AUDIO_VISUAL_DELETE_BEHAVIORS_STATUS_TO_ERROR = collections.defaultdict(
+    lambda: (AudioVisualResponseError, None))
+_AUDIO_VISUAL_DELETE_BEHAVIORS_STATUS_TO_ERROR.update({
+    audio_visual_pb2.DeleteBehaviorsResponse.STATUS_SUCCESS: (None, None),
+    audio_visual_pb2.DeleteBehaviorsResponse.STATUS_DOES_NOT_EXIST:
+        error_pair(DoesNotExistError),
+    audio_visual_pb2.DeleteBehaviorsResponse.STATUS_DELETE_PERMANENT:
+        error_pair(PermanentBehaviorError),
+})
 
 
 @handle_common_header_errors
@@ -337,3 +451,66 @@ def _stop_behavior_error(response):
                          status_to_error=_AUDIO_VISUAL_STOP_BEHAVIOR_STATUS_TO_ERROR)
 
 
+@handle_common_header_errors
+@handle_unset_status_error(unset='STATUS_UNKNOWN')
+def _add_or_modify_behavior_error(response):
+    """AddOrModifyBehaviorResponse response to exception."""
+    return error_factory(response, response.status,
+                         status_to_string=audio_visual_pb2.AddOrModifyBehaviorResponse.Status.Name,
+                         status_to_error=_AUDIO_VISUAL_ADD_OR_MODIFY_BEHAVIOR_STATUS_TO_ERROR)
+
+
+@handle_common_header_errors
+@handle_unset_status_error(unset='STATUS_UNKNOWN')
+def _delete_behaviors_error(response):
+    """DeleteBehaviorResponse response to exception."""
+    return error_factory(response, response.status,
+                         status_to_string=audio_visual_pb2.DeleteBehaviorsResponse.Status.Name,
+                         status_to_error=_AUDIO_VISUAL_DELETE_BEHAVIORS_STATUS_TO_ERROR)
+
+
+def check_color(led_sequence_group):
+    # Check every LED
+    leds = ["center", "front_left", "front_right", "hind_left", "hind_right"]
+    for led in leds:
+        # Get the LED sequence by location
+        led_sequence = getattr(led_sequence_group, led, None)
+        if led_sequence is not None:
+            # Now, normalize the color in the LED sequence by location
+            if led_sequence.HasField("animation_sequence"):
+                for idx, frame in enumerate(led_sequence.animation_sequence.frames):
+                    if frame.HasField("color"):
+                        led_sequence.animation_sequence.frames[idx].color.CopyFrom(
+                            clamp_and_normalize_color(frame.color))
+            elif led_sequence.HasField("blink_sequence"):
+                if led_sequence.blink_sequence.HasField("color"):
+                    led_sequence.blink_sequence.color.CopyFrom(
+                        clamp_and_normalize_color(led_sequence.blink_sequence.color))
+            elif led_sequence.HasField("pulse_sequence"):
+                if led_sequence.pulse_sequence.HasField("color"):
+                    led_sequence.pulse_sequence.color.CopyFrom(
+                        clamp_and_normalize_color(led_sequence.pulse_sequence.color))
+            elif led_sequence.HasField("synced_blink_sequence"):
+                if led_sequence.synced_blink_sequence.HasField("color"):
+                    led_sequence.synced_blink_sequence.color.CopyFrom(
+                        clamp_and_normalize_color(led_sequence.synced_blink_sequence.color))
+            elif led_sequence.HasField("solid_color_sequence"):
+                if led_sequence.solid_color_sequence.HasField("color"):
+                    led_sequence.solid_color_sequence.color.CopyFrom(
+                        clamp_and_normalize_color(led_sequence.solid_color_sequence.color))
+    return led_sequence_group
+
+
+# Scale color so that their Euclidean norm does not exceed max_color_magnitude.
+# NOTE: max_color_magnitude of 255 (roughly 50% of sqrt(3*255^2)=441.67) is a heuristic chosen to prevent damage to the robot's LEDs.
+# Exceeding this value may result in damage to the robot's LEDs that will NOT be covered under warranty.
+def clamp_and_normalize_color(color, max_color_magnitude=255):
+    r, g, b = color.rgb.r, color.rgb.g, color.rgb.b
+    norm = math.sqrt(r**2 + g**2 + b**2)
+    if norm > max_color_magnitude and norm > 0:
+        scale = max_color_magnitude / norm
+        scaled_color = audio_visual_pb2.Color(
+            rgb=audio_visual_pb2.Color.RGB(r=int(r * scale), g=int(g * scale), b=int(b * scale)))
+        print(f"Input color {color} scaled by {scale:.2f}. Clamped color: {scaled_color}.")
+        color = scaled_color
+    return color

bosdyn/client/sdk.py

@@ -64,6 +64,7 @@ from .spot_check import SpotCheckClient
 from .time_sync import TimeSyncClient
 from .world_object import WorldObjectClient
 
+from .audio_visual import AudioVisualClient  # isort:skip
 
 
 class SdkError(Error):
@@ -111,6 +112,7 @@ _DEFAULT_SERVICE_CLIENTS = [
     AuthClient,
     AutoReturnClient,
     AutowalkClient,
+    AudioVisualClient,
     DataAcquisitionClient,
     DataAcquisitionStoreClient,
     DataBufferClient,

{bosdyn_client-5.0.1.dist-info → bosdyn_client-5.0.1.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: bosdyn-client
-Version: 5.0.1
+Version: 5.0.1.2
 Summary: Boston Dynamics API client code and interfaces
 Home-page: https://dev.bostondynamics.com/
 Author: Boston Dynamics
@@ -15,8 +15,8 @@ Classifier: License :: Other/Proprietary License
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
-Requires-Dist: bosdyn-api (==5.0.1)
-Requires-Dist: bosdyn-core (==5.0.1)
+Requires-Dist: bosdyn-api (==5.0.1.2)
+Requires-Dist: bosdyn-core (==5.0.1.2)
 Requires-Dist: grpcio
 Requires-Dist: pyjwt
 Requires-Dist: numpy

{bosdyn_client-5.0.1.dist-info → bosdyn_client-5.0.1.2.dist-info}/RECORD

@@ -8,7 +8,7 @@ bosdyn/client/area_callback_service_servicer.py,sha256=o1kYKV83Q-ud-_rmT17XTSqBd
 bosdyn/client/area_callback_service_utils.py,sha256=R8ljJe8fPszMI6RyuGRyv_QGu63kw1yZAveZydlpERI,5858
 bosdyn/client/arm_surface_contact.py,sha256=DRfPfsFEzfk6ufe080ViqasUefl2ZUtcvcNENgcf55k,3710
 bosdyn/client/async_tasks.py,sha256=gEPev6_jaUCe-G5PqktMiMGb7ohDy0daunxzQD5jafg,5594
-bosdyn/client/audio_visual.py,sha256=yfGy7qL6WRvYPE_gAzBJLzQ8Aucc_u5Hkb_L8fJ-Jyc,14230
+bosdyn/client/audio_visual.py,sha256=MVwmcAtBQ4xcAY-pYsbKtoAti_2jwQH2a02zNkW-ixY,23150
 bosdyn/client/audio_visual_helpers.py,sha256=9qksn7epH5jBdbwa6VVMcm2mn8HCVtJuSW1C847Jo6w,4499
 bosdyn/client/auth.py,sha256=YLo6jP0Ssl_Z6rHtTiPiKUNIweDRYub9w3iHdUe6n40,5302
 bosdyn/client/auto_return.py,sha256=kqT1gaaneLYIPFVAFzpvTHRwa8NYYQ2OBf7wViBQudE,5598
@@ -66,7 +66,7 @@ bosdyn/client/robot.py,sha256=XQCp9NjcwS4Bhhohjup_AcLlYm67DV0tlPxuqZTwU1M,31114
 bosdyn/client/robot_command.py,sha256=LtoVKlJwwhTmADRMvJIWJ4B5rY_MpdhHnL72zKm1ECU,108248
 bosdyn/client/robot_id.py,sha256=0VZHG9hltwTLAm1_Bt26Xq1O6EROswqNwHvjY7kaplk,2482
 bosdyn/client/robot_state.py,sha256=h551ke5eHdAC7NgVuLphY8FZR899Ii8_lYwuoX1w1nk,7073
-bosdyn/client/sdk.py,sha256=UFG5sRbnzEiB7hlUBIPm9KVceBrEOLGDuLQJtoIdyzM,12864
+bosdyn/client/sdk.py,sha256=XGW0DqlBfZv31LNYjjtU8p-86C5U-x2zJd7bAF3eDzg,12945
 bosdyn/client/server_util.py,sha256=uLT12vs5nAhdJ0ryaKuE82dxXnBOupebyDuzI8tbLRo,10560
 bosdyn/client/service_customization_helpers.py,sha256=GD23vhBfwCi1S4eBYIBoTbvHe9kwap1cbq0CHXlciGw,49155
 bosdyn/client/signals_helpers.py,sha256=Sp91IrMxVU-PeH6TK2njzFCKmFMyshRJqNa4DYRMqDU,3682
@@ -97,7 +97,7 @@ bosdyn/client/spot_cam/power.py,sha256=HS3nJF8hXq9m1JziOIwLHGLtlNMyLgewWBgs-mRZm
 bosdyn/client/spot_cam/ptz.py,sha256=O1m7zDZ92zRmvy9qhjojiphMQwAweTO0HVizQFdWFFE,10630
 bosdyn/client/spot_cam/streamquality.py,sha256=e-RjizZPwZSOS4Jlqb5Ds-mC6uKam252dpEHkb58Oc8,6364
 bosdyn/client/spot_cam/version.py,sha256=R82eyCAY9PfZqbN8D6hNzSeZatpgpsFr995dRt1Mbe0,2856
-bosdyn_client-5.0.1.dist-info/METADATA,sha256=RYhDRNp8XDqkZmc5omW_vvTfEGEEpRYEAy3o961WbZg,3987
-bosdyn_client-5.0.1.dist-info/WHEEL,sha256=AtBG6SXL3KF_v0NxLf0ehyVOh0cold-JbJYXNGorC6Q,92
-bosdyn_client-5.0.1.dist-info/top_level.txt,sha256=an2OWgx1ej2jFjmBjPWNQ68ZglvUfKhmXWW-WhTtDmA,7
-bosdyn_client-5.0.1.dist-info/RECORD,,
+bosdyn_client-5.0.1.2.dist-info/METADATA,sha256=6Lup1U3iViBamJWCL5qGN3kg3x_YaQ1OH_uxJqLnilE,3993
+bosdyn_client-5.0.1.2.dist-info/WHEEL,sha256=AtBG6SXL3KF_v0NxLf0ehyVOh0cold-JbJYXNGorC6Q,92
+bosdyn_client-5.0.1.2.dist-info/top_level.txt,sha256=an2OWgx1ej2jFjmBjPWNQ68ZglvUfKhmXWW-WhTtDmA,7
+bosdyn_client-5.0.1.2.dist-info/RECORD,,