Skip to content

Commit

Permalink
fix wiki build errors introduced with common-auxiliary-functions
Browse files Browse the repository at this point in the history
  • Loading branch information
Hwurzburg committed Oct 31, 2019
1 parent 54fb4d3 commit b1c49d0
Show file tree
Hide file tree
Showing 7 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion common/source/docs/common-buzzer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ A buzzer (or Tone Alarm) can be used to audibly indicate status changes for the
.. image:: ../../../images/buzzer.jpg
:target: ../_images/buzzer.jpg

If a passive piezo is used, it can play various :ref:`sounds <common-sounds-pixhawkpx4>` including the Arming buzz and Lost Vehicle Alarms (search for "Lost Copter Alarm" on :ref:`this page <channel-7-and-8-options>` , "Lost Plane" in the RCx_OPTIONS, for example, :ref:`RC5_OPTION <RC5_OPTION>` , or "Lost Rover" in the :ref:`Auxiliary Functions <rover-auxiliary-functions>`).
If a passive piezo is used, it can play various :ref:`sounds <common-sounds-pixhawkpx4>` including the Arming buzz and Lost Vehicle Alarms (search for "Lost Copter Alarm" on :ref:`this page <channel-7-and-8-options>` , "Lost Plane" in the RCx_OPTIONS, for example, :ref:`RC5_OPTION <RC5_OPTION>` , or "Lost Rover" in the :ref:`Auxiliary Functions <common-auxiliary-functions>`).

If an active buzzer is used, it can indicate the following:

Expand Down
2 changes: 1 addition & 1 deletion common/source/docs/common-relay.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The relays can be controlled with the auxiliary switches. For Copter:
:target: ../_images/Relay_SetupCh7WithMP.png

For Plane, setting the RCx_OPTION parameter, such as :ref:`RC5_OPTION<RC5_OPTION>` .
For Rover, see :ref:`Auxiliary Functions<rover-auxiliary-functions>` .
For Rover, see :ref:`Auxiliary Functions<common-auxiliary-functions>` .

Mission control of the relay
============================
Expand Down
4 changes: 2 additions & 2 deletions rover/source/docs/arming-your-rover.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ If the LEDs never become blue or green please see the "Pre-Arm Checks" section b
There are three ways to arm the vehicle:

- **From the transmitter sticks**. Ensure the vehicle is in :ref:`Hold <hold-mode>`, :ref:`Manual <manual-mode>`, :ref:`Acro <acro-mode>` or :ref:`Steering <steering-mode>` mode, then center the throttle stick and hold the steering stick fully to the right for 2 seconds
- **From a transmitter switch**. Raise the auxiliary switch to the high position (see :ref:`how to configure aux functions here <rover-auxiliary-functions>`)
- **From a transmitter switch**. Raise the auxiliary switch to the high position (see :ref:`how to configure aux functions here <common-auxiliary-functions>`)
- **From the Ground Station**. Press the arm/disarm button on your ground station. If using the Mission Planner this can be found on the Flight Data screen's action tab on the bottom left

.. image:: ../../../images/armingButtonMissPlan.jpg
Expand All @@ -30,7 +30,7 @@ How to Disarm
=============

- **From the transmitter sticks**. Ensure the vehicle is in :ref:`Hold <hold-mode>`, :ref:`Manual <manual-mode>`, :ref:`Acro <acro-mode>` or :ref:`Steering <steering-mode>` mode, then hold the steering stick fully left for 2 seconds
- **From a transmitter switch**. Lower the auxiliary switch to the low position (see :ref:`how to configure aux functions here <rover-auxiliary-functions>`)
- **From a transmitter switch**. Lower the auxiliary switch to the low position (see :ref:`how to configure aux functions here <common-auxiliary-functions>`)
- **From the Ground Station**. Press the arm/disarm button on your ground station. If using the Mission Planner this can be found on the Flight Data screen's action tab on the bottom left

.. note::
Expand Down
2 changes: 1 addition & 1 deletion rover/source/docs/balance_bot-configure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ The vehicle must be armed for the wheels to start moving. Check the :ref:`rover

.. tip:: Remove wheels before proceeding.

#. Set a :ref:`transmitter switch<rover-auxiliary-functions>` for arming. Ensure the channel used for the switch has been :ref:`calibrated<common-radio-control-calibration>`. To configure a channel for arming, for example channel 7, then set the parameter:
#. Set a :ref:`transmitter switch<common-auxiliary-functions>` for arming. Ensure the channel used for the switch has been :ref:`calibrated<common-radio-control-calibration>`. To configure a channel for arming, for example channel 7, then set the parameter:

- :ref:`RC7_OPTION<RC7_OPTION>` =41 (Sets function of channel 7 as arming/disarming)

Expand Down
2 changes: 1 addition & 1 deletion rover/source/docs/learning-a-mission.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Missions can be created by driving the vehicle around intermittently recording t

If using version 3.2 (or higher) this can be accomplished by doing the following:

- set the :ref:`Auxiliary Function Switch <rover-auxiliary-functions>` to "Save Waypoint" by setting :ref:`CH7_OPTION <CH7_OPTION>` to "1"
- set the :ref:`Auxiliary Function Switch <common-auxiliary-functions>` to "Save Waypoint" by setting :ref:`CH7_OPTION <CH7_OPTION>` to "1"
- wait for a good position estimate (i.e. LED will turn green)
- drive the vehicle around in any mode except Auto.
- when the vehicle is at a position that you would like to record as a waypoint, toggle the auxiliary function switch high (and then return to low)
Expand Down
2 changes: 1 addition & 1 deletion rover/source/docs/learning-mode.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Learning Mode (deprecated)
==========================

In Rover-3.2 (and higher) Learning mode has been removed and replaced by the "Save Waypoint" :ref:`auxiliary switch function <rover-auxiliary-functions>`.
In Rover-3.2 (and higher) Learning mode has been removed and replaced by the "Save Waypoint" :ref:`auxiliary switch function <common-auxiliary-functions>`.

In Rover-3.1 and earlier, Learning drove exactly like :ref:`Manual <manual-mode>` and waypoints would be saved in the mission command list when the channel 7 switch was momentarily toggled.

Expand Down
2 changes: 1 addition & 1 deletion rover/source/docs/rover-tuning-throttle-and-speed.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The :ref:`CRUISE_THROTTLE <CRUISE_THROTTLE>` and :ref:`CRUISE_SPEED <CRUISE_SPEE

One way to set the value is to:

- set the :ref:`Auxiliary Function Switch <rover-auxiliary-functions>` to "Learn Cruise Speed"
- set the :ref:`Auxiliary Function Switch <common-auxiliary-functions>` to "Learn Cruise Speed"
- arm the vehicle and switch to :ref:`Manual <manual-mode>`
- drive the vehicle at a speed close to the speed you would normally drive it at (in Auto or other modes)
- move the aux function switch to the high position for a few seconds and then back down to the low position
Expand Down

0 comments on commit b1c49d0

Please sign in to comment.