wandelbots-api-client 25.8.0.dev77__py3-none-any.whl → 25.11.0.dev12__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 (637) 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 +10 -5
  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 +17 -6
  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 +11 -6
  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 +6 -4
  29. wandelbots_api_client/api/virtual_robot_mode_api.py +1 -2
  30. wandelbots_api_client/api/virtual_robot_setup_api.py +1 -2
  31. wandelbots_api_client/api_client.py +14 -7
  32. wandelbots_api_client/configuration.py +18 -7
  33. wandelbots_api_client/exceptions.py +1 -1
  34. wandelbots_api_client/models/__init__.py +3 -4
  35. wandelbots_api_client/models/abb_controller.py +5 -5
  36. wandelbots_api_client/models/abb_controller_egm_server.py +3 -3
  37. wandelbots_api_client/models/activate_license_request.py +2 -2
  38. wandelbots_api_client/models/add_request.py +3 -3
  39. wandelbots_api_client/models/all_joint_positions_request.py +3 -3
  40. wandelbots_api_client/models/all_joint_positions_response.py +2 -2
  41. wandelbots_api_client/models/api_version.py +91 -0
  42. wandelbots_api_client/models/app.py +8 -8
  43. wandelbots_api_client/models/array_input.py +2 -2
  44. wandelbots_api_client/models/array_output.py +2 -2
  45. wandelbots_api_client/models/behavior.py +1 -1
  46. wandelbots_api_client/models/blending_auto.py +3 -3
  47. wandelbots_api_client/models/blending_position.py +3 -3
  48. wandelbots_api_client/models/box.py +5 -5
  49. wandelbots_api_client/models/box2.py +6 -6
  50. wandelbots_api_client/models/box3.py +6 -6
  51. wandelbots_api_client/models/capsule.py +3 -3
  52. wandelbots_api_client/models/capsule2.py +4 -4
  53. wandelbots_api_client/models/capsule3.py +4 -4
  54. wandelbots_api_client/models/capture.py +2 -2
  55. wandelbots_api_client/models/cell.py +4 -4
  56. wandelbots_api_client/models/circle.py +3 -3
  57. wandelbots_api_client/models/code_with_arguments.py +7 -6
  58. wandelbots_api_client/models/collection_value.py +1 -1
  59. wandelbots_api_client/models/collider.py +4 -4
  60. wandelbots_api_client/models/collider_input.py +4 -4
  61. wandelbots_api_client/models/collider_output.py +4 -4
  62. wandelbots_api_client/models/collider_output_shape.py +1 -1
  63. wandelbots_api_client/models/collider_shape.py +1 -41
  64. wandelbots_api_client/models/collision.py +7 -7
  65. wandelbots_api_client/models/collision_contact.py +3 -3
  66. wandelbots_api_client/models/collision_motion_group.py +7 -6
  67. wandelbots_api_client/models/collision_motion_group_assembly.py +9 -8
  68. wandelbots_api_client/models/collision_robot_configuration_input.py +12 -10
  69. wandelbots_api_client/models/collision_robot_configuration_output.py +12 -10
  70. wandelbots_api_client/models/collision_scene.py +11 -9
  71. wandelbots_api_client/models/collision_scene_assembly.py +14 -12
  72. wandelbots_api_client/models/command.py +7 -7
  73. wandelbots_api_client/models/command_settings.py +4 -4
  74. wandelbots_api_client/models/comparator.py +1 -1
  75. wandelbots_api_client/models/compound.py +2 -2
  76. wandelbots_api_client/models/container_environment_inner.py +3 -3
  77. wandelbots_api_client/models/container_image.py +4 -4
  78. wandelbots_api_client/models/container_image_secrets_inner.py +2 -2
  79. wandelbots_api_client/models/container_resources.py +2 -2
  80. wandelbots_api_client/models/container_storage.py +3 -3
  81. wandelbots_api_client/models/controller_capabilities.py +3 -3
  82. wandelbots_api_client/models/controller_instance.py +9 -9
  83. wandelbots_api_client/models/controller_instance_list.py +2 -2
  84. wandelbots_api_client/models/convex_hull.py +2 -2
  85. wandelbots_api_client/models/convex_hull2.py +3 -3
  86. wandelbots_api_client/models/convex_hull3.py +3 -3
  87. wandelbots_api_client/models/coordinate_system.py +6 -6
  88. wandelbots_api_client/models/coordinate_systems.py +2 -2
  89. wandelbots_api_client/models/create_device_request_inner.py +1 -1
  90. wandelbots_api_client/models/create_program_run200_response.py +2 -2
  91. wandelbots_api_client/models/create_program_run_request.py +2 -2
  92. wandelbots_api_client/models/create_trigger200_response.py +2 -2
  93. wandelbots_api_client/models/create_trigger_request.py +7 -7
  94. wandelbots_api_client/models/cubic_spline.py +2 -2
  95. wandelbots_api_client/models/cubic_spline_cubic_spline_parameter.py +3 -3
  96. wandelbots_api_client/models/cubic_spline_parameter.py +3 -3
  97. wandelbots_api_client/models/cycle_time.py +2 -2
  98. wandelbots_api_client/models/cylinder.py +3 -3
  99. wandelbots_api_client/models/cylinder2.py +4 -4
  100. wandelbots_api_client/models/cylinder3.py +4 -4
  101. wandelbots_api_client/models/dh_parameter.py +6 -6
  102. wandelbots_api_client/models/direction.py +1 -1
  103. wandelbots_api_client/models/direction_jogging_request.py +10 -10
  104. wandelbots_api_client/models/error.py +3 -3
  105. wandelbots_api_client/models/execute_trajectory_request.py +1 -1
  106. wandelbots_api_client/models/execute_trajectory_response.py +1 -1
  107. wandelbots_api_client/models/execution_result.py +4 -4
  108. wandelbots_api_client/models/external_joint_stream_datapoint.py +3 -3
  109. wandelbots_api_client/models/external_joint_stream_datapoint_value.py +5 -5
  110. wandelbots_api_client/models/fanuc_controller.py +3 -3
  111. wandelbots_api_client/models/feedback_collision.py +5 -5
  112. wandelbots_api_client/models/feedback_joint_limit_exceeded.py +4 -4
  113. wandelbots_api_client/models/feedback_out_of_workspace.py +3 -3
  114. wandelbots_api_client/models/feedback_singularity.py +4 -4
  115. wandelbots_api_client/models/flag.py +2 -2
  116. wandelbots_api_client/models/force_vector.py +4 -4
  117. wandelbots_api_client/models/geometry.py +12 -12
  118. wandelbots_api_client/models/get_all_program_runs200_response.py +2 -2
  119. wandelbots_api_client/models/get_all_triggers200_response.py +2 -2
  120. wandelbots_api_client/models/get_mode_response.py +2 -2
  121. wandelbots_api_client/models/get_trajectory_response.py +2 -2
  122. wandelbots_api_client/models/get_trajectory_sample_response.py +2 -2
  123. wandelbots_api_client/models/google_protobuf_any.py +2 -2
  124. wandelbots_api_client/models/http_exception_response.py +2 -2
  125. wandelbots_api_client/models/http_validation_error.py +2 -2
  126. wandelbots_api_client/models/http_validation_error2.py +2 -2
  127. wandelbots_api_client/models/image_credentials.py +4 -4
  128. wandelbots_api_client/models/info_service_capabilities.py +8 -8
  129. wandelbots_api_client/models/initialize_movement_request.py +6 -6
  130. wandelbots_api_client/models/initialize_movement_response.py +2 -2
  131. wandelbots_api_client/models/initialize_movement_response_init_response.py +3 -3
  132. wandelbots_api_client/models/io.py +6 -6
  133. wandelbots_api_client/models/io_description.py +10 -10
  134. wandelbots_api_client/models/io_value.py +5 -5
  135. wandelbots_api_client/models/ios.py +2 -2
  136. wandelbots_api_client/models/jogging_response.py +4 -4
  137. wandelbots_api_client/models/jogging_service_capabilities.py +3 -3
  138. wandelbots_api_client/models/joint_jogging_request.py +6 -6
  139. wandelbots_api_client/models/joint_limit.py +5 -5
  140. wandelbots_api_client/models/joint_limit_exceeded.py +3 -3
  141. wandelbots_api_client/models/joint_position_request.py +4 -4
  142. wandelbots_api_client/models/joint_trajectory.py +4 -4
  143. wandelbots_api_client/models/joints.py +2 -2
  144. wandelbots_api_client/models/kinematic_service_capabilities.py +4 -4
  145. wandelbots_api_client/models/kuka_controller.py +10 -8
  146. wandelbots_api_client/models/kuka_controller_rsi_server.py +3 -3
  147. wandelbots_api_client/models/license.py +11 -11
  148. wandelbots_api_client/models/license_status.py +3 -3
  149. wandelbots_api_client/models/license_status_enum.py +1 -1
  150. wandelbots_api_client/models/limit_settings.py +13 -13
  151. wandelbots_api_client/models/limits_override.py +7 -7
  152. wandelbots_api_client/models/list_devices200_response_inner.py +1 -1
  153. wandelbots_api_client/models/list_io_descriptions_response.py +2 -2
  154. wandelbots_api_client/models/list_io_values_response.py +2 -2
  155. wandelbots_api_client/models/list_payloads_response.py +2 -2
  156. wandelbots_api_client/models/list_program_metadata_response.py +2 -2
  157. wandelbots_api_client/models/list_recipe_metadata_response.py +2 -2
  158. wandelbots_api_client/models/list_response.py +2 -2
  159. wandelbots_api_client/models/list_tcps_response.py +2 -2
  160. wandelbots_api_client/models/manufacturer.py +1 -1
  161. wandelbots_api_client/models/mode_change_response.py +5 -5
  162. wandelbots_api_client/models/motion_command.py +4 -4
  163. wandelbots_api_client/models/motion_command_blending.py +1 -1
  164. wandelbots_api_client/models/motion_command_path.py +1 -1
  165. wandelbots_api_client/models/motion_group_behavior_getter.py +2 -2
  166. wandelbots_api_client/models/motion_group_info.py +4 -4
  167. wandelbots_api_client/models/motion_group_infos.py +2 -2
  168. wandelbots_api_client/models/motion_group_instance.py +6 -6
  169. wandelbots_api_client/models/motion_group_instance_list.py +2 -2
  170. wandelbots_api_client/models/motion_group_joints.py +5 -5
  171. wandelbots_api_client/models/motion_group_physical.py +6 -6
  172. wandelbots_api_client/models/motion_group_specification.py +3 -3
  173. wandelbots_api_client/models/motion_group_state.py +13 -13
  174. wandelbots_api_client/models/motion_group_state_joint_limit_reached.py +2 -2
  175. wandelbots_api_client/models/motion_group_state_response.py +3 -3
  176. wandelbots_api_client/models/motion_id.py +2 -2
  177. wandelbots_api_client/models/motion_ids_list_response.py +2 -2
  178. wandelbots_api_client/models/motion_vector.py +4 -4
  179. wandelbots_api_client/models/mounting.py +3 -3
  180. wandelbots_api_client/models/move_request.py +9 -9
  181. wandelbots_api_client/models/move_response.py +3 -3
  182. wandelbots_api_client/models/move_to_trajectory_via_joint_ptp_request.py +5 -5
  183. wandelbots_api_client/models/movement.py +2 -2
  184. wandelbots_api_client/models/movement_error.py +2 -2
  185. wandelbots_api_client/models/movement_error_error.py +2 -2
  186. wandelbots_api_client/models/movement_movement.py +4 -4
  187. wandelbots_api_client/models/op_mode.py +2 -2
  188. wandelbots_api_client/models/opcua_node_value_trigger_config.py +4 -4
  189. wandelbots_api_client/models/opcua_node_value_trigger_config_node_value.py +1 -1
  190. wandelbots_api_client/models/optimizer_setup.py +8 -8
  191. wandelbots_api_client/models/out_of_workspace.py +2 -2
  192. wandelbots_api_client/models/path.py +2 -2
  193. wandelbots_api_client/models/path_cartesian_ptp.py +3 -3
  194. wandelbots_api_client/models/path_circle.py +4 -4
  195. wandelbots_api_client/models/path_cubic_spline.py +3 -3
  196. wandelbots_api_client/models/path_joint_ptp.py +3 -3
  197. wandelbots_api_client/models/path_line.py +3 -3
  198. wandelbots_api_client/models/pause_movement_request.py +3 -3
  199. wandelbots_api_client/models/pause_movement_response.py +2 -2
  200. wandelbots_api_client/models/pause_movement_response_pause_response.py +3 -3
  201. wandelbots_api_client/models/pause_on_io.py +3 -3
  202. wandelbots_api_client/models/payload.py +5 -5
  203. wandelbots_api_client/models/plan_collision_free_ptp_request.py +10 -9
  204. wandelbots_api_client/models/plan_collision_free_ptp_request_target.py +1 -1
  205. wandelbots_api_client/models/plan_failed_on_trajectory_response.py +10 -10
  206. wandelbots_api_client/models/plan_failed_response.py +8 -8
  207. wandelbots_api_client/models/plan_request.py +6 -6
  208. wandelbots_api_client/models/plan_response.py +4 -4
  209. wandelbots_api_client/models/plan_successful_response.py +3 -3
  210. wandelbots_api_client/models/plan_trajectory_failed_response.py +4 -4
  211. wandelbots_api_client/models/plan_trajectory_failed_response_error_feedback.py +1 -1
  212. wandelbots_api_client/models/plan_trajectory_request.py +10 -9
  213. wandelbots_api_client/models/plan_trajectory_response.py +2 -2
  214. wandelbots_api_client/models/plan_trajectory_response_response.py +1 -1
  215. wandelbots_api_client/models/plane2.py +2 -2
  216. wandelbots_api_client/models/plane3.py +2 -2
  217. wandelbots_api_client/models/planned_motion.py +6 -6
  218. wandelbots_api_client/models/planner_pose.py +3 -3
  219. wandelbots_api_client/models/planning_limits.py +13 -13
  220. wandelbots_api_client/models/planning_limits_limit_range.py +3 -3
  221. wandelbots_api_client/models/playback_speed_request.py +3 -3
  222. wandelbots_api_client/models/playback_speed_response.py +2 -2
  223. wandelbots_api_client/models/playback_speed_response_playback_speed_response.py +2 -2
  224. wandelbots_api_client/models/point_cloud.py +2 -2
  225. wandelbots_api_client/models/pose.py +4 -4
  226. wandelbots_api_client/models/pose2.py +3 -3
  227. wandelbots_api_client/models/program_metadata.py +7 -7
  228. wandelbots_api_client/models/program_run.py +15 -14
  229. wandelbots_api_client/models/program_run_object.py +7 -7
  230. wandelbots_api_client/models/program_run_state.py +1 -1
  231. wandelbots_api_client/models/program_runner_reference.py +3 -3
  232. wandelbots_api_client/models/pyjectory_datatypes_core_pose.py +3 -3
  233. wandelbots_api_client/models/pyjectory_datatypes_serializer_orientation.py +2 -2
  234. wandelbots_api_client/models/pyjectory_datatypes_serializer_pose.py +2 -2
  235. wandelbots_api_client/models/pyjectory_datatypes_serializer_position.py +2 -2
  236. wandelbots_api_client/models/pyriphery_etcd_etcd_configuration.py +5 -5
  237. wandelbots_api_client/models/pyriphery_hardware_isaac_isaac_configuration.py +5 -5
  238. wandelbots_api_client/models/pyriphery_opcua_opcua_configuration.py +4 -4
  239. wandelbots_api_client/models/pyriphery_pyrae_controller_controller_configuration.py +7 -7
  240. wandelbots_api_client/models/pyriphery_pyrae_robot_robot_configuration.py +8 -8
  241. wandelbots_api_client/models/pyriphery_robotics_configurable_collision_scene_configurable_collision_scene_configuration_input.py +13 -11
  242. wandelbots_api_client/models/pyriphery_robotics_configurable_collision_scene_configurable_collision_scene_configuration_output.py +13 -11
  243. wandelbots_api_client/models/pyriphery_robotics_robotcell_timer_configuration.py +3 -3
  244. wandelbots_api_client/models/pyriphery_robotics_simulation_robot_with_view_open3d_configuration.py +4 -4
  245. wandelbots_api_client/models/pyriphery_robotics_simulation_simulated_io_configuration.py +3 -3
  246. wandelbots_api_client/models/pyriphery_robotics_simulation_simulated_opcua_configuration.py +3 -3
  247. wandelbots_api_client/models/quaternion.py +5 -5
  248. wandelbots_api_client/models/recipe_metadata.py +8 -8
  249. wandelbots_api_client/models/rectangle.py +3 -3
  250. wandelbots_api_client/models/rectangle2.py +4 -4
  251. wandelbots_api_client/models/rectangle3.py +4 -4
  252. wandelbots_api_client/models/rectangular_capsule.py +4 -4
  253. wandelbots_api_client/models/rectangular_capsule2.py +5 -5
  254. wandelbots_api_client/models/rectangular_capsule3.py +5 -5
  255. wandelbots_api_client/models/release_channel.py +1 -1
  256. wandelbots_api_client/models/request.py +1 -1
  257. wandelbots_api_client/models/request1.py +1 -1
  258. wandelbots_api_client/models/response_get_value_programs_values_key_get.py +1 -1
  259. wandelbots_api_client/models/response_get_values_programs_values_get_value.py +1 -1
  260. wandelbots_api_client/models/robot_controller.py +3 -3
  261. wandelbots_api_client/models/robot_controller_configuration.py +1 -1
  262. wandelbots_api_client/models/robot_controller_state.py +8 -8
  263. wandelbots_api_client/models/robot_link_geometry.py +3 -3
  264. wandelbots_api_client/models/robot_state.py +3 -3
  265. wandelbots_api_client/models/robot_system_mode.py +1 -1
  266. wandelbots_api_client/models/robot_tcp.py +5 -5
  267. wandelbots_api_client/models/robot_tcps.py +2 -2
  268. wandelbots_api_client/models/rotation_angle_types.py +1 -1
  269. wandelbots_api_client/models/rotation_angles.py +3 -3
  270. wandelbots_api_client/models/safety_configuration.py +6 -6
  271. wandelbots_api_client/models/safety_setup.py +5 -5
  272. wandelbots_api_client/models/safety_setup_safety_settings.py +3 -3
  273. wandelbots_api_client/models/safety_setup_safety_zone.py +5 -5
  274. wandelbots_api_client/models/safety_zone.py +4 -4
  275. wandelbots_api_client/models/safety_zone_limits.py +3 -3
  276. wandelbots_api_client/models/safety_zone_violation.py +2 -2
  277. wandelbots_api_client/models/service_status.py +3 -3
  278. wandelbots_api_client/models/service_status_phase.py +1 -1
  279. wandelbots_api_client/models/service_status_severity.py +1 -1
  280. wandelbots_api_client/models/service_status_status.py +4 -4
  281. wandelbots_api_client/models/set_io.py +3 -3
  282. wandelbots_api_client/models/set_playback_speed.py +3 -3
  283. wandelbots_api_client/models/single_joint_limit.py +3 -3
  284. wandelbots_api_client/models/singularity.py +3 -3
  285. wandelbots_api_client/models/singularity_type_enum.py +1 -1
  286. wandelbots_api_client/models/sphere.py +2 -2
  287. wandelbots_api_client/models/sphere2.py +3 -3
  288. wandelbots_api_client/models/sphere3.py +3 -3
  289. wandelbots_api_client/models/standstill.py +2 -2
  290. wandelbots_api_client/models/standstill_reason.py +1 -1
  291. wandelbots_api_client/models/standstill_standstill.py +4 -4
  292. wandelbots_api_client/models/start_movement_request.py +6 -6
  293. wandelbots_api_client/models/start_on_io.py +3 -3
  294. wandelbots_api_client/models/status.py +4 -4
  295. wandelbots_api_client/models/stop_response.py +4 -4
  296. wandelbots_api_client/models/store_value.py +1 -1
  297. wandelbots_api_client/models/stream_move_backward.py +2 -2
  298. wandelbots_api_client/models/stream_move_forward.py +2 -2
  299. wandelbots_api_client/models/stream_move_playback_speed.py +2 -2
  300. wandelbots_api_client/models/stream_move_request.py +1 -1
  301. wandelbots_api_client/models/stream_move_response.py +4 -4
  302. wandelbots_api_client/models/stream_move_to_trajectory.py +2 -2
  303. wandelbots_api_client/models/stream_stop.py +2 -2
  304. wandelbots_api_client/models/tcp_pose.py +5 -5
  305. wandelbots_api_client/models/tcp_pose_request.py +5 -5
  306. wandelbots_api_client/models/tool_geometry.py +3 -3
  307. wandelbots_api_client/models/trajectory_sample.py +12 -12
  308. wandelbots_api_client/models/trigger_object.py +11 -11
  309. wandelbots_api_client/models/trigger_type.py +1 -1
  310. wandelbots_api_client/models/universalrobots_controller.py +3 -3
  311. wandelbots_api_client/models/update_nova_version_request.py +2 -2
  312. wandelbots_api_client/models/update_program_metadata_request.py +4 -4
  313. wandelbots_api_client/models/update_recipe_metadata_request.py +4 -4
  314. wandelbots_api_client/models/update_trigger_request.py +6 -6
  315. wandelbots_api_client/models/validation_error.py +4 -4
  316. wandelbots_api_client/models/validation_error2.py +4 -4
  317. wandelbots_api_client/models/validation_error2_loc_inner.py +1 -1
  318. wandelbots_api_client/models/validation_error_loc_inner.py +1 -1
  319. wandelbots_api_client/models/value.py +1 -1
  320. wandelbots_api_client/models/vector3d.py +4 -4
  321. wandelbots_api_client/models/version_number.py +9 -9
  322. wandelbots_api_client/models/virtual_controller.py +6 -6
  323. wandelbots_api_client/models/virtual_controller_types.py +11 -1
  324. wandelbots_api_client/models/virtual_robot_configuration.py +3 -3
  325. wandelbots_api_client/models/yaskawa_controller.py +3 -3
  326. wandelbots_api_client/rest.py +3 -2
  327. wandelbots_api_client/v2/__init__.py +3 -4
  328. wandelbots_api_client/v2/api/__init__.py +2 -0
  329. wandelbots_api_client/v2/api/application_api.py +11 -12
  330. wandelbots_api_client/v2/api/bus_inputs_outputs_api.py +930 -82
  331. wandelbots_api_client/v2/api/cell_api.py +8 -9
  332. wandelbots_api_client/v2/api/controller_api.py +35 -32
  333. wandelbots_api_client/v2/api/controller_inputs_outputs_api.py +14 -13
  334. wandelbots_api_client/v2/api/jogging_api.py +8 -6
  335. wandelbots_api_client/v2/api/kinematics_api.py +14 -16
  336. wandelbots_api_client/v2/api/license_api.py +8 -9
  337. wandelbots_api_client/v2/api/motion_group_api.py +10 -9
  338. wandelbots_api_client/v2/api/motion_group_models_api.py +13 -50
  339. wandelbots_api_client/v2/api/program_api.py +2 -3
  340. wandelbots_api_client/v2/api/store_collision_components_api.py +823 -50
  341. wandelbots_api_client/v2/api/store_collision_setups_api.py +264 -7
  342. wandelbots_api_client/v2/api/store_object_api.py +11 -12
  343. wandelbots_api_client/v2/api/system_api.py +6 -6
  344. wandelbots_api_client/v2/api/trajectory_caching_api.py +14 -15
  345. wandelbots_api_client/v2/api/trajectory_execution_api.py +8 -6
  346. wandelbots_api_client/v2/api/trajectory_planning_api.py +17 -19
  347. wandelbots_api_client/v2/api/version_api.py +284 -0
  348. wandelbots_api_client/v2/api/virtual_controller_api.py +53 -39
  349. wandelbots_api_client/v2/api/virtual_controller_behavior_api.py +20 -12
  350. wandelbots_api_client/v2/api/virtual_controller_inputs_outputs_api.py +5 -6
  351. wandelbots_api_client/v2/api_client.py +15 -8
  352. wandelbots_api_client/v2/configuration.py +19 -8
  353. wandelbots_api_client/v2/exceptions.py +2 -2
  354. wandelbots_api_client/v2/models/__init__.py +50 -29
  355. wandelbots_api_client/v2/models/abb_controller.py +8 -11
  356. wandelbots_api_client/v2/models/abb_controller_egm_server.py +4 -4
  357. wandelbots_api_client/v2/models/activate_license_request.py +3 -3
  358. wandelbots_api_client/v2/models/add_trajectory_error.py +5 -5
  359. wandelbots_api_client/v2/models/add_trajectory_error_data.py +58 -58
  360. wandelbots_api_client/v2/models/add_trajectory_request.py +5 -5
  361. wandelbots_api_client/v2/models/add_trajectory_response.py +4 -4
  362. wandelbots_api_client/v2/models/api_version.py +91 -0
  363. wandelbots_api_client/v2/models/app.py +11 -11
  364. wandelbots_api_client/v2/models/behavior.py +3 -3
  365. wandelbots_api_client/v2/models/blending_auto.py +6 -5
  366. wandelbots_api_client/v2/models/blending_position.py +4 -4
  367. wandelbots_api_client/v2/models/boolean_value.py +6 -9
  368. wandelbots_api_client/v2/models/box.py +7 -7
  369. wandelbots_api_client/v2/models/{io_description2.py → bus_io_description.py} +16 -16
  370. wandelbots_api_client/v2/models/bus_io_modbus_client.py +104 -0
  371. wandelbots_api_client/v2/models/bus_io_modbus_server.py +115 -0
  372. wandelbots_api_client/v2/models/bus_io_modbus_tcp_client.py +106 -0
  373. wandelbots_api_client/v2/models/bus_io_modbus_tcp_server.py +104 -0
  374. wandelbots_api_client/v2/models/bus_io_modbus_virtual.py +98 -0
  375. wandelbots_api_client/v2/models/bus_io_profinet.py +8 -11
  376. wandelbots_api_client/v2/models/bus_io_profinet_default_route.py +4 -4
  377. wandelbots_api_client/v2/models/bus_io_profinet_ip_config.py +5 -5
  378. wandelbots_api_client/v2/models/bus_io_profinet_network.py +5 -5
  379. wandelbots_api_client/v2/models/bus_io_profinet_virtual.py +5 -8
  380. wandelbots_api_client/v2/models/bus_io_type.py +65 -18
  381. wandelbots_api_client/v2/models/bus_ios_state.py +4 -4
  382. wandelbots_api_client/v2/models/bus_ios_state_enum.py +2 -2
  383. wandelbots_api_client/v2/models/capsule.py +5 -5
  384. wandelbots_api_client/v2/models/cartesian_limits.py +6 -6
  385. wandelbots_api_client/v2/models/cell.py +7 -7
  386. wandelbots_api_client/v2/models/collider.py +5 -5
  387. wandelbots_api_client/v2/models/collider_shape.py +2 -42
  388. wandelbots_api_client/v2/models/collision.py +8 -8
  389. wandelbots_api_client/v2/models/collision_contact.py +4 -4
  390. wandelbots_api_client/v2/models/collision_error.py +3 -3
  391. wandelbots_api_client/v2/models/collision_free_algorithm.py +3 -3
  392. wandelbots_api_client/v2/models/collision_setup.py +14 -12
  393. wandelbots_api_client/v2/models/comparator.py +2 -2
  394. wandelbots_api_client/v2/models/configuration_archive_status.py +2 -17
  395. wandelbots_api_client/v2/models/configuration_archive_status_creating.py +4 -4
  396. wandelbots_api_client/v2/models/configuration_archive_status_error.py +4 -4
  397. wandelbots_api_client/v2/models/configuration_archive_status_success.py +3 -3
  398. wandelbots_api_client/v2/models/configuration_resource.py +5 -5
  399. wandelbots_api_client/v2/models/container_environment_inner.py +4 -4
  400. wandelbots_api_client/v2/models/container_image.py +5 -5
  401. wandelbots_api_client/v2/models/container_image_secrets_inner.py +3 -3
  402. wandelbots_api_client/v2/models/container_resources.py +4 -4
  403. wandelbots_api_client/v2/models/container_storage.py +4 -4
  404. wandelbots_api_client/v2/models/controller_description.py +6 -6
  405. wandelbots_api_client/v2/models/convex_hull.py +4 -4
  406. wandelbots_api_client/v2/models/coordinate_system.py +8 -8
  407. wandelbots_api_client/v2/models/coordinate_system_data.py +7 -7
  408. wandelbots_api_client/v2/models/cubic_spline_parameter.py +4 -4
  409. wandelbots_api_client/v2/models/cycle_time.py +5 -4
  410. wandelbots_api_client/v2/models/cylinder.py +5 -5
  411. wandelbots_api_client/v2/models/dh_parameter.py +7 -7
  412. wandelbots_api_client/v2/models/direction.py +2 -2
  413. wandelbots_api_client/v2/models/error.py +4 -4
  414. wandelbots_api_client/v2/models/error_invalid_joint_count.py +5 -5
  415. wandelbots_api_client/v2/models/error_joint_limit_exceeded.py +6 -5
  416. wandelbots_api_client/v2/models/error_joint_position_collision.py +6 -6
  417. wandelbots_api_client/v2/models/error_max_iterations_exceeded.py +4 -4
  418. wandelbots_api_client/v2/models/execute.py +4 -4
  419. wandelbots_api_client/v2/models/execute_details.py +2 -12
  420. wandelbots_api_client/v2/models/execute_jogging_request.py +30 -2
  421. wandelbots_api_client/v2/models/execute_jogging_response.py +7 -7
  422. wandelbots_api_client/v2/models/execute_trajectory_request.py +30 -2
  423. wandelbots_api_client/v2/models/execute_trajectory_response.py +7 -7
  424. wandelbots_api_client/v2/models/external_joint_stream_datapoint.py +4 -4
  425. wandelbots_api_client/v2/models/external_joint_stream_request.py +3 -3
  426. wandelbots_api_client/v2/models/fanuc_controller.py +6 -9
  427. wandelbots_api_client/v2/models/feedback_collision.py +6 -6
  428. wandelbots_api_client/v2/models/feedback_joint_limit_exceeded.py +7 -6
  429. wandelbots_api_client/v2/models/feedback_out_of_workspace.py +4 -4
  430. wandelbots_api_client/v2/models/feedback_singularity.py +5 -5
  431. wandelbots_api_client/v2/models/flag.py +3 -3
  432. wandelbots_api_client/v2/models/float_value.py +6 -9
  433. wandelbots_api_client/v2/models/forward_kinematics422_response.py +3 -3
  434. wandelbots_api_client/v2/models/forward_kinematics_request.py +6 -6
  435. wandelbots_api_client/v2/models/forward_kinematics_response.py +3 -3
  436. wandelbots_api_client/v2/models/forward_kinematics_validation_error.py +7 -7
  437. wandelbots_api_client/v2/models/get_trajectory_response.py +5 -5
  438. wandelbots_api_client/v2/models/http_validation_error.py +3 -3
  439. wandelbots_api_client/v2/models/image_credentials.py +5 -5
  440. wandelbots_api_client/v2/models/{inconsitent_trajectory_size.py → inconsistent_trajectory_size_error.py} +9 -9
  441. wandelbots_api_client/v2/models/{inconsitent_trajectory_size_inconsistent_trajectory_size.py → inconsistent_trajectory_size_error_inconsistent_trajectory_size.py} +9 -9
  442. wandelbots_api_client/v2/models/initialize_jogging_request.py +7 -10
  443. wandelbots_api_client/v2/models/initialize_jogging_response.py +4 -4
  444. wandelbots_api_client/v2/models/initialize_movement_request.py +7 -10
  445. wandelbots_api_client/v2/models/initialize_movement_request_trajectory.py +2 -2
  446. wandelbots_api_client/v2/models/initialize_movement_response.py +5 -5
  447. wandelbots_api_client/v2/models/integer_value.py +6 -9
  448. wandelbots_api_client/v2/models/{invalid_dof.py → invalid_dof_error.py} +9 -9
  449. wandelbots_api_client/v2/models/{invalid_dof_invalid_dof.py → invalid_dof_error_invalid_dof.py} +8 -8
  450. wandelbots_api_client/v2/models/inverse_kinematics422_response.py +3 -3
  451. wandelbots_api_client/v2/models/inverse_kinematics_request.py +12 -11
  452. wandelbots_api_client/v2/models/inverse_kinematics_response.py +3 -3
  453. wandelbots_api_client/v2/models/inverse_kinematics_validation_error.py +7 -7
  454. wandelbots_api_client/v2/models/inverse_kinematics_validation_error_all_of_data.py +2 -2
  455. wandelbots_api_client/v2/models/io_boolean_value.py +7 -10
  456. wandelbots_api_client/v2/models/{io_description_min.py → io_boundary.py} +10 -25
  457. wandelbots_api_client/v2/models/io_description.py +13 -13
  458. wandelbots_api_client/v2/models/io_direction.py +2 -2
  459. wandelbots_api_client/v2/models/io_float_value.py +7 -10
  460. wandelbots_api_client/v2/models/io_integer_value.py +7 -10
  461. wandelbots_api_client/v2/models/io_origin.py +37 -0
  462. wandelbots_api_client/v2/models/io_value.py +2 -17
  463. wandelbots_api_client/v2/models/io_value_type.py +2 -2
  464. wandelbots_api_client/v2/models/jogging_details.py +4 -4
  465. wandelbots_api_client/v2/models/jogging_details_state.py +2 -27
  466. wandelbots_api_client/v2/models/jogging_paused_by_user.py +3 -3
  467. wandelbots_api_client/v2/models/jogging_paused_near_collision.py +4 -4
  468. wandelbots_api_client/v2/models/jogging_paused_near_joint_limit.py +6 -5
  469. wandelbots_api_client/v2/models/jogging_paused_on_io.py +3 -3
  470. wandelbots_api_client/v2/models/jogging_running.py +3 -3
  471. wandelbots_api_client/v2/models/{joint_limit_exceeded.py → joint_limit_exceeded_error.py} +7 -7
  472. wandelbots_api_client/v2/models/joint_limits.py +6 -6
  473. wandelbots_api_client/v2/models/joint_trajectory.py +5 -5
  474. wandelbots_api_client/v2/models/joint_velocity_request.py +6 -9
  475. wandelbots_api_client/v2/models/joint_velocity_response.py +4 -4
  476. wandelbots_api_client/v2/models/kuka_controller.py +12 -13
  477. wandelbots_api_client/v2/models/kuka_controller_rsi_server.py +4 -4
  478. wandelbots_api_client/v2/models/license.py +12 -12
  479. wandelbots_api_client/v2/models/license_status.py +4 -4
  480. wandelbots_api_client/v2/models/license_status_enum.py +2 -2
  481. wandelbots_api_client/v2/models/limit_range.py +4 -4
  482. wandelbots_api_client/v2/models/limit_set.py +7 -7
  483. wandelbots_api_client/v2/models/limits_override.py +8 -8
  484. wandelbots_api_client/v2/models/list_trajectories_response.py +3 -3
  485. wandelbots_api_client/v2/models/manufacturer.py +2 -2
  486. wandelbots_api_client/v2/models/midpoint_insertion_algorithm.py +4 -4
  487. wandelbots_api_client/v2/models/modbus_io.py +105 -0
  488. wandelbots_api_client/v2/models/modbus_io_area.py +40 -0
  489. wandelbots_api_client/v2/models/modbus_io_byte_order.py +40 -0
  490. wandelbots_api_client/v2/models/{http_validation_error2.py → modbus_io_data.py} +23 -28
  491. wandelbots_api_client/v2/models/modbus_io_type_enum.py +39 -0
  492. wandelbots_api_client/v2/models/motion_command.py +5 -5
  493. wandelbots_api_client/v2/models/motion_command_blending.py +2 -2
  494. wandelbots_api_client/v2/models/motion_command_path.py +2 -2
  495. wandelbots_api_client/v2/models/motion_group_description.py +30 -25
  496. wandelbots_api_client/v2/models/motion_group_info.py +7 -6
  497. wandelbots_api_client/v2/models/motion_group_joints.py +6 -6
  498. wandelbots_api_client/v2/models/motion_group_setup.py +15 -13
  499. wandelbots_api_client/v2/models/motion_group_state.py +18 -17
  500. wandelbots_api_client/v2/models/motion_group_state_joint_limit_reached.py +3 -3
  501. wandelbots_api_client/v2/models/movement_error_response.py +4 -4
  502. wandelbots_api_client/v2/models/{nan_value.py → nan_value_error.py} +9 -9
  503. wandelbots_api_client/v2/models/{nan_value_nan_value.py → nan_value_error_nan_value.py} +6 -6
  504. wandelbots_api_client/v2/models/op_mode.py +3 -3
  505. wandelbots_api_client/v2/models/operating_state.py +2 -2
  506. wandelbots_api_client/v2/models/operation_limits.py +6 -6
  507. wandelbots_api_client/v2/models/operation_mode.py +2 -2
  508. wandelbots_api_client/v2/models/orientation_type.py +2 -2
  509. wandelbots_api_client/v2/models/path_cartesian_ptp.py +4 -4
  510. wandelbots_api_client/v2/models/path_circle.py +5 -5
  511. wandelbots_api_client/v2/models/path_cubic_spline.py +4 -4
  512. wandelbots_api_client/v2/models/path_joint_ptp.py +4 -4
  513. wandelbots_api_client/v2/models/path_line.py +4 -4
  514. wandelbots_api_client/v2/models/pause_jogging_request.py +5 -8
  515. wandelbots_api_client/v2/models/pause_jogging_response.py +4 -4
  516. wandelbots_api_client/v2/models/pause_movement_request.py +5 -8
  517. wandelbots_api_client/v2/models/pause_movement_response.py +4 -4
  518. wandelbots_api_client/v2/models/pause_on_io.py +9 -6
  519. wandelbots_api_client/v2/models/payload.py +6 -6
  520. wandelbots_api_client/v2/models/plan422_response.py +3 -3
  521. wandelbots_api_client/v2/models/plan_collision_free_failed_response.py +3 -3
  522. wandelbots_api_client/v2/models/plan_collision_free_request.py +6 -6
  523. wandelbots_api_client/v2/models/plan_collision_free_response.py +3 -3
  524. wandelbots_api_client/v2/models/plan_collision_free_response_response.py +2 -2
  525. wandelbots_api_client/v2/models/plan_trajectory_failed_response.py +5 -5
  526. wandelbots_api_client/v2/models/plan_trajectory_failed_response_error_feedback.py +2 -2
  527. wandelbots_api_client/v2/models/plan_trajectory_request.py +5 -5
  528. wandelbots_api_client/v2/models/plan_trajectory_response.py +3 -3
  529. wandelbots_api_client/v2/models/plan_trajectory_response_response.py +2 -2
  530. wandelbots_api_client/v2/models/plan_validation_error.py +7 -7
  531. wandelbots_api_client/v2/models/plan_validation_error_all_of_data.py +2 -2
  532. wandelbots_api_client/v2/models/plane.py +3 -3
  533. wandelbots_api_client/v2/models/playback_speed_request.py +8 -10
  534. wandelbots_api_client/v2/models/playback_speed_response.py +4 -4
  535. wandelbots_api_client/v2/models/pose.py +4 -4
  536. wandelbots_api_client/v2/models/profinet_description.py +7 -7
  537. wandelbots_api_client/v2/models/profinet_input_output_config.py +5 -5
  538. wandelbots_api_client/v2/models/profinet_io.py +10 -10
  539. wandelbots_api_client/v2/models/profinet_io_data.py +9 -9
  540. wandelbots_api_client/v2/models/profinet_io_direction.py +3 -3
  541. wandelbots_api_client/v2/models/profinet_io_type_enum.py +2 -2
  542. wandelbots_api_client/v2/models/profinet_slot_description.py +6 -6
  543. wandelbots_api_client/v2/models/profinet_sub_slot_description.py +5 -5
  544. wandelbots_api_client/v2/models/program.py +8 -8
  545. wandelbots_api_client/v2/models/program_run.py +16 -14
  546. wandelbots_api_client/v2/models/program_run_state.py +2 -2
  547. wandelbots_api_client/v2/models/program_start_request.py +3 -3
  548. wandelbots_api_client/v2/models/rectangle.py +5 -5
  549. wandelbots_api_client/v2/models/rectangular_capsule.py +6 -6
  550. wandelbots_api_client/v2/models/release_channel.py +2 -2
  551. wandelbots_api_client/v2/models/robot_controller.py +4 -4
  552. wandelbots_api_client/v2/models/robot_controller_configuration.py +2 -2
  553. wandelbots_api_client/v2/models/robot_controller_state.py +13 -12
  554. wandelbots_api_client/v2/models/robot_system_mode.py +2 -2
  555. wandelbots_api_client/v2/models/robot_tcp.py +7 -7
  556. wandelbots_api_client/v2/models/robot_tcp_data.py +6 -6
  557. wandelbots_api_client/v2/models/rrt_connect_algorithm.py +8 -8
  558. wandelbots_api_client/v2/models/safety_state_type.py +2 -2
  559. wandelbots_api_client/v2/models/service_group.py +2 -2
  560. wandelbots_api_client/v2/models/service_status.py +5 -5
  561. wandelbots_api_client/v2/models/service_status_phase.py +2 -2
  562. wandelbots_api_client/v2/models/service_status_response.py +4 -4
  563. wandelbots_api_client/v2/models/service_status_severity.py +2 -2
  564. wandelbots_api_client/v2/models/service_status_status.py +5 -5
  565. wandelbots_api_client/v2/models/set_io.py +9 -6
  566. wandelbots_api_client/v2/models/settable_robot_system_mode.py +2 -2
  567. wandelbots_api_client/v2/models/singularity_type_enum.py +2 -2
  568. wandelbots_api_client/v2/models/sphere.py +4 -4
  569. wandelbots_api_client/v2/models/start_movement_request.py +13 -14
  570. wandelbots_api_client/v2/models/start_movement_response.py +4 -4
  571. wandelbots_api_client/v2/models/start_on_io.py +9 -6
  572. wandelbots_api_client/v2/models/stream_io_values_response.py +7 -6
  573. wandelbots_api_client/v2/models/tcp_offset.py +4 -4
  574. wandelbots_api_client/v2/models/{tcp_required.py → tcp_required_error.py} +6 -6
  575. wandelbots_api_client/v2/models/tcp_velocity_request.py +7 -10
  576. wandelbots_api_client/v2/models/tcp_velocity_response.py +4 -4
  577. wandelbots_api_client/v2/models/{torque_exceeded.py → torque_exceeded_error.py} +9 -9
  578. wandelbots_api_client/v2/models/{torque_exceeded_torque_exceeded.py → torque_exceeded_error_torque_exceeded.py} +8 -8
  579. wandelbots_api_client/v2/models/trajectory_data.py +7 -7
  580. wandelbots_api_client/v2/models/trajectory_details.py +6 -6
  581. wandelbots_api_client/v2/models/trajectory_details_state.py +2 -27
  582. wandelbots_api_client/v2/models/trajectory_ended.py +3 -3
  583. wandelbots_api_client/v2/models/trajectory_id.py +5 -5
  584. wandelbots_api_client/v2/models/trajectory_paused_by_user.py +3 -3
  585. wandelbots_api_client/v2/models/trajectory_paused_on_io.py +3 -3
  586. wandelbots_api_client/v2/models/trajectory_running.py +6 -5
  587. wandelbots_api_client/v2/models/trajectory_wait_for_io.py +3 -3
  588. wandelbots_api_client/v2/models/unit_type.py +2 -2
  589. wandelbots_api_client/v2/models/universalrobots_controller.py +6 -9
  590. wandelbots_api_client/v2/models/update_nova_version_request.py +3 -3
  591. wandelbots_api_client/v2/models/validation_error.py +6 -6
  592. wandelbots_api_client/v2/models/validation_error2.py +5 -5
  593. wandelbots_api_client/v2/models/validation_error_loc_inner.py +2 -2
  594. wandelbots_api_client/v2/models/virtual_controller.py +8 -11
  595. wandelbots_api_client/v2/models/virtual_controller_types.py +12 -2
  596. wandelbots_api_client/v2/models/virtual_robot_configuration.py +4 -4
  597. wandelbots_api_client/v2/models/wait_for_io_event_request.py +4 -4
  598. wandelbots_api_client/v2/models/yaskawa_controller.py +6 -9
  599. wandelbots_api_client/v2/rest.py +4 -3
  600. wandelbots_api_client/v2_pydantic/__init__.py +50 -0
  601. wandelbots_api_client/v2_pydantic/api/__init__.py +51 -0
  602. wandelbots_api_client/v2_pydantic/api/application_api.py +1803 -0
  603. wandelbots_api_client/v2_pydantic/api/bus_inputs_outputs_api.py +4603 -0
  604. wandelbots_api_client/v2_pydantic/api/cell_api.py +2003 -0
  605. wandelbots_api_client/v2_pydantic/api/controller_api.py +3721 -0
  606. wandelbots_api_client/v2_pydantic/api/controller_inputs_outputs_api.py +1395 -0
  607. wandelbots_api_client/v2_pydantic/api/jogging_api.py +125 -0
  608. wandelbots_api_client/v2_pydantic/api/kinematics_api.py +642 -0
  609. wandelbots_api_client/v2_pydantic/api/license_api.py +1061 -0
  610. wandelbots_api_client/v2_pydantic/api/motion_group_api.py +733 -0
  611. wandelbots_api_client/v2_pydantic/api/motion_group_models_api.py +563 -0
  612. wandelbots_api_client/v2_pydantic/api/program_api.py +1187 -0
  613. wandelbots_api_client/v2_pydantic/api/store_collision_components_api.py +4170 -0
  614. wandelbots_api_client/v2_pydantic/api/store_collision_setups_api.py +1419 -0
  615. wandelbots_api_client/v2_pydantic/api/store_object_api.py +1719 -0
  616. wandelbots_api_client/v2_pydantic/api/system_api.py +2427 -0
  617. wandelbots_api_client/v2_pydantic/api/trajectory_caching_api.py +1508 -0
  618. wandelbots_api_client/v2_pydantic/api/trajectory_execution_api.py +125 -0
  619. wandelbots_api_client/v2_pydantic/api/trajectory_planning_api.py +642 -0
  620. wandelbots_api_client/v2_pydantic/api/version_api.py +287 -0
  621. wandelbots_api_client/v2_pydantic/api/virtual_controller_api.py +4610 -0
  622. wandelbots_api_client/v2_pydantic/api/virtual_controller_behavior_api.py +991 -0
  623. wandelbots_api_client/v2_pydantic/api/virtual_controller_inputs_outputs_api.py +1012 -0
  624. wandelbots_api_client/v2_pydantic/api_client.py +809 -0
  625. wandelbots_api_client/v2_pydantic/api_response.py +21 -0
  626. wandelbots_api_client/v2_pydantic/configuration.py +606 -0
  627. wandelbots_api_client/v2_pydantic/exceptions.py +216 -0
  628. wandelbots_api_client/v2_pydantic/models.py +4561 -0
  629. wandelbots_api_client/v2_pydantic/py.typed +0 -0
  630. wandelbots_api_client/v2_pydantic/rest.py +213 -0
  631. {wandelbots_api_client-25.8.0.dev77.dist-info → wandelbots_api_client-25.11.0.dev12.dist-info}/METADATA +17 -16
  632. wandelbots_api_client-25.11.0.dev12.dist-info/RECORD +640 -0
  633. wandelbots_api_client/models/create_trigger_request_config.py +0 -123
  634. wandelbots_api_client-25.8.0.dev77.dist-info/RECORD +0 -596
  635. {wandelbots_api_client-25.8.0.dev77.dist-info → wandelbots_api_client-25.11.0.dev12.dist-info}/WHEEL +0 -0
  636. {wandelbots_api_client-25.8.0.dev77.dist-info → wandelbots_api_client-25.11.0.dev12.dist-info}/licenses/LICENSE +0 -0
  637. {wandelbots_api_client-25.8.0.dev77.dist-info → wandelbots_api_client-25.11.0.dev12.dist-info}/top_level.txt +0 -0
@@ -0,0 +1,4603 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ Wandelbots NOVA API
5
+
6
+ Interact with robots in an easy and intuitive way.
7
+
8
+ The version of the OpenAPI document: 2.1.0 dev
9
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
10
+
11
+ Do not edit the class manually.
12
+ """ # noqa: E501
13
+
14
+ from furl import furl
15
+ import json
16
+ import humps
17
+ import re
18
+ import warnings
19
+ import websockets
20
+ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
21
+ from typing import Any, AsyncGenerator, Callable, Dict, List, Optional, Tuple, Union
22
+ from typing_extensions import Annotated
23
+ from urllib.parse import quote
24
+
25
+ from pydantic import Field, StrictStr
26
+ from typing import List, Optional
27
+ from typing_extensions import Annotated
28
+ from wandelbots_api_client.v2_pydantic.models import BusIODescription
29
+ from wandelbots_api_client.v2_pydantic.models import BusIOType
30
+ from wandelbots_api_client.v2_pydantic.models import BusIOsState
31
+ from wandelbots_api_client.v2_pydantic.models import IOValue
32
+ from wandelbots_api_client.v2_pydantic.models import ModbusIO
33
+ from wandelbots_api_client.v2_pydantic.models import ModbusIOData
34
+ from wandelbots_api_client.v2_pydantic.models import ProfinetDescription
35
+ from wandelbots_api_client.v2_pydantic.models import ProfinetIO
36
+ from wandelbots_api_client.v2_pydantic.models import ProfinetIOData
37
+ from wandelbots_api_client.v2_pydantic.models import ProfinetInputOutputConfig
38
+
39
+ from wandelbots_api_client.v2_pydantic.api_client import ApiClient, RequestSerialized
40
+ from wandelbots_api_client.v2_pydantic.api_response import ApiResponse
41
+ from wandelbots_api_client.v2_pydantic.rest import RESTResponseType
42
+
43
+ class BUSInputsOutputsApi:
44
+ """NOTE: This class is auto generated by OpenAPI Generator
45
+ Ref: https://openapi-generator.tech
46
+
47
+ Do not edit the class manually.
48
+ """
49
+
50
+ def __init__(self, api_client=None) -> None:
51
+ if api_client is None:
52
+ api_client = ApiClient.get_default()
53
+ self.api_client = api_client
54
+
55
+ @validate_call
56
+ async def add_bus_io_service(
57
+ self,
58
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
59
+ bus_io_type: BusIOType,
60
+ completion_timeout: Optional[Annotated[int, Field(strict=True, ge=1)]] = None,
61
+ _request_timeout: Union[
62
+ None,
63
+ Annotated[StrictFloat, Field(gt=0)],
64
+ Tuple[
65
+ Annotated[StrictFloat, Field(gt=0)],
66
+ Annotated[StrictFloat, Field(gt=0)]
67
+ ]
68
+ ] = None,
69
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
70
+ _content_type: Optional[StrictStr] = None,
71
+ _headers: Optional[Dict[StrictStr, Any]] = None,
72
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
73
+ ) -> None:
74
+ """Add Service
75
+
76
+ Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
77
+
78
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
79
+ :type cell: str
80
+ :param bus_io_type: (required)
81
+ :type bus_io_type: BusIOType
82
+ :param completion_timeout:
83
+ :type completion_timeout: int
84
+ :param _request_timeout: timeout setting for this request. If one
85
+ number provided, it will be total request
86
+ timeout. It can also be a pair (tuple) of
87
+ (connection, read) timeouts.
88
+ :type _request_timeout: int, tuple(int, int), optional
89
+ :param _request_auth: set to override the auth_settings for an a single
90
+ request; this effectively ignores the
91
+ authentication in the spec for a single request.
92
+ :type _request_auth: dict, optional
93
+ :param _content_type: force content-type for the request.
94
+ :type _content_type: str, Optional
95
+ :param _headers: set to override the headers for a single
96
+ request; this effectively ignores the headers
97
+ in the spec for a single request.
98
+ :type _headers: dict, optional
99
+ :param _host_index: set to override the host_index for a single
100
+ request; this effectively ignores the host_index
101
+ in the spec for a single request.
102
+ :type _host_index: int, optional
103
+ :return: Returns the result object.
104
+ """ # noqa: E501
105
+
106
+ _param = self._add_bus_io_service_serialize(
107
+ cell=cell,
108
+ bus_io_type=bus_io_type,
109
+ completion_timeout=completion_timeout,
110
+ _request_auth=_request_auth,
111
+ _content_type=_content_type,
112
+ _headers=_headers,
113
+ _host_index=_host_index
114
+ )
115
+
116
+ _response_types_map: Dict[str, Optional[str]] = {
117
+ '200': None,
118
+ '202': None,
119
+ '403': "Error",
120
+ '404': "Error",
121
+ '409': None,
122
+ }
123
+
124
+ response_data = await self.api_client.call_api(
125
+ *_param,
126
+ _request_timeout=_request_timeout
127
+ )
128
+ await response_data.read()
129
+ return self.api_client.response_deserialize(
130
+ response_data=response_data,
131
+ response_types_map=_response_types_map,
132
+ ).data
133
+
134
+
135
+ @validate_call
136
+ async def add_bus_io_service_with_http_info(
137
+ self,
138
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
139
+ bus_io_type: BusIOType,
140
+ completion_timeout: Optional[Annotated[int, Field(strict=True, ge=1)]] = None,
141
+ _request_timeout: Union[
142
+ None,
143
+ Annotated[StrictFloat, Field(gt=0)],
144
+ Tuple[
145
+ Annotated[StrictFloat, Field(gt=0)],
146
+ Annotated[StrictFloat, Field(gt=0)]
147
+ ]
148
+ ] = None,
149
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
150
+ _content_type: Optional[StrictStr] = None,
151
+ _headers: Optional[Dict[StrictStr, Any]] = None,
152
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
153
+ ) -> ApiResponse[None]:
154
+ """Add Service
155
+
156
+ Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
157
+
158
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
159
+ :type cell: str
160
+ :param bus_io_type: (required)
161
+ :type bus_io_type: BusIOType
162
+ :param completion_timeout:
163
+ :type completion_timeout: int
164
+ :param _request_timeout: timeout setting for this request. If one
165
+ number provided, it will be total request
166
+ timeout. It can also be a pair (tuple) of
167
+ (connection, read) timeouts.
168
+ :type _request_timeout: int, tuple(int, int), optional
169
+ :param _request_auth: set to override the auth_settings for an a single
170
+ request; this effectively ignores the
171
+ authentication in the spec for a single request.
172
+ :type _request_auth: dict, optional
173
+ :param _content_type: force content-type for the request.
174
+ :type _content_type: str, Optional
175
+ :param _headers: set to override the headers for a single
176
+ request; this effectively ignores the headers
177
+ in the spec for a single request.
178
+ :type _headers: dict, optional
179
+ :param _host_index: set to override the host_index for a single
180
+ request; this effectively ignores the host_index
181
+ in the spec for a single request.
182
+ :type _host_index: int, optional
183
+ :return: Returns the result object.
184
+ """ # noqa: E501
185
+
186
+ _param = self._add_bus_io_service_serialize(
187
+ cell=cell,
188
+ bus_io_type=bus_io_type,
189
+ completion_timeout=completion_timeout,
190
+ _request_auth=_request_auth,
191
+ _content_type=_content_type,
192
+ _headers=_headers,
193
+ _host_index=_host_index
194
+ )
195
+
196
+ _response_types_map: Dict[str, Optional[str]] = {
197
+ '200': None,
198
+ '202': None,
199
+ '403': "Error",
200
+ '404': "Error",
201
+ '409': None,
202
+ }
203
+
204
+ response_data = await self.api_client.call_api(
205
+ *_param,
206
+ _request_timeout=_request_timeout
207
+ )
208
+ await response_data.read()
209
+ return self.api_client.response_deserialize(
210
+ response_data=response_data,
211
+ response_types_map=_response_types_map,
212
+ )
213
+
214
+
215
+ @validate_call
216
+ async def add_bus_io_service_without_preload_content(
217
+ self,
218
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
219
+ bus_io_type: BusIOType,
220
+ completion_timeout: Optional[Annotated[int, Field(strict=True, ge=1)]] = None,
221
+ _request_timeout: Union[
222
+ None,
223
+ Annotated[StrictFloat, Field(gt=0)],
224
+ Tuple[
225
+ Annotated[StrictFloat, Field(gt=0)],
226
+ Annotated[StrictFloat, Field(gt=0)]
227
+ ]
228
+ ] = None,
229
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
230
+ _content_type: Optional[StrictStr] = None,
231
+ _headers: Optional[Dict[StrictStr, Any]] = None,
232
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
233
+ ) -> RESTResponseType:
234
+ """Add Service
235
+
236
+ Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
237
+
238
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
239
+ :type cell: str
240
+ :param bus_io_type: (required)
241
+ :type bus_io_type: BusIOType
242
+ :param completion_timeout:
243
+ :type completion_timeout: int
244
+ :param _request_timeout: timeout setting for this request. If one
245
+ number provided, it will be total request
246
+ timeout. It can also be a pair (tuple) of
247
+ (connection, read) timeouts.
248
+ :type _request_timeout: int, tuple(int, int), optional
249
+ :param _request_auth: set to override the auth_settings for an a single
250
+ request; this effectively ignores the
251
+ authentication in the spec for a single request.
252
+ :type _request_auth: dict, optional
253
+ :param _content_type: force content-type for the request.
254
+ :type _content_type: str, Optional
255
+ :param _headers: set to override the headers for a single
256
+ request; this effectively ignores the headers
257
+ in the spec for a single request.
258
+ :type _headers: dict, optional
259
+ :param _host_index: set to override the host_index for a single
260
+ request; this effectively ignores the host_index
261
+ in the spec for a single request.
262
+ :type _host_index: int, optional
263
+ :return: Returns the result object.
264
+ """ # noqa: E501
265
+
266
+ _param = self._add_bus_io_service_serialize(
267
+ cell=cell,
268
+ bus_io_type=bus_io_type,
269
+ completion_timeout=completion_timeout,
270
+ _request_auth=_request_auth,
271
+ _content_type=_content_type,
272
+ _headers=_headers,
273
+ _host_index=_host_index
274
+ )
275
+
276
+ _response_types_map: Dict[str, Optional[str]] = {
277
+ '200': None,
278
+ '202': None,
279
+ '403': "Error",
280
+ '404': "Error",
281
+ '409': None,
282
+ }
283
+
284
+ response_data = await self.api_client.call_api(
285
+ *_param,
286
+ _request_timeout=_request_timeout
287
+ )
288
+ return response_data.response
289
+
290
+
291
+ def _add_bus_io_service_serialize(
292
+ self,
293
+ cell,
294
+ bus_io_type,
295
+ completion_timeout,
296
+ _request_auth,
297
+ _content_type,
298
+ _headers,
299
+ _host_index,
300
+ ) -> RequestSerialized:
301
+
302
+ _host = None
303
+
304
+ _collection_formats: Dict[str, str] = {
305
+ }
306
+
307
+ _path_params: Dict[str, str] = {}
308
+ _query_params: List[Tuple[str, str]] = []
309
+ _header_params: Dict[str, Optional[str]] = _headers or {}
310
+ _form_params: List[Tuple[str, str]] = []
311
+ _files: Dict[str, Union[str, bytes]] = {}
312
+ _body_params: Optional[bytes] = None
313
+
314
+ # process the path parameters
315
+ if cell is not None:
316
+ _path_params['cell'] = cell
317
+ # process the query parameters
318
+ if completion_timeout is not None:
319
+
320
+ _query_params.append(('completion_timeout', completion_timeout))
321
+
322
+ # process the header parameters
323
+ # process the form parameters
324
+ # process the body parameter
325
+ if bus_io_type is not None:
326
+ _body_params = bus_io_type
327
+
328
+
329
+ # set the HTTP header `Accept`
330
+ _header_params['Accept'] = self.api_client.select_header_accept(
331
+ [
332
+ 'application/json'
333
+ ]
334
+ )
335
+
336
+ # set the HTTP header `Content-Type`
337
+ if _content_type:
338
+ _header_params['Content-Type'] = _content_type
339
+ else:
340
+ _default_content_type = (
341
+ self.api_client.select_header_content_type(
342
+ [
343
+ 'application/json'
344
+ ]
345
+ )
346
+ )
347
+ if _default_content_type is not None:
348
+ _header_params['Content-Type'] = _default_content_type
349
+
350
+ # authentication setting
351
+ _auth_settings: List[str] = [
352
+ 'BasicAuth',
353
+ 'BearerAuth'
354
+ ]
355
+
356
+ return self.api_client.param_serialize(
357
+ method='POST',
358
+ resource_path='/cells/{cell}/bus-ios',
359
+ path_params=_path_params,
360
+ query_params=_query_params,
361
+ header_params=_header_params,
362
+ body=_body_params,
363
+ post_params=_form_params,
364
+ files=_files,
365
+ auth_settings=_auth_settings,
366
+ collection_formats=_collection_formats,
367
+ _host=_host,
368
+ _request_auth=_request_auth
369
+ )
370
+
371
+
372
+
373
+ @validate_call
374
+ async def add_modbus_io(
375
+ self,
376
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
377
+ io: Annotated[StrictStr, Field(description="Unique identifier to address an Input/Output in the cell.")],
378
+ modbus_io_data: ModbusIOData,
379
+ _request_timeout: Union[
380
+ None,
381
+ Annotated[StrictFloat, Field(gt=0)],
382
+ Tuple[
383
+ Annotated[StrictFloat, Field(gt=0)],
384
+ Annotated[StrictFloat, Field(gt=0)]
385
+ ]
386
+ ] = None,
387
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
388
+ _content_type: Optional[StrictStr] = None,
389
+ _headers: Optional[Dict[StrictStr, Any]] = None,
390
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
391
+ ) -> None:
392
+ """Add MODBUS Input/Output
393
+
394
+ Adds an input/output variable to or updates an input/output variable on the MODBUS device, e.g., NOVA's MODBUS service. The inputs/outputs map variables to specific memory addresses in the process image. The NOVA's MODBUS service's configuration can be viewed via [listModbusIOs](listModbusIOs).
395
+
396
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
397
+ :type cell: str
398
+ :param io: Unique identifier to address an Input/Output in the cell. (required)
399
+ :type io: str
400
+ :param modbus_io_data: (required)
401
+ :type modbus_io_data: ModbusIOData
402
+ :param _request_timeout: timeout setting for this request. If one
403
+ number provided, it will be total request
404
+ timeout. It can also be a pair (tuple) of
405
+ (connection, read) timeouts.
406
+ :type _request_timeout: int, tuple(int, int), optional
407
+ :param _request_auth: set to override the auth_settings for an a single
408
+ request; this effectively ignores the
409
+ authentication in the spec for a single request.
410
+ :type _request_auth: dict, optional
411
+ :param _content_type: force content-type for the request.
412
+ :type _content_type: str, Optional
413
+ :param _headers: set to override the headers for a single
414
+ request; this effectively ignores the headers
415
+ in the spec for a single request.
416
+ :type _headers: dict, optional
417
+ :param _host_index: set to override the host_index for a single
418
+ request; this effectively ignores the host_index
419
+ in the spec for a single request.
420
+ :type _host_index: int, optional
421
+ :return: Returns the result object.
422
+ """ # noqa: E501
423
+
424
+ _param = self._add_modbus_io_serialize(
425
+ cell=cell,
426
+ io=io,
427
+ modbus_io_data=modbus_io_data,
428
+ _request_auth=_request_auth,
429
+ _content_type=_content_type,
430
+ _headers=_headers,
431
+ _host_index=_host_index
432
+ )
433
+
434
+ _response_types_map: Dict[str, Optional[str]] = {
435
+ '200': None,
436
+ '400': "Error",
437
+ '404': "Error",
438
+ }
439
+
440
+ response_data = await self.api_client.call_api(
441
+ *_param,
442
+ _request_timeout=_request_timeout
443
+ )
444
+ await response_data.read()
445
+ return self.api_client.response_deserialize(
446
+ response_data=response_data,
447
+ response_types_map=_response_types_map,
448
+ ).data
449
+
450
+
451
+ @validate_call
452
+ async def add_modbus_io_with_http_info(
453
+ self,
454
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
455
+ io: Annotated[StrictStr, Field(description="Unique identifier to address an Input/Output in the cell.")],
456
+ modbus_io_data: ModbusIOData,
457
+ _request_timeout: Union[
458
+ None,
459
+ Annotated[StrictFloat, Field(gt=0)],
460
+ Tuple[
461
+ Annotated[StrictFloat, Field(gt=0)],
462
+ Annotated[StrictFloat, Field(gt=0)]
463
+ ]
464
+ ] = None,
465
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
466
+ _content_type: Optional[StrictStr] = None,
467
+ _headers: Optional[Dict[StrictStr, Any]] = None,
468
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
469
+ ) -> ApiResponse[None]:
470
+ """Add MODBUS Input/Output
471
+
472
+ Adds an input/output variable to or updates an input/output variable on the MODBUS device, e.g., NOVA's MODBUS service. The inputs/outputs map variables to specific memory addresses in the process image. The NOVA's MODBUS service's configuration can be viewed via [listModbusIOs](listModbusIOs).
473
+
474
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
475
+ :type cell: str
476
+ :param io: Unique identifier to address an Input/Output in the cell. (required)
477
+ :type io: str
478
+ :param modbus_io_data: (required)
479
+ :type modbus_io_data: ModbusIOData
480
+ :param _request_timeout: timeout setting for this request. If one
481
+ number provided, it will be total request
482
+ timeout. It can also be a pair (tuple) of
483
+ (connection, read) timeouts.
484
+ :type _request_timeout: int, tuple(int, int), optional
485
+ :param _request_auth: set to override the auth_settings for an a single
486
+ request; this effectively ignores the
487
+ authentication in the spec for a single request.
488
+ :type _request_auth: dict, optional
489
+ :param _content_type: force content-type for the request.
490
+ :type _content_type: str, Optional
491
+ :param _headers: set to override the headers for a single
492
+ request; this effectively ignores the headers
493
+ in the spec for a single request.
494
+ :type _headers: dict, optional
495
+ :param _host_index: set to override the host_index for a single
496
+ request; this effectively ignores the host_index
497
+ in the spec for a single request.
498
+ :type _host_index: int, optional
499
+ :return: Returns the result object.
500
+ """ # noqa: E501
501
+
502
+ _param = self._add_modbus_io_serialize(
503
+ cell=cell,
504
+ io=io,
505
+ modbus_io_data=modbus_io_data,
506
+ _request_auth=_request_auth,
507
+ _content_type=_content_type,
508
+ _headers=_headers,
509
+ _host_index=_host_index
510
+ )
511
+
512
+ _response_types_map: Dict[str, Optional[str]] = {
513
+ '200': None,
514
+ '400': "Error",
515
+ '404': "Error",
516
+ }
517
+
518
+ response_data = await self.api_client.call_api(
519
+ *_param,
520
+ _request_timeout=_request_timeout
521
+ )
522
+ await response_data.read()
523
+ return self.api_client.response_deserialize(
524
+ response_data=response_data,
525
+ response_types_map=_response_types_map,
526
+ )
527
+
528
+
529
+ @validate_call
530
+ async def add_modbus_io_without_preload_content(
531
+ self,
532
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
533
+ io: Annotated[StrictStr, Field(description="Unique identifier to address an Input/Output in the cell.")],
534
+ modbus_io_data: ModbusIOData,
535
+ _request_timeout: Union[
536
+ None,
537
+ Annotated[StrictFloat, Field(gt=0)],
538
+ Tuple[
539
+ Annotated[StrictFloat, Field(gt=0)],
540
+ Annotated[StrictFloat, Field(gt=0)]
541
+ ]
542
+ ] = None,
543
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
544
+ _content_type: Optional[StrictStr] = None,
545
+ _headers: Optional[Dict[StrictStr, Any]] = None,
546
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
547
+ ) -> RESTResponseType:
548
+ """Add MODBUS Input/Output
549
+
550
+ Adds an input/output variable to or updates an input/output variable on the MODBUS device, e.g., NOVA's MODBUS service. The inputs/outputs map variables to specific memory addresses in the process image. The NOVA's MODBUS service's configuration can be viewed via [listModbusIOs](listModbusIOs).
551
+
552
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
553
+ :type cell: str
554
+ :param io: Unique identifier to address an Input/Output in the cell. (required)
555
+ :type io: str
556
+ :param modbus_io_data: (required)
557
+ :type modbus_io_data: ModbusIOData
558
+ :param _request_timeout: timeout setting for this request. If one
559
+ number provided, it will be total request
560
+ timeout. It can also be a pair (tuple) of
561
+ (connection, read) timeouts.
562
+ :type _request_timeout: int, tuple(int, int), optional
563
+ :param _request_auth: set to override the auth_settings for an a single
564
+ request; this effectively ignores the
565
+ authentication in the spec for a single request.
566
+ :type _request_auth: dict, optional
567
+ :param _content_type: force content-type for the request.
568
+ :type _content_type: str, Optional
569
+ :param _headers: set to override the headers for a single
570
+ request; this effectively ignores the headers
571
+ in the spec for a single request.
572
+ :type _headers: dict, optional
573
+ :param _host_index: set to override the host_index for a single
574
+ request; this effectively ignores the host_index
575
+ in the spec for a single request.
576
+ :type _host_index: int, optional
577
+ :return: Returns the result object.
578
+ """ # noqa: E501
579
+
580
+ _param = self._add_modbus_io_serialize(
581
+ cell=cell,
582
+ io=io,
583
+ modbus_io_data=modbus_io_data,
584
+ _request_auth=_request_auth,
585
+ _content_type=_content_type,
586
+ _headers=_headers,
587
+ _host_index=_host_index
588
+ )
589
+
590
+ _response_types_map: Dict[str, Optional[str]] = {
591
+ '200': None,
592
+ '400': "Error",
593
+ '404': "Error",
594
+ }
595
+
596
+ response_data = await self.api_client.call_api(
597
+ *_param,
598
+ _request_timeout=_request_timeout
599
+ )
600
+ return response_data.response
601
+
602
+
603
+ def _add_modbus_io_serialize(
604
+ self,
605
+ cell,
606
+ io,
607
+ modbus_io_data,
608
+ _request_auth,
609
+ _content_type,
610
+ _headers,
611
+ _host_index,
612
+ ) -> RequestSerialized:
613
+
614
+ _host = None
615
+
616
+ _collection_formats: Dict[str, str] = {
617
+ }
618
+
619
+ _path_params: Dict[str, str] = {}
620
+ _query_params: List[Tuple[str, str]] = []
621
+ _header_params: Dict[str, Optional[str]] = _headers or {}
622
+ _form_params: List[Tuple[str, str]] = []
623
+ _files: Dict[str, Union[str, bytes]] = {}
624
+ _body_params: Optional[bytes] = None
625
+
626
+ # process the path parameters
627
+ if cell is not None:
628
+ _path_params['cell'] = cell
629
+ if io is not None:
630
+ _path_params['io'] = io
631
+ # process the query parameters
632
+ # process the header parameters
633
+ # process the form parameters
634
+ # process the body parameter
635
+ if modbus_io_data is not None:
636
+ _body_params = modbus_io_data
637
+
638
+
639
+ # set the HTTP header `Accept`
640
+ _header_params['Accept'] = self.api_client.select_header_accept(
641
+ [
642
+ 'application/json'
643
+ ]
644
+ )
645
+
646
+ # set the HTTP header `Content-Type`
647
+ if _content_type:
648
+ _header_params['Content-Type'] = _content_type
649
+ else:
650
+ _default_content_type = (
651
+ self.api_client.select_header_content_type(
652
+ [
653
+ 'application/json'
654
+ ]
655
+ )
656
+ )
657
+ if _default_content_type is not None:
658
+ _header_params['Content-Type'] = _default_content_type
659
+
660
+ # authentication setting
661
+ _auth_settings: List[str] = [
662
+ 'BasicAuth',
663
+ 'BearerAuth'
664
+ ]
665
+
666
+ return self.api_client.param_serialize(
667
+ method='PUT',
668
+ resource_path='/cells/{cell}/bus-ios/modbus/ios/{io}',
669
+ path_params=_path_params,
670
+ query_params=_query_params,
671
+ header_params=_header_params,
672
+ body=_body_params,
673
+ post_params=_form_params,
674
+ files=_files,
675
+ auth_settings=_auth_settings,
676
+ collection_formats=_collection_formats,
677
+ _host=_host,
678
+ _request_auth=_request_auth
679
+ )
680
+
681
+
682
+
683
+ @validate_call
684
+ async def add_profinet_io(
685
+ self,
686
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
687
+ io: Annotated[StrictStr, Field(description="Unique identifier to address an Input/Output in the cell.")],
688
+ profinet_io_data: ProfinetIOData,
689
+ _request_timeout: Union[
690
+ None,
691
+ Annotated[StrictFloat, Field(gt=0)],
692
+ Tuple[
693
+ Annotated[StrictFloat, Field(gt=0)],
694
+ Annotated[StrictFloat, Field(gt=0)]
695
+ ]
696
+ ] = None,
697
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
698
+ _content_type: Optional[StrictStr] = None,
699
+ _headers: Optional[Dict[StrictStr, Any]] = None,
700
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
701
+ ) -> None:
702
+ """Add PROFINET Input/Output
703
+
704
+ Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g., NOVA's PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA's PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA's PROFINET service's configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal).
705
+
706
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
707
+ :type cell: str
708
+ :param io: Unique identifier to address an Input/Output in the cell. (required)
709
+ :type io: str
710
+ :param profinet_io_data: (required)
711
+ :type profinet_io_data: ProfinetIOData
712
+ :param _request_timeout: timeout setting for this request. If one
713
+ number provided, it will be total request
714
+ timeout. It can also be a pair (tuple) of
715
+ (connection, read) timeouts.
716
+ :type _request_timeout: int, tuple(int, int), optional
717
+ :param _request_auth: set to override the auth_settings for an a single
718
+ request; this effectively ignores the
719
+ authentication in the spec for a single request.
720
+ :type _request_auth: dict, optional
721
+ :param _content_type: force content-type for the request.
722
+ :type _content_type: str, Optional
723
+ :param _headers: set to override the headers for a single
724
+ request; this effectively ignores the headers
725
+ in the spec for a single request.
726
+ :type _headers: dict, optional
727
+ :param _host_index: set to override the host_index for a single
728
+ request; this effectively ignores the host_index
729
+ in the spec for a single request.
730
+ :type _host_index: int, optional
731
+ :return: Returns the result object.
732
+ """ # noqa: E501
733
+
734
+ _param = self._add_profinet_io_serialize(
735
+ cell=cell,
736
+ io=io,
737
+ profinet_io_data=profinet_io_data,
738
+ _request_auth=_request_auth,
739
+ _content_type=_content_type,
740
+ _headers=_headers,
741
+ _host_index=_host_index
742
+ )
743
+
744
+ _response_types_map: Dict[str, Optional[str]] = {
745
+ '200': None,
746
+ '400': "Error",
747
+ '404': "Error",
748
+ }
749
+
750
+ response_data = await self.api_client.call_api(
751
+ *_param,
752
+ _request_timeout=_request_timeout
753
+ )
754
+ await response_data.read()
755
+ return self.api_client.response_deserialize(
756
+ response_data=response_data,
757
+ response_types_map=_response_types_map,
758
+ ).data
759
+
760
+
761
+ @validate_call
762
+ async def add_profinet_io_with_http_info(
763
+ self,
764
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
765
+ io: Annotated[StrictStr, Field(description="Unique identifier to address an Input/Output in the cell.")],
766
+ profinet_io_data: ProfinetIOData,
767
+ _request_timeout: Union[
768
+ None,
769
+ Annotated[StrictFloat, Field(gt=0)],
770
+ Tuple[
771
+ Annotated[StrictFloat, Field(gt=0)],
772
+ Annotated[StrictFloat, Field(gt=0)]
773
+ ]
774
+ ] = None,
775
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
776
+ _content_type: Optional[StrictStr] = None,
777
+ _headers: Optional[Dict[StrictStr, Any]] = None,
778
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
779
+ ) -> ApiResponse[None]:
780
+ """Add PROFINET Input/Output
781
+
782
+ Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g., NOVA's PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA's PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA's PROFINET service's configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal).
783
+
784
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
785
+ :type cell: str
786
+ :param io: Unique identifier to address an Input/Output in the cell. (required)
787
+ :type io: str
788
+ :param profinet_io_data: (required)
789
+ :type profinet_io_data: ProfinetIOData
790
+ :param _request_timeout: timeout setting for this request. If one
791
+ number provided, it will be total request
792
+ timeout. It can also be a pair (tuple) of
793
+ (connection, read) timeouts.
794
+ :type _request_timeout: int, tuple(int, int), optional
795
+ :param _request_auth: set to override the auth_settings for an a single
796
+ request; this effectively ignores the
797
+ authentication in the spec for a single request.
798
+ :type _request_auth: dict, optional
799
+ :param _content_type: force content-type for the request.
800
+ :type _content_type: str, Optional
801
+ :param _headers: set to override the headers for a single
802
+ request; this effectively ignores the headers
803
+ in the spec for a single request.
804
+ :type _headers: dict, optional
805
+ :param _host_index: set to override the host_index for a single
806
+ request; this effectively ignores the host_index
807
+ in the spec for a single request.
808
+ :type _host_index: int, optional
809
+ :return: Returns the result object.
810
+ """ # noqa: E501
811
+
812
+ _param = self._add_profinet_io_serialize(
813
+ cell=cell,
814
+ io=io,
815
+ profinet_io_data=profinet_io_data,
816
+ _request_auth=_request_auth,
817
+ _content_type=_content_type,
818
+ _headers=_headers,
819
+ _host_index=_host_index
820
+ )
821
+
822
+ _response_types_map: Dict[str, Optional[str]] = {
823
+ '200': None,
824
+ '400': "Error",
825
+ '404': "Error",
826
+ }
827
+
828
+ response_data = await self.api_client.call_api(
829
+ *_param,
830
+ _request_timeout=_request_timeout
831
+ )
832
+ await response_data.read()
833
+ return self.api_client.response_deserialize(
834
+ response_data=response_data,
835
+ response_types_map=_response_types_map,
836
+ )
837
+
838
+
839
+ @validate_call
840
+ async def add_profinet_io_without_preload_content(
841
+ self,
842
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
843
+ io: Annotated[StrictStr, Field(description="Unique identifier to address an Input/Output in the cell.")],
844
+ profinet_io_data: ProfinetIOData,
845
+ _request_timeout: Union[
846
+ None,
847
+ Annotated[StrictFloat, Field(gt=0)],
848
+ Tuple[
849
+ Annotated[StrictFloat, Field(gt=0)],
850
+ Annotated[StrictFloat, Field(gt=0)]
851
+ ]
852
+ ] = None,
853
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
854
+ _content_type: Optional[StrictStr] = None,
855
+ _headers: Optional[Dict[StrictStr, Any]] = None,
856
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
857
+ ) -> RESTResponseType:
858
+ """Add PROFINET Input/Output
859
+
860
+ Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g., NOVA's PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA's PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA's PROFINET service's configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal).
861
+
862
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
863
+ :type cell: str
864
+ :param io: Unique identifier to address an Input/Output in the cell. (required)
865
+ :type io: str
866
+ :param profinet_io_data: (required)
867
+ :type profinet_io_data: ProfinetIOData
868
+ :param _request_timeout: timeout setting for this request. If one
869
+ number provided, it will be total request
870
+ timeout. It can also be a pair (tuple) of
871
+ (connection, read) timeouts.
872
+ :type _request_timeout: int, tuple(int, int), optional
873
+ :param _request_auth: set to override the auth_settings for an a single
874
+ request; this effectively ignores the
875
+ authentication in the spec for a single request.
876
+ :type _request_auth: dict, optional
877
+ :param _content_type: force content-type for the request.
878
+ :type _content_type: str, Optional
879
+ :param _headers: set to override the headers for a single
880
+ request; this effectively ignores the headers
881
+ in the spec for a single request.
882
+ :type _headers: dict, optional
883
+ :param _host_index: set to override the host_index for a single
884
+ request; this effectively ignores the host_index
885
+ in the spec for a single request.
886
+ :type _host_index: int, optional
887
+ :return: Returns the result object.
888
+ """ # noqa: E501
889
+
890
+ _param = self._add_profinet_io_serialize(
891
+ cell=cell,
892
+ io=io,
893
+ profinet_io_data=profinet_io_data,
894
+ _request_auth=_request_auth,
895
+ _content_type=_content_type,
896
+ _headers=_headers,
897
+ _host_index=_host_index
898
+ )
899
+
900
+ _response_types_map: Dict[str, Optional[str]] = {
901
+ '200': None,
902
+ '400': "Error",
903
+ '404': "Error",
904
+ }
905
+
906
+ response_data = await self.api_client.call_api(
907
+ *_param,
908
+ _request_timeout=_request_timeout
909
+ )
910
+ return response_data.response
911
+
912
+
913
+ def _add_profinet_io_serialize(
914
+ self,
915
+ cell,
916
+ io,
917
+ profinet_io_data,
918
+ _request_auth,
919
+ _content_type,
920
+ _headers,
921
+ _host_index,
922
+ ) -> RequestSerialized:
923
+
924
+ _host = None
925
+
926
+ _collection_formats: Dict[str, str] = {
927
+ }
928
+
929
+ _path_params: Dict[str, str] = {}
930
+ _query_params: List[Tuple[str, str]] = []
931
+ _header_params: Dict[str, Optional[str]] = _headers or {}
932
+ _form_params: List[Tuple[str, str]] = []
933
+ _files: Dict[str, Union[str, bytes]] = {}
934
+ _body_params: Optional[bytes] = None
935
+
936
+ # process the path parameters
937
+ if cell is not None:
938
+ _path_params['cell'] = cell
939
+ if io is not None:
940
+ _path_params['io'] = io
941
+ # process the query parameters
942
+ # process the header parameters
943
+ # process the form parameters
944
+ # process the body parameter
945
+ if profinet_io_data is not None:
946
+ _body_params = profinet_io_data
947
+
948
+
949
+ # set the HTTP header `Accept`
950
+ _header_params['Accept'] = self.api_client.select_header_accept(
951
+ [
952
+ 'application/json'
953
+ ]
954
+ )
955
+
956
+ # set the HTTP header `Content-Type`
957
+ if _content_type:
958
+ _header_params['Content-Type'] = _content_type
959
+ else:
960
+ _default_content_type = (
961
+ self.api_client.select_header_content_type(
962
+ [
963
+ 'application/json'
964
+ ]
965
+ )
966
+ )
967
+ if _default_content_type is not None:
968
+ _header_params['Content-Type'] = _default_content_type
969
+
970
+ # authentication setting
971
+ _auth_settings: List[str] = [
972
+ 'BasicAuth',
973
+ 'BearerAuth'
974
+ ]
975
+
976
+ return self.api_client.param_serialize(
977
+ method='PUT',
978
+ resource_path='/cells/{cell}/bus-ios/profinet/ios/{io}',
979
+ path_params=_path_params,
980
+ query_params=_query_params,
981
+ header_params=_header_params,
982
+ body=_body_params,
983
+ post_params=_form_params,
984
+ files=_files,
985
+ auth_settings=_auth_settings,
986
+ collection_formats=_collection_formats,
987
+ _host=_host,
988
+ _request_auth=_request_auth
989
+ )
990
+
991
+
992
+
993
+ @validate_call
994
+ async def clear_bus_io_service(
995
+ self,
996
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
997
+ completion_timeout: Optional[Annotated[int, Field(strict=True, ge=1)]] = None,
998
+ _request_timeout: Union[
999
+ None,
1000
+ Annotated[StrictFloat, Field(gt=0)],
1001
+ Tuple[
1002
+ Annotated[StrictFloat, Field(gt=0)],
1003
+ Annotated[StrictFloat, Field(gt=0)]
1004
+ ]
1005
+ ] = None,
1006
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1007
+ _content_type: Optional[StrictStr] = None,
1008
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1009
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1010
+ ) -> None:
1011
+ """Clear Service
1012
+
1013
+ Remove the BUS inputs/outputs service from the cell.
1014
+
1015
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
1016
+ :type cell: str
1017
+ :param completion_timeout:
1018
+ :type completion_timeout: int
1019
+ :param _request_timeout: timeout setting for this request. If one
1020
+ number provided, it will be total request
1021
+ timeout. It can also be a pair (tuple) of
1022
+ (connection, read) timeouts.
1023
+ :type _request_timeout: int, tuple(int, int), optional
1024
+ :param _request_auth: set to override the auth_settings for an a single
1025
+ request; this effectively ignores the
1026
+ authentication in the spec for a single request.
1027
+ :type _request_auth: dict, optional
1028
+ :param _content_type: force content-type for the request.
1029
+ :type _content_type: str, Optional
1030
+ :param _headers: set to override the headers for a single
1031
+ request; this effectively ignores the headers
1032
+ in the spec for a single request.
1033
+ :type _headers: dict, optional
1034
+ :param _host_index: set to override the host_index for a single
1035
+ request; this effectively ignores the host_index
1036
+ in the spec for a single request.
1037
+ :type _host_index: int, optional
1038
+ :return: Returns the result object.
1039
+ """ # noqa: E501
1040
+
1041
+ _param = self._clear_bus_io_service_serialize(
1042
+ cell=cell,
1043
+ completion_timeout=completion_timeout,
1044
+ _request_auth=_request_auth,
1045
+ _content_type=_content_type,
1046
+ _headers=_headers,
1047
+ _host_index=_host_index
1048
+ )
1049
+
1050
+ _response_types_map: Dict[str, Optional[str]] = {
1051
+ '200': None,
1052
+ '202': None,
1053
+ '404': "Error",
1054
+ }
1055
+
1056
+ response_data = await self.api_client.call_api(
1057
+ *_param,
1058
+ _request_timeout=_request_timeout
1059
+ )
1060
+ await response_data.read()
1061
+ return self.api_client.response_deserialize(
1062
+ response_data=response_data,
1063
+ response_types_map=_response_types_map,
1064
+ ).data
1065
+
1066
+
1067
+ @validate_call
1068
+ async def clear_bus_io_service_with_http_info(
1069
+ self,
1070
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
1071
+ completion_timeout: Optional[Annotated[int, Field(strict=True, ge=1)]] = None,
1072
+ _request_timeout: Union[
1073
+ None,
1074
+ Annotated[StrictFloat, Field(gt=0)],
1075
+ Tuple[
1076
+ Annotated[StrictFloat, Field(gt=0)],
1077
+ Annotated[StrictFloat, Field(gt=0)]
1078
+ ]
1079
+ ] = None,
1080
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1081
+ _content_type: Optional[StrictStr] = None,
1082
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1083
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1084
+ ) -> ApiResponse[None]:
1085
+ """Clear Service
1086
+
1087
+ Remove the BUS inputs/outputs service from the cell.
1088
+
1089
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
1090
+ :type cell: str
1091
+ :param completion_timeout:
1092
+ :type completion_timeout: int
1093
+ :param _request_timeout: timeout setting for this request. If one
1094
+ number provided, it will be total request
1095
+ timeout. It can also be a pair (tuple) of
1096
+ (connection, read) timeouts.
1097
+ :type _request_timeout: int, tuple(int, int), optional
1098
+ :param _request_auth: set to override the auth_settings for an a single
1099
+ request; this effectively ignores the
1100
+ authentication in the spec for a single request.
1101
+ :type _request_auth: dict, optional
1102
+ :param _content_type: force content-type for the request.
1103
+ :type _content_type: str, Optional
1104
+ :param _headers: set to override the headers for a single
1105
+ request; this effectively ignores the headers
1106
+ in the spec for a single request.
1107
+ :type _headers: dict, optional
1108
+ :param _host_index: set to override the host_index for a single
1109
+ request; this effectively ignores the host_index
1110
+ in the spec for a single request.
1111
+ :type _host_index: int, optional
1112
+ :return: Returns the result object.
1113
+ """ # noqa: E501
1114
+
1115
+ _param = self._clear_bus_io_service_serialize(
1116
+ cell=cell,
1117
+ completion_timeout=completion_timeout,
1118
+ _request_auth=_request_auth,
1119
+ _content_type=_content_type,
1120
+ _headers=_headers,
1121
+ _host_index=_host_index
1122
+ )
1123
+
1124
+ _response_types_map: Dict[str, Optional[str]] = {
1125
+ '200': None,
1126
+ '202': None,
1127
+ '404': "Error",
1128
+ }
1129
+
1130
+ response_data = await self.api_client.call_api(
1131
+ *_param,
1132
+ _request_timeout=_request_timeout
1133
+ )
1134
+ await response_data.read()
1135
+ return self.api_client.response_deserialize(
1136
+ response_data=response_data,
1137
+ response_types_map=_response_types_map,
1138
+ )
1139
+
1140
+
1141
+ @validate_call
1142
+ async def clear_bus_io_service_without_preload_content(
1143
+ self,
1144
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
1145
+ completion_timeout: Optional[Annotated[int, Field(strict=True, ge=1)]] = None,
1146
+ _request_timeout: Union[
1147
+ None,
1148
+ Annotated[StrictFloat, Field(gt=0)],
1149
+ Tuple[
1150
+ Annotated[StrictFloat, Field(gt=0)],
1151
+ Annotated[StrictFloat, Field(gt=0)]
1152
+ ]
1153
+ ] = None,
1154
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1155
+ _content_type: Optional[StrictStr] = None,
1156
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1157
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1158
+ ) -> RESTResponseType:
1159
+ """Clear Service
1160
+
1161
+ Remove the BUS inputs/outputs service from the cell.
1162
+
1163
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
1164
+ :type cell: str
1165
+ :param completion_timeout:
1166
+ :type completion_timeout: int
1167
+ :param _request_timeout: timeout setting for this request. If one
1168
+ number provided, it will be total request
1169
+ timeout. It can also be a pair (tuple) of
1170
+ (connection, read) timeouts.
1171
+ :type _request_timeout: int, tuple(int, int), optional
1172
+ :param _request_auth: set to override the auth_settings for an a single
1173
+ request; this effectively ignores the
1174
+ authentication in the spec for a single request.
1175
+ :type _request_auth: dict, optional
1176
+ :param _content_type: force content-type for the request.
1177
+ :type _content_type: str, Optional
1178
+ :param _headers: set to override the headers for a single
1179
+ request; this effectively ignores the headers
1180
+ in the spec for a single request.
1181
+ :type _headers: dict, optional
1182
+ :param _host_index: set to override the host_index for a single
1183
+ request; this effectively ignores the host_index
1184
+ in the spec for a single request.
1185
+ :type _host_index: int, optional
1186
+ :return: Returns the result object.
1187
+ """ # noqa: E501
1188
+
1189
+ _param = self._clear_bus_io_service_serialize(
1190
+ cell=cell,
1191
+ completion_timeout=completion_timeout,
1192
+ _request_auth=_request_auth,
1193
+ _content_type=_content_type,
1194
+ _headers=_headers,
1195
+ _host_index=_host_index
1196
+ )
1197
+
1198
+ _response_types_map: Dict[str, Optional[str]] = {
1199
+ '200': None,
1200
+ '202': None,
1201
+ '404': "Error",
1202
+ }
1203
+
1204
+ response_data = await self.api_client.call_api(
1205
+ *_param,
1206
+ _request_timeout=_request_timeout
1207
+ )
1208
+ return response_data.response
1209
+
1210
+
1211
+ def _clear_bus_io_service_serialize(
1212
+ self,
1213
+ cell,
1214
+ completion_timeout,
1215
+ _request_auth,
1216
+ _content_type,
1217
+ _headers,
1218
+ _host_index,
1219
+ ) -> RequestSerialized:
1220
+
1221
+ _host = None
1222
+
1223
+ _collection_formats: Dict[str, str] = {
1224
+ }
1225
+
1226
+ _path_params: Dict[str, str] = {}
1227
+ _query_params: List[Tuple[str, str]] = []
1228
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1229
+ _form_params: List[Tuple[str, str]] = []
1230
+ _files: Dict[str, Union[str, bytes]] = {}
1231
+ _body_params: Optional[bytes] = None
1232
+
1233
+ # process the path parameters
1234
+ if cell is not None:
1235
+ _path_params['cell'] = cell
1236
+ # process the query parameters
1237
+ if completion_timeout is not None:
1238
+
1239
+ _query_params.append(('completion_timeout', completion_timeout))
1240
+
1241
+ # process the header parameters
1242
+ # process the form parameters
1243
+ # process the body parameter
1244
+
1245
+
1246
+ # set the HTTP header `Accept`
1247
+ _header_params['Accept'] = self.api_client.select_header_accept(
1248
+ [
1249
+ 'application/json'
1250
+ ]
1251
+ )
1252
+
1253
+
1254
+ # authentication setting
1255
+ _auth_settings: List[str] = [
1256
+ 'BasicAuth',
1257
+ 'BearerAuth'
1258
+ ]
1259
+
1260
+ return self.api_client.param_serialize(
1261
+ method='DELETE',
1262
+ resource_path='/cells/{cell}/bus-ios',
1263
+ path_params=_path_params,
1264
+ query_params=_query_params,
1265
+ header_params=_header_params,
1266
+ body=_body_params,
1267
+ post_params=_form_params,
1268
+ files=_files,
1269
+ auth_settings=_auth_settings,
1270
+ collection_formats=_collection_formats,
1271
+ _host=_host,
1272
+ _request_auth=_request_auth
1273
+ )
1274
+
1275
+
1276
+
1277
+ @validate_call
1278
+ async def delete_modbus_io(
1279
+ self,
1280
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
1281
+ io: Annotated[StrictStr, Field(description="Unique identifier to address an Input/Output in the cell.")],
1282
+ _request_timeout: Union[
1283
+ None,
1284
+ Annotated[StrictFloat, Field(gt=0)],
1285
+ Tuple[
1286
+ Annotated[StrictFloat, Field(gt=0)],
1287
+ Annotated[StrictFloat, Field(gt=0)]
1288
+ ]
1289
+ ] = None,
1290
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1291
+ _content_type: Optional[StrictStr] = None,
1292
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1293
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1294
+ ) -> None:
1295
+ """Remove MODBUS Input/Ouptut
1296
+
1297
+ Removes an input/output variable configuration from the MODBUS device, e.g., NOVA's MODBUS service.
1298
+
1299
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
1300
+ :type cell: str
1301
+ :param io: Unique identifier to address an Input/Output in the cell. (required)
1302
+ :type io: str
1303
+ :param _request_timeout: timeout setting for this request. If one
1304
+ number provided, it will be total request
1305
+ timeout. It can also be a pair (tuple) of
1306
+ (connection, read) timeouts.
1307
+ :type _request_timeout: int, tuple(int, int), optional
1308
+ :param _request_auth: set to override the auth_settings for an a single
1309
+ request; this effectively ignores the
1310
+ authentication in the spec for a single request.
1311
+ :type _request_auth: dict, optional
1312
+ :param _content_type: force content-type for the request.
1313
+ :type _content_type: str, Optional
1314
+ :param _headers: set to override the headers for a single
1315
+ request; this effectively ignores the headers
1316
+ in the spec for a single request.
1317
+ :type _headers: dict, optional
1318
+ :param _host_index: set to override the host_index for a single
1319
+ request; this effectively ignores the host_index
1320
+ in the spec for a single request.
1321
+ :type _host_index: int, optional
1322
+ :return: Returns the result object.
1323
+ """ # noqa: E501
1324
+
1325
+ _param = self._delete_modbus_io_serialize(
1326
+ cell=cell,
1327
+ io=io,
1328
+ _request_auth=_request_auth,
1329
+ _content_type=_content_type,
1330
+ _headers=_headers,
1331
+ _host_index=_host_index
1332
+ )
1333
+
1334
+ _response_types_map: Dict[str, Optional[str]] = {
1335
+ '200': None,
1336
+ '400': "Error",
1337
+ '404': "Error",
1338
+ }
1339
+
1340
+ response_data = await self.api_client.call_api(
1341
+ *_param,
1342
+ _request_timeout=_request_timeout
1343
+ )
1344
+ await response_data.read()
1345
+ return self.api_client.response_deserialize(
1346
+ response_data=response_data,
1347
+ response_types_map=_response_types_map,
1348
+ ).data
1349
+
1350
+
1351
+ @validate_call
1352
+ async def delete_modbus_io_with_http_info(
1353
+ self,
1354
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
1355
+ io: Annotated[StrictStr, Field(description="Unique identifier to address an Input/Output in the cell.")],
1356
+ _request_timeout: Union[
1357
+ None,
1358
+ Annotated[StrictFloat, Field(gt=0)],
1359
+ Tuple[
1360
+ Annotated[StrictFloat, Field(gt=0)],
1361
+ Annotated[StrictFloat, Field(gt=0)]
1362
+ ]
1363
+ ] = None,
1364
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1365
+ _content_type: Optional[StrictStr] = None,
1366
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1367
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1368
+ ) -> ApiResponse[None]:
1369
+ """Remove MODBUS Input/Ouptut
1370
+
1371
+ Removes an input/output variable configuration from the MODBUS device, e.g., NOVA's MODBUS service.
1372
+
1373
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
1374
+ :type cell: str
1375
+ :param io: Unique identifier to address an Input/Output in the cell. (required)
1376
+ :type io: str
1377
+ :param _request_timeout: timeout setting for this request. If one
1378
+ number provided, it will be total request
1379
+ timeout. It can also be a pair (tuple) of
1380
+ (connection, read) timeouts.
1381
+ :type _request_timeout: int, tuple(int, int), optional
1382
+ :param _request_auth: set to override the auth_settings for an a single
1383
+ request; this effectively ignores the
1384
+ authentication in the spec for a single request.
1385
+ :type _request_auth: dict, optional
1386
+ :param _content_type: force content-type for the request.
1387
+ :type _content_type: str, Optional
1388
+ :param _headers: set to override the headers for a single
1389
+ request; this effectively ignores the headers
1390
+ in the spec for a single request.
1391
+ :type _headers: dict, optional
1392
+ :param _host_index: set to override the host_index for a single
1393
+ request; this effectively ignores the host_index
1394
+ in the spec for a single request.
1395
+ :type _host_index: int, optional
1396
+ :return: Returns the result object.
1397
+ """ # noqa: E501
1398
+
1399
+ _param = self._delete_modbus_io_serialize(
1400
+ cell=cell,
1401
+ io=io,
1402
+ _request_auth=_request_auth,
1403
+ _content_type=_content_type,
1404
+ _headers=_headers,
1405
+ _host_index=_host_index
1406
+ )
1407
+
1408
+ _response_types_map: Dict[str, Optional[str]] = {
1409
+ '200': None,
1410
+ '400': "Error",
1411
+ '404': "Error",
1412
+ }
1413
+
1414
+ response_data = await self.api_client.call_api(
1415
+ *_param,
1416
+ _request_timeout=_request_timeout
1417
+ )
1418
+ await response_data.read()
1419
+ return self.api_client.response_deserialize(
1420
+ response_data=response_data,
1421
+ response_types_map=_response_types_map,
1422
+ )
1423
+
1424
+
1425
+ @validate_call
1426
+ async def delete_modbus_io_without_preload_content(
1427
+ self,
1428
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
1429
+ io: Annotated[StrictStr, Field(description="Unique identifier to address an Input/Output in the cell.")],
1430
+ _request_timeout: Union[
1431
+ None,
1432
+ Annotated[StrictFloat, Field(gt=0)],
1433
+ Tuple[
1434
+ Annotated[StrictFloat, Field(gt=0)],
1435
+ Annotated[StrictFloat, Field(gt=0)]
1436
+ ]
1437
+ ] = None,
1438
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1439
+ _content_type: Optional[StrictStr] = None,
1440
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1441
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1442
+ ) -> RESTResponseType:
1443
+ """Remove MODBUS Input/Ouptut
1444
+
1445
+ Removes an input/output variable configuration from the MODBUS device, e.g., NOVA's MODBUS service.
1446
+
1447
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
1448
+ :type cell: str
1449
+ :param io: Unique identifier to address an Input/Output in the cell. (required)
1450
+ :type io: str
1451
+ :param _request_timeout: timeout setting for this request. If one
1452
+ number provided, it will be total request
1453
+ timeout. It can also be a pair (tuple) of
1454
+ (connection, read) timeouts.
1455
+ :type _request_timeout: int, tuple(int, int), optional
1456
+ :param _request_auth: set to override the auth_settings for an a single
1457
+ request; this effectively ignores the
1458
+ authentication in the spec for a single request.
1459
+ :type _request_auth: dict, optional
1460
+ :param _content_type: force content-type for the request.
1461
+ :type _content_type: str, Optional
1462
+ :param _headers: set to override the headers for a single
1463
+ request; this effectively ignores the headers
1464
+ in the spec for a single request.
1465
+ :type _headers: dict, optional
1466
+ :param _host_index: set to override the host_index for a single
1467
+ request; this effectively ignores the host_index
1468
+ in the spec for a single request.
1469
+ :type _host_index: int, optional
1470
+ :return: Returns the result object.
1471
+ """ # noqa: E501
1472
+
1473
+ _param = self._delete_modbus_io_serialize(
1474
+ cell=cell,
1475
+ io=io,
1476
+ _request_auth=_request_auth,
1477
+ _content_type=_content_type,
1478
+ _headers=_headers,
1479
+ _host_index=_host_index
1480
+ )
1481
+
1482
+ _response_types_map: Dict[str, Optional[str]] = {
1483
+ '200': None,
1484
+ '400': "Error",
1485
+ '404': "Error",
1486
+ }
1487
+
1488
+ response_data = await self.api_client.call_api(
1489
+ *_param,
1490
+ _request_timeout=_request_timeout
1491
+ )
1492
+ return response_data.response
1493
+
1494
+
1495
+ def _delete_modbus_io_serialize(
1496
+ self,
1497
+ cell,
1498
+ io,
1499
+ _request_auth,
1500
+ _content_type,
1501
+ _headers,
1502
+ _host_index,
1503
+ ) -> RequestSerialized:
1504
+
1505
+ _host = None
1506
+
1507
+ _collection_formats: Dict[str, str] = {
1508
+ }
1509
+
1510
+ _path_params: Dict[str, str] = {}
1511
+ _query_params: List[Tuple[str, str]] = []
1512
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1513
+ _form_params: List[Tuple[str, str]] = []
1514
+ _files: Dict[str, Union[str, bytes]] = {}
1515
+ _body_params: Optional[bytes] = None
1516
+
1517
+ # process the path parameters
1518
+ if cell is not None:
1519
+ _path_params['cell'] = cell
1520
+ if io is not None:
1521
+ _path_params['io'] = io
1522
+ # process the query parameters
1523
+ # process the header parameters
1524
+ # process the form parameters
1525
+ # process the body parameter
1526
+
1527
+
1528
+ # set the HTTP header `Accept`
1529
+ _header_params['Accept'] = self.api_client.select_header_accept(
1530
+ [
1531
+ 'application/json'
1532
+ ]
1533
+ )
1534
+
1535
+
1536
+ # authentication setting
1537
+ _auth_settings: List[str] = [
1538
+ 'BasicAuth',
1539
+ 'BearerAuth'
1540
+ ]
1541
+
1542
+ return self.api_client.param_serialize(
1543
+ method='DELETE',
1544
+ resource_path='/cells/{cell}/bus-ios/modbus/ios/{io}',
1545
+ path_params=_path_params,
1546
+ query_params=_query_params,
1547
+ header_params=_header_params,
1548
+ body=_body_params,
1549
+ post_params=_form_params,
1550
+ files=_files,
1551
+ auth_settings=_auth_settings,
1552
+ collection_formats=_collection_formats,
1553
+ _host=_host,
1554
+ _request_auth=_request_auth
1555
+ )
1556
+
1557
+
1558
+
1559
+ @validate_call
1560
+ async def delete_profinet_io(
1561
+ self,
1562
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
1563
+ io: Annotated[StrictStr, Field(description="Unique identifier to address an Input/Output in the cell.")],
1564
+ _request_timeout: Union[
1565
+ None,
1566
+ Annotated[StrictFloat, Field(gt=0)],
1567
+ Tuple[
1568
+ Annotated[StrictFloat, Field(gt=0)],
1569
+ Annotated[StrictFloat, Field(gt=0)]
1570
+ ]
1571
+ ] = None,
1572
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1573
+ _content_type: Optional[StrictStr] = None,
1574
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1575
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1576
+ ) -> None:
1577
+ """Remove PROFINET Input/Ouptut
1578
+
1579
+ Removes an input/output variable configuration from the PROFINET device, e.g., NOVA's PROFINET service.
1580
+
1581
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
1582
+ :type cell: str
1583
+ :param io: Unique identifier to address an Input/Output in the cell. (required)
1584
+ :type io: str
1585
+ :param _request_timeout: timeout setting for this request. If one
1586
+ number provided, it will be total request
1587
+ timeout. It can also be a pair (tuple) of
1588
+ (connection, read) timeouts.
1589
+ :type _request_timeout: int, tuple(int, int), optional
1590
+ :param _request_auth: set to override the auth_settings for an a single
1591
+ request; this effectively ignores the
1592
+ authentication in the spec for a single request.
1593
+ :type _request_auth: dict, optional
1594
+ :param _content_type: force content-type for the request.
1595
+ :type _content_type: str, Optional
1596
+ :param _headers: set to override the headers for a single
1597
+ request; this effectively ignores the headers
1598
+ in the spec for a single request.
1599
+ :type _headers: dict, optional
1600
+ :param _host_index: set to override the host_index for a single
1601
+ request; this effectively ignores the host_index
1602
+ in the spec for a single request.
1603
+ :type _host_index: int, optional
1604
+ :return: Returns the result object.
1605
+ """ # noqa: E501
1606
+
1607
+ _param = self._delete_profinet_io_serialize(
1608
+ cell=cell,
1609
+ io=io,
1610
+ _request_auth=_request_auth,
1611
+ _content_type=_content_type,
1612
+ _headers=_headers,
1613
+ _host_index=_host_index
1614
+ )
1615
+
1616
+ _response_types_map: Dict[str, Optional[str]] = {
1617
+ '200': None,
1618
+ '400': "Error",
1619
+ '404': "Error",
1620
+ }
1621
+
1622
+ response_data = await self.api_client.call_api(
1623
+ *_param,
1624
+ _request_timeout=_request_timeout
1625
+ )
1626
+ await response_data.read()
1627
+ return self.api_client.response_deserialize(
1628
+ response_data=response_data,
1629
+ response_types_map=_response_types_map,
1630
+ ).data
1631
+
1632
+
1633
+ @validate_call
1634
+ async def delete_profinet_io_with_http_info(
1635
+ self,
1636
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
1637
+ io: Annotated[StrictStr, Field(description="Unique identifier to address an Input/Output in the cell.")],
1638
+ _request_timeout: Union[
1639
+ None,
1640
+ Annotated[StrictFloat, Field(gt=0)],
1641
+ Tuple[
1642
+ Annotated[StrictFloat, Field(gt=0)],
1643
+ Annotated[StrictFloat, Field(gt=0)]
1644
+ ]
1645
+ ] = None,
1646
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1647
+ _content_type: Optional[StrictStr] = None,
1648
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1649
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1650
+ ) -> ApiResponse[None]:
1651
+ """Remove PROFINET Input/Ouptut
1652
+
1653
+ Removes an input/output variable configuration from the PROFINET device, e.g., NOVA's PROFINET service.
1654
+
1655
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
1656
+ :type cell: str
1657
+ :param io: Unique identifier to address an Input/Output in the cell. (required)
1658
+ :type io: str
1659
+ :param _request_timeout: timeout setting for this request. If one
1660
+ number provided, it will be total request
1661
+ timeout. It can also be a pair (tuple) of
1662
+ (connection, read) timeouts.
1663
+ :type _request_timeout: int, tuple(int, int), optional
1664
+ :param _request_auth: set to override the auth_settings for an a single
1665
+ request; this effectively ignores the
1666
+ authentication in the spec for a single request.
1667
+ :type _request_auth: dict, optional
1668
+ :param _content_type: force content-type for the request.
1669
+ :type _content_type: str, Optional
1670
+ :param _headers: set to override the headers for a single
1671
+ request; this effectively ignores the headers
1672
+ in the spec for a single request.
1673
+ :type _headers: dict, optional
1674
+ :param _host_index: set to override the host_index for a single
1675
+ request; this effectively ignores the host_index
1676
+ in the spec for a single request.
1677
+ :type _host_index: int, optional
1678
+ :return: Returns the result object.
1679
+ """ # noqa: E501
1680
+
1681
+ _param = self._delete_profinet_io_serialize(
1682
+ cell=cell,
1683
+ io=io,
1684
+ _request_auth=_request_auth,
1685
+ _content_type=_content_type,
1686
+ _headers=_headers,
1687
+ _host_index=_host_index
1688
+ )
1689
+
1690
+ _response_types_map: Dict[str, Optional[str]] = {
1691
+ '200': None,
1692
+ '400': "Error",
1693
+ '404': "Error",
1694
+ }
1695
+
1696
+ response_data = await self.api_client.call_api(
1697
+ *_param,
1698
+ _request_timeout=_request_timeout
1699
+ )
1700
+ await response_data.read()
1701
+ return self.api_client.response_deserialize(
1702
+ response_data=response_data,
1703
+ response_types_map=_response_types_map,
1704
+ )
1705
+
1706
+
1707
+ @validate_call
1708
+ async def delete_profinet_io_without_preload_content(
1709
+ self,
1710
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
1711
+ io: Annotated[StrictStr, Field(description="Unique identifier to address an Input/Output in the cell.")],
1712
+ _request_timeout: Union[
1713
+ None,
1714
+ Annotated[StrictFloat, Field(gt=0)],
1715
+ Tuple[
1716
+ Annotated[StrictFloat, Field(gt=0)],
1717
+ Annotated[StrictFloat, Field(gt=0)]
1718
+ ]
1719
+ ] = None,
1720
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1721
+ _content_type: Optional[StrictStr] = None,
1722
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1723
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1724
+ ) -> RESTResponseType:
1725
+ """Remove PROFINET Input/Ouptut
1726
+
1727
+ Removes an input/output variable configuration from the PROFINET device, e.g., NOVA's PROFINET service.
1728
+
1729
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
1730
+ :type cell: str
1731
+ :param io: Unique identifier to address an Input/Output in the cell. (required)
1732
+ :type io: str
1733
+ :param _request_timeout: timeout setting for this request. If one
1734
+ number provided, it will be total request
1735
+ timeout. It can also be a pair (tuple) of
1736
+ (connection, read) timeouts.
1737
+ :type _request_timeout: int, tuple(int, int), optional
1738
+ :param _request_auth: set to override the auth_settings for an a single
1739
+ request; this effectively ignores the
1740
+ authentication in the spec for a single request.
1741
+ :type _request_auth: dict, optional
1742
+ :param _content_type: force content-type for the request.
1743
+ :type _content_type: str, Optional
1744
+ :param _headers: set to override the headers for a single
1745
+ request; this effectively ignores the headers
1746
+ in the spec for a single request.
1747
+ :type _headers: dict, optional
1748
+ :param _host_index: set to override the host_index for a single
1749
+ request; this effectively ignores the host_index
1750
+ in the spec for a single request.
1751
+ :type _host_index: int, optional
1752
+ :return: Returns the result object.
1753
+ """ # noqa: E501
1754
+
1755
+ _param = self._delete_profinet_io_serialize(
1756
+ cell=cell,
1757
+ io=io,
1758
+ _request_auth=_request_auth,
1759
+ _content_type=_content_type,
1760
+ _headers=_headers,
1761
+ _host_index=_host_index
1762
+ )
1763
+
1764
+ _response_types_map: Dict[str, Optional[str]] = {
1765
+ '200': None,
1766
+ '400': "Error",
1767
+ '404': "Error",
1768
+ }
1769
+
1770
+ response_data = await self.api_client.call_api(
1771
+ *_param,
1772
+ _request_timeout=_request_timeout
1773
+ )
1774
+ return response_data.response
1775
+
1776
+
1777
+ def _delete_profinet_io_serialize(
1778
+ self,
1779
+ cell,
1780
+ io,
1781
+ _request_auth,
1782
+ _content_type,
1783
+ _headers,
1784
+ _host_index,
1785
+ ) -> RequestSerialized:
1786
+
1787
+ _host = None
1788
+
1789
+ _collection_formats: Dict[str, str] = {
1790
+ }
1791
+
1792
+ _path_params: Dict[str, str] = {}
1793
+ _query_params: List[Tuple[str, str]] = []
1794
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1795
+ _form_params: List[Tuple[str, str]] = []
1796
+ _files: Dict[str, Union[str, bytes]] = {}
1797
+ _body_params: Optional[bytes] = None
1798
+
1799
+ # process the path parameters
1800
+ if cell is not None:
1801
+ _path_params['cell'] = cell
1802
+ if io is not None:
1803
+ _path_params['io'] = io
1804
+ # process the query parameters
1805
+ # process the header parameters
1806
+ # process the form parameters
1807
+ # process the body parameter
1808
+
1809
+
1810
+ # set the HTTP header `Accept`
1811
+ _header_params['Accept'] = self.api_client.select_header_accept(
1812
+ [
1813
+ 'application/json'
1814
+ ]
1815
+ )
1816
+
1817
+
1818
+ # authentication setting
1819
+ _auth_settings: List[str] = [
1820
+ 'BasicAuth',
1821
+ 'BearerAuth'
1822
+ ]
1823
+
1824
+ return self.api_client.param_serialize(
1825
+ method='DELETE',
1826
+ resource_path='/cells/{cell}/bus-ios/profinet/ios/{io}',
1827
+ path_params=_path_params,
1828
+ query_params=_query_params,
1829
+ header_params=_header_params,
1830
+ body=_body_params,
1831
+ post_params=_form_params,
1832
+ files=_files,
1833
+ auth_settings=_auth_settings,
1834
+ collection_formats=_collection_formats,
1835
+ _host=_host,
1836
+ _request_auth=_request_auth
1837
+ )
1838
+
1839
+
1840
+
1841
+ @validate_call
1842
+ async def get_bus_io_service(
1843
+ self,
1844
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
1845
+ _request_timeout: Union[
1846
+ None,
1847
+ Annotated[StrictFloat, Field(gt=0)],
1848
+ Tuple[
1849
+ Annotated[StrictFloat, Field(gt=0)],
1850
+ Annotated[StrictFloat, Field(gt=0)]
1851
+ ]
1852
+ ] = None,
1853
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1854
+ _content_type: Optional[StrictStr] = None,
1855
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1856
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1857
+ ) -> BusIOType:
1858
+ """Get Service
1859
+
1860
+ Get deployed BUS inputs/outputs service.
1861
+
1862
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
1863
+ :type cell: str
1864
+ :param _request_timeout: timeout setting for this request. If one
1865
+ number provided, it will be total request
1866
+ timeout. It can also be a pair (tuple) of
1867
+ (connection, read) timeouts.
1868
+ :type _request_timeout: int, tuple(int, int), optional
1869
+ :param _request_auth: set to override the auth_settings for an a single
1870
+ request; this effectively ignores the
1871
+ authentication in the spec for a single request.
1872
+ :type _request_auth: dict, optional
1873
+ :param _content_type: force content-type for the request.
1874
+ :type _content_type: str, Optional
1875
+ :param _headers: set to override the headers for a single
1876
+ request; this effectively ignores the headers
1877
+ in the spec for a single request.
1878
+ :type _headers: dict, optional
1879
+ :param _host_index: set to override the host_index for a single
1880
+ request; this effectively ignores the host_index
1881
+ in the spec for a single request.
1882
+ :type _host_index: int, optional
1883
+ :return: Returns the result object.
1884
+ """ # noqa: E501
1885
+
1886
+ _param = self._get_bus_io_service_serialize(
1887
+ cell=cell,
1888
+ _request_auth=_request_auth,
1889
+ _content_type=_content_type,
1890
+ _headers=_headers,
1891
+ _host_index=_host_index
1892
+ )
1893
+
1894
+ _response_types_map: Dict[str, Optional[str]] = {
1895
+ '200': "BusIOType",
1896
+ '404': "Error",
1897
+ }
1898
+
1899
+ response_data = await self.api_client.call_api(
1900
+ *_param,
1901
+ _request_timeout=_request_timeout
1902
+ )
1903
+ await response_data.read()
1904
+ return self.api_client.response_deserialize(
1905
+ response_data=response_data,
1906
+ response_types_map=_response_types_map,
1907
+ ).data
1908
+
1909
+
1910
+ @validate_call
1911
+ async def get_bus_io_service_with_http_info(
1912
+ self,
1913
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
1914
+ _request_timeout: Union[
1915
+ None,
1916
+ Annotated[StrictFloat, Field(gt=0)],
1917
+ Tuple[
1918
+ Annotated[StrictFloat, Field(gt=0)],
1919
+ Annotated[StrictFloat, Field(gt=0)]
1920
+ ]
1921
+ ] = None,
1922
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1923
+ _content_type: Optional[StrictStr] = None,
1924
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1925
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1926
+ ) -> ApiResponse[BusIOType]:
1927
+ """Get Service
1928
+
1929
+ Get deployed BUS inputs/outputs service.
1930
+
1931
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
1932
+ :type cell: str
1933
+ :param _request_timeout: timeout setting for this request. If one
1934
+ number provided, it will be total request
1935
+ timeout. It can also be a pair (tuple) of
1936
+ (connection, read) timeouts.
1937
+ :type _request_timeout: int, tuple(int, int), optional
1938
+ :param _request_auth: set to override the auth_settings for an a single
1939
+ request; this effectively ignores the
1940
+ authentication in the spec for a single request.
1941
+ :type _request_auth: dict, optional
1942
+ :param _content_type: force content-type for the request.
1943
+ :type _content_type: str, Optional
1944
+ :param _headers: set to override the headers for a single
1945
+ request; this effectively ignores the headers
1946
+ in the spec for a single request.
1947
+ :type _headers: dict, optional
1948
+ :param _host_index: set to override the host_index for a single
1949
+ request; this effectively ignores the host_index
1950
+ in the spec for a single request.
1951
+ :type _host_index: int, optional
1952
+ :return: Returns the result object.
1953
+ """ # noqa: E501
1954
+
1955
+ _param = self._get_bus_io_service_serialize(
1956
+ cell=cell,
1957
+ _request_auth=_request_auth,
1958
+ _content_type=_content_type,
1959
+ _headers=_headers,
1960
+ _host_index=_host_index
1961
+ )
1962
+
1963
+ _response_types_map: Dict[str, Optional[str]] = {
1964
+ '200': "BusIOType",
1965
+ '404': "Error",
1966
+ }
1967
+
1968
+ response_data = await self.api_client.call_api(
1969
+ *_param,
1970
+ _request_timeout=_request_timeout
1971
+ )
1972
+ await response_data.read()
1973
+ return self.api_client.response_deserialize(
1974
+ response_data=response_data,
1975
+ response_types_map=_response_types_map,
1976
+ )
1977
+
1978
+
1979
+ @validate_call
1980
+ async def get_bus_io_service_without_preload_content(
1981
+ self,
1982
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
1983
+ _request_timeout: Union[
1984
+ None,
1985
+ Annotated[StrictFloat, Field(gt=0)],
1986
+ Tuple[
1987
+ Annotated[StrictFloat, Field(gt=0)],
1988
+ Annotated[StrictFloat, Field(gt=0)]
1989
+ ]
1990
+ ] = None,
1991
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1992
+ _content_type: Optional[StrictStr] = None,
1993
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1994
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1995
+ ) -> RESTResponseType:
1996
+ """Get Service
1997
+
1998
+ Get deployed BUS inputs/outputs service.
1999
+
2000
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
2001
+ :type cell: str
2002
+ :param _request_timeout: timeout setting for this request. If one
2003
+ number provided, it will be total request
2004
+ timeout. It can also be a pair (tuple) of
2005
+ (connection, read) timeouts.
2006
+ :type _request_timeout: int, tuple(int, int), optional
2007
+ :param _request_auth: set to override the auth_settings for an a single
2008
+ request; this effectively ignores the
2009
+ authentication in the spec for a single request.
2010
+ :type _request_auth: dict, optional
2011
+ :param _content_type: force content-type for the request.
2012
+ :type _content_type: str, Optional
2013
+ :param _headers: set to override the headers for a single
2014
+ request; this effectively ignores the headers
2015
+ in the spec for a single request.
2016
+ :type _headers: dict, optional
2017
+ :param _host_index: set to override the host_index for a single
2018
+ request; this effectively ignores the host_index
2019
+ in the spec for a single request.
2020
+ :type _host_index: int, optional
2021
+ :return: Returns the result object.
2022
+ """ # noqa: E501
2023
+
2024
+ _param = self._get_bus_io_service_serialize(
2025
+ cell=cell,
2026
+ _request_auth=_request_auth,
2027
+ _content_type=_content_type,
2028
+ _headers=_headers,
2029
+ _host_index=_host_index
2030
+ )
2031
+
2032
+ _response_types_map: Dict[str, Optional[str]] = {
2033
+ '200': "BusIOType",
2034
+ '404': "Error",
2035
+ }
2036
+
2037
+ response_data = await self.api_client.call_api(
2038
+ *_param,
2039
+ _request_timeout=_request_timeout
2040
+ )
2041
+ return response_data.response
2042
+
2043
+
2044
+ def _get_bus_io_service_serialize(
2045
+ self,
2046
+ cell,
2047
+ _request_auth,
2048
+ _content_type,
2049
+ _headers,
2050
+ _host_index,
2051
+ ) -> RequestSerialized:
2052
+
2053
+ _host = None
2054
+
2055
+ _collection_formats: Dict[str, str] = {
2056
+ }
2057
+
2058
+ _path_params: Dict[str, str] = {}
2059
+ _query_params: List[Tuple[str, str]] = []
2060
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2061
+ _form_params: List[Tuple[str, str]] = []
2062
+ _files: Dict[str, Union[str, bytes]] = {}
2063
+ _body_params: Optional[bytes] = None
2064
+
2065
+ # process the path parameters
2066
+ if cell is not None:
2067
+ _path_params['cell'] = cell
2068
+ # process the query parameters
2069
+ # process the header parameters
2070
+ # process the form parameters
2071
+ # process the body parameter
2072
+
2073
+
2074
+ # set the HTTP header `Accept`
2075
+ _header_params['Accept'] = self.api_client.select_header_accept(
2076
+ [
2077
+ 'application/json'
2078
+ ]
2079
+ )
2080
+
2081
+
2082
+ # authentication setting
2083
+ _auth_settings: List[str] = [
2084
+ 'BasicAuth',
2085
+ 'BearerAuth'
2086
+ ]
2087
+
2088
+ return self.api_client.param_serialize(
2089
+ method='GET',
2090
+ resource_path='/cells/{cell}/bus-ios',
2091
+ path_params=_path_params,
2092
+ query_params=_query_params,
2093
+ header_params=_header_params,
2094
+ body=_body_params,
2095
+ post_params=_form_params,
2096
+ files=_files,
2097
+ auth_settings=_auth_settings,
2098
+ collection_formats=_collection_formats,
2099
+ _host=_host,
2100
+ _request_auth=_request_auth
2101
+ )
2102
+
2103
+
2104
+
2105
+ @validate_call
2106
+ async def get_bus_io_state(
2107
+ self,
2108
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
2109
+ _request_timeout: Union[
2110
+ None,
2111
+ Annotated[StrictFloat, Field(gt=0)],
2112
+ Tuple[
2113
+ Annotated[StrictFloat, Field(gt=0)],
2114
+ Annotated[StrictFloat, Field(gt=0)]
2115
+ ]
2116
+ ] = None,
2117
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2118
+ _content_type: Optional[StrictStr] = None,
2119
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2120
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2121
+ ) -> BusIOsState:
2122
+ """State
2123
+
2124
+ Get the current state of the BUS Inputs/Outputs service.
2125
+
2126
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
2127
+ :type cell: str
2128
+ :param _request_timeout: timeout setting for this request. If one
2129
+ number provided, it will be total request
2130
+ timeout. It can also be a pair (tuple) of
2131
+ (connection, read) timeouts.
2132
+ :type _request_timeout: int, tuple(int, int), optional
2133
+ :param _request_auth: set to override the auth_settings for an a single
2134
+ request; this effectively ignores the
2135
+ authentication in the spec for a single request.
2136
+ :type _request_auth: dict, optional
2137
+ :param _content_type: force content-type for the request.
2138
+ :type _content_type: str, Optional
2139
+ :param _headers: set to override the headers for a single
2140
+ request; this effectively ignores the headers
2141
+ in the spec for a single request.
2142
+ :type _headers: dict, optional
2143
+ :param _host_index: set to override the host_index for a single
2144
+ request; this effectively ignores the host_index
2145
+ in the spec for a single request.
2146
+ :type _host_index: int, optional
2147
+ :return: Returns the result object.
2148
+ """ # noqa: E501
2149
+
2150
+ _param = self._get_bus_io_state_serialize(
2151
+ cell=cell,
2152
+ _request_auth=_request_auth,
2153
+ _content_type=_content_type,
2154
+ _headers=_headers,
2155
+ _host_index=_host_index
2156
+ )
2157
+
2158
+ _response_types_map: Dict[str, Optional[str]] = {
2159
+ '200': "BusIOsState",
2160
+ '404': "Error",
2161
+ }
2162
+
2163
+ response_data = await self.api_client.call_api(
2164
+ *_param,
2165
+ _request_timeout=_request_timeout
2166
+ )
2167
+ await response_data.read()
2168
+ return self.api_client.response_deserialize(
2169
+ response_data=response_data,
2170
+ response_types_map=_response_types_map,
2171
+ ).data
2172
+
2173
+
2174
+ @validate_call
2175
+ async def get_bus_io_state_with_http_info(
2176
+ self,
2177
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
2178
+ _request_timeout: Union[
2179
+ None,
2180
+ Annotated[StrictFloat, Field(gt=0)],
2181
+ Tuple[
2182
+ Annotated[StrictFloat, Field(gt=0)],
2183
+ Annotated[StrictFloat, Field(gt=0)]
2184
+ ]
2185
+ ] = None,
2186
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2187
+ _content_type: Optional[StrictStr] = None,
2188
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2189
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2190
+ ) -> ApiResponse[BusIOsState]:
2191
+ """State
2192
+
2193
+ Get the current state of the BUS Inputs/Outputs service.
2194
+
2195
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
2196
+ :type cell: str
2197
+ :param _request_timeout: timeout setting for this request. If one
2198
+ number provided, it will be total request
2199
+ timeout. It can also be a pair (tuple) of
2200
+ (connection, read) timeouts.
2201
+ :type _request_timeout: int, tuple(int, int), optional
2202
+ :param _request_auth: set to override the auth_settings for an a single
2203
+ request; this effectively ignores the
2204
+ authentication in the spec for a single request.
2205
+ :type _request_auth: dict, optional
2206
+ :param _content_type: force content-type for the request.
2207
+ :type _content_type: str, Optional
2208
+ :param _headers: set to override the headers for a single
2209
+ request; this effectively ignores the headers
2210
+ in the spec for a single request.
2211
+ :type _headers: dict, optional
2212
+ :param _host_index: set to override the host_index for a single
2213
+ request; this effectively ignores the host_index
2214
+ in the spec for a single request.
2215
+ :type _host_index: int, optional
2216
+ :return: Returns the result object.
2217
+ """ # noqa: E501
2218
+
2219
+ _param = self._get_bus_io_state_serialize(
2220
+ cell=cell,
2221
+ _request_auth=_request_auth,
2222
+ _content_type=_content_type,
2223
+ _headers=_headers,
2224
+ _host_index=_host_index
2225
+ )
2226
+
2227
+ _response_types_map: Dict[str, Optional[str]] = {
2228
+ '200': "BusIOsState",
2229
+ '404': "Error",
2230
+ }
2231
+
2232
+ response_data = await self.api_client.call_api(
2233
+ *_param,
2234
+ _request_timeout=_request_timeout
2235
+ )
2236
+ await response_data.read()
2237
+ return self.api_client.response_deserialize(
2238
+ response_data=response_data,
2239
+ response_types_map=_response_types_map,
2240
+ )
2241
+
2242
+
2243
+ @validate_call
2244
+ async def get_bus_io_state_without_preload_content(
2245
+ self,
2246
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
2247
+ _request_timeout: Union[
2248
+ None,
2249
+ Annotated[StrictFloat, Field(gt=0)],
2250
+ Tuple[
2251
+ Annotated[StrictFloat, Field(gt=0)],
2252
+ Annotated[StrictFloat, Field(gt=0)]
2253
+ ]
2254
+ ] = None,
2255
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2256
+ _content_type: Optional[StrictStr] = None,
2257
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2258
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2259
+ ) -> RESTResponseType:
2260
+ """State
2261
+
2262
+ Get the current state of the BUS Inputs/Outputs service.
2263
+
2264
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
2265
+ :type cell: str
2266
+ :param _request_timeout: timeout setting for this request. If one
2267
+ number provided, it will be total request
2268
+ timeout. It can also be a pair (tuple) of
2269
+ (connection, read) timeouts.
2270
+ :type _request_timeout: int, tuple(int, int), optional
2271
+ :param _request_auth: set to override the auth_settings for an a single
2272
+ request; this effectively ignores the
2273
+ authentication in the spec for a single request.
2274
+ :type _request_auth: dict, optional
2275
+ :param _content_type: force content-type for the request.
2276
+ :type _content_type: str, Optional
2277
+ :param _headers: set to override the headers for a single
2278
+ request; this effectively ignores the headers
2279
+ in the spec for a single request.
2280
+ :type _headers: dict, optional
2281
+ :param _host_index: set to override the host_index for a single
2282
+ request; this effectively ignores the host_index
2283
+ in the spec for a single request.
2284
+ :type _host_index: int, optional
2285
+ :return: Returns the result object.
2286
+ """ # noqa: E501
2287
+
2288
+ _param = self._get_bus_io_state_serialize(
2289
+ cell=cell,
2290
+ _request_auth=_request_auth,
2291
+ _content_type=_content_type,
2292
+ _headers=_headers,
2293
+ _host_index=_host_index
2294
+ )
2295
+
2296
+ _response_types_map: Dict[str, Optional[str]] = {
2297
+ '200': "BusIOsState",
2298
+ '404': "Error",
2299
+ }
2300
+
2301
+ response_data = await self.api_client.call_api(
2302
+ *_param,
2303
+ _request_timeout=_request_timeout
2304
+ )
2305
+ return response_data.response
2306
+
2307
+
2308
+ def _get_bus_io_state_serialize(
2309
+ self,
2310
+ cell,
2311
+ _request_auth,
2312
+ _content_type,
2313
+ _headers,
2314
+ _host_index,
2315
+ ) -> RequestSerialized:
2316
+
2317
+ _host = None
2318
+
2319
+ _collection_formats: Dict[str, str] = {
2320
+ }
2321
+
2322
+ _path_params: Dict[str, str] = {}
2323
+ _query_params: List[Tuple[str, str]] = []
2324
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2325
+ _form_params: List[Tuple[str, str]] = []
2326
+ _files: Dict[str, Union[str, bytes]] = {}
2327
+ _body_params: Optional[bytes] = None
2328
+
2329
+ # process the path parameters
2330
+ if cell is not None:
2331
+ _path_params['cell'] = cell
2332
+ # process the query parameters
2333
+ # process the header parameters
2334
+ # process the form parameters
2335
+ # process the body parameter
2336
+
2337
+
2338
+ # set the HTTP header `Accept`
2339
+ _header_params['Accept'] = self.api_client.select_header_accept(
2340
+ [
2341
+ 'application/json'
2342
+ ]
2343
+ )
2344
+
2345
+
2346
+ # authentication setting
2347
+ _auth_settings: List[str] = [
2348
+ 'BasicAuth',
2349
+ 'BearerAuth'
2350
+ ]
2351
+
2352
+ return self.api_client.param_serialize(
2353
+ method='GET',
2354
+ resource_path='/cells/{cell}/bus-ios/state',
2355
+ path_params=_path_params,
2356
+ query_params=_query_params,
2357
+ header_params=_header_params,
2358
+ body=_body_params,
2359
+ post_params=_form_params,
2360
+ files=_files,
2361
+ auth_settings=_auth_settings,
2362
+ collection_formats=_collection_formats,
2363
+ _host=_host,
2364
+ _request_auth=_request_auth
2365
+ )
2366
+
2367
+
2368
+
2369
+ @validate_call
2370
+ async def get_bus_io_values(
2371
+ self,
2372
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
2373
+ ios: Optional[List[StrictStr]] = None,
2374
+ _request_timeout: Union[
2375
+ None,
2376
+ Annotated[StrictFloat, Field(gt=0)],
2377
+ Tuple[
2378
+ Annotated[StrictFloat, Field(gt=0)],
2379
+ Annotated[StrictFloat, Field(gt=0)]
2380
+ ]
2381
+ ] = None,
2382
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2383
+ _content_type: Optional[StrictStr] = None,
2384
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2385
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2386
+ ) -> List[IOValue]:
2387
+ """Get Input/Output Values
2388
+
2389
+ Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listBusIODescriptions](listBusIODescriptions).
2390
+
2391
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
2392
+ :type cell: str
2393
+ :param ios:
2394
+ :type ios: List[str]
2395
+ :param _request_timeout: timeout setting for this request. If one
2396
+ number provided, it will be total request
2397
+ timeout. It can also be a pair (tuple) of
2398
+ (connection, read) timeouts.
2399
+ :type _request_timeout: int, tuple(int, int), optional
2400
+ :param _request_auth: set to override the auth_settings for an a single
2401
+ request; this effectively ignores the
2402
+ authentication in the spec for a single request.
2403
+ :type _request_auth: dict, optional
2404
+ :param _content_type: force content-type for the request.
2405
+ :type _content_type: str, Optional
2406
+ :param _headers: set to override the headers for a single
2407
+ request; this effectively ignores the headers
2408
+ in the spec for a single request.
2409
+ :type _headers: dict, optional
2410
+ :param _host_index: set to override the host_index for a single
2411
+ request; this effectively ignores the host_index
2412
+ in the spec for a single request.
2413
+ :type _host_index: int, optional
2414
+ :return: Returns the result object.
2415
+ """ # noqa: E501
2416
+
2417
+ _param = self._get_bus_io_values_serialize(
2418
+ cell=cell,
2419
+ ios=ios,
2420
+ _request_auth=_request_auth,
2421
+ _content_type=_content_type,
2422
+ _headers=_headers,
2423
+ _host_index=_host_index
2424
+ )
2425
+
2426
+ _response_types_map: Dict[str, Optional[str]] = {
2427
+ '200': "List[IOValue]",
2428
+ '400': "Error",
2429
+ '404': "Error",
2430
+ }
2431
+
2432
+ response_data = await self.api_client.call_api(
2433
+ *_param,
2434
+ _request_timeout=_request_timeout
2435
+ )
2436
+ await response_data.read()
2437
+ return self.api_client.response_deserialize(
2438
+ response_data=response_data,
2439
+ response_types_map=_response_types_map,
2440
+ ).data
2441
+
2442
+
2443
+ @validate_call
2444
+ async def get_bus_io_values_with_http_info(
2445
+ self,
2446
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
2447
+ ios: Optional[List[StrictStr]] = None,
2448
+ _request_timeout: Union[
2449
+ None,
2450
+ Annotated[StrictFloat, Field(gt=0)],
2451
+ Tuple[
2452
+ Annotated[StrictFloat, Field(gt=0)],
2453
+ Annotated[StrictFloat, Field(gt=0)]
2454
+ ]
2455
+ ] = None,
2456
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2457
+ _content_type: Optional[StrictStr] = None,
2458
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2459
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2460
+ ) -> ApiResponse[List[IOValue]]:
2461
+ """Get Input/Output Values
2462
+
2463
+ Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listBusIODescriptions](listBusIODescriptions).
2464
+
2465
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
2466
+ :type cell: str
2467
+ :param ios:
2468
+ :type ios: List[str]
2469
+ :param _request_timeout: timeout setting for this request. If one
2470
+ number provided, it will be total request
2471
+ timeout. It can also be a pair (tuple) of
2472
+ (connection, read) timeouts.
2473
+ :type _request_timeout: int, tuple(int, int), optional
2474
+ :param _request_auth: set to override the auth_settings for an a single
2475
+ request; this effectively ignores the
2476
+ authentication in the spec for a single request.
2477
+ :type _request_auth: dict, optional
2478
+ :param _content_type: force content-type for the request.
2479
+ :type _content_type: str, Optional
2480
+ :param _headers: set to override the headers for a single
2481
+ request; this effectively ignores the headers
2482
+ in the spec for a single request.
2483
+ :type _headers: dict, optional
2484
+ :param _host_index: set to override the host_index for a single
2485
+ request; this effectively ignores the host_index
2486
+ in the spec for a single request.
2487
+ :type _host_index: int, optional
2488
+ :return: Returns the result object.
2489
+ """ # noqa: E501
2490
+
2491
+ _param = self._get_bus_io_values_serialize(
2492
+ cell=cell,
2493
+ ios=ios,
2494
+ _request_auth=_request_auth,
2495
+ _content_type=_content_type,
2496
+ _headers=_headers,
2497
+ _host_index=_host_index
2498
+ )
2499
+
2500
+ _response_types_map: Dict[str, Optional[str]] = {
2501
+ '200': "List[IOValue]",
2502
+ '400': "Error",
2503
+ '404': "Error",
2504
+ }
2505
+
2506
+ response_data = await self.api_client.call_api(
2507
+ *_param,
2508
+ _request_timeout=_request_timeout
2509
+ )
2510
+ await response_data.read()
2511
+ return self.api_client.response_deserialize(
2512
+ response_data=response_data,
2513
+ response_types_map=_response_types_map,
2514
+ )
2515
+
2516
+
2517
+ @validate_call
2518
+ async def get_bus_io_values_without_preload_content(
2519
+ self,
2520
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
2521
+ ios: Optional[List[StrictStr]] = None,
2522
+ _request_timeout: Union[
2523
+ None,
2524
+ Annotated[StrictFloat, Field(gt=0)],
2525
+ Tuple[
2526
+ Annotated[StrictFloat, Field(gt=0)],
2527
+ Annotated[StrictFloat, Field(gt=0)]
2528
+ ]
2529
+ ] = None,
2530
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2531
+ _content_type: Optional[StrictStr] = None,
2532
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2533
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2534
+ ) -> RESTResponseType:
2535
+ """Get Input/Output Values
2536
+
2537
+ Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listBusIODescriptions](listBusIODescriptions).
2538
+
2539
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
2540
+ :type cell: str
2541
+ :param ios:
2542
+ :type ios: List[str]
2543
+ :param _request_timeout: timeout setting for this request. If one
2544
+ number provided, it will be total request
2545
+ timeout. It can also be a pair (tuple) of
2546
+ (connection, read) timeouts.
2547
+ :type _request_timeout: int, tuple(int, int), optional
2548
+ :param _request_auth: set to override the auth_settings for an a single
2549
+ request; this effectively ignores the
2550
+ authentication in the spec for a single request.
2551
+ :type _request_auth: dict, optional
2552
+ :param _content_type: force content-type for the request.
2553
+ :type _content_type: str, Optional
2554
+ :param _headers: set to override the headers for a single
2555
+ request; this effectively ignores the headers
2556
+ in the spec for a single request.
2557
+ :type _headers: dict, optional
2558
+ :param _host_index: set to override the host_index for a single
2559
+ request; this effectively ignores the host_index
2560
+ in the spec for a single request.
2561
+ :type _host_index: int, optional
2562
+ :return: Returns the result object.
2563
+ """ # noqa: E501
2564
+
2565
+ _param = self._get_bus_io_values_serialize(
2566
+ cell=cell,
2567
+ ios=ios,
2568
+ _request_auth=_request_auth,
2569
+ _content_type=_content_type,
2570
+ _headers=_headers,
2571
+ _host_index=_host_index
2572
+ )
2573
+
2574
+ _response_types_map: Dict[str, Optional[str]] = {
2575
+ '200': "List[IOValue]",
2576
+ '400': "Error",
2577
+ '404': "Error",
2578
+ }
2579
+
2580
+ response_data = await self.api_client.call_api(
2581
+ *_param,
2582
+ _request_timeout=_request_timeout
2583
+ )
2584
+ return response_data.response
2585
+
2586
+
2587
+ def _get_bus_io_values_serialize(
2588
+ self,
2589
+ cell,
2590
+ ios,
2591
+ _request_auth,
2592
+ _content_type,
2593
+ _headers,
2594
+ _host_index,
2595
+ ) -> RequestSerialized:
2596
+
2597
+ _host = None
2598
+
2599
+ _collection_formats: Dict[str, str] = {
2600
+ 'ios': 'multi',
2601
+ }
2602
+
2603
+ _path_params: Dict[str, str] = {}
2604
+ _query_params: List[Tuple[str, str]] = []
2605
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2606
+ _form_params: List[Tuple[str, str]] = []
2607
+ _files: Dict[str, Union[str, bytes]] = {}
2608
+ _body_params: Optional[bytes] = None
2609
+
2610
+ # process the path parameters
2611
+ if cell is not None:
2612
+ _path_params['cell'] = cell
2613
+ # process the query parameters
2614
+ if ios is not None:
2615
+
2616
+ _query_params.append(('ios', ios))
2617
+
2618
+ # process the header parameters
2619
+ # process the form parameters
2620
+ # process the body parameter
2621
+
2622
+
2623
+ # set the HTTP header `Accept`
2624
+ _header_params['Accept'] = self.api_client.select_header_accept(
2625
+ [
2626
+ 'application/json'
2627
+ ]
2628
+ )
2629
+
2630
+
2631
+ # authentication setting
2632
+ _auth_settings: List[str] = [
2633
+ 'BasicAuth',
2634
+ 'BearerAuth'
2635
+ ]
2636
+
2637
+ return self.api_client.param_serialize(
2638
+ method='GET',
2639
+ resource_path='/cells/{cell}/bus-ios/ios/values',
2640
+ path_params=_path_params,
2641
+ query_params=_query_params,
2642
+ header_params=_header_params,
2643
+ body=_body_params,
2644
+ post_params=_form_params,
2645
+ files=_files,
2646
+ auth_settings=_auth_settings,
2647
+ collection_formats=_collection_formats,
2648
+ _host=_host,
2649
+ _request_auth=_request_auth
2650
+ )
2651
+
2652
+
2653
+
2654
+ @validate_call
2655
+ async def get_profinet_description(
2656
+ self,
2657
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
2658
+ _request_timeout: Union[
2659
+ None,
2660
+ Annotated[StrictFloat, Field(gt=0)],
2661
+ Tuple[
2662
+ Annotated[StrictFloat, Field(gt=0)],
2663
+ Annotated[StrictFloat, Field(gt=0)]
2664
+ ]
2665
+ ] = None,
2666
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2667
+ _content_type: Optional[StrictStr] = None,
2668
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2669
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2670
+ ) -> ProfinetDescription:
2671
+ """Get PROFINET Description
2672
+
2673
+ Get description of NOVA as a PROFINET device.
2674
+
2675
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
2676
+ :type cell: str
2677
+ :param _request_timeout: timeout setting for this request. If one
2678
+ number provided, it will be total request
2679
+ timeout. It can also be a pair (tuple) of
2680
+ (connection, read) timeouts.
2681
+ :type _request_timeout: int, tuple(int, int), optional
2682
+ :param _request_auth: set to override the auth_settings for an a single
2683
+ request; this effectively ignores the
2684
+ authentication in the spec for a single request.
2685
+ :type _request_auth: dict, optional
2686
+ :param _content_type: force content-type for the request.
2687
+ :type _content_type: str, Optional
2688
+ :param _headers: set to override the headers for a single
2689
+ request; this effectively ignores the headers
2690
+ in the spec for a single request.
2691
+ :type _headers: dict, optional
2692
+ :param _host_index: set to override the host_index for a single
2693
+ request; this effectively ignores the host_index
2694
+ in the spec for a single request.
2695
+ :type _host_index: int, optional
2696
+ :return: Returns the result object.
2697
+ """ # noqa: E501
2698
+
2699
+ _param = self._get_profinet_description_serialize(
2700
+ cell=cell,
2701
+ _request_auth=_request_auth,
2702
+ _content_type=_content_type,
2703
+ _headers=_headers,
2704
+ _host_index=_host_index
2705
+ )
2706
+
2707
+ _response_types_map: Dict[str, Optional[str]] = {
2708
+ '200': "ProfinetDescription",
2709
+ '400': "Error",
2710
+ '404': "Error",
2711
+ }
2712
+
2713
+ response_data = await self.api_client.call_api(
2714
+ *_param,
2715
+ _request_timeout=_request_timeout
2716
+ )
2717
+ await response_data.read()
2718
+ return self.api_client.response_deserialize(
2719
+ response_data=response_data,
2720
+ response_types_map=_response_types_map,
2721
+ ).data
2722
+
2723
+
2724
+ @validate_call
2725
+ async def get_profinet_description_with_http_info(
2726
+ self,
2727
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
2728
+ _request_timeout: Union[
2729
+ None,
2730
+ Annotated[StrictFloat, Field(gt=0)],
2731
+ Tuple[
2732
+ Annotated[StrictFloat, Field(gt=0)],
2733
+ Annotated[StrictFloat, Field(gt=0)]
2734
+ ]
2735
+ ] = None,
2736
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2737
+ _content_type: Optional[StrictStr] = None,
2738
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2739
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2740
+ ) -> ApiResponse[ProfinetDescription]:
2741
+ """Get PROFINET Description
2742
+
2743
+ Get description of NOVA as a PROFINET device.
2744
+
2745
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
2746
+ :type cell: str
2747
+ :param _request_timeout: timeout setting for this request. If one
2748
+ number provided, it will be total request
2749
+ timeout. It can also be a pair (tuple) of
2750
+ (connection, read) timeouts.
2751
+ :type _request_timeout: int, tuple(int, int), optional
2752
+ :param _request_auth: set to override the auth_settings for an a single
2753
+ request; this effectively ignores the
2754
+ authentication in the spec for a single request.
2755
+ :type _request_auth: dict, optional
2756
+ :param _content_type: force content-type for the request.
2757
+ :type _content_type: str, Optional
2758
+ :param _headers: set to override the headers for a single
2759
+ request; this effectively ignores the headers
2760
+ in the spec for a single request.
2761
+ :type _headers: dict, optional
2762
+ :param _host_index: set to override the host_index for a single
2763
+ request; this effectively ignores the host_index
2764
+ in the spec for a single request.
2765
+ :type _host_index: int, optional
2766
+ :return: Returns the result object.
2767
+ """ # noqa: E501
2768
+
2769
+ _param = self._get_profinet_description_serialize(
2770
+ cell=cell,
2771
+ _request_auth=_request_auth,
2772
+ _content_type=_content_type,
2773
+ _headers=_headers,
2774
+ _host_index=_host_index
2775
+ )
2776
+
2777
+ _response_types_map: Dict[str, Optional[str]] = {
2778
+ '200': "ProfinetDescription",
2779
+ '400': "Error",
2780
+ '404': "Error",
2781
+ }
2782
+
2783
+ response_data = await self.api_client.call_api(
2784
+ *_param,
2785
+ _request_timeout=_request_timeout
2786
+ )
2787
+ await response_data.read()
2788
+ return self.api_client.response_deserialize(
2789
+ response_data=response_data,
2790
+ response_types_map=_response_types_map,
2791
+ )
2792
+
2793
+
2794
+ @validate_call
2795
+ async def get_profinet_description_without_preload_content(
2796
+ self,
2797
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
2798
+ _request_timeout: Union[
2799
+ None,
2800
+ Annotated[StrictFloat, Field(gt=0)],
2801
+ Tuple[
2802
+ Annotated[StrictFloat, Field(gt=0)],
2803
+ Annotated[StrictFloat, Field(gt=0)]
2804
+ ]
2805
+ ] = None,
2806
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2807
+ _content_type: Optional[StrictStr] = None,
2808
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2809
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2810
+ ) -> RESTResponseType:
2811
+ """Get PROFINET Description
2812
+
2813
+ Get description of NOVA as a PROFINET device.
2814
+
2815
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
2816
+ :type cell: str
2817
+ :param _request_timeout: timeout setting for this request. If one
2818
+ number provided, it will be total request
2819
+ timeout. It can also be a pair (tuple) of
2820
+ (connection, read) timeouts.
2821
+ :type _request_timeout: int, tuple(int, int), optional
2822
+ :param _request_auth: set to override the auth_settings for an a single
2823
+ request; this effectively ignores the
2824
+ authentication in the spec for a single request.
2825
+ :type _request_auth: dict, optional
2826
+ :param _content_type: force content-type for the request.
2827
+ :type _content_type: str, Optional
2828
+ :param _headers: set to override the headers for a single
2829
+ request; this effectively ignores the headers
2830
+ in the spec for a single request.
2831
+ :type _headers: dict, optional
2832
+ :param _host_index: set to override the host_index for a single
2833
+ request; this effectively ignores the host_index
2834
+ in the spec for a single request.
2835
+ :type _host_index: int, optional
2836
+ :return: Returns the result object.
2837
+ """ # noqa: E501
2838
+
2839
+ _param = self._get_profinet_description_serialize(
2840
+ cell=cell,
2841
+ _request_auth=_request_auth,
2842
+ _content_type=_content_type,
2843
+ _headers=_headers,
2844
+ _host_index=_host_index
2845
+ )
2846
+
2847
+ _response_types_map: Dict[str, Optional[str]] = {
2848
+ '200': "ProfinetDescription",
2849
+ '400': "Error",
2850
+ '404': "Error",
2851
+ }
2852
+
2853
+ response_data = await self.api_client.call_api(
2854
+ *_param,
2855
+ _request_timeout=_request_timeout
2856
+ )
2857
+ return response_data.response
2858
+
2859
+
2860
+ def _get_profinet_description_serialize(
2861
+ self,
2862
+ cell,
2863
+ _request_auth,
2864
+ _content_type,
2865
+ _headers,
2866
+ _host_index,
2867
+ ) -> RequestSerialized:
2868
+
2869
+ _host = None
2870
+
2871
+ _collection_formats: Dict[str, str] = {
2872
+ }
2873
+
2874
+ _path_params: Dict[str, str] = {}
2875
+ _query_params: List[Tuple[str, str]] = []
2876
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2877
+ _form_params: List[Tuple[str, str]] = []
2878
+ _files: Dict[str, Union[str, bytes]] = {}
2879
+ _body_params: Optional[bytes] = None
2880
+
2881
+ # process the path parameters
2882
+ if cell is not None:
2883
+ _path_params['cell'] = cell
2884
+ # process the query parameters
2885
+ # process the header parameters
2886
+ # process the form parameters
2887
+ # process the body parameter
2888
+
2889
+
2890
+ # set the HTTP header `Accept`
2891
+ _header_params['Accept'] = self.api_client.select_header_accept(
2892
+ [
2893
+ 'application/json'
2894
+ ]
2895
+ )
2896
+
2897
+
2898
+ # authentication setting
2899
+ _auth_settings: List[str] = [
2900
+ 'BasicAuth',
2901
+ 'BearerAuth'
2902
+ ]
2903
+
2904
+ return self.api_client.param_serialize(
2905
+ method='GET',
2906
+ resource_path='/cells/{cell}/bus-ios/profinet/description',
2907
+ path_params=_path_params,
2908
+ query_params=_query_params,
2909
+ header_params=_header_params,
2910
+ body=_body_params,
2911
+ post_params=_form_params,
2912
+ files=_files,
2913
+ auth_settings=_auth_settings,
2914
+ collection_formats=_collection_formats,
2915
+ _host=_host,
2916
+ _request_auth=_request_auth
2917
+ )
2918
+
2919
+
2920
+
2921
+ @validate_call
2922
+ async def get_profinet_ios_from_file(
2923
+ self,
2924
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
2925
+ input_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None,
2926
+ output_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None,
2927
+ _request_timeout: Union[
2928
+ None,
2929
+ Annotated[StrictFloat, Field(gt=0)],
2930
+ Tuple[
2931
+ Annotated[StrictFloat, Field(gt=0)],
2932
+ Annotated[StrictFloat, Field(gt=0)]
2933
+ ]
2934
+ ] = None,
2935
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2936
+ _content_type: Optional[StrictStr] = None,
2937
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2938
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2939
+ ) -> str:
2940
+ """PROFINET Inputs/Outputs to File
2941
+
2942
+ Get input/output variable configuration of the PROFINET device, e.g., NOVA's PROFINET service as file. You can specify byte offsets for the input and output variable addresses to get an XML tagmap that is ready to paste to the third party software, e.g., TIA portal.
2943
+
2944
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
2945
+ :type cell: str
2946
+ :param input_offset:
2947
+ :type input_offset: int
2948
+ :param output_offset:
2949
+ :type output_offset: int
2950
+ :param _request_timeout: timeout setting for this request. If one
2951
+ number provided, it will be total request
2952
+ timeout. It can also be a pair (tuple) of
2953
+ (connection, read) timeouts.
2954
+ :type _request_timeout: int, tuple(int, int), optional
2955
+ :param _request_auth: set to override the auth_settings for an a single
2956
+ request; this effectively ignores the
2957
+ authentication in the spec for a single request.
2958
+ :type _request_auth: dict, optional
2959
+ :param _content_type: force content-type for the request.
2960
+ :type _content_type: str, Optional
2961
+ :param _headers: set to override the headers for a single
2962
+ request; this effectively ignores the headers
2963
+ in the spec for a single request.
2964
+ :type _headers: dict, optional
2965
+ :param _host_index: set to override the host_index for a single
2966
+ request; this effectively ignores the host_index
2967
+ in the spec for a single request.
2968
+ :type _host_index: int, optional
2969
+ :return: Returns the result object.
2970
+ """ # noqa: E501
2971
+
2972
+ _param = self._get_profinet_ios_from_file_serialize(
2973
+ cell=cell,
2974
+ input_offset=input_offset,
2975
+ output_offset=output_offset,
2976
+ _request_auth=_request_auth,
2977
+ _content_type=_content_type,
2978
+ _headers=_headers,
2979
+ _host_index=_host_index
2980
+ )
2981
+
2982
+ _response_types_map: Dict[str, Optional[str]] = {
2983
+ '200': "str",
2984
+ '400': "Error",
2985
+ '404': "Error",
2986
+ }
2987
+
2988
+ response_data = await self.api_client.call_api(
2989
+ *_param,
2990
+ _request_timeout=_request_timeout
2991
+ )
2992
+ await response_data.read()
2993
+ return self.api_client.response_deserialize(
2994
+ response_data=response_data,
2995
+ response_types_map=_response_types_map,
2996
+ ).data
2997
+
2998
+
2999
+ @validate_call
3000
+ async def get_profinet_ios_from_file_with_http_info(
3001
+ self,
3002
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
3003
+ input_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None,
3004
+ output_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None,
3005
+ _request_timeout: Union[
3006
+ None,
3007
+ Annotated[StrictFloat, Field(gt=0)],
3008
+ Tuple[
3009
+ Annotated[StrictFloat, Field(gt=0)],
3010
+ Annotated[StrictFloat, Field(gt=0)]
3011
+ ]
3012
+ ] = None,
3013
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3014
+ _content_type: Optional[StrictStr] = None,
3015
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3016
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3017
+ ) -> ApiResponse[str]:
3018
+ """PROFINET Inputs/Outputs to File
3019
+
3020
+ Get input/output variable configuration of the PROFINET device, e.g., NOVA's PROFINET service as file. You can specify byte offsets for the input and output variable addresses to get an XML tagmap that is ready to paste to the third party software, e.g., TIA portal.
3021
+
3022
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
3023
+ :type cell: str
3024
+ :param input_offset:
3025
+ :type input_offset: int
3026
+ :param output_offset:
3027
+ :type output_offset: int
3028
+ :param _request_timeout: timeout setting for this request. If one
3029
+ number provided, it will be total request
3030
+ timeout. It can also be a pair (tuple) of
3031
+ (connection, read) timeouts.
3032
+ :type _request_timeout: int, tuple(int, int), optional
3033
+ :param _request_auth: set to override the auth_settings for an a single
3034
+ request; this effectively ignores the
3035
+ authentication in the spec for a single request.
3036
+ :type _request_auth: dict, optional
3037
+ :param _content_type: force content-type for the request.
3038
+ :type _content_type: str, Optional
3039
+ :param _headers: set to override the headers for a single
3040
+ request; this effectively ignores the headers
3041
+ in the spec for a single request.
3042
+ :type _headers: dict, optional
3043
+ :param _host_index: set to override the host_index for a single
3044
+ request; this effectively ignores the host_index
3045
+ in the spec for a single request.
3046
+ :type _host_index: int, optional
3047
+ :return: Returns the result object.
3048
+ """ # noqa: E501
3049
+
3050
+ _param = self._get_profinet_ios_from_file_serialize(
3051
+ cell=cell,
3052
+ input_offset=input_offset,
3053
+ output_offset=output_offset,
3054
+ _request_auth=_request_auth,
3055
+ _content_type=_content_type,
3056
+ _headers=_headers,
3057
+ _host_index=_host_index
3058
+ )
3059
+
3060
+ _response_types_map: Dict[str, Optional[str]] = {
3061
+ '200': "str",
3062
+ '400': "Error",
3063
+ '404': "Error",
3064
+ }
3065
+
3066
+ response_data = await self.api_client.call_api(
3067
+ *_param,
3068
+ _request_timeout=_request_timeout
3069
+ )
3070
+ await response_data.read()
3071
+ return self.api_client.response_deserialize(
3072
+ response_data=response_data,
3073
+ response_types_map=_response_types_map,
3074
+ )
3075
+
3076
+
3077
+ @validate_call
3078
+ async def get_profinet_ios_from_file_without_preload_content(
3079
+ self,
3080
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
3081
+ input_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None,
3082
+ output_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None,
3083
+ _request_timeout: Union[
3084
+ None,
3085
+ Annotated[StrictFloat, Field(gt=0)],
3086
+ Tuple[
3087
+ Annotated[StrictFloat, Field(gt=0)],
3088
+ Annotated[StrictFloat, Field(gt=0)]
3089
+ ]
3090
+ ] = None,
3091
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3092
+ _content_type: Optional[StrictStr] = None,
3093
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3094
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3095
+ ) -> RESTResponseType:
3096
+ """PROFINET Inputs/Outputs to File
3097
+
3098
+ Get input/output variable configuration of the PROFINET device, e.g., NOVA's PROFINET service as file. You can specify byte offsets for the input and output variable addresses to get an XML tagmap that is ready to paste to the third party software, e.g., TIA portal.
3099
+
3100
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
3101
+ :type cell: str
3102
+ :param input_offset:
3103
+ :type input_offset: int
3104
+ :param output_offset:
3105
+ :type output_offset: int
3106
+ :param _request_timeout: timeout setting for this request. If one
3107
+ number provided, it will be total request
3108
+ timeout. It can also be a pair (tuple) of
3109
+ (connection, read) timeouts.
3110
+ :type _request_timeout: int, tuple(int, int), optional
3111
+ :param _request_auth: set to override the auth_settings for an a single
3112
+ request; this effectively ignores the
3113
+ authentication in the spec for a single request.
3114
+ :type _request_auth: dict, optional
3115
+ :param _content_type: force content-type for the request.
3116
+ :type _content_type: str, Optional
3117
+ :param _headers: set to override the headers for a single
3118
+ request; this effectively ignores the headers
3119
+ in the spec for a single request.
3120
+ :type _headers: dict, optional
3121
+ :param _host_index: set to override the host_index for a single
3122
+ request; this effectively ignores the host_index
3123
+ in the spec for a single request.
3124
+ :type _host_index: int, optional
3125
+ :return: Returns the result object.
3126
+ """ # noqa: E501
3127
+
3128
+ _param = self._get_profinet_ios_from_file_serialize(
3129
+ cell=cell,
3130
+ input_offset=input_offset,
3131
+ output_offset=output_offset,
3132
+ _request_auth=_request_auth,
3133
+ _content_type=_content_type,
3134
+ _headers=_headers,
3135
+ _host_index=_host_index
3136
+ )
3137
+
3138
+ _response_types_map: Dict[str, Optional[str]] = {
3139
+ '200': "str",
3140
+ '400': "Error",
3141
+ '404': "Error",
3142
+ }
3143
+
3144
+ response_data = await self.api_client.call_api(
3145
+ *_param,
3146
+ _request_timeout=_request_timeout
3147
+ )
3148
+ return response_data.response
3149
+
3150
+
3151
+ def _get_profinet_ios_from_file_serialize(
3152
+ self,
3153
+ cell,
3154
+ input_offset,
3155
+ output_offset,
3156
+ _request_auth,
3157
+ _content_type,
3158
+ _headers,
3159
+ _host_index,
3160
+ ) -> RequestSerialized:
3161
+
3162
+ _host = None
3163
+
3164
+ _collection_formats: Dict[str, str] = {
3165
+ }
3166
+
3167
+ _path_params: Dict[str, str] = {}
3168
+ _query_params: List[Tuple[str, str]] = []
3169
+ _header_params: Dict[str, Optional[str]] = _headers or {}
3170
+ _form_params: List[Tuple[str, str]] = []
3171
+ _files: Dict[str, Union[str, bytes]] = {}
3172
+ _body_params: Optional[bytes] = None
3173
+
3174
+ # process the path parameters
3175
+ if cell is not None:
3176
+ _path_params['cell'] = cell
3177
+ # process the query parameters
3178
+ if input_offset is not None:
3179
+
3180
+ _query_params.append(('input_offset', input_offset))
3181
+
3182
+ if output_offset is not None:
3183
+
3184
+ _query_params.append(('output_offset', output_offset))
3185
+
3186
+ # process the header parameters
3187
+ # process the form parameters
3188
+ # process the body parameter
3189
+
3190
+
3191
+ # set the HTTP header `Accept`
3192
+ _header_params['Accept'] = self.api_client.select_header_accept(
3193
+ [
3194
+ 'application/json'
3195
+ ]
3196
+ )
3197
+
3198
+
3199
+ # authentication setting
3200
+ _auth_settings: List[str] = [
3201
+ 'BasicAuth',
3202
+ 'BearerAuth'
3203
+ ]
3204
+
3205
+ return self.api_client.param_serialize(
3206
+ method='GET',
3207
+ resource_path='/cells/{cell}/bus-ios/profinet/iofile',
3208
+ path_params=_path_params,
3209
+ query_params=_query_params,
3210
+ header_params=_header_params,
3211
+ body=_body_params,
3212
+ post_params=_form_params,
3213
+ files=_files,
3214
+ auth_settings=_auth_settings,
3215
+ collection_formats=_collection_formats,
3216
+ _host=_host,
3217
+ _request_auth=_request_auth
3218
+ )
3219
+
3220
+
3221
+
3222
+ @validate_call
3223
+ async def list_bus_io_descriptions(
3224
+ self,
3225
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
3226
+ _request_timeout: Union[
3227
+ None,
3228
+ Annotated[StrictFloat, Field(gt=0)],
3229
+ Tuple[
3230
+ Annotated[StrictFloat, Field(gt=0)],
3231
+ Annotated[StrictFloat, Field(gt=0)]
3232
+ ]
3233
+ ] = None,
3234
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3235
+ _content_type: Optional[StrictStr] = None,
3236
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3237
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3238
+ ) -> List[BusIODescription]:
3239
+ """List Descriptions
3240
+
3241
+ List all input/output descriptions for configured BUS services. The input/output descriptions contain information like name, type and unit. The input/output direction is given in perspective of the BUS service.
3242
+
3243
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
3244
+ :type cell: str
3245
+ :param _request_timeout: timeout setting for this request. If one
3246
+ number provided, it will be total request
3247
+ timeout. It can also be a pair (tuple) of
3248
+ (connection, read) timeouts.
3249
+ :type _request_timeout: int, tuple(int, int), optional
3250
+ :param _request_auth: set to override the auth_settings for an a single
3251
+ request; this effectively ignores the
3252
+ authentication in the spec for a single request.
3253
+ :type _request_auth: dict, optional
3254
+ :param _content_type: force content-type for the request.
3255
+ :type _content_type: str, Optional
3256
+ :param _headers: set to override the headers for a single
3257
+ request; this effectively ignores the headers
3258
+ in the spec for a single request.
3259
+ :type _headers: dict, optional
3260
+ :param _host_index: set to override the host_index for a single
3261
+ request; this effectively ignores the host_index
3262
+ in the spec for a single request.
3263
+ :type _host_index: int, optional
3264
+ :return: Returns the result object.
3265
+ """ # noqa: E501
3266
+
3267
+ _param = self._list_bus_io_descriptions_serialize(
3268
+ cell=cell,
3269
+ _request_auth=_request_auth,
3270
+ _content_type=_content_type,
3271
+ _headers=_headers,
3272
+ _host_index=_host_index
3273
+ )
3274
+
3275
+ _response_types_map: Dict[str, Optional[str]] = {
3276
+ '200': "List[BusIODescription]",
3277
+ '404': "Error",
3278
+ }
3279
+
3280
+ response_data = await self.api_client.call_api(
3281
+ *_param,
3282
+ _request_timeout=_request_timeout
3283
+ )
3284
+ await response_data.read()
3285
+ return self.api_client.response_deserialize(
3286
+ response_data=response_data,
3287
+ response_types_map=_response_types_map,
3288
+ ).data
3289
+
3290
+
3291
+ @validate_call
3292
+ async def list_bus_io_descriptions_with_http_info(
3293
+ self,
3294
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
3295
+ _request_timeout: Union[
3296
+ None,
3297
+ Annotated[StrictFloat, Field(gt=0)],
3298
+ Tuple[
3299
+ Annotated[StrictFloat, Field(gt=0)],
3300
+ Annotated[StrictFloat, Field(gt=0)]
3301
+ ]
3302
+ ] = None,
3303
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3304
+ _content_type: Optional[StrictStr] = None,
3305
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3306
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3307
+ ) -> ApiResponse[List[BusIODescription]]:
3308
+ """List Descriptions
3309
+
3310
+ List all input/output descriptions for configured BUS services. The input/output descriptions contain information like name, type and unit. The input/output direction is given in perspective of the BUS service.
3311
+
3312
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
3313
+ :type cell: str
3314
+ :param _request_timeout: timeout setting for this request. If one
3315
+ number provided, it will be total request
3316
+ timeout. It can also be a pair (tuple) of
3317
+ (connection, read) timeouts.
3318
+ :type _request_timeout: int, tuple(int, int), optional
3319
+ :param _request_auth: set to override the auth_settings for an a single
3320
+ request; this effectively ignores the
3321
+ authentication in the spec for a single request.
3322
+ :type _request_auth: dict, optional
3323
+ :param _content_type: force content-type for the request.
3324
+ :type _content_type: str, Optional
3325
+ :param _headers: set to override the headers for a single
3326
+ request; this effectively ignores the headers
3327
+ in the spec for a single request.
3328
+ :type _headers: dict, optional
3329
+ :param _host_index: set to override the host_index for a single
3330
+ request; this effectively ignores the host_index
3331
+ in the spec for a single request.
3332
+ :type _host_index: int, optional
3333
+ :return: Returns the result object.
3334
+ """ # noqa: E501
3335
+
3336
+ _param = self._list_bus_io_descriptions_serialize(
3337
+ cell=cell,
3338
+ _request_auth=_request_auth,
3339
+ _content_type=_content_type,
3340
+ _headers=_headers,
3341
+ _host_index=_host_index
3342
+ )
3343
+
3344
+ _response_types_map: Dict[str, Optional[str]] = {
3345
+ '200': "List[BusIODescription]",
3346
+ '404': "Error",
3347
+ }
3348
+
3349
+ response_data = await self.api_client.call_api(
3350
+ *_param,
3351
+ _request_timeout=_request_timeout
3352
+ )
3353
+ await response_data.read()
3354
+ return self.api_client.response_deserialize(
3355
+ response_data=response_data,
3356
+ response_types_map=_response_types_map,
3357
+ )
3358
+
3359
+
3360
+ @validate_call
3361
+ async def list_bus_io_descriptions_without_preload_content(
3362
+ self,
3363
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
3364
+ _request_timeout: Union[
3365
+ None,
3366
+ Annotated[StrictFloat, Field(gt=0)],
3367
+ Tuple[
3368
+ Annotated[StrictFloat, Field(gt=0)],
3369
+ Annotated[StrictFloat, Field(gt=0)]
3370
+ ]
3371
+ ] = None,
3372
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3373
+ _content_type: Optional[StrictStr] = None,
3374
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3375
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3376
+ ) -> RESTResponseType:
3377
+ """List Descriptions
3378
+
3379
+ List all input/output descriptions for configured BUS services. The input/output descriptions contain information like name, type and unit. The input/output direction is given in perspective of the BUS service.
3380
+
3381
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
3382
+ :type cell: str
3383
+ :param _request_timeout: timeout setting for this request. If one
3384
+ number provided, it will be total request
3385
+ timeout. It can also be a pair (tuple) of
3386
+ (connection, read) timeouts.
3387
+ :type _request_timeout: int, tuple(int, int), optional
3388
+ :param _request_auth: set to override the auth_settings for an a single
3389
+ request; this effectively ignores the
3390
+ authentication in the spec for a single request.
3391
+ :type _request_auth: dict, optional
3392
+ :param _content_type: force content-type for the request.
3393
+ :type _content_type: str, Optional
3394
+ :param _headers: set to override the headers for a single
3395
+ request; this effectively ignores the headers
3396
+ in the spec for a single request.
3397
+ :type _headers: dict, optional
3398
+ :param _host_index: set to override the host_index for a single
3399
+ request; this effectively ignores the host_index
3400
+ in the spec for a single request.
3401
+ :type _host_index: int, optional
3402
+ :return: Returns the result object.
3403
+ """ # noqa: E501
3404
+
3405
+ _param = self._list_bus_io_descriptions_serialize(
3406
+ cell=cell,
3407
+ _request_auth=_request_auth,
3408
+ _content_type=_content_type,
3409
+ _headers=_headers,
3410
+ _host_index=_host_index
3411
+ )
3412
+
3413
+ _response_types_map: Dict[str, Optional[str]] = {
3414
+ '200': "List[BusIODescription]",
3415
+ '404': "Error",
3416
+ }
3417
+
3418
+ response_data = await self.api_client.call_api(
3419
+ *_param,
3420
+ _request_timeout=_request_timeout
3421
+ )
3422
+ return response_data.response
3423
+
3424
+
3425
+ def _list_bus_io_descriptions_serialize(
3426
+ self,
3427
+ cell,
3428
+ _request_auth,
3429
+ _content_type,
3430
+ _headers,
3431
+ _host_index,
3432
+ ) -> RequestSerialized:
3433
+
3434
+ _host = None
3435
+
3436
+ _collection_formats: Dict[str, str] = {
3437
+ }
3438
+
3439
+ _path_params: Dict[str, str] = {}
3440
+ _query_params: List[Tuple[str, str]] = []
3441
+ _header_params: Dict[str, Optional[str]] = _headers or {}
3442
+ _form_params: List[Tuple[str, str]] = []
3443
+ _files: Dict[str, Union[str, bytes]] = {}
3444
+ _body_params: Optional[bytes] = None
3445
+
3446
+ # process the path parameters
3447
+ if cell is not None:
3448
+ _path_params['cell'] = cell
3449
+ # process the query parameters
3450
+ # process the header parameters
3451
+ # process the form parameters
3452
+ # process the body parameter
3453
+
3454
+
3455
+ # set the HTTP header `Accept`
3456
+ _header_params['Accept'] = self.api_client.select_header_accept(
3457
+ [
3458
+ 'application/json'
3459
+ ]
3460
+ )
3461
+
3462
+
3463
+ # authentication setting
3464
+ _auth_settings: List[str] = [
3465
+ 'BasicAuth',
3466
+ 'BearerAuth'
3467
+ ]
3468
+
3469
+ return self.api_client.param_serialize(
3470
+ method='GET',
3471
+ resource_path='/cells/{cell}/bus-ios/ios/description',
3472
+ path_params=_path_params,
3473
+ query_params=_query_params,
3474
+ header_params=_header_params,
3475
+ body=_body_params,
3476
+ post_params=_form_params,
3477
+ files=_files,
3478
+ auth_settings=_auth_settings,
3479
+ collection_formats=_collection_formats,
3480
+ _host=_host,
3481
+ _request_auth=_request_auth
3482
+ )
3483
+
3484
+
3485
+
3486
+ @validate_call
3487
+ async def list_modbus_ios(
3488
+ self,
3489
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
3490
+ _request_timeout: Union[
3491
+ None,
3492
+ Annotated[StrictFloat, Field(gt=0)],
3493
+ Tuple[
3494
+ Annotated[StrictFloat, Field(gt=0)],
3495
+ Annotated[StrictFloat, Field(gt=0)]
3496
+ ]
3497
+ ] = None,
3498
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3499
+ _content_type: Optional[StrictStr] = None,
3500
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3501
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3502
+ ) -> List[ModbusIO]:
3503
+ """List MODBUS Input/Output Configuration
3504
+
3505
+ List descriptions for all configured input/output variables of the MODBUS service. The input/output descriptions contain information like name, type and address. The input/output direction is given in perspective of the active MODBUS type (service or client). - The byte and bit addresses are the locations in the MODBUS input/output process image the variable points to. - The MODBUS controller as well as NOVA's MODBUS service use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA MODBUS service's configuration is modified via [addModbusIO](addModbusIO).
3506
+
3507
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
3508
+ :type cell: str
3509
+ :param _request_timeout: timeout setting for this request. If one
3510
+ number provided, it will be total request
3511
+ timeout. It can also be a pair (tuple) of
3512
+ (connection, read) timeouts.
3513
+ :type _request_timeout: int, tuple(int, int), optional
3514
+ :param _request_auth: set to override the auth_settings for an a single
3515
+ request; this effectively ignores the
3516
+ authentication in the spec for a single request.
3517
+ :type _request_auth: dict, optional
3518
+ :param _content_type: force content-type for the request.
3519
+ :type _content_type: str, Optional
3520
+ :param _headers: set to override the headers for a single
3521
+ request; this effectively ignores the headers
3522
+ in the spec for a single request.
3523
+ :type _headers: dict, optional
3524
+ :param _host_index: set to override the host_index for a single
3525
+ request; this effectively ignores the host_index
3526
+ in the spec for a single request.
3527
+ :type _host_index: int, optional
3528
+ :return: Returns the result object.
3529
+ """ # noqa: E501
3530
+
3531
+ _param = self._list_modbus_ios_serialize(
3532
+ cell=cell,
3533
+ _request_auth=_request_auth,
3534
+ _content_type=_content_type,
3535
+ _headers=_headers,
3536
+ _host_index=_host_index
3537
+ )
3538
+
3539
+ _response_types_map: Dict[str, Optional[str]] = {
3540
+ '200': "List[ModbusIO]",
3541
+ '404': "Error",
3542
+ }
3543
+
3544
+ response_data = await self.api_client.call_api(
3545
+ *_param,
3546
+ _request_timeout=_request_timeout
3547
+ )
3548
+ await response_data.read()
3549
+ return self.api_client.response_deserialize(
3550
+ response_data=response_data,
3551
+ response_types_map=_response_types_map,
3552
+ ).data
3553
+
3554
+
3555
+ @validate_call
3556
+ async def list_modbus_ios_with_http_info(
3557
+ self,
3558
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
3559
+ _request_timeout: Union[
3560
+ None,
3561
+ Annotated[StrictFloat, Field(gt=0)],
3562
+ Tuple[
3563
+ Annotated[StrictFloat, Field(gt=0)],
3564
+ Annotated[StrictFloat, Field(gt=0)]
3565
+ ]
3566
+ ] = None,
3567
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3568
+ _content_type: Optional[StrictStr] = None,
3569
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3570
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3571
+ ) -> ApiResponse[List[ModbusIO]]:
3572
+ """List MODBUS Input/Output Configuration
3573
+
3574
+ List descriptions for all configured input/output variables of the MODBUS service. The input/output descriptions contain information like name, type and address. The input/output direction is given in perspective of the active MODBUS type (service or client). - The byte and bit addresses are the locations in the MODBUS input/output process image the variable points to. - The MODBUS controller as well as NOVA's MODBUS service use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA MODBUS service's configuration is modified via [addModbusIO](addModbusIO).
3575
+
3576
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
3577
+ :type cell: str
3578
+ :param _request_timeout: timeout setting for this request. If one
3579
+ number provided, it will be total request
3580
+ timeout. It can also be a pair (tuple) of
3581
+ (connection, read) timeouts.
3582
+ :type _request_timeout: int, tuple(int, int), optional
3583
+ :param _request_auth: set to override the auth_settings for an a single
3584
+ request; this effectively ignores the
3585
+ authentication in the spec for a single request.
3586
+ :type _request_auth: dict, optional
3587
+ :param _content_type: force content-type for the request.
3588
+ :type _content_type: str, Optional
3589
+ :param _headers: set to override the headers for a single
3590
+ request; this effectively ignores the headers
3591
+ in the spec for a single request.
3592
+ :type _headers: dict, optional
3593
+ :param _host_index: set to override the host_index for a single
3594
+ request; this effectively ignores the host_index
3595
+ in the spec for a single request.
3596
+ :type _host_index: int, optional
3597
+ :return: Returns the result object.
3598
+ """ # noqa: E501
3599
+
3600
+ _param = self._list_modbus_ios_serialize(
3601
+ cell=cell,
3602
+ _request_auth=_request_auth,
3603
+ _content_type=_content_type,
3604
+ _headers=_headers,
3605
+ _host_index=_host_index
3606
+ )
3607
+
3608
+ _response_types_map: Dict[str, Optional[str]] = {
3609
+ '200': "List[ModbusIO]",
3610
+ '404': "Error",
3611
+ }
3612
+
3613
+ response_data = await self.api_client.call_api(
3614
+ *_param,
3615
+ _request_timeout=_request_timeout
3616
+ )
3617
+ await response_data.read()
3618
+ return self.api_client.response_deserialize(
3619
+ response_data=response_data,
3620
+ response_types_map=_response_types_map,
3621
+ )
3622
+
3623
+
3624
+ @validate_call
3625
+ async def list_modbus_ios_without_preload_content(
3626
+ self,
3627
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
3628
+ _request_timeout: Union[
3629
+ None,
3630
+ Annotated[StrictFloat, Field(gt=0)],
3631
+ Tuple[
3632
+ Annotated[StrictFloat, Field(gt=0)],
3633
+ Annotated[StrictFloat, Field(gt=0)]
3634
+ ]
3635
+ ] = None,
3636
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3637
+ _content_type: Optional[StrictStr] = None,
3638
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3639
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3640
+ ) -> RESTResponseType:
3641
+ """List MODBUS Input/Output Configuration
3642
+
3643
+ List descriptions for all configured input/output variables of the MODBUS service. The input/output descriptions contain information like name, type and address. The input/output direction is given in perspective of the active MODBUS type (service or client). - The byte and bit addresses are the locations in the MODBUS input/output process image the variable points to. - The MODBUS controller as well as NOVA's MODBUS service use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA MODBUS service's configuration is modified via [addModbusIO](addModbusIO).
3644
+
3645
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
3646
+ :type cell: str
3647
+ :param _request_timeout: timeout setting for this request. If one
3648
+ number provided, it will be total request
3649
+ timeout. It can also be a pair (tuple) of
3650
+ (connection, read) timeouts.
3651
+ :type _request_timeout: int, tuple(int, int), optional
3652
+ :param _request_auth: set to override the auth_settings for an a single
3653
+ request; this effectively ignores the
3654
+ authentication in the spec for a single request.
3655
+ :type _request_auth: dict, optional
3656
+ :param _content_type: force content-type for the request.
3657
+ :type _content_type: str, Optional
3658
+ :param _headers: set to override the headers for a single
3659
+ request; this effectively ignores the headers
3660
+ in the spec for a single request.
3661
+ :type _headers: dict, optional
3662
+ :param _host_index: set to override the host_index for a single
3663
+ request; this effectively ignores the host_index
3664
+ in the spec for a single request.
3665
+ :type _host_index: int, optional
3666
+ :return: Returns the result object.
3667
+ """ # noqa: E501
3668
+
3669
+ _param = self._list_modbus_ios_serialize(
3670
+ cell=cell,
3671
+ _request_auth=_request_auth,
3672
+ _content_type=_content_type,
3673
+ _headers=_headers,
3674
+ _host_index=_host_index
3675
+ )
3676
+
3677
+ _response_types_map: Dict[str, Optional[str]] = {
3678
+ '200': "List[ModbusIO]",
3679
+ '404': "Error",
3680
+ }
3681
+
3682
+ response_data = await self.api_client.call_api(
3683
+ *_param,
3684
+ _request_timeout=_request_timeout
3685
+ )
3686
+ return response_data.response
3687
+
3688
+
3689
+ def _list_modbus_ios_serialize(
3690
+ self,
3691
+ cell,
3692
+ _request_auth,
3693
+ _content_type,
3694
+ _headers,
3695
+ _host_index,
3696
+ ) -> RequestSerialized:
3697
+
3698
+ _host = None
3699
+
3700
+ _collection_formats: Dict[str, str] = {
3701
+ }
3702
+
3703
+ _path_params: Dict[str, str] = {}
3704
+ _query_params: List[Tuple[str, str]] = []
3705
+ _header_params: Dict[str, Optional[str]] = _headers or {}
3706
+ _form_params: List[Tuple[str, str]] = []
3707
+ _files: Dict[str, Union[str, bytes]] = {}
3708
+ _body_params: Optional[bytes] = None
3709
+
3710
+ # process the path parameters
3711
+ if cell is not None:
3712
+ _path_params['cell'] = cell
3713
+ # process the query parameters
3714
+ # process the header parameters
3715
+ # process the form parameters
3716
+ # process the body parameter
3717
+
3718
+
3719
+ # set the HTTP header `Accept`
3720
+ _header_params['Accept'] = self.api_client.select_header_accept(
3721
+ [
3722
+ 'application/json'
3723
+ ]
3724
+ )
3725
+
3726
+
3727
+ # authentication setting
3728
+ _auth_settings: List[str] = [
3729
+ 'BasicAuth',
3730
+ 'BearerAuth'
3731
+ ]
3732
+
3733
+ return self.api_client.param_serialize(
3734
+ method='GET',
3735
+ resource_path='/cells/{cell}/bus-ios/modbus/ios',
3736
+ path_params=_path_params,
3737
+ query_params=_query_params,
3738
+ header_params=_header_params,
3739
+ body=_body_params,
3740
+ post_params=_form_params,
3741
+ files=_files,
3742
+ auth_settings=_auth_settings,
3743
+ collection_formats=_collection_formats,
3744
+ _host=_host,
3745
+ _request_auth=_request_auth
3746
+ )
3747
+
3748
+
3749
+
3750
+ @validate_call
3751
+ async def list_profinet_ios(
3752
+ self,
3753
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
3754
+ _request_timeout: Union[
3755
+ None,
3756
+ Annotated[StrictFloat, Field(gt=0)],
3757
+ Tuple[
3758
+ Annotated[StrictFloat, Field(gt=0)],
3759
+ Annotated[StrictFloat, Field(gt=0)]
3760
+ ]
3761
+ ] = None,
3762
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3763
+ _content_type: Optional[StrictStr] = None,
3764
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3765
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3766
+ ) -> List[ProfinetIO]:
3767
+ """List PROFINET Input/Output Configuration
3768
+
3769
+ List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information like name, type and unit. The input/output direction is given in perspective of the PROFINET device, e.g., the configured PROFINET service. - The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. - The PROFINET controller as well as NOVA's PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA PROFINET service's configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal.
3770
+
3771
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
3772
+ :type cell: str
3773
+ :param _request_timeout: timeout setting for this request. If one
3774
+ number provided, it will be total request
3775
+ timeout. It can also be a pair (tuple) of
3776
+ (connection, read) timeouts.
3777
+ :type _request_timeout: int, tuple(int, int), optional
3778
+ :param _request_auth: set to override the auth_settings for an a single
3779
+ request; this effectively ignores the
3780
+ authentication in the spec for a single request.
3781
+ :type _request_auth: dict, optional
3782
+ :param _content_type: force content-type for the request.
3783
+ :type _content_type: str, Optional
3784
+ :param _headers: set to override the headers for a single
3785
+ request; this effectively ignores the headers
3786
+ in the spec for a single request.
3787
+ :type _headers: dict, optional
3788
+ :param _host_index: set to override the host_index for a single
3789
+ request; this effectively ignores the host_index
3790
+ in the spec for a single request.
3791
+ :type _host_index: int, optional
3792
+ :return: Returns the result object.
3793
+ """ # noqa: E501
3794
+
3795
+ _param = self._list_profinet_ios_serialize(
3796
+ cell=cell,
3797
+ _request_auth=_request_auth,
3798
+ _content_type=_content_type,
3799
+ _headers=_headers,
3800
+ _host_index=_host_index
3801
+ )
3802
+
3803
+ _response_types_map: Dict[str, Optional[str]] = {
3804
+ '200': "List[ProfinetIO]",
3805
+ '404': "Error",
3806
+ }
3807
+
3808
+ response_data = await self.api_client.call_api(
3809
+ *_param,
3810
+ _request_timeout=_request_timeout
3811
+ )
3812
+ await response_data.read()
3813
+ return self.api_client.response_deserialize(
3814
+ response_data=response_data,
3815
+ response_types_map=_response_types_map,
3816
+ ).data
3817
+
3818
+
3819
+ @validate_call
3820
+ async def list_profinet_ios_with_http_info(
3821
+ self,
3822
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
3823
+ _request_timeout: Union[
3824
+ None,
3825
+ Annotated[StrictFloat, Field(gt=0)],
3826
+ Tuple[
3827
+ Annotated[StrictFloat, Field(gt=0)],
3828
+ Annotated[StrictFloat, Field(gt=0)]
3829
+ ]
3830
+ ] = None,
3831
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3832
+ _content_type: Optional[StrictStr] = None,
3833
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3834
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3835
+ ) -> ApiResponse[List[ProfinetIO]]:
3836
+ """List PROFINET Input/Output Configuration
3837
+
3838
+ List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information like name, type and unit. The input/output direction is given in perspective of the PROFINET device, e.g., the configured PROFINET service. - The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. - The PROFINET controller as well as NOVA's PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA PROFINET service's configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal.
3839
+
3840
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
3841
+ :type cell: str
3842
+ :param _request_timeout: timeout setting for this request. If one
3843
+ number provided, it will be total request
3844
+ timeout. It can also be a pair (tuple) of
3845
+ (connection, read) timeouts.
3846
+ :type _request_timeout: int, tuple(int, int), optional
3847
+ :param _request_auth: set to override the auth_settings for an a single
3848
+ request; this effectively ignores the
3849
+ authentication in the spec for a single request.
3850
+ :type _request_auth: dict, optional
3851
+ :param _content_type: force content-type for the request.
3852
+ :type _content_type: str, Optional
3853
+ :param _headers: set to override the headers for a single
3854
+ request; this effectively ignores the headers
3855
+ in the spec for a single request.
3856
+ :type _headers: dict, optional
3857
+ :param _host_index: set to override the host_index for a single
3858
+ request; this effectively ignores the host_index
3859
+ in the spec for a single request.
3860
+ :type _host_index: int, optional
3861
+ :return: Returns the result object.
3862
+ """ # noqa: E501
3863
+
3864
+ _param = self._list_profinet_ios_serialize(
3865
+ cell=cell,
3866
+ _request_auth=_request_auth,
3867
+ _content_type=_content_type,
3868
+ _headers=_headers,
3869
+ _host_index=_host_index
3870
+ )
3871
+
3872
+ _response_types_map: Dict[str, Optional[str]] = {
3873
+ '200': "List[ProfinetIO]",
3874
+ '404': "Error",
3875
+ }
3876
+
3877
+ response_data = await self.api_client.call_api(
3878
+ *_param,
3879
+ _request_timeout=_request_timeout
3880
+ )
3881
+ await response_data.read()
3882
+ return self.api_client.response_deserialize(
3883
+ response_data=response_data,
3884
+ response_types_map=_response_types_map,
3885
+ )
3886
+
3887
+
3888
+ @validate_call
3889
+ async def list_profinet_ios_without_preload_content(
3890
+ self,
3891
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
3892
+ _request_timeout: Union[
3893
+ None,
3894
+ Annotated[StrictFloat, Field(gt=0)],
3895
+ Tuple[
3896
+ Annotated[StrictFloat, Field(gt=0)],
3897
+ Annotated[StrictFloat, Field(gt=0)]
3898
+ ]
3899
+ ] = None,
3900
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3901
+ _content_type: Optional[StrictStr] = None,
3902
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3903
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3904
+ ) -> RESTResponseType:
3905
+ """List PROFINET Input/Output Configuration
3906
+
3907
+ List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information like name, type and unit. The input/output direction is given in perspective of the PROFINET device, e.g., the configured PROFINET service. - The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. - The PROFINET controller as well as NOVA's PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA PROFINET service's configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal.
3908
+
3909
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
3910
+ :type cell: str
3911
+ :param _request_timeout: timeout setting for this request. If one
3912
+ number provided, it will be total request
3913
+ timeout. It can also be a pair (tuple) of
3914
+ (connection, read) timeouts.
3915
+ :type _request_timeout: int, tuple(int, int), optional
3916
+ :param _request_auth: set to override the auth_settings for an a single
3917
+ request; this effectively ignores the
3918
+ authentication in the spec for a single request.
3919
+ :type _request_auth: dict, optional
3920
+ :param _content_type: force content-type for the request.
3921
+ :type _content_type: str, Optional
3922
+ :param _headers: set to override the headers for a single
3923
+ request; this effectively ignores the headers
3924
+ in the spec for a single request.
3925
+ :type _headers: dict, optional
3926
+ :param _host_index: set to override the host_index for a single
3927
+ request; this effectively ignores the host_index
3928
+ in the spec for a single request.
3929
+ :type _host_index: int, optional
3930
+ :return: Returns the result object.
3931
+ """ # noqa: E501
3932
+
3933
+ _param = self._list_profinet_ios_serialize(
3934
+ cell=cell,
3935
+ _request_auth=_request_auth,
3936
+ _content_type=_content_type,
3937
+ _headers=_headers,
3938
+ _host_index=_host_index
3939
+ )
3940
+
3941
+ _response_types_map: Dict[str, Optional[str]] = {
3942
+ '200': "List[ProfinetIO]",
3943
+ '404': "Error",
3944
+ }
3945
+
3946
+ response_data = await self.api_client.call_api(
3947
+ *_param,
3948
+ _request_timeout=_request_timeout
3949
+ )
3950
+ return response_data.response
3951
+
3952
+
3953
+ def _list_profinet_ios_serialize(
3954
+ self,
3955
+ cell,
3956
+ _request_auth,
3957
+ _content_type,
3958
+ _headers,
3959
+ _host_index,
3960
+ ) -> RequestSerialized:
3961
+
3962
+ _host = None
3963
+
3964
+ _collection_formats: Dict[str, str] = {
3965
+ }
3966
+
3967
+ _path_params: Dict[str, str] = {}
3968
+ _query_params: List[Tuple[str, str]] = []
3969
+ _header_params: Dict[str, Optional[str]] = _headers or {}
3970
+ _form_params: List[Tuple[str, str]] = []
3971
+ _files: Dict[str, Union[str, bytes]] = {}
3972
+ _body_params: Optional[bytes] = None
3973
+
3974
+ # process the path parameters
3975
+ if cell is not None:
3976
+ _path_params['cell'] = cell
3977
+ # process the query parameters
3978
+ # process the header parameters
3979
+ # process the form parameters
3980
+ # process the body parameter
3981
+
3982
+
3983
+ # set the HTTP header `Accept`
3984
+ _header_params['Accept'] = self.api_client.select_header_accept(
3985
+ [
3986
+ 'application/json'
3987
+ ]
3988
+ )
3989
+
3990
+
3991
+ # authentication setting
3992
+ _auth_settings: List[str] = [
3993
+ 'BasicAuth',
3994
+ 'BearerAuth'
3995
+ ]
3996
+
3997
+ return self.api_client.param_serialize(
3998
+ method='GET',
3999
+ resource_path='/cells/{cell}/bus-ios/profinet/ios',
4000
+ path_params=_path_params,
4001
+ query_params=_query_params,
4002
+ header_params=_header_params,
4003
+ body=_body_params,
4004
+ post_params=_form_params,
4005
+ files=_files,
4006
+ auth_settings=_auth_settings,
4007
+ collection_formats=_collection_formats,
4008
+ _host=_host,
4009
+ _request_auth=_request_auth
4010
+ )
4011
+
4012
+
4013
+
4014
+ @validate_call
4015
+ async def set_bus_io_values(
4016
+ self,
4017
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
4018
+ io_value: List[IOValue],
4019
+ _request_timeout: Union[
4020
+ None,
4021
+ Annotated[StrictFloat, Field(gt=0)],
4022
+ Tuple[
4023
+ Annotated[StrictFloat, Field(gt=0)],
4024
+ Annotated[StrictFloat, Field(gt=0)]
4025
+ ]
4026
+ ] = None,
4027
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
4028
+ _content_type: Optional[StrictStr] = None,
4029
+ _headers: Optional[Dict[StrictStr, Any]] = None,
4030
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
4031
+ ) -> None:
4032
+ """Set Output Values
4033
+
4034
+ Set values of outputs. In case of virtual Bus Input/Outputs, also inputs can be set. All available output identifiers can be requested via [listBusIODescriptions](listBusIODescriptions). The call will return once the values have been set and accepted by the service.
4035
+
4036
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
4037
+ :type cell: str
4038
+ :param io_value: (required)
4039
+ :type io_value: List[IOValue]
4040
+ :param _request_timeout: timeout setting for this request. If one
4041
+ number provided, it will be total request
4042
+ timeout. It can also be a pair (tuple) of
4043
+ (connection, read) timeouts.
4044
+ :type _request_timeout: int, tuple(int, int), optional
4045
+ :param _request_auth: set to override the auth_settings for an a single
4046
+ request; this effectively ignores the
4047
+ authentication in the spec for a single request.
4048
+ :type _request_auth: dict, optional
4049
+ :param _content_type: force content-type for the request.
4050
+ :type _content_type: str, Optional
4051
+ :param _headers: set to override the headers for a single
4052
+ request; this effectively ignores the headers
4053
+ in the spec for a single request.
4054
+ :type _headers: dict, optional
4055
+ :param _host_index: set to override the host_index for a single
4056
+ request; this effectively ignores the host_index
4057
+ in the spec for a single request.
4058
+ :type _host_index: int, optional
4059
+ :return: Returns the result object.
4060
+ """ # noqa: E501
4061
+
4062
+ _param = self._set_bus_io_values_serialize(
4063
+ cell=cell,
4064
+ io_value=io_value,
4065
+ _request_auth=_request_auth,
4066
+ _content_type=_content_type,
4067
+ _headers=_headers,
4068
+ _host_index=_host_index
4069
+ )
4070
+
4071
+ _response_types_map: Dict[str, Optional[str]] = {
4072
+ '200': None,
4073
+ '400': "Error",
4074
+ '404': "Error",
4075
+ }
4076
+
4077
+ response_data = await self.api_client.call_api(
4078
+ *_param,
4079
+ _request_timeout=_request_timeout
4080
+ )
4081
+ await response_data.read()
4082
+ return self.api_client.response_deserialize(
4083
+ response_data=response_data,
4084
+ response_types_map=_response_types_map,
4085
+ ).data
4086
+
4087
+
4088
+ @validate_call
4089
+ async def set_bus_io_values_with_http_info(
4090
+ self,
4091
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
4092
+ io_value: List[IOValue],
4093
+ _request_timeout: Union[
4094
+ None,
4095
+ Annotated[StrictFloat, Field(gt=0)],
4096
+ Tuple[
4097
+ Annotated[StrictFloat, Field(gt=0)],
4098
+ Annotated[StrictFloat, Field(gt=0)]
4099
+ ]
4100
+ ] = None,
4101
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
4102
+ _content_type: Optional[StrictStr] = None,
4103
+ _headers: Optional[Dict[StrictStr, Any]] = None,
4104
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
4105
+ ) -> ApiResponse[None]:
4106
+ """Set Output Values
4107
+
4108
+ Set values of outputs. In case of virtual Bus Input/Outputs, also inputs can be set. All available output identifiers can be requested via [listBusIODescriptions](listBusIODescriptions). The call will return once the values have been set and accepted by the service.
4109
+
4110
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
4111
+ :type cell: str
4112
+ :param io_value: (required)
4113
+ :type io_value: List[IOValue]
4114
+ :param _request_timeout: timeout setting for this request. If one
4115
+ number provided, it will be total request
4116
+ timeout. It can also be a pair (tuple) of
4117
+ (connection, read) timeouts.
4118
+ :type _request_timeout: int, tuple(int, int), optional
4119
+ :param _request_auth: set to override the auth_settings for an a single
4120
+ request; this effectively ignores the
4121
+ authentication in the spec for a single request.
4122
+ :type _request_auth: dict, optional
4123
+ :param _content_type: force content-type for the request.
4124
+ :type _content_type: str, Optional
4125
+ :param _headers: set to override the headers for a single
4126
+ request; this effectively ignores the headers
4127
+ in the spec for a single request.
4128
+ :type _headers: dict, optional
4129
+ :param _host_index: set to override the host_index for a single
4130
+ request; this effectively ignores the host_index
4131
+ in the spec for a single request.
4132
+ :type _host_index: int, optional
4133
+ :return: Returns the result object.
4134
+ """ # noqa: E501
4135
+
4136
+ _param = self._set_bus_io_values_serialize(
4137
+ cell=cell,
4138
+ io_value=io_value,
4139
+ _request_auth=_request_auth,
4140
+ _content_type=_content_type,
4141
+ _headers=_headers,
4142
+ _host_index=_host_index
4143
+ )
4144
+
4145
+ _response_types_map: Dict[str, Optional[str]] = {
4146
+ '200': None,
4147
+ '400': "Error",
4148
+ '404': "Error",
4149
+ }
4150
+
4151
+ response_data = await self.api_client.call_api(
4152
+ *_param,
4153
+ _request_timeout=_request_timeout
4154
+ )
4155
+ await response_data.read()
4156
+ return self.api_client.response_deserialize(
4157
+ response_data=response_data,
4158
+ response_types_map=_response_types_map,
4159
+ )
4160
+
4161
+
4162
+ @validate_call
4163
+ async def set_bus_io_values_without_preload_content(
4164
+ self,
4165
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
4166
+ io_value: List[IOValue],
4167
+ _request_timeout: Union[
4168
+ None,
4169
+ Annotated[StrictFloat, Field(gt=0)],
4170
+ Tuple[
4171
+ Annotated[StrictFloat, Field(gt=0)],
4172
+ Annotated[StrictFloat, Field(gt=0)]
4173
+ ]
4174
+ ] = None,
4175
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
4176
+ _content_type: Optional[StrictStr] = None,
4177
+ _headers: Optional[Dict[StrictStr, Any]] = None,
4178
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
4179
+ ) -> RESTResponseType:
4180
+ """Set Output Values
4181
+
4182
+ Set values of outputs. In case of virtual Bus Input/Outputs, also inputs can be set. All available output identifiers can be requested via [listBusIODescriptions](listBusIODescriptions). The call will return once the values have been set and accepted by the service.
4183
+
4184
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
4185
+ :type cell: str
4186
+ :param io_value: (required)
4187
+ :type io_value: List[IOValue]
4188
+ :param _request_timeout: timeout setting for this request. If one
4189
+ number provided, it will be total request
4190
+ timeout. It can also be a pair (tuple) of
4191
+ (connection, read) timeouts.
4192
+ :type _request_timeout: int, tuple(int, int), optional
4193
+ :param _request_auth: set to override the auth_settings for an a single
4194
+ request; this effectively ignores the
4195
+ authentication in the spec for a single request.
4196
+ :type _request_auth: dict, optional
4197
+ :param _content_type: force content-type for the request.
4198
+ :type _content_type: str, Optional
4199
+ :param _headers: set to override the headers for a single
4200
+ request; this effectively ignores the headers
4201
+ in the spec for a single request.
4202
+ :type _headers: dict, optional
4203
+ :param _host_index: set to override the host_index for a single
4204
+ request; this effectively ignores the host_index
4205
+ in the spec for a single request.
4206
+ :type _host_index: int, optional
4207
+ :return: Returns the result object.
4208
+ """ # noqa: E501
4209
+
4210
+ _param = self._set_bus_io_values_serialize(
4211
+ cell=cell,
4212
+ io_value=io_value,
4213
+ _request_auth=_request_auth,
4214
+ _content_type=_content_type,
4215
+ _headers=_headers,
4216
+ _host_index=_host_index
4217
+ )
4218
+
4219
+ _response_types_map: Dict[str, Optional[str]] = {
4220
+ '200': None,
4221
+ '400': "Error",
4222
+ '404': "Error",
4223
+ }
4224
+
4225
+ response_data = await self.api_client.call_api(
4226
+ *_param,
4227
+ _request_timeout=_request_timeout
4228
+ )
4229
+ return response_data.response
4230
+
4231
+
4232
+ def _set_bus_io_values_serialize(
4233
+ self,
4234
+ cell,
4235
+ io_value,
4236
+ _request_auth,
4237
+ _content_type,
4238
+ _headers,
4239
+ _host_index,
4240
+ ) -> RequestSerialized:
4241
+
4242
+ _host = None
4243
+
4244
+ _collection_formats: Dict[str, str] = {
4245
+ 'IOValue': '',
4246
+ }
4247
+
4248
+ _path_params: Dict[str, str] = {}
4249
+ _query_params: List[Tuple[str, str]] = []
4250
+ _header_params: Dict[str, Optional[str]] = _headers or {}
4251
+ _form_params: List[Tuple[str, str]] = []
4252
+ _files: Dict[str, Union[str, bytes]] = {}
4253
+ _body_params: Optional[bytes] = None
4254
+
4255
+ # process the path parameters
4256
+ if cell is not None:
4257
+ _path_params['cell'] = cell
4258
+ # process the query parameters
4259
+ # process the header parameters
4260
+ # process the form parameters
4261
+ # process the body parameter
4262
+ if io_value is not None:
4263
+ _body_params = io_value
4264
+
4265
+
4266
+ # set the HTTP header `Accept`
4267
+ _header_params['Accept'] = self.api_client.select_header_accept(
4268
+ [
4269
+ 'application/json'
4270
+ ]
4271
+ )
4272
+
4273
+ # set the HTTP header `Content-Type`
4274
+ if _content_type:
4275
+ _header_params['Content-Type'] = _content_type
4276
+ else:
4277
+ _default_content_type = (
4278
+ self.api_client.select_header_content_type(
4279
+ [
4280
+ 'application/json'
4281
+ ]
4282
+ )
4283
+ )
4284
+ if _default_content_type is not None:
4285
+ _header_params['Content-Type'] = _default_content_type
4286
+
4287
+ # authentication setting
4288
+ _auth_settings: List[str] = [
4289
+ 'BasicAuth',
4290
+ 'BearerAuth'
4291
+ ]
4292
+
4293
+ return self.api_client.param_serialize(
4294
+ method='PUT',
4295
+ resource_path='/cells/{cell}/bus-ios/ios/values',
4296
+ path_params=_path_params,
4297
+ query_params=_query_params,
4298
+ header_params=_header_params,
4299
+ body=_body_params,
4300
+ post_params=_form_params,
4301
+ files=_files,
4302
+ auth_settings=_auth_settings,
4303
+ collection_formats=_collection_formats,
4304
+ _host=_host,
4305
+ _request_auth=_request_auth
4306
+ )
4307
+
4308
+
4309
+
4310
+ @validate_call
4311
+ async def set_profinet_ios_from_file(
4312
+ self,
4313
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
4314
+ profinet_input_output_config: ProfinetInputOutputConfig,
4315
+ _request_timeout: Union[
4316
+ None,
4317
+ Annotated[StrictFloat, Field(gt=0)],
4318
+ Tuple[
4319
+ Annotated[StrictFloat, Field(gt=0)],
4320
+ Annotated[StrictFloat, Field(gt=0)]
4321
+ ]
4322
+ ] = None,
4323
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
4324
+ _content_type: Optional[StrictStr] = None,
4325
+ _headers: Optional[Dict[StrictStr, Any]] = None,
4326
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
4327
+ ) -> None:
4328
+ """Set PROFINET Inputs/Outputs from File
4329
+
4330
+ Sets input/output variable configuration on the PROFINET device (i.e. NOVA's PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA's PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA's PROFINET service's configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding engineering system, e.g., TIA portal. #### Export variables You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g., TIA portal. - The endpoint is built so that the perspective of input and output (PROFINET Device's input is PROFINET Controller's output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
4331
+
4332
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
4333
+ :type cell: str
4334
+ :param profinet_input_output_config: (required)
4335
+ :type profinet_input_output_config: ProfinetInputOutputConfig
4336
+ :param _request_timeout: timeout setting for this request. If one
4337
+ number provided, it will be total request
4338
+ timeout. It can also be a pair (tuple) of
4339
+ (connection, read) timeouts.
4340
+ :type _request_timeout: int, tuple(int, int), optional
4341
+ :param _request_auth: set to override the auth_settings for an a single
4342
+ request; this effectively ignores the
4343
+ authentication in the spec for a single request.
4344
+ :type _request_auth: dict, optional
4345
+ :param _content_type: force content-type for the request.
4346
+ :type _content_type: str, Optional
4347
+ :param _headers: set to override the headers for a single
4348
+ request; this effectively ignores the headers
4349
+ in the spec for a single request.
4350
+ :type _headers: dict, optional
4351
+ :param _host_index: set to override the host_index for a single
4352
+ request; this effectively ignores the host_index
4353
+ in the spec for a single request.
4354
+ :type _host_index: int, optional
4355
+ :return: Returns the result object.
4356
+ """ # noqa: E501
4357
+
4358
+ _param = self._set_profinet_ios_from_file_serialize(
4359
+ cell=cell,
4360
+ profinet_input_output_config=profinet_input_output_config,
4361
+ _request_auth=_request_auth,
4362
+ _content_type=_content_type,
4363
+ _headers=_headers,
4364
+ _host_index=_host_index
4365
+ )
4366
+
4367
+ _response_types_map: Dict[str, Optional[str]] = {
4368
+ '200': None,
4369
+ '400': "Error",
4370
+ '404': "Error",
4371
+ }
4372
+
4373
+ response_data = await self.api_client.call_api(
4374
+ *_param,
4375
+ _request_timeout=_request_timeout
4376
+ )
4377
+ await response_data.read()
4378
+ return self.api_client.response_deserialize(
4379
+ response_data=response_data,
4380
+ response_types_map=_response_types_map,
4381
+ ).data
4382
+
4383
+
4384
+ @validate_call
4385
+ async def set_profinet_ios_from_file_with_http_info(
4386
+ self,
4387
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
4388
+ profinet_input_output_config: ProfinetInputOutputConfig,
4389
+ _request_timeout: Union[
4390
+ None,
4391
+ Annotated[StrictFloat, Field(gt=0)],
4392
+ Tuple[
4393
+ Annotated[StrictFloat, Field(gt=0)],
4394
+ Annotated[StrictFloat, Field(gt=0)]
4395
+ ]
4396
+ ] = None,
4397
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
4398
+ _content_type: Optional[StrictStr] = None,
4399
+ _headers: Optional[Dict[StrictStr, Any]] = None,
4400
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
4401
+ ) -> ApiResponse[None]:
4402
+ """Set PROFINET Inputs/Outputs from File
4403
+
4404
+ Sets input/output variable configuration on the PROFINET device (i.e. NOVA's PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA's PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA's PROFINET service's configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding engineering system, e.g., TIA portal. #### Export variables You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g., TIA portal. - The endpoint is built so that the perspective of input and output (PROFINET Device's input is PROFINET Controller's output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
4405
+
4406
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
4407
+ :type cell: str
4408
+ :param profinet_input_output_config: (required)
4409
+ :type profinet_input_output_config: ProfinetInputOutputConfig
4410
+ :param _request_timeout: timeout setting for this request. If one
4411
+ number provided, it will be total request
4412
+ timeout. It can also be a pair (tuple) of
4413
+ (connection, read) timeouts.
4414
+ :type _request_timeout: int, tuple(int, int), optional
4415
+ :param _request_auth: set to override the auth_settings for an a single
4416
+ request; this effectively ignores the
4417
+ authentication in the spec for a single request.
4418
+ :type _request_auth: dict, optional
4419
+ :param _content_type: force content-type for the request.
4420
+ :type _content_type: str, Optional
4421
+ :param _headers: set to override the headers for a single
4422
+ request; this effectively ignores the headers
4423
+ in the spec for a single request.
4424
+ :type _headers: dict, optional
4425
+ :param _host_index: set to override the host_index for a single
4426
+ request; this effectively ignores the host_index
4427
+ in the spec for a single request.
4428
+ :type _host_index: int, optional
4429
+ :return: Returns the result object.
4430
+ """ # noqa: E501
4431
+
4432
+ _param = self._set_profinet_ios_from_file_serialize(
4433
+ cell=cell,
4434
+ profinet_input_output_config=profinet_input_output_config,
4435
+ _request_auth=_request_auth,
4436
+ _content_type=_content_type,
4437
+ _headers=_headers,
4438
+ _host_index=_host_index
4439
+ )
4440
+
4441
+ _response_types_map: Dict[str, Optional[str]] = {
4442
+ '200': None,
4443
+ '400': "Error",
4444
+ '404': "Error",
4445
+ }
4446
+
4447
+ response_data = await self.api_client.call_api(
4448
+ *_param,
4449
+ _request_timeout=_request_timeout
4450
+ )
4451
+ await response_data.read()
4452
+ return self.api_client.response_deserialize(
4453
+ response_data=response_data,
4454
+ response_types_map=_response_types_map,
4455
+ )
4456
+
4457
+
4458
+ @validate_call
4459
+ async def set_profinet_ios_from_file_without_preload_content(
4460
+ self,
4461
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
4462
+ profinet_input_output_config: ProfinetInputOutputConfig,
4463
+ _request_timeout: Union[
4464
+ None,
4465
+ Annotated[StrictFloat, Field(gt=0)],
4466
+ Tuple[
4467
+ Annotated[StrictFloat, Field(gt=0)],
4468
+ Annotated[StrictFloat, Field(gt=0)]
4469
+ ]
4470
+ ] = None,
4471
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
4472
+ _content_type: Optional[StrictStr] = None,
4473
+ _headers: Optional[Dict[StrictStr, Any]] = None,
4474
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
4475
+ ) -> RESTResponseType:
4476
+ """Set PROFINET Inputs/Outputs from File
4477
+
4478
+ Sets input/output variable configuration on the PROFINET device (i.e. NOVA's PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA's PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA's PROFINET service's configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding engineering system, e.g., TIA portal. #### Export variables You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g., TIA portal. - The endpoint is built so that the perspective of input and output (PROFINET Device's input is PROFINET Controller's output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
4479
+
4480
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
4481
+ :type cell: str
4482
+ :param profinet_input_output_config: (required)
4483
+ :type profinet_input_output_config: ProfinetInputOutputConfig
4484
+ :param _request_timeout: timeout setting for this request. If one
4485
+ number provided, it will be total request
4486
+ timeout. It can also be a pair (tuple) of
4487
+ (connection, read) timeouts.
4488
+ :type _request_timeout: int, tuple(int, int), optional
4489
+ :param _request_auth: set to override the auth_settings for an a single
4490
+ request; this effectively ignores the
4491
+ authentication in the spec for a single request.
4492
+ :type _request_auth: dict, optional
4493
+ :param _content_type: force content-type for the request.
4494
+ :type _content_type: str, Optional
4495
+ :param _headers: set to override the headers for a single
4496
+ request; this effectively ignores the headers
4497
+ in the spec for a single request.
4498
+ :type _headers: dict, optional
4499
+ :param _host_index: set to override the host_index for a single
4500
+ request; this effectively ignores the host_index
4501
+ in the spec for a single request.
4502
+ :type _host_index: int, optional
4503
+ :return: Returns the result object.
4504
+ """ # noqa: E501
4505
+
4506
+ _param = self._set_profinet_ios_from_file_serialize(
4507
+ cell=cell,
4508
+ profinet_input_output_config=profinet_input_output_config,
4509
+ _request_auth=_request_auth,
4510
+ _content_type=_content_type,
4511
+ _headers=_headers,
4512
+ _host_index=_host_index
4513
+ )
4514
+
4515
+ _response_types_map: Dict[str, Optional[str]] = {
4516
+ '200': None,
4517
+ '400': "Error",
4518
+ '404': "Error",
4519
+ }
4520
+
4521
+ response_data = await self.api_client.call_api(
4522
+ *_param,
4523
+ _request_timeout=_request_timeout
4524
+ )
4525
+ return response_data.response
4526
+
4527
+
4528
+ def _set_profinet_ios_from_file_serialize(
4529
+ self,
4530
+ cell,
4531
+ profinet_input_output_config,
4532
+ _request_auth,
4533
+ _content_type,
4534
+ _headers,
4535
+ _host_index,
4536
+ ) -> RequestSerialized:
4537
+
4538
+ _host = None
4539
+
4540
+ _collection_formats: Dict[str, str] = {
4541
+ }
4542
+
4543
+ _path_params: Dict[str, str] = {}
4544
+ _query_params: List[Tuple[str, str]] = []
4545
+ _header_params: Dict[str, Optional[str]] = _headers or {}
4546
+ _form_params: List[Tuple[str, str]] = []
4547
+ _files: Dict[str, Union[str, bytes]] = {}
4548
+ _body_params: Optional[bytes] = None
4549
+
4550
+ # process the path parameters
4551
+ if cell is not None:
4552
+ _path_params['cell'] = cell
4553
+ # process the query parameters
4554
+ # process the header parameters
4555
+ # process the form parameters
4556
+ # process the body parameter
4557
+ if profinet_input_output_config is not None:
4558
+ _body_params = profinet_input_output_config
4559
+
4560
+
4561
+ # set the HTTP header `Accept`
4562
+ _header_params['Accept'] = self.api_client.select_header_accept(
4563
+ [
4564
+ 'application/json'
4565
+ ]
4566
+ )
4567
+
4568
+ # set the HTTP header `Content-Type`
4569
+ if _content_type:
4570
+ _header_params['Content-Type'] = _content_type
4571
+ else:
4572
+ _default_content_type = (
4573
+ self.api_client.select_header_content_type(
4574
+ [
4575
+ 'application/json'
4576
+ ]
4577
+ )
4578
+ )
4579
+ if _default_content_type is not None:
4580
+ _header_params['Content-Type'] = _default_content_type
4581
+
4582
+ # authentication setting
4583
+ _auth_settings: List[str] = [
4584
+ 'BasicAuth',
4585
+ 'BearerAuth'
4586
+ ]
4587
+
4588
+ return self.api_client.param_serialize(
4589
+ method='PUT',
4590
+ resource_path='/cells/{cell}/bus-ios/profinet/iofile',
4591
+ path_params=_path_params,
4592
+ query_params=_query_params,
4593
+ header_params=_header_params,
4594
+ body=_body_params,
4595
+ post_params=_form_params,
4596
+ files=_files,
4597
+ auth_settings=_auth_settings,
4598
+ collection_formats=_collection_formats,
4599
+ _host=_host,
4600
+ _request_auth=_request_auth
4601
+ )
4602
+
4603
+