Recorder#

class pycanape.recorder.Recorder(dll: CANapeDll, asap3_handle: LP_tAsap3Hdl, recorder_id: LP_c_ulong)[source]#

The Recorder class is not meant to be instantiated by the user. Recorder instances are returned by define_recorder(), get_recorder_by_index() and get_selected_recorder().

Parameters:

  • asap3_handle (LP_tAsap3Hdl) –

  • recorder_id (LP_c_ulong) –

  • dll (CANapeDll) –

disable() → None[source]#

Disable Recorder.

Return type:

None

enable() → None[source]#

Enable Recorder.

Return type:

None

get_mdf_filename() → str[source]#

Retrieve the MDF Filename of a Recorder.

Return type:

str

get_name() → str[source]#

Get the name of the recorder.

Return type:

str

get_state() → RecorderState[source]#

Return the state of a Recorder

Return type:

RecorderState

is_enabled() → bool[source]#

Check if Recorder is enabled.

Returns:

True if recorder is enabled

Return type:

bool

pause(pause: bool) → None[source]#

Pause or unpause recorder.

Parameters:

pause (bool) –

Return type:

None

set_mdf_filename(filename: str | Path) → None[source]#

Set the MDF Filename for a Recorder.

Parameters:

filename (str | Path) – new recorder filename e.g. ‘{RECORDER}_{YEAR}-{MONTH}-{DAY}_{HOUR}-{MINUTE}-{SECOND}.MF4’

Return type:

None

start() → None[source]#

Starts the recording into the mdf file.

Return type:

None

stop(save_to_mdf: bool = True) → None[source]#

Stops the recording and writes an MDF File.

Parameters:

save_to_mdf (bool) – save recorded data to a file if True

Return type:

None