Add Getting Started

2026-06-13 20:49:48 +02:00
commit befa6b7efc
+33
@@ -0,0 +1,33 @@
# J1939 CAN Logger
## Overview
This project is a **J1939 CAN bus data logger** built around an STM32 microcontroller. It listens to two CAN buses (500 kbit/s and 250 kbit/s), logs all CAN messages to a microSD card, and indicates activity with LEDs. The firmware uses **CMSISRTOS v2** (FreeRTOS) to manage multiple tasks: CAN reception, logging, and heartbeat blinking.
## Main Features
- Two independent CAN interfaces (silent mode does not disturb the bus)
- Acceptall filtering (logs every CAN frame)
- J1939ready (29bit extended identifiers)
- LED indicators:
- Blinks on each received CAN message (per bus)
- Heartbeat LED to show system alive
- RTOS task separation for reliable, nonblocking operation
- Data logging via serial interface
## Planned Future Features
- Data logging to FAT32 microSD card (CSV format)
## Quick Start (summary)
1. Build the firmware with STM32CubeIDE or Makefile.
2. Connect the board to a J1939 network via CAN transceivers.
3. Insert a formatted microSD card.
4. Power on the logger starts recording immediately.
5. Remove the SD card and view logs on a PC.
or:
3. Power on the logger starts recording immediately.
4. Connect a listening device on serial interface and read logs.
See the other wiki pages for hardware setup, software architecture, and detailed usage.