zaber-motion 7.12.0__py3-none-win32.whl → 7.14.0__py3-none-win32.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 (492) hide show
  1. zaber_motion/__init__.py +103 -103
  2. zaber_motion/ascii/__init__.py +73 -73
  3. zaber_motion/ascii/all_axes.py +352 -352
  4. zaber_motion/ascii/axis.py +1673 -1666
  5. zaber_motion/ascii/axis_group.py +391 -391
  6. zaber_motion/ascii/axis_settings.py +752 -752
  7. zaber_motion/ascii/connection.py +1174 -1174
  8. zaber_motion/ascii/device.py +908 -908
  9. zaber_motion/ascii/device_io.py +1170 -1170
  10. zaber_motion/ascii/device_settings.py +735 -735
  11. zaber_motion/ascii/lockstep.py +1184 -1184
  12. zaber_motion/ascii/oscilloscope.py +635 -635
  13. zaber_motion/ascii/oscilloscope_data.py +240 -240
  14. zaber_motion/ascii/pvt.py +105 -105
  15. zaber_motion/ascii/pvt_buffer.py +146 -146
  16. zaber_motion/ascii/pvt_io.py +630 -630
  17. zaber_motion/ascii/pvt_sequence.py +1530 -1530
  18. zaber_motion/ascii/servo_tuner.py +637 -637
  19. zaber_motion/ascii/setting_constants.py +1755 -1755
  20. zaber_motion/ascii/storage.py +905 -905
  21. zaber_motion/ascii/stream.py +2182 -2182
  22. zaber_motion/ascii/stream_buffer.py +101 -101
  23. zaber_motion/ascii/stream_io.py +700 -700
  24. zaber_motion/ascii/streams.py +105 -105
  25. zaber_motion/ascii/transport.py +202 -202
  26. zaber_motion/ascii/trigger.py +886 -886
  27. zaber_motion/ascii/triggers.py +241 -241
  28. zaber_motion/ascii/warning_flags.py +178 -178
  29. zaber_motion/ascii/warnings.py +152 -152
  30. zaber_motion/async_utils.py +46 -46
  31. zaber_motion/binary/__init__.py +14 -14
  32. zaber_motion/binary/connection.py +648 -648
  33. zaber_motion/binary/device.py +924 -924
  34. zaber_motion/binary/device_settings.py +121 -121
  35. zaber_motion/bindings.py +50 -50
  36. zaber_motion/call.py +198 -198
  37. zaber_motion/convert_exception.py +138 -138
  38. zaber_motion/dto/__init__.py +11 -11
  39. zaber_motion/dto/ascii/__init__.py +46 -46
  40. zaber_motion/dto/ascii/alert_event.py +110 -110
  41. zaber_motion/dto/ascii/axis_identity.py +134 -117
  42. zaber_motion/dto/ascii/axis_type.py +14 -14
  43. zaber_motion/dto/ascii/can_set_state_axis_response.py +69 -69
  44. zaber_motion/dto/ascii/can_set_state_device_response.py +75 -75
  45. zaber_motion/dto/ascii/conversion_factor.py +81 -81
  46. zaber_motion/dto/ascii/device_identity.py +136 -136
  47. zaber_motion/dto/ascii/device_io_info.py +108 -108
  48. zaber_motion/dto/ascii/digital_output_action.py +13 -13
  49. zaber_motion/dto/ascii/get_axis_setting.py +64 -64
  50. zaber_motion/dto/ascii/get_axis_setting_result.py +81 -81
  51. zaber_motion/dto/ascii/get_setting.py +88 -88
  52. zaber_motion/dto/ascii/get_setting_result.py +87 -87
  53. zaber_motion/dto/ascii/io_port_label.py +84 -84
  54. zaber_motion/dto/ascii/io_port_type.py +14 -14
  55. zaber_motion/dto/ascii/lockstep_axes.py +108 -108
  56. zaber_motion/dto/ascii/measurement_sequence.py +73 -73
  57. zaber_motion/dto/ascii/message_type.py +14 -14
  58. zaber_motion/dto/ascii/optional_measurement_sequence.py +71 -71
  59. zaber_motion/dto/ascii/oscilloscope_capture_properties.py +116 -116
  60. zaber_motion/dto/ascii/oscilloscope_data_source.py +11 -11
  61. zaber_motion/dto/ascii/paramset_info.py +92 -92
  62. zaber_motion/dto/ascii/pid_tuning.py +125 -125
  63. zaber_motion/dto/ascii/pvt_axis_definition.py +70 -70
  64. zaber_motion/dto/ascii/pvt_axis_type.py +11 -11
  65. zaber_motion/dto/ascii/pvt_csv_data.py +75 -75
  66. zaber_motion/dto/ascii/pvt_mode.py +12 -12
  67. zaber_motion/dto/ascii/pvt_sequence_data.py +99 -99
  68. zaber_motion/dto/ascii/response.py +137 -137
  69. zaber_motion/dto/ascii/servo_tuning_param.py +66 -66
  70. zaber_motion/dto/ascii/servo_tuning_paramset.py +21 -21
  71. zaber_motion/dto/ascii/set_state_axis_response.py +75 -75
  72. zaber_motion/dto/ascii/set_state_device_response.py +80 -80
  73. zaber_motion/dto/ascii/simple_tuning.py +118 -118
  74. zaber_motion/dto/ascii/simple_tuning_param_definition.py +100 -100
  75. zaber_motion/dto/ascii/stream_axis_definition.py +70 -70
  76. zaber_motion/dto/ascii/stream_axis_type.py +11 -11
  77. zaber_motion/dto/ascii/stream_mode.py +13 -13
  78. zaber_motion/dto/ascii/trigger_action.py +12 -12
  79. zaber_motion/dto/ascii/trigger_condition.py +15 -15
  80. zaber_motion/dto/ascii/trigger_enabled_state.py +68 -68
  81. zaber_motion/dto/ascii/trigger_operation.py +12 -12
  82. zaber_motion/dto/ascii/trigger_state.py +114 -114
  83. zaber_motion/dto/ascii/unknown_response_event.py +137 -137
  84. zaber_motion/dto/axis_address.py +74 -74
  85. zaber_motion/dto/binary/__init__.py +11 -11
  86. zaber_motion/dto/binary/binary_settings.py +74 -74
  87. zaber_motion/dto/binary/command_code.py +106 -106
  88. zaber_motion/dto/binary/device_identity.py +156 -156
  89. zaber_motion/dto/binary/device_type.py +12 -12
  90. zaber_motion/dto/binary/error_code.py +101 -101
  91. zaber_motion/dto/binary/message.py +91 -91
  92. zaber_motion/dto/binary/reply_code.py +16 -16
  93. zaber_motion/dto/binary/reply_only_event.py +91 -91
  94. zaber_motion/dto/binary/unknown_response_event.py +91 -91
  95. zaber_motion/dto/channel_address.py +74 -74
  96. zaber_motion/dto/device_db_source.py +66 -66
  97. zaber_motion/dto/device_db_source_type.py +11 -11
  98. zaber_motion/dto/exceptions/__init__.py +24 -24
  99. zaber_motion/dto/exceptions/binary_command_failed_exception_data.py +57 -57
  100. zaber_motion/dto/exceptions/command_failed_exception_data.py +151 -151
  101. zaber_motion/dto/exceptions/command_too_long_exception_data.py +98 -98
  102. zaber_motion/dto/exceptions/device_address_conflict_exception_data.py +63 -63
  103. zaber_motion/dto/exceptions/device_db_failed_exception_data.py +74 -74
  104. zaber_motion/dto/exceptions/device_db_inner_error.py +85 -85
  105. zaber_motion/dto/exceptions/g_code_execution_exception_data.py +75 -75
  106. zaber_motion/dto/exceptions/g_code_syntax_exception_data.py +75 -75
  107. zaber_motion/dto/exceptions/invalid_packet_exception_data.py +63 -63
  108. zaber_motion/dto/exceptions/invalid_pvt_point.py +69 -69
  109. zaber_motion/dto/exceptions/invalid_response_exception_data.py +51 -51
  110. zaber_motion/dto/exceptions/movement_failed_exception_data.py +104 -104
  111. zaber_motion/dto/exceptions/movement_interrupted_exception_data.py +104 -104
  112. zaber_motion/dto/exceptions/operation_failed_exception_data.py +104 -104
  113. zaber_motion/dto/exceptions/pvt_execution_exception_data.py +86 -86
  114. zaber_motion/dto/exceptions/pvt_movement_failed_exception_data.py +69 -69
  115. zaber_motion/dto/exceptions/pvt_movement_interrupted_exception_data.py +69 -69
  116. zaber_motion/dto/exceptions/set_device_state_exception_data.py +176 -176
  117. zaber_motion/dto/exceptions/set_peripheral_state_exception_data.py +121 -121
  118. zaber_motion/dto/exceptions/stream_execution_exception_data.py +63 -63
  119. zaber_motion/dto/exceptions/stream_movement_failed_exception_data.py +69 -69
  120. zaber_motion/dto/exceptions/stream_movement_interrupted_exception_data.py +69 -69
  121. zaber_motion/dto/firmware_version.py +91 -91
  122. zaber_motion/dto/gcode/__init__.py +9 -9
  123. zaber_motion/dto/gcode/axis_definition.py +74 -74
  124. zaber_motion/dto/gcode/axis_mapping.py +69 -69
  125. zaber_motion/dto/gcode/axis_transformation.py +79 -79
  126. zaber_motion/dto/gcode/device_definition.py +99 -99
  127. zaber_motion/dto/gcode/translate_message.py +87 -87
  128. zaber_motion/dto/gcode/translate_result.py +79 -79
  129. zaber_motion/dto/gcode/translator_config.py +84 -84
  130. zaber_motion/dto/log_output_mode.py +13 -13
  131. zaber_motion/dto/measurement.py +67 -67
  132. zaber_motion/dto/microscopy/__init__.py +6 -6
  133. zaber_motion/dto/microscopy/autofocus_status.py +57 -57
  134. zaber_motion/dto/microscopy/microscope_config.py +159 -159
  135. zaber_motion/dto/microscopy/third_party_components.py +55 -55
  136. zaber_motion/dto/microscopy/wdi_autofocus_provider_status.py +57 -57
  137. zaber_motion/dto/named_parameter.py +64 -64
  138. zaber_motion/dto/product/__init__.py +5 -5
  139. zaber_motion/dto/product/process_controller_mode.py +13 -13
  140. zaber_motion/dto/product/process_controller_source.py +72 -72
  141. zaber_motion/dto/product/process_controller_source_sensor.py +11 -11
  142. zaber_motion/dto/requests/__init__.py +256 -254
  143. zaber_motion/dto/requests/alert_event_wrapper.py +82 -82
  144. zaber_motion/dto/requests/autofocus_focus_request.py +131 -131
  145. zaber_motion/dto/requests/autofocus_get_objective_params_request.py +121 -121
  146. zaber_motion/dto/requests/autofocus_get_objective_params_response.py +56 -56
  147. zaber_motion/dto/requests/autofocus_get_status_response.py +50 -50
  148. zaber_motion/dto/requests/autofocus_set_objective_params_request.py +141 -141
  149. zaber_motion/dto/requests/axes_empty_request.py +95 -95
  150. zaber_motion/dto/requests/axes_get_setting_request.py +121 -121
  151. zaber_motion/dto/requests/axes_move_request.py +114 -114
  152. zaber_motion/dto/requests/axis_empty_request.py +79 -79
  153. zaber_motion/dto/requests/axis_move_type.py +12 -12
  154. zaber_motion/dto/requests/axis_to_string_request.py +88 -88
  155. zaber_motion/dto/requests/binary_device_detect_request.py +56 -56
  156. zaber_motion/dto/requests/binary_device_detect_response.py +57 -57
  157. zaber_motion/dto/requests/binary_device_get_setting_request.py +89 -89
  158. zaber_motion/dto/requests/binary_device_home_request.py +88 -88
  159. zaber_motion/dto/requests/binary_device_move_request.py +111 -111
  160. zaber_motion/dto/requests/binary_device_set_setting_request.py +100 -100
  161. zaber_motion/dto/requests/binary_device_stop_request.py +88 -88
  162. zaber_motion/dto/requests/binary_generic_with_units_request.py +122 -122
  163. zaber_motion/dto/requests/binary_message_collection.py +56 -56
  164. zaber_motion/dto/requests/binary_reply_only_event_wrapper.py +82 -82
  165. zaber_motion/dto/requests/bool_response.py +43 -43
  166. zaber_motion/dto/requests/can_set_state_axis_response.py +60 -60
  167. zaber_motion/dto/requests/can_set_state_request.py +100 -100
  168. zaber_motion/dto/requests/channel_on.py +84 -84
  169. zaber_motion/dto/requests/channel_set_intensity.py +90 -90
  170. zaber_motion/dto/requests/check_version_request.py +54 -54
  171. zaber_motion/dto/requests/custom_interface_close_request.py +60 -60
  172. zaber_motion/dto/requests/custom_interface_open_response.py +51 -51
  173. zaber_motion/dto/requests/custom_interface_read_request.py +51 -51
  174. zaber_motion/dto/requests/custom_interface_write_request.py +60 -60
  175. zaber_motion/dto/requests/device_cancel_all_outputs_schedule_request.py +80 -80
  176. zaber_motion/dto/requests/device_cancel_output_schedule_request.py +84 -84
  177. zaber_motion/dto/requests/device_convert_setting_request.py +116 -116
  178. zaber_motion/dto/requests/device_detect_request.py +68 -68
  179. zaber_motion/dto/requests/device_detect_response.py +57 -57
  180. zaber_motion/dto/requests/device_empty_request.py +65 -65
  181. zaber_motion/dto/requests/device_get_all_analog_io_request.py +74 -74
  182. zaber_motion/dto/requests/device_get_all_analog_io_response.py +54 -54
  183. zaber_motion/dto/requests/device_get_all_digital_io_request.py +74 -74
  184. zaber_motion/dto/requests/device_get_all_digital_io_response.py +46 -46
  185. zaber_motion/dto/requests/device_get_analog_io_request.py +88 -88
  186. zaber_motion/dto/requests/device_get_digital_io_request.py +88 -88
  187. zaber_motion/dto/requests/device_get_setting_request.py +100 -100
  188. zaber_motion/dto/requests/device_get_storage_request.py +93 -93
  189. zaber_motion/dto/requests/device_get_warnings_request.py +84 -84
  190. zaber_motion/dto/requests/device_get_warnings_response.py +51 -51
  191. zaber_motion/dto/requests/device_home_request.py +84 -84
  192. zaber_motion/dto/requests/device_identify_request.py +77 -77
  193. zaber_motion/dto/requests/device_move_request.py +177 -177
  194. zaber_motion/dto/requests/device_move_sin_request.py +140 -140
  195. zaber_motion/dto/requests/device_multi_get_setting_request.py +118 -118
  196. zaber_motion/dto/requests/device_on_all_request.py +56 -56
  197. zaber_motion/dto/requests/device_on_all_response.py +57 -57
  198. zaber_motion/dto/requests/device_restore_request.py +84 -84
  199. zaber_motion/dto/requests/device_set_all_analog_outputs_request.py +82 -82
  200. zaber_motion/dto/requests/device_set_all_analog_outputs_schedule_request.py +121 -121
  201. zaber_motion/dto/requests/device_set_all_digital_outputs_request.py +83 -83
  202. zaber_motion/dto/requests/device_set_all_digital_outputs_schedule_request.py +122 -122
  203. zaber_motion/dto/requests/device_set_analog_output_request.py +90 -90
  204. zaber_motion/dto/requests/device_set_analog_output_schedule_request.py +124 -124
  205. zaber_motion/dto/requests/device_set_digital_output_request.py +91 -91
  206. zaber_motion/dto/requests/device_set_digital_output_schedule_request.py +125 -125
  207. zaber_motion/dto/requests/device_set_lowpass_filter_request.py +102 -102
  208. zaber_motion/dto/requests/device_set_setting_bool_request.py +93 -93
  209. zaber_motion/dto/requests/device_set_setting_int_request.py +102 -102
  210. zaber_motion/dto/requests/device_set_setting_request.py +111 -111
  211. zaber_motion/dto/requests/device_set_setting_str_request.py +97 -97
  212. zaber_motion/dto/requests/device_set_storage_bool_request.py +93 -93
  213. zaber_motion/dto/requests/device_set_storage_number_request.py +99 -99
  214. zaber_motion/dto/requests/device_set_storage_request.py +102 -102
  215. zaber_motion/dto/requests/device_set_unit_conversions_request.py +108 -108
  216. zaber_motion/dto/requests/device_stop_request.py +84 -84
  217. zaber_motion/dto/requests/device_storage_list_keys_request.py +88 -88
  218. zaber_motion/dto/requests/device_storage_request.py +88 -88
  219. zaber_motion/dto/requests/device_type.py +8 -8
  220. zaber_motion/dto/requests/device_wait_until_idle_request.py +84 -84
  221. zaber_motion/dto/requests/disconnected_event.py +101 -101
  222. zaber_motion/dto/requests/double_array_response.py +54 -54
  223. zaber_motion/dto/requests/double_response.py +48 -48
  224. zaber_motion/dto/requests/driver_enable_request.py +90 -90
  225. zaber_motion/dto/requests/empty_autofocus_request.py +107 -107
  226. zaber_motion/dto/requests/empty_request.py +38 -38
  227. zaber_motion/dto/requests/errors.py +68 -68
  228. zaber_motion/dto/requests/find_device_request.py +65 -65
  229. zaber_motion/dto/requests/find_device_response.py +51 -51
  230. zaber_motion/dto/requests/forget_devices_request.py +71 -71
  231. zaber_motion/dto/requests/gateway_event.py +45 -45
  232. zaber_motion/dto/requests/gateway_request.py +45 -45
  233. zaber_motion/dto/requests/gateway_response.py +69 -69
  234. zaber_motion/dto/requests/generic_binary_request.py +107 -107
  235. zaber_motion/dto/requests/generic_command_request.py +107 -107
  236. zaber_motion/dto/requests/generic_command_response_collection.py +56 -56
  237. zaber_motion/dto/requests/get_all_io_port_labels_response.py +56 -56
  238. zaber_motion/dto/requests/get_axis_setting_results.py +56 -56
  239. zaber_motion/dto/requests/get_io_port_label_request.py +91 -91
  240. zaber_motion/dto/requests/get_setting_results.py +56 -56
  241. zaber_motion/dto/requests/get_simple_tuning_param_definition_response.py +56 -56
  242. zaber_motion/dto/requests/int_64_response.py +51 -51
  243. zaber_motion/dto/requests/int_array_response.py +57 -57
  244. zaber_motion/dto/requests/int_request.py +51 -51
  245. zaber_motion/dto/requests/int_response.py +51 -51
  246. zaber_motion/dto/requests/interface_empty_request.py +51 -51
  247. zaber_motion/dto/requests/interface_type.py +11 -11
  248. zaber_motion/dto/requests/load_paramset.py +102 -102
  249. zaber_motion/dto/requests/lockstep_disable_request.py +84 -84
  250. zaber_motion/dto/requests/lockstep_empty_request.py +79 -79
  251. zaber_motion/dto/requests/lockstep_enable_request.py +99 -99
  252. zaber_motion/dto/requests/lockstep_get_axis_numbers_response.py +57 -57
  253. zaber_motion/dto/requests/lockstep_get_request.py +91 -91
  254. zaber_motion/dto/requests/lockstep_home_request.py +84 -84
  255. zaber_motion/dto/requests/lockstep_move_request.py +163 -163
  256. zaber_motion/dto/requests/lockstep_move_sin_request.py +140 -140
  257. zaber_motion/dto/requests/lockstep_set_request.py +116 -116
  258. zaber_motion/dto/requests/lockstep_stop_request.py +84 -84
  259. zaber_motion/dto/requests/lockstep_wait_until_idle_request.py +84 -84
  260. zaber_motion/dto/requests/microscope_config_response.py +50 -50
  261. zaber_motion/dto/requests/microscope_empty_request.py +65 -65
  262. zaber_motion/dto/requests/microscope_find_request.py +63 -63
  263. zaber_motion/dto/requests/microscope_init_request.py +70 -70
  264. zaber_motion/dto/requests/microscope_trigger_camera_request.py +107 -107
  265. zaber_motion/dto/requests/objective_changer_change_request.py +119 -119
  266. zaber_motion/dto/requests/objective_changer_create_response.py +79 -79
  267. zaber_motion/dto/requests/objective_changer_get_current_response.py +51 -51
  268. zaber_motion/dto/requests/objective_changer_request.py +93 -93
  269. zaber_motion/dto/requests/objective_changer_set_request.py +116 -116
  270. zaber_motion/dto/requests/open_binary_interface_request.py +100 -100
  271. zaber_motion/dto/requests/open_interface_request.py +159 -159
  272. zaber_motion/dto/requests/open_interface_response.py +51 -51
  273. zaber_motion/dto/requests/oscilloscope_add_io_channel_request.py +91 -91
  274. zaber_motion/dto/requests/oscilloscope_add_setting_channel_request.py +88 -88
  275. zaber_motion/dto/requests/oscilloscope_data_get_request.py +63 -63
  276. zaber_motion/dto/requests/oscilloscope_data_get_sample_time_request.py +77 -77
  277. zaber_motion/dto/requests/oscilloscope_data_get_samples_response.py +54 -54
  278. zaber_motion/dto/requests/oscilloscope_data_identifier.py +51 -51
  279. zaber_motion/dto/requests/oscilloscope_read_response.py +57 -57
  280. zaber_motion/dto/requests/oscilloscope_request.py +65 -65
  281. zaber_motion/dto/requests/oscilloscope_start_request.py +79 -79
  282. zaber_motion/dto/requests/prepare_command_request.py +108 -108
  283. zaber_motion/dto/requests/process_on.py +107 -107
  284. zaber_motion/dto/requests/pvt_buffer_get_sequence_data_request.py +79 -79
  285. zaber_motion/dto/requests/pvt_csv_request.py +59 -59
  286. zaber_motion/dto/requests/pvt_generate_positions_request.py +74 -74
  287. zaber_motion/dto/requests/pvt_generate_velocities_and_times_request.py +96 -96
  288. zaber_motion/dto/requests/pvt_generate_velocities_request.py +93 -93
  289. zaber_motion/dto/requests/pvt_load_csv_request.py +45 -45
  290. zaber_motion/dto/requests/pvt_point_request.py +145 -145
  291. zaber_motion/dto/requests/pvt_points_request.py +147 -147
  292. zaber_motion/dto/requests/pvt_save_csv_request.py +74 -74
  293. zaber_motion/dto/requests/pvt_submit_sequence_data_request.py +93 -93
  294. zaber_motion/dto/requests/renumber_request.py +79 -79
  295. zaber_motion/dto/requests/response_type.py +8 -8
  296. zaber_motion/dto/requests/servo_tuning_paramset_response.py +48 -48
  297. zaber_motion/dto/requests/servo_tuning_request.py +91 -91
  298. zaber_motion/dto/requests/set_device_db_layered_sources_request.py +56 -56
  299. zaber_motion/dto/requests/set_device_db_source_request.py +63 -63
  300. zaber_motion/dto/requests/set_interface_checksum_enabled_request.py +56 -56
  301. zaber_motion/dto/requests/set_interface_timeout_request.py +65 -65
  302. zaber_motion/dto/requests/set_internal_mode_request.py +43 -43
  303. zaber_motion/dto/requests/set_io_port_label_request.py +100 -100
  304. zaber_motion/dto/requests/set_log_output_request.py +57 -57
  305. zaber_motion/dto/requests/set_process_controller_source.py +93 -93
  306. zaber_motion/dto/requests/set_servo_tuning_pid_request.py +135 -135
  307. zaber_motion/dto/requests/set_servo_tuning_request.py +116 -116
  308. zaber_motion/dto/requests/set_simple_tuning.py +174 -174
  309. zaber_motion/dto/requests/set_state_request.py +93 -93
  310. zaber_motion/dto/requests/stream_arc_request.py +199 -199
  311. zaber_motion/dto/requests/stream_buffer_erase_request.py +84 -84
  312. zaber_motion/dto/requests/stream_buffer_get_content_request.py +84 -84
  313. zaber_motion/dto/requests/stream_buffer_get_content_response.py +51 -51
  314. zaber_motion/dto/requests/stream_buffer_list.py +70 -70
  315. zaber_motion/dto/requests/stream_call_request.py +112 -112
  316. zaber_motion/dto/requests/stream_cancel_all_outputs_schedule_request.py +99 -99
  317. zaber_motion/dto/requests/stream_cancel_output_schedule_request.py +103 -103
  318. zaber_motion/dto/requests/stream_circle_request.py +155 -155
  319. zaber_motion/dto/requests/stream_empty_request.py +84 -84
  320. zaber_motion/dto/requests/stream_generic_command_batch_request.py +99 -99
  321. zaber_motion/dto/requests/stream_generic_command_request.py +93 -93
  322. zaber_motion/dto/requests/stream_get_axes_response.py +75 -75
  323. zaber_motion/dto/requests/stream_get_max_centripetal_acceleration_request.py +96 -96
  324. zaber_motion/dto/requests/stream_get_max_speed_request.py +96 -96
  325. zaber_motion/dto/requests/stream_get_max_tangential_acceleration_request.py +96 -96
  326. zaber_motion/dto/requests/stream_line_request.py +135 -135
  327. zaber_motion/dto/requests/stream_mode_response.py +60 -60
  328. zaber_motion/dto/requests/stream_segment_type.py +8 -8
  329. zaber_motion/dto/requests/stream_set_all_analog_outputs_request.py +101 -101
  330. zaber_motion/dto/requests/stream_set_all_analog_outputs_schedule_request.py +140 -140
  331. zaber_motion/dto/requests/stream_set_all_digital_outputs_request.py +102 -102
  332. zaber_motion/dto/requests/stream_set_all_digital_outputs_schedule_request.py +141 -141
  333. zaber_motion/dto/requests/stream_set_analog_output_request.py +109 -109
  334. zaber_motion/dto/requests/stream_set_analog_output_schedule_request.py +143 -143
  335. zaber_motion/dto/requests/stream_set_digital_output_request.py +110 -110
  336. zaber_motion/dto/requests/stream_set_digital_output_schedule_request.py +144 -144
  337. zaber_motion/dto/requests/stream_set_hold_request.py +89 -89
  338. zaber_motion/dto/requests/stream_set_max_centripetal_acceleration_request.py +107 -107
  339. zaber_motion/dto/requests/stream_set_max_speed_request.py +107 -107
  340. zaber_motion/dto/requests/stream_set_max_tangential_acceleration_request.py +107 -107
  341. zaber_motion/dto/requests/stream_setup_live_composite_request.py +123 -123
  342. zaber_motion/dto/requests/stream_setup_live_request.py +104 -104
  343. zaber_motion/dto/requests/stream_setup_store_arbitrary_axes_request.py +126 -126
  344. zaber_motion/dto/requests/stream_setup_store_composite_request.py +151 -151
  345. zaber_motion/dto/requests/stream_setup_store_request.py +132 -132
  346. zaber_motion/dto/requests/stream_wait_analog_input_request.py +118 -118
  347. zaber_motion/dto/requests/stream_wait_digital_input_request.py +103 -103
  348. zaber_motion/dto/requests/stream_wait_request.py +107 -107
  349. zaber_motion/dto/requests/stream_wait_until_idle_request.py +89 -89
  350. zaber_motion/dto/requests/string_array_response.py +51 -51
  351. zaber_motion/dto/requests/string_response.py +45 -45
  352. zaber_motion/dto/requests/test_event.py +45 -45
  353. zaber_motion/dto/requests/test_request.py +55 -55
  354. zaber_motion/dto/requests/test_request_complex.py +57 -0
  355. zaber_motion/dto/requests/test_response.py +45 -45
  356. zaber_motion/dto/requests/test_response_long.py +51 -51
  357. zaber_motion/dto/requests/toggle_device_db_store_request.py +50 -50
  358. zaber_motion/dto/requests/tools_list_serial_ports_response.py +51 -51
  359. zaber_motion/dto/requests/translator_create_from_device_request.py +97 -97
  360. zaber_motion/dto/requests/translator_create_live_request.py +91 -91
  361. zaber_motion/dto/requests/translator_create_request.py +62 -62
  362. zaber_motion/dto/requests/translator_create_response.py +51 -51
  363. zaber_motion/dto/requests/translator_empty_request.py +51 -51
  364. zaber_motion/dto/requests/translator_flush_live_request.py +56 -56
  365. zaber_motion/dto/requests/translator_flush_response.py +51 -51
  366. zaber_motion/dto/requests/translator_get_axis_offset_request.py +81 -81
  367. zaber_motion/dto/requests/translator_get_axis_position_request.py +72 -72
  368. zaber_motion/dto/requests/translator_set_axis_position_request.py +83 -83
  369. zaber_motion/dto/requests/translator_set_feed_rate_override_request.py +62 -62
  370. zaber_motion/dto/requests/translator_set_traverse_rate_request.py +74 -74
  371. zaber_motion/dto/requests/translator_translate_request.py +60 -60
  372. zaber_motion/dto/requests/trigger_clear_action_request.py +91 -91
  373. zaber_motion/dto/requests/trigger_empty_request.py +79 -79
  374. zaber_motion/dto/requests/trigger_enable_request.py +93 -93
  375. zaber_motion/dto/requests/trigger_enabled_states.py +56 -56
  376. zaber_motion/dto/requests/trigger_fire_at_interval_request.py +102 -102
  377. zaber_motion/dto/requests/trigger_fire_when_distance_travelled_request.py +116 -116
  378. zaber_motion/dto/requests/trigger_fire_when_io_request.py +128 -128
  379. zaber_motion/dto/requests/trigger_fire_when_request.py +88 -88
  380. zaber_motion/dto/requests/trigger_fire_when_setting_request.py +137 -137
  381. zaber_motion/dto/requests/trigger_on_fire_request.py +114 -114
  382. zaber_motion/dto/requests/trigger_on_fire_set_request.py +149 -149
  383. zaber_motion/dto/requests/trigger_on_fire_set_to_setting_request.py +149 -149
  384. zaber_motion/dto/requests/trigger_set_label_request.py +88 -88
  385. zaber_motion/dto/requests/trigger_states.py +56 -56
  386. zaber_motion/dto/requests/unit_convert_unit_request.py +71 -71
  387. zaber_motion/dto/requests/unit_get_enum_request.py +45 -45
  388. zaber_motion/dto/requests/unit_get_enum_response.py +48 -48
  389. zaber_motion/dto/requests/unit_get_symbol_request.py +48 -48
  390. zaber_motion/dto/requests/unit_get_symbol_response.py +45 -45
  391. zaber_motion/dto/requests/unknown_binary_response_event_wrapper.py +82 -82
  392. zaber_motion/dto/requests/unknown_response_event_wrapper.py +82 -82
  393. zaber_motion/dto/requests/wait_to_clear_warnings_request.py +105 -105
  394. zaber_motion/dto/requests/wait_to_respond_request.py +76 -76
  395. zaber_motion/dto/requests/wdi_generic_float_request.py +119 -0
  396. zaber_motion/dto/requests/wdi_generic_request.py +136 -136
  397. zaber_motion/dto/requests/wdi_get_status_response.py +50 -50
  398. zaber_motion/dto/rotation_direction.py +13 -13
  399. zaber_motion/dto_object.py +18 -18
  400. zaber_motion/events.py +112 -112
  401. zaber_motion/exceptions/__init__.py +87 -87
  402. zaber_motion/exceptions/bad_command_exception.py +10 -10
  403. zaber_motion/exceptions/bad_data_exception.py +10 -10
  404. zaber_motion/exceptions/binary_command_failed_exception.py +27 -27
  405. zaber_motion/exceptions/command_failed_exception.py +27 -27
  406. zaber_motion/exceptions/command_preempted_exception.py +10 -10
  407. zaber_motion/exceptions/command_too_long_exception.py +27 -27
  408. zaber_motion/exceptions/connection_closed_exception.py +10 -10
  409. zaber_motion/exceptions/connection_failed_exception.py +10 -10
  410. zaber_motion/exceptions/conversion_failed_exception.py +10 -10
  411. zaber_motion/exceptions/device_address_conflict_exception.py +27 -27
  412. zaber_motion/exceptions/device_busy_exception.py +10 -10
  413. zaber_motion/exceptions/device_db_failed_exception.py +27 -27
  414. zaber_motion/exceptions/device_detection_failed_exception.py +10 -10
  415. zaber_motion/exceptions/device_failed_exception.py +11 -11
  416. zaber_motion/exceptions/device_not_identified_exception.py +10 -10
  417. zaber_motion/exceptions/driver_disabled_exception.py +10 -10
  418. zaber_motion/exceptions/g_code_execution_exception.py +27 -27
  419. zaber_motion/exceptions/g_code_syntax_exception.py +27 -27
  420. zaber_motion/exceptions/incompatible_shared_library_exception.py +11 -11
  421. zaber_motion/exceptions/internal_error_exception.py +10 -10
  422. zaber_motion/exceptions/invalid_argument_exception.py +10 -10
  423. zaber_motion/exceptions/invalid_csv_data_exception.py +10 -10
  424. zaber_motion/exceptions/invalid_data_exception.py +10 -10
  425. zaber_motion/exceptions/invalid_operation_exception.py +10 -10
  426. zaber_motion/exceptions/invalid_packet_exception.py +27 -27
  427. zaber_motion/exceptions/invalid_park_state_exception.py +10 -10
  428. zaber_motion/exceptions/invalid_request_data_exception.py +11 -11
  429. zaber_motion/exceptions/invalid_response_exception.py +27 -27
  430. zaber_motion/exceptions/io_channel_out_of_range_exception.py +10 -10
  431. zaber_motion/exceptions/io_failed_exception.py +10 -10
  432. zaber_motion/exceptions/lockstep_enabled_exception.py +10 -10
  433. zaber_motion/exceptions/lockstep_not_enabled_exception.py +10 -10
  434. zaber_motion/exceptions/motion_lib_exception.py +18 -18
  435. zaber_motion/exceptions/movement_failed_exception.py +27 -27
  436. zaber_motion/exceptions/movement_interrupted_exception.py +27 -27
  437. zaber_motion/exceptions/no_device_found_exception.py +10 -10
  438. zaber_motion/exceptions/no_value_for_key_exception.py +10 -10
  439. zaber_motion/exceptions/not_supported_exception.py +10 -10
  440. zaber_motion/exceptions/operation_failed_exception.py +27 -27
  441. zaber_motion/exceptions/os_failed_exception.py +10 -10
  442. zaber_motion/exceptions/out_of_request_ids_exception.py +10 -10
  443. zaber_motion/exceptions/pvt_discontinuity_exception.py +10 -10
  444. zaber_motion/exceptions/pvt_execution_exception.py +27 -27
  445. zaber_motion/exceptions/pvt_mode_exception.py +10 -10
  446. zaber_motion/exceptions/pvt_movement_failed_exception.py +27 -27
  447. zaber_motion/exceptions/pvt_movement_interrupted_exception.py +27 -27
  448. zaber_motion/exceptions/pvt_sequence_generation_failed_exception.py +10 -10
  449. zaber_motion/exceptions/pvt_setup_failed_exception.py +10 -10
  450. zaber_motion/exceptions/remote_mode_exception.py +11 -11
  451. zaber_motion/exceptions/request_timeout_exception.py +10 -10
  452. zaber_motion/exceptions/serial_port_busy_exception.py +10 -10
  453. zaber_motion/exceptions/set_device_state_failed_exception.py +27 -27
  454. zaber_motion/exceptions/set_peripheral_state_failed_exception.py +27 -27
  455. zaber_motion/exceptions/setting_not_found_exception.py +10 -10
  456. zaber_motion/exceptions/stream_discontinuity_exception.py +10 -10
  457. zaber_motion/exceptions/stream_execution_exception.py +27 -27
  458. zaber_motion/exceptions/stream_mode_exception.py +10 -10
  459. zaber_motion/exceptions/stream_movement_failed_exception.py +27 -27
  460. zaber_motion/exceptions/stream_movement_interrupted_exception.py +27 -27
  461. zaber_motion/exceptions/stream_setup_failed_exception.py +10 -10
  462. zaber_motion/exceptions/timeout_exception.py +10 -10
  463. zaber_motion/exceptions/transport_already_used_exception.py +10 -10
  464. zaber_motion/exceptions/unknown_request_exception.py +10 -10
  465. zaber_motion/gcode/__init__.py +11 -11
  466. zaber_motion/gcode/offline_translator.py +401 -401
  467. zaber_motion/gcode/translator.py +424 -424
  468. zaber_motion/library.py +179 -179
  469. zaber_motion/microscopy/__init__.py +14 -14
  470. zaber_motion/microscopy/autofocus.py +645 -645
  471. zaber_motion/microscopy/camera_trigger.py +108 -108
  472. zaber_motion/microscopy/filter_changer.py +167 -167
  473. zaber_motion/microscopy/illuminator.py +139 -139
  474. zaber_motion/microscopy/illuminator_channel.py +616 -616
  475. zaber_motion/microscopy/microscope.py +315 -315
  476. zaber_motion/microscopy/objective_changer.py +403 -403
  477. zaber_motion/microscopy/wdi_autofocus_provider.py +536 -396
  478. zaber_motion/product/__init__.py +7 -7
  479. zaber_motion/product/process.py +818 -818
  480. zaber_motion/product/process_controller.py +134 -134
  481. zaber_motion/serialization.py +32 -32
  482. zaber_motion/tools.py +78 -78
  483. zaber_motion/unit_table.py +86 -86
  484. zaber_motion/units.py +206 -206
  485. zaber_motion/version.py +1 -1
  486. {zaber_motion-7.12.0.dist-info → zaber_motion-7.14.0.dist-info}/LICENSE.txt +2119 -2119
  487. {zaber_motion-7.12.0.dist-info → zaber_motion-7.14.0.dist-info}/METADATA +1 -1
  488. zaber_motion-7.14.0.dist-info/RECORD +496 -0
  489. zaber_motion_bindings/zaber-motion-core-windows-386.dll +0 -0
  490. zaber_motion-7.12.0.dist-info/RECORD +0 -494
  491. {zaber_motion-7.12.0.dist-info → zaber_motion-7.14.0.dist-info}/WHEEL +0 -0
  492. {zaber_motion-7.12.0.dist-info → zaber_motion-7.14.0.dist-info}/top_level.txt +0 -0
@@ -1,700 +1,700 @@
1
- # pylint: disable=too-many-arguments, too-many-lines
2
-
3
- # ===== THIS FILE IS GENERATED FROM A TEMPLATE ===== #
4
- # ============== DO NOT EDIT DIRECTLY ============== #
5
- from typing import TYPE_CHECKING, List
6
- from ..dto import requests as dto
7
- from ..units import Units, TimeUnits
8
- from ..call import call, call_async
9
- from ..dto.ascii.digital_output_action import DigitalOutputAction
10
-
11
- if TYPE_CHECKING:
12
- from .device import Device
13
-
14
-
15
- class StreamIo:
16
- """
17
- Class providing access to I/O for a stream.
18
- """
19
-
20
- def __init__(self, device: 'Device', stream_id: int):
21
- self._device: 'Device' = device
22
- self._stream_id: int = stream_id
23
-
24
- def set_digital_output(
25
- self,
26
- channel_number: int,
27
- value: DigitalOutputAction
28
- ) -> None:
29
- """
30
- Sets value for the specified digital output channel.
31
-
32
- Args:
33
- channel_number: Channel number starting at 1.
34
- value: The type of action to perform on the channel.
35
- """
36
- request = dto.StreamSetDigitalOutputRequest(
37
- interface_id=self._device.connection.interface_id,
38
- device=self._device.device_address,
39
- stream_id=self._stream_id,
40
- channel_number=channel_number,
41
- value=value,
42
- )
43
- call("device/stream_set_digital_output", request)
44
-
45
- async def set_digital_output_async(
46
- self,
47
- channel_number: int,
48
- value: DigitalOutputAction
49
- ) -> None:
50
- """
51
- Sets value for the specified digital output channel.
52
-
53
- Args:
54
- channel_number: Channel number starting at 1.
55
- value: The type of action to perform on the channel.
56
- """
57
- request = dto.StreamSetDigitalOutputRequest(
58
- interface_id=self._device.connection.interface_id,
59
- device=self._device.device_address,
60
- stream_id=self._stream_id,
61
- channel_number=channel_number,
62
- value=value,
63
- )
64
- await call_async("device/stream_set_digital_output", request)
65
-
66
- def set_all_digital_outputs(
67
- self,
68
- values: List[DigitalOutputAction]
69
- ) -> None:
70
- """
71
- Sets values for all digital output channels.
72
-
73
- Args:
74
- values: The type of action to perform on the channel.
75
- """
76
- request = dto.StreamSetAllDigitalOutputsRequest(
77
- interface_id=self._device.connection.interface_id,
78
- device=self._device.device_address,
79
- stream_id=self._stream_id,
80
- values=values,
81
- )
82
- call("device/stream_set_all_digital_outputs", request)
83
-
84
- async def set_all_digital_outputs_async(
85
- self,
86
- values: List[DigitalOutputAction]
87
- ) -> None:
88
- """
89
- Sets values for all digital output channels.
90
-
91
- Args:
92
- values: The type of action to perform on the channel.
93
- """
94
- request = dto.StreamSetAllDigitalOutputsRequest(
95
- interface_id=self._device.connection.interface_id,
96
- device=self._device.device_address,
97
- stream_id=self._stream_id,
98
- values=values,
99
- )
100
- await call_async("device/stream_set_all_digital_outputs", request)
101
-
102
- def set_digital_output_schedule(
103
- self,
104
- channel_number: int,
105
- value: DigitalOutputAction,
106
- future_value: DigitalOutputAction,
107
- delay: float,
108
- unit: TimeUnits = Units.NATIVE
109
- ) -> None:
110
- """
111
- Sets current and future value for the specified digital output channel.
112
- Requires at least Firmware 7.37.
113
-
114
- Args:
115
- channel_number: Channel number starting at 1.
116
- value: The type of action to perform immediately on the channel.
117
- future_value: The type of action to perform in the future on the channel.
118
- delay: Delay between setting current value and setting future value.
119
- unit: Units of time.
120
- """
121
- if delay <= 0:
122
- raise ValueError('Delay must be a positive value.')
123
-
124
- request = dto.StreamSetDigitalOutputScheduleRequest(
125
- interface_id=self._device.connection.interface_id,
126
- device=self._device.device_address,
127
- stream_id=self._stream_id,
128
- channel_number=channel_number,
129
- value=value,
130
- future_value=future_value,
131
- delay=delay,
132
- unit=unit,
133
- )
134
- call("device/stream_set_digital_output_schedule", request)
135
-
136
- async def set_digital_output_schedule_async(
137
- self,
138
- channel_number: int,
139
- value: DigitalOutputAction,
140
- future_value: DigitalOutputAction,
141
- delay: float,
142
- unit: TimeUnits = Units.NATIVE
143
- ) -> None:
144
- """
145
- Sets current and future value for the specified digital output channel.
146
- Requires at least Firmware 7.37.
147
-
148
- Args:
149
- channel_number: Channel number starting at 1.
150
- value: The type of action to perform immediately on the channel.
151
- future_value: The type of action to perform in the future on the channel.
152
- delay: Delay between setting current value and setting future value.
153
- unit: Units of time.
154
- """
155
- if delay <= 0:
156
- raise ValueError('Delay must be a positive value.')
157
-
158
- request = dto.StreamSetDigitalOutputScheduleRequest(
159
- interface_id=self._device.connection.interface_id,
160
- device=self._device.device_address,
161
- stream_id=self._stream_id,
162
- channel_number=channel_number,
163
- value=value,
164
- future_value=future_value,
165
- delay=delay,
166
- unit=unit,
167
- )
168
- await call_async("device/stream_set_digital_output_schedule", request)
169
-
170
- def set_all_digital_outputs_schedule(
171
- self,
172
- values: List[DigitalOutputAction],
173
- future_values: List[DigitalOutputAction],
174
- delay: float,
175
- unit: TimeUnits = Units.NATIVE
176
- ) -> None:
177
- """
178
- Sets current and future values for all digital output channels.
179
- Requires at least Firmware 7.37.
180
-
181
- Args:
182
- values: The type of actions to perform immediately on output channels.
183
- future_values: The type of actions to perform in the future on output channels.
184
- delay: Delay between setting current values and setting future values.
185
- unit: Units of time.
186
- """
187
- if delay <= 0:
188
- raise ValueError('Delay must be a positive value.')
189
-
190
- request = dto.StreamSetAllDigitalOutputsScheduleRequest(
191
- interface_id=self._device.connection.interface_id,
192
- device=self._device.device_address,
193
- stream_id=self._stream_id,
194
- values=values,
195
- future_values=future_values,
196
- delay=delay,
197
- unit=unit,
198
- )
199
- call("device/stream_set_all_digital_outputs_schedule", request)
200
-
201
- async def set_all_digital_outputs_schedule_async(
202
- self,
203
- values: List[DigitalOutputAction],
204
- future_values: List[DigitalOutputAction],
205
- delay: float,
206
- unit: TimeUnits = Units.NATIVE
207
- ) -> None:
208
- """
209
- Sets current and future values for all digital output channels.
210
- Requires at least Firmware 7.37.
211
-
212
- Args:
213
- values: The type of actions to perform immediately on output channels.
214
- future_values: The type of actions to perform in the future on output channels.
215
- delay: Delay between setting current values and setting future values.
216
- unit: Units of time.
217
- """
218
- if delay <= 0:
219
- raise ValueError('Delay must be a positive value.')
220
-
221
- request = dto.StreamSetAllDigitalOutputsScheduleRequest(
222
- interface_id=self._device.connection.interface_id,
223
- device=self._device.device_address,
224
- stream_id=self._stream_id,
225
- values=values,
226
- future_values=future_values,
227
- delay=delay,
228
- unit=unit,
229
- )
230
- await call_async("device/stream_set_all_digital_outputs_schedule", request)
231
-
232
- def set_analog_output(
233
- self,
234
- channel_number: int,
235
- value: float
236
- ) -> None:
237
- """
238
- Sets value for the specified analog output channel.
239
-
240
- Args:
241
- channel_number: Channel number starting at 1.
242
- value: Value to set the output channel voltage to.
243
- """
244
- request = dto.StreamSetAnalogOutputRequest(
245
- interface_id=self._device.connection.interface_id,
246
- device=self._device.device_address,
247
- stream_id=self._stream_id,
248
- channel_number=channel_number,
249
- value=value,
250
- )
251
- call("device/stream_set_analog_output", request)
252
-
253
- async def set_analog_output_async(
254
- self,
255
- channel_number: int,
256
- value: float
257
- ) -> None:
258
- """
259
- Sets value for the specified analog output channel.
260
-
261
- Args:
262
- channel_number: Channel number starting at 1.
263
- value: Value to set the output channel voltage to.
264
- """
265
- request = dto.StreamSetAnalogOutputRequest(
266
- interface_id=self._device.connection.interface_id,
267
- device=self._device.device_address,
268
- stream_id=self._stream_id,
269
- channel_number=channel_number,
270
- value=value,
271
- )
272
- await call_async("device/stream_set_analog_output", request)
273
-
274
- def set_all_analog_outputs(
275
- self,
276
- values: List[float]
277
- ) -> None:
278
- """
279
- Sets values for all analog output channels.
280
-
281
- Args:
282
- values: Voltage values to set the output channels to.
283
- """
284
- request = dto.StreamSetAllAnalogOutputsRequest(
285
- interface_id=self._device.connection.interface_id,
286
- device=self._device.device_address,
287
- stream_id=self._stream_id,
288
- values=values,
289
- )
290
- call("device/stream_set_all_analog_outputs", request)
291
-
292
- async def set_all_analog_outputs_async(
293
- self,
294
- values: List[float]
295
- ) -> None:
296
- """
297
- Sets values for all analog output channels.
298
-
299
- Args:
300
- values: Voltage values to set the output channels to.
301
- """
302
- request = dto.StreamSetAllAnalogOutputsRequest(
303
- interface_id=self._device.connection.interface_id,
304
- device=self._device.device_address,
305
- stream_id=self._stream_id,
306
- values=values,
307
- )
308
- await call_async("device/stream_set_all_analog_outputs", request)
309
-
310
- def set_analog_output_schedule(
311
- self,
312
- channel_number: int,
313
- value: float,
314
- future_value: float,
315
- delay: float,
316
- unit: TimeUnits = Units.NATIVE
317
- ) -> None:
318
- """
319
- Sets current and future value for the specified analog output channel.
320
- Requires at least Firmware 7.38.
321
-
322
- Args:
323
- channel_number: Channel number starting at 1.
324
- value: Value to set the output channel voltage to immediately.
325
- future_value: Value to set the output channel voltage to in the future.
326
- delay: Delay between setting current value and setting future value.
327
- unit: Units of time.
328
- """
329
- if delay <= 0:
330
- raise ValueError('Delay must be a positive value.')
331
-
332
- request = dto.StreamSetAnalogOutputScheduleRequest(
333
- interface_id=self._device.connection.interface_id,
334
- device=self._device.device_address,
335
- stream_id=self._stream_id,
336
- channel_number=channel_number,
337
- value=value,
338
- future_value=future_value,
339
- delay=delay,
340
- unit=unit,
341
- )
342
- call("device/stream_set_analog_output_schedule", request)
343
-
344
- async def set_analog_output_schedule_async(
345
- self,
346
- channel_number: int,
347
- value: float,
348
- future_value: float,
349
- delay: float,
350
- unit: TimeUnits = Units.NATIVE
351
- ) -> None:
352
- """
353
- Sets current and future value for the specified analog output channel.
354
- Requires at least Firmware 7.38.
355
-
356
- Args:
357
- channel_number: Channel number starting at 1.
358
- value: Value to set the output channel voltage to immediately.
359
- future_value: Value to set the output channel voltage to in the future.
360
- delay: Delay between setting current value and setting future value.
361
- unit: Units of time.
362
- """
363
- if delay <= 0:
364
- raise ValueError('Delay must be a positive value.')
365
-
366
- request = dto.StreamSetAnalogOutputScheduleRequest(
367
- interface_id=self._device.connection.interface_id,
368
- device=self._device.device_address,
369
- stream_id=self._stream_id,
370
- channel_number=channel_number,
371
- value=value,
372
- future_value=future_value,
373
- delay=delay,
374
- unit=unit,
375
- )
376
- await call_async("device/stream_set_analog_output_schedule", request)
377
-
378
- def set_all_analog_outputs_schedule(
379
- self,
380
- values: List[float],
381
- future_values: List[float],
382
- delay: float,
383
- unit: TimeUnits = Units.NATIVE
384
- ) -> None:
385
- """
386
- Sets current and future values for all analog output channels.
387
- Requires at least Firmware 7.38.
388
-
389
- Args:
390
- values: Voltage values to set the output channels to immediately.
391
- future_values: Voltage values to set the output channels to in the future.
392
- delay: Delay between setting current values and setting future values.
393
- unit: Units of time.
394
- """
395
- if delay <= 0:
396
- raise ValueError('Delay must be a positive value.')
397
-
398
- request = dto.StreamSetAllAnalogOutputsScheduleRequest(
399
- interface_id=self._device.connection.interface_id,
400
- device=self._device.device_address,
401
- stream_id=self._stream_id,
402
- values=values,
403
- future_values=future_values,
404
- delay=delay,
405
- unit=unit,
406
- )
407
- call("device/stream_set_all_analog_outputs_schedule", request)
408
-
409
- async def set_all_analog_outputs_schedule_async(
410
- self,
411
- values: List[float],
412
- future_values: List[float],
413
- delay: float,
414
- unit: TimeUnits = Units.NATIVE
415
- ) -> None:
416
- """
417
- Sets current and future values for all analog output channels.
418
- Requires at least Firmware 7.38.
419
-
420
- Args:
421
- values: Voltage values to set the output channels to immediately.
422
- future_values: Voltage values to set the output channels to in the future.
423
- delay: Delay between setting current values and setting future values.
424
- unit: Units of time.
425
- """
426
- if delay <= 0:
427
- raise ValueError('Delay must be a positive value.')
428
-
429
- request = dto.StreamSetAllAnalogOutputsScheduleRequest(
430
- interface_id=self._device.connection.interface_id,
431
- device=self._device.device_address,
432
- stream_id=self._stream_id,
433
- values=values,
434
- future_values=future_values,
435
- delay=delay,
436
- unit=unit,
437
- )
438
- await call_async("device/stream_set_all_analog_outputs_schedule", request)
439
-
440
- def cancel_digital_output_schedule(
441
- self,
442
- channel_number: int
443
- ) -> None:
444
- """
445
- Cancels a scheduled digital output action.
446
- Requires at least Firmware 7.37.
447
-
448
- Args:
449
- channel_number: Channel number starting at 1.
450
- """
451
- request = dto.StreamCancelOutputScheduleRequest(
452
- interface_id=self._device.connection.interface_id,
453
- device=self._device.device_address,
454
- analog=False,
455
- stream_id=self._stream_id,
456
- channel_number=channel_number,
457
- )
458
- call("device/stream_cancel_output_schedule", request)
459
-
460
- async def cancel_digital_output_schedule_async(
461
- self,
462
- channel_number: int
463
- ) -> None:
464
- """
465
- Cancels a scheduled digital output action.
466
- Requires at least Firmware 7.37.
467
-
468
- Args:
469
- channel_number: Channel number starting at 1.
470
- """
471
- request = dto.StreamCancelOutputScheduleRequest(
472
- interface_id=self._device.connection.interface_id,
473
- device=self._device.device_address,
474
- analog=False,
475
- stream_id=self._stream_id,
476
- channel_number=channel_number,
477
- )
478
- await call_async("device/stream_cancel_output_schedule", request)
479
-
480
- def cancel_all_digital_outputs_schedule(
481
- self,
482
- channels: List[bool] = []
483
- ) -> None:
484
- """
485
- Cancel all scheduled digital output actions.
486
- Requires at least Firmware 7.37.
487
-
488
- Args:
489
- channels: Optionally specify which channels to cancel.
490
- Array length must be empty or equal to the number of channels on device.
491
- Specifying "True" for a channel will cancel the scheduled digital output action for that channel.
492
- """
493
- request = dto.StreamCancelAllOutputsScheduleRequest(
494
- interface_id=self._device.connection.interface_id,
495
- device=self._device.device_address,
496
- analog=False,
497
- stream_id=self._stream_id,
498
- channels=channels,
499
- )
500
- call("device/stream_cancel_all_outputs_schedule", request)
501
-
502
- async def cancel_all_digital_outputs_schedule_async(
503
- self,
504
- channels: List[bool] = []
505
- ) -> None:
506
- """
507
- Cancel all scheduled digital output actions.
508
- Requires at least Firmware 7.37.
509
-
510
- Args:
511
- channels: Optionally specify which channels to cancel.
512
- Array length must be empty or equal to the number of channels on device.
513
- Specifying "True" for a channel will cancel the scheduled digital output action for that channel.
514
- """
515
- request = dto.StreamCancelAllOutputsScheduleRequest(
516
- interface_id=self._device.connection.interface_id,
517
- device=self._device.device_address,
518
- analog=False,
519
- stream_id=self._stream_id,
520
- channels=channels,
521
- )
522
- await call_async("device/stream_cancel_all_outputs_schedule", request)
523
-
524
- def cancel_analog_output_schedule(
525
- self,
526
- channel_number: int
527
- ) -> None:
528
- """
529
- Cancels a scheduled analog output value.
530
- Requires at least Firmware 7.38.
531
-
532
- Args:
533
- channel_number: Channel number starting at 1.
534
- """
535
- request = dto.StreamCancelOutputScheduleRequest(
536
- interface_id=self._device.connection.interface_id,
537
- device=self._device.device_address,
538
- analog=True,
539
- stream_id=self._stream_id,
540
- channel_number=channel_number,
541
- )
542
- call("device/stream_cancel_output_schedule", request)
543
-
544
- async def cancel_analog_output_schedule_async(
545
- self,
546
- channel_number: int
547
- ) -> None:
548
- """
549
- Cancels a scheduled analog output value.
550
- Requires at least Firmware 7.38.
551
-
552
- Args:
553
- channel_number: Channel number starting at 1.
554
- """
555
- request = dto.StreamCancelOutputScheduleRequest(
556
- interface_id=self._device.connection.interface_id,
557
- device=self._device.device_address,
558
- analog=True,
559
- stream_id=self._stream_id,
560
- channel_number=channel_number,
561
- )
562
- await call_async("device/stream_cancel_output_schedule", request)
563
-
564
- def cancel_all_analog_outputs_schedule(
565
- self,
566
- channels: List[bool] = []
567
- ) -> None:
568
- """
569
- Cancel all scheduled analog output actions.
570
- Requires at least Firmware 7.38.
571
-
572
- Args:
573
- channels: Optionally specify which channels to cancel.
574
- Array length must be empty or equal to the number of channels on device.
575
- Specifying "True" for a channel will cancel the scheduled analog output value for that channel.
576
- """
577
- request = dto.StreamCancelAllOutputsScheduleRequest(
578
- interface_id=self._device.connection.interface_id,
579
- device=self._device.device_address,
580
- analog=True,
581
- stream_id=self._stream_id,
582
- channels=channels,
583
- )
584
- call("device/stream_cancel_all_outputs_schedule", request)
585
-
586
- async def cancel_all_analog_outputs_schedule_async(
587
- self,
588
- channels: List[bool] = []
589
- ) -> None:
590
- """
591
- Cancel all scheduled analog output actions.
592
- Requires at least Firmware 7.38.
593
-
594
- Args:
595
- channels: Optionally specify which channels to cancel.
596
- Array length must be empty or equal to the number of channels on device.
597
- Specifying "True" for a channel will cancel the scheduled analog output value for that channel.
598
- """
599
- request = dto.StreamCancelAllOutputsScheduleRequest(
600
- interface_id=self._device.connection.interface_id,
601
- device=self._device.device_address,
602
- analog=True,
603
- stream_id=self._stream_id,
604
- channels=channels,
605
- )
606
- await call_async("device/stream_cancel_all_outputs_schedule", request)
607
-
608
- def wait_digital_input(
609
- self,
610
- channel_number: int,
611
- value: bool
612
- ) -> None:
613
- """
614
- Wait for a digital input channel to reach a given value.
615
-
616
- Args:
617
- channel_number: The number of the digital input channel.
618
- Channel numbers are numbered from one.
619
- value: The value that the stream should wait for.
620
- """
621
- request = dto.StreamWaitDigitalInputRequest(
622
- interface_id=self._device.connection.interface_id,
623
- device=self._device.device_address,
624
- stream_id=self._stream_id,
625
- channel_number=channel_number,
626
- value=value,
627
- )
628
- call("device/stream_wait_digital_input", request)
629
-
630
- async def wait_digital_input_async(
631
- self,
632
- channel_number: int,
633
- value: bool
634
- ) -> None:
635
- """
636
- Wait for a digital input channel to reach a given value.
637
-
638
- Args:
639
- channel_number: The number of the digital input channel.
640
- Channel numbers are numbered from one.
641
- value: The value that the stream should wait for.
642
- """
643
- request = dto.StreamWaitDigitalInputRequest(
644
- interface_id=self._device.connection.interface_id,
645
- device=self._device.device_address,
646
- stream_id=self._stream_id,
647
- channel_number=channel_number,
648
- value=value,
649
- )
650
- await call_async("device/stream_wait_digital_input", request)
651
-
652
- def wait_analog_input(
653
- self,
654
- channel_number: int,
655
- condition: str,
656
- value: float
657
- ) -> None:
658
- """
659
- Wait for the value of a analog input channel to reach a condition concerning a given value.
660
-
661
- Args:
662
- channel_number: The number of the analog input channel.
663
- Channel numbers are numbered from one.
664
- condition: A condition (e.g. <, <=, ==, !=).
665
- value: The value that the condition concerns, in Volts.
666
- """
667
- request = dto.StreamWaitAnalogInputRequest(
668
- interface_id=self._device.connection.interface_id,
669
- device=self._device.device_address,
670
- stream_id=self._stream_id,
671
- channel_number=channel_number,
672
- condition=condition,
673
- value=value,
674
- )
675
- call("device/stream_wait_analog_input", request)
676
-
677
- async def wait_analog_input_async(
678
- self,
679
- channel_number: int,
680
- condition: str,
681
- value: float
682
- ) -> None:
683
- """
684
- Wait for the value of a analog input channel to reach a condition concerning a given value.
685
-
686
- Args:
687
- channel_number: The number of the analog input channel.
688
- Channel numbers are numbered from one.
689
- condition: A condition (e.g. <, <=, ==, !=).
690
- value: The value that the condition concerns, in Volts.
691
- """
692
- request = dto.StreamWaitAnalogInputRequest(
693
- interface_id=self._device.connection.interface_id,
694
- device=self._device.device_address,
695
- stream_id=self._stream_id,
696
- channel_number=channel_number,
697
- condition=condition,
698
- value=value,
699
- )
700
- await call_async("device/stream_wait_analog_input", request)
1
+ # pylint: disable=too-many-arguments, too-many-lines
2
+
3
+ # ===== THIS FILE IS GENERATED FROM A TEMPLATE ===== #
4
+ # ============== DO NOT EDIT DIRECTLY ============== #
5
+ from typing import TYPE_CHECKING, List
6
+ from ..dto import requests as dto
7
+ from ..units import Units, TimeUnits
8
+ from ..call import call, call_async
9
+ from ..dto.ascii.digital_output_action import DigitalOutputAction
10
+
11
+ if TYPE_CHECKING:
12
+ from .device import Device
13
+
14
+
15
+ class StreamIo:
16
+ """
17
+ Class providing access to I/O for a stream.
18
+ """
19
+
20
+ def __init__(self, device: 'Device', stream_id: int):
21
+ self._device: 'Device' = device
22
+ self._stream_id: int = stream_id
23
+
24
+ def set_digital_output(
25
+ self,
26
+ channel_number: int,
27
+ value: DigitalOutputAction
28
+ ) -> None:
29
+ """
30
+ Sets value for the specified digital output channel.
31
+
32
+ Args:
33
+ channel_number: Channel number starting at 1.
34
+ value: The type of action to perform on the channel.
35
+ """
36
+ request = dto.StreamSetDigitalOutputRequest(
37
+ interface_id=self._device.connection.interface_id,
38
+ device=self._device.device_address,
39
+ stream_id=self._stream_id,
40
+ channel_number=channel_number,
41
+ value=value,
42
+ )
43
+ call("device/stream_set_digital_output", request)
44
+
45
+ async def set_digital_output_async(
46
+ self,
47
+ channel_number: int,
48
+ value: DigitalOutputAction
49
+ ) -> None:
50
+ """
51
+ Sets value for the specified digital output channel.
52
+
53
+ Args:
54
+ channel_number: Channel number starting at 1.
55
+ value: The type of action to perform on the channel.
56
+ """
57
+ request = dto.StreamSetDigitalOutputRequest(
58
+ interface_id=self._device.connection.interface_id,
59
+ device=self._device.device_address,
60
+ stream_id=self._stream_id,
61
+ channel_number=channel_number,
62
+ value=value,
63
+ )
64
+ await call_async("device/stream_set_digital_output", request)
65
+
66
+ def set_all_digital_outputs(
67
+ self,
68
+ values: List[DigitalOutputAction]
69
+ ) -> None:
70
+ """
71
+ Sets values for all digital output channels.
72
+
73
+ Args:
74
+ values: The type of action to perform on the channel.
75
+ """
76
+ request = dto.StreamSetAllDigitalOutputsRequest(
77
+ interface_id=self._device.connection.interface_id,
78
+ device=self._device.device_address,
79
+ stream_id=self._stream_id,
80
+ values=values,
81
+ )
82
+ call("device/stream_set_all_digital_outputs", request)
83
+
84
+ async def set_all_digital_outputs_async(
85
+ self,
86
+ values: List[DigitalOutputAction]
87
+ ) -> None:
88
+ """
89
+ Sets values for all digital output channels.
90
+
91
+ Args:
92
+ values: The type of action to perform on the channel.
93
+ """
94
+ request = dto.StreamSetAllDigitalOutputsRequest(
95
+ interface_id=self._device.connection.interface_id,
96
+ device=self._device.device_address,
97
+ stream_id=self._stream_id,
98
+ values=values,
99
+ )
100
+ await call_async("device/stream_set_all_digital_outputs", request)
101
+
102
+ def set_digital_output_schedule(
103
+ self,
104
+ channel_number: int,
105
+ value: DigitalOutputAction,
106
+ future_value: DigitalOutputAction,
107
+ delay: float,
108
+ unit: TimeUnits = Units.NATIVE
109
+ ) -> None:
110
+ """
111
+ Sets current and future value for the specified digital output channel.
112
+ Requires at least Firmware 7.37.
113
+
114
+ Args:
115
+ channel_number: Channel number starting at 1.
116
+ value: The type of action to perform immediately on the channel.
117
+ future_value: The type of action to perform in the future on the channel.
118
+ delay: Delay between setting current value and setting future value.
119
+ unit: Units of time.
120
+ """
121
+ if delay <= 0:
122
+ raise ValueError('Delay must be a positive value.')
123
+
124
+ request = dto.StreamSetDigitalOutputScheduleRequest(
125
+ interface_id=self._device.connection.interface_id,
126
+ device=self._device.device_address,
127
+ stream_id=self._stream_id,
128
+ channel_number=channel_number,
129
+ value=value,
130
+ future_value=future_value,
131
+ delay=delay,
132
+ unit=unit,
133
+ )
134
+ call("device/stream_set_digital_output_schedule", request)
135
+
136
+ async def set_digital_output_schedule_async(
137
+ self,
138
+ channel_number: int,
139
+ value: DigitalOutputAction,
140
+ future_value: DigitalOutputAction,
141
+ delay: float,
142
+ unit: TimeUnits = Units.NATIVE
143
+ ) -> None:
144
+ """
145
+ Sets current and future value for the specified digital output channel.
146
+ Requires at least Firmware 7.37.
147
+
148
+ Args:
149
+ channel_number: Channel number starting at 1.
150
+ value: The type of action to perform immediately on the channel.
151
+ future_value: The type of action to perform in the future on the channel.
152
+ delay: Delay between setting current value and setting future value.
153
+ unit: Units of time.
154
+ """
155
+ if delay <= 0:
156
+ raise ValueError('Delay must be a positive value.')
157
+
158
+ request = dto.StreamSetDigitalOutputScheduleRequest(
159
+ interface_id=self._device.connection.interface_id,
160
+ device=self._device.device_address,
161
+ stream_id=self._stream_id,
162
+ channel_number=channel_number,
163
+ value=value,
164
+ future_value=future_value,
165
+ delay=delay,
166
+ unit=unit,
167
+ )
168
+ await call_async("device/stream_set_digital_output_schedule", request)
169
+
170
+ def set_all_digital_outputs_schedule(
171
+ self,
172
+ values: List[DigitalOutputAction],
173
+ future_values: List[DigitalOutputAction],
174
+ delay: float,
175
+ unit: TimeUnits = Units.NATIVE
176
+ ) -> None:
177
+ """
178
+ Sets current and future values for all digital output channels.
179
+ Requires at least Firmware 7.37.
180
+
181
+ Args:
182
+ values: The type of actions to perform immediately on output channels.
183
+ future_values: The type of actions to perform in the future on output channels.
184
+ delay: Delay between setting current values and setting future values.
185
+ unit: Units of time.
186
+ """
187
+ if delay <= 0:
188
+ raise ValueError('Delay must be a positive value.')
189
+
190
+ request = dto.StreamSetAllDigitalOutputsScheduleRequest(
191
+ interface_id=self._device.connection.interface_id,
192
+ device=self._device.device_address,
193
+ stream_id=self._stream_id,
194
+ values=values,
195
+ future_values=future_values,
196
+ delay=delay,
197
+ unit=unit,
198
+ )
199
+ call("device/stream_set_all_digital_outputs_schedule", request)
200
+
201
+ async def set_all_digital_outputs_schedule_async(
202
+ self,
203
+ values: List[DigitalOutputAction],
204
+ future_values: List[DigitalOutputAction],
205
+ delay: float,
206
+ unit: TimeUnits = Units.NATIVE
207
+ ) -> None:
208
+ """
209
+ Sets current and future values for all digital output channels.
210
+ Requires at least Firmware 7.37.
211
+
212
+ Args:
213
+ values: The type of actions to perform immediately on output channels.
214
+ future_values: The type of actions to perform in the future on output channels.
215
+ delay: Delay between setting current values and setting future values.
216
+ unit: Units of time.
217
+ """
218
+ if delay <= 0:
219
+ raise ValueError('Delay must be a positive value.')
220
+
221
+ request = dto.StreamSetAllDigitalOutputsScheduleRequest(
222
+ interface_id=self._device.connection.interface_id,
223
+ device=self._device.device_address,
224
+ stream_id=self._stream_id,
225
+ values=values,
226
+ future_values=future_values,
227
+ delay=delay,
228
+ unit=unit,
229
+ )
230
+ await call_async("device/stream_set_all_digital_outputs_schedule", request)
231
+
232
+ def set_analog_output(
233
+ self,
234
+ channel_number: int,
235
+ value: float
236
+ ) -> None:
237
+ """
238
+ Sets value for the specified analog output channel.
239
+
240
+ Args:
241
+ channel_number: Channel number starting at 1.
242
+ value: Value to set the output channel voltage to.
243
+ """
244
+ request = dto.StreamSetAnalogOutputRequest(
245
+ interface_id=self._device.connection.interface_id,
246
+ device=self._device.device_address,
247
+ stream_id=self._stream_id,
248
+ channel_number=channel_number,
249
+ value=value,
250
+ )
251
+ call("device/stream_set_analog_output", request)
252
+
253
+ async def set_analog_output_async(
254
+ self,
255
+ channel_number: int,
256
+ value: float
257
+ ) -> None:
258
+ """
259
+ Sets value for the specified analog output channel.
260
+
261
+ Args:
262
+ channel_number: Channel number starting at 1.
263
+ value: Value to set the output channel voltage to.
264
+ """
265
+ request = dto.StreamSetAnalogOutputRequest(
266
+ interface_id=self._device.connection.interface_id,
267
+ device=self._device.device_address,
268
+ stream_id=self._stream_id,
269
+ channel_number=channel_number,
270
+ value=value,
271
+ )
272
+ await call_async("device/stream_set_analog_output", request)
273
+
274
+ def set_all_analog_outputs(
275
+ self,
276
+ values: List[float]
277
+ ) -> None:
278
+ """
279
+ Sets values for all analog output channels.
280
+
281
+ Args:
282
+ values: Voltage values to set the output channels to.
283
+ """
284
+ request = dto.StreamSetAllAnalogOutputsRequest(
285
+ interface_id=self._device.connection.interface_id,
286
+ device=self._device.device_address,
287
+ stream_id=self._stream_id,
288
+ values=values,
289
+ )
290
+ call("device/stream_set_all_analog_outputs", request)
291
+
292
+ async def set_all_analog_outputs_async(
293
+ self,
294
+ values: List[float]
295
+ ) -> None:
296
+ """
297
+ Sets values for all analog output channels.
298
+
299
+ Args:
300
+ values: Voltage values to set the output channels to.
301
+ """
302
+ request = dto.StreamSetAllAnalogOutputsRequest(
303
+ interface_id=self._device.connection.interface_id,
304
+ device=self._device.device_address,
305
+ stream_id=self._stream_id,
306
+ values=values,
307
+ )
308
+ await call_async("device/stream_set_all_analog_outputs", request)
309
+
310
+ def set_analog_output_schedule(
311
+ self,
312
+ channel_number: int,
313
+ value: float,
314
+ future_value: float,
315
+ delay: float,
316
+ unit: TimeUnits = Units.NATIVE
317
+ ) -> None:
318
+ """
319
+ Sets current and future value for the specified analog output channel.
320
+ Requires at least Firmware 7.38.
321
+
322
+ Args:
323
+ channel_number: Channel number starting at 1.
324
+ value: Value to set the output channel voltage to immediately.
325
+ future_value: Value to set the output channel voltage to in the future.
326
+ delay: Delay between setting current value and setting future value.
327
+ unit: Units of time.
328
+ """
329
+ if delay <= 0:
330
+ raise ValueError('Delay must be a positive value.')
331
+
332
+ request = dto.StreamSetAnalogOutputScheduleRequest(
333
+ interface_id=self._device.connection.interface_id,
334
+ device=self._device.device_address,
335
+ stream_id=self._stream_id,
336
+ channel_number=channel_number,
337
+ value=value,
338
+ future_value=future_value,
339
+ delay=delay,
340
+ unit=unit,
341
+ )
342
+ call("device/stream_set_analog_output_schedule", request)
343
+
344
+ async def set_analog_output_schedule_async(
345
+ self,
346
+ channel_number: int,
347
+ value: float,
348
+ future_value: float,
349
+ delay: float,
350
+ unit: TimeUnits = Units.NATIVE
351
+ ) -> None:
352
+ """
353
+ Sets current and future value for the specified analog output channel.
354
+ Requires at least Firmware 7.38.
355
+
356
+ Args:
357
+ channel_number: Channel number starting at 1.
358
+ value: Value to set the output channel voltage to immediately.
359
+ future_value: Value to set the output channel voltage to in the future.
360
+ delay: Delay between setting current value and setting future value.
361
+ unit: Units of time.
362
+ """
363
+ if delay <= 0:
364
+ raise ValueError('Delay must be a positive value.')
365
+
366
+ request = dto.StreamSetAnalogOutputScheduleRequest(
367
+ interface_id=self._device.connection.interface_id,
368
+ device=self._device.device_address,
369
+ stream_id=self._stream_id,
370
+ channel_number=channel_number,
371
+ value=value,
372
+ future_value=future_value,
373
+ delay=delay,
374
+ unit=unit,
375
+ )
376
+ await call_async("device/stream_set_analog_output_schedule", request)
377
+
378
+ def set_all_analog_outputs_schedule(
379
+ self,
380
+ values: List[float],
381
+ future_values: List[float],
382
+ delay: float,
383
+ unit: TimeUnits = Units.NATIVE
384
+ ) -> None:
385
+ """
386
+ Sets current and future values for all analog output channels.
387
+ Requires at least Firmware 7.38.
388
+
389
+ Args:
390
+ values: Voltage values to set the output channels to immediately.
391
+ future_values: Voltage values to set the output channels to in the future.
392
+ delay: Delay between setting current values and setting future values.
393
+ unit: Units of time.
394
+ """
395
+ if delay <= 0:
396
+ raise ValueError('Delay must be a positive value.')
397
+
398
+ request = dto.StreamSetAllAnalogOutputsScheduleRequest(
399
+ interface_id=self._device.connection.interface_id,
400
+ device=self._device.device_address,
401
+ stream_id=self._stream_id,
402
+ values=values,
403
+ future_values=future_values,
404
+ delay=delay,
405
+ unit=unit,
406
+ )
407
+ call("device/stream_set_all_analog_outputs_schedule", request)
408
+
409
+ async def set_all_analog_outputs_schedule_async(
410
+ self,
411
+ values: List[float],
412
+ future_values: List[float],
413
+ delay: float,
414
+ unit: TimeUnits = Units.NATIVE
415
+ ) -> None:
416
+ """
417
+ Sets current and future values for all analog output channels.
418
+ Requires at least Firmware 7.38.
419
+
420
+ Args:
421
+ values: Voltage values to set the output channels to immediately.
422
+ future_values: Voltage values to set the output channels to in the future.
423
+ delay: Delay between setting current values and setting future values.
424
+ unit: Units of time.
425
+ """
426
+ if delay <= 0:
427
+ raise ValueError('Delay must be a positive value.')
428
+
429
+ request = dto.StreamSetAllAnalogOutputsScheduleRequest(
430
+ interface_id=self._device.connection.interface_id,
431
+ device=self._device.device_address,
432
+ stream_id=self._stream_id,
433
+ values=values,
434
+ future_values=future_values,
435
+ delay=delay,
436
+ unit=unit,
437
+ )
438
+ await call_async("device/stream_set_all_analog_outputs_schedule", request)
439
+
440
+ def cancel_digital_output_schedule(
441
+ self,
442
+ channel_number: int
443
+ ) -> None:
444
+ """
445
+ Cancels a scheduled digital output action.
446
+ Requires at least Firmware 7.37.
447
+
448
+ Args:
449
+ channel_number: Channel number starting at 1.
450
+ """
451
+ request = dto.StreamCancelOutputScheduleRequest(
452
+ interface_id=self._device.connection.interface_id,
453
+ device=self._device.device_address,
454
+ analog=False,
455
+ stream_id=self._stream_id,
456
+ channel_number=channel_number,
457
+ )
458
+ call("device/stream_cancel_output_schedule", request)
459
+
460
+ async def cancel_digital_output_schedule_async(
461
+ self,
462
+ channel_number: int
463
+ ) -> None:
464
+ """
465
+ Cancels a scheduled digital output action.
466
+ Requires at least Firmware 7.37.
467
+
468
+ Args:
469
+ channel_number: Channel number starting at 1.
470
+ """
471
+ request = dto.StreamCancelOutputScheduleRequest(
472
+ interface_id=self._device.connection.interface_id,
473
+ device=self._device.device_address,
474
+ analog=False,
475
+ stream_id=self._stream_id,
476
+ channel_number=channel_number,
477
+ )
478
+ await call_async("device/stream_cancel_output_schedule", request)
479
+
480
+ def cancel_all_digital_outputs_schedule(
481
+ self,
482
+ channels: List[bool] = []
483
+ ) -> None:
484
+ """
485
+ Cancel all scheduled digital output actions.
486
+ Requires at least Firmware 7.37.
487
+
488
+ Args:
489
+ channels: Optionally specify which channels to cancel.
490
+ Array length must be empty or equal to the number of channels on device.
491
+ Specifying "True" for a channel will cancel the scheduled digital output action for that channel.
492
+ """
493
+ request = dto.StreamCancelAllOutputsScheduleRequest(
494
+ interface_id=self._device.connection.interface_id,
495
+ device=self._device.device_address,
496
+ analog=False,
497
+ stream_id=self._stream_id,
498
+ channels=channels,
499
+ )
500
+ call("device/stream_cancel_all_outputs_schedule", request)
501
+
502
+ async def cancel_all_digital_outputs_schedule_async(
503
+ self,
504
+ channels: List[bool] = []
505
+ ) -> None:
506
+ """
507
+ Cancel all scheduled digital output actions.
508
+ Requires at least Firmware 7.37.
509
+
510
+ Args:
511
+ channels: Optionally specify which channels to cancel.
512
+ Array length must be empty or equal to the number of channels on device.
513
+ Specifying "True" for a channel will cancel the scheduled digital output action for that channel.
514
+ """
515
+ request = dto.StreamCancelAllOutputsScheduleRequest(
516
+ interface_id=self._device.connection.interface_id,
517
+ device=self._device.device_address,
518
+ analog=False,
519
+ stream_id=self._stream_id,
520
+ channels=channels,
521
+ )
522
+ await call_async("device/stream_cancel_all_outputs_schedule", request)
523
+
524
+ def cancel_analog_output_schedule(
525
+ self,
526
+ channel_number: int
527
+ ) -> None:
528
+ """
529
+ Cancels a scheduled analog output value.
530
+ Requires at least Firmware 7.38.
531
+
532
+ Args:
533
+ channel_number: Channel number starting at 1.
534
+ """
535
+ request = dto.StreamCancelOutputScheduleRequest(
536
+ interface_id=self._device.connection.interface_id,
537
+ device=self._device.device_address,
538
+ analog=True,
539
+ stream_id=self._stream_id,
540
+ channel_number=channel_number,
541
+ )
542
+ call("device/stream_cancel_output_schedule", request)
543
+
544
+ async def cancel_analog_output_schedule_async(
545
+ self,
546
+ channel_number: int
547
+ ) -> None:
548
+ """
549
+ Cancels a scheduled analog output value.
550
+ Requires at least Firmware 7.38.
551
+
552
+ Args:
553
+ channel_number: Channel number starting at 1.
554
+ """
555
+ request = dto.StreamCancelOutputScheduleRequest(
556
+ interface_id=self._device.connection.interface_id,
557
+ device=self._device.device_address,
558
+ analog=True,
559
+ stream_id=self._stream_id,
560
+ channel_number=channel_number,
561
+ )
562
+ await call_async("device/stream_cancel_output_schedule", request)
563
+
564
+ def cancel_all_analog_outputs_schedule(
565
+ self,
566
+ channels: List[bool] = []
567
+ ) -> None:
568
+ """
569
+ Cancel all scheduled analog output actions.
570
+ Requires at least Firmware 7.38.
571
+
572
+ Args:
573
+ channels: Optionally specify which channels to cancel.
574
+ Array length must be empty or equal to the number of channels on device.
575
+ Specifying "True" for a channel will cancel the scheduled analog output value for that channel.
576
+ """
577
+ request = dto.StreamCancelAllOutputsScheduleRequest(
578
+ interface_id=self._device.connection.interface_id,
579
+ device=self._device.device_address,
580
+ analog=True,
581
+ stream_id=self._stream_id,
582
+ channels=channels,
583
+ )
584
+ call("device/stream_cancel_all_outputs_schedule", request)
585
+
586
+ async def cancel_all_analog_outputs_schedule_async(
587
+ self,
588
+ channels: List[bool] = []
589
+ ) -> None:
590
+ """
591
+ Cancel all scheduled analog output actions.
592
+ Requires at least Firmware 7.38.
593
+
594
+ Args:
595
+ channels: Optionally specify which channels to cancel.
596
+ Array length must be empty or equal to the number of channels on device.
597
+ Specifying "True" for a channel will cancel the scheduled analog output value for that channel.
598
+ """
599
+ request = dto.StreamCancelAllOutputsScheduleRequest(
600
+ interface_id=self._device.connection.interface_id,
601
+ device=self._device.device_address,
602
+ analog=True,
603
+ stream_id=self._stream_id,
604
+ channels=channels,
605
+ )
606
+ await call_async("device/stream_cancel_all_outputs_schedule", request)
607
+
608
+ def wait_digital_input(
609
+ self,
610
+ channel_number: int,
611
+ value: bool
612
+ ) -> None:
613
+ """
614
+ Wait for a digital input channel to reach a given value.
615
+
616
+ Args:
617
+ channel_number: The number of the digital input channel.
618
+ Channel numbers are numbered from one.
619
+ value: The value that the stream should wait for.
620
+ """
621
+ request = dto.StreamWaitDigitalInputRequest(
622
+ interface_id=self._device.connection.interface_id,
623
+ device=self._device.device_address,
624
+ stream_id=self._stream_id,
625
+ channel_number=channel_number,
626
+ value=value,
627
+ )
628
+ call("device/stream_wait_digital_input", request)
629
+
630
+ async def wait_digital_input_async(
631
+ self,
632
+ channel_number: int,
633
+ value: bool
634
+ ) -> None:
635
+ """
636
+ Wait for a digital input channel to reach a given value.
637
+
638
+ Args:
639
+ channel_number: The number of the digital input channel.
640
+ Channel numbers are numbered from one.
641
+ value: The value that the stream should wait for.
642
+ """
643
+ request = dto.StreamWaitDigitalInputRequest(
644
+ interface_id=self._device.connection.interface_id,
645
+ device=self._device.device_address,
646
+ stream_id=self._stream_id,
647
+ channel_number=channel_number,
648
+ value=value,
649
+ )
650
+ await call_async("device/stream_wait_digital_input", request)
651
+
652
+ def wait_analog_input(
653
+ self,
654
+ channel_number: int,
655
+ condition: str,
656
+ value: float
657
+ ) -> None:
658
+ """
659
+ Wait for the value of a analog input channel to reach a condition concerning a given value.
660
+
661
+ Args:
662
+ channel_number: The number of the analog input channel.
663
+ Channel numbers are numbered from one.
664
+ condition: A condition (e.g. <, <=, ==, !=).
665
+ value: The value that the condition concerns, in Volts.
666
+ """
667
+ request = dto.StreamWaitAnalogInputRequest(
668
+ interface_id=self._device.connection.interface_id,
669
+ device=self._device.device_address,
670
+ stream_id=self._stream_id,
671
+ channel_number=channel_number,
672
+ condition=condition,
673
+ value=value,
674
+ )
675
+ call("device/stream_wait_analog_input", request)
676
+
677
+ async def wait_analog_input_async(
678
+ self,
679
+ channel_number: int,
680
+ condition: str,
681
+ value: float
682
+ ) -> None:
683
+ """
684
+ Wait for the value of a analog input channel to reach a condition concerning a given value.
685
+
686
+ Args:
687
+ channel_number: The number of the analog input channel.
688
+ Channel numbers are numbered from one.
689
+ condition: A condition (e.g. <, <=, ==, !=).
690
+ value: The value that the condition concerns, in Volts.
691
+ """
692
+ request = dto.StreamWaitAnalogInputRequest(
693
+ interface_id=self._device.connection.interface_id,
694
+ device=self._device.device_address,
695
+ stream_id=self._stream_id,
696
+ channel_number=channel_number,
697
+ condition=condition,
698
+ value=value,
699
+ )
700
+ await call_async("device/stream_wait_analog_input", request)