Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lauszus/python_can_viewer
Python CAN Viewer
https://github.com/lauszus/python_can_viewer
Last synced: 24 days ago
JSON representation
Python CAN Viewer
- Host: GitHub
- URL: https://github.com/lauszus/python_can_viewer
- Owner: Lauszus
- License: gpl-2.0
- Created: 2018-07-06T10:11:31.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-07-06T18:01:00.000Z (over 2 years ago)
- Last Synced: 2024-10-07T15:05:27.467Z (about 1 month ago)
- Language: Python
- Size: 506 KB
- Stars: 13
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Python CAN Viewer
#### Developed by Kristian Lauszus, 2018
The code is released under the GNU General Public License.
_________
[](https://pypi.org/project/Python-CAN-Viewer)
[](https://travis-ci.com/Lauszus/python_can_viewer)
[](https://ci.appveyor.com/project/Lauszus/python-can-viewer/branch/master)
[](https://codecov.io/gh/Lauszus/python_can_viewer)
A simple CAN viewer terminal application written in Python. Python 2, Python 3, pypy and pypy3 are supported.
## Deprecated
This package is deprecated, as it is now part of the [python-can](https://github.com/hardbyte/python-can) package.
Improvements and bug-fixes will not be back-ported. For that reason it is recommended to use the [python-can](https://github.com/hardbyte/python-can) package instead by executing the following:
```bash
python -m can.viewer
```
## Usage
The program can be installed via pip:
```bash
pip install python_can_viewer
```
To run the script simply execute:
```bash
python -m python_can_viewer
```
A screenshot of the application can be seen below:
The first column is the number of times a frame with the particular ID has been received, next is the timestamp of the frame relative to the first received message. The third column is the time between the current frame relative to the previous one. Next is the length of the frame and then the data.
The last two columns are the decoded CANopen function code and node ID. If CANopen is not used, then they can simply be ignored.
### Command line arguments
By default it will be using the ```socketcan``` interface. All interfaces supported by [python-can](https://github.com/hardbyte/python-can) are supported and can be specified using the ```-i``` argument.
The full usage page can be seen below:
```
Usage: python -m python_can_viewer [-h] [--version] [-b BITRATE] [-c CHANNEL]
[-d {:,:::...:,file.txt}]
[-f {:,~}]
[-i {iscan,ixxat,kvaser,neovi,nican,pcan,serial,slcan,socketcan,socketcan_ctypes,socketcan_native,usb2can,vector,virtual}]
[--ignore-canopen]
A simple CAN viewer terminal application written in Python
Optional arguments:
-h, --help Show this help message and exit
--version Show program's version number and exit
-b, --bitrate BITRATE
Bitrate to use for the given CAN interface
-c, --channel CHANNEL
Most backend interfaces require some sort of channel.
for example with the serial interface the channel
might be a rfcomm device: "/dev/rfcomm0" with the
socketcan interfaces valid channel examples include:
"can0", "vcan0". (default: use default for the
specified interface)
-d, --decode {:,:::...:,file.txt}
Specify how to convert the raw bytes into real values.
The ID of the frame is given as the first argument and the format as the second.
The Python struct package is used to unpack the received data
where the format characters have the following meaning:
< = little-endian, > = big-endian
x = pad byte
c = char
? = bool
b = int8_t, B = uint8_t
h = int16, H = uint16
l = int32_t, L = uint32_t
q = int64_t, Q = uint64_t
f = float (32-bits), d = double (64-bits)
Fx to convert six bytes with ID 0x100 into uint8_t, uint16 and uint32_t:
$ python -m python_can_viewer -d "100::,~}
Comma separated CAN filters for the given CAN interface:
: (matches when & mask == can_id & mask)
~ (matches when & mask != can_id & mask)
Fx to show only frames with ID 0x100 to 0x103:
python -m python_can_viewer -f 100:7FC
Note that the ID and mask are alway interpreted as hex values
-i, --interface {iscan,ixxat,kvaser,neovi,nican,pcan,serial,slcan,socketcan,socketcan_ctypes,socketcan_native,usb2can,vector,virtual}
Specify the backend CAN interface to use. (default: "socketcan")
--ignore-canopen Do not print CANopen information
```
### Shortcuts
| Key | Description |
|:--------:|:-----------------------:|
| ESC/q | Exit the viewer |
| c | Clear the stored frames |
| SPACE | Pause the viewer |
| UP/DOWN | Scroll the viewer |
### Misc
I would recommend the following board for testing on a Raspberry Pi: .
The CAN interface can be setup like so:
```bash
sudo apt-get -y install can-utils
sudo raspi-config nonint do_spi 0
sudo sh -c 'echo "dtoverlay=mcp2515-can0,oscillator=16000000,interrupt=25" >> /boot/config.txt'
sudo sh -c 'echo "dtoverlay=spi0-hw-cs" >> /boot/config.txt'
```
For more information send me an email at .