wandelbots-api-client 25.6.0.dev7__py3-none-any.whl → 25.10.0rc2__py3-none-any.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.
Files changed (658) hide show
  1. wandelbots_api_client/__init__.py +2 -3
  2. wandelbots_api_client/api/__init__.py +2 -0
  3. wandelbots_api_client/api/application_api.py +1 -2
  4. wandelbots_api_client/api/cell_api.py +1 -2
  5. wandelbots_api_client/api/controller_api.py +13 -8
  6. wandelbots_api_client/api/controller_ios_api.py +3 -6
  7. wandelbots_api_client/api/coordinate_systems_api.py +1 -2
  8. wandelbots_api_client/api/device_configuration_api.py +1 -2
  9. wandelbots_api_client/api/library_program_api.py +1 -2
  10. wandelbots_api_client/api/library_program_metadata_api.py +1 -2
  11. wandelbots_api_client/api/library_recipe_api.py +1 -2
  12. wandelbots_api_client/api/library_recipe_metadata_api.py +1 -2
  13. wandelbots_api_client/api/license_api.py +1 -2
  14. wandelbots_api_client/api/motion_api.py +59 -8
  15. wandelbots_api_client/api/motion_group_api.py +1 -2
  16. wandelbots_api_client/api/motion_group_infos_api.py +3 -2
  17. wandelbots_api_client/api/motion_group_jogging_api.py +53 -8
  18. wandelbots_api_client/api/motion_group_kinematic_api.py +1 -2
  19. wandelbots_api_client/api/program_api.py +1 -2
  20. wandelbots_api_client/api/program_operator_api.py +1 -2
  21. wandelbots_api_client/api/program_values_api.py +1 -2
  22. wandelbots_api_client/api/store_collision_components_api.py +10 -8
  23. wandelbots_api_client/api/store_collision_scenes_api.py +1 -2
  24. wandelbots_api_client/api/store_object_api.py +1 -2
  25. wandelbots_api_client/api/system_api.py +1 -2
  26. wandelbots_api_client/api/version_api.py +284 -0
  27. wandelbots_api_client/api/virtual_robot_api.py +1 -2
  28. wandelbots_api_client/api/virtual_robot_behavior_api.py +27 -5
  29. wandelbots_api_client/api/virtual_robot_mode_api.py +1 -2
  30. wandelbots_api_client/api/virtual_robot_setup_api.py +16 -17
  31. wandelbots_api_client/api_client.py +14 -7
  32. wandelbots_api_client/authorization.py +244 -0
  33. wandelbots_api_client/configuration.py +18 -7
  34. wandelbots_api_client/exceptions.py +1 -1
  35. wandelbots_api_client/models/__init__.py +3 -4
  36. wandelbots_api_client/models/abb_controller.py +5 -5
  37. wandelbots_api_client/models/abb_controller_egm_server.py +3 -3
  38. wandelbots_api_client/models/activate_license_request.py +2 -2
  39. wandelbots_api_client/models/add_request.py +3 -3
  40. wandelbots_api_client/models/all_joint_positions_request.py +3 -3
  41. wandelbots_api_client/models/all_joint_positions_response.py +2 -2
  42. wandelbots_api_client/{v2/models/error2.py → models/api_version.py} +10 -10
  43. wandelbots_api_client/models/app.py +8 -8
  44. wandelbots_api_client/models/array_input.py +2 -2
  45. wandelbots_api_client/models/array_output.py +2 -2
  46. wandelbots_api_client/models/behavior.py +1 -1
  47. wandelbots_api_client/models/blending_auto.py +3 -3
  48. wandelbots_api_client/models/blending_position.py +3 -3
  49. wandelbots_api_client/models/box.py +5 -5
  50. wandelbots_api_client/models/box2.py +6 -6
  51. wandelbots_api_client/models/box3.py +6 -6
  52. wandelbots_api_client/models/capsule.py +3 -3
  53. wandelbots_api_client/models/capsule2.py +4 -4
  54. wandelbots_api_client/models/capsule3.py +4 -4
  55. wandelbots_api_client/models/capture.py +2 -2
  56. wandelbots_api_client/models/cell.py +4 -4
  57. wandelbots_api_client/models/circle.py +3 -3
  58. wandelbots_api_client/models/code_with_arguments.py +7 -6
  59. wandelbots_api_client/models/collection_value.py +1 -1
  60. wandelbots_api_client/models/collider.py +4 -4
  61. wandelbots_api_client/models/collider_input.py +4 -4
  62. wandelbots_api_client/models/collider_output.py +4 -4
  63. wandelbots_api_client/models/collider_output_shape.py +1 -1
  64. wandelbots_api_client/models/collider_shape.py +1 -41
  65. wandelbots_api_client/models/collision.py +7 -7
  66. wandelbots_api_client/models/collision_contact.py +3 -3
  67. wandelbots_api_client/models/collision_motion_group.py +7 -6
  68. wandelbots_api_client/models/collision_motion_group_assembly.py +9 -8
  69. wandelbots_api_client/models/collision_robot_configuration_input.py +12 -10
  70. wandelbots_api_client/models/collision_robot_configuration_output.py +12 -10
  71. wandelbots_api_client/models/collision_scene.py +11 -9
  72. wandelbots_api_client/models/collision_scene_assembly.py +14 -12
  73. wandelbots_api_client/models/command.py +7 -7
  74. wandelbots_api_client/models/command_settings.py +4 -4
  75. wandelbots_api_client/models/comparator.py +1 -1
  76. wandelbots_api_client/models/compound.py +2 -2
  77. wandelbots_api_client/models/container_environment_inner.py +3 -3
  78. wandelbots_api_client/models/container_image.py +4 -4
  79. wandelbots_api_client/models/container_image_secrets_inner.py +2 -2
  80. wandelbots_api_client/models/container_resources.py +2 -2
  81. wandelbots_api_client/models/container_storage.py +3 -3
  82. wandelbots_api_client/models/controller_capabilities.py +3 -3
  83. wandelbots_api_client/models/controller_instance.py +9 -9
  84. wandelbots_api_client/models/controller_instance_list.py +2 -2
  85. wandelbots_api_client/models/convex_hull.py +2 -2
  86. wandelbots_api_client/models/convex_hull2.py +3 -3
  87. wandelbots_api_client/models/convex_hull3.py +3 -3
  88. wandelbots_api_client/models/coordinate_system.py +6 -6
  89. wandelbots_api_client/models/coordinate_systems.py +2 -2
  90. wandelbots_api_client/models/create_device_request_inner.py +1 -1
  91. wandelbots_api_client/models/create_program_run200_response.py +2 -2
  92. wandelbots_api_client/models/create_program_run_request.py +2 -2
  93. wandelbots_api_client/models/create_trigger200_response.py +2 -2
  94. wandelbots_api_client/models/create_trigger_request.py +7 -7
  95. wandelbots_api_client/models/cubic_spline.py +2 -2
  96. wandelbots_api_client/models/cubic_spline_cubic_spline_parameter.py +3 -3
  97. wandelbots_api_client/models/cubic_spline_parameter.py +3 -3
  98. wandelbots_api_client/models/cycle_time.py +2 -2
  99. wandelbots_api_client/models/cylinder.py +3 -3
  100. wandelbots_api_client/models/cylinder2.py +4 -4
  101. wandelbots_api_client/models/cylinder3.py +4 -4
  102. wandelbots_api_client/models/dh_parameter.py +6 -6
  103. wandelbots_api_client/models/direction.py +1 -1
  104. wandelbots_api_client/models/direction_jogging_request.py +10 -10
  105. wandelbots_api_client/models/error.py +3 -3
  106. wandelbots_api_client/models/execute_trajectory_request.py +1 -1
  107. wandelbots_api_client/models/execute_trajectory_response.py +1 -1
  108. wandelbots_api_client/models/execution_result.py +4 -4
  109. wandelbots_api_client/models/external_joint_stream_datapoint.py +3 -3
  110. wandelbots_api_client/models/external_joint_stream_datapoint_value.py +5 -5
  111. wandelbots_api_client/models/fanuc_controller.py +3 -3
  112. wandelbots_api_client/models/feedback_collision.py +5 -5
  113. wandelbots_api_client/models/feedback_joint_limit_exceeded.py +4 -4
  114. wandelbots_api_client/models/feedback_out_of_workspace.py +3 -3
  115. wandelbots_api_client/models/feedback_singularity.py +4 -4
  116. wandelbots_api_client/models/flag.py +2 -2
  117. wandelbots_api_client/models/force_vector.py +4 -4
  118. wandelbots_api_client/models/geometry.py +12 -12
  119. wandelbots_api_client/models/get_all_program_runs200_response.py +2 -2
  120. wandelbots_api_client/models/get_all_triggers200_response.py +2 -2
  121. wandelbots_api_client/models/get_mode_response.py +2 -2
  122. wandelbots_api_client/models/get_trajectory_response.py +2 -2
  123. wandelbots_api_client/models/get_trajectory_sample_response.py +2 -2
  124. wandelbots_api_client/models/google_protobuf_any.py +2 -2
  125. wandelbots_api_client/models/http_exception_response.py +2 -2
  126. wandelbots_api_client/models/http_validation_error.py +2 -2
  127. wandelbots_api_client/models/http_validation_error2.py +2 -2
  128. wandelbots_api_client/models/image_credentials.py +4 -4
  129. wandelbots_api_client/models/info_service_capabilities.py +8 -8
  130. wandelbots_api_client/models/initialize_movement_request.py +6 -6
  131. wandelbots_api_client/models/initialize_movement_response.py +2 -2
  132. wandelbots_api_client/models/initialize_movement_response_init_response.py +3 -3
  133. wandelbots_api_client/models/io.py +6 -6
  134. wandelbots_api_client/models/io_description.py +10 -10
  135. wandelbots_api_client/models/io_value.py +5 -5
  136. wandelbots_api_client/models/ios.py +2 -2
  137. wandelbots_api_client/models/jogging_response.py +4 -4
  138. wandelbots_api_client/models/jogging_service_capabilities.py +3 -3
  139. wandelbots_api_client/models/joint_jogging_request.py +6 -6
  140. wandelbots_api_client/models/joint_limit.py +5 -5
  141. wandelbots_api_client/models/joint_limit_exceeded.py +3 -3
  142. wandelbots_api_client/models/joint_position_request.py +4 -4
  143. wandelbots_api_client/models/joint_trajectory.py +4 -4
  144. wandelbots_api_client/models/joints.py +2 -2
  145. wandelbots_api_client/models/kinematic_service_capabilities.py +4 -4
  146. wandelbots_api_client/models/kuka_controller.py +10 -8
  147. wandelbots_api_client/models/kuka_controller_rsi_server.py +3 -3
  148. wandelbots_api_client/models/license.py +11 -11
  149. wandelbots_api_client/models/license_status.py +3 -3
  150. wandelbots_api_client/models/license_status_enum.py +1 -1
  151. wandelbots_api_client/models/limit_settings.py +13 -13
  152. wandelbots_api_client/models/limits_override.py +7 -7
  153. wandelbots_api_client/models/list_devices200_response_inner.py +1 -1
  154. wandelbots_api_client/models/list_io_descriptions_response.py +2 -2
  155. wandelbots_api_client/models/list_io_values_response.py +2 -2
  156. wandelbots_api_client/models/list_payloads_response.py +2 -2
  157. wandelbots_api_client/models/list_program_metadata_response.py +2 -2
  158. wandelbots_api_client/models/list_recipe_metadata_response.py +2 -2
  159. wandelbots_api_client/models/list_response.py +2 -2
  160. wandelbots_api_client/models/list_tcps_response.py +2 -2
  161. wandelbots_api_client/models/manufacturer.py +1 -1
  162. wandelbots_api_client/models/mode_change_response.py +5 -5
  163. wandelbots_api_client/models/motion_command.py +4 -4
  164. wandelbots_api_client/models/motion_command_blending.py +1 -1
  165. wandelbots_api_client/models/motion_command_path.py +1 -1
  166. wandelbots_api_client/models/motion_group_behavior_getter.py +2 -2
  167. wandelbots_api_client/models/motion_group_info.py +4 -4
  168. wandelbots_api_client/models/motion_group_infos.py +2 -2
  169. wandelbots_api_client/models/motion_group_instance.py +6 -6
  170. wandelbots_api_client/models/motion_group_instance_list.py +2 -2
  171. wandelbots_api_client/models/motion_group_joints.py +5 -5
  172. wandelbots_api_client/models/motion_group_physical.py +6 -6
  173. wandelbots_api_client/models/motion_group_specification.py +3 -3
  174. wandelbots_api_client/models/motion_group_state.py +13 -13
  175. wandelbots_api_client/models/motion_group_state_joint_limit_reached.py +2 -2
  176. wandelbots_api_client/models/motion_group_state_response.py +3 -3
  177. wandelbots_api_client/models/motion_id.py +2 -2
  178. wandelbots_api_client/models/motion_ids_list_response.py +2 -2
  179. wandelbots_api_client/models/motion_vector.py +4 -4
  180. wandelbots_api_client/models/mounting.py +3 -3
  181. wandelbots_api_client/models/move_request.py +9 -9
  182. wandelbots_api_client/models/move_response.py +3 -3
  183. wandelbots_api_client/models/move_to_trajectory_via_joint_ptp_request.py +5 -5
  184. wandelbots_api_client/models/movement.py +2 -2
  185. wandelbots_api_client/models/movement_error.py +2 -2
  186. wandelbots_api_client/models/movement_error_error.py +2 -2
  187. wandelbots_api_client/models/movement_movement.py +4 -4
  188. wandelbots_api_client/models/op_mode.py +2 -2
  189. wandelbots_api_client/models/opcua_node_value_trigger_config.py +4 -4
  190. wandelbots_api_client/models/opcua_node_value_trigger_config_node_value.py +1 -1
  191. wandelbots_api_client/models/optimizer_setup.py +8 -8
  192. wandelbots_api_client/models/out_of_workspace.py +2 -2
  193. wandelbots_api_client/models/path.py +2 -2
  194. wandelbots_api_client/models/path_cartesian_ptp.py +3 -3
  195. wandelbots_api_client/models/path_circle.py +4 -4
  196. wandelbots_api_client/models/path_cubic_spline.py +3 -3
  197. wandelbots_api_client/models/path_joint_ptp.py +3 -3
  198. wandelbots_api_client/models/path_line.py +3 -3
  199. wandelbots_api_client/models/pause_movement_request.py +3 -3
  200. wandelbots_api_client/models/pause_movement_response.py +2 -2
  201. wandelbots_api_client/models/pause_movement_response_pause_response.py +3 -3
  202. wandelbots_api_client/models/pause_on_io.py +3 -3
  203. wandelbots_api_client/models/payload.py +5 -5
  204. wandelbots_api_client/models/plan_collision_free_ptp_request.py +10 -9
  205. wandelbots_api_client/models/plan_collision_free_ptp_request_target.py +1 -1
  206. wandelbots_api_client/models/plan_failed_on_trajectory_response.py +10 -10
  207. wandelbots_api_client/models/plan_failed_response.py +8 -8
  208. wandelbots_api_client/models/plan_request.py +6 -6
  209. wandelbots_api_client/models/plan_response.py +4 -4
  210. wandelbots_api_client/models/plan_successful_response.py +3 -3
  211. wandelbots_api_client/models/plan_trajectory_failed_response.py +4 -4
  212. wandelbots_api_client/models/plan_trajectory_failed_response_error_feedback.py +1 -1
  213. wandelbots_api_client/models/plan_trajectory_request.py +10 -9
  214. wandelbots_api_client/models/plan_trajectory_response.py +2 -2
  215. wandelbots_api_client/models/plan_trajectory_response_response.py +1 -1
  216. wandelbots_api_client/models/plane2.py +2 -2
  217. wandelbots_api_client/models/plane3.py +2 -2
  218. wandelbots_api_client/models/planned_motion.py +6 -6
  219. wandelbots_api_client/models/planner_pose.py +3 -3
  220. wandelbots_api_client/models/planning_limits.py +13 -13
  221. wandelbots_api_client/models/planning_limits_limit_range.py +3 -3
  222. wandelbots_api_client/models/playback_speed_request.py +3 -3
  223. wandelbots_api_client/models/playback_speed_response.py +2 -2
  224. wandelbots_api_client/models/playback_speed_response_playback_speed_response.py +2 -2
  225. wandelbots_api_client/models/point_cloud.py +2 -2
  226. wandelbots_api_client/models/pose.py +4 -4
  227. wandelbots_api_client/models/pose2.py +3 -3
  228. wandelbots_api_client/models/program_metadata.py +7 -7
  229. wandelbots_api_client/models/program_run.py +15 -14
  230. wandelbots_api_client/models/program_run_object.py +7 -7
  231. wandelbots_api_client/models/program_run_state.py +1 -1
  232. wandelbots_api_client/models/program_runner_reference.py +3 -3
  233. wandelbots_api_client/models/pyjectory_datatypes_core_pose.py +3 -3
  234. wandelbots_api_client/models/pyjectory_datatypes_serializer_orientation.py +2 -2
  235. wandelbots_api_client/models/pyjectory_datatypes_serializer_pose.py +2 -2
  236. wandelbots_api_client/models/pyjectory_datatypes_serializer_position.py +2 -2
  237. wandelbots_api_client/models/pyriphery_etcd_etcd_configuration.py +5 -5
  238. wandelbots_api_client/models/pyriphery_hardware_isaac_isaac_configuration.py +5 -5
  239. wandelbots_api_client/models/pyriphery_opcua_opcua_configuration.py +4 -4
  240. wandelbots_api_client/models/pyriphery_pyrae_controller_controller_configuration.py +7 -7
  241. wandelbots_api_client/models/pyriphery_pyrae_robot_robot_configuration.py +8 -8
  242. wandelbots_api_client/models/pyriphery_robotics_configurable_collision_scene_configurable_collision_scene_configuration_input.py +13 -11
  243. wandelbots_api_client/models/pyriphery_robotics_configurable_collision_scene_configurable_collision_scene_configuration_output.py +13 -11
  244. wandelbots_api_client/models/pyriphery_robotics_robotcell_timer_configuration.py +3 -3
  245. wandelbots_api_client/models/pyriphery_robotics_simulation_robot_with_view_open3d_configuration.py +4 -4
  246. wandelbots_api_client/models/pyriphery_robotics_simulation_simulated_io_configuration.py +3 -3
  247. wandelbots_api_client/models/pyriphery_robotics_simulation_simulated_opcua_configuration.py +3 -3
  248. wandelbots_api_client/models/quaternion.py +5 -5
  249. wandelbots_api_client/models/recipe_metadata.py +8 -8
  250. wandelbots_api_client/models/rectangle.py +3 -3
  251. wandelbots_api_client/models/rectangle2.py +4 -4
  252. wandelbots_api_client/models/rectangle3.py +4 -4
  253. wandelbots_api_client/models/rectangular_capsule.py +4 -4
  254. wandelbots_api_client/models/rectangular_capsule2.py +5 -5
  255. wandelbots_api_client/models/rectangular_capsule3.py +5 -5
  256. wandelbots_api_client/models/release_channel.py +1 -1
  257. wandelbots_api_client/models/request.py +1 -1
  258. wandelbots_api_client/models/request1.py +1 -1
  259. wandelbots_api_client/models/response_get_value_programs_values_key_get.py +1 -1
  260. wandelbots_api_client/models/response_get_values_programs_values_get_value.py +1 -1
  261. wandelbots_api_client/models/robot_controller.py +3 -3
  262. wandelbots_api_client/models/robot_controller_configuration.py +1 -1
  263. wandelbots_api_client/models/robot_controller_state.py +8 -8
  264. wandelbots_api_client/models/robot_link_geometry.py +3 -3
  265. wandelbots_api_client/models/robot_state.py +3 -3
  266. wandelbots_api_client/models/robot_system_mode.py +1 -1
  267. wandelbots_api_client/models/robot_tcp.py +5 -5
  268. wandelbots_api_client/models/robot_tcps.py +2 -2
  269. wandelbots_api_client/models/rotation_angle_types.py +1 -1
  270. wandelbots_api_client/models/rotation_angles.py +3 -3
  271. wandelbots_api_client/models/safety_configuration.py +6 -6
  272. wandelbots_api_client/models/safety_setup.py +5 -5
  273. wandelbots_api_client/models/safety_setup_safety_settings.py +3 -3
  274. wandelbots_api_client/models/safety_setup_safety_zone.py +5 -5
  275. wandelbots_api_client/models/safety_zone.py +4 -4
  276. wandelbots_api_client/models/safety_zone_limits.py +3 -3
  277. wandelbots_api_client/models/safety_zone_violation.py +2 -2
  278. wandelbots_api_client/models/service_status.py +3 -3
  279. wandelbots_api_client/models/service_status_phase.py +1 -1
  280. wandelbots_api_client/models/service_status_severity.py +1 -1
  281. wandelbots_api_client/models/service_status_status.py +4 -4
  282. wandelbots_api_client/models/set_io.py +3 -3
  283. wandelbots_api_client/models/set_playback_speed.py +3 -3
  284. wandelbots_api_client/models/single_joint_limit.py +3 -3
  285. wandelbots_api_client/models/singularity.py +3 -3
  286. wandelbots_api_client/models/singularity_type_enum.py +1 -1
  287. wandelbots_api_client/models/sphere.py +2 -2
  288. wandelbots_api_client/models/sphere2.py +3 -3
  289. wandelbots_api_client/models/sphere3.py +3 -3
  290. wandelbots_api_client/models/standstill.py +2 -2
  291. wandelbots_api_client/models/standstill_reason.py +1 -1
  292. wandelbots_api_client/models/standstill_standstill.py +4 -4
  293. wandelbots_api_client/models/start_movement_request.py +6 -6
  294. wandelbots_api_client/models/start_on_io.py +3 -3
  295. wandelbots_api_client/models/status.py +4 -4
  296. wandelbots_api_client/models/stop_response.py +4 -4
  297. wandelbots_api_client/models/store_value.py +1 -1
  298. wandelbots_api_client/models/stream_move_backward.py +2 -2
  299. wandelbots_api_client/models/stream_move_forward.py +2 -2
  300. wandelbots_api_client/models/stream_move_playback_speed.py +2 -2
  301. wandelbots_api_client/models/stream_move_request.py +1 -1
  302. wandelbots_api_client/models/stream_move_response.py +4 -4
  303. wandelbots_api_client/models/stream_move_to_trajectory.py +2 -2
  304. wandelbots_api_client/models/stream_stop.py +2 -2
  305. wandelbots_api_client/models/tcp_pose.py +5 -5
  306. wandelbots_api_client/models/tcp_pose_request.py +5 -5
  307. wandelbots_api_client/models/tool_geometry.py +3 -3
  308. wandelbots_api_client/models/trajectory_sample.py +12 -12
  309. wandelbots_api_client/models/trigger_object.py +11 -11
  310. wandelbots_api_client/models/trigger_type.py +1 -1
  311. wandelbots_api_client/models/universalrobots_controller.py +3 -3
  312. wandelbots_api_client/models/update_nova_version_request.py +2 -2
  313. wandelbots_api_client/models/update_program_metadata_request.py +4 -4
  314. wandelbots_api_client/models/update_recipe_metadata_request.py +4 -4
  315. wandelbots_api_client/models/update_trigger_request.py +6 -6
  316. wandelbots_api_client/models/validation_error.py +4 -4
  317. wandelbots_api_client/models/validation_error2.py +4 -4
  318. wandelbots_api_client/models/validation_error2_loc_inner.py +1 -1
  319. wandelbots_api_client/models/validation_error_loc_inner.py +1 -1
  320. wandelbots_api_client/models/value.py +1 -1
  321. wandelbots_api_client/models/vector3d.py +4 -4
  322. wandelbots_api_client/models/version_number.py +9 -9
  323. wandelbots_api_client/models/virtual_controller.py +7 -7
  324. wandelbots_api_client/models/virtual_controller_types.py +17 -2
  325. wandelbots_api_client/models/virtual_robot_configuration.py +3 -3
  326. wandelbots_api_client/models/yaskawa_controller.py +3 -3
  327. wandelbots_api_client/rest.py +3 -2
  328. wandelbots_api_client/v2/__init__.py +3 -4
  329. wandelbots_api_client/v2/api/__init__.py +16 -16
  330. wandelbots_api_client/v2/api/application_api.py +11 -12
  331. wandelbots_api_client/v2/api/bus_inputs_outputs_api.py +4555 -0
  332. wandelbots_api_client/v2/api/cell_api.py +8 -9
  333. wandelbots_api_client/v2/api/controller_api.py +206 -202
  334. wandelbots_api_client/v2/api/controller_inputs_outputs_api.py +45 -44
  335. wandelbots_api_client/v2/api/jogging_api.py +33 -11
  336. wandelbots_api_client/v2/api/kinematics_api.py +636 -0
  337. wandelbots_api_client/v2/api/license_api.py +8 -9
  338. wandelbots_api_client/v2/api/motion_group_api.py +61 -31
  339. wandelbots_api_client/v2/api/motion_group_models_api.py +557 -0
  340. wandelbots_api_client/v2/api/program_api.py +167 -1308
  341. wandelbots_api_client/v2/api/store_collision_components_api.py +823 -50
  342. wandelbots_api_client/v2/api/store_collision_setups_api.py +1404 -0
  343. wandelbots_api_client/v2/api/store_object_api.py +11 -12
  344. wandelbots_api_client/v2/api/system_api.py +282 -18
  345. wandelbots_api_client/v2/api/trajectory_caching_api.py +94 -20
  346. wandelbots_api_client/v2/api/trajectory_execution_api.py +33 -11
  347. wandelbots_api_client/v2/api/trajectory_planning_api.py +68 -323
  348. wandelbots_api_client/v2/api/{inverse_kinematics_api.py → version_api.py} +24 -81
  349. wandelbots_api_client/v2/api/virtual_controller_api.py +4565 -0
  350. wandelbots_api_client/v2/api/virtual_controller_behavior_api.py +982 -0
  351. wandelbots_api_client/v2/api/virtual_controller_inputs_outputs_api.py +1003 -0
  352. wandelbots_api_client/v2/api_client.py +15 -8
  353. wandelbots_api_client/v2/configuration.py +19 -8
  354. wandelbots_api_client/v2/exceptions.py +2 -2
  355. wandelbots_api_client/v2/models/__init__.py +210 -159
  356. wandelbots_api_client/v2/models/abb_controller.py +8 -11
  357. wandelbots_api_client/v2/models/abb_controller_egm_server.py +4 -4
  358. wandelbots_api_client/v2/models/activate_license_request.py +3 -3
  359. wandelbots_api_client/v2/models/add_trajectory_error.py +5 -5
  360. wandelbots_api_client/v2/models/add_trajectory_error_data.py +66 -66
  361. wandelbots_api_client/v2/models/add_trajectory_request.py +5 -5
  362. wandelbots_api_client/v2/models/add_trajectory_response.py +4 -4
  363. wandelbots_api_client/v2/models/{jogging_error_response_error.py → api_version.py} +9 -9
  364. wandelbots_api_client/v2/models/app.py +19 -11
  365. wandelbots_api_client/v2/models/behavior.py +3 -3
  366. wandelbots_api_client/v2/models/blending_auto.py +6 -5
  367. wandelbots_api_client/v2/models/blending_position.py +4 -4
  368. wandelbots_api_client/v2/models/boolean_value.py +7 -10
  369. wandelbots_api_client/v2/models/box.py +7 -7
  370. wandelbots_api_client/v2/models/{program_run_object.py → bus_io_description.py} +31 -20
  371. wandelbots_api_client/v2/models/{jogging_error_response.py → bus_io_modbus_client.py} +23 -14
  372. wandelbots_api_client/v2/models/bus_io_modbus_server.py +115 -0
  373. wandelbots_api_client/v2/models/bus_io_modbus_tcp_client.py +106 -0
  374. wandelbots_api_client/v2/models/bus_io_modbus_tcp_server.py +104 -0
  375. wandelbots_api_client/v2/models/{movement_error_error.py → bus_io_modbus_virtual.py} +17 -10
  376. wandelbots_api_client/v2/models/bus_io_profinet.py +114 -0
  377. wandelbots_api_client/v2/models/{motion_group_behavior_getter.py → bus_io_profinet_default_route.py} +12 -11
  378. wandelbots_api_client/v2/models/bus_io_profinet_ip_config.py +95 -0
  379. wandelbots_api_client/v2/models/{update_trigger_request.py → bus_io_profinet_network.py} +18 -18
  380. wandelbots_api_client/v2/models/bus_io_profinet_virtual.py +98 -0
  381. wandelbots_api_client/v2/models/bus_io_type.py +212 -0
  382. wandelbots_api_client/v2/models/{create_trigger200_response.py → bus_ios_state.py} +12 -9
  383. wandelbots_api_client/v2/models/bus_ios_state_enum.py +39 -0
  384. wandelbots_api_client/v2/models/capsule.py +5 -5
  385. wandelbots_api_client/v2/models/{robot_state.py → cartesian_limits.py} +15 -15
  386. wandelbots_api_client/v2/models/cell.py +7 -7
  387. wandelbots_api_client/v2/models/collider.py +5 -5
  388. wandelbots_api_client/v2/models/collider_shape.py +2 -42
  389. wandelbots_api_client/v2/models/collision.py +11 -11
  390. wandelbots_api_client/v2/models/collision_contact.py +6 -6
  391. wandelbots_api_client/v2/models/{collision2.py → collision_error.py} +7 -7
  392. wandelbots_api_client/v2/models/collision_free_algorithm.py +155 -0
  393. wandelbots_api_client/v2/models/{collision_motion_group_assembly.py → collision_setup.py} +32 -18
  394. wandelbots_api_client/v2/models/comparator.py +2 -2
  395. wandelbots_api_client/v2/models/configuration_archive_status.py +174 -0
  396. wandelbots_api_client/v2/models/{joints.py → configuration_archive_status_creating.py} +20 -10
  397. wandelbots_api_client/v2/models/configuration_archive_status_error.py +100 -0
  398. wandelbots_api_client/v2/models/configuration_archive_status_success.py +98 -0
  399. wandelbots_api_client/v2/models/configuration_resource.py +5 -5
  400. wandelbots_api_client/v2/models/container_environment_inner.py +4 -4
  401. wandelbots_api_client/v2/models/container_image.py +5 -5
  402. wandelbots_api_client/v2/models/container_image_secrets_inner.py +3 -3
  403. wandelbots_api_client/v2/models/{create_program_operator_run200_response.py → container_resources.py} +12 -9
  404. wandelbots_api_client/v2/models/container_storage.py +4 -4
  405. wandelbots_api_client/v2/models/{create_trigger_request.py → controller_description.py} +16 -21
  406. wandelbots_api_client/v2/models/convex_hull.py +4 -4
  407. wandelbots_api_client/v2/models/coordinate_system.py +11 -11
  408. wandelbots_api_client/v2/models/coordinate_system_data.py +101 -0
  409. wandelbots_api_client/v2/models/cubic_spline_parameter.py +4 -4
  410. wandelbots_api_client/v2/models/cycle_time.py +5 -4
  411. wandelbots_api_client/v2/models/cylinder.py +5 -5
  412. wandelbots_api_client/v2/models/dh_parameter.py +7 -7
  413. wandelbots_api_client/v2/models/direction.py +2 -2
  414. wandelbots_api_client/v2/models/error.py +4 -4
  415. wandelbots_api_client/v2/models/{jogging_paused_collision.py → error_invalid_joint_count.py} +21 -14
  416. wandelbots_api_client/v2/models/error_joint_limit_exceeded.py +103 -0
  417. wandelbots_api_client/v2/models/{coordinate_systems.py → error_joint_position_collision.py} +30 -19
  418. wandelbots_api_client/v2/models/error_max_iterations_exceeded.py +100 -0
  419. wandelbots_api_client/v2/models/execute.py +97 -0
  420. wandelbots_api_client/v2/models/{set_io_values_request_inner.py → execute_details.py} +47 -43
  421. wandelbots_api_client/v2/models/execute_jogging_request.py +52 -10
  422. wandelbots_api_client/v2/models/execute_jogging_response.py +87 -26
  423. wandelbots_api_client/v2/models/execute_trajectory_request.py +30 -2
  424. wandelbots_api_client/v2/models/execute_trajectory_response.py +61 -42
  425. wandelbots_api_client/v2/models/external_joint_stream_datapoint.py +6 -6
  426. wandelbots_api_client/v2/models/{robot_tcps.py → external_joint_stream_request.py} +17 -17
  427. wandelbots_api_client/v2/models/fanuc_controller.py +6 -9
  428. wandelbots_api_client/v2/models/feedback_collision.py +6 -6
  429. wandelbots_api_client/v2/models/feedback_joint_limit_exceeded.py +7 -6
  430. wandelbots_api_client/v2/models/feedback_out_of_workspace.py +4 -4
  431. wandelbots_api_client/v2/models/feedback_singularity.py +5 -5
  432. wandelbots_api_client/v2/models/flag.py +3 -3
  433. wandelbots_api_client/v2/models/float_value.py +8 -11
  434. wandelbots_api_client/v2/models/{get_all_triggers200_response.py → forward_kinematics422_response.py} +17 -17
  435. wandelbots_api_client/v2/models/forward_kinematics_request.py +104 -0
  436. wandelbots_api_client/v2/models/{controllers_list.py → forward_kinematics_response.py} +18 -18
  437. wandelbots_api_client/v2/models/{list_coordinate_systems_response.py → forward_kinematics_validation_error.py} +30 -18
  438. wandelbots_api_client/v2/models/get_trajectory_response.py +5 -5
  439. wandelbots_api_client/v2/models/http_validation_error.py +5 -5
  440. wandelbots_api_client/v2/models/image_credentials.py +5 -5
  441. wandelbots_api_client/v2/models/{inconsitent_trajectory_size.py → inconsistent_trajectory_size_error.py} +9 -9
  442. wandelbots_api_client/v2/models/{inconsitent_trajectory_size_inconsistent_trajectory_size.py → inconsistent_trajectory_size_error_inconsistent_trajectory_size.py} +9 -9
  443. wandelbots_api_client/v2/models/initialize_jogging_request.py +9 -16
  444. wandelbots_api_client/v2/models/initialize_jogging_response.py +17 -12
  445. wandelbots_api_client/v2/models/initialize_movement_request.py +7 -12
  446. wandelbots_api_client/v2/models/initialize_movement_request_trajectory.py +2 -2
  447. wandelbots_api_client/v2/models/initialize_movement_response.py +22 -11
  448. wandelbots_api_client/v2/models/integer_value.py +8 -11
  449. wandelbots_api_client/v2/models/{invalid_dof.py → invalid_dof_error.py} +9 -9
  450. wandelbots_api_client/v2/models/{invalid_dof_invalid_dof.py → invalid_dof_error_invalid_dof.py} +8 -8
  451. wandelbots_api_client/v2/models/{motion_group_infos.py → inverse_kinematics422_response.py} +18 -18
  452. wandelbots_api_client/v2/models/inverse_kinematics_request.py +51 -31
  453. wandelbots_api_client/v2/models/inverse_kinematics_response.py +3 -3
  454. wandelbots_api_client/v2/models/inverse_kinematics_validation_error.py +120 -0
  455. wandelbots_api_client/v2/models/inverse_kinematics_validation_error_all_of_data.py +155 -0
  456. wandelbots_api_client/v2/models/io_boolean_value.py +8 -11
  457. wandelbots_api_client/v2/models/{io_description_min.py → io_boundary.py} +10 -25
  458. wandelbots_api_client/v2/models/io_description.py +15 -15
  459. wandelbots_api_client/v2/models/io_direction.py +2 -2
  460. wandelbots_api_client/v2/models/io_float_value.py +9 -12
  461. wandelbots_api_client/v2/models/io_integer_value.py +9 -12
  462. wandelbots_api_client/v2/models/{trigger_type.py → io_origin.py} +7 -6
  463. wandelbots_api_client/v2/models/{set_output_values_request_inner.py → io_value.py} +10 -25
  464. wandelbots_api_client/v2/models/io_value_type.py +2 -2
  465. wandelbots_api_client/v2/models/{movement_movement.py → jogging_details.py} +21 -16
  466. wandelbots_api_client/v2/models/{jogging_state.py → jogging_details_state.py} +76 -43
  467. wandelbots_api_client/v2/models/{program_run_reference.py → jogging_paused_by_user.py} +17 -13
  468. wandelbots_api_client/v2/models/{jogging_paused_collision_paused_near_collision.py → jogging_paused_near_collision.py} +19 -10
  469. wandelbots_api_client/v2/models/{jogging_paused_joint_limit_paused_near_joint_limit.py → jogging_paused_near_joint_limit.py} +20 -10
  470. wandelbots_api_client/v2/models/jogging_paused_on_io.py +14 -7
  471. wandelbots_api_client/v2/models/jogging_running.py +14 -7
  472. wandelbots_api_client/v2/models/{joint_limit_exceeded.py → joint_limit_exceeded_error.py} +7 -7
  473. wandelbots_api_client/v2/models/joint_limits.py +101 -0
  474. wandelbots_api_client/v2/models/joint_trajectory.py +6 -23
  475. wandelbots_api_client/v2/models/joint_velocity_request.py +7 -14
  476. wandelbots_api_client/v2/models/joint_velocity_response.py +100 -0
  477. wandelbots_api_client/v2/models/kuka_controller.py +12 -13
  478. wandelbots_api_client/v2/models/kuka_controller_rsi_server.py +4 -4
  479. wandelbots_api_client/v2/models/license.py +12 -12
  480. wandelbots_api_client/v2/models/license_status.py +4 -4
  481. wandelbots_api_client/v2/models/license_status_enum.py +2 -2
  482. wandelbots_api_client/v2/models/{planning_limits_limit_range.py → limit_range.py} +8 -8
  483. wandelbots_api_client/v2/models/limit_set.py +129 -0
  484. wandelbots_api_client/v2/models/limits_override.py +8 -8
  485. wandelbots_api_client/v2/models/list_trajectories_response.py +3 -3
  486. wandelbots_api_client/v2/models/manufacturer.py +2 -2
  487. wandelbots_api_client/v2/models/midpoint_insertion_algorithm.py +101 -0
  488. wandelbots_api_client/v2/models/modbus_io.py +105 -0
  489. wandelbots_api_client/v2/models/modbus_io_area.py +40 -0
  490. wandelbots_api_client/v2/models/modbus_io_byte_order.py +40 -0
  491. wandelbots_api_client/v2/models/modbus_io_data.py +103 -0
  492. wandelbots_api_client/v2/models/modbus_io_type_enum.py +39 -0
  493. wandelbots_api_client/v2/models/motion_command.py +5 -5
  494. wandelbots_api_client/v2/models/motion_command_blending.py +2 -2
  495. wandelbots_api_client/v2/models/motion_command_path.py +2 -2
  496. wandelbots_api_client/v2/models/{planning_parameters.py → motion_group_description.py} +40 -35
  497. wandelbots_api_client/v2/models/motion_group_info.py +7 -6
  498. wandelbots_api_client/v2/models/motion_group_joints.py +6 -6
  499. wandelbots_api_client/v2/models/{robot_setup.py → motion_group_setup.py} +33 -35
  500. wandelbots_api_client/v2/models/motion_group_state.py +32 -44
  501. wandelbots_api_client/v2/models/motion_group_state_joint_limit_reached.py +3 -3
  502. wandelbots_api_client/v2/models/movement_error_response.py +100 -0
  503. wandelbots_api_client/v2/models/{nan_value.py → nan_value_error.py} +9 -9
  504. wandelbots_api_client/v2/models/{nan_value_nan_value.py → nan_value_error_nan_value.py} +6 -6
  505. wandelbots_api_client/v2/models/op_mode.py +3 -3
  506. wandelbots_api_client/v2/models/operating_state.py +2 -2
  507. wandelbots_api_client/v2/models/operation_limits.py +110 -0
  508. wandelbots_api_client/v2/models/operation_mode.py +2 -2
  509. wandelbots_api_client/v2/models/orientation_type.py +2 -2
  510. wandelbots_api_client/v2/models/path_cartesian_ptp.py +4 -4
  511. wandelbots_api_client/v2/models/path_circle.py +5 -5
  512. wandelbots_api_client/v2/models/path_cubic_spline.py +4 -4
  513. wandelbots_api_client/v2/models/path_joint_ptp.py +4 -4
  514. wandelbots_api_client/v2/models/path_line.py +4 -4
  515. wandelbots_api_client/v2/models/pause_jogging_request.py +98 -0
  516. wandelbots_api_client/v2/models/{initialize_jogging_response_init_response.py → pause_jogging_response.py} +19 -12
  517. wandelbots_api_client/v2/models/pause_movement_request.py +7 -12
  518. wandelbots_api_client/v2/models/pause_movement_response.py +17 -12
  519. wandelbots_api_client/v2/models/pause_on_io.py +11 -8
  520. wandelbots_api_client/v2/models/payload.py +6 -6
  521. wandelbots_api_client/v2/models/{http_validation_error2.py → plan422_response.py} +9 -9
  522. wandelbots_api_client/v2/models/{movement.py → plan_collision_free_failed_response.py} +13 -13
  523. wandelbots_api_client/v2/models/{jogging_response_jogging.py → plan_collision_free_request.py} +25 -21
  524. wandelbots_api_client/v2/models/{standstill.py → plan_collision_free_response.py} +13 -13
  525. wandelbots_api_client/{models/create_trigger_request_config.py → v2/models/plan_collision_free_response_response.py} +34 -20
  526. wandelbots_api_client/v2/models/plan_trajectory_failed_response.py +5 -5
  527. wandelbots_api_client/v2/models/plan_trajectory_failed_response_error_feedback.py +2 -2
  528. wandelbots_api_client/v2/models/plan_trajectory_request.py +11 -11
  529. wandelbots_api_client/v2/models/plan_trajectory_response.py +3 -3
  530. wandelbots_api_client/v2/models/plan_trajectory_response_response.py +2 -2
  531. wandelbots_api_client/v2/models/{get_all_program_operator_runs200_response.py → plan_validation_error.py} +30 -18
  532. wandelbots_api_client/v2/models/plan_validation_error_all_of_data.py +174 -0
  533. wandelbots_api_client/v2/models/plane.py +3 -3
  534. wandelbots_api_client/v2/models/playback_speed_request.py +7 -9
  535. wandelbots_api_client/v2/models/playback_speed_response.py +17 -12
  536. wandelbots_api_client/v2/models/pose.py +4 -4
  537. wandelbots_api_client/v2/models/profinet_description.py +120 -0
  538. wandelbots_api_client/v2/models/{opcua_node_value_trigger_config.py → profinet_input_output_config.py} +14 -17
  539. wandelbots_api_client/v2/models/profinet_io.py +104 -0
  540. wandelbots_api_client/v2/models/{program_request.py → profinet_io_data.py} +20 -39
  541. wandelbots_api_client/v2/models/profinet_io_direction.py +38 -0
  542. wandelbots_api_client/v2/models/profinet_io_type_enum.py +45 -0
  543. wandelbots_api_client/v2/models/{list_io_descriptions_response.py → profinet_slot_description.py} +23 -18
  544. wandelbots_api_client/v2/models/profinet_sub_slot_description.py +96 -0
  545. wandelbots_api_client/v2/models/program.py +109 -0
  546. wandelbots_api_client/v2/models/program_run.py +23 -35
  547. wandelbots_api_client/v2/models/program_run_state.py +8 -8
  548. wandelbots_api_client/v2/models/{jogging_paused_user_request.py → program_start_request.py} +10 -10
  549. wandelbots_api_client/v2/models/rectangle.py +5 -5
  550. wandelbots_api_client/v2/models/rectangular_capsule.py +6 -6
  551. wandelbots_api_client/v2/models/release_channel.py +2 -2
  552. wandelbots_api_client/v2/models/robot_controller.py +4 -4
  553. wandelbots_api_client/v2/models/robot_controller_configuration.py +2 -2
  554. wandelbots_api_client/v2/models/robot_controller_state.py +17 -11
  555. wandelbots_api_client/v2/models/robot_system_mode.py +8 -8
  556. wandelbots_api_client/v2/models/robot_tcp.py +10 -10
  557. wandelbots_api_client/v2/models/{motion_vector.py → robot_tcp_data.py} +16 -13
  558. wandelbots_api_client/v2/models/rrt_connect_algorithm.py +109 -0
  559. wandelbots_api_client/v2/models/safety_state_type.py +2 -2
  560. wandelbots_api_client/v2/models/service_group.py +2 -2
  561. wandelbots_api_client/v2/models/service_status.py +5 -5
  562. wandelbots_api_client/v2/models/service_status_phase.py +2 -2
  563. wandelbots_api_client/v2/models/service_status_response.py +4 -4
  564. wandelbots_api_client/v2/models/service_status_severity.py +2 -2
  565. wandelbots_api_client/v2/models/service_status_status.py +5 -5
  566. wandelbots_api_client/v2/models/{standstill_standstill.py → set_io.py} +17 -17
  567. wandelbots_api_client/v2/models/settable_robot_system_mode.py +2 -2
  568. wandelbots_api_client/v2/models/singularity_type_enum.py +2 -2
  569. wandelbots_api_client/v2/models/sphere.py +4 -4
  570. wandelbots_api_client/v2/models/start_movement_request.py +14 -15
  571. wandelbots_api_client/v2/models/start_movement_response.py +100 -0
  572. wandelbots_api_client/v2/models/start_on_io.py +11 -8
  573. wandelbots_api_client/v2/models/{list_io_values_response.py → stream_io_values_response.py} +17 -11
  574. wandelbots_api_client/v2/models/tcp_offset.py +4 -4
  575. wandelbots_api_client/v2/models/{tcp_required.py → tcp_required_error.py} +6 -6
  576. wandelbots_api_client/v2/models/tcp_velocity_request.py +6 -9
  577. wandelbots_api_client/v2/models/tcp_velocity_response.py +100 -0
  578. wandelbots_api_client/v2/models/{torque_exceeded.py → torque_exceeded_error.py} +9 -9
  579. wandelbots_api_client/v2/models/{torque_exceeded_torque_exceeded.py → torque_exceeded_error_torque_exceeded.py} +8 -8
  580. wandelbots_api_client/v2/models/trajectory_data.py +6 -6
  581. wandelbots_api_client/v2/models/trajectory_details.py +108 -0
  582. wandelbots_api_client/v2/models/trajectory_details_state.py +212 -0
  583. wandelbots_api_client/v2/models/trajectory_ended.py +98 -0
  584. wandelbots_api_client/v2/models/trajectory_id.py +4 -4
  585. wandelbots_api_client/v2/models/{get_mode_response.py → trajectory_paused_by_user.py} +17 -11
  586. wandelbots_api_client/v2/models/trajectory_paused_on_io.py +98 -0
  587. wandelbots_api_client/v2/models/trajectory_running.py +101 -0
  588. wandelbots_api_client/v2/models/{create_program_operator_run_request.py → trajectory_wait_for_io.py} +17 -10
  589. wandelbots_api_client/v2/models/unit_type.py +3 -3
  590. wandelbots_api_client/v2/models/universalrobots_controller.py +6 -9
  591. wandelbots_api_client/v2/models/update_nova_version_request.py +3 -3
  592. wandelbots_api_client/v2/models/validation_error.py +9 -7
  593. wandelbots_api_client/v2/models/validation_error2.py +6 -6
  594. wandelbots_api_client/v2/models/validation_error_loc_inner.py +2 -2
  595. wandelbots_api_client/v2/models/virtual_controller.py +11 -14
  596. wandelbots_api_client/v2/models/virtual_controller_types.py +18 -3
  597. wandelbots_api_client/v2/models/virtual_robot_configuration.py +4 -4
  598. wandelbots_api_client/v2/models/wait_for_io_event_request.py +6 -6
  599. wandelbots_api_client/v2/models/yaskawa_controller.py +6 -9
  600. wandelbots_api_client/v2/rest.py +4 -3
  601. wandelbots_api_client/v2_pydantic/__init__.py +50 -0
  602. wandelbots_api_client/v2_pydantic/api/__init__.py +51 -0
  603. wandelbots_api_client/{v2/api/virtual_robot_api.py → v2_pydantic/api/application_api.py} +327 -426
  604. wandelbots_api_client/v2_pydantic/api/bus_inputs_outputs_api.py +4603 -0
  605. wandelbots_api_client/{v2/api/virtual_robot_setup_api.py → v2_pydantic/api/cell_api.py} +291 -771
  606. wandelbots_api_client/v2_pydantic/api/controller_api.py +3721 -0
  607. wandelbots_api_client/v2_pydantic/api/controller_inputs_outputs_api.py +1395 -0
  608. wandelbots_api_client/v2_pydantic/api/jogging_api.py +125 -0
  609. wandelbots_api_client/v2_pydantic/api/kinematics_api.py +642 -0
  610. wandelbots_api_client/{v2/api/store_collision_scenes_api.py → v2_pydantic/api/license_api.py} +158 -248
  611. wandelbots_api_client/{v2/api/virtual_robot_behavior_api.py → v2_pydantic/api/motion_group_api.py} +156 -131
  612. wandelbots_api_client/v2_pydantic/api/motion_group_models_api.py +563 -0
  613. wandelbots_api_client/{v2/api/store_program_api.py → v2_pydantic/api/program_api.py} +191 -181
  614. wandelbots_api_client/v2_pydantic/api/store_collision_components_api.py +4170 -0
  615. wandelbots_api_client/v2_pydantic/api/store_collision_setups_api.py +1419 -0
  616. wandelbots_api_client/v2_pydantic/api/store_object_api.py +1719 -0
  617. wandelbots_api_client/{v2/api/program_operator_api.py → v2_pydantic/api/system_api.py} +625 -476
  618. wandelbots_api_client/{v2/api/virtual_robot_mode_api.py → v2_pydantic/api/trajectory_caching_api.py} +208 -162
  619. wandelbots_api_client/v2_pydantic/api/trajectory_execution_api.py +125 -0
  620. wandelbots_api_client/v2_pydantic/api/trajectory_planning_api.py +642 -0
  621. wandelbots_api_client/v2_pydantic/api/version_api.py +287 -0
  622. wandelbots_api_client/v2_pydantic/api/virtual_controller_api.py +4610 -0
  623. wandelbots_api_client/v2_pydantic/api/virtual_controller_behavior_api.py +991 -0
  624. wandelbots_api_client/v2_pydantic/api/virtual_controller_inputs_outputs_api.py +1012 -0
  625. wandelbots_api_client/v2_pydantic/api_client.py +809 -0
  626. wandelbots_api_client/v2_pydantic/api_response.py +21 -0
  627. wandelbots_api_client/v2_pydantic/configuration.py +606 -0
  628. wandelbots_api_client/v2_pydantic/exceptions.py +216 -0
  629. wandelbots_api_client/v2_pydantic/models.py +4561 -0
  630. wandelbots_api_client/v2_pydantic/py.typed +0 -0
  631. wandelbots_api_client/v2_pydantic/rest.py +213 -0
  632. wandelbots_api_client-25.10.0rc2.dist-info/METADATA +62 -0
  633. wandelbots_api_client-25.10.0rc2.dist-info/RECORD +640 -0
  634. {wandelbots_api_client-25.6.0.dev7.dist-info → wandelbots_api_client-25.10.0rc2.dist-info}/WHEEL +2 -1
  635. wandelbots_api_client-25.10.0rc2.dist-info/top_level.txt +1 -0
  636. wandelbots_api_client/v2/models/collision_motion_group.py +0 -121
  637. wandelbots_api_client/v2/models/collision_scene.py +0 -119
  638. wandelbots_api_client/v2/models/collision_scene_assembly.py +0 -129
  639. wandelbots_api_client/v2/models/controller.py +0 -132
  640. wandelbots_api_client/v2/models/external_joint_stream_datapoint_value.py +0 -97
  641. wandelbots_api_client/v2/models/initialize_movement_response_init_response.py +0 -93
  642. wandelbots_api_client/v2/models/jogging_paused_joint_limit.py +0 -95
  643. wandelbots_api_client/v2/models/jogging_response.py +0 -95
  644. wandelbots_api_client/v2/models/motion_group_instance.py +0 -101
  645. wandelbots_api_client/v2/models/motion_group_state_without_payload.py +0 -146
  646. wandelbots_api_client/v2/models/movement_error.py +0 -95
  647. wandelbots_api_client/v2/models/opcua_node_value_trigger_config_node_value.py +0 -160
  648. wandelbots_api_client/v2/models/pause_movement_response_pause_response.py +0 -93
  649. wandelbots_api_client/v2/models/planning_limits.py +0 -130
  650. wandelbots_api_client/v2/models/playback_speed_response_playback_speed_response.py +0 -91
  651. wandelbots_api_client/v2/models/program_run_result.py +0 -108
  652. wandelbots_api_client/v2/models/single_motion_group_collision_scene.py +0 -135
  653. wandelbots_api_client/v2/models/standstill_reason.py +0 -39
  654. wandelbots_api_client/v2/models/trigger_object.py +0 -111
  655. wandelbots_api_client/v2/models/version_number.py +0 -105
  656. wandelbots_api_client-25.6.0.dev7.dist-info/METADATA +0 -63
  657. wandelbots_api_client-25.6.0.dev7.dist-info/RECORD +0 -580
  658. {wandelbots_api_client-25.6.0.dev7.dist-info → wandelbots_api_client-25.10.0rc2.dist-info/licenses}/LICENSE +0 -0
@@ -3,15 +3,14 @@
3
3
  """
4
4
  Wandelbots NOVA API
5
5
 
6
- Interact with robots in an easy and intuitive way. > **Note:** API version 2 is experimental and will experience functional changes.
6
+ Interact with robots in an easy and intuitive way.
7
7
 
8
- The version of the OpenAPI document: 2.0.0 beta
8
+ The version of the OpenAPI document: 2.1.0 dev
9
9
  Generated by OpenAPI Generator (https://openapi-generator.tech)
10
10
 
11
11
  Do not edit the class manually.
12
12
  """ # noqa: E501
13
13
 
14
-
15
14
  from furl import furl
16
15
  import json
17
16
  import humps
@@ -23,13 +22,11 @@ from typing import Any, AsyncGenerator, Callable, Dict, List, Optional, Tuple, U
23
22
  from typing_extensions import Annotated
24
23
  from urllib.parse import quote
25
24
 
26
- from pydantic import Field, StrictInt, StrictStr
27
- from typing import Optional
25
+ from pydantic import Field, StrictStr
26
+ from typing import List, Optional
28
27
  from typing_extensions import Annotated
29
- from wandelbots_api_client.v2.models.controllers_list import ControllersList
28
+ from wandelbots_api_client.v2.models.controller_description import ControllerDescription
30
29
  from wandelbots_api_client.v2.models.coordinate_system import CoordinateSystem
31
- from wandelbots_api_client.v2.models.get_mode_response import GetModeResponse
32
- from wandelbots_api_client.v2.models.list_coordinate_systems_response import ListCoordinateSystemsResponse
33
30
  from wandelbots_api_client.v2.models.orientation_type import OrientationType
34
31
  from wandelbots_api_client.v2.models.robot_controller import RobotController
35
32
  from wandelbots_api_client.v2.models.robot_controller_state import RobotControllerState
@@ -73,7 +70,7 @@ class ControllerApi:
73
70
  ) -> None:
74
71
  """Add Robot Controller
75
72
 
76
- Add a robot controller to the cell. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior.
73
+ Add a robot controller to the cell.
77
74
 
78
75
  :param cell: Unique identifier addressing a cell in all API calls. (required)
79
76
  :type cell: str
@@ -152,7 +149,7 @@ class ControllerApi:
152
149
  ) -> ApiResponse[None]:
153
150
  """Add Robot Controller
154
151
 
155
- Add a robot controller to the cell. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior.
152
+ Add a robot controller to the cell.
156
153
 
157
154
  :param cell: Unique identifier addressing a cell in all API calls. (required)
158
155
  :type cell: str
@@ -231,7 +228,7 @@ class ControllerApi:
231
228
  ) -> RESTResponseType:
232
229
  """Add Robot Controller
233
230
 
234
- Add a robot controller to the cell. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior.
231
+ Add a robot controller to the cell.
235
232
 
236
233
  :param cell: Unique identifier addressing a cell in all API calls. (required)
237
234
  :type cell: str
@@ -387,7 +384,7 @@ class ControllerApi:
387
384
  ) -> None:
388
385
  """Clear Robot Controllers
389
386
 
390
- Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with the 'Add Robot Controller' endpoint. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior.
387
+ Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](addRobotController).
391
388
 
392
389
  :param cell: Unique identifier addressing a cell in all API calls. (required)
393
390
  :type cell: str
@@ -460,7 +457,7 @@ class ControllerApi:
460
457
  ) -> ApiResponse[None]:
461
458
  """Clear Robot Controllers
462
459
 
463
- Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with the 'Add Robot Controller' endpoint. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior.
460
+ Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](addRobotController).
464
461
 
465
462
  :param cell: Unique identifier addressing a cell in all API calls. (required)
466
463
  :type cell: str
@@ -533,7 +530,7 @@ class ControllerApi:
533
530
  ) -> RESTResponseType:
534
531
  """Clear Robot Controllers
535
532
 
536
- Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with the 'Add Robot Controller' endpoint. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior.
533
+ Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](addRobotController).
537
534
 
538
535
  :param cell: Unique identifier addressing a cell in all API calls. (required)
539
536
  :type cell: str
@@ -669,7 +666,7 @@ class ControllerApi:
669
666
  ) -> None:
670
667
  """Delete Robot Controller
671
668
 
672
- Delete a robot controller from the cell. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior.
669
+ Delete a robot controller from the cell.
673
670
 
674
671
  :param cell: Unique identifier addressing a cell in all API calls. (required)
675
672
  :type cell: str
@@ -746,7 +743,7 @@ class ControllerApi:
746
743
  ) -> ApiResponse[None]:
747
744
  """Delete Robot Controller
748
745
 
749
- Delete a robot controller from the cell. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior.
746
+ Delete a robot controller from the cell.
750
747
 
751
748
  :param cell: Unique identifier addressing a cell in all API calls. (required)
752
749
  :type cell: str
@@ -823,7 +820,7 @@ class ControllerApi:
823
820
  ) -> RESTResponseType:
824
821
  """Delete Robot Controller
825
822
 
826
- Delete a robot controller from the cell. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior.
823
+ Delete a robot controller from the cell.
827
824
 
828
825
  :param cell: Unique identifier addressing a cell in all API calls. (required)
829
826
  :type cell: str
@@ -945,12 +942,10 @@ class ControllerApi:
945
942
 
946
943
 
947
944
  @validate_call
948
- async def get_coordinate_system(
945
+ async def get_controller_description(
949
946
  self,
950
947
  cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
951
948
  controller: Annotated[StrictStr, Field(description="Unique identifier to address a controller in the cell.")],
952
- coordinate_system: Annotated[StrictStr, Field(description="Unique identifier addressing a coordinate system.")],
953
- orientation_type: Optional[OrientationType] = None,
954
949
  _request_timeout: Union[
955
950
  None,
956
951
  Annotated[StrictFloat, Field(gt=0)],
@@ -963,19 +958,15 @@ class ControllerApi:
963
958
  _content_type: Optional[StrictStr] = None,
964
959
  _headers: Optional[Dict[StrictStr, Any]] = None,
965
960
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
966
- ) -> CoordinateSystem:
967
- """Coordinate System
961
+ ) -> ControllerDescription:
962
+ """Description
968
963
 
969
- Request a coordinate system specification for a given identifier. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
964
+ Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](getMotionGroupDescription) to get more information about the motion group.
970
965
 
971
966
  :param cell: Unique identifier addressing a cell in all API calls. (required)
972
967
  :type cell: str
973
968
  :param controller: Unique identifier to address a controller in the cell. (required)
974
969
  :type controller: str
975
- :param coordinate_system: Unique identifier addressing a coordinate system. (required)
976
- :type coordinate_system: str
977
- :param orientation_type:
978
- :type orientation_type: OrientationType
979
970
  :param _request_timeout: timeout setting for this request. If one
980
971
  number provided, it will be total request
981
972
  timeout. It can also be a pair (tuple) of
@@ -998,11 +989,9 @@ class ControllerApi:
998
989
  :return: Returns the result object.
999
990
  """ # noqa: E501
1000
991
 
1001
- _param = self._get_coordinate_system_serialize(
992
+ _param = self._get_controller_description_serialize(
1002
993
  cell=cell,
1003
994
  controller=controller,
1004
- coordinate_system=coordinate_system,
1005
- orientation_type=orientation_type,
1006
995
  _request_auth=_request_auth,
1007
996
  _content_type=_content_type,
1008
997
  _headers=_headers,
@@ -1010,7 +999,7 @@ class ControllerApi:
1010
999
  )
1011
1000
 
1012
1001
  _response_types_map: Dict[str, Optional[str]] = {
1013
- '200': "CoordinateSystem",
1002
+ '200': "ControllerDescription",
1014
1003
  '400': "Error",
1015
1004
  '404': "Error",
1016
1005
  }
@@ -1026,12 +1015,10 @@ class ControllerApi:
1026
1015
 
1027
1016
 
1028
1017
  @validate_call
1029
- async def get_coordinate_system_with_http_info(
1018
+ async def get_controller_description_with_http_info(
1030
1019
  self,
1031
1020
  cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
1032
1021
  controller: Annotated[StrictStr, Field(description="Unique identifier to address a controller in the cell.")],
1033
- coordinate_system: Annotated[StrictStr, Field(description="Unique identifier addressing a coordinate system.")],
1034
- orientation_type: Optional[OrientationType] = None,
1035
1022
  _request_timeout: Union[
1036
1023
  None,
1037
1024
  Annotated[StrictFloat, Field(gt=0)],
@@ -1044,19 +1031,15 @@ class ControllerApi:
1044
1031
  _content_type: Optional[StrictStr] = None,
1045
1032
  _headers: Optional[Dict[StrictStr, Any]] = None,
1046
1033
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1047
- ) -> ApiResponse[CoordinateSystem]:
1048
- """Coordinate System
1034
+ ) -> ApiResponse[ControllerDescription]:
1035
+ """Description
1049
1036
 
1050
- Request a coordinate system specification for a given identifier. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
1037
+ Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](getMotionGroupDescription) to get more information about the motion group.
1051
1038
 
1052
1039
  :param cell: Unique identifier addressing a cell in all API calls. (required)
1053
1040
  :type cell: str
1054
1041
  :param controller: Unique identifier to address a controller in the cell. (required)
1055
1042
  :type controller: str
1056
- :param coordinate_system: Unique identifier addressing a coordinate system. (required)
1057
- :type coordinate_system: str
1058
- :param orientation_type:
1059
- :type orientation_type: OrientationType
1060
1043
  :param _request_timeout: timeout setting for this request. If one
1061
1044
  number provided, it will be total request
1062
1045
  timeout. It can also be a pair (tuple) of
@@ -1079,11 +1062,9 @@ class ControllerApi:
1079
1062
  :return: Returns the result object.
1080
1063
  """ # noqa: E501
1081
1064
 
1082
- _param = self._get_coordinate_system_serialize(
1065
+ _param = self._get_controller_description_serialize(
1083
1066
  cell=cell,
1084
1067
  controller=controller,
1085
- coordinate_system=coordinate_system,
1086
- orientation_type=orientation_type,
1087
1068
  _request_auth=_request_auth,
1088
1069
  _content_type=_content_type,
1089
1070
  _headers=_headers,
@@ -1091,7 +1072,7 @@ class ControllerApi:
1091
1072
  )
1092
1073
 
1093
1074
  _response_types_map: Dict[str, Optional[str]] = {
1094
- '200': "CoordinateSystem",
1075
+ '200': "ControllerDescription",
1095
1076
  '400': "Error",
1096
1077
  '404': "Error",
1097
1078
  }
@@ -1107,12 +1088,10 @@ class ControllerApi:
1107
1088
 
1108
1089
 
1109
1090
  @validate_call
1110
- async def get_coordinate_system_without_preload_content(
1091
+ async def get_controller_description_without_preload_content(
1111
1092
  self,
1112
1093
  cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
1113
1094
  controller: Annotated[StrictStr, Field(description="Unique identifier to address a controller in the cell.")],
1114
- coordinate_system: Annotated[StrictStr, Field(description="Unique identifier addressing a coordinate system.")],
1115
- orientation_type: Optional[OrientationType] = None,
1116
1095
  _request_timeout: Union[
1117
1096
  None,
1118
1097
  Annotated[StrictFloat, Field(gt=0)],
@@ -1126,18 +1105,14 @@ class ControllerApi:
1126
1105
  _headers: Optional[Dict[StrictStr, Any]] = None,
1127
1106
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1128
1107
  ) -> RESTResponseType:
1129
- """Coordinate System
1108
+ """Description
1130
1109
 
1131
- Request a coordinate system specification for a given identifier. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
1110
+ Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](getMotionGroupDescription) to get more information about the motion group.
1132
1111
 
1133
1112
  :param cell: Unique identifier addressing a cell in all API calls. (required)
1134
1113
  :type cell: str
1135
1114
  :param controller: Unique identifier to address a controller in the cell. (required)
1136
1115
  :type controller: str
1137
- :param coordinate_system: Unique identifier addressing a coordinate system. (required)
1138
- :type coordinate_system: str
1139
- :param orientation_type:
1140
- :type orientation_type: OrientationType
1141
1116
  :param _request_timeout: timeout setting for this request. If one
1142
1117
  number provided, it will be total request
1143
1118
  timeout. It can also be a pair (tuple) of
@@ -1160,11 +1135,9 @@ class ControllerApi:
1160
1135
  :return: Returns the result object.
1161
1136
  """ # noqa: E501
1162
1137
 
1163
- _param = self._get_coordinate_system_serialize(
1138
+ _param = self._get_controller_description_serialize(
1164
1139
  cell=cell,
1165
1140
  controller=controller,
1166
- coordinate_system=coordinate_system,
1167
- orientation_type=orientation_type,
1168
1141
  _request_auth=_request_auth,
1169
1142
  _content_type=_content_type,
1170
1143
  _headers=_headers,
@@ -1172,7 +1145,7 @@ class ControllerApi:
1172
1145
  )
1173
1146
 
1174
1147
  _response_types_map: Dict[str, Optional[str]] = {
1175
- '200': "CoordinateSystem",
1148
+ '200': "ControllerDescription",
1176
1149
  '400': "Error",
1177
1150
  '404': "Error",
1178
1151
  }
@@ -1183,12 +1156,10 @@ class ControllerApi:
1183
1156
  return response_data.response
1184
1157
 
1185
1158
 
1186
- def _get_coordinate_system_serialize(
1159
+ def _get_controller_description_serialize(
1187
1160
  self,
1188
1161
  cell,
1189
1162
  controller,
1190
- coordinate_system,
1191
- orientation_type,
1192
1163
  _request_auth,
1193
1164
  _content_type,
1194
1165
  _headers,
@@ -1212,13 +1183,7 @@ class ControllerApi:
1212
1183
  _path_params['cell'] = cell
1213
1184
  if controller is not None:
1214
1185
  _path_params['controller'] = controller
1215
- if coordinate_system is not None:
1216
- _path_params['coordinate-system'] = coordinate_system
1217
1186
  # process the query parameters
1218
- if orientation_type is not None:
1219
-
1220
- _query_params.append(('orientation_type', orientation_type.value))
1221
-
1222
1187
  # process the header parameters
1223
1188
  # process the form parameters
1224
1189
  # process the body parameter
@@ -1240,7 +1205,7 @@ class ControllerApi:
1240
1205
 
1241
1206
  return self.api_client.param_serialize(
1242
1207
  method='GET',
1243
- resource_path='/cells/{cell}/controllers/{controller}/coordinate-systems/{coordinate-system}',
1208
+ resource_path='/cells/{cell}/controllers/{controller}/description',
1244
1209
  path_params=_path_params,
1245
1210
  query_params=_query_params,
1246
1211
  header_params=_header_params,
@@ -1256,10 +1221,12 @@ class ControllerApi:
1256
1221
 
1257
1222
 
1258
1223
  @validate_call
1259
- async def get_current_robot_controller_state(
1224
+ async def get_coordinate_system(
1260
1225
  self,
1261
1226
  cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
1262
1227
  controller: Annotated[StrictStr, Field(description="Unique identifier to address a controller in the cell.")],
1228
+ coordinate_system: Annotated[StrictStr, Field(description="Unique identifier addressing a coordinate system.")],
1229
+ orientation_type: Optional[OrientationType] = None,
1263
1230
  _request_timeout: Union[
1264
1231
  None,
1265
1232
  Annotated[StrictFloat, Field(gt=0)],
@@ -1272,15 +1239,19 @@ class ControllerApi:
1272
1239
  _content_type: Optional[StrictStr] = None,
1273
1240
  _headers: Optional[Dict[StrictStr, Any]] = None,
1274
1241
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1275
- ) -> RobotControllerState:
1276
- """State
1242
+ ) -> CoordinateSystem:
1243
+ """Coordinate System
1277
1244
 
1278
- Get the current state of a robot controller.
1245
+ Request a coordinate system specification for a given identifier. Use parameter `orientation_type` to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter `orientation_type` is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with `On` + the unique identifier of the robot controller.
1279
1246
 
1280
1247
  :param cell: Unique identifier addressing a cell in all API calls. (required)
1281
1248
  :type cell: str
1282
1249
  :param controller: Unique identifier to address a controller in the cell. (required)
1283
1250
  :type controller: str
1251
+ :param coordinate_system: Unique identifier addressing a coordinate system. (required)
1252
+ :type coordinate_system: str
1253
+ :param orientation_type:
1254
+ :type orientation_type: OrientationType
1284
1255
  :param _request_timeout: timeout setting for this request. If one
1285
1256
  number provided, it will be total request
1286
1257
  timeout. It can also be a pair (tuple) of
@@ -1303,9 +1274,11 @@ class ControllerApi:
1303
1274
  :return: Returns the result object.
1304
1275
  """ # noqa: E501
1305
1276
 
1306
- _param = self._get_current_robot_controller_state_serialize(
1277
+ _param = self._get_coordinate_system_serialize(
1307
1278
  cell=cell,
1308
1279
  controller=controller,
1280
+ coordinate_system=coordinate_system,
1281
+ orientation_type=orientation_type,
1309
1282
  _request_auth=_request_auth,
1310
1283
  _content_type=_content_type,
1311
1284
  _headers=_headers,
@@ -1313,7 +1286,7 @@ class ControllerApi:
1313
1286
  )
1314
1287
 
1315
1288
  _response_types_map: Dict[str, Optional[str]] = {
1316
- '200': "RobotControllerState",
1289
+ '200': "CoordinateSystem",
1317
1290
  '400': "Error",
1318
1291
  '404': "Error",
1319
1292
  }
@@ -1329,10 +1302,12 @@ class ControllerApi:
1329
1302
 
1330
1303
 
1331
1304
  @validate_call
1332
- async def get_current_robot_controller_state_with_http_info(
1305
+ async def get_coordinate_system_with_http_info(
1333
1306
  self,
1334
1307
  cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
1335
1308
  controller: Annotated[StrictStr, Field(description="Unique identifier to address a controller in the cell.")],
1309
+ coordinate_system: Annotated[StrictStr, Field(description="Unique identifier addressing a coordinate system.")],
1310
+ orientation_type: Optional[OrientationType] = None,
1336
1311
  _request_timeout: Union[
1337
1312
  None,
1338
1313
  Annotated[StrictFloat, Field(gt=0)],
@@ -1345,15 +1320,19 @@ class ControllerApi:
1345
1320
  _content_type: Optional[StrictStr] = None,
1346
1321
  _headers: Optional[Dict[StrictStr, Any]] = None,
1347
1322
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1348
- ) -> ApiResponse[RobotControllerState]:
1349
- """State
1323
+ ) -> ApiResponse[CoordinateSystem]:
1324
+ """Coordinate System
1350
1325
 
1351
- Get the current state of a robot controller.
1326
+ Request a coordinate system specification for a given identifier. Use parameter `orientation_type` to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter `orientation_type` is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with `On` + the unique identifier of the robot controller.
1352
1327
 
1353
1328
  :param cell: Unique identifier addressing a cell in all API calls. (required)
1354
1329
  :type cell: str
1355
1330
  :param controller: Unique identifier to address a controller in the cell. (required)
1356
1331
  :type controller: str
1332
+ :param coordinate_system: Unique identifier addressing a coordinate system. (required)
1333
+ :type coordinate_system: str
1334
+ :param orientation_type:
1335
+ :type orientation_type: OrientationType
1357
1336
  :param _request_timeout: timeout setting for this request. If one
1358
1337
  number provided, it will be total request
1359
1338
  timeout. It can also be a pair (tuple) of
@@ -1376,9 +1355,11 @@ class ControllerApi:
1376
1355
  :return: Returns the result object.
1377
1356
  """ # noqa: E501
1378
1357
 
1379
- _param = self._get_current_robot_controller_state_serialize(
1358
+ _param = self._get_coordinate_system_serialize(
1380
1359
  cell=cell,
1381
1360
  controller=controller,
1361
+ coordinate_system=coordinate_system,
1362
+ orientation_type=orientation_type,
1382
1363
  _request_auth=_request_auth,
1383
1364
  _content_type=_content_type,
1384
1365
  _headers=_headers,
@@ -1386,7 +1367,7 @@ class ControllerApi:
1386
1367
  )
1387
1368
 
1388
1369
  _response_types_map: Dict[str, Optional[str]] = {
1389
- '200': "RobotControllerState",
1370
+ '200': "CoordinateSystem",
1390
1371
  '400': "Error",
1391
1372
  '404': "Error",
1392
1373
  }
@@ -1402,10 +1383,12 @@ class ControllerApi:
1402
1383
 
1403
1384
 
1404
1385
  @validate_call
1405
- async def get_current_robot_controller_state_without_preload_content(
1386
+ async def get_coordinate_system_without_preload_content(
1406
1387
  self,
1407
1388
  cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
1408
1389
  controller: Annotated[StrictStr, Field(description="Unique identifier to address a controller in the cell.")],
1390
+ coordinate_system: Annotated[StrictStr, Field(description="Unique identifier addressing a coordinate system.")],
1391
+ orientation_type: Optional[OrientationType] = None,
1409
1392
  _request_timeout: Union[
1410
1393
  None,
1411
1394
  Annotated[StrictFloat, Field(gt=0)],
@@ -1419,14 +1402,18 @@ class ControllerApi:
1419
1402
  _headers: Optional[Dict[StrictStr, Any]] = None,
1420
1403
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1421
1404
  ) -> RESTResponseType:
1422
- """State
1405
+ """Coordinate System
1423
1406
 
1424
- Get the current state of a robot controller.
1407
+ Request a coordinate system specification for a given identifier. Use parameter `orientation_type` to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter `orientation_type` is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with `On` + the unique identifier of the robot controller.
1425
1408
 
1426
1409
  :param cell: Unique identifier addressing a cell in all API calls. (required)
1427
1410
  :type cell: str
1428
1411
  :param controller: Unique identifier to address a controller in the cell. (required)
1429
1412
  :type controller: str
1413
+ :param coordinate_system: Unique identifier addressing a coordinate system. (required)
1414
+ :type coordinate_system: str
1415
+ :param orientation_type:
1416
+ :type orientation_type: OrientationType
1430
1417
  :param _request_timeout: timeout setting for this request. If one
1431
1418
  number provided, it will be total request
1432
1419
  timeout. It can also be a pair (tuple) of
@@ -1449,9 +1436,11 @@ class ControllerApi:
1449
1436
  :return: Returns the result object.
1450
1437
  """ # noqa: E501
1451
1438
 
1452
- _param = self._get_current_robot_controller_state_serialize(
1439
+ _param = self._get_coordinate_system_serialize(
1453
1440
  cell=cell,
1454
1441
  controller=controller,
1442
+ coordinate_system=coordinate_system,
1443
+ orientation_type=orientation_type,
1455
1444
  _request_auth=_request_auth,
1456
1445
  _content_type=_content_type,
1457
1446
  _headers=_headers,
@@ -1459,7 +1448,7 @@ class ControllerApi:
1459
1448
  )
1460
1449
 
1461
1450
  _response_types_map: Dict[str, Optional[str]] = {
1462
- '200': "RobotControllerState",
1451
+ '200': "CoordinateSystem",
1463
1452
  '400': "Error",
1464
1453
  '404': "Error",
1465
1454
  }
@@ -1470,10 +1459,12 @@ class ControllerApi:
1470
1459
  return response_data.response
1471
1460
 
1472
1461
 
1473
- def _get_current_robot_controller_state_serialize(
1462
+ def _get_coordinate_system_serialize(
1474
1463
  self,
1475
1464
  cell,
1476
1465
  controller,
1466
+ coordinate_system,
1467
+ orientation_type,
1477
1468
  _request_auth,
1478
1469
  _content_type,
1479
1470
  _headers,
@@ -1497,7 +1488,13 @@ class ControllerApi:
1497
1488
  _path_params['cell'] = cell
1498
1489
  if controller is not None:
1499
1490
  _path_params['controller'] = controller
1491
+ if coordinate_system is not None:
1492
+ _path_params['coordinate-system'] = coordinate_system
1500
1493
  # process the query parameters
1494
+ if orientation_type is not None:
1495
+
1496
+ _query_params.append(('orientation_type', orientation_type.value))
1497
+
1501
1498
  # process the header parameters
1502
1499
  # process the form parameters
1503
1500
  # process the body parameter
@@ -1519,7 +1516,7 @@ class ControllerApi:
1519
1516
 
1520
1517
  return self.api_client.param_serialize(
1521
1518
  method='GET',
1522
- resource_path='/cells/{cell}/controllers/{controller}/state',
1519
+ resource_path='/cells/{cell}/controllers/{controller}/coordinate-systems/{coordinate-system}',
1523
1520
  path_params=_path_params,
1524
1521
  query_params=_query_params,
1525
1522
  header_params=_header_params,
@@ -1535,7 +1532,7 @@ class ControllerApi:
1535
1532
 
1536
1533
 
1537
1534
  @validate_call
1538
- async def get_mode(
1535
+ async def get_current_robot_controller_state(
1539
1536
  self,
1540
1537
  cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
1541
1538
  controller: Annotated[StrictStr, Field(description="Unique identifier to address a controller in the cell.")],
@@ -1551,10 +1548,10 @@ class ControllerApi:
1551
1548
  _content_type: Optional[StrictStr] = None,
1552
1549
  _headers: Optional[Dict[StrictStr, Any]] = None,
1553
1550
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1554
- ) -> GetModeResponse:
1555
- """Current Mode
1551
+ ) -> RobotControllerState:
1552
+ """State
1556
1553
 
1557
- Get the current robot system mode of a registered robot controller. The robot system mode indicates if a robot controller can be used. See [setDefaultMode](setDefaultMode) for more information about the different modes. The mode is influenced by the operating mode of the robot controller. The operating mode can be changed via [setDefaultMode](setDefaultMode). Request the current operating mode of the robot controller via [getCurrentRobotControllerState](getCurrentRobotControllerState).
1554
+ Get the current state of a robot controller.
1558
1555
 
1559
1556
  :param cell: Unique identifier addressing a cell in all API calls. (required)
1560
1557
  :type cell: str
@@ -1582,7 +1579,7 @@ class ControllerApi:
1582
1579
  :return: Returns the result object.
1583
1580
  """ # noqa: E501
1584
1581
 
1585
- _param = self._get_mode_serialize(
1582
+ _param = self._get_current_robot_controller_state_serialize(
1586
1583
  cell=cell,
1587
1584
  controller=controller,
1588
1585
  _request_auth=_request_auth,
@@ -1592,7 +1589,7 @@ class ControllerApi:
1592
1589
  )
1593
1590
 
1594
1591
  _response_types_map: Dict[str, Optional[str]] = {
1595
- '200': "GetModeResponse",
1592
+ '200': "RobotControllerState",
1596
1593
  '400': "Error",
1597
1594
  '404': "Error",
1598
1595
  }
@@ -1608,7 +1605,7 @@ class ControllerApi:
1608
1605
 
1609
1606
 
1610
1607
  @validate_call
1611
- async def get_mode_with_http_info(
1608
+ async def get_current_robot_controller_state_with_http_info(
1612
1609
  self,
1613
1610
  cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
1614
1611
  controller: Annotated[StrictStr, Field(description="Unique identifier to address a controller in the cell.")],
@@ -1624,10 +1621,10 @@ class ControllerApi:
1624
1621
  _content_type: Optional[StrictStr] = None,
1625
1622
  _headers: Optional[Dict[StrictStr, Any]] = None,
1626
1623
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1627
- ) -> ApiResponse[GetModeResponse]:
1628
- """Current Mode
1624
+ ) -> ApiResponse[RobotControllerState]:
1625
+ """State
1629
1626
 
1630
- Get the current robot system mode of a registered robot controller. The robot system mode indicates if a robot controller can be used. See [setDefaultMode](setDefaultMode) for more information about the different modes. The mode is influenced by the operating mode of the robot controller. The operating mode can be changed via [setDefaultMode](setDefaultMode). Request the current operating mode of the robot controller via [getCurrentRobotControllerState](getCurrentRobotControllerState).
1627
+ Get the current state of a robot controller.
1631
1628
 
1632
1629
  :param cell: Unique identifier addressing a cell in all API calls. (required)
1633
1630
  :type cell: str
@@ -1655,7 +1652,7 @@ class ControllerApi:
1655
1652
  :return: Returns the result object.
1656
1653
  """ # noqa: E501
1657
1654
 
1658
- _param = self._get_mode_serialize(
1655
+ _param = self._get_current_robot_controller_state_serialize(
1659
1656
  cell=cell,
1660
1657
  controller=controller,
1661
1658
  _request_auth=_request_auth,
@@ -1665,7 +1662,7 @@ class ControllerApi:
1665
1662
  )
1666
1663
 
1667
1664
  _response_types_map: Dict[str, Optional[str]] = {
1668
- '200': "GetModeResponse",
1665
+ '200': "RobotControllerState",
1669
1666
  '400': "Error",
1670
1667
  '404': "Error",
1671
1668
  }
@@ -1681,7 +1678,7 @@ class ControllerApi:
1681
1678
 
1682
1679
 
1683
1680
  @validate_call
1684
- async def get_mode_without_preload_content(
1681
+ async def get_current_robot_controller_state_without_preload_content(
1685
1682
  self,
1686
1683
  cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
1687
1684
  controller: Annotated[StrictStr, Field(description="Unique identifier to address a controller in the cell.")],
@@ -1698,9 +1695,9 @@ class ControllerApi:
1698
1695
  _headers: Optional[Dict[StrictStr, Any]] = None,
1699
1696
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1700
1697
  ) -> RESTResponseType:
1701
- """Current Mode
1698
+ """State
1702
1699
 
1703
- Get the current robot system mode of a registered robot controller. The robot system mode indicates if a robot controller can be used. See [setDefaultMode](setDefaultMode) for more information about the different modes. The mode is influenced by the operating mode of the robot controller. The operating mode can be changed via [setDefaultMode](setDefaultMode). Request the current operating mode of the robot controller via [getCurrentRobotControllerState](getCurrentRobotControllerState).
1700
+ Get the current state of a robot controller.
1704
1701
 
1705
1702
  :param cell: Unique identifier addressing a cell in all API calls. (required)
1706
1703
  :type cell: str
@@ -1728,7 +1725,7 @@ class ControllerApi:
1728
1725
  :return: Returns the result object.
1729
1726
  """ # noqa: E501
1730
1727
 
1731
- _param = self._get_mode_serialize(
1728
+ _param = self._get_current_robot_controller_state_serialize(
1732
1729
  cell=cell,
1733
1730
  controller=controller,
1734
1731
  _request_auth=_request_auth,
@@ -1738,7 +1735,7 @@ class ControllerApi:
1738
1735
  )
1739
1736
 
1740
1737
  _response_types_map: Dict[str, Optional[str]] = {
1741
- '200': "GetModeResponse",
1738
+ '200': "RobotControllerState",
1742
1739
  '400': "Error",
1743
1740
  '404': "Error",
1744
1741
  }
@@ -1749,7 +1746,7 @@ class ControllerApi:
1749
1746
  return response_data.response
1750
1747
 
1751
1748
 
1752
- def _get_mode_serialize(
1749
+ def _get_current_robot_controller_state_serialize(
1753
1750
  self,
1754
1751
  cell,
1755
1752
  controller,
@@ -1798,7 +1795,7 @@ class ControllerApi:
1798
1795
 
1799
1796
  return self.api_client.param_serialize(
1800
1797
  method='GET',
1801
- resource_path='/cells/{cell}/controllers/{controller}/mode',
1798
+ resource_path='/cells/{cell}/controllers/{controller}/state',
1802
1799
  path_params=_path_params,
1803
1800
  query_params=_query_params,
1804
1801
  header_params=_header_params,
@@ -2090,7 +2087,7 @@ class ControllerApi:
2090
2087
 
2091
2088
 
2092
2089
  @validate_call
2093
- async def get_virtual_robot_configuration(
2090
+ async def get_virtual_controller_configuration(
2094
2091
  self,
2095
2092
  cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
2096
2093
  controller: Annotated[StrictStr, Field(description="Unique identifier to address a controller in the cell.")],
@@ -2107,9 +2104,9 @@ class ControllerApi:
2107
2104
  _headers: Optional[Dict[StrictStr, Any]] = None,
2108
2105
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2109
2106
  ) -> VirtualRobotConfiguration:
2110
- """Virtual Robot Configuration
2107
+ """Virtual Controller Configuration
2111
2108
 
2112
- Receive the configuration for a virtual robot controller. Used to configure a virtual robot controller via [addRobotController](addRobotController). > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
2109
+ Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration.
2113
2110
 
2114
2111
  :param cell: Unique identifier addressing a cell in all API calls. (required)
2115
2112
  :type cell: str
@@ -2137,7 +2134,7 @@ class ControllerApi:
2137
2134
  :return: Returns the result object.
2138
2135
  """ # noqa: E501
2139
2136
 
2140
- _param = self._get_virtual_robot_configuration_serialize(
2137
+ _param = self._get_virtual_controller_configuration_serialize(
2141
2138
  cell=cell,
2142
2139
  controller=controller,
2143
2140
  _request_auth=_request_auth,
@@ -2163,7 +2160,7 @@ class ControllerApi:
2163
2160
 
2164
2161
 
2165
2162
  @validate_call
2166
- async def get_virtual_robot_configuration_with_http_info(
2163
+ async def get_virtual_controller_configuration_with_http_info(
2167
2164
  self,
2168
2165
  cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
2169
2166
  controller: Annotated[StrictStr, Field(description="Unique identifier to address a controller in the cell.")],
@@ -2180,9 +2177,9 @@ class ControllerApi:
2180
2177
  _headers: Optional[Dict[StrictStr, Any]] = None,
2181
2178
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2182
2179
  ) -> ApiResponse[VirtualRobotConfiguration]:
2183
- """Virtual Robot Configuration
2180
+ """Virtual Controller Configuration
2184
2181
 
2185
- Receive the configuration for a virtual robot controller. Used to configure a virtual robot controller via [addRobotController](addRobotController). > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
2182
+ Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration.
2186
2183
 
2187
2184
  :param cell: Unique identifier addressing a cell in all API calls. (required)
2188
2185
  :type cell: str
@@ -2210,7 +2207,7 @@ class ControllerApi:
2210
2207
  :return: Returns the result object.
2211
2208
  """ # noqa: E501
2212
2209
 
2213
- _param = self._get_virtual_robot_configuration_serialize(
2210
+ _param = self._get_virtual_controller_configuration_serialize(
2214
2211
  cell=cell,
2215
2212
  controller=controller,
2216
2213
  _request_auth=_request_auth,
@@ -2236,7 +2233,7 @@ class ControllerApi:
2236
2233
 
2237
2234
 
2238
2235
  @validate_call
2239
- async def get_virtual_robot_configuration_without_preload_content(
2236
+ async def get_virtual_controller_configuration_without_preload_content(
2240
2237
  self,
2241
2238
  cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
2242
2239
  controller: Annotated[StrictStr, Field(description="Unique identifier to address a controller in the cell.")],
@@ -2253,9 +2250,9 @@ class ControllerApi:
2253
2250
  _headers: Optional[Dict[StrictStr, Any]] = None,
2254
2251
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2255
2252
  ) -> RESTResponseType:
2256
- """Virtual Robot Configuration
2253
+ """Virtual Controller Configuration
2257
2254
 
2258
- Receive the configuration for a virtual robot controller. Used to configure a virtual robot controller via [addRobotController](addRobotController). > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
2255
+ Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration.
2259
2256
 
2260
2257
  :param cell: Unique identifier addressing a cell in all API calls. (required)
2261
2258
  :type cell: str
@@ -2283,7 +2280,7 @@ class ControllerApi:
2283
2280
  :return: Returns the result object.
2284
2281
  """ # noqa: E501
2285
2282
 
2286
- _param = self._get_virtual_robot_configuration_serialize(
2283
+ _param = self._get_virtual_controller_configuration_serialize(
2287
2284
  cell=cell,
2288
2285
  controller=controller,
2289
2286
  _request_auth=_request_auth,
@@ -2304,7 +2301,7 @@ class ControllerApi:
2304
2301
  return response_data.response
2305
2302
 
2306
2303
 
2307
- def _get_virtual_robot_configuration_serialize(
2304
+ def _get_virtual_controller_configuration_serialize(
2308
2305
  self,
2309
2306
  cell,
2310
2307
  controller,
@@ -2369,9 +2366,11 @@ class ControllerApi:
2369
2366
 
2370
2367
 
2371
2368
  @validate_call
2372
- async def list_controllers(
2369
+ async def list_coordinate_systems(
2373
2370
  self,
2374
2371
  cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
2372
+ controller: Annotated[StrictStr, Field(description="Unique identifier to address a controller in the cell.")],
2373
+ orientation_type: Optional[OrientationType] = None,
2375
2374
  _request_timeout: Union[
2376
2375
  None,
2377
2376
  Annotated[StrictFloat, Field(gt=0)],
@@ -2384,13 +2383,17 @@ class ControllerApi:
2384
2383
  _content_type: Optional[StrictStr] = None,
2385
2384
  _headers: Optional[Dict[StrictStr, Any]] = None,
2386
2385
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2387
- ) -> ControllersList:
2388
- """List Descriptions
2386
+ ) -> List[CoordinateSystem]:
2387
+ """List Coordinate Systems
2389
2388
 
2390
- List all configured robot controllers.
2389
+ Lists all specifications of coordinate systems from robot controllers. Use parameter `orientation_type` to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter `orientation_type` is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with `On` + the unique identifier of the robot controller.
2391
2390
 
2392
2391
  :param cell: Unique identifier addressing a cell in all API calls. (required)
2393
2392
  :type cell: str
2393
+ :param controller: Unique identifier to address a controller in the cell. (required)
2394
+ :type controller: str
2395
+ :param orientation_type:
2396
+ :type orientation_type: OrientationType
2394
2397
  :param _request_timeout: timeout setting for this request. If one
2395
2398
  number provided, it will be total request
2396
2399
  timeout. It can also be a pair (tuple) of
@@ -2413,8 +2416,10 @@ class ControllerApi:
2413
2416
  :return: Returns the result object.
2414
2417
  """ # noqa: E501
2415
2418
 
2416
- _param = self._list_controllers_serialize(
2419
+ _param = self._list_coordinate_systems_serialize(
2417
2420
  cell=cell,
2421
+ controller=controller,
2422
+ orientation_type=orientation_type,
2418
2423
  _request_auth=_request_auth,
2419
2424
  _content_type=_content_type,
2420
2425
  _headers=_headers,
@@ -2422,7 +2427,7 @@ class ControllerApi:
2422
2427
  )
2423
2428
 
2424
2429
  _response_types_map: Dict[str, Optional[str]] = {
2425
- '200': "ControllersList",
2430
+ '200': "List[CoordinateSystem]",
2426
2431
  '400': "Error",
2427
2432
  }
2428
2433
  response_data = await self.api_client.call_api(
@@ -2437,9 +2442,11 @@ class ControllerApi:
2437
2442
 
2438
2443
 
2439
2444
  @validate_call
2440
- async def list_controllers_with_http_info(
2445
+ async def list_coordinate_systems_with_http_info(
2441
2446
  self,
2442
2447
  cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
2448
+ controller: Annotated[StrictStr, Field(description="Unique identifier to address a controller in the cell.")],
2449
+ orientation_type: Optional[OrientationType] = None,
2443
2450
  _request_timeout: Union[
2444
2451
  None,
2445
2452
  Annotated[StrictFloat, Field(gt=0)],
@@ -2452,13 +2459,17 @@ class ControllerApi:
2452
2459
  _content_type: Optional[StrictStr] = None,
2453
2460
  _headers: Optional[Dict[StrictStr, Any]] = None,
2454
2461
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2455
- ) -> ApiResponse[ControllersList]:
2456
- """List Descriptions
2462
+ ) -> ApiResponse[List[CoordinateSystem]]:
2463
+ """List Coordinate Systems
2457
2464
 
2458
- List all configured robot controllers.
2465
+ Lists all specifications of coordinate systems from robot controllers. Use parameter `orientation_type` to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter `orientation_type` is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with `On` + the unique identifier of the robot controller.
2459
2466
 
2460
2467
  :param cell: Unique identifier addressing a cell in all API calls. (required)
2461
2468
  :type cell: str
2469
+ :param controller: Unique identifier to address a controller in the cell. (required)
2470
+ :type controller: str
2471
+ :param orientation_type:
2472
+ :type orientation_type: OrientationType
2462
2473
  :param _request_timeout: timeout setting for this request. If one
2463
2474
  number provided, it will be total request
2464
2475
  timeout. It can also be a pair (tuple) of
@@ -2481,8 +2492,10 @@ class ControllerApi:
2481
2492
  :return: Returns the result object.
2482
2493
  """ # noqa: E501
2483
2494
 
2484
- _param = self._list_controllers_serialize(
2495
+ _param = self._list_coordinate_systems_serialize(
2485
2496
  cell=cell,
2497
+ controller=controller,
2498
+ orientation_type=orientation_type,
2486
2499
  _request_auth=_request_auth,
2487
2500
  _content_type=_content_type,
2488
2501
  _headers=_headers,
@@ -2490,7 +2503,7 @@ class ControllerApi:
2490
2503
  )
2491
2504
 
2492
2505
  _response_types_map: Dict[str, Optional[str]] = {
2493
- '200': "ControllersList",
2506
+ '200': "List[CoordinateSystem]",
2494
2507
  '400': "Error",
2495
2508
  }
2496
2509
  response_data = await self.api_client.call_api(
@@ -2505,9 +2518,11 @@ class ControllerApi:
2505
2518
 
2506
2519
 
2507
2520
  @validate_call
2508
- async def list_controllers_without_preload_content(
2521
+ async def list_coordinate_systems_without_preload_content(
2509
2522
  self,
2510
2523
  cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
2524
+ controller: Annotated[StrictStr, Field(description="Unique identifier to address a controller in the cell.")],
2525
+ orientation_type: Optional[OrientationType] = None,
2511
2526
  _request_timeout: Union[
2512
2527
  None,
2513
2528
  Annotated[StrictFloat, Field(gt=0)],
@@ -2521,12 +2536,16 @@ class ControllerApi:
2521
2536
  _headers: Optional[Dict[StrictStr, Any]] = None,
2522
2537
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2523
2538
  ) -> RESTResponseType:
2524
- """List Descriptions
2539
+ """List Coordinate Systems
2525
2540
 
2526
- List all configured robot controllers.
2541
+ Lists all specifications of coordinate systems from robot controllers. Use parameter `orientation_type` to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter `orientation_type` is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with `On` + the unique identifier of the robot controller.
2527
2542
 
2528
2543
  :param cell: Unique identifier addressing a cell in all API calls. (required)
2529
2544
  :type cell: str
2545
+ :param controller: Unique identifier to address a controller in the cell. (required)
2546
+ :type controller: str
2547
+ :param orientation_type:
2548
+ :type orientation_type: OrientationType
2530
2549
  :param _request_timeout: timeout setting for this request. If one
2531
2550
  number provided, it will be total request
2532
2551
  timeout. It can also be a pair (tuple) of
@@ -2549,8 +2568,10 @@ class ControllerApi:
2549
2568
  :return: Returns the result object.
2550
2569
  """ # noqa: E501
2551
2570
 
2552
- _param = self._list_controllers_serialize(
2571
+ _param = self._list_coordinate_systems_serialize(
2553
2572
  cell=cell,
2573
+ controller=controller,
2574
+ orientation_type=orientation_type,
2554
2575
  _request_auth=_request_auth,
2555
2576
  _content_type=_content_type,
2556
2577
  _headers=_headers,
@@ -2558,7 +2579,7 @@ class ControllerApi:
2558
2579
  )
2559
2580
 
2560
2581
  _response_types_map: Dict[str, Optional[str]] = {
2561
- '200': "ControllersList",
2582
+ '200': "List[CoordinateSystem]",
2562
2583
  '400': "Error",
2563
2584
  }
2564
2585
  response_data = await self.api_client.call_api(
@@ -2568,9 +2589,11 @@ class ControllerApi:
2568
2589
  return response_data.response
2569
2590
 
2570
2591
 
2571
- def _list_controllers_serialize(
2592
+ def _list_coordinate_systems_serialize(
2572
2593
  self,
2573
2594
  cell,
2595
+ controller,
2596
+ orientation_type,
2574
2597
  _request_auth,
2575
2598
  _content_type,
2576
2599
  _headers,
@@ -2592,7 +2615,13 @@ class ControllerApi:
2592
2615
  # process the path parameters
2593
2616
  if cell is not None:
2594
2617
  _path_params['cell'] = cell
2618
+ if controller is not None:
2619
+ _path_params['controller'] = controller
2595
2620
  # process the query parameters
2621
+ if orientation_type is not None:
2622
+
2623
+ _query_params.append(('orientation_type', orientation_type.value))
2624
+
2596
2625
  # process the header parameters
2597
2626
  # process the form parameters
2598
2627
  # process the body parameter
@@ -2614,7 +2643,7 @@ class ControllerApi:
2614
2643
 
2615
2644
  return self.api_client.param_serialize(
2616
2645
  method='GET',
2617
- resource_path='/cells/{cell}/controllers',
2646
+ resource_path='/cells/{cell}/controllers/{controller}/coordinate-systems',
2618
2647
  path_params=_path_params,
2619
2648
  query_params=_query_params,
2620
2649
  header_params=_header_params,
@@ -2630,11 +2659,9 @@ class ControllerApi:
2630
2659
 
2631
2660
 
2632
2661
  @validate_call
2633
- async def list_coordinate_systems(
2662
+ async def list_robot_controllers(
2634
2663
  self,
2635
2664
  cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
2636
- controller: Annotated[StrictStr, Field(description="Unique identifier to address a controller in the cell.")],
2637
- orientation_type: Optional[OrientationType] = None,
2638
2665
  _request_timeout: Union[
2639
2666
  None,
2640
2667
  Annotated[StrictFloat, Field(gt=0)],
@@ -2647,17 +2674,13 @@ class ControllerApi:
2647
2674
  _content_type: Optional[StrictStr] = None,
2648
2675
  _headers: Optional[Dict[StrictStr, Any]] = None,
2649
2676
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2650
- ) -> ListCoordinateSystemsResponse:
2651
- """List Coordinate Systems
2677
+ ) -> List[str]:
2678
+ """List Robot Controllers
2652
2679
 
2653
- Lists all specifications of coordinate systems from robot controllers. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
2680
+ List the names of all deployed robot controllers.
2654
2681
 
2655
2682
  :param cell: Unique identifier addressing a cell in all API calls. (required)
2656
2683
  :type cell: str
2657
- :param controller: Unique identifier to address a controller in the cell. (required)
2658
- :type controller: str
2659
- :param orientation_type:
2660
- :type orientation_type: OrientationType
2661
2684
  :param _request_timeout: timeout setting for this request. If one
2662
2685
  number provided, it will be total request
2663
2686
  timeout. It can also be a pair (tuple) of
@@ -2680,10 +2703,8 @@ class ControllerApi:
2680
2703
  :return: Returns the result object.
2681
2704
  """ # noqa: E501
2682
2705
 
2683
- _param = self._list_coordinate_systems_serialize(
2706
+ _param = self._list_robot_controllers_serialize(
2684
2707
  cell=cell,
2685
- controller=controller,
2686
- orientation_type=orientation_type,
2687
2708
  _request_auth=_request_auth,
2688
2709
  _content_type=_content_type,
2689
2710
  _headers=_headers,
@@ -2691,8 +2712,7 @@ class ControllerApi:
2691
2712
  )
2692
2713
 
2693
2714
  _response_types_map: Dict[str, Optional[str]] = {
2694
- '200': "ListCoordinateSystemsResponse",
2695
- '400': "Error",
2715
+ '200': "List[str]",
2696
2716
  }
2697
2717
  response_data = await self.api_client.call_api(
2698
2718
  *_param,
@@ -2706,11 +2726,9 @@ class ControllerApi:
2706
2726
 
2707
2727
 
2708
2728
  @validate_call
2709
- async def list_coordinate_systems_with_http_info(
2729
+ async def list_robot_controllers_with_http_info(
2710
2730
  self,
2711
2731
  cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
2712
- controller: Annotated[StrictStr, Field(description="Unique identifier to address a controller in the cell.")],
2713
- orientation_type: Optional[OrientationType] = None,
2714
2732
  _request_timeout: Union[
2715
2733
  None,
2716
2734
  Annotated[StrictFloat, Field(gt=0)],
@@ -2723,17 +2741,13 @@ class ControllerApi:
2723
2741
  _content_type: Optional[StrictStr] = None,
2724
2742
  _headers: Optional[Dict[StrictStr, Any]] = None,
2725
2743
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2726
- ) -> ApiResponse[ListCoordinateSystemsResponse]:
2727
- """List Coordinate Systems
2744
+ ) -> ApiResponse[List[str]]:
2745
+ """List Robot Controllers
2728
2746
 
2729
- Lists all specifications of coordinate systems from robot controllers. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
2747
+ List the names of all deployed robot controllers.
2730
2748
 
2731
2749
  :param cell: Unique identifier addressing a cell in all API calls. (required)
2732
2750
  :type cell: str
2733
- :param controller: Unique identifier to address a controller in the cell. (required)
2734
- :type controller: str
2735
- :param orientation_type:
2736
- :type orientation_type: OrientationType
2737
2751
  :param _request_timeout: timeout setting for this request. If one
2738
2752
  number provided, it will be total request
2739
2753
  timeout. It can also be a pair (tuple) of
@@ -2756,10 +2770,8 @@ class ControllerApi:
2756
2770
  :return: Returns the result object.
2757
2771
  """ # noqa: E501
2758
2772
 
2759
- _param = self._list_coordinate_systems_serialize(
2773
+ _param = self._list_robot_controllers_serialize(
2760
2774
  cell=cell,
2761
- controller=controller,
2762
- orientation_type=orientation_type,
2763
2775
  _request_auth=_request_auth,
2764
2776
  _content_type=_content_type,
2765
2777
  _headers=_headers,
@@ -2767,8 +2779,7 @@ class ControllerApi:
2767
2779
  )
2768
2780
 
2769
2781
  _response_types_map: Dict[str, Optional[str]] = {
2770
- '200': "ListCoordinateSystemsResponse",
2771
- '400': "Error",
2782
+ '200': "List[str]",
2772
2783
  }
2773
2784
  response_data = await self.api_client.call_api(
2774
2785
  *_param,
@@ -2782,11 +2793,9 @@ class ControllerApi:
2782
2793
 
2783
2794
 
2784
2795
  @validate_call
2785
- async def list_coordinate_systems_without_preload_content(
2796
+ async def list_robot_controllers_without_preload_content(
2786
2797
  self,
2787
2798
  cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
2788
- controller: Annotated[StrictStr, Field(description="Unique identifier to address a controller in the cell.")],
2789
- orientation_type: Optional[OrientationType] = None,
2790
2799
  _request_timeout: Union[
2791
2800
  None,
2792
2801
  Annotated[StrictFloat, Field(gt=0)],
@@ -2800,16 +2809,12 @@ class ControllerApi:
2800
2809
  _headers: Optional[Dict[StrictStr, Any]] = None,
2801
2810
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2802
2811
  ) -> RESTResponseType:
2803
- """List Coordinate Systems
2812
+ """List Robot Controllers
2804
2813
 
2805
- Lists all specifications of coordinate systems from robot controllers. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
2814
+ List the names of all deployed robot controllers.
2806
2815
 
2807
2816
  :param cell: Unique identifier addressing a cell in all API calls. (required)
2808
2817
  :type cell: str
2809
- :param controller: Unique identifier to address a controller in the cell. (required)
2810
- :type controller: str
2811
- :param orientation_type:
2812
- :type orientation_type: OrientationType
2813
2818
  :param _request_timeout: timeout setting for this request. If one
2814
2819
  number provided, it will be total request
2815
2820
  timeout. It can also be a pair (tuple) of
@@ -2832,10 +2837,8 @@ class ControllerApi:
2832
2837
  :return: Returns the result object.
2833
2838
  """ # noqa: E501
2834
2839
 
2835
- _param = self._list_coordinate_systems_serialize(
2840
+ _param = self._list_robot_controllers_serialize(
2836
2841
  cell=cell,
2837
- controller=controller,
2838
- orientation_type=orientation_type,
2839
2842
  _request_auth=_request_auth,
2840
2843
  _content_type=_content_type,
2841
2844
  _headers=_headers,
@@ -2843,8 +2846,7 @@ class ControllerApi:
2843
2846
  )
2844
2847
 
2845
2848
  _response_types_map: Dict[str, Optional[str]] = {
2846
- '200': "ListCoordinateSystemsResponse",
2847
- '400': "Error",
2849
+ '200': "List[str]",
2848
2850
  }
2849
2851
  response_data = await self.api_client.call_api(
2850
2852
  *_param,
@@ -2853,11 +2855,9 @@ class ControllerApi:
2853
2855
  return response_data.response
2854
2856
 
2855
2857
 
2856
- def _list_coordinate_systems_serialize(
2858
+ def _list_robot_controllers_serialize(
2857
2859
  self,
2858
2860
  cell,
2859
- controller,
2860
- orientation_type,
2861
2861
  _request_auth,
2862
2862
  _content_type,
2863
2863
  _headers,
@@ -2879,13 +2879,7 @@ class ControllerApi:
2879
2879
  # process the path parameters
2880
2880
  if cell is not None:
2881
2881
  _path_params['cell'] = cell
2882
- if controller is not None:
2883
- _path_params['controller'] = controller
2884
2882
  # process the query parameters
2885
- if orientation_type is not None:
2886
-
2887
- _query_params.append(('orientation_type', orientation_type.value))
2888
-
2889
2883
  # process the header parameters
2890
2884
  # process the form parameters
2891
2885
  # process the body parameter
@@ -2907,7 +2901,7 @@ class ControllerApi:
2907
2901
 
2908
2902
  return self.api_client.param_serialize(
2909
2903
  method='GET',
2910
- resource_path='/cells/{cell}/controllers/{controller}/coordinate-systems',
2904
+ resource_path='/cells/{cell}/controllers',
2911
2905
  path_params=_path_params,
2912
2906
  query_params=_query_params,
2913
2907
  header_params=_header_params,
@@ -2943,7 +2937,7 @@ class ControllerApi:
2943
2937
  ) -> None:
2944
2938
  """Set Default Mode
2945
2939
 
2946
- Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state 'normal' or 'reduced'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can't be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
2940
+ Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network, monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state `normal` or `reduced`. If the robot controller is in `manual` operating mode, you have to manually confirm the control usage activation on the robot control panel. This manual confirmation can't be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > `setDefaultMode` enables the robot controller to stay in control mode to keep the motors activated. > This allows for faster execution of sequential movements as no mode switches are required. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
2947
2941
 
2948
2942
  :param cell: Unique identifier addressing a cell in all API calls. (required)
2949
2943
  :type cell: str
@@ -3020,7 +3014,7 @@ class ControllerApi:
3020
3014
  ) -> ApiResponse[None]:
3021
3015
  """Set Default Mode
3022
3016
 
3023
- Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state 'normal' or 'reduced'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can't be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
3017
+ Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network, monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state `normal` or `reduced`. If the robot controller is in `manual` operating mode, you have to manually confirm the control usage activation on the robot control panel. This manual confirmation can't be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > `setDefaultMode` enables the robot controller to stay in control mode to keep the motors activated. > This allows for faster execution of sequential movements as no mode switches are required. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
3024
3018
 
3025
3019
  :param cell: Unique identifier addressing a cell in all API calls. (required)
3026
3020
  :type cell: str
@@ -3097,7 +3091,7 @@ class ControllerApi:
3097
3091
  ) -> RESTResponseType:
3098
3092
  """Set Default Mode
3099
3093
 
3100
- Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state 'normal' or 'reduced'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can't be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
3094
+ Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network, monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state `normal` or `reduced`. If the robot controller is in `manual` operating mode, you have to manually confirm the control usage activation on the robot control panel. This manual confirmation can't be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > `setDefaultMode` enables the robot controller to stay in control mode to keep the motors activated. > This allows for faster execution of sequential movements as no mode switches are required. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
3101
3095
 
3102
3096
  :param cell: Unique identifier addressing a cell in all API calls. (required)
3103
3097
  :type cell: str
@@ -3219,10 +3213,10 @@ class ControllerApi:
3219
3213
 
3220
3214
 
3221
3215
  @validate_call
3222
- async def stream_free_drive(self, cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")], controller: Annotated[StrictStr, Field(description="Unique identifier to address a controller in the cell.")], response_rate: Optional[StrictInt] = None) -> AsyncGenerator[RobotControllerState, None]: # noqa: E501
3216
+ async def stream_free_drive(self, cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")], controller: Annotated[StrictStr, Field(description="Unique identifier to address a controller in the cell.")], response_rate: Optional[Annotated[int, Field(le=2147483647, strict=True, ge=0)]] = None) -> AsyncGenerator[RobotControllerState, None]: # noqa: E501
3223
3217
  """Stream Free Drive # noqa: E501
3224
3218
 
3225
- <!-- theme: danger --> > Websocket endpoint Sets the robot controller into freedrive mode and stays in freedrive until the websocket connection is closed by the client. In freedrive mode, it is possible to move the attached motion groups by hand. This is a blocking call. As long as the websocket connection is open, no other endpoint can control or move the robot. <!-- theme: danger --> > **DANGER** > Danger caused by robot. Improper assessment by the integrator of the application-specific hazards can result in people being > crushed, drawn in or caught due to the robot's complex movement sequences. Before opening the websocket, ensure that > - The robot is in a safe state, > - The right payload is set (e.g by using the (getActivePayload)[getActivePayload] endpoint), > - No humans or object are within the robot's reach or within the cell. As long as the websocket connection is open you will get the current state of the robot system in the response in the specified response_rate. If the activation failed, the returned status will return possible reasons for the failure. Free drive mode is only available for robot controllers that support it, in particular Collobarative Robots (\"Cobots\"). Use the (listController)[listController] endpoint to check if the robot controller supports free drive mode. # noqa: E501
3219
+ <!-- theme: success --> > Websocket endpoint Sets the robot controller into freedrive mode and stays in freedrive until the websocket connection is closed by the client. In freedrive mode, it is possible to move the attached motion groups by hand. This is a blocking call. As long as the websocket connection is open, no other endpoint can control or move the robot. <!-- theme: danger --> > **DANGER** > > Danger caused by robot. Improper assessment by the integrator of the application-specific hazards can result in people being > crushed, drawn in or caught due to the robot's complex movement sequences. Before opening the websocket, ensure that > > - The robot is in a safe state, > - The right payload is set, > - No humans or object are within the robot's reach or within the cell. As long as the websocket connection is open you will get the current state of the robot system in the response in the specified `response_rate`. If the activation failed, the returned status will return possible reasons for the failure. Free drive mode is only available for robot controllers that support it, in particular cobots. Use [listRobotControllers](listRobotControllers) to check if the robot controller supports free drive mode. # noqa: E501
3226
3220
  :param request: A StreamFreeDriveRequest
3227
3221
  :info All responses from the server will be yielded
3228
3222
  :type StreamFreeDriveRequest
@@ -3285,13 +3279,15 @@ class ControllerApi:
3285
3279
  yield RobotControllerState.from_dict(response_data["result"])
3286
3280
  except websockets.exceptions.ConnectionClosed:
3287
3281
  return
3282
+ finally:
3283
+ await websocket.close()
3288
3284
 
3289
3285
 
3290
3286
  @validate_call
3291
- async def stream_robot_controller_state(self, cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")], controller: Annotated[StrictStr, Field(description="Unique identifier to address a controller in the cell.")], response_rate: Optional[StrictInt] = None) -> AsyncGenerator[RobotControllerState, None]: # noqa: E501
3287
+ async def stream_robot_controller_state(self, cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")], controller: Annotated[StrictStr, Field(description="Unique identifier to address a controller in the cell.")], response_rate: Optional[Annotated[int, Field(le=2147483647, strict=True, ge=0)]] = None, add_controller_timeout: Optional[Annotated[int, Field(le=2147483647, strict=True, ge=0)]] = None) -> AsyncGenerator[RobotControllerState, None]: # noqa: E501
3292
3288
  """Stream State # noqa: E501
3293
3289
 
3294
- <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller. # noqa: E501
3290
+ <!-- theme: success --> > Websocket endpoint Receive updates of the state of a robot controller. The stream can be opened before the controller is registered. To register a controller, call [addRobotController](addRobotController). While connecting, the stream sends initialization updates. Once the controller reaches `MODE_MONITOR`, it sends controller state updates. # noqa: E501
3295
3291
  :param request: A StreamRobotControllerStateRequest
3296
3292
  :info All responses from the server will be yielded
3297
3293
  :type StreamRobotControllerStateRequest
@@ -3343,6 +3339,12 @@ class ControllerApi:
3343
3339
  url_schema += "&".join(["response_rate=" + s for s in response_rate])
3344
3340
  else:
3345
3341
  url_schema += "response_rate="+str(response_rate)
3342
+ if locals().get("add_controller_timeout") is not None:
3343
+ url_schema = append_parameter_connector(url_schema)
3344
+ if isinstance(add_controller_timeout, list):
3345
+ url_schema += "&".join(["add_controller_timeout=" + s for s in add_controller_timeout])
3346
+ else:
3347
+ url_schema += "add_controller_timeout="+str(add_controller_timeout)
3346
3348
  full_url = furl(url_schema)
3347
3349
 
3348
3350
  async with websockets.connect(full_url.url, open_timeout=10, additional_headers=headers) as websocket:
@@ -3354,6 +3356,8 @@ class ControllerApi:
3354
3356
  yield RobotControllerState.from_dict(response_data["result"])
3355
3357
  except websockets.exceptions.ConnectionClosed:
3356
3358
  return
3359
+ finally:
3360
+ await websocket.close()
3357
3361
 
3358
3362
 
3359
3363
  @validate_call
@@ -3378,7 +3382,7 @@ class ControllerApi:
3378
3382
  ) -> None:
3379
3383
  """Update Robot Controller
3380
3384
 
3381
- Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior.
3385
+ Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. To update a virtual controller, the previous controller will be deleted and a new one created. Changes to the configuration, e.g., TCPs, coordinate systems, mounting, are **not** transferred to the new robot. <!-- theme: info --> > **NOTE** > > An update is not a reset. To do a reset: > 1. Get the current configuration via [getRobotController](getRobotController). > 2. Delete the existing virtual robot controller via [deleteRobotController](deleteRobotController). > 3. Add a virtual robot controller with [addRobotController](addRobotController).
3382
3386
 
3383
3387
  :param cell: Unique identifier addressing a cell in all API calls. (required)
3384
3388
  :type cell: str
@@ -3459,7 +3463,7 @@ class ControllerApi:
3459
3463
  ) -> ApiResponse[None]:
3460
3464
  """Update Robot Controller
3461
3465
 
3462
- Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior.
3466
+ Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. To update a virtual controller, the previous controller will be deleted and a new one created. Changes to the configuration, e.g., TCPs, coordinate systems, mounting, are **not** transferred to the new robot. <!-- theme: info --> > **NOTE** > > An update is not a reset. To do a reset: > 1. Get the current configuration via [getRobotController](getRobotController). > 2. Delete the existing virtual robot controller via [deleteRobotController](deleteRobotController). > 3. Add a virtual robot controller with [addRobotController](addRobotController).
3463
3467
 
3464
3468
  :param cell: Unique identifier addressing a cell in all API calls. (required)
3465
3469
  :type cell: str
@@ -3540,7 +3544,7 @@ class ControllerApi:
3540
3544
  ) -> RESTResponseType:
3541
3545
  """Update Robot Controller
3542
3546
 
3543
- Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior.
3547
+ Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. To update a virtual controller, the previous controller will be deleted and a new one created. Changes to the configuration, e.g., TCPs, coordinate systems, mounting, are **not** transferred to the new robot. <!-- theme: info --> > **NOTE** > > An update is not a reset. To do a reset: > 1. Get the current configuration via [getRobotController](getRobotController). > 2. Delete the existing virtual robot controller via [deleteRobotController](deleteRobotController). > 3. Add a virtual robot controller with [addRobotController](addRobotController).
3544
3548
 
3545
3549
  :param cell: Unique identifier addressing a cell in all API calls. (required)
3546
3550
  :type cell: str