CAN BUS tools.
Project description
About
CAN BUS tools.
DBC file mangling.
candump output decoder.
Installation
pip install cantools
Example usage
Scripting
An example parsing and using a small DBC-file:
>>> import cantools
>>> from pprint import pprint
>>> db = cantools.db.File()
>>> db.add_dbc_file('tests/files/motohawk.dbc')
>>> db
version('1.0')
node('PCM1', None)
node('FOO', None)
message('ExampleMessage', 0x1f0, 8, 'Example message used as template in MotoHawk models.')
signal('Temperature', 7, 12, 'big_endian', True, 0.01, 250, 229.53, 270.47, 'degK', None, None)
signal('AverageRadius', 1, 6, 'big_endian', False, 0.1, 0, 0.0, 5.0, 'm', None, '')
signal('Enable', 0, 1, 'big_endian', False, 1.0, 0, 0.0, 0.0, '-', None, None)
>>> db.messages
[message('ExampleMessage', 0x1f0, 8, 'Example message used as template in MotoHawk models.')]
>>> example_message = db.messages[0]
>>> example_message.comment
'Example message used as template in MotoHawk models.'
>>> pprint(example_message.signals)
[signal('Temperature', 7, 12, 'big_endian', True, 0.01, 250, 229.53, 270.47, 'degK', None, None),
signal('AverageRadius', 1, 6, 'big_endian', False, 0.1, 0, 0.0, 5.0, 'm', None, ''),
signal('Enable', 0, 1, 'big_endian', False, 1.0, 0, 0.0, 0.0, '-', None, None)]
>>> db.nodes
[node('PCM1', None), node('FOO', None)]
>>> db.version
'1.0'
>>>
The example continues encoding a message and sending it on a CAN bus using the python-can package.
>>> import can
>>> can.rc['interface'] = 'socketcan_ctypes'
>>> can.rc['channel'] = 'vcan0'
>>> can_bus = can.interface.Bus()
>>> data = example_message.encode({'Temperature': 250.1, 'AverageRadius': 3.2, 'Enable': 1})
>>> message = can.Message(arbitration_id=example_message.frame_id, data=data)
>>> can_bus.send(message)
>>>
See the test suite for additional examples: https://github.com/eerimoq/cantools/blob/master/tests/test_cantools.py
Command line tool
Decode CAN frames captured with the Linux program candump.
$ candump vcan0 | cantools decode motohawk.dbc
vcan0 000001F0 [7] 01 FA 0F 00 00 00 00 :: ExampleMessage(Temperature: 249.88 degK, AverageRadius: 0.0 m, Enable: 1.0 -)
vcan0 000001F0 [7] 01 FA 0F 00 00 00 00 :: ExampleMessage(Temperature: 249.88 degK, AverageRadius: 0.0 m, Enable: 1.0 -)
vcan0 000001F0 [7] 01 FA 0F 00 00 00 00 :: ExampleMessage(Temperature: 249.88 degK, AverageRadius: 0.0 m, Enable: 1.0 -)
Contributing
Fork the repository.
Implement the new feature or bug fix.
Implement test case(s) to ensure that future changes do not break legacy.
Run the test suite for Python 2 and Python 3. Make sure all tests pass.
python setup.py test python3 setup.py test
Create a pull request.
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
cantools-4.0.0.tar.gz
(20.9 kB
view hashes)
Built Distribution
Close
Hashes for cantools-4.0.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3b0c3426a48e2a88a48a1b40ff12d48e9e00e73edf4d97c521471205d49846ae |
|
MD5 | b319a3c16cb6308cae751a15ca3a54ad |
|
BLAKE2b-256 | 323c95374463ac6f88f1fe1aa0ae4dbda95dac193e507de7a6eb8319894d29c1 |