docs: добавь поясняющие комментарии к модулям и инструментам

This commit is contained in:
2026-10-02 16:45:50 +03:00
parent 6cbce6c360
commit 427fc70100
488 changed files with 2877 additions and 1 deletions

View File

@@ -1,3 +1,7 @@
# Точка обнаружения декодера gate_driver_timing в DSView/libsigrokdecode. Экспорт класса
# Decoder из pd.py позволяет загрузчику зарегистрировать плагин; сам разбор потока выполняется
# в модуле декодера.
"""DSView protocol decoder for SCALE gate-driver timing checks."""
from .pd import Decoder

View File

@@ -1,3 +1,9 @@
# Проверка временных характеристик драйвера затвора по цифровым фронтам. Параметры профилей
# задаются в наносекундах; типичная задержка ACK используется для предупреждения, а
# нормированная длительность импульса — для PASS/FAIL. Этот адаптер переводит события
# libsigrokdecode в аннотации DSView; координаты выборок пересчитываются с учётом частоты
# захвата.
"""DSView/libsigrokdecode front end for SCALE gate-driver timing checks."""
import sigrokdecode as srd

View File

@@ -1 +1,5 @@
# Точка обнаружения декодера pm35_uart в DSView/libsigrokdecode. Экспорт класса Decoder из
# pd.py позволяет загрузчику зарегистрировать плагин; сам разбор потока выполняется в модуле
# декодера.
from .pd import Decoder

View File

@@ -1,3 +1,8 @@
# Декодирование UART-обмена ПМ35 с командами Modbus 03/06. Учитывается исторический ответ на
# 128 слов с нулевым полем числа байтов; универсальный Modbus-parser без этого правила
# потеряет границу сообщения. Этот адаптер переводит события libsigrokdecode в аннотации
# DSView; координаты выборок пересчитываются с учётом частоты захвата.
import sigrokdecode as srd
from common.setgui_decoders.pm35_uart import PM35Parser

View File

@@ -1 +1,5 @@
# Точка обнаружения декодера set_can в DSView/libsigrokdecode. Экспорт класса Decoder из pd.py
# позволяет загрузчику зарегистрировать плагин; сам разбор потока выполняется в модуле
# декодера.
from .pd import Decoder

View File

@@ -1,3 +1,8 @@
# Сегментация SET v2 и интерпретация CAN-данных зависят от выбранного слоя. Адрес и номер
# сегмента должны проверяться до объединения данных; classic CAN-пакет ограничен восемью
# байтами. Этот адаптер переводит события libsigrokdecode в аннотации DSView; координаты
# выборок пересчитываются с учётом частоты захвата.
import sigrokdecode as srd
from common.setgui_decoders.set_can import Reassembler, legacy

View File

@@ -1 +1,5 @@
# Точка обнаружения декодера set_uart в DSView/libsigrokdecode. Экспорт класса Decoder из
# pd.py позволяет загрузчику зарегистрировать плагин; сам разбор потока выполняется в модуле
# декодера.
from .pd import Decoder

View File

@@ -1,3 +1,8 @@
# Декодирование потоков UART протоколов SET по накопленным байтам. Поиск сигнатуры и проверка
# сообщения должны переживать границу входного фрагмента; неверная контрольная сумма не
# выдаётся как успешный пакет. Этот адаптер переводит события libsigrokdecode в аннотации
# DSView; координаты выборок пересчитываются с учётом частоты захвата.
import sigrokdecode as srd
from common.setgui_decoders.set_uart import StreamParser

View File

@@ -1 +1,5 @@
# Точка обнаружения декодера transistor_pair в DSView/libsigrokdecode. Экспорт класса Decoder
# из pd.py позволяет загрузчику зарегистрировать плагин; сам разбор потока выполняется в
# модуле декодера.
from .pd import Decoder

View File

@@ -1,3 +1,8 @@
# Анализ двух комплементарных входов транзисторной пары. Совместное включение, паузы и
# интервалы определяются только по этим входам; ACK/Vstat драйвера не участвуют в данной
# модели. Этот адаптер переводит события libsigrokdecode в аннотации DSView; координаты
# выборок пересчитываются с учётом частоты захвата.
"""Two-input transistor pair analyzer, independent of driver feedback."""
import sigrokdecode as srd
from common.setgui_decoders.transistor_pair import PairTimingChecker