From a507ecef2f6aa198a798d85d98ac094b5a4f902a Mon Sep 17 00:00:00 2001 From: Mathias Rasmussen Date: Mon, 4 Jan 2021 00:10:27 +0100 Subject: [PATCH] docs: Update readme --- README.md | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 53fdef4..e94fb29 100644 --- a/README.md +++ b/README.md @@ -5,26 +5,24 @@ Digital ESC firmware for controlling brushless motors in multirotors. > Based on [BLHeli_S](https://github.com/bitdump/BLHeli) revision 16.7 -Bluejay aims to be an open source successor to BLHeli_S bringing DShot RPM telemetry to ESCs with Busy Bee MCUs. +Bluejay aims to be an open source successor to BLHeli_S adding several improvements to ESCs with Busy Bee MCUs. -## Project State -Bluejay is still in early development and further testing is needed before it should be used for serious flight. +It is still in early development and further testing is needed before it should be used for serious flight. +If you want to help testing it any feedback you can provide is greatly appreciated! -**Current Features:** +## Current Features - Digital signal protocol: DShot 300 and 600 - Bidirectional DShot: RPM telemetry - 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. +All releases can be found in the [releases](https://github.com/mathiasvr/bluejay/releases) section. Release files use a naming convention similar to BLHeli: `{T}_{M}_{D}_{P}_{V}.hex`. @@ -32,6 +30,6 @@ Release files use a naming convention similar to BLHeli: `{T}_{M}_{D}_{P}_{V}.he |---|--------------------|-------------------------------------------------------| | 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 | +| D | `0` - `90` | Dead time (`0` *only* for ESCs with built-in dead time) | +| P | `24`, `48` or `96` | PWM frequency [kHz] | +| V | eg. `0.5` | Bluejay version |