devctrl.devices.led_controller.impl.dummy.DummyLedController#
- class DummyLedController[source]#
Bases:
LedController,DummyDeviceMethods
Manually add a specific device.
This function should be overridden by device implementations only, and is not intended to be used directly.
Connect an instance of the device's dummy implementation
Return a flat dictionary of all base classes below this class :param recurse: If True, recursively search for base classes :return: dict of {class name: class}
Get controller capabilities
Query the current device operating mode
Query the status of the device and return a string describing errors.
Query whether the device is (still) connected
Get a list of all devices for this type.
Set the LED brightness to 0%
Set the LED brightness to 100%
Set the LED brightness to a specific percentage
Set the LED controller operating mode
Attributes
- BRIGHTNESS_ON_OFF = 2#
- BRIGHTNESS_PERCENT = 1#
- VALID_BRIGHTNESS_PERCENT = (0, 100)#
- _CLASS_TYPE = 'dummy'#
- __abstractmethods__ = frozenset({})#
- __annotations__ = {}#
- __dict__ = mappingproxy({'__module__': 'devctrl.devices.led_controller.impl.dummy', '__firstlineno__': 4, '__init__': <function DummyLedController.__init__>, 'on': <function DummyLedController.on>, 'off': <function DummyLedController.off>, 'set_brightness_percent': <function DummyLedController.set_brightness_percent>, 'get_brightness_percent': <function DummyLedController.get_brightness_percent>, 'set_mode': <function DummyLedController.set_mode>, 'get_mode': <function DummyLedController.get_mode>, 'set_current_A': <function DummyLedController.set_current_A>, 'get_current_A': <function DummyLedController.get_current_A>, 'get_capabilities': <function DummyLedController.get_capabilities>, '__repr__': <function DummyLedController.__repr__>, '__static_attributes__': ('current_A', 'level', 'mode'), '__doc__': None, '__abstractmethods__': frozenset(), '_abc_impl': <_abc._abc_data object>, '_children': {}, '_manual_devices': [], '_CLASS_TYPE': 'dummy'})#
- __firstlineno__ = 4#
- __module__ = 'devctrl.devices.led_controller.impl.dummy'#
- __repr__() str[source]#
- Returns:
The name of the device. If applicable, this should include serial port, GPIB address, etc.
- __slots__ = ()#
- __static_attributes__ = ('current_A', 'level', 'mode')#
- __weakref__#
list of weak references to the object
- _abc_impl = <_abc._abc_data object>#
- _children = {}#
- _dummies_only = False#
- classmethod _enumerate_devices() list[str]#
This function should be overridden by device implementations only, and is not intended to be used directly. Instead, use list_devices() to get a list of devices. Use enumerate_devices only directly when you only want to list devices of one specific implementation, i.e., only SR830 Lock-In: SR830._enumerate_devices() :param class_name: The name of the device class
- _manual_devices: list[str] = []#
- classmethod add_device(connect_info)#
Manually add a specific device. The device will show up when list_devices() is called for the device type. Call this from the device class implementation, e.g. use ModelXYZ9000.add_device(‘GPIB:1234:5678’) to add a specific device with a fixed GPIB address. This is useful when automatic discovery is undesired/impossible, either because it is not implemented or it disturbs other devices which can’t handle a identification request. :param cls: The device implementation class :param connect_info: A string argument that is passed to the connect() method of the device implementation, when the device is being connected.
- static allow_only_dummy_devices()#
- classmethod connect(device_type_name: str, device_name: str | None, **kwargs) Device#
- Parameters:
device_type_name – The name of the device class
device_name – The name of the device class
- classmethod connect_device(device_name)#
This function should be overridden by device implementations only, and is not intended to be used directly. Instead, use list_devices() to get a list of devices, and pass the selected device type and name to connect() :param device_name: The name of the device class
- classmethod connect_dummy(**kwargs) Device#
Connect an instance of the device’s dummy implementation
- classmethod get_base_classes(recurse=True) dict[str, type[Device]]#
Return a flat dictionary of all base classes below this class :param recurse: If True, recursively search for base classes :return: dict of {class name: class}
- get_capabilities() int[source]#
Get controller capabilities
- Returns:
Capabilities bitmask (BRIGHTNESS_PERCENT)
- classmethod get_device_name() str#
- Returns:
The specific type name of the device, e.g., SR830 or Keithly2600
- classmethod get_device_type_name() str#
- Returns:
The general type name of the device, e.g., Lock-In Amplifier or Voltmeter
- get_led_name() None | str#
- get_mode() str[source]#
Query the current device operating mode
- Returns:
Current mode identifier string
- get_status() str#
Query the status of the device and return a string describing errors. If everything is ok, empty string must be returned :return: String of device status
- is_connected() bool#
Query whether the device is (still) connected
- classmethod list_devices() list[tuple[str, str]]#
Get a list of all devices for this type. The list made up of: - Manually added devices - Available devices (those returned by _enumerate_devices) - A dummy device (if a dummy implementation exists) - List of all devices of child classes
- Returns:
list of available devices