From 0143158ffd72ecd7d165420a4d9490e149caecb3 Mon Sep 17 00:00:00 2001 From: ThankTheMaker <33477197+thankthemaker@users.noreply.github.com> Date: Mon, 25 Sep 2023 22:04:37 +0200 Subject: [PATCH] Create versions.md --- versions.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 versions.md diff --git a/versions.md b/versions.md new file mode 100644 index 0000000..9254132 --- /dev/null +++ b/versions.md @@ -0,0 +1,21 @@ +# Firmware versions and types + + +## Versions +Versions follow [symantic versioning](https://semver.org/). The update mechanism always tries to update to the latest compatible version. + +## Types +rESCue firmware does support different hardware setups, therefore different types of the firmware exist. + +### regular +The regular type uses CANBUS and supports addressable LEDs (e.g. Neopixel or other WS28.. based) + +### cob +The COB type supports COB-LED-modules by driving one or two external MOSFET by PWM. + +### uart +The UART type uses UART instead of CANBUS to "talk" to the VESC. + +### cob_uart +The cob_uart type supports COB-LED-modules by driving one or two external MOSFET by PWM and uses UART for communication with the VESC. +