From befa6b7efc58f6c7b36cb088120ed43f78dfb5ff Mon Sep 17 00:00:00 2001 From: Erick Ahmed Date: Sat, 13 Jun 2026 20:49:48 +0200 Subject: [PATCH] Add Getting Started --- Getting-Started.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 Getting-Started.md diff --git a/Getting-Started.md b/Getting-Started.md new file mode 100644 index 0000000..4367371 --- /dev/null +++ b/Getting-Started.md @@ -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 **CMSIS‑RTOS 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) +- Accept‑all filtering (logs every CAN frame) +- J1939‑ready (29‑bit extended identifiers) +- LED indicators: + - Blinks on each received CAN message (per bus) + - Heartbeat LED to show system alive +- RTOS task separation for reliable, non‑blocking 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. \ No newline at end of file