Async CAN / ISO-TP / UDS library for Car Bus Analyzer
Project description
carbus-lib (async CAN / ISO-TP / UDS stack)
Асинхронная библиотека на Python для работы с CAN-адаптером CAN-Hacker / Car Bus Analyzer:
- 📡
carbus_async– низкоуровневая работа с железкой (CAN/LIN, фильтры, терминаторы и т.д.) - 📦
isotp_async– ISO-TP (ISO 15765-2) поверх CAN (single + multi-frame) - 🩺
uds_async– UDS (ISO 14229) клиент и сервер (диагностика, чтение VIN и т.п.) - 🌐
TCP-bridge– удалённое подключение к адаптеру через сеть (как будто он воткнут локально)
Python 3.10 и выше
Никаких «магических» зависимостей — всё наasyncio.
Поддерживаемые интерфейсы: https://canhacker.ru/shop/
*Тестировалось на устройствах с Протоколом Версии 22
Установка
Через систему управления пакетами PIP
python -m pip install carbus-lib
Либо как editable-модуль из репозитория:
git clone https://github.com/controllerzz/carbus_lib.git
cd carbus_lib
pip install -e .
carbus-lib
Асинхронная библиотека для работы с CAN / CAN-FD, ISO-TP и UDS.
Поддерживает локальное подключение через USB CDC и удалённую работу через TCP-bridge.
Возможности
- CAN / CAN-FD отправка и приём
- Настройка каналов, скоростей, режимов, BRS
- Фильтры ID, очистка фильтров, управление терминатором 120 Ω
- ISO-TP (single + multi-frame)
- UDS Client и UDS Server (эмуляция ЭБУ)
- TCP-мост: удалённая работа с адаптером так, как будто он подключён локально
- Логирование всего протокольного трафика
Работа с CAN
Простейший пример: открыть устройство, настроить канал и отправить / принять кадр.
import asyncio
from carbus_async.device import CarBusDevice
from carbus_async.messages import CanMessage
async def main():
dev = await CarBusDevice.open("COM6", baudrate=115200)
# классический CAN 500 kbit/s
await dev.open_can_channel(
channel=1,
nominal_bitrate=500_000,
)
# включаем терминатор 120 Ω на канале 1
await dev.set_terminator(channel=1, enabled=True)
# отправка кадра 0x7E0 8 байт
msg = CanMessage(can_id=0x7E0, data=b"\x02\x3E\x00\x00\x00\x00\x00\x00")
await dev.send_can(msg, channel=1)
# приём любого сообщения
ch, rx = await dev.receive_can()
print("RX:", ch, rx)
await dev.close()
asyncio.run(main())
Настройка канала через Bit Timing
Возможность конфигруации скорости CAN канала через Bit Timing
# CANFD+BRS 500/2000 kbit/s
await dev.open_can_channel_custom(
channel=1,
nominal_timing=CanTiming(
prescaler=15,
tq_seg1=12,
tq_seg2=3,
sjw=1
),
data_timing=CanTiming(
prescaler=6,
tq_seg1=7,
tq_seg2=2,
sjw=1
),
fd=True,
brs=True,
)
Получение информации об устройстве:
Получение инфмормации об устройстве и его фичах
info = await dev.get_device_info()
print("HW:", info.hardware_name)
print("FW:", info.firmware_version)
print("Serial:", info.serial_int)
print("Features:",
"gateway" if info.feature_gateway else "",
"isotp" if info.feature_isotp else "",
"txbuf" if info.feature_tx_buffer else "",
"txtask" if info.feature_tx_task else "",
)
Пример настройки фильтров:
11 bit фильтры имеют index от 0 до 27 включительно, 29 bit фильтры имеют index от 28 до 35 включительно
# очистить все фильтры на канале 1
await dev.clear_all_filters(1)
# разрешить только ответы с ID 0x7E8 (11-битный стандартный ID)
await dev.set_std_id_filter(
channel=1,
index=0,
can_id=0x7E8,
mask=0x7FF,
)
Управление терминатором 120 Ω:
Включаем терминатор на канале 1 и выключаем терминатор на канале 2
await dev.set_terminator(channel=1, enabled=True)
await dev.set_terminator(channel=2, enabled=False)
Проверка наличия внутреннего терминатора у девайса
if await dev.has_terminator():
await dev.set_terminator(channel=1, enabled=True)
print("Device has an internal terminator")
else:
print("Device does not have an internal terminator")
Включаем терминатор на канале 1, если это поддерживает девайс
await dev.ensure_terminator(channel=1, enabled=True)
Отправка периодичных сообщений:
Отправка сообщений с статичными данными и периодом 100мс
from carbus_async import PeriodicCanSender
sender = PeriodicCanSender(dev)
sender.add(
"heartbeat",
channel=1,
can_id=0x123,
data=b"\x01\x02\x03\x04\x05\x06\x07\x08",
period_s=0.1,
)
Отправка сообщений с модификацией данных и периодом 500мс
from carbus_async import PeriodicCanSender
sender = PeriodicCanSender(dev)
def mod(tick, data):
b = bytearray(data)
b[0] = tick & 0xFF
return bytes(b)
sender.add(
"cnt",
channel=1,
can_id=0x100,
data=b"\x00" * 8,
period_s=0.5,
modify=mod)
Хуки подписка на сообщение / сообщение + данные по маске:
Подписка по CAN ID
@dev.on_can_id(0x7E0)
async def on_engine_req(ch, msg):
print("ENGINE:", hex(msg.can_id), msg.data.hex())
Подписка по CAN ID + маске данных
@dev.on_can_match(
can_id=0x7E0,
value=b"\x02\x10\x00",
mask=b"\xFF\xFF\x00",
)
async def on_session_control(ch, msg):
print("SessionControl")
ISO-TP (isotp_async)
ISO-TP канал строится поверх CarBusDevice:
from isotp_async import open_isotp
isotp = await open_isotp(dev, channel=1, tx_id=0x7E0, rx_id=0x7E8)
# отправить запрос ReadDataByIdentifier F190 (VIN)
await isotp.send_pdu(b"\x22\xF1\x90")
# получить полный ответ (single или multi-frame)
resp = await isotp.recv_pdu(timeout=5.0)
print("ISO-TP:", resp.hex())
UDS Client (uds_async.client)
Клиент UDS использует IsoTpChannel:
from isotp_async import open_isotp
from uds_async import UdsClient
isotp = await open_isotp(dev, channel=1, tx_id=0x7E0, rx_id=0x7E8)
uds = UdsClient(isotp)
vin = await uds.read_data_by_identifier(0xF190)
print("VIN:", vin.decode(errors="ignore"))
Удалённая работа через TCP (tcp_bridge)
1. Сервер (рядом с адаптером)
На машине, где физически подключён CAN-адаптер:
python.exe -m carbus_async.tcp_bridge --serial COM6 --port 7000
Адаптер открывается локально, а поверх него поднимается TCP-мост.
2. Клиент (удалённая машина)
На другой машине можно использовать тот же API, как с локальным COM, но через open_tcp:
import asyncio
from carbus_async.device import CarBusDevice
from carbus_async.messages import CanMessage
async def main():
dev = await CarBusDevice.open_tcp("192.168.1.10", 7000)
await dev.open_can_channel(
channel=1,
nominal_bitrate=500_000,
fd=False,
)
msg = CanMessage(can_id=0x321, data=b"\x01\x02\x03\x04")
await dev.send_can(msg, channel=1)
ch, rx = await dev.receive_can()
print("REMOTE RX:", ch, rx)
await dev.close()
asyncio.run(main())
Логирование
Для отладки удобно включить подробное логирование:
import logging
logging.basicConfig(
level=logging.DEBUG,
format="%(asctime)s [%(levelname)s] %(name)s: %(message)s",
)
Логгеры:
carbus_async.wire.*— сырые кадры по USB/TCP (TX/RX)carbus_async.device.*— высокоуровневые события, ошибки, BUS_ERROR- дополнительные логгеры в isotp_async / uds_async
Лицензия
MIT.
ДАННОЕ ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ ПРЕДОСТАВЛЯЕТСЯ «КАК ЕСТЬ», БЕЗ КАКИХ-ЛИБО ГАРАНТИЙ, ЯВНО ВЫРАЖЕННЫХ ИЛИ ПОДРАЗУМЕВАЕМЫХ, ВКЛЮЧАЯ ГАРАНТИИ ТОВАРНОЙ ПРИГОДНОСТИ, СООТВЕТСТВИЯ ПО ЕГО КОНКРЕТНОМУ НАЗНАЧЕНИЮ И ОТСУТСТВИЯ НАРУШЕНИЙ, НО НЕ ОГРАНИЧИВАЯСЬ ИМИ. НИ В КАКОМ СЛУЧАЕ АВТОРЫ ИЛИ ПРАВООБЛАДАТЕЛИ НЕ НЕСУТ ОТВЕТСТВЕННОСТИ ПО КАКИМ-ЛИБО ИСКАМ, ЗА УЩЕРБ ИЛИ ПО ИНЫМ ТРЕБОВАНИЯМ, В ТОМ ЧИСЛЕ, ПРИ ДЕЙСТВИИ КОНТРАКТА, ДЕЛИКТЕ ИЛИ ИНОЙ СИТУАЦИИ, ВОЗНИКШИМ ИЗ-ЗА ИСПОЛЬЗОВАНИЯ ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ ИЛИ ИНЫХ ДЕЙСТВИЙ С ПРОГРАММНЫМ ОБЕСПЕЧЕНИЕМ.
Pull Requests и предложения по улучшению приветствуются 🚗
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file carbus_lib-0.1.6.tar.gz.
File metadata
- Download URL: carbus_lib-0.1.6.tar.gz
- Upload date:
- Size: 31.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b7dc736ac2b90b49ddab5ae9b48e6cd73faef97ffc8b4c4c65ce4aefeedb1be0
|
|
| MD5 |
9154d6c2365cb38b2467139f0929e1e2
|
|
| BLAKE2b-256 |
2e025b219bdeb521b8a2ce4232b33b8e72c503dfb119501d341de0078fc46017
|
File details
Details for the file carbus_lib-0.1.6-py3-none-any.whl.
File metadata
- Download URL: carbus_lib-0.1.6-py3-none-any.whl
- Upload date:
- Size: 34.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1794942e15321c0ef950a2bf671474367622c0ed562dcba3cf02a38c4dcfaf4f
|
|
| MD5 |
121ae814e4616884126fc912685874fb
|
|
| BLAKE2b-256 |
eb6e4284d9cad3b06e7cb3d4ccc27dff04ea83bac0c016665ac9f7c9251fd6e2
|