Module#
- class pycanape.module.Module(asap3_handle: LP_tAsap3Hdl, module_handle: c_ushort)#
The
Module
class is not meant to be instantiated by the user. Instead,Module
instances are returned bycreate_module()
,get_module_by_index()
andget_module_by_name()
.- Parameters:
asap3_handle (LP_tAsap3Hdl) –
module_handle (c_ushort) –
- execute_script_ex(script_file: bool, script: str) Script #
Execute a script file or a single script command.
- Parameters:
script_file (bool) – Declares interpretation of parameter script. If ‘script_file’ is true, parameter ‘script’ is interpreted as the file name of the script file to be executed. If ‘script_file’ is false, ‘script’ is interpreted as a single script command
script (str) – A script filename or an single script command
- Returns:
The instance of the Script class
- Return type:
- get_calibration_object(name: str) ScalarCalibrationObject | AxisCalibrationObject | CurveCalibrationObject | MapCalibrationObject | AsciiCalibrationObject | ValueBlockCalibrationObject #
Get calibration object by name or wildcard pattern (e.g. ‘*InitReset’).
- Parameters:
name (str) –
- Return type:
ScalarCalibrationObject | AxisCalibrationObject | CurveCalibrationObject | MapCalibrationObject | AsciiCalibrationObject | ValueBlockCalibrationObject
- get_database_info() DatabaseInfo #
Get Info concerning the database file.
- Return type:
- get_ecu_driver_type() DriverType #
Retrieves the drivertype of an ECU.
- Returns:
DriverType enum
- Return type:
- get_measurement_list_entries() Dict[str, MeasurementListEntry] #
Retrieve the entries from the CANape Measurement list.
- Returns:
A dict of Measurement list entries that uses the object name of the entries as key
- Return type:
- has_resume_mode() bool #
Information about the Resume mode.
- Returns:
Function returns True if the device supports resume mode.
- Return type:
- is_module_active() bool #
Return the activation state of the module.
- Returns:
activation state
- Return type:
- module_activation(activate: bool = True) None #
Switches the module activation state.
- Parameters:
activate (bool) – True -> activate Module False -> deactivate Module
- Return type:
None
- reset_data_acquisition_channels_by_module() None #
Clears the data acquisition channel list of a specific module.
Note
this function only clears these measurement objects from the API-Measurement-List which are defined by API
- Return type:
None
- class pycanape.module.MeasurementListEntry(task_id, rate, save_flag, disabled, object_name)#
Create new instance of MeasurementListEntry(task_id, rate, save_flag, disabled, object_name)
- class pycanape.module.DatabaseInfo(file_name, file_path, file_type)#
Create new instance of DatabaseInfo(file_name, file_path, file_type)
- Parameters:
file_name (str) –
file_path (str) –
file_type (DBFileType) –
- file_type: DBFileType#
Alias for field number 2