Skip to content

Commit fc85035

Browse files
committed
Updated README to reflect new recommended integration methods
1 parent 045777e commit fc85035

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,15 @@
1-
# CAN bus API examples (Python/MATLAB) | CANedge
1+
# CAN bus API examples (Python/MATLAB) | CANedge [LEGACY]
2+
3+
## Update: Legacy notice + new Python/MATLAB integration methods
4+
If you need to work with the CANedge data in Python/MATLAB, we now recommend to use the methods described in the below documentations:
5+
- CANedge + Python: [About](https://www.csselectronics.com/pages/python-can-bus-api) | [Intro](https://canlogger.csselectronics.com/canedge-getting-started/ce3/log-file-tools/api-tools)
6+
- CANedge + MATLAB: [About]https://www.csselectronics.com/pages/matlab-mdf-mf4-can-bus) | [Intro](https://canlogger.csselectronics.com/canedge-getting-started/ce3/log-file-tools/matlab)
7+
8+
The Python methods/modules shown in repository under `examples/data-processing/` can still be used, but will not be updated going forward (this refers to the sub modules of our Python API, `mdf-iter`, `canedge-browser` and `can-decoder`). We instead refer to our new integration with python-can or our Python examples of how to work with DBC decoded Parquet data lakes. The script examples found in `examples/other/` will still be relevant going forward.
9+
10+
--------------------
11+
12+
## Overview
213

314
This project includes Python and MATLAB examples of how to process MF4 log files with CAN/LIN data from your [CANedge](https://www.csselectronics.com/) data loggers. Most examples focus on the use of our Python API modules (`canedge_browser`, `mdf_iter`, `can_decoder`) for use with the CANedge log file formats (`MF4`, `MFC`, `MFE`, `MFM`). However, you'll also find other script examples incl. for the asammdf Python API, MATLAB, S3 and more.
415

0 commit comments

Comments
 (0)