From 4e29e29b5c0c9f48f28ac67a5fac049d44f51b8b Mon Sep 17 00:00:00 2001 From: Mathias Rasmussen Date: Sat, 7 Nov 2020 22:12:29 +0100 Subject: [PATCH] docs: Update readme --- README.md | 30 ++++++++++++++++-------------- 1 file changed, 16 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 6d79191..53fdef4 100644 --- a/README.md +++ b/README.md @@ -3,33 +3,35 @@ # Bluejay Digital ESC firmware for controlling brushless motors in multirotors. -A fork of [BLHeli_S](https://github.com/bitdump/BLHeli) based on revision 16.7. +> Based on [BLHeli_S](https://github.com/bitdump/BLHeli) revision 16.7 -## Summary Bluejay aims to be an open source successor to BLHeli_S bringing DShot RPM telemetry to ESCs with Busy Bee MCUs. -Compared to BLHeli_S this project only supports the DShot protocol and all analog protocols have been removed to ease code maintenance. - -A more detailed list of changes can be seen in the project [changelog](CHANGELOG.md). - ## Project State -Bluejay is still in early development and further testing is needed before it can be used for real flight. +Bluejay is still in early development and further testing is needed before it should be used for serious flight. **Current Features:** - Digital signal protocol: DShot 300 and 600 - Bidirectional DShot: RPM telemetry -- Selectable PWM frequency: 24 and 48 kHz +- Selectable PWM frequency: 24, 48 and 96 kHz +- PWM dithering: 10-bit effective throttle resolution + +Compared to BLHeli_S this project only supports the DShot protocol and all analog protocols have been removed to ease code maintenance. +Bluejay also includes several optimizations. +See the project [changelog](CHANGELOG.md) for a detailed list of changes. ## Flashing ESCs The Bluejay firmware can be flashed to BLHeli_S compatible ESCs using BLHeli Configurator. All releases can be found in the [releases](https://github.com/mathiasvr/Bluejay/releases) section. -Files currently use similar naming convention to BLHeli: `{T}_{M}_{DT}_{P}_{V}.hex`. +Release files use a naming convention similar to BLHeli: `{T}_{M}_{D}_{P}_{V}.hex`. -- T: Target layout (`A` - `W`) -- M: MCU type, `L` for BB1 (24MHz), `H` for BB2 (48MHz) -- DT: Deadtime (aka Feton_Delay) -- P: PWM frequency `24` or `48` -- V: Bluejay version eg. `0.3.0`. +| | | | +|---|--------------------|-------------------------------------------------------| +| T | `A` - `W` | Target ESC layout | +| M | `L` or `H` | MCU type: `L` (BB1 24MHz), `H` (BB2 48MHz) | +| D | `0` - `90` | Deadtime (`0` *only* for ESCs with built-in deadtime) | +| P | `24`, `48` or `96` | PWM frequency | +| V | eg. `0.4.0` | Bluejay version |