hvl_ccb.dev.tiepie

Submodules

• hvl_ccb.dev.tiepie.base
  • TiePieDeviceConfig
    • TiePieDeviceConfig.clean_values()
    • TiePieDeviceConfig.force_value()
    • TiePieDeviceConfig.is_configdataclass
    • TiePieDeviceConfig.is_data_ready_polling_interval_sec
    • TiePieDeviceConfig.keys()
    • TiePieDeviceConfig.n_max_try_get_device
    • TiePieDeviceConfig.optional_defaults()
    • TiePieDeviceConfig.require_block_measurement_support
    • TiePieDeviceConfig.required_keys()
    • TiePieDeviceConfig.serial_number
    • TiePieDeviceConfig.wait_sec_retry_get_device
  • TiePieDeviceType
    • TiePieDeviceType.GENERATOR
    • TiePieDeviceType.OSCILLOSCOPE
  • TiePieError
  • get_device_by_serial_number()
  • wrap_libtiepie_exception()
• hvl_ccb.dev.tiepie.channel
  • TiePieOscilloscopeChannelConfig
    • TiePieOscilloscopeChannelConfig.clean_coupling()
    • TiePieOscilloscopeChannelConfig.clean_enabled()
    • TiePieOscilloscopeChannelConfig.clean_input_range()
    • TiePieOscilloscopeChannelConfig.clean_trigger_enabled()
    • TiePieOscilloscopeChannelConfig.clean_trigger_hysteresis()
    • TiePieOscilloscopeChannelConfig.clean_trigger_kind()
    • TiePieOscilloscopeChannelConfig.clean_trigger_level()
    • TiePieOscilloscopeChannelConfig.clean_trigger_level_mode()
    • TiePieOscilloscopeChannelConfig.coupling
    • TiePieOscilloscopeChannelConfig.enabled
    • TiePieOscilloscopeChannelConfig.has_safeground
    • TiePieOscilloscopeChannelConfig.input_range
    • TiePieOscilloscopeChannelConfig.probe_gain
    • TiePieOscilloscopeChannelConfig.probe_offset
    • TiePieOscilloscopeChannelConfig.safeground_enabled
    • TiePieOscilloscopeChannelConfig.trigger_enabled
    • TiePieOscilloscopeChannelConfig.trigger_hysteresis
    • TiePieOscilloscopeChannelConfig.trigger_kind
    • TiePieOscilloscopeChannelConfig.trigger_level
    • TiePieOscilloscopeChannelConfig.trigger_level_mode
  • TiePieOscilloscopeChannelConfigLimits
  • TiePieOscilloscopeChannelCoupling
    • TiePieOscilloscopeChannelCoupling.ACA
    • TiePieOscilloscopeChannelCoupling.ACV
    • TiePieOscilloscopeChannelCoupling.DCA
    • TiePieOscilloscopeChannelCoupling.DCV
  • TiePieOscilloscopeRange
    • TiePieOscilloscopeRange.EIGHTY_VOLT
    • TiePieOscilloscopeRange.EIGHT_HUNDRED_MILLI_VOLT
    • TiePieOscilloscopeRange.EIGHT_VOLT
    • TiePieOscilloscopeRange.FORTY_VOLT
    • TiePieOscilloscopeRange.FOUR_HUNDRED_MILLI_VOLT
    • TiePieOscilloscopeRange.FOUR_VOLT
    • TiePieOscilloscopeRange.TWENTY_VOLT
    • TiePieOscilloscopeRange.TWO_HUNDRED_MILLI_VOLT
    • TiePieOscilloscopeRange.TWO_VOLT
    • TiePieOscilloscopeRange.unit()
  • TiePieOscilloscopeTriggerKind
    • TiePieOscilloscopeTriggerKind.ANY
    • TiePieOscilloscopeTriggerKind.FALLING
    • TiePieOscilloscopeTriggerKind.RISING
  • TiePieOscilloscopeTriggerLevelMode
    • TiePieOscilloscopeTriggerLevelMode.ABSOLUTE
    • TiePieOscilloscopeTriggerLevelMode.RELATIVE
    • TiePieOscilloscopeTriggerLevelMode.UNKNOWN
• hvl_ccb.dev.tiepie.device
  • TiePieHS5
  • TiePieHS6
  • TiePieWS5
• hvl_ccb.dev.tiepie.generator
  • TiePieGeneratorConfig
    • TiePieGeneratorConfig.amplitude
    • TiePieGeneratorConfig.clean_amplitude()
    • TiePieGeneratorConfig.clean_enabled()
    • TiePieGeneratorConfig.clean_frequency()
    • TiePieGeneratorConfig.clean_offset()
    • TiePieGeneratorConfig.clean_signal_type()
    • TiePieGeneratorConfig.clean_waveform()
    • TiePieGeneratorConfig.enabled
    • TiePieGeneratorConfig.frequency
    • TiePieGeneratorConfig.offset
    • TiePieGeneratorConfig.signal_type
    • TiePieGeneratorConfig.waveform
  • TiePieGeneratorConfigLimits
  • TiePieGeneratorMixin
    • TiePieGeneratorMixin.config_gen
    • TiePieGeneratorMixin.generator_is_running
    • TiePieGeneratorMixin.generator_start()
    • TiePieGeneratorMixin.generator_stop()
    • TiePieGeneratorMixin.start()
    • TiePieGeneratorMixin.stop()
  • TiePieGeneratorSignalType
    • TiePieGeneratorSignalType.ARBITRARY
    • TiePieGeneratorSignalType.DC
    • TiePieGeneratorSignalType.NOISE
    • TiePieGeneratorSignalType.PULSE
    • TiePieGeneratorSignalType.SINE
    • TiePieGeneratorSignalType.SQUARE
    • TiePieGeneratorSignalType.TRIANGLE
    • TiePieGeneratorSignalType.UNKNOWN
• hvl_ccb.dev.tiepie.oscilloscope
  • TiePieOscilloscope
    • TiePieOscilloscope.channels_enabled
    • TiePieOscilloscope.collect_measurement_data()
    • TiePieOscilloscope.config_cls()
    • TiePieOscilloscope.config_osc
    • TiePieOscilloscope.config_osc_channel_dict
    • TiePieOscilloscope.default_com_cls()
    • TiePieOscilloscope.force_trigger()
    • TiePieOscilloscope.is_measurement_data_ready()
    • TiePieOscilloscope.is_measurement_running()
    • TiePieOscilloscope.is_triggered()
    • TiePieOscilloscope.list_devices()
    • TiePieOscilloscope.n_channels
    • TiePieOscilloscope.start()
    • TiePieOscilloscope.start_measurement()
    • TiePieOscilloscope.stop()
    • TiePieOscilloscope.stop_measurement()
  • TiePieOscilloscopeAutoResolutionModes
    • TiePieOscilloscopeAutoResolutionModes.ALL
    • TiePieOscilloscopeAutoResolutionModes.DISABLED
    • TiePieOscilloscopeAutoResolutionModes.NATIVEONLY
    • TiePieOscilloscopeAutoResolutionModes.UNKNOWN
  • TiePieOscilloscopeConfig
    • TiePieOscilloscopeConfig.auto_resolution_mode
    • TiePieOscilloscopeConfig.clean_auto_resolution_mode()
    • TiePieOscilloscopeConfig.clean_pre_sample_ratio()
    • TiePieOscilloscopeConfig.clean_record_length()
    • TiePieOscilloscopeConfig.clean_resolution()
    • TiePieOscilloscopeConfig.clean_sample_rate()
    • TiePieOscilloscopeConfig.clean_trigger_timeout()
    • TiePieOscilloscopeConfig.pre_sample_ratio
    • TiePieOscilloscopeConfig.record_length
    • TiePieOscilloscopeConfig.resolution
    • TiePieOscilloscopeConfig.sample_frequency
    • TiePieOscilloscopeConfig.sample_rate
    • TiePieOscilloscopeConfig.trigger_timeout
  • TiePieOscilloscopeConfigLimits
  • TiePieOscilloscopeResolution
    • TiePieOscilloscopeResolution.EIGHT_BIT
    • TiePieOscilloscopeResolution.FOURTEEN_BIT
    • TiePieOscilloscopeResolution.SIXTEEN_BIT
    • TiePieOscilloscopeResolution.TWELVE_BIT
• hvl_ccb.dev.tiepie.utils
  • PublicPropertiesReprMixin

Module contents

This module is a wrapper around LibTiePie SDK devices; see https://www.tiepie.com/en/libtiepie-sdk .

The device classes adds simplifications for starting of the device (using serial number) and managing mutable configuration of both the device and oscilloscope’s channels. This includes extra validation and typing hints support.

Extra installation

LibTiePie SDK library is available only on Windows and on Linux.

To use this LibTiePie SDK devices wrapper:

1. install the hvl_ccb package with a tiepie extra feature:

   $ pip install "hvl_ccb[tiepie]"
   

   this will install the Python bindings for the library.

2. install the library

   • on Linux: the hvl_ccb package uses the forked version

   python-libtiepie-bi in version 1.1.8 which has the binaries included. No additional installation is needed anymore. * on Windows: the additional DLL is included in Python bindings package.

Troubleshooting

On a Windows system, if you encounter an OSError like this:

...
    self._handle = _dlopen(self._name, mode)
OSError: [WinError 126] The specified module could not be found

most likely the python-libtiepie package was installed in your site-packages/ directory as a python-libtiepie-*.egg file via python setup.py install or python setup.py develop command. In such case uninstall the library and re-install it using pip:

$ pip uninstall python-libtiepie
$ pip install python-libtiepie

This should create libtiepie/ folder. Alternatively, manually move the folder libtiepie/ from inside of the .egg archive file to the containing it site-packages/ directory (PyCharm’s Project tool window supports reading and extracting from .egg archives).