Skip to main content

An NCurses-based TUI application for tracking activity over the CAN bus and decoding messages with provided EDS/OD files.

Project description

CANOpen Monitor

license pypi read the docs issues feature requests unit tests deployment

An NCurses-based TUI application for tracking activity over the CAN bus and decoding messages with provided EDS/OD files.


Quick Start

Install

$ pip install canopen-monitor

Run

Run the monitor, binding to can0

$ canopen-monitor -i can0

Use this for an extensive help menu

$ canopen-monitor --help


Configuration

The default configurations provided by CANOpen Monitor can be found in canopen_monitor/assets. These are the default assets provided. At runtime these configs are copied to ~/.config/canopen-monitor where they can be modified and the changes will persist.

EDS files are loaded from ~/.cache/canopen-monitor


Development and Contribution

Documentation

Check out our Read The Docs pages for more info on the application sub-components and methods.

Pre-Requisites

  • Linux 4.11 or greater (any distribution)

  • Python 3.8.5 or higher (pyenv is recommended for managing different python versions, see pyenv homepage for information)

Install Locally

Setup a virtual CAN signal generator

$ sudo apt-get install can-utils

Start a virtual CAN

$ sudo ip link add dev vcan0 type vcan

$ sudo ip link set up vcan0

Clone the repo

$ git clone https://github.com/Boneill3/CANopen-monitor.git

$ cd CANopen-monitor

$ pip install -e .[dev]

(Note: the -e flag creates a symbolic-link to your local development version. Set it once, and forget it)

Generate random messages with socketcan-dev

$ chmod 700 socketcan-dev

$ ./socketcan-dev.py --random-id --random-message -r

Start the monitor

$ canopen-monitor

Create documentation locally

$ make -C docs clean html

(Note: documentation is configured to auto-build with ReadTheDocs on every push to master)


Message Types + COB ID Ranges:

Wikipedia Table
Abridged Table:
Name COB ID Range
SYNC 080
EMCY 080 + NodeID
TPDO1 180 + NodeID
RPDO1 200 + NodeID
TPDO2 280 + NodeID
RPDO2 300 + NodeID
TPDO3 380 + NodeID
RPDO3 400 + NodeID
TPDO4 480 + NodeID
RPDO4 500 + NodeID
TSDO 580 + NodeID
RSDO 600 + NodeID
NMT (Heartbeat) 700 + NodeID

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

canopen-monitor-3.3.1.tar.gz (48.0 kB view details)

Uploaded Source

Built Distribution

canopen_monitor-3.3.1-py3-none-any.whl (69.3 kB view details)

Uploaded Python 3

File details

Details for the file canopen-monitor-3.3.1.tar.gz.

File metadata

  • Download URL: canopen-monitor-3.3.1.tar.gz
  • Upload date:
  • Size: 48.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.4

File hashes

Hashes for canopen-monitor-3.3.1.tar.gz
Algorithm Hash digest
SHA256 ad4b815faa14a777622c9aa6016b38eae5ab33f404b2e2ee65cc6712de6059de
MD5 3173d01ea255321fea7a4d249b53b0fe
BLAKE2b-256 bb86719b5101ff8c21ecf107d105d202df5463b926acc52c0365d4395c9db4f3

See more details on using hashes here.

File details

Details for the file canopen_monitor-3.3.1-py3-none-any.whl.

File metadata

  • Download URL: canopen_monitor-3.3.1-py3-none-any.whl
  • Upload date:
  • Size: 69.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.4

File hashes

Hashes for canopen_monitor-3.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f905175a2da1481cb6bd98e79be639a44cef7c1be2b51e12d905beaba9274a08
MD5 a81c414e44d500ff1764fc8856d6a69a
BLAKE2b-256 48a53b0e788e0bddedfaf4ae0e28a6596faf22832d1c519fa0fbb4ca0cfe0f7e

See more details on using hashes here.

Supported by

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