Skip to content

Commit

Permalink
Update configuration wiki
Browse files Browse the repository at this point in the history
  • Loading branch information
@haslinghuis
haslinghuis committed Sep 30, 2024
1 parent 9150f3d commit e7ea269
Show file tree
Hide file tree
Showing 2 changed files with 80 additions and 63 deletions.
106 changes: 47 additions & 59 deletions docs/wiki/configurator/configuration-tab.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,11 @@ and a high gyro frequency (8KHz gyro would be 4KHz PID loop on an F411)

### Sensor Toggles

- **Accelerometer** - Enable or disable the accelerometer, which is used for self-stabilization features
- **Barometer** - Enable or disable the barometer. If present, it's used for altitude measurement
- **Magnetometer** - Enable or disable the magnetometer. If present, it's used to tell the real world orientation
| Sensor | Description |
| :------------ | :------------------------------------------------------------------------------------------- |
| Accelerometer | Enable or disable the accelerometer, which is used for self-stabilization features |
| Barometer | Enable or disable the barometer. If present, it's used for altitude measurement |
| Magnetometer | Enable or disable the magnetometer. If present, it's used to tell the real world orientation |

## Accelerometer Trim

Expand Down Expand Up @@ -82,20 +84,30 @@ Running a high frequency signal on the motor output to make the motors resonate
for an actual buzzer, but it cannot be activated in flight (as the motors are spinning), isn't as loud, and can't be
used for a long time as the motors may draw excessive current and overheat

- **Beacon Tone** - You can pick from 5 different tones
- **RX_LOST** - Enable or disable the tone when the RX signal is lost
- **RX_SET** - Enable or disable the tone when the `BEEPER` mode is on
| Setting | Description |
| :---------- | :------------------------------------------------------ |
| Beacon Tone | You can pick from 5 different tones |
| RX_LOST | Enable or disable the tone when the RX signal is lost |
| RX_SET | Enable or disable the tone when the `BEEPER` mode is on |

## Other features

A list of various different features that can be enabled or disabled, and may or may not be present on your flight
controller

- **INFLIGHT_ACC_CAL** - Allows you to calibrate the accelerometer in flight
- **SERVO_TILT** - Enables the `CAMSTAB` mode, which will stabilize the camera angle by up to two servos set in a gimbal
configuration
- **SOFTSERIAL** - Emulates a serial port on a different output, or splits an RX-TX UART pair. This allows you to use
it as an extra UART
| Setting | Description |
| :----------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| AIRMODE | Permanently enable airmode, which will give the craft more control authority in the air when at 0 throttle |
| CHANNEL_FORWARDING | Allows you to forward an aux channel to a motor/servo output |
| DISPLAY | Enables the display feature, which allows you to use a small OLED display to show various information. If enabled and no display is connected, the FC will take about 10s longer to boot. It's not recommended to use nowadays |
| GPS | Enable GPS support, do not enable when there is no GNSS unit attached |
| INFLIGHT_ACC_CAL | Allows you to calibrate the accelerometer in flight |
| LED_STRIP | Enables the LED strip feature, which allows you to control WS2812B RGB LEDs |
| OSD | Enables the OSD, you can configure it in the OSD tab that will appear when you enable this |
| SERVO_TILT | Enables the `CAMSTAB` mode, which will stabilize the camera angle by up to two servos set in a gimbal configuration |
| SOFTSERIAL | Emulates a serial port on a different output, or splits an RX-TX UART pair. Allows you to use it as an extra UART |
| SONAR | Enables sonar support, but this feature is not recommended for use nowadays |
| TRANSPONDER | Enables the race transponder feature if your hardware supports it |

:::info

Expand All @@ -110,55 +122,31 @@ there are some limitations.

:::

- **SONAR** - Enables sonar support, but this feature is not recommended for use nowadays
- **LED_STRIP** - Enables the LED strip feature, which allows you to control WS2812B RGB LEDs
- **DISPLAY** - Enables the display feature, which allows you to use a small OLED display to show various information.
If enabled and no display is connected, the FC will take about 10s longer to boot. It's not recommended to use nowadays
- **OSD** - Enables the OSD, you can configure it in the OSD tab that will appear when you enable this
- **BLACKBOX** - Enables the blackbox feature, which allows you to record flight data to a flash chip on the FC, or
an SD card (if present). You can configure it in the Blackbox tab that will appear when you enable this
- **CHANNEL_FORWARDING** - Allows you to forward an aux channel to a motor/servo output
- **TRANSPONDER** - Enables the race transponder feature if your hardware supports it
- **AIRMODE** - Permanently enable airmode, which will give the craft more control authority in the air when at 0 throttle

## GPS

Enable and set up the GPS settings:

- Protocol:

- **NMEA** - A binary protocol for GPS data
- **UBLOX** - A text protocol for GPS data, more customisable
- **MSP** - GPS using the MultiWii Serial Protocol

- **Auto Baud** - Automatically detect the baud rate of the GPS
- **Auto Config** - Automatically configure the GPS
- **Set Home Point Once** - If enabled, the home point will be set only once, when the GPS is first acquired. If disabled,
the home point will be updated every time the craft is armed

## Beeper Configuration

Toggle different triggers when the beeper should be active

- **GYRO_CALIBRATED** - Will beep when the gyroscope has been calibrated
- **RX_LOST** - Will beep when the RX signal is lost (repeats until the signal is regained)
- **RX_LOST_LANDING** - Will beep when the RX signal is lost, and the craft is in a landing phase
- **DISARMING** - Will beep when the craft is disarmed
- **ARMING** - Will beep when the craft is armed
- **ARMING_GPS_FIX** - Will beep when the craft is armed, and the GPS has a fix
- **BAT_CRIT_LOW** - Will beep when the battery is critically low according to the value set in the Battery tab (repeats)
- **BAT_LOW** - Will beep when the battery is low according to the value set in the Battery tab (repeats)
- **GPS_STATUS** - Will beep x amount of times depending on the amount of satellites found
- **RX_SET** - Will beep when the `BEEPER` mode is on
- **ACC_CALIBRATION** - Will beep when the inflight accelerometer calibration is successful
- **ACC_CALIBRATION_FAIL** - Will beep when the inflight accelerometer calibration fails
- **READY_BEEP** - Will beep when the craft has a GPS fix and is ready to be armed
- **DISARM_REPEAT** - Will beep when the sticks are in a disarm position
- **ARMED** - Will beep when the craft is armed and motors are not spinning (repeats until throttle is raised, or the craft is disarmed)
- **SYSTEM_INIT** - Will beep when the FC has been powered on
- **USB** - Will beep when the FC is powered by USB, disable this to prevent beeping when configuring on the bench
- **BLACKBOX_ERASE** - Will beep when the blackbox has been erased
- **CRASH_FLIP** - Will beep when the crash flip mode is active
- **CAM_CONNECTION_OPEN** - Will beep when the 5 key OSD menu is opened
- **CAM_CONNECTION_CLOSE** - Will beep when the 5 key OSD menu is closed
- **RC_SMOOTHING_INIT_FAIL** - Will beep when the craft is armed and RC smoothing has not been initialized
| Setting | Description |
| :--------------------- | :--------------------------------------------------------------------------------------------------------------------- |
| GYRO_CALIBRATED | Beeps when the gyroscope has been calibrated |
| RX_LOST | Beeps when the RX signal is lost (repeats until the signal is regained) |
| RX_LOST_LANDING | Beeps when the RX signal is lost, and the craft is in a landing phase |
| DISARMING | Beeps when the craft is disarmed |
| ARMING | Beeps when the craft is armed |
| ARMING_GPS_FIX | Beeps when the craft is armed, and the GPS has a fix |
| BAT_CRIT_LOW | Beeps when the battery is critically low according to the value set in the Battery tab (repeats) |
| BAT_LOW | Beeps when the battery is low according to the value set in the Battery tab (repeats) |
| GPS_STATUS | Beeps x amount of times depending on the amount of satellites found |
| RX_SET | Beeps when the `BEEPER` mode is on |
| ACC_CALIBRATION | Beeps when the inflight accelerometer calibration is successful |
| ACC_CALIBRATION_FAIL | Beeps when the inflight accelerometer calibration fails |
| READY_BEEP | Beeps when the craft has a GPS fix and is ready to be armed |
| DISARM_REPEAT | Beeps when the sticks are in a disarm position |
| ARMED | Beeps when the craft is armed and motors are not spinning (repeats until throttle is raised, or the craft is disarmed) |
| SYSTEM_INIT | Beeps when the FC has been powered on |
| USB | Beeps when the FC is powered by USB, disable this to prevent beeping when configuring on the bench |
| BLACKBOX_ERASE | Beeps when the blackbox has been erased |
| CRASH_FLIP | Beeps when the crash flip mode is active |
| CAM_CONNECTION_OPEN | Beeps when the 5 key OSD menu is opened |
| CAM_CONNECTION_CLOSE | Beeps when the 5 key OSD menu is closed |
| RC_SMOOTHING_INIT_FAIL | Beeps when the craft is armed and RC smoothing has not been initialized |
37 changes: 33 additions & 4 deletions docs/wiki/configurator/gps-tab.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,39 @@
sidebar_position: 12
---

# GPS Tab
# GPS

:::note
Sorry; this Wiki page has not yet been written.
:::
The correct term to use is GNSS.

GPS is just one of the available Global navigation satellite systems.

## Systems

| Constellation | Operator | Coverage | Altitude (km) | Satellites in Orbit |
| ------------- | -------------- | -------- | ------------------------------------ | ------------------- |
| GPS | US Space Force | Global | 20,180 | 31 |
| GLONASS | Roscosmos | Global | 19,130 | 24 |
| GALILEO | GSA & ESA | Global | 23,222 | 26 |
| BEIDOU | CNSA | Global | 21,528 (MEO)<br/>35,768 (GEO & IGSO) | 48 |
| QZSS | JAXA | Regional | 32,000 (perigree)<br/>40,000(apogee) | 4 |
| IRNSS / NAVIC | ISRO | Regional | 36,000 | 8 |

## Protocol

Enable and set up the GNSS settings:

| Protocol | Description |
| :------- | :----------------------------------------------- |
| NMEA | A binary protocol for GNSS data |
| UBLOX | A text protocol for GNSS data, more customizable |
| MSP | GNSS using the MultiWii Serial Protocol |

## Settings

| Setting | Description |
| :------------------ | :-------------------------------------------------------------------------------------------------------------------------------------------------- |
| Auto Baud | Automatically detect the baud rate of the GNSS |
| Auto Config | Automatically configure the GNSS |
| Set Home Point Once | If enabled, the home point will be set only once, when a fix is acquired. If disabled, the home point will be updated every time the craft is armed |

For more information about GPS changes in 4.5, see the [Wiki document](/docs/wiki/guides/current/Failsafe).

0 comments on commit e7ea269

Please sign in to comment.