Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

spellcheck and typographical fixes #489

Merged
merged 12 commits into from
Nov 22, 2024
4 changes: 2 additions & 2 deletions docs/development/API/BusDrivers.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ It can be faster to perform short transfers using polled access rather than sett
1. DMA is enabled on the bus and device
2. All transmit/receive buffers are in memory supporting DMAs
3. One of the following:
1. There are are at least `SPI_DMA_THRESHOLD` bytes to transfer
1. There are at least `SPI_DMA_THRESHOLD` bytes to transfer
2. There is more than a single element in the segment list
3. The `negateCS` boolean is set to `false` in the terminating entry of the list.

Expand All @@ -167,7 +167,7 @@ The ELRS driver in `rx_sx1280.c` is an example of 3.3 where the terminating link
void spiSequence(const extDevice_t *dev, busSegment_t *segments);
```

This routine queues the given segment list for processing. If the device's bus is already busy then this segment list will be linked to the preceeding one in the queue so that the accesses will automatically proceed one after the other as quickly as possible.
This routine queues the given segment list for processing. If the device's bus is already busy then this segment list will be linked to the preceding one in the queue so that the accesses will automatically proceed one after the other as quickly as possible.

```
void spiWait(const extDevice_t *dev);
Expand Down
2 changes: 1 addition & 1 deletion docs/development/API/Cloud-Build-API.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Uses config repo for targets using defines only. For more information see [How t

## Usage

For optimal use please select ONLY the appropiate hardware for the flight controller after selecting the correct target (using auto-detect button).
For optimal use please select ONLY the appropriate hardware for the flight controller after selecting the correct target (using auto-detect button).
The options below are further described in the [wiki/Firmware Flasher page](/docs/wiki/configurator/firmware-flasher-tab). We also have a complete listing of [build options](/docs/development/Defines).

### Radio Protocols
Expand Down
2 changes: 1 addition & 1 deletion docs/development/API/DisplayPort.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ The `attribute` parameter is encoded thus.
| column | uint8 | Column on which to position the first character of the string |
| system_element | uint8 | System element to be rendered by the VTX/goggle/display device |

`system_element` will be one of the following as defined by `displayPortSystemElement_e `. Once one MSP_DP_SYS sub-command has been received by the VTX/goggle/display device then the default system elements should no longer be displayed in their default locations, but only explicitly as directed by this command. In this way, the default behaviour is as before, but as soon as any system element is explicitly positioned these OSD elements behave just like any other and can be called up is specific locations by any given OSD profile.
`system_element` will be one of the following as defined by `displayPortSystemElement_e `. Once one MSP_DP_SYS sub-command has been received by the VTX/goggle/display device then the default system elements should no longer be displayed in their default locations, but only explicitly as directed by this command. In this way, the default behavior is as before, but as soon as any system element is explicitly positioned these OSD elements behave just like any other and can be called up is specific locations by any given OSD profile.

```
// System elements rendered by VTX or Goggles
Expand Down
4 changes: 2 additions & 2 deletions docs/development/API/MSP-Extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ note: it would be ideal to disable this when armed
#### AdjustmentIndex

The FC maintains internal state for each adjustmentStateIndex, currently 4 simultaneous adjustment states are maintained. Multiple adjustment ranges
can be configured to use the same state but care should be taken not to send multiple adjustment ranges that when active would confict.
can be configured to use the same state but care should be taken not to send multiple adjustment ranges that when active would conflict.

e.g. Configuring two identical adjustment ranges using the same slot would conflict, but configuring two adjustment ranges that used
only one half of the possible channel range each but used the same adjustmentStateIndex would not conflict.
Expand All @@ -158,7 +158,7 @@ The FC does NOT check for conflicts.

#### AdjustmentFunction

There are many adjustments that can be made, the numbers of them and their use is found in the documentation of the cli `adjrange` command in the 'Inflight Adjustents' section.
There are many adjustments that can be made, the numbers of them and their use is found in the documentation of the cli `adjrange` command in the 'Inflight Adjustments' section.

### Implementation Notes

Expand Down
2 changes: 1 addition & 1 deletion docs/development/Blackbox-Internals.md
Original file line number Diff line number Diff line change
Expand Up @@ -557,7 +557,7 @@ For an I-interval of 32, these are the resulting logging patterns at some differ
#### Firmware type (optional)

Because Blackbox records the internal flight controller state, the interpretation of the logged data will depend
on knowing which flight controller recorded it. To accomodate this, the name of the flight controller should be recorded:
on knowing which flight controller recorded it. To accommodate this, the name of the flight controller should be recorded:

```
H Firmware type:Cleanflight
Expand Down
2 changes: 1 addition & 1 deletion docs/development/Cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ Please check the `help` command and use `get <variable name>` in the CLI Tab to
| [`failsafe_throttle_low_delay`](/docs/wiki/guides/current/Failsafe) | Activate failsafe when throttle is low and no RX data has been received since this value, in 10th of seconds | 0 | 300 | 100 | Master | UINT16 |
| [`failsafe_procedure`](/docs/wiki/guides/current/Failsafe) | 0 = Autolanding (default). 1 = Drop. | 0 | 1 | 0 | Master | UINT8 |
| `gimbal_mode` | When feature SERVO_TILT is enabled, this can be either NORMAL or MIXTILT | | | NORMAL | Profile | UINT8 |
| `acc_hardware` | This is used to suggest which accelerometer driver should load, or to force no accelerometer in case gyro-only flight is needed. Default (0) will attempt to auto-detect among enabled drivers. Otherwise, to force a particular device, set it to 2 for ADXL345, 3 for MPU6050 integrated accelerometer, 4 for MMA8452, 5 for BMA280, 6 for LSM303DLHC, 7 for MPU6000, 8 for MPU6500 or 1 to disable accelerometer alltogether - resulting in gyro-only operation. | 0 | 9 | 0 | Master | UINT8 |
| `acc_hardware` | This is used to suggest which accelerometer driver should load, or to force no accelerometer in case gyro-only flight is needed. Default (0) will attempt to auto-detect among enabled drivers. Otherwise, to force a particular device, set it to 2 for ADXL345, 3 for MPU6050 integrated accelerometer, 4 for MMA8452, 5 for BMA280, 6 for LSM303DLHC, 7 for MPU6000, 8 for MPU6500 or 1 to disable accelerometer altogether - resulting in gyro-only operation. | 0 | 9 | 0 | Master | UINT8 |
| `accz_lpf_cutoff` | Cutoff frequency used in the low-pass filtering of accelerometer measurements. | 1 | 20 | 5 | Profile | FLOAT |
| `acc_trim_pitch` | Accelerometer trim (Pitch) | -300 | 300 | 0 | Profile | INT16 |
| `acc_trim_roll` | Accelerometer trim (Roll) | -300 | 300 | 0 | Profile | INT16 |
Expand Down
4 changes: 2 additions & 2 deletions docs/development/Controls.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ The stick positions are combined to activate different functions:

### History

Intial stick commands, came from MultiWII but the original code no-longer has direct links.
Initial stick commands, came from MultiWII but the original code no-longer has direct links.

The original documents as listed below can be found here https://code.google.com/archive/p/multiwii/source/default/source

Expand Down Expand Up @@ -122,7 +122,7 @@ https://www.youtube.com/watch?v=YNRl0OTKRGA

## Deadband

If yaw, roll or pitch sticks do not reliably return to centre or the radio has a lot of jitter around the centrepoint, deadband can be applied. The whole deadband value is applied _either side_ of the center point rather than half the value above and half the value below. The deadband value will have an effect on stick endpoint values as the axis value will be reduced by the amount of deadband applied.
If yaw, roll or pitch sticks do not reliably return to center or the radio has a lot of jitter around the center point, deadband can be applied. The whole deadband value is applied _either side_ of the center point rather than half the value above and half the value below. The deadband value will have an effect on stick endpoint values as the axis value will be reduced by the amount of deadband applied.

`deadband` -
Applied to roll, pitch.
Expand Down
2 changes: 1 addition & 1 deletion docs/development/Defines.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Betaflight uses `#define` macro syntax to include software components that support additional features or specific hardware modules at build time.

A basic set of defines is included in the config file for each board. At build time, the user can add extra defines in the the Configurator's Firmware Flasher Tab.
A basic set of defines is included in the config file for each board. At build time, the user can add extra defines in the Configurator's Firmware Flasher Tab.

When selecting GPS, Baro, etc from the `Other Options` list, any additional required or related defines are added automatically. For example, if `BARO` is requested by the user, the `USE_BARO` define, and all supported baro hardware defines, are automatically included.

Expand Down
2 changes: 1 addition & 1 deletion docs/development/Display.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ feature DISPLAY
The SSD1306 display is a 128x64 OLED display that is visible in full sunlight, small and consumes very little current.
This makes it ideal for aircraft use.

There are various models of SSD1306 boards out there, they are not all equal and some require addtional modifications
There are various models of SSD1306 boards out there, they are not all equal and some require additional modifications
before they work. Choose wisely!

Links to displays:
Expand Down
2 changes: 1 addition & 1 deletion docs/development/Dshot.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ There is normally a pause between frames of at least 2 microseconds to indicate

It should of course be noted that DShot is not the absolute most efficient protocol for representing bit values in a serial stream, but the reason for the approach taken rather than other options is to ensure accuracy in the very noisy environment found on a multi-rotor. That said it is certainly no slouch. It takes it to the current crop, with DSHOT600 being a mere 1 microsecond slower than Multishot at full throttle. Even DSHOT150 is on a par with Oneshot42. The following graph represents the full throttle timing of the current protocols:

DShot has no real concept of minimum and maximum durations for timing, it is a digital protocol afterall. A disarmed throttle value of 0 takes the same amount of time to communicate as a full throttle value.
DShot has no real concept of minimum and maximum durations for timing, it is a digital protocol after all. A disarmed throttle value of 0 takes the same amount of time to communicate as a full throttle value.

### Will my ESCs or flight controller be supported?

Expand Down
12 changes: 6 additions & 6 deletions docs/development/Inflight-Adjustments.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Changing settings during flight can make your aircraft unstable and crash if you

- Always make adjustments while flying in a large open area.
- Make small adjustments and fly carefully to test your adjustment.
- Give yourself enough flying space and time to adjust to how your changes affect the behaviour of the aircraft.
- Give yourself enough flying space and time to adjust to how your changes affect the behavior of the aircraft.
- Remember to set adjustment channel switches/pots to the center position before powering on your TX and your aircraft.
- If possible configure switch warnings on your transmitter for dedicated adjustment switches.
- A momentary 3 position switch is the best choice of switch for this - i.e. one that re-centers itself when you let go of it.
Expand All @@ -23,10 +23,10 @@ The other mode is Absolute mode where a pot (knob/slider) may be directly mapped

Both modes utilise two channels to make an adjustment.

| Channel | Use |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Range | This channel is used to enable an adjustment. When the channel is set to fall withing the specified range, then the corresponding adjustment is enabled. This is similar to mode setting where a given mode is enabled when a channel is within a lower and upper range. |
| Adjustment | This channel is used to control the change to the specified setting |
| Channel | Use |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Range | This channel is used to enable an adjustment. When the channel is set to fall within the specified range, then the corresponding adjustment is enabled. This is similar to mode setting where a given mode is enabled when a channel is within a lower and upper range. |
| Adjustment | This channel is used to control the change to the specified setting |

Settings are not saved automatically, connect a GUI, refresh and save or save using stick position when disarmed.
Powering off without saving will discard the adjustments.
Expand Down Expand Up @@ -278,6 +278,6 @@ The following examples shows **incorrect** configurations - the entire usable ra
![Configurator example 6](Screenshots/adjustments-incorrect-config-1.png)
![Configurator example 7](Screenshots/adjustments-incorrect-config-2.png)

In the following example, the incorrect configuraton (above) has been corrected by adding a range that makes 'No changes'.
In the following example, the incorrect configuration (above) has been corrected by adding a range that makes 'No changes'.

![Configurator example 7](Screenshots/adjustments-incorrect-config-2-corrected.png)
2 changes: 1 addition & 1 deletion docs/development/Mixer.md
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ smix reverse 5 2 r

Here is an example of a custom twin engine plane with [Differential Thrust](http://rcvehicles.about.com/od/rcairplanes/ss/RCAirplaneBasic.htm#step8)
Motors take the first 2 pins, the servos take pins as indicated in the [Servo slot] chart above.
Settings bellow have motor yaw influence at "0.3", you can change this number to have more or less differential thrust over the two motors.
Settings below have motor yaw influence at "0.3", you can change this number to have more or less differential thrust over the two motors.
Note: You can look at the Motors tab in [Cleanflight Cofigurator](https://chrome.google.com/webstore/detail/cleanflight-configurator/enacoimjcgeinfnnnpajinjgmkahmfgb?hl=en) to see motor and servo outputs.

| Pins | Outputs |
Expand Down
4 changes: 2 additions & 2 deletions docs/development/Rx.md
Original file line number Diff line number Diff line change
Expand Up @@ -218,8 +218,8 @@ Signal loss can be detected when:

### RX loss configuration

The `rxfail` cli command is used to configure per-channel rx-loss behaviour.
You can use the `rxfail` command to change this behaviour.
The `rxfail` cli command is used to configure per-channel rx-loss behavior.
You can use the `rxfail` command to change this behavior.
A flight channel can either be AUTOMATIC or HOLD, an AUX channel can either be SET or HOLD.

- AUTOMATIC - Flight channels are set to safe values (low throttle, mid position for yaw/pitch/roll).
Expand Down
Loading
Loading