https://github.com/jmscslgroup/strym
A real time CAN vehicle data logging, analysis and visualization tool to work with USB-CAN Interface for developing in-vehicle AI algorithms for self-driving and automation
https://github.com/jmscslgroup/strym
can-bus cantools commaai data-visualization openpilot python3 visualization
Last synced: 6 months ago
JSON representation
A real time CAN vehicle data logging, analysis and visualization tool to work with USB-CAN Interface for developing in-vehicle AI algorithms for self-driving and automation
- Host: GitHub
- URL: https://github.com/jmscslgroup/strym
- Owner: jmscslgroup
- License: other
- Created: 2019-11-12T05:48:05.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2025-06-09T21:14:07.000Z (8 months ago)
- Last Synced: 2025-07-07T21:19:46.891Z (7 months ago)
- Topics: can-bus, cantools, commaai, data-visualization, openpilot, python3, visualization
- Language: Python
- Homepage: https://jmscslgroup.github.io/strym/
- Size: 179 MB
- Stars: 30
- Watchers: 6
- Forks: 6
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.rst
- License: LICENSE
Awesome Lists containing this project
- awesome-canbus - strym - Real time CAN data logging and visualization tool to work with USB-CAN Interface. (Utils / Python Tools)
README
# Strym
[](https://GitHub.com/jmscslgroup/strym/graphs/commit-activity)
[](https://www.python.org/)
[](https://www.sphinx-doc.org/)
[](https://pypi.python.org/pypi/strym/)
[](https://pepy.tech/project/strym)
## Citation
Please cite our work as follows if you have used Strym:
Bhadani, Rahul, Matt Bunting, Matthew Nice, Ngoc Minh Tran, Safwan Elmadani, Dan Work, and Jonathan Sprinkle.
Strym: A python package for real-time can data logging, analysis and visualization to work with usb-can interface."
In 2022 2nd Workshop on Data-Driven and Intelligent Cyber-Physical Systems for Smart Cities Workshop (DI-CPS), pp. 14-23. IEEE, 2022.
```
@inproceedings{bhadani2022strym,
title={Strym: A python package for real-time can data logging, analysis and visualization to work with usb-can interface},
author={Bhadani, Rahul and Bunting, Matt and Nice, Matthew and Tran, Ngoc Minh and Elmadani, Safwan and Work, Dan and Sprinkle, Jonathan},
booktitle={2022 2nd Workshop on Data-Driven and Intelligent Cyber-Physical Systems for Smart Cities Workshop (DI-CPS)},
pages={14--23},
year={2022},
organization={IEEE}
}
```
__A python package for real-time CAN data logging, analysis and visualization to work with USB-CAN Interface.__
__Strym__ is a python package that provides APIs to interface with COMMA.AI panda for logging CAN data, analysis and visualization in real-time from supported modern vehicles such Toyota RAV4 and Honda Pilot. There are two kinds of functionality that __Strym__ provides:
1. Real-time visualization of CAN data through comma.ai Panda and Giraffe connector.
2. Offline analysis and visualization of CAN Data from a CSV Formatted file.
## Installation
The recommended way to use strym is with UV package manager and virutal environment.
### Installing Rust and Cargo
```
curl https://sh.rustup.rs -sSf | sh
```
### Installing UV
```
curl -LsSf https://astral.sh/uv/install.sh | sh
```
Close the terminal and reopen it.
### Creating Python Virtual Environment
```
mkdir -p playground/stream
cd playground/stream
uv python install 3.12
uv init --name stream --no-package
uv venv --python 3.12
# activate virtual environment
source .venv/bin/activate
uv add strym
uv add ipykernel
uv add notebook
```
The above has to be done one time only.
For the subsequent session, do the following, after opening the new terminal
If you have an existing conda environment, deactivate using `conda deactivate`.
If you have any other python virtual environment, deactivate that as well.
### Using strym
```
cd playground/stream
source .venv/bin/activate
jupyter notebook
```
It will launch the jupyter notebook.
Create a new notebook, and add the following code:
```
import strym
from strym import strymread
# change the file name as per your convenience
file = "2021-06-04-12-01-39_2T3MWRFVXLW056972_CAN_Messages.csv"
r = strymread(file)
r.speed()
```
If you see the speed dataframe, it means strym is read to be used by you.
You should also be able to use Visual Studio code in the same manner by following the instruction
```
cd playground/stream
source .venv/bin/activate
code .
```
Then, you can create a Python notebook, and select the Python Kernel from `.venv/bin/activate`.
## Philosophy behind Strym
Strym data is capable of handling timeseries data obtained from Comma.ai Panda and Giraffe Connector.
Most functions and methods in `strym` expects timeseries data of following format
| | Time | Message |
|---|--------------------|---------|
| 1 | 1582056042.5040324 | 2.0 |
| 2 | 1582056043.5040324 | 2.1 |
| 3 | 1582056044.5040324 | 2.12 |
| 4 | 1582056045.5040324 | 1.98 |
| 5 | 1582056046.5040324 | 1.6 |
Here, data should be of type Pandas.DataFrame with two columns: Time and Message.
However, scope of strym is not limited to timeseries data obtained from comma.ai Panda. Any timeseries data of above format is capable of harnessing methods available in `strym`.
## Quick Start for CAN Data Analysis and Visualization
You can use __Strym__ for quick visualization by importing `strymread`:
```python
import strym
from strym import strymread
from strym import ranalyze
import matplotlib.pyplot as plt
import pandas as pd
from pylab import rcParams
import strym.DBC_Read_Tools as dbc
import numpy as np
plt.rcParams["figure.figsize"] = (16,8)
rcParams.update({'font.size': 40})
dbcfile = '/home/ivory/VersionControl/Jmscslgroup/strym/examples/newToyotacode.dbc'
r =strymread(csvfile="/home/ivory/CyverseData/JmscslgroupData/PandaData/2020_02_18/2020-02-18-13-00-42-209119__CAN_Messages.csv", dbcfile=dbcfile)
```
Checkout documentation at https://jmscslgroup.github.io/strym/getting_started.html for more in-depth tutorials.
## Software Requirements
- Ubuntu 20.04 or higher
- Python 3.12
- UV package manager
### Note about installation on RASPBERRY PI for CAN Data Logging
If you are going to install the package on RASPBERRY PI, I highly recommend installing Python 3.7 from the source as there is no Py3.7 release for Raspberry PI.
You will also need to install pre-compiled binaries for NumPy otherwise you may encounter huge inconvenience while building NumPy wheels for Raspberry PI.
## Hardware Requirements for CAN Logging
- comma.ai CAN-USB __Panda__ board.
- comma.ai Giraffee Connector
- A modern vehicle with CAN Bus available such as Toyota RAV4, Toyota CHR, etc.
## Installation Instructions
[](https://www.youtube.com/watch?v=w2p1uYmHBPA&t=5s)
## Usage for Real-Time Visualization of CAN messages using Strym
Plug your Comma AI Panda device using Giraffe Connector to your CAR's OBD port for data logging and streaming. Insert one end of the USB to Panda Device and another end to your laptop.
In python, you will be required to create an object of type `Strym`:
See `strym_impl.py` for one such usage example in the [example folder](https://github.com/jmscslgroup/strym/blob/master/examples), however, I am provided details of an example below:
Create a new file. I will use the gedit to create a new file. You will be required to pass a path of the CAN Database DBC file to `strym` while instantiating its object. Once you have a `strym` object, you can call its `isoviz()` function. `isoviz()` function takes two arguments: i) the message type that you want to visualize, e.g. SPEED ii) attribute number to plot specific signal of the desired message type. `isoviz()` function will simultaneously capture CAN message in a CSV file and also plot the desired message's signal. To terminate, press CTRL-C. Upon pressing CTRL-C, a SIGINT signal handler will be called that will terminate the logging of CAN messages and also save a matplotlib figure of the desired message's signal in pdf and pickle format.
```bash
gedit viz_example.py
```
```python
from strym import strym
import cantools
import sys, math, time
import signal
db = './newToyotacode.dbc'
Viz = strym(dbcfile = db)
message_type_to_visualize = 'SPEED'
message_attribute_number_to_visualize = 1
visualize = False
options = {"log": "info" }
Viz.isolog(visualize, message_type_to_visualize, message_attribute_number_to_visualize, **options)
signal.signal(signal.SIGINT, Viz.kill)
print('Datafile saved is {}'.format(Viz.logfile))
```
You will need a DBC file to parse can messages. Download an example DBC file [here](https://github.com/jmscslgroup/strym/blob/master/examples/newToyotacode.dbc)
To run the above program:
```bash
python viz_example.py`
```
If you are done, press CTRL-C.
## Issues
If you run into any issues, please use the issue feature of GitHub to log your issues. I will try my best to address any issue as soon as
possible.
For an issue related to installation/use on windows, please see following filed issues:
1. [Issue #8: OSError: [WinError 126]](https://github.com/jmscslgroup/strym/issues/8)
## Contributing to this project
If you like to contribute to this project, please fork this repository to your GitHub account, create a new branch for yourself and send a pull request for the merge. After reviewing the changes, we will decide if this is a good place to add your changes.
## Authors and Contributors
- Rahul Bhadani ( rahulbhadani@email.arizona.edu)
- Jonathan Sprinkle (sprinkjm@email.arizona.edu)
- Gustavo Lee (gustavolee@email.arizona.edu)
- Matthew Nice (matthew.nice@vanderbilt.edu)
- George Gunter (gunter.gl@gmail.com)
- Safwan Elmadani (safwanelmadani@email.arizona.edu)
## Licensing
License: MIT License
Copyright 2019-2020 Rahul Bhadani, Jonathan Sprinkle, Arizona Board of Regents
Initial Date: Nov 12, 2019
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files
(the "Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject
to the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
SHALL THE AUTHORS, COPYRIGHT HOLDERS OR ARIZONA BOARD OF REGENTS
BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
OR OTHER DEALINGS IN THE SOFTWARE.