Welcome to Typhoon API’s documentation!¶
- Author:
Typhoon HIL
- Release date:
Dec 07, 2023
- Requirements:
# This requirements file is used for Typhoon-python
https://www.typhoon-hil.com/sharing/team/dependencies/asammdf-7.3.13-cp311-cp311-win_amd64.whl; sys_platform == 'win32' # used because of the problem with a PySide6
asyncio==3.4.3 # used in our tests
asyncua==0.9.95 # used in our tests
canopen==2.0.0 # used in our tests
dss-python==0.13.0 # opandssdirect requirement
ifcfg==0.24 # used in our tests
mcp2210-python==1.0.4 # used in our tests
opendssdirect.py==0.8.0
pdfrw==0.4 # used inside TDD project
# pyopendnp3==0.1.0; sys_platform == 'win32' # used in our tests - not compatible with python 3.11
pyserial==3.5 # used in our tests
pysoem==1.1.0
pytest-asyncio==0.19.0 # used in our tests
pytest-harvest==1.10.4 # used in our tests
python-can==4.1.0 # used in our tests
pythonnet==3.0.1; sys_platform == 'win32'
pyusb==1.2.1
git+https://github.com/typhoon-hil/model-converter.git
paramiko==2.11.0 # used in our tests
# This is requirement for the TyTest, prebuilt by us because there is no whl file. Compilers are needed for the build.
https://www.typhoon-hil.com/sharing/team/dependencies/xhtml2pdf-0.2.11-py3-none-any.whl
# Libs used for VISA communication for BorgWarner Power and Measurement devices
pyvisa==1.13.0
pyvisa-py==0.7.0
# These libs are used to eliminate warnings prints when typhoon.test.capture is imported.
# They are not used for anything else. This is Canmatrix lib issue which is asammdf dependency.
#ldfparser
#xlrd
#xlwt
#xlsxwriter
#exported_src\typhoontest\.
#exported_src\api\.
Contents:
- 1. HIL API
- 1.1. API references
load_model()load_settings_file()save_settings_file()save_model_state()load_model_state()upload_standalone_model()model_write()model_read()add_data_logger()remove_data_logger()start_data_logger()stop_data_logger()update_sources()prepare_source_arbitrary_waveform()prepare_source_constant_value()prepare_source_sine_waveform()enable_ao_limiting()disable_ao_limiting()set_boot_configuration()set_source_arbitrary_waveform()set_source_constant_value()set_source_sine_waveform()set_source_scaling()set_pv_input_file()set_pv_amb_params()set_analog_output()set_analog_output_signal()set_analog_output_scaling()set_analog_output_offset()set_digital_output()set_digital_output_signal()set_digital_output_inverting()set_digital_output_sw_control()set_digital_output_software_value()set_contactor()set_contactor_control_mode()set_contactor_state()set_machine_constant_torque()set_machine_linear_torque()set_machine_square_torque()set_machine_load_source()set_machine_external_torque_type()set_machine_constant_torque_type()set_machine_load_type()set_machine_speed()set_machine_initial_angle()set_machine_initial_speed()set_machine_inc_encoder_offset()set_machine_sin_encoder_offset()set_machine_encoder_offset()set_machine_resolver_offset()set_pe_switching_block_control_mode()set_pe_switching_block_software_value()set_initial_battery_soc()set_scada_input_value()set_cp_input_value()set_text_mode()set_debug_level()start_capture()stop_capture()start_simulation()stop_simulation()is_simulation_running()check_hil_hwid()capture_in_progress()timeout_occurred()read_pv_iv_curve()read_analog_signal()read_analog_signals()read_digital_signal()read_digital_signals()read_digital_input()read_streaming_signals()load_signal_gen_data()create_signal_stimulus()prepare_signal_stimulus()start_signal_stimulus()stop_signal_stimulus()pause_signal_stimulus()reboot_hil()wait_sec()wait_msec()wait_on_user()end_script_by_user()reset_flag_status()get_model_variables()get_cp_output_value()get_scada_output_value()get_battery_soc()get_pv_mpp()get_num_of_connected_hils()get_sim_step()get_sim_time()get_device_cfg_list()get_sw_version()get_hil_calibration_date()get_device_features()get_hw_info()get_flag_status()get_sources()get_pvs()get_analog_signals()get_digital_signals()get_streaming_analog_signals()get_streaming_digital_signals()get_contactors()get_machines()get_pe_switching_blocks()get_scada_inputs()get_scada_outputs()get_source_settings()get_pv_panel_settings()get_machine_settings()get_pe_switching_block_settings()get_contactor_settings()get_analog_output_settings()get_digital_output_settings()get_cp_input_settings()get_scada_input_settings()get_hil_serial_number()get_ns_var()get_ns_vars()get_data_logger_status()get_model_file_path()get_sp_monitors_values()available_sources()available_pvs()available_analog_signals()available_digital_signals()available_contactors()available_machines()available_pe_switching_blocks()
- 1.1. API references
- 2. SCADA API
- 2.1. WidgetHandle
- 2.2. SCADA API constants
- 2.3. SCADA API in HIL SCADA
- 2.4. API references
ScadaAPIScadaAPI.add_library_path()ScadaAPI.create_widget()ScadaAPI.create_new_panel()ScadaAPI.create_new_library_panel()ScadaAPI.copy()ScadaAPI.delete_widget()ScadaAPI.execute_action()ScadaAPI.reload_libraries()ScadaAPI.remove_library_path()ScadaAPI.load_panel()ScadaAPI.load_library_panel()ScadaAPI.save_panel()ScadaAPI.save_panel_as()ScadaAPI.set_property_value()ScadaAPI.get_property_value()ScadaAPI.get_widget_by_id()ScadaAPI.get_widget_by_fqn()ScadaAPI.get_library_paths()
- 3. Schematic Editor API
- 3.1. Examples
- 3.2. Schematic API constants
- 3.3. Positioning
- 3.4. Schematic model configuration
- 3.5. API references
SchematicAPISchematicAPI.add_library_path()SchematicAPI.close_model()SchematicAPI.compile()SchematicAPI.create_comment()SchematicAPI.create_component()SchematicAPI.create_connection()SchematicAPI.create_junction()SchematicAPI.create_library_model()SchematicAPI.create_mask()SchematicAPI.create_new_model()SchematicAPI.create_port()SchematicAPI.create_property()SchematicAPI.create_tag()SchematicAPI.delete_item()SchematicAPI.detect_hw_settings()SchematicAPI.disable_items()SchematicAPI.disable_property()SchematicAPI.disable_property_serialization()SchematicAPI.disp_component_icon_text()SchematicAPI.enable_items()SchematicAPI.enable_property()SchematicAPI.enable_property_serialization()SchematicAPI.error()SchematicAPI.exists()SchematicAPI.export_c_from_model()SchematicAPI.export_c_from_selection()SchematicAPI.export_c_from_subsystem()SchematicAPI.export_library()SchematicAPI.export_model_to_json()SchematicAPI.find_connections()SchematicAPI.fqn()SchematicAPI.get_available_library_components()SchematicAPI.get_breakpoints()SchematicAPI.get_calculated_terminal_position()SchematicAPI.get_comment_text()SchematicAPI.get_compiled_model_file()SchematicAPI.get_component_type_name()SchematicAPI.get_connectable_direction()SchematicAPI.get_connectable_kind()SchematicAPI.get_connected_items()SchematicAPI.get_conv_prop()SchematicAPI.get_description()SchematicAPI.get_flip()SchematicAPI.get_fqn()SchematicAPI.get_handler_code()SchematicAPI.get_hw_property()SchematicAPI.get_hw_settings()SchematicAPI.get_icon_drawing_commands()SchematicAPI.get_item()SchematicAPI.get_item_visual_properties()SchematicAPI.get_items()SchematicAPI.get_label()SchematicAPI.get_library_paths()SchematicAPI.get_library_resource_dir_path()SchematicAPI.get_mask()SchematicAPI.get_model_dependencies()SchematicAPI.get_model_file_path()SchematicAPI.get_model_information()SchematicAPI.get_model_property_value()SchematicAPI.get_name()SchematicAPI.get_ns_var()SchematicAPI.get_ns_vars()SchematicAPI.get_parent()SchematicAPI.get_position()SchematicAPI.get_property_combo_values()SchematicAPI.get_property_default_value()SchematicAPI.get_property_disp_value()SchematicAPI.get_property_type_attributes()SchematicAPI.get_property_value()SchematicAPI.get_property_value_type()SchematicAPI.get_property_values()SchematicAPI.get_rotation()SchematicAPI.get_size()SchematicAPI.get_sub_level_handle()SchematicAPI.get_terminal_dimension()SchematicAPI.get_terminal_sp_type()SchematicAPI.get_terminal_sp_type_value()SchematicAPI.hide_name()SchematicAPI.hide_property()SchematicAPI.info()SchematicAPI.is_enabled()SchematicAPI.is_name_visible()SchematicAPI.is_property_enabled()SchematicAPI.is_property_serializable()SchematicAPI.is_property_visible()SchematicAPI.is_require_satisfied()SchematicAPI.is_subsystem()SchematicAPI.is_terminal_feedthrough()SchematicAPI.is_tunable()SchematicAPI.load()SchematicAPI.model_to_api()SchematicAPI.precompile_fmu()SchematicAPI.print_message()SchematicAPI.prop()SchematicAPI.refresh_icon()SchematicAPI.reload_libraries()SchematicAPI.remove_library_path()SchematicAPI.remove_mask()SchematicAPI.remove_property()SchematicAPI.save()SchematicAPI.save_as()SchematicAPI.set_color()SchematicAPI.set_component_icon_image()SchematicAPI.set_component_property()SchematicAPI.set_description()SchematicAPI.set_flip()SchematicAPI.set_handler_code()SchematicAPI.set_hw_settings()SchematicAPI.set_icon_drawing_commands()SchematicAPI.set_item_visual_properties()SchematicAPI.set_label()SchematicAPI.set_model_dependencies()SchematicAPI.set_model_init_code()SchematicAPI.set_model_property_value()SchematicAPI.set_name()SchematicAPI.set_ns_var()SchematicAPI.set_port_properties()SchematicAPI.set_position()SchematicAPI.set_property_attribute()SchematicAPI.set_property_combo_values()SchematicAPI.set_property_disp_value()SchematicAPI.set_property_value()SchematicAPI.set_property_value_type()SchematicAPI.set_property_values()SchematicAPI.set_rotation()SchematicAPI.set_simulation_method()SchematicAPI.set_simulation_time_step()SchematicAPI.set_size()SchematicAPI.set_tag_properties()SchematicAPI.set_terminal_dimension()SchematicAPI.set_terminal_feedthrough()SchematicAPI.set_terminal_sp_type()SchematicAPI.set_terminal_sp_type_value()SchematicAPI.set_tunable()SchematicAPI.show_name()SchematicAPI.show_property()SchematicAPI.sync_dynamic_terminals()SchematicAPI.term()SchematicAPI.unlink_component()SchematicAPI.warning()
- 4. Configuration Manager API
- 4.1. Example
- 4.1.1. API references
ConfigurationManagerAPIConfigurationManagerAPI.create_config()ConfigurationManagerAPI.generate()ConfigurationManagerAPI.get_name()ConfigurationManagerAPI.get_options()ConfigurationManagerAPI.get_project_variants()ConfigurationManagerAPI.load_config()ConfigurationManagerAPI.load_project()ConfigurationManagerAPI.make_pick()ConfigurationManagerAPI.picks()ConfigurationManagerAPI.save_config()
- 4.1.1. API references
- 4.1. Example
- 5. Modbus API
- 5.1. Modbus Client Initialization
- 5.1.1. API references
TCPModbusClientTCPModbusClient.__init__()TCPModbusClient.modbus()TCPModbusClient.endianness()TCPModbusClient.set_endianness()TCPModbusClient.auto_close()TCPModbusClient.set_auto_close()TCPModbusClient.auto_open()TCPModbusClient.set_auto_open()TCPModbusClient.close()TCPModbusClient.open()TCPModbusClient.debug()TCPModbusClient.set_debug()TCPModbusClient.host()TCPModbusClient.set_host()TCPModbusClient.port()TCPModbusClient.set_port()TCPModbusClient.timeout()TCPModbusClient.set_timeout()TCPModbusClient.unit_id()TCPModbusClient.set_unit_id()TCPModbusClient.is_open()TCPModbusClient.read_coils()TCPModbusClient.read_discrete_inputs()TCPModbusClient.read_input_registers()TCPModbusClient.read_holding_registers()TCPModbusClient.read_input_registers_adv()TCPModbusClient.read_holding_registers_adv()TCPModbusClient.write_single_coil()TCPModbusClient.write_single_register()TCPModbusClient.write_multiple_coils()TCPModbusClient.write_multiple_registers()TCPModbusClient.write_registers_adv()
- 5.1.2. Utility module
bool_list_to_int()uint16_to_int16()uint32_to_int32()uint64_to_int64()uint32_to_float()uint64_to_double()float_to_uint32()double_to_uint64()int16_to_uint16()int32_to_uint32()int64_to_uint64()int32_to_uint16_list()int64_to_uint16_list()uint32_to_uint16_list()uint64_to_uint16_list()float_to_uint16_list()double_to_uint16_list()uint16_list_to_float()uint16_list_to_double()uint16_list_to_int32()uint16_list_to_int64()uint16_list_to_uint32()uint16_list_to_uint64()
- 5.1.1. API references
- 5.1. Modbus Client Initialization
- 6. PV Generator API
- 7. HIL SCADA
- 8. Typhoon HIL RPC API
- 9. Firmware Manager API
- 10. Device Manager API
- 10.1. Examples
- 10.1.1. Example 1
- 10.1.2. Example 2
DeviceManagerAPIDeviceManagerAPI.add_devices_to_setup()DeviceManagerAPI.add_discovery_ip_addresses()DeviceManagerAPI.connect_setup()DeviceManagerAPI.disconnect_setup()DeviceManagerAPI.get_available_devices()DeviceManagerAPI.get_detected_devices()DeviceManagerAPI.get_device_settings()DeviceManagerAPI.get_hil_info()DeviceManagerAPI.get_setup_devices()DeviceManagerAPI.get_setup_devices_serials()DeviceManagerAPI.is_setup_connected()DeviceManagerAPI.load_setup()DeviceManagerAPI.remove_devices_from_setup()DeviceManagerAPI.remove_discovery_ip_addresses()DeviceManagerAPI.set_device_settings()DeviceManagerAPI.sync_firmware()DeviceManagerAPI.update_firmware()
- 10.1. Examples
- 11. Package Manager API
- 11.1. Examples
- 11.2. API references
PackageManagerAPIPackageManagerAPI.create_example()PackageManagerAPI.create_package()PackageManagerAPI.download_package()PackageManagerAPI.get_available_packages()PackageManagerAPI.get_installed_packages()PackageManagerAPI.get_modified_packages()PackageManagerAPI.install_package()PackageManagerAPI.reinstall_package()PackageManagerAPI.uninstall_package()PackageManagerAPI.validate_package()