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