viam-sdk 0.45.2__py3-none-win_amd64.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of viam-sdk might be problematic. Click here for more details.
- viam/__init__.py +71 -0
- viam/app/__init__.py +0 -0
- viam/app/_logs.py +34 -0
- viam/app/app_client.py +2525 -0
- viam/app/billing_client.py +143 -0
- viam/app/data_client.py +1715 -0
- viam/app/ml_training_client.py +251 -0
- viam/app/provisioning_client.py +95 -0
- viam/app/viam_client.py +260 -0
- viam/components/__init__.py +0 -0
- viam/components/arm/__init__.py +16 -0
- viam/components/arm/arm.py +223 -0
- viam/components/arm/client.py +124 -0
- viam/components/arm/service.py +123 -0
- viam/components/audio_input/__init__.py +18 -0
- viam/components/audio_input/audio_input.py +81 -0
- viam/components/audio_input/client.py +70 -0
- viam/components/audio_input/service.py +114 -0
- viam/components/base/__init__.py +13 -0
- viam/components/base/base.py +260 -0
- viam/components/base/client.py +153 -0
- viam/components/base/service.py +138 -0
- viam/components/board/__init__.py +9 -0
- viam/components/board/board.py +414 -0
- viam/components/board/client.py +241 -0
- viam/components/board/service.py +223 -0
- viam/components/button/__init__.py +10 -0
- viam/components/button/button.py +41 -0
- viam/components/button/client.py +52 -0
- viam/components/button/service.py +46 -0
- viam/components/camera/__init__.py +22 -0
- viam/components/camera/camera.py +138 -0
- viam/components/camera/client.py +98 -0
- viam/components/camera/service.py +105 -0
- viam/components/component_base.py +65 -0
- viam/components/encoder/__init__.py +18 -0
- viam/components/encoder/client.py +83 -0
- viam/components/encoder/encoder.py +118 -0
- viam/components/encoder/service.py +72 -0
- viam/components/gantry/__init__.py +11 -0
- viam/components/gantry/client.py +115 -0
- viam/components/gantry/gantry.py +156 -0
- viam/components/gantry/service.py +113 -0
- viam/components/generic/__init__.py +18 -0
- viam/components/generic/client.py +62 -0
- viam/components/generic/generic.py +76 -0
- viam/components/generic/service.py +40 -0
- viam/components/gripper/__init__.py +11 -0
- viam/components/gripper/client.py +85 -0
- viam/components/gripper/gripper.py +114 -0
- viam/components/gripper/service.py +81 -0
- viam/components/input/__init__.py +15 -0
- viam/components/input/client.py +194 -0
- viam/components/input/input.py +297 -0
- viam/components/input/service.py +175 -0
- viam/components/motor/__init__.py +11 -0
- viam/components/motor/client.py +168 -0
- viam/components/motor/motor.py +301 -0
- viam/components/motor/service.py +150 -0
- viam/components/movement_sensor/__init__.py +21 -0
- viam/components/movement_sensor/client.py +161 -0
- viam/components/movement_sensor/movement_sensor.py +253 -0
- viam/components/movement_sensor/service.py +146 -0
- viam/components/pose_tracker/__init__.py +17 -0
- viam/components/pose_tracker/client.py +50 -0
- viam/components/pose_tracker/pose_tracker.py +40 -0
- viam/components/pose_tracker/service.py +45 -0
- viam/components/power_sensor/__init__.py +17 -0
- viam/components/power_sensor/client.py +86 -0
- viam/components/power_sensor/power_sensor.py +104 -0
- viam/components/power_sensor/service.py +72 -0
- viam/components/sensor/__init__.py +18 -0
- viam/components/sensor/client.py +49 -0
- viam/components/sensor/sensor.py +48 -0
- viam/components/sensor/service.py +51 -0
- viam/components/servo/__init__.py +11 -0
- viam/components/servo/client.py +86 -0
- viam/components/servo/service.py +80 -0
- viam/components/servo/servo.py +114 -0
- viam/components/switch/__init__.py +10 -0
- viam/components/switch/client.py +83 -0
- viam/components/switch/service.py +72 -0
- viam/components/switch/switch.py +95 -0
- viam/errors.py +105 -0
- viam/gen/__init__.py +0 -0
- viam/gen/app/__init__.py +0 -0
- viam/gen/app/agent/__init__.py +0 -0
- viam/gen/app/agent/v1/__init__.py +0 -0
- viam/gen/app/agent/v1/agent_grpc.py +29 -0
- viam/gen/app/agent/v1/agent_pb2.py +47 -0
- viam/gen/app/agent/v1/agent_pb2.pyi +280 -0
- viam/gen/app/cloudslam/__init__.py +0 -0
- viam/gen/app/cloudslam/v1/__init__.py +0 -0
- viam/gen/app/cloudslam/v1/cloud_slam_grpc.py +70 -0
- viam/gen/app/cloudslam/v1/cloud_slam_pb2.py +54 -0
- viam/gen/app/cloudslam/v1/cloud_slam_pb2.pyi +384 -0
- viam/gen/app/data/__init__.py +0 -0
- viam/gen/app/data/v1/__init__.py +0 -0
- viam/gen/app/data/v1/data_grpc.py +206 -0
- viam/gen/app/data/v1/data_pb2.py +178 -0
- viam/gen/app/data/v1/data_pb2.pyi +1485 -0
- viam/gen/app/datapipelines/__init__.py +0 -0
- viam/gen/app/datapipelines/v1/__init__.py +0 -0
- viam/gen/app/datapipelines/v1/data_pipelines_grpc.py +84 -0
- viam/gen/app/datapipelines/v1/data_pipelines_pb2.py +56 -0
- viam/gen/app/datapipelines/v1/data_pipelines_pb2.pyi +370 -0
- viam/gen/app/dataset/__init__.py +0 -0
- viam/gen/app/dataset/v1/__init__.py +0 -0
- viam/gen/app/dataset/v1/dataset_grpc.py +60 -0
- viam/gen/app/dataset/v1/dataset_pb2.py +40 -0
- viam/gen/app/dataset/v1/dataset_pb2.pyi +179 -0
- viam/gen/app/datasync/__init__.py +0 -0
- viam/gen/app/datasync/v1/__init__.py +0 -0
- viam/gen/app/datasync/v1/data_sync_grpc.py +47 -0
- viam/gen/app/datasync/v1/data_sync_pb2.py +70 -0
- viam/gen/app/datasync/v1/data_sync_pb2.pyi +425 -0
- viam/gen/app/mlinference/__init__.py +0 -0
- viam/gen/app/mlinference/v1/__init__.py +0 -0
- viam/gen/app/mlinference/v1/ml_inference_grpc.py +28 -0
- viam/gen/app/mlinference/v1/ml_inference_pb2.py +23 -0
- viam/gen/app/mlinference/v1/ml_inference_pb2.pyi +63 -0
- viam/gen/app/mltraining/__init__.py +0 -0
- viam/gen/app/mltraining/v1/__init__.py +0 -0
- viam/gen/app/mltraining/v1/ml_training_grpc.py +78 -0
- viam/gen/app/mltraining/v1/ml_training_pb2.py +124 -0
- viam/gen/app/mltraining/v1/ml_training_pb2.pyi +415 -0
- viam/gen/app/packages/__init__.py +0 -0
- viam/gen/app/packages/v1/__init__.py +0 -0
- viam/gen/app/packages/v1/packages_grpc.py +54 -0
- viam/gen/app/packages/v1/packages_pb2.py +52 -0
- viam/gen/app/packages/v1/packages_pb2.pyi +311 -0
- viam/gen/app/v1/__init__.py +0 -0
- viam/gen/app/v1/app_grpc.py +863 -0
- viam/gen/app/v1/app_pb2.py +649 -0
- viam/gen/app/v1/app_pb2.pyi +5279 -0
- viam/gen/app/v1/billing_grpc.py +76 -0
- viam/gen/app/v1/billing_pb2.py +92 -0
- viam/gen/app/v1/billing_pb2.pyi +463 -0
- viam/gen/app/v1/end_user_grpc.py +59 -0
- viam/gen/app/v1/end_user_pb2.py +55 -0
- viam/gen/app/v1/end_user_pb2.pyi +181 -0
- viam/gen/app/v1/robot_grpc.py +55 -0
- viam/gen/app/v1/robot_pb2.py +127 -0
- viam/gen/app/v1/robot_pb2.pyi +1202 -0
- viam/gen/common/__init__.py +0 -0
- viam/gen/common/v1/__init__.py +0 -0
- viam/gen/common/v1/common_grpc.py +0 -0
- viam/gen/common/v1/common_pb2.py +78 -0
- viam/gen/common/v1/common_pb2.pyi +687 -0
- viam/gen/component/__init__.py +0 -0
- viam/gen/component/arm/__init__.py +0 -0
- viam/gen/component/arm/v1/__init__.py +0 -0
- viam/gen/component/arm/v1/arm_grpc.py +102 -0
- viam/gen/component/arm/v1/arm_pb2.py +74 -0
- viam/gen/component/arm/v1/arm_pb2.pyi +344 -0
- viam/gen/component/audioinput/__init__.py +0 -0
- viam/gen/component/audioinput/v1/__init__.py +0 -0
- viam/gen/component/audioinput/v1/audioinput_grpc.py +63 -0
- viam/gen/component/audioinput/v1/audioinput_pb2.py +45 -0
- viam/gen/component/audioinput/v1/audioinput_pb2.pyi +179 -0
- viam/gen/component/base/__init__.py +0 -0
- viam/gen/component/base/v1/__init__.py +0 -0
- viam/gen/component/base/v1/base_grpc.py +94 -0
- viam/gen/component/base/v1/base_pb2.py +66 -0
- viam/gen/component/base/v1/base_pb2.pyi +258 -0
- viam/gen/component/board/__init__.py +0 -0
- viam/gen/component/board/v1/__init__.py +0 -0
- viam/gen/component/board/v1/board_grpc.py +127 -0
- viam/gen/component/board/v1/board_pb2.py +103 -0
- viam/gen/component/board/v1/board_pb2.pyi +496 -0
- viam/gen/component/button/__init__.py +0 -0
- viam/gen/component/button/v1/__init__.py +0 -0
- viam/gen/component/button/v1/button_grpc.py +38 -0
- viam/gen/component/button/v1/button_pb2.py +28 -0
- viam/gen/component/button/v1/button_pb2.pyi +39 -0
- viam/gen/component/camera/__init__.py +0 -0
- viam/gen/component/camera/v1/__init__.py +0 -0
- viam/gen/component/camera/v1/camera_grpc.py +79 -0
- viam/gen/component/camera/v1/camera_pb2.py +67 -0
- viam/gen/component/camera/v1/camera_pb2.pyi +373 -0
- viam/gen/component/encoder/__init__.py +0 -0
- viam/gen/component/encoder/v1/__init__.py +0 -0
- viam/gen/component/encoder/v1/encoder_grpc.py +62 -0
- viam/gen/component/encoder/v1/encoder_pb2.py +44 -0
- viam/gen/component/encoder/v1/encoder_pb2.pyi +147 -0
- viam/gen/component/gantry/__init__.py +0 -0
- viam/gen/component/gantry/v1/__init__.py +0 -0
- viam/gen/component/gantry/v1/gantry_grpc.py +86 -0
- viam/gen/component/gantry/v1/gantry_pb2.py +62 -0
- viam/gen/component/gantry/v1/gantry_pb2.pyi +239 -0
- viam/gen/component/generic/__init__.py +0 -0
- viam/gen/component/generic/v1/__init__.py +0 -0
- viam/gen/component/generic/v1/generic_grpc.py +37 -0
- viam/gen/component/generic/v1/generic_pb2.py +23 -0
- viam/gen/component/generic/v1/generic_pb2.pyi +6 -0
- viam/gen/component/gripper/__init__.py +0 -0
- viam/gen/component/gripper/v1/__init__.py +0 -0
- viam/gen/component/gripper/v1/gripper_grpc.py +70 -0
- viam/gen/component/gripper/v1/gripper_pb2.py +48 -0
- viam/gen/component/gripper/v1/gripper_pb2.pyi +137 -0
- viam/gen/component/inputcontroller/__init__.py +0 -0
- viam/gen/component/inputcontroller/v1/__init__.py +0 -0
- viam/gen/component/inputcontroller/v1/input_controller_grpc.py +71 -0
- viam/gen/component/inputcontroller/v1/input_controller_pb2.py +55 -0
- viam/gen/component/inputcontroller/v1/input_controller_pb2.pyi +243 -0
- viam/gen/component/motor/__init__.py +0 -0
- viam/gen/component/motor/v1/__init__.py +0 -0
- viam/gen/component/motor/v1/motor_grpc.py +118 -0
- viam/gen/component/motor/v1/motor_pb2.py +86 -0
- viam/gen/component/motor/v1/motor_pb2.pyi +368 -0
- viam/gen/component/movementsensor/__init__.py +0 -0
- viam/gen/component/movementsensor/v1/__init__.py +0 -0
- viam/gen/component/movementsensor/v1/movementsensor_grpc.py +110 -0
- viam/gen/component/movementsensor/v1/movementsensor_pb2.py +78 -0
- viam/gen/component/movementsensor/v1/movementsensor_pb2.pyi +384 -0
- viam/gen/component/posetracker/__init__.py +0 -0
- viam/gen/component/posetracker/v1/__init__.py +0 -0
- viam/gen/component/posetracker/v1/pose_tracker_grpc.py +46 -0
- viam/gen/component/posetracker/v1/pose_tracker_pb2.py +34 -0
- viam/gen/component/posetracker/v1/pose_tracker_pb2.pyi +79 -0
- viam/gen/component/powersensor/__init__.py +0 -0
- viam/gen/component/powersensor/v1/__init__.py +0 -0
- viam/gen/component/powersensor/v1/powersensor_grpc.py +62 -0
- viam/gen/component/powersensor/v1/powersensor_pb2.py +42 -0
- viam/gen/component/powersensor/v1/powersensor_pb2.pyi +124 -0
- viam/gen/component/sensor/__init__.py +0 -0
- viam/gen/component/sensor/v1/__init__.py +0 -0
- viam/gen/component/sensor/v1/sensor_grpc.py +45 -0
- viam/gen/component/sensor/v1/sensor_pb2.py +25 -0
- viam/gen/component/sensor/v1/sensor_pb2.pyi +6 -0
- viam/gen/component/servo/__init__.py +0 -0
- viam/gen/component/servo/v1/__init__.py +0 -0
- viam/gen/component/servo/v1/servo_grpc.py +70 -0
- viam/gen/component/servo/v1/servo_pb2.py +50 -0
- viam/gen/component/servo/v1/servo_pb2.pyi +150 -0
- viam/gen/component/switch/__init__.py +0 -0
- viam/gen/component/switch/v1/__init__.py +0 -0
- viam/gen/component/switch/v1/switch_grpc.py +54 -0
- viam/gen/component/switch/v1/switch_pb2.py +40 -0
- viam/gen/component/switch/v1/switch_pb2.pyi +109 -0
- viam/gen/component/testecho/__init__.py +0 -0
- viam/gen/component/testecho/v1/__init__.py +0 -0
- viam/gen/component/testecho/v1/testecho_grpc.py +52 -0
- viam/gen/component/testecho/v1/testecho_pb2.py +36 -0
- viam/gen/component/testecho/v1/testecho_pb2.pyi +114 -0
- viam/gen/module/__init__.py +0 -0
- viam/gen/module/v1/__init__.py +0 -0
- viam/gen/module/v1/module_grpc.py +61 -0
- viam/gen/module/v1/module_pb2.py +43 -0
- viam/gen/module/v1/module_pb2.pyi +211 -0
- viam/gen/proto/__init__.py +0 -0
- viam/gen/proto/rpc/__init__.py +0 -0
- viam/gen/proto/rpc/examples/__init__.py +0 -0
- viam/gen/proto/rpc/examples/echo/__init__.py +0 -0
- viam/gen/proto/rpc/examples/echo/v1/__init__.py +0 -0
- viam/gen/proto/rpc/examples/echo/v1/echo_grpc.py +44 -0
- viam/gen/proto/rpc/examples/echo/v1/echo_pb2.py +32 -0
- viam/gen/proto/rpc/examples/echo/v1/echo_pb2.pyi +87 -0
- viam/gen/proto/rpc/examples/echoresource/__init__.py +0 -0
- viam/gen/proto/rpc/examples/echoresource/v1/__init__.py +0 -0
- viam/gen/proto/rpc/examples/echoresource/v1/echoresource_grpc.py +43 -0
- viam/gen/proto/rpc/examples/echoresource/v1/echoresource_pb2.py +29 -0
- viam/gen/proto/rpc/examples/echoresource/v1/echoresource_pb2.pyi +93 -0
- viam/gen/proto/rpc/v1/__init__.py +0 -0
- viam/gen/proto/rpc/v1/auth_grpc.py +47 -0
- viam/gen/proto/rpc/v1/auth_pb2.py +34 -0
- viam/gen/proto/rpc/v1/auth_pb2.pyi +92 -0
- viam/gen/proto/rpc/webrtc/__init__.py +0 -0
- viam/gen/proto/rpc/webrtc/v1/__init__.py +0 -0
- viam/gen/proto/rpc/webrtc/v1/grpc_grpc.py +0 -0
- viam/gen/proto/rpc/webrtc/v1/grpc_pb2.py +43 -0
- viam/gen/proto/rpc/webrtc/v1/grpc_pb2.pyi +304 -0
- viam/gen/proto/rpc/webrtc/v1/signaling_grpc.py +54 -0
- viam/gen/proto/rpc/webrtc/v1/signaling_pb2.py +70 -0
- viam/gen/proto/rpc/webrtc/v1/signaling_pb2.pyi +496 -0
- viam/gen/provisioning/__init__.py +0 -0
- viam/gen/provisioning/v1/__init__.py +0 -0
- viam/gen/provisioning/v1/provisioning_grpc.py +51 -0
- viam/gen/provisioning/v1/provisioning_pb2.py +39 -0
- viam/gen/provisioning/v1/provisioning_pb2.pyi +188 -0
- viam/gen/robot/__init__.py +0 -0
- viam/gen/robot/v1/__init__.py +0 -0
- viam/gen/robot/v1/robot_grpc.py +208 -0
- viam/gen/robot/v1/robot_pb2.py +188 -0
- viam/gen/robot/v1/robot_pb2.pyi +1020 -0
- viam/gen/service/__init__.py +0 -0
- viam/gen/service/datamanager/__init__.py +0 -0
- viam/gen/service/datamanager/v1/__init__.py +0 -0
- viam/gen/service/datamanager/v1/data_manager_grpc.py +38 -0
- viam/gen/service/datamanager/v1/data_manager_pb2.py +28 -0
- viam/gen/service/datamanager/v1/data_manager_pb2.pyi +39 -0
- viam/gen/service/discovery/__init__.py +0 -0
- viam/gen/service/discovery/v1/__init__.py +0 -0
- viam/gen/service/discovery/v1/discovery_grpc.py +39 -0
- viam/gen/service/discovery/v1/discovery_pb2.py +29 -0
- viam/gen/service/discovery/v1/discovery_pb2.pyi +51 -0
- viam/gen/service/generic/__init__.py +0 -0
- viam/gen/service/generic/v1/__init__.py +0 -0
- viam/gen/service/generic/v1/generic_grpc.py +29 -0
- viam/gen/service/generic/v1/generic_pb2.py +21 -0
- viam/gen/service/generic/v1/generic_pb2.pyi +6 -0
- viam/gen/service/mlmodel/__init__.py +0 -0
- viam/gen/service/mlmodel/v1/__init__.py +0 -0
- viam/gen/service/mlmodel/v1/mlmodel_grpc.py +37 -0
- viam/gen/service/mlmodel/v1/mlmodel_pb2.py +83 -0
- viam/gen/service/mlmodel/v1/mlmodel_pb2.pyi +480 -0
- viam/gen/service/motion/__init__.py +0 -0
- viam/gen/service/motion/v1/__init__.py +0 -0
- viam/gen/service/motion/v1/motion_grpc.py +87 -0
- viam/gen/service/motion/v1/motion_pb2.py +97 -0
- viam/gen/service/motion/v1/motion_pb2.pyi +838 -0
- viam/gen/service/navigation/__init__.py +0 -0
- viam/gen/service/navigation/v1/__init__.py +0 -0
- viam/gen/service/navigation/v1/navigation_grpc.py +102 -0
- viam/gen/service/navigation/v1/navigation_pb2.py +84 -0
- viam/gen/service/navigation/v1/navigation_pb2.pyi +419 -0
- viam/gen/service/sensors/__init__.py +0 -0
- viam/gen/service/sensors/v1/__init__.py +0 -0
- viam/gen/service/sensors/v1/sensors_grpc.py +46 -0
- viam/gen/service/sensors/v1/sensors_pb2.py +68 -0
- viam/gen/service/sensors/v1/sensors_pb2.pyi +137 -0
- viam/gen/service/shell/__init__.py +0 -0
- viam/gen/service/shell/v1/__init__.py +0 -0
- viam/gen/service/shell/v1/shell_grpc.py +55 -0
- viam/gen/service/shell/v1/shell_pb2.py +45 -0
- viam/gen/service/shell/v1/shell_pb2.pyi +307 -0
- viam/gen/service/slam/__init__.py +0 -0
- viam/gen/service/slam/v1/__init__.py +0 -0
- viam/gen/service/slam/v1/slam_grpc.py +61 -0
- viam/gen/service/slam/v1/slam_pb2.py +51 -0
- viam/gen/service/slam/v1/slam_pb2.pyi +213 -0
- viam/gen/service/vision/__init__.py +0 -0
- viam/gen/service/vision/v1/__init__.py +0 -0
- viam/gen/service/vision/v1/vision_grpc.py +87 -0
- viam/gen/service/vision/v1/vision_pb2.py +69 -0
- viam/gen/service/vision/v1/vision_pb2.pyi +454 -0
- viam/gen/stream/__init__.py +0 -0
- viam/gen/stream/v1/__init__.py +0 -0
- viam/gen/stream/v1/stream_grpc.py +59 -0
- viam/gen/stream/v1/stream_pb2.py +39 -0
- viam/gen/stream/v1/stream_pb2.pyi +161 -0
- viam/gen/tagger/__init__.py +0 -0
- viam/gen/tagger/v1/__init__.py +0 -0
- viam/gen/tagger/v1/tagger_grpc.py +0 -0
- viam/gen/tagger/v1/tagger_pb2.py +16 -0
- viam/gen/tagger/v1/tagger_pb2.pyi +15 -0
- viam/logging.py +216 -0
- viam/media/__init__.py +0 -0
- viam/media/audio.py +16 -0
- viam/media/utils/__init__.py +0 -0
- viam/media/utils/pil/__init__.py +51 -0
- viam/media/utils/pil/viam_rgba_plugin.py +73 -0
- viam/media/viam_rgba.py +10 -0
- viam/media/video.py +217 -0
- viam/module/__init__.py +5 -0
- viam/module/module.py +281 -0
- viam/module/service.py +66 -0
- viam/module/types.py +23 -0
- viam/operations.py +124 -0
- viam/proto/__init__.py +0 -0
- viam/proto/app/__init__.py +554 -0
- viam/proto/app/agent/__init__.py +28 -0
- viam/proto/app/billing.py +58 -0
- viam/proto/app/cloudslam/__init__.py +48 -0
- viam/proto/app/data/__init__.py +138 -0
- viam/proto/app/datapipelines/__init__.py +56 -0
- viam/proto/app/dataset/__init__.py +36 -0
- viam/proto/app/datasync/__init__.py +44 -0
- viam/proto/app/end_user.py +34 -0
- viam/proto/app/mlinference/__init__.py +15 -0
- viam/proto/app/mltraining/__init__.py +52 -0
- viam/proto/app/packages/__init__.py +38 -0
- viam/proto/app/robot.py +84 -0
- viam/proto/common/__init__.py +66 -0
- viam/proto/component/__init__.py +0 -0
- viam/proto/component/arm/__init__.py +48 -0
- viam/proto/component/audioinput/__init__.py +30 -0
- viam/proto/component/base/__init__.py +42 -0
- viam/proto/component/board/__init__.py +62 -0
- viam/proto/component/button/__init__.py +15 -0
- viam/proto/component/camera/__init__.py +46 -0
- viam/proto/component/encoder/__init__.py +28 -0
- viam/proto/component/gantry/__init__.py +40 -0
- viam/proto/component/generic/__init__.py +12 -0
- viam/proto/component/gripper/__init__.py +30 -0
- viam/proto/component/inputcontroller/__init__.py +38 -0
- viam/proto/component/motor/__init__.py +56 -0
- viam/proto/component/movementsensor/__init__.py +50 -0
- viam/proto/component/posetracker/__init__.py +19 -0
- viam/proto/component/powersensor/__init__.py +30 -0
- viam/proto/component/sensor/__init__.py +12 -0
- viam/proto/component/servo/__init__.py +32 -0
- viam/proto/component/switch/__init__.py +26 -0
- viam/proto/component/testecho/__init__.py +30 -0
- viam/proto/module/__init__.py +38 -0
- viam/proto/provisioning/__init__.py +36 -0
- viam/proto/robot/__init__.py +130 -0
- viam/proto/rpc/__init__.py +0 -0
- viam/proto/rpc/auth.py +34 -0
- viam/proto/rpc/examples/__init__.py +0 -0
- viam/proto/rpc/examples/echo/__init__.py +26 -0
- viam/proto/rpc/examples/echoresource/__init__.py +30 -0
- viam/proto/rpc/webrtc/__init__.py +0 -0
- viam/proto/rpc/webrtc/grpc.py +36 -0
- viam/proto/rpc/webrtc/signaling.py +58 -0
- viam/proto/service/__init__.py +0 -0
- viam/proto/service/datamanager/__init__.py +19 -0
- viam/proto/service/discovery/__init__.py +15 -0
- viam/proto/service/generic/__init__.py +12 -0
- viam/proto/service/mlmodel/__init__.py +54 -0
- viam/proto/service/motion/__init__.py +68 -0
- viam/proto/service/navigation/__init__.py +58 -0
- viam/proto/service/sensors/__init__.py +18 -0
- viam/proto/service/shell/__init__.py +36 -0
- viam/proto/service/slam/__init__.py +36 -0
- viam/proto/service/vision/__init__.py +46 -0
- viam/proto/stream/__init__.py +36 -0
- viam/proto/tagger/__init__.py +6 -0
- viam/py.typed +0 -0
- viam/resource/__init__.py +0 -0
- viam/resource/base.py +123 -0
- viam/resource/easy_resource.py +153 -0
- viam/resource/manager.py +126 -0
- viam/resource/registry.py +199 -0
- viam/resource/rpc_client_base.py +65 -0
- viam/resource/rpc_service_base.py +48 -0
- viam/resource/types.py +213 -0
- viam/robot/__init__.py +0 -0
- viam/robot/client.py +909 -0
- viam/robot/service.py +69 -0
- viam/rpc/__init__.py +0 -0
- viam/rpc/dial.py +420 -0
- viam/rpc/libviam_rust_utils.dll +0 -0
- viam/rpc/server.py +201 -0
- viam/rpc/signaling.py +29 -0
- viam/rpc/types.py +22 -0
- viam/services/__init__.py +0 -0
- viam/services/discovery/__init__.py +12 -0
- viam/services/discovery/client.py +55 -0
- viam/services/discovery/discovery.py +52 -0
- viam/services/discovery/service.py +43 -0
- viam/services/generic/__init__.py +18 -0
- viam/services/generic/client.py +58 -0
- viam/services/generic/generic.py +58 -0
- viam/services/generic/service.py +29 -0
- viam/services/mlmodel/__init__.py +24 -0
- viam/services/mlmodel/client.py +37 -0
- viam/services/mlmodel/mlmodel.py +78 -0
- viam/services/mlmodel/service.py +38 -0
- viam/services/mlmodel/utils.py +101 -0
- viam/services/motion/__init__.py +17 -0
- viam/services/motion/client.py +215 -0
- viam/services/motion/motion.py +378 -0
- viam/services/motion/service.py +132 -0
- viam/services/navigation/__init__.py +11 -0
- viam/services/navigation/client.py +99 -0
- viam/services/navigation/navigation.py +250 -0
- viam/services/navigation/service.py +137 -0
- viam/services/service_base.py +78 -0
- viam/services/service_client_base.py +46 -0
- viam/services/slam/__init__.py +17 -0
- viam/services/slam/client.py +62 -0
- viam/services/slam/service.py +75 -0
- viam/services/slam/slam.py +111 -0
- viam/services/vision/__init__.py +15 -0
- viam/services/vision/client.py +206 -0
- viam/services/vision/service.py +146 -0
- viam/services/vision/vision.py +315 -0
- viam/sessions_client.py +245 -0
- viam/streams.py +44 -0
- viam/utils.py +365 -0
- viam/version_metadata.py +4 -0
- viam_sdk-0.45.2.dist-info/METADATA +157 -0
- viam_sdk-0.45.2.dist-info/RECORD +476 -0
- viam_sdk-0.45.2.dist-info/WHEEL +4 -0
- viam_sdk-0.45.2.dist-info/licenses/LICENSE +202 -0
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
from grpclib.server import Stream
|
|
2
|
+
|
|
3
|
+
from viam.proto.common import DoCommandRequest, DoCommandResponse
|
|
4
|
+
from viam.proto.service.motion import (
|
|
5
|
+
GetPlanRequest,
|
|
6
|
+
GetPlanResponse,
|
|
7
|
+
GetPoseRequest,
|
|
8
|
+
GetPoseResponse,
|
|
9
|
+
ListPlanStatusesRequest,
|
|
10
|
+
ListPlanStatusesResponse,
|
|
11
|
+
MoveOnGlobeRequest,
|
|
12
|
+
MoveOnGlobeResponse,
|
|
13
|
+
MoveOnMapRequest,
|
|
14
|
+
MoveOnMapResponse,
|
|
15
|
+
MoveRequest,
|
|
16
|
+
MoveResponse,
|
|
17
|
+
StopPlanRequest,
|
|
18
|
+
StopPlanResponse,
|
|
19
|
+
UnimplementedMotionServiceBase,
|
|
20
|
+
)
|
|
21
|
+
from viam.resource.rpc_service_base import ResourceRPCServiceBase
|
|
22
|
+
from viam.utils import dict_to_struct, struct_to_dict
|
|
23
|
+
|
|
24
|
+
from .motion import Motion
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
class MotionRPCService(UnimplementedMotionServiceBase, ResourceRPCServiceBase[Motion]):
|
|
28
|
+
RESOURCE_TYPE = Motion
|
|
29
|
+
|
|
30
|
+
async def Move(self, stream: Stream[MoveRequest, MoveResponse]) -> None:
|
|
31
|
+
request = await stream.recv_message()
|
|
32
|
+
assert request is not None
|
|
33
|
+
service = self.get_resource(request.name)
|
|
34
|
+
timeout = stream.deadline.time_remaining() if stream.deadline else None
|
|
35
|
+
result = await service.move(
|
|
36
|
+
request.component_name,
|
|
37
|
+
request.destination,
|
|
38
|
+
request.world_state,
|
|
39
|
+
request.constraints,
|
|
40
|
+
extra=struct_to_dict(request.extra),
|
|
41
|
+
timeout=timeout,
|
|
42
|
+
)
|
|
43
|
+
response = MoveResponse(success=result)
|
|
44
|
+
await stream.send_message(response)
|
|
45
|
+
|
|
46
|
+
async def MoveOnMap(self, stream: Stream[MoveOnMapRequest, MoveOnMapResponse]) -> None:
|
|
47
|
+
request = await stream.recv_message()
|
|
48
|
+
assert request is not None
|
|
49
|
+
service = self.get_resource(request.name)
|
|
50
|
+
timeout = stream.deadline.time_remaining() if stream.deadline else None
|
|
51
|
+
result = await service.move_on_map(
|
|
52
|
+
request.component_name,
|
|
53
|
+
request.destination,
|
|
54
|
+
request.slam_service_name,
|
|
55
|
+
request.motion_configuration,
|
|
56
|
+
request.obstacles,
|
|
57
|
+
extra=struct_to_dict(request.extra),
|
|
58
|
+
timeout=timeout,
|
|
59
|
+
)
|
|
60
|
+
response = MoveOnMapResponse(execution_id=result)
|
|
61
|
+
await stream.send_message(response)
|
|
62
|
+
|
|
63
|
+
async def MoveOnGlobe(self, stream: Stream[MoveOnGlobeRequest, MoveOnGlobeResponse]) -> None:
|
|
64
|
+
request = await stream.recv_message()
|
|
65
|
+
assert request is not None
|
|
66
|
+
service = self.get_resource(request.name)
|
|
67
|
+
timeout = stream.deadline.time_remaining() if stream.deadline else None
|
|
68
|
+
result = await service.move_on_globe(
|
|
69
|
+
request.component_name,
|
|
70
|
+
request.destination,
|
|
71
|
+
request.movement_sensor_name,
|
|
72
|
+
request.obstacles,
|
|
73
|
+
request.heading,
|
|
74
|
+
request.motion_configuration,
|
|
75
|
+
bounding_regions=request.bounding_regions,
|
|
76
|
+
extra=struct_to_dict(request.extra),
|
|
77
|
+
timeout=timeout,
|
|
78
|
+
)
|
|
79
|
+
response = MoveOnGlobeResponse(execution_id=result)
|
|
80
|
+
await stream.send_message(response)
|
|
81
|
+
|
|
82
|
+
async def GetPose(self, stream: Stream[GetPoseRequest, GetPoseResponse]) -> None:
|
|
83
|
+
request = await stream.recv_message()
|
|
84
|
+
assert request is not None
|
|
85
|
+
service = self.get_resource(request.name)
|
|
86
|
+
timeout = stream.deadline.time_remaining() if stream.deadline else None
|
|
87
|
+
result = await service.get_pose(
|
|
88
|
+
request.component_name,
|
|
89
|
+
request.destination_frame,
|
|
90
|
+
request.supplemental_transforms,
|
|
91
|
+
extra=struct_to_dict(request.extra),
|
|
92
|
+
timeout=timeout,
|
|
93
|
+
)
|
|
94
|
+
response = GetPoseResponse(pose=result)
|
|
95
|
+
await stream.send_message(response)
|
|
96
|
+
|
|
97
|
+
async def StopPlan(self, stream: Stream[StopPlanRequest, StopPlanResponse]) -> None:
|
|
98
|
+
request = await stream.recv_message()
|
|
99
|
+
assert request is not None
|
|
100
|
+
service = self.get_resource(request.name)
|
|
101
|
+
timeout = stream.deadline.time_remaining() if stream.deadline else None
|
|
102
|
+
await service.stop_plan(request.component_name, extra=struct_to_dict(request.extra), timeout=timeout)
|
|
103
|
+
response = StopPlanResponse()
|
|
104
|
+
await stream.send_message(response)
|
|
105
|
+
|
|
106
|
+
async def ListPlanStatuses(self, stream: Stream[ListPlanStatusesRequest, ListPlanStatusesResponse]) -> None:
|
|
107
|
+
request = await stream.recv_message()
|
|
108
|
+
assert request is not None
|
|
109
|
+
service = self.get_resource(request.name)
|
|
110
|
+
timeout = stream.deadline.time_remaining() if stream.deadline else None
|
|
111
|
+
result = await service.list_plan_statuses(request.only_active_plans, extra=struct_to_dict(request.extra), timeout=timeout)
|
|
112
|
+
response = ListPlanStatusesResponse(plan_statuses_with_ids=result)
|
|
113
|
+
await stream.send_message(response)
|
|
114
|
+
|
|
115
|
+
async def GetPlan(self, stream: Stream[GetPlanRequest, GetPlanResponse]) -> None:
|
|
116
|
+
request = await stream.recv_message()
|
|
117
|
+
assert request is not None
|
|
118
|
+
service = self.get_resource(request.name)
|
|
119
|
+
timeout = stream.deadline.time_remaining() if stream.deadline else None
|
|
120
|
+
result = await service.get_plan(
|
|
121
|
+
request.component_name, request.last_plan_only, request.execution_id, extra=struct_to_dict(request.extra), timeout=timeout
|
|
122
|
+
)
|
|
123
|
+
await stream.send_message(result)
|
|
124
|
+
|
|
125
|
+
async def DoCommand(self, stream: Stream[DoCommandRequest, DoCommandResponse]) -> None:
|
|
126
|
+
request = await stream.recv_message()
|
|
127
|
+
assert request is not None
|
|
128
|
+
service = self.get_resource(request.name)
|
|
129
|
+
timeout = stream.deadline.time_remaining() if stream.deadline else None
|
|
130
|
+
result = await service.do_command(struct_to_dict(request.command), timeout=timeout, metadata=stream.metadata)
|
|
131
|
+
response = DoCommandResponse(result=dict_to_struct(result))
|
|
132
|
+
await stream.send_message(response)
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
from viam.proto.common import GeoGeometry, GeoPoint
|
|
2
|
+
from viam.proto.service.navigation import MapType, Mode, Path, Waypoint
|
|
3
|
+
from viam.resource.registry import Registry, ResourceRegistration
|
|
4
|
+
|
|
5
|
+
from .client import NavigationClient
|
|
6
|
+
from .navigation import Navigation
|
|
7
|
+
from .service import NavigationRPCService
|
|
8
|
+
|
|
9
|
+
__all__ = ["GeoPoint", "GeoGeometry", "NavigationClient", "Navigation", "Waypoint", "Mode", "Path", "MapType"]
|
|
10
|
+
|
|
11
|
+
Registry.register_api(ResourceRegistration(Navigation, NavigationRPCService, lambda name, channel: NavigationClient(name, channel)))
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
from typing import List, Mapping, Optional
|
|
2
|
+
|
|
3
|
+
from grpclib.client import Channel
|
|
4
|
+
|
|
5
|
+
from viam.proto.common import DoCommandRequest, DoCommandResponse
|
|
6
|
+
from viam.proto.service.navigation import (
|
|
7
|
+
AddWaypointRequest,
|
|
8
|
+
GetLocationRequest,
|
|
9
|
+
GetLocationResponse,
|
|
10
|
+
GetModeRequest,
|
|
11
|
+
GetModeResponse,
|
|
12
|
+
GetObstaclesRequest,
|
|
13
|
+
GetObstaclesResponse,
|
|
14
|
+
GetPathsRequest,
|
|
15
|
+
GetPathsResponse,
|
|
16
|
+
GetPropertiesRequest,
|
|
17
|
+
GetPropertiesResponse,
|
|
18
|
+
GetWaypointsRequest,
|
|
19
|
+
GetWaypointsResponse,
|
|
20
|
+
NavigationServiceStub,
|
|
21
|
+
Path,
|
|
22
|
+
RemoveWaypointRequest,
|
|
23
|
+
SetModeRequest,
|
|
24
|
+
)
|
|
25
|
+
from viam.resource.rpc_client_base import ReconfigurableResourceRPCClientBase
|
|
26
|
+
from viam.utils import ValueTypes, dict_to_struct, struct_to_dict
|
|
27
|
+
|
|
28
|
+
from . import GeoGeometry, GeoPoint, MapType, Mode, Waypoint
|
|
29
|
+
from .navigation import Navigation
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
class NavigationClient(Navigation, ReconfigurableResourceRPCClientBase):
|
|
33
|
+
"""
|
|
34
|
+
Connect to the NavigationService, which allows the robot to navigate to specified locations.
|
|
35
|
+
"""
|
|
36
|
+
|
|
37
|
+
client: NavigationServiceStub
|
|
38
|
+
|
|
39
|
+
def __init__(self, name: str, channel: Channel):
|
|
40
|
+
self.channel = channel
|
|
41
|
+
self.client = NavigationServiceStub(channel)
|
|
42
|
+
super().__init__(name)
|
|
43
|
+
|
|
44
|
+
async def get_paths(self, *, timeout: Optional[float] = None, **kwargs) -> List[Path]:
|
|
45
|
+
md = kwargs.get("metadata", self.Metadata()).proto
|
|
46
|
+
request = GetPathsRequest(name=self.name)
|
|
47
|
+
response: GetPathsResponse = await self.client.GetPaths(request, timeout=timeout, metadata=md)
|
|
48
|
+
return list(response.paths)
|
|
49
|
+
|
|
50
|
+
async def get_location(self, *, timeout: Optional[float] = None, **kwargs) -> GeoPoint:
|
|
51
|
+
md = kwargs.get("metadata", self.Metadata()).proto
|
|
52
|
+
request = GetLocationRequest(name=self.name)
|
|
53
|
+
response: GetLocationResponse = await self.client.GetLocation(request, timeout=timeout, metadata=md)
|
|
54
|
+
return response.location
|
|
55
|
+
|
|
56
|
+
async def get_obstacles(self, *, timeout: Optional[float] = None, **kwargs) -> List[GeoGeometry]:
|
|
57
|
+
md = kwargs.get("metadata", self.Metadata()).proto
|
|
58
|
+
request = GetObstaclesRequest(name=self.name)
|
|
59
|
+
response: GetObstaclesResponse = await self.client.GetObstacles(request, timeout=timeout, metadata=md)
|
|
60
|
+
return list(response.obstacles)
|
|
61
|
+
|
|
62
|
+
async def get_waypoints(self, *, timeout: Optional[float] = None, **kwargs) -> List[Waypoint]:
|
|
63
|
+
md = kwargs.get("metadata", self.Metadata()).proto
|
|
64
|
+
request = GetWaypointsRequest(name=self.name)
|
|
65
|
+
response: GetWaypointsResponse = await self.client.GetWaypoints(request, timeout=timeout, metadata=md)
|
|
66
|
+
return list(response.waypoints)
|
|
67
|
+
|
|
68
|
+
async def add_waypoint(self, point: GeoPoint, *, timeout: Optional[float] = None, **kwargs):
|
|
69
|
+
md = kwargs.get("metadata", self.Metadata()).proto
|
|
70
|
+
request = AddWaypointRequest(name=self.name, location=point)
|
|
71
|
+
await self.client.AddWaypoint(request, timeout=timeout, metadata=md)
|
|
72
|
+
|
|
73
|
+
async def remove_waypoint(self, id: str, *, timeout: Optional[float] = None, **kwargs):
|
|
74
|
+
md = kwargs.get("metadata", self.Metadata()).proto
|
|
75
|
+
request = RemoveWaypointRequest(name=self.name, id=id)
|
|
76
|
+
await self.client.RemoveWaypoint(request, timeout=timeout, metadata=md)
|
|
77
|
+
|
|
78
|
+
async def get_mode(self, *, timeout: Optional[float] = None, **kwargs) -> Mode.ValueType:
|
|
79
|
+
md = kwargs.get("metadata", self.Metadata()).proto
|
|
80
|
+
request = GetModeRequest(name=self.name)
|
|
81
|
+
response: GetModeResponse = await self.client.GetMode(request, timeout=timeout, metadata=md)
|
|
82
|
+
return response.mode
|
|
83
|
+
|
|
84
|
+
async def set_mode(self, mode: Mode.ValueType, *, timeout: Optional[float] = None, **kwargs):
|
|
85
|
+
md = kwargs.get("metadata", self.Metadata()).proto
|
|
86
|
+
request = SetModeRequest(name=self.name, mode=mode)
|
|
87
|
+
await self.client.SetMode(request, timeout=timeout, metadata=md)
|
|
88
|
+
|
|
89
|
+
async def get_properties(self, *, timeout: Optional[float] = None, **kwargs) -> MapType.ValueType:
|
|
90
|
+
md = kwargs.get("metadata", self.Metadata()).proto
|
|
91
|
+
request = GetPropertiesRequest(name=self.name)
|
|
92
|
+
response: GetPropertiesResponse = await self.client.GetProperties(request, timeout=timeout, metadata=md)
|
|
93
|
+
return response.map_type
|
|
94
|
+
|
|
95
|
+
async def do_command(self, command: Mapping[str, ValueTypes], *, timeout: Optional[float] = None, **kwargs) -> Mapping[str, ValueTypes]:
|
|
96
|
+
md = kwargs.get("metadata", self.Metadata()).proto
|
|
97
|
+
request = DoCommandRequest(name=self.name, command=dict_to_struct(command))
|
|
98
|
+
response: DoCommandResponse = await self.client.DoCommand(request, timeout=timeout, metadata=md)
|
|
99
|
+
return struct_to_dict(response.result)
|
|
@@ -0,0 +1,250 @@
|
|
|
1
|
+
import abc
|
|
2
|
+
from typing import Final, List, Optional
|
|
3
|
+
|
|
4
|
+
from viam.resource.types import API, RESOURCE_NAMESPACE_RDK, RESOURCE_TYPE_SERVICE
|
|
5
|
+
|
|
6
|
+
from ..service_base import ServiceBase
|
|
7
|
+
from . import GeoGeometry, GeoPoint, MapType, Mode, Path, Waypoint
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
class Navigation(ServiceBase):
|
|
11
|
+
"""
|
|
12
|
+
Navigation represents a Navigation service.
|
|
13
|
+
|
|
14
|
+
This acts as an abstract base class for any drivers representing specific
|
|
15
|
+
navigation service implementations. This cannot be used on its own. If the ``__init__()`` function is
|
|
16
|
+
overridden, it must call the ``super().__init__()`` function.
|
|
17
|
+
|
|
18
|
+
For more information, see `Navigation service <https://docs.viam.com/dev/reference/apis/services/navigation/>`_.
|
|
19
|
+
"""
|
|
20
|
+
|
|
21
|
+
API: Final = API( # pyright: ignore [reportIncompatibleVariableOverride]
|
|
22
|
+
RESOURCE_NAMESPACE_RDK, RESOURCE_TYPE_SERVICE, "navigation"
|
|
23
|
+
)
|
|
24
|
+
|
|
25
|
+
@abc.abstractmethod
|
|
26
|
+
async def get_paths(self, *, timeout: Optional[float]) -> List[Path]:
|
|
27
|
+
"""
|
|
28
|
+
Get each path, the series of geo points the robot plans to travel through
|
|
29
|
+
to get to a destination waypoint, in the machine's motion planning.
|
|
30
|
+
|
|
31
|
+
::
|
|
32
|
+
|
|
33
|
+
my_nav = NavigationClient.from_robot(robot=machine, name="my_nav_service")
|
|
34
|
+
|
|
35
|
+
# Get a list containing each path stored by the navigation service
|
|
36
|
+
paths = await my_nav.get_paths()
|
|
37
|
+
|
|
38
|
+
Args:
|
|
39
|
+
timeout (Optional[float]): An option to set how long to wait (in seconds)
|
|
40
|
+
before calling a time-out and closing the underlying RPC call.
|
|
41
|
+
|
|
42
|
+
Returns:
|
|
43
|
+
List[navigation.Path]: An array comprised of Paths, where each path is either a user-provided destination or
|
|
44
|
+
a Waypoint, along with the corresponding set of geopoints. This outlines the route the machine is expected to take to
|
|
45
|
+
reach the specified destination or Waypoint.
|
|
46
|
+
|
|
47
|
+
For more information, see `Navigation service <https://docs.viam.com/dev/reference/apis/services/navigation/#getpaths>`_.
|
|
48
|
+
"""
|
|
49
|
+
...
|
|
50
|
+
|
|
51
|
+
@abc.abstractmethod
|
|
52
|
+
async def get_location(self, *, timeout: Optional[float]) -> GeoPoint:
|
|
53
|
+
"""
|
|
54
|
+
Get the current location of the robot in the navigation service.
|
|
55
|
+
|
|
56
|
+
::
|
|
57
|
+
|
|
58
|
+
my_nav = NavigationClient.from_robot(robot=machine, name="my_nav_service")
|
|
59
|
+
|
|
60
|
+
# Get the current location of the robot in the navigation service
|
|
61
|
+
location = await my_nav.get_location()
|
|
62
|
+
|
|
63
|
+
Args:
|
|
64
|
+
timeout (Optional[float]): An option to set how long to wait (in seconds)
|
|
65
|
+
before calling a time-out and closing the underlying RPC call.
|
|
66
|
+
|
|
67
|
+
Returns:
|
|
68
|
+
navigation.GeoPoint: The current location of the robot in the navigation service,
|
|
69
|
+
represented in a GeoPoint with latitude and longitude values.
|
|
70
|
+
|
|
71
|
+
For more information, see `Navigation service <https://docs.viam.com/dev/reference/apis/services/navigation/#getlocation>`_.
|
|
72
|
+
"""
|
|
73
|
+
...
|
|
74
|
+
|
|
75
|
+
@abc.abstractmethod
|
|
76
|
+
async def get_obstacles(self, *, timeout: Optional[float]) -> List[GeoGeometry]:
|
|
77
|
+
"""
|
|
78
|
+
Get an array or list of the obstacles currently in the service's data storage.
|
|
79
|
+
These are objects designated for the robot to avoid when navigating.
|
|
80
|
+
These include all transient obstacles which are discovered by the vision services configured for the navigation service,
|
|
81
|
+
in addition to the obstacles that are configured as a part of the service.
|
|
82
|
+
|
|
83
|
+
::
|
|
84
|
+
|
|
85
|
+
my_nav = NavigationClient.from_robot(robot=machine, name="my_nav_service")
|
|
86
|
+
|
|
87
|
+
# Get a list containing each obstacle stored by the navigation service
|
|
88
|
+
obstacles = await my_nav.get_obstacles()
|
|
89
|
+
|
|
90
|
+
Args:
|
|
91
|
+
timeout (Optional[float]): An option to set how long to wait (in seconds)
|
|
92
|
+
before calling a time-out and closing the underlying RPC call.
|
|
93
|
+
|
|
94
|
+
Returns:
|
|
95
|
+
List[navigation.GeoGeometry]: A list comprised of each GeoGeometry in the service's data storage.
|
|
96
|
+
These are objects designated for the robot to avoid when navigating.
|
|
97
|
+
|
|
98
|
+
For more information, see `Navigation service <https://docs.viam.com/dev/reference/apis/services/navigation/#getobstacles>`_.
|
|
99
|
+
"""
|
|
100
|
+
...
|
|
101
|
+
|
|
102
|
+
@abc.abstractmethod
|
|
103
|
+
async def get_waypoints(self, *, timeout: Optional[float]) -> List[Waypoint]:
|
|
104
|
+
"""
|
|
105
|
+
Get an array of waypoints currently in the service's data storage.
|
|
106
|
+
These are locations designated within a path for the robot to navigate to.
|
|
107
|
+
|
|
108
|
+
::
|
|
109
|
+
|
|
110
|
+
my_nav = NavigationClient.from_robot(robot=machine, name="my_nav_service")
|
|
111
|
+
|
|
112
|
+
# Get a list containing each waypoint stored by the navigation service
|
|
113
|
+
waypoints = await my_nav.get_waypoints()
|
|
114
|
+
|
|
115
|
+
Args:
|
|
116
|
+
timeout (Optional[float]): An option to set how long to wait (in seconds)
|
|
117
|
+
before calling a time-out and closing the underlying RPC call.
|
|
118
|
+
|
|
119
|
+
Returns:
|
|
120
|
+
List[navigation.Waypoint]: An array comprised of each Waypoint in the service's data storage.
|
|
121
|
+
These are locations designated within a path for the robot to navigate to.
|
|
122
|
+
|
|
123
|
+
For more information, see `Navigation service <https://docs.viam.com/dev/reference/apis/services/navigation/#getwaypoints>`_.
|
|
124
|
+
"""
|
|
125
|
+
...
|
|
126
|
+
|
|
127
|
+
@abc.abstractmethod
|
|
128
|
+
async def add_waypoint(self, point: GeoPoint, *, timeout: Optional[float]):
|
|
129
|
+
"""
|
|
130
|
+
Add a waypoint to the service's data storage.
|
|
131
|
+
|
|
132
|
+
::
|
|
133
|
+
|
|
134
|
+
my_nav = NavigationClient.from_robot(robot=machine, name="my_nav_service")
|
|
135
|
+
|
|
136
|
+
# Create a new waypoint with latitude and longitude values of 0 degrees
|
|
137
|
+
location = GeoPoint(latitude=0, longitude=0)
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
# Add your waypoint to the service's data storage
|
|
141
|
+
await my_nav.add_waypoint(point=location)
|
|
142
|
+
|
|
143
|
+
Args:
|
|
144
|
+
point (navigation.GeoPoint): The current location of the robot in the navigation service,
|
|
145
|
+
represented in a GeoPoint with latitude and longitude values.
|
|
146
|
+
timeout (Optional[float]): An option to set how long to wait (in seconds)
|
|
147
|
+
before calling a time-out and closing the underlying RPC call.
|
|
148
|
+
|
|
149
|
+
For more information, see `Navigation service <https://docs.viam.com/dev/reference/apis/services/navigation/#addwaypoint>`_.
|
|
150
|
+
"""
|
|
151
|
+
...
|
|
152
|
+
|
|
153
|
+
@abc.abstractmethod
|
|
154
|
+
async def remove_waypoint(self, id: str, *, timeout: Optional[float]):
|
|
155
|
+
"""
|
|
156
|
+
Remove a waypoint from the service's data storage. If the robot is currently navigating to this waypoint,
|
|
157
|
+
the motion will be canceled, and the robot will proceed to the next waypoint.
|
|
158
|
+
|
|
159
|
+
::
|
|
160
|
+
|
|
161
|
+
my_nav = NavigationClient.from_robot(robot=machine, name="my_nav_service")
|
|
162
|
+
|
|
163
|
+
# Remove the waypoint matching that ObjectID from the service's data storage
|
|
164
|
+
await my_nav.remove_waypoint(waypoint_id)
|
|
165
|
+
|
|
166
|
+
Args:
|
|
167
|
+
id (str): The MongoDB ObjectID of the Waypoint to remove from the service's data storage.
|
|
168
|
+
timeout (Optional[float]): An option to set how long to wait (in seconds)
|
|
169
|
+
before calling a time-out and closing the underlying RPC call.
|
|
170
|
+
|
|
171
|
+
For more information, see `Navigation service <https://docs.viam.com/dev/reference/apis/services/navigation/#removewaypoint>`_.
|
|
172
|
+
"""
|
|
173
|
+
...
|
|
174
|
+
|
|
175
|
+
@abc.abstractmethod
|
|
176
|
+
async def get_mode(self, *, timeout: Optional[float]) -> Mode.ValueType:
|
|
177
|
+
"""
|
|
178
|
+
Get the Mode the service is operating in.
|
|
179
|
+
|
|
180
|
+
There are two options for modes: MODE_MANUAL or MODE_WAYPOINT.
|
|
181
|
+
|
|
182
|
+
MODE_WAYPOINT: Start to look for added waypoints and begin autonomous navigation.
|
|
183
|
+
MODE_MANUAL: Stop autonomous navigation between waypoints and allow the base to be controlled manually.
|
|
184
|
+
|
|
185
|
+
::
|
|
186
|
+
|
|
187
|
+
my_nav = NavigationClient.from_robot(robot=machine, name="my_nav_service")
|
|
188
|
+
|
|
189
|
+
# Get the Mode the service is operating in
|
|
190
|
+
await my_nav.get_mode()
|
|
191
|
+
|
|
192
|
+
Args:
|
|
193
|
+
timeout (Optional[float]): An option to set how long to wait (in seconds)
|
|
194
|
+
before calling a time-out and closing the underlying RPC call.
|
|
195
|
+
|
|
196
|
+
Returns:
|
|
197
|
+
navigation.Mode.ValueType: The Mode the service is operating in.
|
|
198
|
+
|
|
199
|
+
For more information, see `Navigation service <https://docs.viam.com/dev/reference/apis/services/navigation/#getmode>`_.
|
|
200
|
+
"""
|
|
201
|
+
...
|
|
202
|
+
|
|
203
|
+
@abc.abstractmethod
|
|
204
|
+
async def set_mode(self, mode: Mode.ValueType, *, timeout: Optional[float]):
|
|
205
|
+
"""
|
|
206
|
+
Set the Mode the service is operating in.
|
|
207
|
+
|
|
208
|
+
There are two options for modes: MODE_MANUAL or MODE_WAYPOINT.
|
|
209
|
+
|
|
210
|
+
MODE_WAYPOINT: Start to look for added waypoints and begin autonomous navigation.
|
|
211
|
+
MODE_MANUAL: Stop autonomous navigation between waypoints and allow the base to be controlled manually.
|
|
212
|
+
|
|
213
|
+
::
|
|
214
|
+
|
|
215
|
+
my_nav = NavigationClient.from_robot(robot=machine, name="my_nav_service")
|
|
216
|
+
|
|
217
|
+
# Set the Mode the service is operating in to MODE_WAYPOINT and begin navigation
|
|
218
|
+
await my_nav.set_mode(Mode.ValueType.MODE_WAYPOINT)
|
|
219
|
+
|
|
220
|
+
Args:
|
|
221
|
+
timeout (Optional[float]): An option to set how long to wait (in seconds)
|
|
222
|
+
before calling a time-out and closing the underlying RPC call.
|
|
223
|
+
mode (navigation.Mode.ValueType): The Mode for the service to operate in.
|
|
224
|
+
|
|
225
|
+
For more information, see `Navigation service <https://docs.viam.com/dev/reference/apis/services/navigation/#setmode>`_.
|
|
226
|
+
"""
|
|
227
|
+
...
|
|
228
|
+
|
|
229
|
+
@abc.abstractmethod
|
|
230
|
+
async def get_properties(self, *, timeout: Optional[float]) -> MapType.ValueType:
|
|
231
|
+
"""
|
|
232
|
+
Get information about the navigation service.
|
|
233
|
+
|
|
234
|
+
::
|
|
235
|
+
|
|
236
|
+
my_nav = NavigationClient.from_robot(robot=machine, name="my_nav_service")
|
|
237
|
+
|
|
238
|
+
# Get the properties of the current navigation service.
|
|
239
|
+
nav_properties = await my_nav.get_properties()
|
|
240
|
+
|
|
241
|
+
Args:
|
|
242
|
+
timeout (Optional[float]): An option to set how long to wait (in seconds)
|
|
243
|
+
before calling a time-out and closing the underlying RPC call.
|
|
244
|
+
|
|
245
|
+
Returns:
|
|
246
|
+
MapType.ValueType: Information about the type of map the service is using.
|
|
247
|
+
|
|
248
|
+
For more information, see `Navigation service <https://docs.viam.com/dev/reference/apis/services/navigation/#getproperties>`_.
|
|
249
|
+
"""
|
|
250
|
+
...
|
|
@@ -0,0 +1,137 @@
|
|
|
1
|
+
from grpclib.server import Stream
|
|
2
|
+
|
|
3
|
+
from viam.proto.common import DoCommandRequest, DoCommandResponse
|
|
4
|
+
from viam.proto.service.navigation import (
|
|
5
|
+
AddWaypointRequest,
|
|
6
|
+
AddWaypointResponse,
|
|
7
|
+
GetLocationRequest,
|
|
8
|
+
GetLocationResponse,
|
|
9
|
+
GetModeRequest,
|
|
10
|
+
GetModeResponse,
|
|
11
|
+
GetObstaclesRequest,
|
|
12
|
+
GetObstaclesResponse,
|
|
13
|
+
GetPathsRequest,
|
|
14
|
+
GetPathsResponse,
|
|
15
|
+
GetPropertiesRequest,
|
|
16
|
+
GetPropertiesResponse,
|
|
17
|
+
GetWaypointsRequest,
|
|
18
|
+
GetWaypointsResponse,
|
|
19
|
+
NavigationServiceBase,
|
|
20
|
+
RemoveWaypointRequest,
|
|
21
|
+
RemoveWaypointResponse,
|
|
22
|
+
SetModeRequest,
|
|
23
|
+
SetModeResponse,
|
|
24
|
+
)
|
|
25
|
+
from viam.resource.rpc_service_base import ResourceRPCServiceBase
|
|
26
|
+
from viam.utils import dict_to_struct, struct_to_dict
|
|
27
|
+
|
|
28
|
+
from .navigation import Navigation
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
class NavigationRPCService(NavigationServiceBase, ResourceRPCServiceBase):
|
|
32
|
+
"""
|
|
33
|
+
gRPC Service for a Navigation service
|
|
34
|
+
"""
|
|
35
|
+
|
|
36
|
+
RESOURCE_TYPE = Navigation
|
|
37
|
+
|
|
38
|
+
async def GetPaths(self, stream: Stream[GetPathsRequest, GetPathsResponse]) -> None:
|
|
39
|
+
request = await stream.recv_message()
|
|
40
|
+
assert request is not None
|
|
41
|
+
name = request.name
|
|
42
|
+
navigation = self.get_resource(name)
|
|
43
|
+
timeout = stream.deadline.time_remaining() if stream.deadline else None
|
|
44
|
+
paths = await navigation.get_paths(timeout=timeout)
|
|
45
|
+
response = GetPathsResponse(paths=paths)
|
|
46
|
+
await stream.send_message(response)
|
|
47
|
+
|
|
48
|
+
async def GetLocation(self, stream: Stream[GetLocationRequest, GetLocationResponse]) -> None:
|
|
49
|
+
request = await stream.recv_message()
|
|
50
|
+
assert request is not None
|
|
51
|
+
name = request.name
|
|
52
|
+
navigation = self.get_resource(name)
|
|
53
|
+
timeout = stream.deadline.time_remaining() if stream.deadline else None
|
|
54
|
+
location = await navigation.get_location(timeout=timeout)
|
|
55
|
+
response = GetLocationResponse(location=location)
|
|
56
|
+
await stream.send_message(response)
|
|
57
|
+
|
|
58
|
+
async def GetObstacles(self, stream: Stream[GetObstaclesRequest, GetObstaclesResponse]) -> None:
|
|
59
|
+
request = await stream.recv_message()
|
|
60
|
+
assert request is not None
|
|
61
|
+
name = request.name
|
|
62
|
+
navigation = self.get_resource(name)
|
|
63
|
+
timeout = stream.deadline.time_remaining() if stream.deadline else None
|
|
64
|
+
obstacles = await navigation.get_obstacles(timeout=timeout)
|
|
65
|
+
response = GetObstaclesResponse(obstacles=obstacles)
|
|
66
|
+
await stream.send_message(response)
|
|
67
|
+
|
|
68
|
+
async def GetWaypoints(self, stream: Stream[GetWaypointsRequest, GetWaypointsResponse]) -> None:
|
|
69
|
+
request = await stream.recv_message()
|
|
70
|
+
assert request is not None
|
|
71
|
+
name = request.name
|
|
72
|
+
navigation = self.get_resource(name)
|
|
73
|
+
timeout = stream.deadline.time_remaining() if stream.deadline else None
|
|
74
|
+
waypoints = await navigation.get_waypoints(timeout=timeout)
|
|
75
|
+
response = GetWaypointsResponse(waypoints=waypoints)
|
|
76
|
+
await stream.send_message(response)
|
|
77
|
+
|
|
78
|
+
async def AddWaypoint(self, stream: Stream[AddWaypointRequest, AddWaypointResponse]) -> None:
|
|
79
|
+
request = await stream.recv_message()
|
|
80
|
+
assert request is not None
|
|
81
|
+
name = request.name
|
|
82
|
+
point = request.location
|
|
83
|
+
navigation = self.get_resource(name)
|
|
84
|
+
timeout = stream.deadline.time_remaining() if stream.deadline else None
|
|
85
|
+
await navigation.add_waypoint(point, timeout=timeout)
|
|
86
|
+
response = AddWaypointResponse()
|
|
87
|
+
await stream.send_message(response)
|
|
88
|
+
|
|
89
|
+
async def RemoveWaypoint(self, stream: Stream[RemoveWaypointRequest, RemoveWaypointResponse]) -> None:
|
|
90
|
+
request = await stream.recv_message()
|
|
91
|
+
assert request is not None
|
|
92
|
+
name = request.name
|
|
93
|
+
id = request.id
|
|
94
|
+
navigation = self.get_resource(name)
|
|
95
|
+
timeout = stream.deadline.time_remaining() if stream.deadline else None
|
|
96
|
+
await navigation.remove_waypoint(id=id, timeout=timeout)
|
|
97
|
+
response = RemoveWaypointResponse()
|
|
98
|
+
await stream.send_message(response)
|
|
99
|
+
|
|
100
|
+
async def GetMode(self, stream: Stream[GetModeRequest, GetModeResponse]) -> None:
|
|
101
|
+
request = await stream.recv_message()
|
|
102
|
+
assert request is not None
|
|
103
|
+
name = request.name
|
|
104
|
+
navigation = self.get_resource(name)
|
|
105
|
+
timeout = stream.deadline.time_remaining() if stream.deadline else None
|
|
106
|
+
mode = await navigation.get_mode(timeout=timeout)
|
|
107
|
+
response = GetModeResponse(mode=mode)
|
|
108
|
+
await stream.send_message(response)
|
|
109
|
+
|
|
110
|
+
async def SetMode(self, stream: Stream[SetModeRequest, SetModeResponse]) -> None:
|
|
111
|
+
request = await stream.recv_message()
|
|
112
|
+
assert request is not None
|
|
113
|
+
name = request.name
|
|
114
|
+
mode = request.mode
|
|
115
|
+
navigation = self.get_resource(name)
|
|
116
|
+
timeout = stream.deadline.time_remaining() if stream.deadline else None
|
|
117
|
+
await navigation.set_mode(mode, timeout=timeout)
|
|
118
|
+
response = SetModeResponse()
|
|
119
|
+
await stream.send_message(response)
|
|
120
|
+
|
|
121
|
+
async def GetProperties(self, stream: Stream[GetPropertiesRequest, GetPropertiesResponse]) -> None:
|
|
122
|
+
request = await stream.recv_message()
|
|
123
|
+
assert request is not None
|
|
124
|
+
navigation = self.get_resource(request.name)
|
|
125
|
+
timeout = stream.deadline.time_remaining() if stream.deadline else None
|
|
126
|
+
map_type = await navigation.get_properties(timeout=timeout)
|
|
127
|
+
response = GetPropertiesResponse(map_type=map_type)
|
|
128
|
+
await stream.send_message(response)
|
|
129
|
+
|
|
130
|
+
async def DoCommand(self, stream: Stream[DoCommandRequest, DoCommandResponse]) -> None:
|
|
131
|
+
request = await stream.recv_message()
|
|
132
|
+
assert request is not None
|
|
133
|
+
navigation = self.get_resource(request.name)
|
|
134
|
+
timeout = stream.deadline.time_remaining() if stream.deadline else None
|
|
135
|
+
result = await navigation.do_command(command=struct_to_dict(request.command), timeout=timeout, metadata=stream.metadata)
|
|
136
|
+
response = DoCommandResponse(result=dict_to_struct(result))
|
|
137
|
+
await stream.send_message(response)
|