Update README
This commit is contained in:
1 parent
49697cc2b2
commit
4068ba6e01
1 file changed
+42
-34
@@ -1,44 +1,52 @@
|
||||
RP2040-Decoder
|
||||
===============
|
||||
# RP2040-Decoder
|
||||
|
||||
This Project is a DIY DCC Decoder for model railroad locomotives which aims to be cost effective.
|
||||
Designed to be a low-cost, open-source alternative to commercial DCC decoders, it utilizes the Raspberry Pi RP2040 dual-core microcontroller. The decoder features DCC protocol decoding and command interpretation alongside motor control in a compact 25x20 mm form factor.
|
||||
|
||||
Features
|
||||
--------
|
||||
## Key Features
|
||||
* **DCC Signal Decoding**: Interrupt-based edge detection with full packet/protocol decoding.
|
||||
* **Motor Control**: 128 speed steps with configurable acceleration/deceleration ramping and v_min/v_mid/v_max; closed-loop control for consistent motor speed under varying load conditions.
|
||||
* **Flexible I/O**: 4x transistor-switched outputs and 6x additional GPIOs; all of them PWM capable.
|
||||
* **CV Configuration**: Function mapping and programming track support.
|
||||
* **Standards Compliance**: Implements the most important NMRA (S-9.1, S-9.2.x) and RCN (210, 212, 216) DCC standards.
|
||||
* **Compact Form Factor**: 25x20 mm board size.
|
||||
* **Integrated Documentation**: Comprehensive [GitHub Pages documentation](https://gab-k.github.io/RP2040-Decoder/) covering hardware theory and software implementation.
|
||||
|
||||
- DCC digital signal decoding
|
||||
- Motor load/speed control
|
||||
- 4 Outputs switched by transistors with configurable optional PWM
|
||||
- 6 additional GPIO for lighter loads or custom applications
|
||||
- Programmable on programming track
|
||||
- CV Function Mapping
|
||||
- Board size of 25x20 mm
|
||||
- Pre-compiled software available and flashable via USB using your regular file explorer
|
||||
- Debugging via Serial Wire Debug or optional logging via stdio and UART/USB serial port
|
||||
## Architecture Overview
|
||||
The system uses each of the two ARM Cortex-M0+ cores for separate tasks:
|
||||
|
||||
Getting Started & Documentation
|
||||
------------
|
||||
* **Core 0: Signal Processing & Management**
|
||||
* Real-time DCC edge detection and packet decoding.
|
||||
* Configuration Variable (CV) management using persistent flash storage.
|
||||
* Service Mode (Programming Track) logic and acknowledgment pulse generation.
|
||||
* **Core 1: Motion Control**
|
||||
* **PID Controller**: A discrete-time PID implementation utilizing a bilinear transform for stability.
|
||||
* **Back-EMF Feedback**: Real-time load compensation via ADC sampling during PWM-off cycles.
|
||||
* **Adaptive Control**: Gain scheduling for $K_P$ and a startup controller (feed-forward) to overcome static friction.
|
||||
|
||||
The [documentation](https://gab-k.github.io/RP2040-Decoder/) provides an overview of the steps required to use the decoder. It also tries to give an insight into how the hardware and software works.
|
||||
## Hardware Revisions
|
||||
|
||||
|
||||
License
|
||||
-------
|
||||
- Software - MIT license
|
||||
- Hardware - CERN Open Hardware Licence Version 2 - Permissive
|
||||
- [LICENSE](https://github.com/gab-k/RP2040-Decoder/blob/main/LICENSE)
|
||||
|
||||
|
||||
------------
|
||||
USB hardware version
|
||||
<div style="display: flex; justify-content: space-between; align-items: center;">
|
||||
<img src="https://raw.githubusercontent.com/gab-k/RP2040-Decoder/refs/heads/gh-pages/img_USB/top.png" alt="Image 1" style="width: 45%;"/>
|
||||
<img src="https://raw.githubusercontent.com/gab-k/RP2040-Decoder/refs/heads/gh-pages/img_USB/bottom.png" alt="Image 2" style="width: 45%;"/>
|
||||
### USB Version
|
||||
Optimized for ease of use; supports UF2 drag-and-drop flashing and serial logging.
|
||||
<div style="display: flex; gap: 10px;">
|
||||
<img src="https://raw.githubusercontent.com/gab-k/RP2040-Decoder/refs/heads/gh-pages/img_USB/top.png" width="45%" />
|
||||
<img src="https://raw.githubusercontent.com/gab-k/RP2040-Decoder/refs/heads/gh-pages/img_USB/bottom.png" width="45%" />
|
||||
</div>
|
||||
|
||||
Legacy hardware version
|
||||
<div style="display: flex; justify-content: space-between; align-items: center;">
|
||||
<img src="https://raw.githubusercontent.com/gab-k/RP2040-Decoder/refs/heads/gh-pages/img_Legacy/top.png" alt="Image 1" style="width: 45%;"/>
|
||||
<img src="https://raw.githubusercontent.com/gab-k/RP2040-Decoder/refs/heads/gh-pages/img_Legacy/bottom.png" alt="Image 2" style="width: 45%;"/>
|
||||
### Legacy Version
|
||||
Revision without USB, one sided assembly, flashed via SWD.
|
||||
<div style="display: flex; gap: 10px;">
|
||||
<img src="https://raw.githubusercontent.com/gab-k/RP2040-Decoder/refs/heads/gh-pages/img_Legacy/top.png" width="45%" />
|
||||
<img src="https://raw.githubusercontent.com/gab-k/RP2040-Decoder/refs/heads/gh-pages/img_Legacy/bottom.png" width="45%" />
|
||||
</div>
|
||||
|
||||
## Getting Started
|
||||
|
||||
To get started, you will first need the hardware. The different options for acquiring a board are outlined [here](https://gab-k.github.io/RP2040-Decoder/sphinx/html/gs/getting_started.html#where-to-get-the-board).
|
||||
|
||||
For the software, you have a few options: you can either [build it from source](https://gab-k.github.io/RP2040-Decoder/sphinx/html/gs/getting_started.html#building-the-software) or use the ready-to-flash [binaries built by the CI pipeline](https://github.com/gab-k/RP2040-Decoder/releases) on each release. [Flashing the firmware](https://gab-k.github.io/RP2040-Decoder/sphinx/html/gs/getting_started.html#flashing-the-software) can be done via SWD or, if you are using the USB hardware version, simply by dragging and dropping the file using your regular file explorer.
|
||||
|
||||
|
||||
## License
|
||||
|
||||
* **Software**: MIT License
|
||||
* **Hardware**: CERN Open Hardware Licence Version 2 - Permissive
|
||||
Reference in new issue
Block a user