import sigrokdecode as srd # API sigrok передаёт кадры базового CAN-декодера и принимает аннотации. from common.setgui_decoders.set_can import Reassembler # Существующий сборщик проверяет сегментацию и тайм-аут SET v2. from common.setgui_decoders.template_protocols import CAN_PROFILES, LEGACY_PROJECTS, decode_can # Профили и каталоги определяются общими библиотеками templates. class Decoder(srd.Decoder): # Стековый анализатор добавляет прикладные дорожки к физическому CAN. api_version = 3 # Версия интерфейса соответствует поставляемому libsigrokdecode4DSL. id = 'set_can' # Стабильный ID сохраняет совместимость записей и меню SETGUI. name = 'SET CAN' # Короткое имя используется в дорожках и диалоге выбора. longname = 'SET CAN / ProtoCAN / Balsam / UMP / DEIF / legacy' # Подпись перечисляет подключённые семейства протоколов. desc = 'Templates protocols, application fields, registers and SET v2 reassembly.' # Описывает результат прикладного разбора. license = 'gplv2+' # Лицензия адаптера соответствует остальным декодерам SET. inputs = ['can'] # Источник — базовый декодер CAN, а не сырые логические уровни. outputs = ['set'] # Тип структурированного выхода сохранён для совместимости стека. tags = ['Embedded/industrial'] # Категория для штатного каталога DSView. options = ( # Несовместимые карты адресов выбираются явно. {'id': 'protocol', 'desc': 'Protocol / протокол', 'default': 'protocan', 'values': CAN_PROFILES}, # Прежнее значение по умолчанию сохраняет настройки существующих записей. {'id': 'project', 'desc': 'Legacy CAN project / проект', 'default': LEGACY_PROJECTS[0], 'values': LEGACY_PROJECTS}, # Проект применяется в режиме legacy. {'id': 'ump_map', 'desc': 'UMP map / карта УМП', 'default': 'gas167', 'values': ('gas167', 'assigned')}, # Локальная карта отделена от назначенных глобальных GAS ID. {'id': 'ump_node', 'desc': 'UMP node / номер УМП', 'default': 1, 'values': (1, 2)}, # Локальные адреса 167/v1 не содержат номер УМП. ) # Неприменимые к профилю настройки игнорируются. annotations = (('frame', 'Frame'), ('payload', 'Payload'), ('error', 'Error'), ('field', 'Field'), ('register', 'Register')) # Первые три индекса сохраняют прежние дорожки. annotation_rows = (('frames', 'Frames', (0,)), ('payload', 'Payload', (1,)), ('errors', 'Errors', (2,)), ('fields', 'Fields', (3,)), ('registers', 'Registers', (4,))) # Поля и регистры получают самостоятельные строки. def __init__(self): # Каждый экземпляр имеет независимое состояние разбора. self.reset() # Незавершённые сегменты не переходят между записями. def reset(self): # Перезапуск освобождает память сборщика. self.reassembler = Reassembler() # Машина ограничивает число параллельных пакетов и проверяет порядок сегментов. self.samplerate = None # Частота поступает событием metadata. def metadata(self, key, value): # Метаданные задают шкалу времени сборки пакетов. if key == srd.SRD_CONF_SAMPLERATE: # Прочие метаданные не влияют на тайм-ауты. self.samplerate = value # Частота выражена в отсчётах в секунду. def start(self): # Выходы регистрируются в штатной фазе запуска sigrok. self.out_ann = self.register(srd.OUTPUT_ANN) # Аннотации предназначены для дорожек и поиска DSView. self.out_python = self.register(srd.OUTPUT_PYTHON) # Словарь полей доступен последующим слоям стека. def decode(self, ss, es, data): # Границы входного CAN-кадра выражены в отсчётах. frame_type, ident, rtr, dlc, payload = data # Кортеж соответствует выходу штатного CAN-декодера. mode = self.options['protocol'] # Профиль определяет формат ID и полезной нагрузки. if frame_type not in ('extended', 'standard') or rtr == 'remote': # RTR не содержит прикладных данных. return # Такие кадры остаются в базовых дорожках CAN. if frame_type == 'standard' and mode != 'deif': # DEIF использует STD CANopen, остальные подключённые протоколы — EXT. return # Предотвращает интерпретацию 11-битного ID как адреса ProtoCAN. if not 0 <= dlc <= 8 or len(payload) != dlc: # Classic CAN ограничивает нагрузку восемью байтами и требует совпадения длины с DLC. events = [(ss, es, None, 'Invalid classic CAN DLC')] # Повреждённый кадр показывается как ошибка. elif mode == 'set-v2' or mode == 'auto' and ident >> 24 == 0x12: # Авто распознаёт зарезервированный префикс SET v2 без угадывания проекта. if not self.samplerate: # Частота нужна для корректного тайм-аута сборки. raise ValueError('SET CAN requires samplerate for reassembly timeout') # Движок получает явную ошибку конфигурации. events = self.reassembler.feed(ident, payload, ss, es, es * 1000.0 / self.samplerate) # Перевод отсчётов в миллисекунды соответствует контракту сборщика. else: # Несегментированные протоколы обрабатывают каждый кадр независимо. try: # Ошибка одного кадра не должна прекращать разбор записи. result = decode_can(ident, payload, mode, extended=frame_type == 'extended', ump_map=self.options['ump_map'], ump_node=self.options['ump_node'], project=self.options['project']) # Подключает текущий парсер templates и выбранную карту. events = [(ss, es, result, None)] if result else [] # Чужой ID не создаёт ложных событий выбранного проекта. except ValueError as exc: # Проверки DLC, диапазонов и форматов возвращают диагностический текст. events = [(ss, es, None, str(exc))] # Следующий кадр продолжит обрабатываться. for start, end, result, error in events: # Сборщик может выдать несколько событий за один кадр. self.put(start, end, self.out_ann, [2 if error else 0, [error or result['summary']]]) # Сводка попадает на дорожку Frames либо Errors. if result: # Подробности выдаются для распознанного сообщения. for title, value in result.get('fields', []): # Названия и единицы определены общим парсером. self.put(start, end, self.out_ann, [3, ['%s: %s' % (title, value)]]) # Поля доступны для просмотра и поиска. for address, value in result.get('registers') or []: # Отсутствующая регистровая нагрузка отличается от пустого запроса. self.put(start, end, self.out_ann, [4, ['R%04X = %04X (%d)' % (address, value, value)]]) # Адрес и слово показаны в HEX, значение также в десятичной системе. for warning in result.get('warnings', []): # Замечания общего парсера сохраняются вместе с корректными полями. self.put(start, end, self.out_ann, [2, [warning]]) # Предупреждения видны в строке ошибок. result['can_id'] = ident # ID остаётся доступным последующим слоям. self.put(start, end, self.out_python, ['FRAME', result]) # Передаёт полную модель события. if events and payload: # Сырые байты позволяют сопоставить расшифровку с исходным CAN. self.put(ss, es, self.out_ann, [1, [' '.join('%02X' % byte for byte in payload)]]) # Порядок байтов совпадает с захватом.