Надёжная фильтрация последовательных портов Python на Linux по имени и производителю с использованием udev

udev_info_example.py
    {
        'serial': '01010A23535223934CF29A1EF5000007',
        'vendor_id': '1d50',
        'usb_model': 'Marlin USB Device',
        'usb_model_id': '6029',
        'usb_vendor':
        'marlinfw.org',
        'vendor': 'OpenMoko, Inc.',
        'model': 'Marlin 2.0 (Serial)'
    }

    ```

или просто перейти к жёсткому кодированию порта, например `/dev/ttyACM0`.

Должно быть довольно очевидно, почему это не является надёжным:
* Может быть несколько последовательных портов, и порядок неизвестен
* Ваш код может работать на разных компьютерах, что приведёт к назначению разных портов
* При повторном подключении устройства ему может быть назначен другой номер последовательного порта (например, `/dev/ttyACM1`)


Следующий код использует только встроенный в Linux инструмент `udevadm` для запроса информации и встроенные библиотеки. **В настоящее время он работает только на Linux.**

```python {filename="udev_serial_utils.py"}
import glob
import subprocess
import re

def get_serial_ports():
    # Получить список устройств /dev/ttyACM* и /dev/ttyUSB*
    ports = glob.glob('/dev/ttyACM*') + glob.glob('/dev/ttyUSB*')
    return ports

def get_udev_info(port):
    # Выполнить команду udevadm и получить вывод
    result = subprocess.run(['udevadm', 'info', '-q', 'all', '-r', '-n', port], capture_output=True, text=True)
    return result.stdout

def find_serial_ports(vendor=None, model=None, usb_vendor=None, usb_model=None, usb_model_id=None, vendor_id=None):
    # Сопоставление читаемых имён с ключами udevadm
    attribute_mapping = {
        "vendor": "ID_VENDOR_FROM_DATABASE",
        "model": "ID_MODEL_FROM_DATABASE",
        "usb_vendor": "ID_USB_VENDOR",
        "usb_model": "ID_USB_MODEL_ENC",
        "usb_model_id": "ID_USB_MODEL_ID",
        "vendor_id": "ID_VENDOR_ID",
        "usb_path": "ID_PATH",
        "serial": "ID_SERIAL_SHORT"
    }

    # Фильтры на основе предоставленных аргументов
    filters = {}
    for key, value in locals().items():
        if value and key in attribute_mapping:
            filters[attribute_mapping[key]] = value

    # Найти и отфильтровать порты
    ports = get_serial_ports()
    filtered_ports = []

    for port in ports:
        udev_info = get_udev_info(port)
        match = True

        for key, value in filters.items():
            if not re.search(f"{key}={re.escape(value)}", udev_info):
                match = False
                break

        if match:
            filtered_ports.append(port)

    return filtered_ports

def get_serial_port_info(port):
    # Сопоставление ключей udevadm с читаемыми именами
    attribute_mapping = {
        "ID_VENDOR_FROM_DATABASE": "vendor",
        "ID_MODEL_FROM_DATABASE": "model",
        "ID_USB_VENDOR": "usb_vendor",
        "ID_USB_MODEL_ENC": "usb_model",
        "ID_USB_MODEL_ID": "usb_model_id",
        "ID_VENDOR_ID": "vendor_id",
        "ID_SERIAL_SHORT": "serial",
    }

    # Выполнить команду udevadm и получить вывод
    udev_info = get_udev_info(port)
    port_info = {}

    for line in udev_info.splitlines():
        if line.startswith('E: '):
            key, value = line[3:].split('=', 1)
            if key in attribute_mapping:
                # Декодировать escape-последовательности вроде \x20 в пробел.
                # ПРИМЕЧАНИЕ: Поскольку только \x20 является распространённым, в настоящее время мы заменяем только его
                port_info[attribute_mapping[key]] = value.replace('\\x20', ' ')

    return port_info

def find_serial_port(**kwargs):
    """
    Найти один последовательный порт, соответствующий предоставленным фильтрам.
    """
    ports = find_serial_ports(**kwargs)
    if len(ports) > 1:
        raise ValueError("Найдено несколько портов, соответствующих фильтрам: " + str(kwargs))
    elif len(ports) == 0:
        raise ValueError("Не найдено портов, соответствующих фильтрам: " + str(kwargs))
    else:
        return ports[0]

Пример: Поиск последовательного порта

find_serial_example.py
# Пример использования: Найти последовательный порт
matching_ports = find_serial_ports(vendor="OpenMoko, Inc.")
print(matching_ports) # Выводит, например, ['/dev/ttyACM0']

Пример: Вывод информации о заданном порту

Это обычно используется, чтобы знать, какие фильтры добавить для find_serial_ports().

print_port_info_example.py
# Пример использования: Вывести информацию о последовательном порте
serial_port_info = get_serial_port_info('/dev/ttyACM0')
print(serial_port_info)

Это выводит, например:

serial_port_info_output.py
{
    'serial': '01010A23535223934CF29A1EF5000007',
    'vendor_id': '1d50',
    'usb_model': 'Marlin USB Device',
    'usb_model_id': '6029',
    'usb_vendor':
    'marlinfw.org',
    'vendor': 'OpenMoko, Inc.',
    'model': 'Marlin 2.0 (Serial)'
}

Check out similar posts by category: Electronics Linux