Skip to main content

UDS over CAN Driver

jumpstarter-driver-uds-can provides UDS (Unified Diagnostic Services, ISO-14229) operations over CAN/ISO-TP (ISO-15765) transport for Jumpstarter. This enables remote automotive ECU diagnostics over CAN bus.

For UDS over DoIP (automotive Ethernet), see jumpstarter-driver-uds-doip. For raw CAN and ISO-TP operations, see jumpstarter-driver-can.

Installation

pip3 install --extra-index-url https://pkg.jumpstarter.dev/simple/ jumpstarter-driver-uds-can

Configuration

Parameter Type Default Description
channel str required CAN channel (e.g. can0, vcan0)
interface str socketcan python-can interface type
rxid int required ISO-TP receive arbitration ID
txid int required ISO-TP transmit arbitration ID
request_timeout float 5.0 UDS request timeout in seconds
isotp_params IsoTpParams {} ISO-TP parameters (stmin, blocksize, etc.)

ISO-TP Parameters

Parameter Type Default Description
stmin int 0 Minimum separation time (ms)
blocksize int 8 Number of consecutive frames
tx_data_length int 8 CAN frame data length
max_frame_size int 4095 Maximum ISO-TP frame size
can_fd bool false Use CAN FD
blocking_send bool false Use blocking send

Example exporter configuration

export:
  uds:
    type: jumpstarter_driver_uds_can.driver.UdsCan
    config:
      channel: "can0"
      interface: "socketcan"
      rxid: 1601  # 0x641
      txid: 1602  # 0x642
      request_timeout: 5
      isotp_params:
        stmin: 32
        blocksize: 8
        tx_data_length: 8

Client API

The client API is shared by all UDS transport drivers via jumpstarter-driver-uds. See the UDS driver documentation for the full API reference.

Method Description
change_session(session) Change diagnostic session
ecu_reset(reset_type) Reset ECU
tester_present() Keep session alive
read_data_by_identifier(did_list) Read DID values
write_data_by_identifier(did, value) Write DID value
request_seed(level) Request security access seed
send_key(level, key) Send security access key
clear_dtc(group) Clear diagnostic trouble codes
read_dtc_by_status_mask(mask) Read DTCs matching status mask

Download files

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

Source Distribution

jumpstarter_driver_uds_can-0.8.1.tar.gz (6.5 kB view details)

Uploaded Source

Built Distribution

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

jumpstarter_driver_uds_can-0.8.1-py3-none-any.whl (8.0 kB view details)

Uploaded Python 3

File details

Details for the file jumpstarter_driver_uds_can-0.8.1.tar.gz.

File metadata

File hashes

Hashes for jumpstarter_driver_uds_can-0.8.1.tar.gz
Algorithm Hash digest
SHA256 a647a0c694603962bfad67d5be7e23f2c54d315363b27ef95d95ee9128ff3b6e
MD5 5b4faf419f1a6c588d78a482735ef92b
BLAKE2b-256 484711297da6a10b9c90b289078a9f2d43459c20102644684355d802e65da991

See more details on using hashes here.

File details

Details for the file jumpstarter_driver_uds_can-0.8.1-py3-none-any.whl.

File metadata

File hashes

Hashes for jumpstarter_driver_uds_can-0.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c8d5c3215dac76f7cb3eb0e27e5f97df8a126f64c8109993ebd3966f51a461ce
MD5 079f70e10732ebeb592021ef17bc65a5
BLAKE2b-256 7a0914ed3669fb6a4c2ee869ce66e9f96ed423d70d80ea2a121127257bdb02a8

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.8.1 This release

2 files

Supported by

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