Skip to content

Commit

Permalink
Docs: Checked wiki for spelling errors (#474)
Browse files Browse the repository at this point in the history
* checked guides, configurator, tuning sections of wiki for spelling errors

* Update docs/wiki/guides/archive/Single-Wire-Software-Serial.md

Co-authored-by: Mark Haslinghuis <[email protected]>

* Update docs/wiki/guides/current/Magnetometer.md

Co-authored-by: Mark Haslinghuis <[email protected]>

---------

Co-authored-by: Mark Haslinghuis <[email protected]>
  • Loading branch information
NootSoGreen and haslinghuis authored Oct 21, 2024
1 parent eac8296 commit ddfe58f
Show file tree
Hide file tree
Showing 53 changed files with 150 additions and 150 deletions.
14 changes: 7 additions & 7 deletions docs/wiki/configurator/firmware-flasher-tab.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ SPI configuration details are resolved via software (part of the configuration d
### Telemetry Protocol

Select the telemetry protocol you need.
For CRSF, ELRS, FPORT or GHST protocols, this is included by default to simplify configuraton.
For CRSF, ELRS, FPORT or GHST protocols, this is included by default to simplify configuration.

### Other Options

Expand All @@ -150,7 +150,7 @@ These are custom functions or features that you can add to the firmware.
| Altitude Hold Mode | Enable Altitude Hold Mode support. See [#13816](https://github.com/betaflight/betaflight/pull/13816) |
| Batt. Continue | See [#11084](https://github.com/betaflight/betaflight/pull/11084) |
| Cam. Control | Enable Camera Control |
| Dashboard | Enable external i2c Oled Display device (to be deprecated) |
| Dashboard | Enable external i2c OLED Display device (to be deprecated) |
| EMFAT (AutoRun, Icon) | Enable FAT emulation and icon for onboard flash or MSC |
| ESC Serial (SK) Inc. 4way | Enable SimonK and ESC Serial support for flashing via 4way interface |
| Flash Storage | 4.4 and earlier only. Enables Blackbox Flash Storage support. In 4.5, is auto-included via the FC config file. To manually add Flash to a 4.5 build, enter `FLASH` in `Custom Defines` |
Expand Down Expand Up @@ -186,18 +186,18 @@ This field is only available in expert mode, and is intended for development and

It defaults to the latest commit (master), meaning the most recent commit of the selected firmware branch. The dropdown includes some recent commits if you want to go back a bit.

Each GitHub pull request has a uniqe ID. The user can include a specific, yet to be merged, `Pull Request`, over the top of master, by typing the number of the pull request, preceded by the `#` character. For example, to include Pull Request #13605, just enter `#13605` in the Custom Defines field.
Each GitHub pull request has a unique ID. The user can include a specific, yet to be merged, `Pull Request`, over the top of master, by typing the number of the pull request, preceded by the `#` character. For example, to include Pull Request #13605, just enter `#13605` in the Custom Defines field.

It is also possible to make a build from any previous point in time by entering the sha of the commit.

## Troubeshooting
## Troubleshooting

:::tip

- Use a good quality data cable, not a power cable.
- USB hubs or OTG cables are sometimes needed with recent computers and in other cases they can cause issues.
- Try disconnecting all cables from your PC first, try rebooting, other ports, upgrade system drivers. Remove other USB connections.
- Try DFU mode (use boot button on FC while plugging in, use <b>Activate Boot Loader / DFU</b> button in setup tab or use <b>bl</b> command in CLI.
- Try DFU mode (use boot button on FC while plugging in, use <b>Activate Boot Loader / DFU</b> button in setup tab or use <b>bl</b> command in CLI.)
- Sometimes peripherals on the flight controller such as receivers or GPS devices can hijack port communication, preventing entering DFU mode. These may require de-soldering.
- Linux needs configuration to allow flashing.
- MacOS or Windows do not need any drivers.
Expand All @@ -207,7 +207,7 @@ It is also possible to make a build from any previous point in time by entering

:::info

If your board pheriperals are not recognized after flashing, please help us add the required configuration details. Some boards have inadequate file definitions, or the manufacturer has changed something on the board.
If your board peripherals are not recognized after flashing, please help us add the required configuration details. Some boards have inadequate file definitions, or the manufacturer has changed something on the board.

<br/>
Reach out to us on our [Discord server](https://discord.betaflight.com/invite) or create an issue in the Betaflight unified targets repo.
Expand All @@ -225,7 +225,7 @@ The `Show Log` link will open the build log and show the defines being applied t

The log file incudes a full string for use when flashing the same build locally is provided, both for Docker and Make.

At any time after flashing, the log can be re-loaded using the `log` buttom at the lower right side of Configurator's S`Setup` page. A summary of the included build options can be displayed using the nearby `Options` button.
At any time after flashing, the log can be re-loaded using the `log` button at the lower right side of Configurator's S`Setup` page. A summary of the included build options can be displayed using the nearby `Options` button.

### Local Flashing

Expand Down
4 changes: 2 additions & 2 deletions docs/wiki/configurator/ports-tab.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ when conflicting options are set
## Serial RX

Used to set the UART to receive serial data from a receiver. This is the most common use of a UART port.
If you toggle this on, you likely do not need to touch any ohter options for this port
If you toggle this on, you likely do not need to touch any other options for this port

## Telemetry Output

Expand All @@ -47,7 +47,7 @@ Receiver
## Sensor Input

When you want the port to receive data from a sensor. This is used for things like BLHeli_32 ESC telemetry,
or GPS. To get GPS working, you may need to manualy assign a baud rate as well
or GPS. To get GPS working, you may need to manually assign a baud rate as well

## Peripherals

Expand Down
4 changes: 2 additions & 2 deletions docs/wiki/configurator/power-tab.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,12 +61,12 @@ voltage is not displayed correctly, you can adjust this value up/down to fix it
### Divider / Multiplier Value

This defines how the value read by the ICs ADC converts into a voltage value that makes sense to the pilot.
In easy terms this sets how the ratio difference between the two voltage divider resistors are used in the voltage calculation formular.
In easy terms this sets how the ratio difference between the two voltage divider resistors are used in the voltage calculation formula.

Example:
Scale: 110 = 10:1 voltage divider (10k:1k ohm resistors)
Divider: 10 = sets the direct resistor to resistor ratio
Multiplier: 1 = this is to finetune the outcome of the calculation, a value of 1 is "no correction"
Multiplier: 1 = this is to fine-tune the outcome of the calculation, a value of 1 is "no correction"

## Amperage Meter

Expand Down
2 changes: 1 addition & 1 deletion docs/wiki/configurator/presets-tab.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Narrow down your search by using the search filters. You can filter by:
- **Status** - Select from various statuses to filter presets by
- **OFFICIAL** - Presets that are made and/or officially supported by the Betaflight team. Usually more
advanced and/or specific to a particular setting
- **COMMUNTIY** - Presets that are made by other users in the community. Often for specific products
- **COMMUNITY** - Presets that are made by other users in the community. Often for specific products
(like VTX tables) and pilot rates
- **EXPERIMENTAL** - Presets that are in development and in the process of being tested

Expand Down
4 changes: 2 additions & 2 deletions docs/wiki/configurator/setup-tab.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,8 @@ Shows some basic data from the flight controller. This includes:
Shows the GPS data if the flight controller has a GPS module connected and set up. This includes:

- **3D Fix** - Shows if the GPS has a 3D fix or not, a fix is needed for proper GPS functionality
- **Sats** - Shows the current ammoount of satellites the GPS has a lock on. The more the better, usually 6 or more is needed for a good fix
- **Lattitude/Longittude** - Shows the current lat/long coordinates of the drone
- **Sats** - Shows the current amount of satellites the GPS has a lock on. The more the better, usually 6 or more is needed for a good fix
- **Latitude/Longitude** - Shows the current lat/long coordinates of the drone

### Instruments

Expand Down
14 changes: 7 additions & 7 deletions docs/wiki/getting-started/hardware/esc-firmware.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ An ESC is the Electronic Speed Controller which supplies power to the craft's mo

## Bidirectional DShot Firmware

The Bidirectional DShot protocol can be enabled in the [Configurator Motors Tab](/docs/wiki/configurator/motors-tab#escmotor-features). Modern Bidirectional DShot is different (and more robust) in BetaFlight 4.5 than BetaFlight 4.0. The ESC firmware must be correct to ensure support for DShot Telemetry and provide the best Betaflight performance. We strongly recommend the use of DShot in conjunection with RPM filtering for the benefits in handling and smooth flight.
The Bidirectional DShot protocol can be enabled in the [Configurator Motors Tab](/docs/wiki/configurator/motors-tab#escmotor-features). Modern Bidirectional DShot is different (and more robust) in BetaFlight 4.5 than BetaFlight 4.0. The ESC firmware must be correct to ensure support for DShot Telemetry and provide the best Betaflight performance. We strongly recommend the use of DShot in conjunction with RPM filtering for the benefits in handling and smooth flight.

### Bidirectional DShot Versions

Expand Down Expand Up @@ -43,7 +43,7 @@ Developers note - prior to 2.00 the AM32 project used a repo for each family of
| Version | Recommended | Comment |
| ------- | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 2.00 | `N` | Cleanup of target structure, unify projects |
| 2.01 | `N` | Increase 10khztimer to 20khz, increase max duty cycle change. |
| 2.01 | `N` | Increase 10khz timer to 20khz, increase max duty cycle change. |
| 2.02 | `N` | Increase startup power for inverted output targets. |
| 2.03 | `N` | Move chime from DShot direction change commands to save command. |
| 2.04 | `Y` | Fix current protection, max duty cycle not increasing. Fix double startup chime. Change current averaging method for more precision. Fix startup ramp speed adjustment. |
Expand Down Expand Up @@ -76,11 +76,11 @@ BLHeli_32 is only available pre-installed on ESCs, the cost of BLHeli_32 license

### BlueJay

BlueJay fully supports RPM filtering and EDT telemetry and is the recommended ESC firmware for 8bit ESCs. Orginally developed by Mathias, a Betaflight developer, more recently BlueJay has been transferred to the BirdSanctuary team and is maintained by Damosvil and Stylesuxx in close partnership with the esc-configurator project.
BlueJay fully supports RPM filtering and EDT telemetry and is the recommended ESC firmware for 8bit ESCs. Originally developed by Mathias, a Betaflight developer, more recently BlueJay has been transferred to the BirdSanctuary team and is maintained by Damosvil and Stylesuxx in close partnership with the esc-configurator project.

BlueJay is easily flashed with an elegant online flashing tool [ESC Configurator](https://esc-configurator.com/). An older offline configurator (https://github.com/mathiasvr/bluejay-configurator/releases) is available but not recommended for current releases. The firmware supports both L and H type ESCs as well as newer Z type, with a range of options, and has been tested on various ESC models.

[Extended DShot Telementry (EDT)](https://github.com/bird-sanctuary/extended-DShot-telemetry) was created by the BlueJay team and allows ESCs without a separate telemetry UART to send additional telemetry alongside RPM data. EDT enables BlueJay ESCs to report voltage, current and temperature as well as signalling error events.
[Extended DShot Telemetry (EDT)](https://github.com/bird-sanctuary/extended-DShot-telemetry) was created by the BlueJay team and allows ESCs without a separate telemetry UART to send additional telemetry alongside RPM data. EDT enables BlueJay ESCs to report voltage, current and temperature as well as signalling error events.

| Version | Recommended | Comment |
| ---------- | ----------- | ------------------------------------------------------------------------------------------------------ |
Expand Down Expand Up @@ -109,15 +109,15 @@ JazzMaverick was poorly documented and has not been maintained for years.
:::

The current build of JazzMaverick's BLHeli fork is 16.9, often referred to as [BlHeli-M](https://www.rcgroups.com/forums/showthread.php?3621257-BLHeli_M-Maverick-version). The easiest way to flash 16.9 is with Asizon's Configurator.
For earlier versions, go to [JazzMaverick](https://github.com/JazzMaverick/BLHeli/tree/JazzMaverick-patch-1/BLHeli_S%20SiLabs)'s code on github. Flash as usual with the conventional [BlHeli-S Configurator](https://github.com/blheli-configurator/blheli-configurator/releases) or use the convenient browser-based [ESC Configurator](https://esc-configurator.com/). Take a look wich version you have to flash correctly. Use either version 16.73 or 16.9.
For earlier versions, go to [JazzMaverick](https://github.com/JazzMaverick/BLHeli/tree/JazzMaverick-patch-1/BLHeli_S%20SiLabs)'s code on github. Flash as usual with the conventional [BlHeli-S Configurator](https://github.com/blheli-configurator/blheli-configurator/releases) or use the convenient browser-based [ESC Configurator](https://esc-configurator.com/). Take a look which version you have to flash correctly. Use either version 16.73 or 16.9.

Betaflight strongly recommends that users avoid JazzMaverick due to the lack of maintenance and the author's experimental approach. This ESC firmware included versions with non-linear throttle response and other features that surprised or confused users.

### BLHeli-S

[BLHeli-S](https://www.rcgroups.com/forums/showthread.php?2640796-BLHeli_S-Smooth-as-Silk) introduced support for the BusyBee line of 8bit MCUs for ESC use. These MCUs featured hardware PWM generation unlike the earlier [BLHeli](https://www.rcgroups.com/forums/showthread.php?2136895-BLHeli-for-Atmel-and-Silabs-united-by-BLHeliSuite) hardware, synchronising the motor PWM tyo the MCU clock and supporting higher eRPM speed output. Damped light mode was also standard, allowing all ESCs to decelerate as well as accelerate the motor.

Whilst these features may sound great these are now standard features and available in all other ESC firmware on this page. Note that DShot support was only added in revision 16.5 and turtle mode and DShot beeper only arrived in the last official 16.7 release. If you recieve an ESC with BLHeli-S we recommend connecting to [ESC Configurator](https://esc-configurator.com/) and flashing BlueJay, you can check a box to copy over the reversed/forward settings from BLHeli-S to BlueJay.
Whilst these features may sound great these are now standard features and available in all other ESC firmware on this page. Note that DShot support was only added in revision 16.5 and turtle mode and DShot beeper only arrived in the last official 16.7 release. If you receive an ESC with BLHeli-S we recommend connecting to [ESC Configurator](https://esc-configurator.com/) and flashing BlueJay, you can check a box to copy over the reversed/forward settings from BLHeli-S to BlueJay.

:::info
These versions are for informational purposes only. Always upgrade BLHeli-S equipment to use BlueJay.
Expand All @@ -131,5 +131,5 @@ These versions are for informational purposes only. Always upgrade BLHeli-S equi
| 16.3 | `N` | Implemented programmable temperature protection. Improved protection of bootloader and generally reduced risk of flash corruption. Some small changes for improved sync hold. |
| 16.4 | `N` | Fixed bug where bootloader operation could be blocked by a defective "eeprom" signature. |
| 16.5 | `N` | Added support for DShot150, DShot300 and DShot600. |
| 16.6 | `N` | Oixed signal detection issue of multishot at 32kHz. Improved bidirectional mode for high input signal rates. |
| 16.6 | `N` | Fixed signal detection issue of multishot at 32kHz. Improved bidirectional mode for high input signal rates. |
| 16.7 | `N` | Addition of DShot commands for beeps and temporary reverse direction (largely by bycedjohnson) |
Loading

0 comments on commit ddfe58f

Please sign in to comment.