viam-sdk 0.3.0__py3-none-linux_armv6l.whl → 0.66.0__py3-none-linux_armv6l.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.

Files changed (452) hide show
  1. viam/__init__.py +29 -2
  2. viam/app/_logs.py +34 -0
  3. viam/app/app_client.py +2696 -0
  4. viam/app/billing_client.py +185 -0
  5. viam/app/data_client.py +2231 -0
  6. viam/app/ml_training_client.py +249 -0
  7. viam/app/provisioning_client.py +93 -0
  8. viam/app/viam_client.py +275 -0
  9. viam/components/arm/__init__.py +3 -26
  10. viam/components/arm/arm.py +123 -8
  11. viam/components/arm/client.py +37 -24
  12. viam/components/arm/service.py +35 -32
  13. viam/components/audio_in/__init__.py +24 -0
  14. viam/components/audio_in/audio_in.py +74 -0
  15. viam/components/audio_in/client.py +76 -0
  16. viam/components/audio_in/service.py +83 -0
  17. viam/components/audio_out/__init__.py +21 -0
  18. viam/components/audio_out/audio_out.py +72 -0
  19. viam/components/audio_out/client.py +67 -0
  20. viam/components/audio_out/service.py +63 -0
  21. viam/components/base/__init__.py +6 -11
  22. viam/components/base/base.py +134 -8
  23. viam/components/base/client.py +51 -23
  24. viam/components/base/service.py +33 -30
  25. viam/components/board/__init__.py +3 -12
  26. viam/components/board/board.py +247 -91
  27. viam/components/board/client.py +149 -83
  28. viam/components/board/service.py +63 -33
  29. viam/components/button/__init__.py +10 -0
  30. viam/components/button/button.py +41 -0
  31. viam/components/button/client.py +52 -0
  32. viam/components/button/service.py +46 -0
  33. viam/components/camera/__init__.py +3 -3
  34. viam/components/camera/camera.py +62 -27
  35. viam/components/camera/client.py +59 -27
  36. viam/components/camera/service.py +42 -65
  37. viam/components/component_base.py +28 -5
  38. viam/components/encoder/__init__.py +1 -1
  39. viam/components/encoder/client.py +25 -14
  40. viam/components/encoder/encoder.py +48 -10
  41. viam/components/encoder/service.py +14 -18
  42. viam/components/gantry/__init__.py +1 -13
  43. viam/components/gantry/client.py +80 -25
  44. viam/components/gantry/gantry.py +123 -9
  45. viam/components/gantry/service.py +51 -29
  46. viam/components/generic/__init__.py +1 -1
  47. viam/components/generic/client.py +21 -8
  48. viam/components/generic/generic.py +10 -2
  49. viam/components/generic/service.py +12 -7
  50. viam/components/gripper/__init__.py +3 -13
  51. viam/components/gripper/client.py +69 -21
  52. viam/components/gripper/gripper.py +123 -3
  53. viam/components/gripper/service.py +44 -22
  54. viam/components/input/__init__.py +1 -14
  55. viam/components/input/client.py +55 -23
  56. viam/components/input/input.py +106 -3
  57. viam/components/input/service.py +16 -21
  58. viam/components/motor/__init__.py +1 -21
  59. viam/components/motor/client.py +56 -33
  60. viam/components/motor/motor.py +127 -4
  61. viam/components/motor/service.py +33 -44
  62. viam/components/movement_sensor/__init__.py +1 -1
  63. viam/components/movement_sensor/client.py +102 -45
  64. viam/components/movement_sensor/movement_sensor.py +130 -61
  65. viam/components/movement_sensor/service.py +38 -41
  66. viam/components/pose_tracker/__init__.py +1 -1
  67. viam/components/pose_tracker/client.py +18 -7
  68. viam/components/pose_tracker/pose_tracker.py +4 -2
  69. viam/components/pose_tracker/service.py +12 -10
  70. viam/components/power_sensor/__init__.py +17 -0
  71. viam/components/power_sensor/client.py +86 -0
  72. viam/components/power_sensor/power_sensor.py +104 -0
  73. viam/components/power_sensor/service.py +72 -0
  74. viam/components/sensor/__init__.py +2 -1
  75. viam/components/sensor/client.py +26 -10
  76. viam/components/sensor/sensor.py +22 -4
  77. viam/components/sensor/service.py +20 -11
  78. viam/components/servo/__init__.py +1 -13
  79. viam/components/servo/client.py +47 -21
  80. viam/components/servo/service.py +15 -22
  81. viam/components/servo/servo.py +61 -2
  82. viam/components/switch/__init__.py +10 -0
  83. viam/components/switch/client.py +83 -0
  84. viam/components/switch/service.py +72 -0
  85. viam/components/switch/switch.py +98 -0
  86. viam/errors.py +10 -0
  87. viam/gen/app/agent/v1/agent_grpc.py +29 -0
  88. viam/gen/app/agent/v1/agent_pb2.py +47 -0
  89. viam/gen/app/agent/v1/agent_pb2.pyi +280 -0
  90. viam/gen/app/cloudslam/v1/__init__.py +0 -0
  91. viam/gen/app/cloudslam/v1/cloud_slam_grpc.py +70 -0
  92. viam/gen/app/cloudslam/v1/cloud_slam_pb2.py +54 -0
  93. viam/gen/app/cloudslam/v1/cloud_slam_pb2.pyi +384 -0
  94. viam/gen/app/data/v1/data_grpc.py +197 -8
  95. viam/gen/app/data/v1/data_pb2.py +238 -99
  96. viam/gen/app/data/v1/data_pb2.pyi +1222 -259
  97. viam/gen/app/datapipelines/__init__.py +0 -0
  98. viam/gen/app/datapipelines/v1/__init__.py +0 -0
  99. viam/gen/app/datapipelines/v1/data_pipelines_grpc.py +84 -0
  100. viam/gen/app/datapipelines/v1/data_pipelines_pb2.py +57 -0
  101. viam/gen/app/datapipelines/v1/data_pipelines_pb2.pyi +387 -0
  102. viam/gen/app/dataset/__init__.py +0 -0
  103. viam/gen/app/dataset/v1/__init__.py +0 -0
  104. viam/gen/app/dataset/v1/dataset_grpc.py +68 -0
  105. viam/gen/app/dataset/v1/dataset_pb2.py +44 -0
  106. viam/gen/app/dataset/v1/dataset_pb2.pyi +214 -0
  107. viam/gen/app/datasync/v1/data_sync_grpc.py +21 -4
  108. viam/gen/app/datasync/v1/data_sync_pb2.py +62 -128
  109. viam/gen/app/datasync/v1/data_sync_pb2.pyi +156 -199
  110. viam/gen/app/mlinference/__init__.py +0 -0
  111. viam/gen/app/mlinference/v1/__init__.py +0 -0
  112. viam/gen/app/mlinference/v1/ml_inference_grpc.py +28 -0
  113. viam/gen/app/mlinference/v1/ml_inference_pb2.py +23 -0
  114. viam/gen/app/mlinference/v1/ml_inference_pb2.pyi +63 -0
  115. viam/gen/app/mltraining/v1/ml_training_grpc.py +51 -3
  116. viam/gen/app/mltraining/v1/ml_training_pb2.py +135 -58
  117. viam/gen/app/mltraining/v1/ml_training_pb2.pyi +328 -39
  118. viam/gen/app/packages/v1/packages_grpc.py +15 -1
  119. viam/gen/app/packages/v1/packages_pb2.py +44 -64
  120. viam/gen/app/packages/v1/packages_pb2.pyi +75 -85
  121. viam/gen/app/v1/app_grpc.py +644 -3
  122. viam/gen/app/v1/app_pb2.py +695 -295
  123. viam/gen/app/v1/app_pb2.pyi +4488 -635
  124. viam/gen/app/v1/billing_grpc.py +53 -11
  125. viam/gen/app/v1/billing_pb2.py +94 -39
  126. viam/gen/app/v1/billing_pb2.pyi +391 -191
  127. viam/gen/app/v1/end_user_grpc.py +59 -0
  128. viam/gen/app/v1/end_user_pb2.py +55 -0
  129. viam/gen/app/v1/end_user_pb2.pyi +181 -0
  130. viam/gen/app/v1/robot_grpc.py +16 -1
  131. viam/gen/app/v1/robot_pb2.py +122 -94
  132. viam/gen/app/v1/robot_pb2.pyi +463 -123
  133. viam/gen/common/v1/common_pb2.py +87 -58
  134. viam/gen/common/v1/common_pb2.pyi +456 -149
  135. viam/gen/component/arm/v1/arm_grpc.py +58 -2
  136. viam/gen/component/arm/v1/arm_pb2.py +68 -51
  137. viam/gen/component/arm/v1/arm_pb2.pyi +108 -42
  138. viam/gen/component/audioin/__init__.py +0 -0
  139. viam/gen/component/audioin/v1/__init__.py +0 -0
  140. viam/gen/component/audioin/v1/audioin_grpc.py +54 -0
  141. viam/gen/component/audioin/v1/audioin_pb2.py +34 -0
  142. viam/gen/component/audioin/v1/audioin_pb2.pyi +94 -0
  143. viam/gen/component/audioinput/v1/audioinput_grpc.py +25 -2
  144. viam/gen/component/audioinput/v1/audioinput_pb2.py +36 -31
  145. viam/gen/component/audioinput/v1/audioinput_pb2.pyi +22 -22
  146. viam/gen/component/audioout/__init__.py +0 -0
  147. viam/gen/component/audioout/v1/__init__.py +0 -0
  148. viam/gen/component/audioout/v1/audioout_grpc.py +54 -0
  149. viam/gen/component/audioout/v1/audioout_pb2.py +32 -0
  150. viam/gen/component/audioout/v1/audioout_pb2.pyi +47 -0
  151. viam/gen/component/base/v1/base_grpc.py +42 -2
  152. viam/gen/component/base/v1/base_pb2.py +58 -47
  153. viam/gen/component/base/v1/base_pb2.pyi +65 -30
  154. viam/gen/component/board/v1/board_grpc.py +59 -7
  155. viam/gen/component/board/v1/board_pb2.py +94 -73
  156. viam/gen/component/board/v1/board_pb2.pyi +165 -68
  157. viam/gen/component/button/__init__.py +0 -0
  158. viam/gen/component/button/v1/__init__.py +0 -0
  159. viam/gen/component/button/v1/button_grpc.py +38 -0
  160. viam/gen/component/button/v1/button_pb2.py +28 -0
  161. viam/gen/component/button/v1/button_pb2.pyi +39 -0
  162. viam/gen/component/camera/v1/camera_grpc.py +38 -2
  163. viam/gen/component/camera/v1/camera_pb2.py +60 -43
  164. viam/gen/component/camera/v1/camera_pb2.pyi +191 -37
  165. viam/gen/component/encoder/v1/encoder_grpc.py +25 -2
  166. viam/gen/component/encoder/v1/encoder_pb2.py +36 -31
  167. viam/gen/component/encoder/v1/encoder_pb2.pyi +15 -15
  168. viam/gen/component/gantry/v1/gantry_grpc.py +47 -2
  169. viam/gen/component/gantry/v1/gantry_pb2.py +56 -43
  170. viam/gen/component/gantry/v1/gantry_pb2.pyi +67 -31
  171. viam/gen/component/generic/v1/generic_grpc.py +16 -2
  172. viam/gen/component/generic/v1/generic_pb2.py +16 -11
  173. viam/gen/component/gripper/v1/gripper_grpc.py +44 -2
  174. viam/gen/component/gripper/v1/gripper_pb2.py +48 -35
  175. viam/gen/component/gripper/v1/gripper_pb2.pyi +62 -24
  176. viam/gen/component/inputcontroller/v1/input_controller_grpc.py +28 -2
  177. viam/gen/component/inputcontroller/v1/input_controller_pb2.py +46 -41
  178. viam/gen/component/inputcontroller/v1/input_controller_pb2.pyi +32 -36
  179. viam/gen/component/motor/v1/motor_grpc.py +51 -2
  180. viam/gen/component/motor/v1/motor_pb2.py +78 -67
  181. viam/gen/component/motor/v1/motor_pb2.pyi +75 -46
  182. viam/gen/component/movementsensor/v1/movementsensor_grpc.py +48 -2
  183. viam/gen/component/movementsensor/v1/movementsensor_pb2.py +70 -63
  184. viam/gen/component/movementsensor/v1/movementsensor_pb2.pyi +84 -57
  185. viam/gen/component/posetracker/v1/pose_tracker_grpc.py +19 -2
  186. viam/gen/component/posetracker/v1/pose_tracker_pb2.py +26 -21
  187. viam/gen/component/posetracker/v1/pose_tracker_pb2.pyi +9 -13
  188. viam/gen/component/powersensor/__init__.py +0 -0
  189. viam/gen/component/powersensor/v1/__init__.py +0 -0
  190. viam/gen/component/powersensor/v1/powersensor_grpc.py +62 -0
  191. viam/gen/component/powersensor/v1/powersensor_pb2.py +42 -0
  192. viam/gen/component/powersensor/v1/powersensor_pb2.pyi +124 -0
  193. viam/gen/component/sensor/v1/sensor_grpc.py +21 -5
  194. viam/gen/component/sensor/v1/sensor_pb2.py +18 -22
  195. viam/gen/component/sensor/v1/sensor_pb2.pyi +1 -69
  196. viam/gen/component/servo/v1/servo_grpc.py +28 -2
  197. viam/gen/component/servo/v1/servo_pb2.py +42 -37
  198. viam/gen/component/servo/v1/servo_pb2.pyi +22 -26
  199. viam/gen/component/switch/__init__.py +0 -0
  200. viam/gen/component/switch/v1/__init__.py +0 -0
  201. viam/gen/component/switch/v1/switch_grpc.py +54 -0
  202. viam/gen/component/switch/v1/switch_pb2.py +40 -0
  203. viam/gen/component/switch/v1/switch_pb2.pyi +116 -0
  204. viam/gen/component/testecho/v1/testecho_grpc.py +15 -0
  205. viam/gen/component/testecho/v1/testecho_pb2.py +29 -26
  206. viam/gen/component/testecho/v1/testecho_pb2.pyi +16 -20
  207. viam/gen/module/v1/module_grpc.py +18 -0
  208. viam/gen/module/v1/module_pb2.py +36 -33
  209. viam/gen/module/v1/module_pb2.pyi +39 -34
  210. viam/gen/opentelemetry/__init__.py +0 -0
  211. viam/gen/opentelemetry/proto/__init__.py +0 -0
  212. viam/gen/opentelemetry/proto/common/__init__.py +0 -0
  213. viam/gen/opentelemetry/proto/common/v1/__init__.py +0 -0
  214. viam/gen/opentelemetry/proto/common/v1/common_grpc.py +0 -0
  215. viam/gen/opentelemetry/proto/common/v1/common_pb2.py +27 -0
  216. viam/gen/opentelemetry/proto/common/v1/common_pb2.pyi +208 -0
  217. viam/gen/opentelemetry/proto/resource/__init__.py +0 -0
  218. viam/gen/opentelemetry/proto/resource/v1/__init__.py +0 -0
  219. viam/gen/opentelemetry/proto/resource/v1/resource_grpc.py +0 -0
  220. viam/gen/opentelemetry/proto/resource/v1/resource_pb2.py +18 -0
  221. viam/gen/opentelemetry/proto/resource/v1/resource_pb2.pyi +59 -0
  222. viam/gen/opentelemetry/proto/trace/__init__.py +0 -0
  223. viam/gen/opentelemetry/proto/trace/v1/__init__.py +0 -0
  224. viam/gen/opentelemetry/proto/trace/v1/trace_grpc.py +0 -0
  225. viam/gen/opentelemetry/proto/trace/v1/trace_pb2.py +37 -0
  226. viam/gen/opentelemetry/proto/trace/v1/trace_pb2.pyi +402 -0
  227. viam/gen/proto/rpc/examples/echo/v1/echo_grpc.py +12 -0
  228. viam/gen/proto/rpc/examples/echo/v1/echo_pb2.py +25 -22
  229. viam/gen/proto/rpc/examples/echo/v1/echo_pb2.pyi +13 -17
  230. viam/gen/proto/rpc/examples/echoresource/v1/echoresource_grpc.py +12 -0
  231. viam/gen/proto/rpc/examples/echoresource/v1/echoresource_pb2.py +23 -20
  232. viam/gen/proto/rpc/examples/echoresource/v1/echoresource_pb2.pyi +13 -17
  233. viam/gen/proto/rpc/v1/auth_grpc.py +11 -0
  234. viam/gen/proto/rpc/v1/auth_pb2.py +27 -24
  235. viam/gen/proto/rpc/v1/auth_pb2.pyi +12 -16
  236. viam/gen/proto/rpc/webrtc/v1/grpc_pb2.py +35 -32
  237. viam/gen/proto/rpc/webrtc/v1/grpc_pb2.pyi +37 -41
  238. viam/gen/proto/rpc/webrtc/v1/signaling_grpc.py +15 -0
  239. viam/gen/proto/rpc/webrtc/v1/signaling_pb2.py +62 -57
  240. viam/gen/proto/rpc/webrtc/v1/signaling_pb2.pyi +78 -69
  241. viam/gen/provisioning/__init__.py +0 -0
  242. viam/gen/provisioning/v1/__init__.py +0 -0
  243. viam/gen/provisioning/v1/provisioning_grpc.py +59 -0
  244. viam/gen/provisioning/v1/provisioning_pb2.py +45 -0
  245. viam/gen/provisioning/v1/provisioning_pb2.pyi +229 -0
  246. viam/gen/robot/v1/robot_grpc.py +144 -15
  247. viam/gen/robot/v1/robot_pb2.py +193 -119
  248. viam/gen/robot/v1/robot_pb2.pyi +565 -137
  249. viam/gen/service/datamanager/v1/data_manager_grpc.py +20 -2
  250. viam/gen/service/datamanager/v1/data_manager_pb2.py +27 -17
  251. viam/gen/service/datamanager/v1/data_manager_pb2.pyi +52 -10
  252. viam/gen/service/discovery/__init__.py +0 -0
  253. viam/gen/service/discovery/v1/__init__.py +0 -0
  254. viam/gen/service/discovery/v1/discovery_grpc.py +39 -0
  255. viam/gen/service/discovery/v1/discovery_pb2.py +29 -0
  256. viam/gen/service/discovery/v1/discovery_pb2.pyi +51 -0
  257. viam/gen/service/generic/__init__.py +0 -0
  258. viam/gen/service/generic/v1/__init__.py +0 -0
  259. viam/gen/service/generic/v1/generic_grpc.py +29 -0
  260. viam/gen/service/generic/v1/generic_pb2.py +21 -0
  261. viam/gen/service/generic/v1/generic_pb2.pyi +6 -0
  262. viam/gen/service/mlmodel/v1/mlmodel_grpc.py +9 -0
  263. viam/gen/service/mlmodel/v1/mlmodel_pb2.py +76 -29
  264. viam/gen/service/mlmodel/v1/mlmodel_pb2.pyi +307 -28
  265. viam/gen/service/motion/v1/motion_grpc.py +42 -4
  266. viam/gen/service/motion/v1/motion_pb2.py +119 -51
  267. viam/gen/service/motion/v1/motion_pb2.pyi +595 -120
  268. viam/gen/service/navigation/v1/navigation_grpc.py +49 -1
  269. viam/gen/service/navigation/v1/navigation_pb2.py +76 -51
  270. viam/gen/service/navigation/v1/navigation_pb2.pyi +188 -33
  271. viam/gen/service/sensors/v1/sensors_grpc.py +12 -0
  272. viam/gen/service/sensors/v1/sensors_pb2.py +60 -29
  273. viam/gen/service/sensors/v1/sensors_pb2.pyi +18 -21
  274. viam/gen/service/shell/v1/shell_grpc.py +27 -1
  275. viam/gen/service/shell/v1/shell_pb2.py +37 -15
  276. viam/gen/service/shell/v1/shell_pb2.pyi +260 -7
  277. viam/gen/service/slam/v1/slam_grpc.py +24 -2
  278. viam/gen/service/slam/v1/slam_pb2.py +44 -30
  279. viam/gen/service/slam/v1/slam_pb2.pyi +128 -27
  280. viam/gen/service/video/__init__.py +0 -0
  281. viam/gen/service/video/v1/__init__.py +0 -0
  282. viam/gen/service/video/v1/video_grpc.py +39 -0
  283. viam/gen/service/video/v1/video_pb2.py +29 -0
  284. viam/gen/service/video/v1/video_pb2.pyi +72 -0
  285. viam/gen/service/vision/v1/vision_grpc.py +39 -1
  286. viam/gen/service/vision/v1/vision_pb2.py +61 -45
  287. viam/gen/service/vision/v1/vision_pb2.pyi +180 -41
  288. viam/gen/service/worldstatestore/__init__.py +0 -0
  289. viam/gen/service/worldstatestore/v1/__init__.py +0 -0
  290. viam/gen/service/worldstatestore/v1/world_state_store_grpc.py +55 -0
  291. viam/gen/service/worldstatestore/v1/world_state_store_pb2.py +39 -0
  292. viam/gen/service/worldstatestore/v1/world_state_store_pb2.pyi +171 -0
  293. viam/gen/stream/__init__.py +0 -0
  294. viam/gen/stream/v1/__init__.py +0 -0
  295. viam/gen/stream/v1/stream_grpc.py +59 -0
  296. viam/gen/stream/v1/stream_pb2.py +39 -0
  297. viam/gen/stream/v1/stream_pb2.pyi +161 -0
  298. viam/gen/tagger/v1/tagger_pb2.py +9 -8
  299. viam/logging.py +160 -17
  300. viam/media/__init__.py +0 -9
  301. viam/media/audio.py +22 -10
  302. viam/media/utils/__init__.py +0 -0
  303. viam/media/utils/pil/__init__.py +55 -0
  304. viam/media/{viam_rgba_plugin.py → utils/pil/viam_rgba_plugin.py} +10 -16
  305. viam/media/viam_rgba.py +10 -0
  306. viam/media/video.py +197 -73
  307. viam/module/module.py +191 -44
  308. viam/module/resource_data_consumer.py +41 -0
  309. viam/module/service.py +9 -1
  310. viam/module/types.py +4 -5
  311. viam/operations.py +4 -3
  312. viam/proto/app/__init__.py +361 -5
  313. viam/proto/app/agent/__init__.py +28 -0
  314. viam/proto/app/billing.py +51 -27
  315. viam/proto/app/cloudslam/__init__.py +48 -0
  316. viam/proto/app/data/__init__.py +103 -17
  317. viam/proto/app/datapipelines/__init__.py +56 -0
  318. viam/proto/app/dataset/__init__.py +40 -0
  319. viam/proto/app/datasync/__init__.py +11 -5
  320. viam/proto/app/end_user.py +34 -0
  321. viam/proto/app/mlinference/__init__.py +15 -0
  322. viam/proto/app/mltraining/__init__.py +25 -1
  323. viam/proto/app/packages/__init__.py +3 -3
  324. viam/proto/app/robot.py +19 -1
  325. viam/proto/common/__init__.py +35 -8
  326. viam/proto/component/arm/__init__.py +9 -1
  327. viam/proto/component/audioin/__init__.py +16 -0
  328. viam/proto/component/audioinput/__init__.py +3 -1
  329. viam/proto/component/audioout/__init__.py +15 -0
  330. viam/proto/component/base/__init__.py +7 -1
  331. viam/proto/component/board/__init__.py +13 -5
  332. viam/proto/component/button/__init__.py +15 -0
  333. viam/proto/component/camera/__init__.py +9 -1
  334. viam/proto/component/encoder/__init__.py +3 -1
  335. viam/proto/component/gantry/__init__.py +7 -1
  336. viam/proto/component/generic/__init__.py +3 -1
  337. viam/proto/component/gripper/__init__.py +7 -1
  338. viam/proto/component/inputcontroller/__init__.py +7 -1
  339. viam/proto/component/motor/__init__.py +7 -1
  340. viam/proto/component/movementsensor/__init__.py +7 -1
  341. viam/proto/component/posetracker/__init__.py +7 -1
  342. viam/proto/component/powersensor/__init__.py +30 -0
  343. viam/proto/component/sensor/__init__.py +3 -4
  344. viam/proto/component/servo/__init__.py +3 -1
  345. viam/proto/component/switch/__init__.py +26 -0
  346. viam/proto/component/testecho/__init__.py +3 -1
  347. viam/proto/module/__init__.py +3 -1
  348. viam/proto/opentelemetry/__init__.py +0 -0
  349. viam/proto/opentelemetry/proto/__init__.py +0 -0
  350. viam/proto/opentelemetry/proto/common/__init__.py +15 -0
  351. viam/proto/opentelemetry/proto/resource/__init__.py +10 -0
  352. viam/proto/opentelemetry/proto/trace/__init__.py +15 -0
  353. viam/proto/provisioning/__init__.py +42 -0
  354. viam/proto/robot/__init__.py +57 -9
  355. viam/proto/rpc/auth.py +11 -1
  356. viam/proto/rpc/examples/echo/__init__.py +3 -1
  357. viam/proto/rpc/examples/echoresource/__init__.py +7 -1
  358. viam/proto/rpc/webrtc/grpc.py +3 -1
  359. viam/proto/rpc/webrtc/signaling.py +5 -1
  360. viam/proto/service/datamanager/__init__.py +15 -2
  361. viam/proto/service/discovery/__init__.py +15 -0
  362. viam/proto/service/generic/__init__.py +12 -0
  363. viam/proto/service/mlmodel/__init__.py +27 -1
  364. viam/proto/service/motion/__init__.py +35 -5
  365. viam/proto/service/navigation/__init__.py +19 -1
  366. viam/proto/service/sensors/__init__.py +3 -1
  367. viam/proto/service/shell/__init__.py +25 -2
  368. viam/proto/service/slam/__init__.py +13 -1
  369. viam/proto/service/video/__init__.py +15 -0
  370. viam/proto/service/vision/__init__.py +11 -1
  371. viam/proto/service/worldstatestore/__init__.py +32 -0
  372. viam/proto/stream/__init__.py +36 -0
  373. viam/py.typed +0 -0
  374. viam/resource/base.py +45 -8
  375. viam/resource/easy_resource.py +149 -0
  376. viam/resource/manager.py +35 -14
  377. viam/resource/registry.py +40 -52
  378. viam/resource/rpc_client_base.py +33 -1
  379. viam/resource/rpc_service_base.py +15 -8
  380. viam/resource/types.py +39 -26
  381. viam/robot/client.py +458 -91
  382. viam/robot/service.py +13 -107
  383. viam/rpc/dial.py +133 -15
  384. viam/rpc/libviam_rust_utils.so +0 -0
  385. viam/rpc/server.py +59 -15
  386. viam/rpc/types.py +2 -4
  387. viam/services/discovery/__init__.py +12 -0
  388. viam/services/discovery/client.py +55 -0
  389. viam/services/discovery/discovery.py +52 -0
  390. viam/services/discovery/service.py +43 -0
  391. viam/services/generic/__init__.py +18 -0
  392. viam/services/generic/client.py +58 -0
  393. viam/services/generic/generic.py +58 -0
  394. viam/services/generic/service.py +29 -0
  395. viam/services/mlmodel/__init__.py +15 -1
  396. viam/services/mlmodel/client.py +20 -15
  397. viam/services/mlmodel/mlmodel.py +44 -7
  398. viam/services/mlmodel/service.py +9 -13
  399. viam/services/mlmodel/utils.py +101 -0
  400. viam/services/motion/__init__.py +15 -3
  401. viam/services/motion/client.py +109 -150
  402. viam/services/motion/motion.py +380 -0
  403. viam/services/motion/service.py +132 -0
  404. viam/services/navigation/__init__.py +11 -0
  405. viam/services/navigation/client.py +99 -0
  406. viam/services/navigation/navigation.py +250 -0
  407. viam/services/navigation/service.py +137 -0
  408. viam/services/service_base.py +43 -4
  409. viam/services/service_client_base.py +4 -4
  410. viam/services/slam/__init__.py +4 -1
  411. viam/services/slam/client.py +21 -11
  412. viam/services/slam/service.py +16 -19
  413. viam/services/slam/slam.py +66 -5
  414. viam/services/vision/__init__.py +8 -0
  415. viam/services/vision/client.py +115 -111
  416. viam/services/vision/service.py +143 -0
  417. viam/services/vision/vision.py +317 -0
  418. viam/services/worldstatestore/__init__.py +18 -0
  419. viam/services/worldstatestore/client.py +94 -0
  420. viam/services/worldstatestore/service.py +55 -0
  421. viam/services/worldstatestore/worldstatestore.py +90 -0
  422. viam/sessions_client.py +254 -0
  423. viam/streams.py +44 -0
  424. viam/utils.py +143 -15
  425. viam/version_metadata.py +4 -0
  426. viam_sdk-0.66.0.dist-info/METADATA +157 -0
  427. viam_sdk-0.66.0.dist-info/RECORD +531 -0
  428. {viam_sdk-0.3.0.dist-info → viam_sdk-0.66.0.dist-info}/WHEEL +1 -1
  429. viam/components/audio_input/__init__.py +0 -18
  430. viam/components/audio_input/audio_input.py +0 -79
  431. viam/components/audio_input/client.py +0 -60
  432. viam/components/audio_input/service.py +0 -118
  433. viam/components/types.py +0 -5
  434. viam/gen/app/model/v1/model_grpc.py +0 -39
  435. viam/gen/app/model/v1/model_pb2.py +0 -71
  436. viam/gen/app/model/v1/model_pb2.pyi +0 -285
  437. viam/gen/proto/rpc/examples/fileupload/v1/fileupload_grpc.py +0 -21
  438. viam/gen/proto/rpc/examples/fileupload/v1/fileupload_pb2.py +0 -18
  439. viam/gen/proto/rpc/examples/fileupload/v1/fileupload_pb2.pyi +0 -49
  440. viam/media/media.py +0 -53
  441. viam/proto/app/model/__init__.py +0 -40
  442. viam/proto/rpc/examples/fileupload/__init__.py +0 -13
  443. viam/services/sensors/__init__.py +0 -5
  444. viam/services/sensors/client.py +0 -63
  445. viam_sdk-0.3.0.dist-info/LICENSE +0 -202
  446. viam_sdk-0.3.0.dist-info/METADATA +0 -122
  447. viam_sdk-0.3.0.dist-info/RECORD +0 -372
  448. /viam/{gen/app/model → app}/__init__.py +0 -0
  449. /viam/gen/app/{model/v1 → agent}/__init__.py +0 -0
  450. /viam/gen/{proto/rpc/examples/fileupload → app/agent/v1}/__init__.py +0 -0
  451. /viam/gen/{proto/rpc/examples/fileupload/v1 → app/cloudslam}/__init__.py +0 -0
  452. /LICENSE → /viam_sdk-0.66.0.dist-info/licenses/LICENSE +0 -0
@@ -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): A waypoint represented in a GeoPoint with
145
+ 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)
@@ -1,13 +1,15 @@
1
1
  import abc
2
+ from logging import Logger
2
3
  from typing import TYPE_CHECKING, ClassVar, Mapping, Optional, cast
3
4
 
4
5
  from typing_extensions import Self
5
6
 
7
+ from viam.logging import getLogger
6
8
  from viam.resource.base import ResourceBase
7
9
  from viam.utils import ValueTypes
8
10
 
9
11
  if TYPE_CHECKING:
10
- from viam.resource.types import Subtype
12
+ from viam.resource.types import API
11
13
  from viam.robot.client import RobotClient
12
14
 
13
15
 
@@ -16,15 +18,32 @@ class ServiceBase(abc.ABC, ResourceBase):
16
18
  All services must inherit from this class.
17
19
  """
18
20
 
19
- SUBTYPE: ClassVar["Subtype"]
21
+ API: ClassVar["API"]
20
22
 
21
- def __init__(self, name: str) -> None:
23
+ def __init__(self, name: str, *, logger: Optional[Logger] = None) -> None:
22
24
  self.name = name
25
+ self.logger = logger if logger is not None else getLogger(f"{self.API}.{name}")
23
26
 
24
27
  @classmethod
25
28
  def from_robot(cls, robot: "RobotClient", name: str) -> Self:
26
29
  """Get the service named ``name`` from the provided robot.
27
30
 
31
+ ::
32
+
33
+ async def connect() -> RobotClient:
34
+ # Replace "<API-KEY>" (including brackets) with your API key and "<API-KEY-ID>" with your API key ID
35
+ options = RobotClient.Options.with_api_key("<API-KEY>", "<API-KEY-ID>")
36
+ # Replace "<MACHINE-URL>" (included brackets) with your machine's connection URL or FQDN
37
+ return await RobotClient.at_address("<MACHINE-URL>", options)
38
+
39
+ async def main():
40
+ robot = await connect()
41
+
42
+ # Can be used with any resource, using the motion service as an example
43
+ motion = MotionClient.from_robot(robot=machine, name="builtin")
44
+
45
+ robot.close()
46
+
28
47
  Args:
29
48
  robot (RobotClient): The robot
30
49
  name (str): The name of the service
@@ -33,7 +52,27 @@ class ServiceBase(abc.ABC, ResourceBase):
33
52
  Self: The service, if it exists on the robot
34
53
  """
35
54
  service = robot.get_service(cls.get_resource_name(name))
36
- return cast(cls, service)
55
+ return cast(cls, service) # type: ignore
37
56
 
38
57
  async def do_command(self, command: Mapping[str, ValueTypes], *, timeout: Optional[float] = None, **kwargs) -> Mapping[str, ValueTypes]:
58
+ """Send/receive arbitrary commands.
59
+
60
+ ::
61
+
62
+ service = SERVICE.from_robot(robot=machine, "builtin") # replace SERVICE with the appropriate class
63
+
64
+ my_command = {
65
+ "cmnd": "dosomething",
66
+ "someparameter": 52
67
+ }
68
+
69
+ # Can be used with any resource, using the motion service as an example
70
+ await service.do_command(command=my_command)
71
+
72
+ Args:
73
+ command (Dict[str, ValueTypes]): The command to execute
74
+
75
+ Returns:
76
+ Dict[str, ValueTypes]: Result of the executed command
77
+ """
39
78
  raise NotImplementedError()
@@ -6,7 +6,7 @@ from typing_extensions import Self
6
6
 
7
7
  from viam.errors import ResourceNotFoundError
8
8
  from viam.proto.common import ResourceName
9
- from viam.resource.base import ResourceBase, Subtype
9
+ from viam.resource.base import API, ResourceBase
10
10
  from viam.utils import ValueTypes
11
11
 
12
12
  if TYPE_CHECKING:
@@ -19,7 +19,7 @@ class ServiceClientBase(abc.ABC, ResourceBase):
19
19
  All service clients must inherit from this class.
20
20
  """
21
21
 
22
- SUBTYPE: ClassVar[Subtype]
22
+ API: ClassVar[API]
23
23
  channel: Channel
24
24
 
25
25
  def __init__(self, name: str, channel: Channel):
@@ -37,10 +37,10 @@ class ServiceClientBase(abc.ABC, ResourceBase):
37
37
  Returns:
38
38
  Self: The service client, if it exists on the robot
39
39
  """
40
- resource_name = ResourceName(namespace="rdk", type="service", subtype=cls.SUBTYPE.resource_subtype, name=name)
40
+ resource_name = ResourceName(namespace="rdk", type="service", subtype=cls.API.resource_subtype, name=name)
41
41
  if resource_name not in robot.resource_names:
42
42
  raise ResourceNotFoundError(resource_name.subtype, resource_name.name)
43
43
  return cls(name, robot._channel)
44
44
 
45
- def do_command(self, command: Mapping[str, ValueTypes], *, timeout: Optional[float] = None, **kwargs) -> Mapping[str, ValueTypes]:
45
+ async def do_command(self, command: Mapping[str, ValueTypes], *, timeout: Optional[float] = None, **kwargs) -> Mapping[str, ValueTypes]:
46
46
  raise NotImplementedError()
@@ -1,4 +1,5 @@
1
1
  from viam.proto.common import Pose
2
+ from viam.proto.service.slam import MappingMode, SensorInfo
2
3
  from viam.resource.registry import Registry, ResourceRegistration
3
4
 
4
5
  from .client import SLAMClient
@@ -7,8 +8,10 @@ from .slam import SLAM
7
8
 
8
9
  __all__ = [
9
10
  "Pose",
11
+ "MappingMode",
12
+ "SensorInfo",
10
13
  "SLAMClient",
11
14
  "SLAM",
12
15
  ]
13
16
 
14
- Registry.register_subtype(ResourceRegistration(SLAM, SLAMRPCService, lambda name, channel: SLAMClient(name, channel)))
17
+ Registry.register_api(ResourceRegistration(SLAM, SLAMRPCService, lambda name, channel: SLAMClient(name, channel)))
@@ -10,6 +10,7 @@ from viam.proto.service.slam import (
10
10
  GetPointCloudMapResponse,
11
11
  GetPositionRequest,
12
12
  GetPositionResponse,
13
+ GetPropertiesRequest,
13
14
  SLAMServiceStub,
14
15
  )
15
16
  from viam.resource.rpc_client_base import ReconfigurableResourceRPCClientBase
@@ -31,22 +32,31 @@ class SLAMClient(SLAM, ReconfigurableResourceRPCClientBase):
31
32
  self.client = SLAMServiceStub(channel)
32
33
  super().__init__(name)
33
34
 
34
- async def get_position(self, *, timeout: Optional[float] = None) -> Pose:
35
+ async def get_position(self, *, timeout: Optional[float] = None, **kwargs) -> Pose:
36
+ md = kwargs.get("metadata", self.Metadata()).proto
35
37
  request = GetPositionRequest(name=self.name)
36
- response: GetPositionResponse = await self.client.GetPosition(request, timeout=timeout)
38
+ response: GetPositionResponse = await self.client.GetPosition(request, timeout=timeout, metadata=md)
37
39
  return response.pose
38
40
 
39
- async def get_point_cloud_map(self, *, timeout: Optional[float] = None) -> List[GetPointCloudMapResponse]:
40
- request = GetPointCloudMapRequest(name=self.name)
41
- response: List[GetPointCloudMapResponse] = await self.client.GetPointCloudMap(request, timeout=timeout)
42
- return response
41
+ async def get_point_cloud_map(self, return_edited_map: bool = False, *, timeout: Optional[float] = None, **kwargs) -> List[bytes]:
42
+ md = kwargs.get("metadata", self.Metadata()).proto
43
+ request = GetPointCloudMapRequest(name=self.name, return_edited_map=return_edited_map)
44
+ response: List[GetPointCloudMapResponse] = await self.client.GetPointCloudMap(request, timeout=timeout, metadata=md)
45
+ return [r.point_cloud_pcd_chunk for r in response]
43
46
 
44
- async def get_internal_state(self, *, timeout: Optional[float] = None) -> List[GetInternalStateResponse]:
47
+ async def get_internal_state(self, *, timeout: Optional[float] = None, **kwargs) -> List[bytes]:
48
+ md = kwargs.get("metadata", self.Metadata()).proto
45
49
  request = GetInternalStateRequest(name=self.name)
46
- response: List[GetInternalStateResponse] = await self.client.GetInternalState(request, timeout=timeout)
47
- return response
50
+ response: List[GetInternalStateResponse] = await self.client.GetInternalState(request, timeout=timeout, metadata=md)
51
+ return [r.internal_state_chunk for r in response]
48
52
 
49
- async def do_command(self, command: Mapping[str, ValueTypes], *, timeout: Optional[float] = None) -> Mapping[str, ValueTypes]:
53
+ async def get_properties(self, *, timeout: Optional[float] = None, **kwargs) -> SLAM.Properties:
54
+ md = kwargs.get("metadata", self.Metadata()).proto
55
+ request = GetPropertiesRequest(name=self.name)
56
+ return await self.client.GetProperties(request, timeout=timeout, metadata=md)
57
+
58
+ async def do_command(self, command: Mapping[str, ValueTypes], *, timeout: Optional[float] = None, **kwargs) -> Mapping[str, ValueTypes]:
59
+ md = kwargs.get("metadata", self.Metadata()).proto
50
60
  request = DoCommandRequest(name=self.name, command=dict_to_struct(command))
51
- response: DoCommandResponse = await self.client.DoCommand(request, timeout=timeout)
61
+ response: DoCommandResponse = await self.client.DoCommand(request, timeout=timeout, metadata=md)
52
62
  return struct_to_dict(response.result)
@@ -1,6 +1,5 @@
1
1
  from grpclib.server import Stream
2
2
 
3
- from viam.errors import ResourceNotFoundError
4
3
  from viam.proto.common import DoCommandRequest, DoCommandResponse
5
4
  from viam.proto.service.slam import (
6
5
  GetInternalStateRequest,
@@ -9,6 +8,8 @@ from viam.proto.service.slam import (
9
8
  GetPointCloudMapResponse,
10
9
  GetPositionRequest,
11
10
  GetPositionResponse,
11
+ GetPropertiesRequest,
12
+ GetPropertiesResponse,
12
13
  SLAMServiceBase,
13
14
  )
14
15
  from viam.resource.rpc_service_base import ResourceRPCServiceBase
@@ -17,7 +18,7 @@ from viam.utils import dict_to_struct, struct_to_dict
17
18
  from .slam import SLAM
18
19
 
19
20
 
20
- class SLAMRPCService(SLAMServiceBase, ResourceRPCServiceBase[SLAM]):
21
+ class SLAMRPCService(SLAMServiceBase, ResourceRPCServiceBase):
21
22
  """
22
23
  gRPC Service for a SLAM service
23
24
  """
@@ -28,10 +29,7 @@ class SLAMRPCService(SLAMServiceBase, ResourceRPCServiceBase[SLAM]):
28
29
  request = await stream.recv_message()
29
30
  assert request is not None
30
31
  name = request.name
31
- try:
32
- slam = self.get_resource(name)
33
- except ResourceNotFoundError as e:
34
- raise e.grpc_error
32
+ slam = self.get_resource(name)
35
33
  timeout = stream.deadline.time_remaining() if stream.deadline else None
36
34
  chunks = await slam.get_internal_state(timeout=timeout)
37
35
  for chunk in chunks:
@@ -42,12 +40,9 @@ class SLAMRPCService(SLAMServiceBase, ResourceRPCServiceBase[SLAM]):
42
40
  request = await stream.recv_message()
43
41
  assert request is not None
44
42
  name = request.name
45
- try:
46
- slam = self.get_resource(name)
47
- except ResourceNotFoundError as e:
48
- raise e.grpc_error
43
+ slam = self.get_resource(name)
49
44
  timeout = stream.deadline.time_remaining() if stream.deadline else None
50
- chunks = await slam.get_point_cloud_map(timeout=timeout)
45
+ chunks = await slam.get_point_cloud_map(return_edited_map=request.return_edited_map, timeout=timeout)
51
46
  for chunk in chunks:
52
47
  response = GetPointCloudMapResponse(point_cloud_pcd_chunk=chunk)
53
48
  await stream.send_message(response)
@@ -56,22 +51,24 @@ class SLAMRPCService(SLAMServiceBase, ResourceRPCServiceBase[SLAM]):
56
51
  request = await stream.recv_message()
57
52
  assert request is not None
58
53
  name = request.name
59
- try:
60
- slam = self.get_resource(name)
61
- except ResourceNotFoundError as e:
62
- raise e.grpc_error
54
+ slam = self.get_resource(name)
63
55
  timeout = stream.deadline.time_remaining() if stream.deadline else None
64
56
  position = await slam.get_position(timeout=timeout)
65
57
  response = GetPositionResponse(pose=position)
66
58
  await stream.send_message(response)
67
59
 
60
+ async def GetProperties(self, stream: Stream[GetPropertiesRequest, GetPropertiesResponse]) -> None:
61
+ request = await stream.recv_message()
62
+ assert request is not None
63
+ slam = self.get_resource(request.name)
64
+ timeout = stream.deadline.time_remaining() if stream.deadline else None
65
+ properties = await slam.get_properties(timeout=timeout)
66
+ await stream.send_message(properties)
67
+
68
68
  async def DoCommand(self, stream: Stream[DoCommandRequest, DoCommandResponse]) -> None:
69
69
  request = await stream.recv_message()
70
70
  assert request is not None
71
- try:
72
- slam = self.get_resource(request.name)
73
- except ResourceNotFoundError as e:
74
- raise e.grpc_error
71
+ slam = self.get_resource(request.name)
75
72
  timeout = stream.deadline.time_remaining() if stream.deadline else None
76
73
  result = await slam.do_command(command=struct_to_dict(request.command), timeout=timeout, metadata=stream.metadata)
77
74
  response = DoCommandResponse(result=dict_to_struct(result))