Skip to content

Commit a3b0744

Browse files
committedMay 2, 2025
Minor revisions
1 parent 6c60e9c commit a3b0744

7 files changed

+19
-16
lines changed
 

‎sub/source/docs/ekf-inav-failsafe.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ What will happen when the failsafe triggers?
2727
- The autopilot's `LED will flash red-yellow or blue-yellow and the tone-alarm will sound <https://www.youtube.com/watch?v=j-CMLrAwlco&feature=player_detailpage&t=60s>`__
2828
- "EKF variance" will appear on the ground station's HUD if telemetry is connected
2929
- In manual flight modes that do not require position (i.e. Stabilize, Acro, AltHold) nothing further will happen but the pilot will be unable to switch into autonomous flight modes (PosHold, Guided, Auto) until the failure clears
30-
- In autonomous modes that require position (i.e. PosHold, Guided, Auto, etc) the :ref:`FS_EKF_ACTION <FS_EKF_ACTION>` controls the behaviour. By default this is "0" meaning the sub will take no action. "1" will send a GCS warning message. "2" will Disarm the sub.
30+
- In autonomous modes that require position (i.e. PosHold, Guided, Auto, etc) the :ref:`FS_EKF_ACTION <FS_EKF_ACTION>` controls the behaviour. By default this is "0" meaning the vehicle will take no action. "1" will send a GCS warning message. "2" will Disarm the sub.
3131
- An EKF failsafe error will be written to the dataflash logs
3232

3333
After an EKF failsafe occurs, the pilot can re-take control (using the flight mode switch) in a manual flight mode such as :ref:`AltHold <altholdmode>` to bring the vehicle home.

‎sub/source/docs/failsafe-landing-page.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
.. _failsafe-landing-page:
22

3-
========
4-
Failsafe
5-
========
3+
=========
4+
Failsafes
5+
=========
66

77
Sub has a number of failsafe mechanisms to ease vehicle recovery/prevent wandering in the event that vehicle control is lost. The main failsafe topics are listed below.
88

9-
.. note:: Once a Radio Failsafe, Battery Failsafe, GCS Failsafe or Terrain Data Loss Failsafe is entered and the failsafe action taken involves a mode change to the vehicle, it will remain in that mode until the pilot changes the mode directly.
9+
.. note:: Once a Radio Failsafe, Battery Failsafe, GCS Failsafe or Pilot Control Loss Failsafe is entered and the failsafe action taken involves a mode change to the vehicle, it will remain in that mode until the pilot changes the mode directly.
1010

1111
.. toctree::
1212
:maxdepth: 1

‎sub/source/docs/gcs-failsafe.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,23 @@ The Ground Station Control (GCS) failsafe controls how Sub will behave if contac
77

88
.. note::
99

10-
Sub also supports other failsafes: :ref:`Radio <radio-failsafe>`, :ref:`Battery <failsafe-battery>`, and :ref:`EKF / DCM Check <ekf-inav-failsafe>`.
10+
Sub also supports other failsafes, see the :ref:`failsafe-landing-page`.
1111

1212
When the failsafe will trigger
1313
==============================
1414
The following situations can cause a loss of GCS MAVLink heartbeat, triggering a GCS failsafe event after :ref:`FS_GCS_TIMEOUT<FS_GCS_TIMEOUT>` seconds:
1515

1616
- The operator turns off or otherwise disconnects the GCS
17-
- The sub travels beyond the range of the GCS telemetry radios
17+
- The vehicle travels beyond the range of the GCS telemetry radios
1818
- The GCS telemetry mechanism on either end loses power
1919
- Wires connecting the GCS telemetry to the autopilot or ground equipment become disconnected
2020

2121
What will happen
2222
================
23-
When a GCS failsafe is triggered, the sub can be configured via parameters to do nothing, attempt to send the GCS a warning message, disarm, or change to ALTHOLD or SURFACE modes.
23+
When a GCS failsafe is triggered, the vehicle can be configured via parameters to do nothing, send the GCS a warning message, disarm, or change to ALTHOLD or SURFACE modes.
2424

25-
If the failsafe clears (i.e. GCS reconnects and MAVLink heartbeat is restored) the sub will remain in its failsafe mode. It will **not** automatically return to the flight mode that was active before the failsafe was triggered, if it was changed.
25+
26+
If the failsafe clears (i.e. GCS reconnects and MAVLink heartbeat is restored) the vehicle will remain in its failsafe mode. It will **not** automatically return to the flight mode that was active before the failsafe was triggered, if it was changed.
2627

2728
Setting the failsafe
2829
====================

‎sub/source/docs/internal-pressure-failsafe.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@
33
==========================
44
Internal Pressure Failsafe
55
==========================
6-
Sub can use the barometer normally included with an autopilot to determine if the pressure inside the sub has increased too much. The amount of the pressure in pascals is set by :ref:`FS_PRESS_MAX<FS_PRESS_MAX>`. If it is exceeded, then the following actions is taken as set by the value of the :ref:`FS_PRESS_ENABLE<FS_PRESS_ENABLE>` parameter:
6+
Sub can use the barometer normally included with an autopilot to determine if the pressure inside the vehicle has increased too much. This could occur if the enclosure is bowing in and near implosion, or if something is burning/off-gassing, or if there's a big enough leak that water is forcing its way in. It can also be from the internal electronics heat.
7+
8+
The amount of the pressure in pascals is set by :ref:`FS_PRESS_MAX<FS_PRESS_MAX>`. If it is exceeded, then the following actions is taken as set by the value of the :ref:`FS_PRESS_ENABLE<FS_PRESS_ENABLE>` parameter:
79

810
- **Disabled** (Value 0) will disable the failsafe entirely.
911
- **Warn Only** (Value 1) will send a GCS warning message.

‎sub/source/docs/internal-temperature-failsafe.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
=============================
44
Internal Temperature Failsafe
55
=============================
6-
Sub can use the barometer normally included with an autopilot to determine if the temperature inside the sub has increased too much. The trigger temperature is set by :ref:`FS_TEMP_MAX<FS_TEMP_MAX>`. If it is exceeded, then the following actions is taken as set by the value of the :ref:`FS_TEMP_ENABLE<FS_PRESS_ENABLE>` parameter:
6+
Sub can use the barometer normally included with an autopilot to determine if the temperature inside the vehicle has increased too much, which can cause vehicle electronics to malfunction, or may indicate a fire. The trigger temperature is set by :ref:`FS_TEMP_MAX<FS_TEMP_MAX>`. If it is exceeded, then the following actions is taken as set by the value of the :ref:`FS_TEMP_ENABLE<FS_PRESS_ENABLE>` parameter:
77

88
- **Disabled** (Value 0) will disable the failsafe entirely.
99
- **Warn Only** (Value 1) will send a GCS warning message.

‎sub/source/docs/pilot-control-failsafe.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ If :ref:`FS_PILOT_INPUT<FS_PILOT_INPUT>` is non-zero, then lack of both valid RC
1414

1515
What will happen
1616
================
17-
When a Pilot Control failsafe is triggered, the sub can be configured via parameters to do nothing, send the GCS a warning message, or Disarm.
17+
When a Pilot Control failsafe is triggered, the vehicle can be configured via parameters to do nothing, send the GCS a warning message, or Disarm.
1818

19-
If the failsafe clears (i.e. RC control or MAVLink overrides from GCS is restored) the sub will remain in its failsafe mode. If it is disarmed, and the pilot wished to re-take control he/she would need to rearm the sub . This can be done via RC or GCS.
19+
If the failsafe clears (i.e. RC control or MAVLink overrides from GCS is restored) the vehicle will remain in its failsafe mode. If it is disarmed, and the pilot wished to re-take control he/she would need to rearm the vehicle . This can be done via RC or GCS.
2020

2121
Setting the failsafe
2222
====================

‎sub/source/docs/radio-failsafe.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Sub supports several configurable failsafe options in cases where contact betwee
1010

1111
.. note::
1212

13-
Sub also supports other failsafes, including: :ref:`Battery <failsafe-battery>`, :ref:`Ground Station <gcs-failsafe>` and :ref:`EKF/DCM failsafes <ekf-inav-failsafe>`. See the :ref:`failsafe-landing-page` for more details.
13+
Sub also supports other failsafes, see the :ref:`failsafe-landing-page`.
1414

1515
When the failsafe will trigger
1616
==============================
@@ -25,9 +25,9 @@ If enabled and set-up correctly the radio failsafe will trigger if any of these
2525

2626
What will happen
2727
================
28-
When a radio failsafe is triggered, the sub can be configured via parameters to do nothing, warn the GCS, or switch mode to SURFACE.
28+
When a radio failsafe is triggered, the vehicle can be configured via parameters to do nothing, warn the GCS, or switch mode to SURFACE.
2929

30-
If the rc failsafe clears (i.e. transmitter and receiver regain contact) the sub will remain in its failsafe mode. It will **not** automatically return to the flight mode that was active before the failsafe was triggered. If the pilot wished to re-take control he/she would need to change the RC flight mode switch to another position.
30+
If the rc failsafe clears (i.e. transmitter and receiver regain contact) the vehicle will remain in its failsafe mode. It will **not** automatically return to the flight mode that was active before the failsafe was triggered. If the pilot wished to re-take control he/she would need to change the RC flight mode switch to another position.
3131

3232
Receiver Configuration
3333
======================

0 commit comments

Comments
 (0)