Skip to main content

An editor for CAN bus database files like dbc or sym, based on cantools and urwid

Project description

dbc-editor

An editor for CAN bus database files like dbc or sym, based on cantools and urwid.

Usage

This application is not mature yet but it is already possible to open existing files and create new ones.

Pass the file that you want to open as command line argument. You can also pass the name of a not existing file in order to create a new file.

When you open the program a list of all messages defined in the passed file is displayed. If it is a new file this list is empty.

How to navigate in the list view:

  • 'arrow up' / 'arrow down' to select a message
  • 'arrow right' to display the signals of the currently selected message
  • 'arrow left' to return from the list of signals to the list of messages
  • 'e' to edit the selected message (if you are in the list of messages) / signal (if you are in the list of signals)
  • '+' to create a new message/signal
  • '-' to delete the selected message/signal
  • 'w' to write/save
  • 'q' to quit

How to navigate in the edit view:

  • 'arrow up' / 'arrow down' to select the entry field

  • 'arrow left' / 'arrow right' to select a radio button. Be careful to not press these buttons too often:

    • If you are on the left most position, pressing 'arrow left' returns to the list view. If you have made changes it will ask you whether you want to save the changes. You can press 'escape' in this dialog to return to the edit view.
    • If you are on the right most position, pressing 'arrow right' saves the changes and returns to the list view. (Same like 'enter')

    Maybe I will change this in the future but this does not have a priority.

  • 'enter' to save changes and return to the list of messages/signals

  • 'escape' to discard changes and return to the list of messages/signals

Installation

$ pipx install dbc-editor

TODO

Most important TODO flags:

  • user input is not checked yet in message edit (only in signal edit), e.g. not entering a Frame ID causes a crash
  • check that database object is ok (for the time being: write, close, open file again. I recommend you version your database files in git, then you can always easily go back if a file gets corrupted.)

Missing message attributes:

  • senders
  • send_type
  • cycle_time

Missing signal attributes:

  • multiplexing
  • initial
  • offset
  • minimum
  • maximum

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

dbc-editor-0.1.0.tar.gz (17.1 kB view details)

Uploaded Source

Built Distribution

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

dbc_editor-0.1.0-py3-none-any.whl (14.1 kB view details)

Uploaded Python 3

File details

Details for the file dbc-editor-0.1.0.tar.gz.

File metadata

  • Download URL: dbc-editor-0.1.0.tar.gz
  • Upload date:
  • Size: 17.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.28.1

File hashes

Hashes for dbc-editor-0.1.0.tar.gz
Algorithm Hash digest
SHA256 fac01e90e9818899375675bac82fc4aa5d8ab5016808bb2caad50f541ba9cc61
MD5 f3467ff71f2701c8bc6e73568dc7ae94
BLAKE2b-256 eb676cb710b0f484c2cc4628c78414dfc2dff2aa5a64d4414fec77993e71b599

See more details on using hashes here.

File details

Details for the file dbc_editor-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: dbc_editor-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 14.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.28.1

File hashes

Hashes for dbc_editor-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4eeab20410b8703b45d7252b278c9c3041f9e303690a18fdfcc61ebede401ee1
MD5 343ab1dd6e49244d937e0b1560443b29
BLAKE2b-256 230f2417b636f1fefcbd0108f8b716b69bbc443a7b06c7eaa7a9b5127e683b5a

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