Skip to main content

Async CAN / ISO-TP / UDS library for Car Bus Analyzer

Project description

car-bus-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.11 и выше
Никаких «магических» зависимостей — всё на asyncio.
*Тестировалось на устройствах с Протоколом Версии 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

# CANFD+BRS 500/2000 kbit/s
await dev.open_can_channel_custom(
    channel=1,
    nominal=(15, 12, 3, 1),  # Prescaler, tqSeg1, tqSeg2, SyncJW
    data=(6, 7, 2, 1),  # Prescaler, tqSeg1, tqSeg2, SyncJW
    fd=True,
    brs=True,
)

Информация об устройстве и фильтры

Пример запроса DEVICE_INFO и настройки фильтров:

info = await dev.get_device_info()

print("HW:", info.hardware_name)
print("FW:", info.firmware_version)
print("Serial:", info.serial_int)

# очистить все фильтры на канале 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 Ω
await dev.set_terminator(channel=1, enabled=True)

ISO-TP (isotp_async)

ISO-TP канал строится поверх CarBusDevice:

from isotp_async.transport import IsoTpChannel

can_tr = CarBusCanTransport(dev, channel=1, rx_id=0x7E8)
isotp = IsoTpChannel(can_tr, 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=30.0)
print("ISO-TP:", resp.hex())

UDS Client (uds_async.client)

Клиент UDS использует IsoTpChannel:

from isotp_async import CarBusCanTransport
from isotp_async.transport import IsoTpChannel
from uds_async import UdsClient

can_tr = CarBusCanTransport(dev, channel=1, rx_id=0x7E8)
isotp = IsoTpChannel(can_tr, 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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

carbus_lib-0.1.1.tar.gz (22.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

carbus_lib-0.1.1-py3-none-any.whl (23.4 kB view details)

Uploaded Python 3

File details

Details for the file carbus_lib-0.1.1.tar.gz.

File metadata

  • Download URL: carbus_lib-0.1.1.tar.gz
  • Upload date:
  • Size: 22.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for carbus_lib-0.1.1.tar.gz
Algorithm Hash digest
SHA256 04e2b8b0dcf73731f6bdadbfc948a8d181607b5ab971e4a751e8321e5f0bb96d
MD5 19c51309e4725d73b7e9e8b9f5edef2c
BLAKE2b-256 b789f08b45b59eaf39f7d184395f29b6dd98ed6668993074fc38ba698cbd8d51

See more details on using hashes here.

File details

Details for the file carbus_lib-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: carbus_lib-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 23.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for carbus_lib-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 252c145beb5b1ee8e6643e25999f3d837a32d4e20cf501f926cc41da349b8ac2
MD5 989d590fe77c90e7133370f80a04b513
BLAKE2b-256 f7787ba3547a8759c81b807c7f8312f8c09301d974d9b2411a69bc8a21c747b5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page