Skip to content

Полная документация класса UsbContext

pyspectrum.UsbContext

Класс для работы с устройством FTDI через библиотеку ftd2xx на системе Windows.

Пример использования:
context = UsbContext()
context.open()
context.set_bitmode(0x40, 0x40)
context.set_timeouts(300, 300)
# Ваш код для работы с устройством FTDI...
context.close()
Source code in pyspectrum/usb_context.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
class UsbContext:
    """
    Класс для работы с устройством FTDI через библиотеку ftd2xx на системе Windows.

    ### Пример использования:
    ```python
    context = UsbContext()
    context.open()
    context.set_bitmode(0x40, 0x40)
    context.set_timeouts(300, 300)
    # Ваш код для работы с устройством FTDI...
    context.close()
    ```
    """
    def __init__(self):
        self.device = None

    def open(self):
        """
        Открывает первое найденное устройство FTDI.

        :raises RuntimeError: Если устройство не найдено или невозможно его открыть.
        """
        self.device = ftd.open()

        if not self.device:
            raise RuntimeError("Failed to open device")

    def close(self):
        """
        Закрывает устройство FTDI.
        """
        if self.device:
            self.device.close()

    def set_bitmode(self, mask, enable):
        """
        Устанавливает режим работы на устройстве FTDI.

        :param mask: Маска для установки режима работы пинов.
        :param enable: Режим работы FTDI чипа (0x40 - 245 FIFO Mode)
        """
        self.device.setBitMode(mask, enable)

    def set_timeouts(self, read_timeout_millis: int, write_timeout_millis: int):
        """
         Устанавливает таймауты чтения и записи для устройства FTDI.

        :param read_timeout_millis: Таймаут чтения в миллисекундах.
        :param write_timeout_millis: Таймаут записи в миллисекундах.
        """
        self.device.setTimeouts(read_timeout_millis, write_timeout_millis)

    def read(self, size) -> bytes:
        """
         Читает данные из устройства FTDI.

        :param size: Количество байтов для чтения.
        :return: Прочитанные данные в виде байтовой строки.
        :raises RuntimeError: Если произошла ошибка при чтении данных.
        """
        try:
            return self.device.read(size)
        except Exception:
            raise RuntimeError("Device read error")

    def write(self, data: bytes) -> int:
        """
        Записывает данные в устройство FTDI.

        :param data: Данные для записи в виде байтовой строки.
        :return: Количество записанных байтов.
        :raises RuntimeError: Если произошла ошибка при записи данных.
        """
        try:
            return self.device.write(data)
        except Exception:
            raise RuntimeError("Device write error")

__init__()

Source code in pyspectrum/usb_context.py 
18
19
def __init__(self):
    self.device = None

device = None instance-attribute

open()

Открывает первое найденное устройство FTDI.

Raises:

Type Description
RuntimeError

Если устройство не найдено или невозможно его открыть.
Source code in pyspectrum/usb_context.py 
21
22
23
24
25
26
27
28
29
30
def open(self):
    """
    Открывает первое найденное устройство FTDI.

    :raises RuntimeError: Если устройство не найдено или невозможно его открыть.
    """
    self.device = ftd.open()

    if not self.device:
        raise RuntimeError("Failed to open device")

close()

Закрывает устройство FTDI.

Source code in pyspectrum/usb_context.py 
32
33
34
35
36
37
def close(self):
    """
    Закрывает устройство FTDI.
    """
    if self.device:
        self.device.close()

set_bitmode(mask, enable)

Устанавливает режим работы на устройстве FTDI.

Parameters:

Name Type Description Default
mask

Маска для установки режима работы пинов.

 required
enable

Режим работы FTDI чипа (0x40 - 245 FIFO Mode)

 required
Source code in pyspectrum/usb_context.py 
39
40
41
42
43
44
45
46
def set_bitmode(self, mask, enable):
    """
    Устанавливает режим работы на устройстве FTDI.

    :param mask: Маска для установки режима работы пинов.
    :param enable: Режим работы FTDI чипа (0x40 - 245 FIFO Mode)
    """
    self.device.setBitMode(mask, enable)

set_timeouts(read_timeout_millis, write_timeout_millis)

Устанавливает таймауты чтения и записи для устройства FTDI.

Parameters:

Name Type Description Default
read_timeout_millis int

Таймаут чтения в миллисекундах.

 required
write_timeout_millis int

Таймаут записи в миллисекундах.

 required
Source code in pyspectrum/usb_context.py 
48
49
50
51
52
53
54
55
def set_timeouts(self, read_timeout_millis: int, write_timeout_millis: int):
    """
     Устанавливает таймауты чтения и записи для устройства FTDI.

    :param read_timeout_millis: Таймаут чтения в миллисекундах.
    :param write_timeout_millis: Таймаут записи в миллисекундах.
    """
    self.device.setTimeouts(read_timeout_millis, write_timeout_millis)

read(size)

Читает данные из устройства FTDI.

Parameters:

Name Type Description Default
size

Количество байтов для чтения.

 required

Returns:

Type Description
bytes

Прочитанные данные в виде байтовой строки.

Raises:

Type Description
RuntimeError

Если произошла ошибка при чтении данных.
Source code in pyspectrum/usb_context.py 
57
58
59
60
61
62
63
64
65
66
67
68
def read(self, size) -> bytes:
    """
     Читает данные из устройства FTDI.

    :param size: Количество байтов для чтения.
    :return: Прочитанные данные в виде байтовой строки.
    :raises RuntimeError: Если произошла ошибка при чтении данных.
    """
    try:
        return self.device.read(size)
    except Exception:
        raise RuntimeError("Device read error")

write(data)

Записывает данные в устройство FTDI.

Parameters:

Name Type Description Default
data bytes

Данные для записи в виде байтовой строки.

 required

Returns:

Type Description
int

Количество записанных байтов.

Raises:

Type Description
RuntimeError

Если произошла ошибка при записи данных.
Source code in pyspectrum/usb_context.py 
70
71
72
73
74
75
76
77
78
79
80
81
def write(self, data: bytes) -> int:
    """
    Записывает данные в устройство FTDI.

    :param data: Данные для записи в виде байтовой строки.
    :return: Количество записанных байтов.
    :raises RuntimeError: Если произошла ошибка при записи данных.
    """
    try:
        return self.device.write(data)
    except Exception:
        raise RuntimeError("Device write error")