Skip to content

Commit 03b04d3

Browse files
authored
Add tune examples and docs (PX4#431)
* Add tune examples and docs. * Move LEDs/tunes to first appear in getting started. Cross link from flying 101
1 parent 7a0f00c commit 03b04d3

31 files changed

+305
-46
lines changed
17.6 KB
Binary file not shown.

assets/tunes/11_parachute_release.mp3

20 KB
Binary file not shown.

assets/tunes/12_ekf_warning.mp3

20.8 KB
Binary file not shown.

assets/tunes/13_baro_warning.mp3

19.2 KB
Binary file not shown.

assets/tunes/14_single_beep.mp3

16.3 KB
Binary file not shown.

assets/tunes/15_home_set_tune.mp3

26.1 KB
Binary file not shown.

assets/tunes/16_make_fs.mp3

23.7 KB
Binary file not shown.

assets/tunes/17_format_failed.mp3

26.9 KB
Binary file not shown.

assets/tunes/18_program_px4io.mp3

86.5 KB
Binary file not shown.
17.1 KB
Binary file not shown.

assets/tunes/1_startup_tone.mp3

29.8 KB
Binary file not shown.
84.5 KB
Binary file not shown.

assets/tunes/2_error_tune.mp3

113 KB
Binary file not shown.
31 KB
Binary file not shown.
21.2 KB
Binary file not shown.
34.3 KB
Binary file not shown.

assets/tunes/6_arming_warning.mp3

62.9 KB
Binary file not shown.
87.8 KB
Binary file not shown.
73.5 KB
Binary file not shown.

assets/tunes/9_gps_warning_slow.mp3

38.4 KB
Binary file not shown.

en/SUMMARY.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@
88
* [Sensors](getting_started/sensor_selection.md)
99
* [Radio Systems](getting_started/rc_transmitter_receiver.md)
1010
* [Flight Modes](getting_started/flight_modes.md)
11+
* [Vehicle Status Notifications](getting_started/vehicle_status.md)
12+
* [LED Meanings](getting_started/led_meanings.md)
13+
* [Tune/Sound Meanings](getting_started/tunes.md)
14+
* [Preflight Checks](flying/pre_flight_checks.md)
1115
* [Flight Reporting](getting_started/flight_reporting.md)
1216
* [Basic Assembly](assembly/README.md)
1317
* [Mounting the Flight Controller](assembly/mount_and_orient_controller.md)
@@ -52,8 +56,6 @@
5256
* [Traxxas Stampede](frames_rover/traxxas_stampede.md)
5357
* [Flying](flying/README.md)
5458
* [First Flight Guidelines](flying/first_flight_guidelines.md)
55-
* [LED Meanings](flying/led_meanings.md)
56-
* [Preflight Checks (Internal)](flying/pre_flight_checks.md)
5759
* [Flying 101](flying/basic_flying.md)
5860
* [Landing \(Fixed Wing\)](flying/fixed_wing_landing.md)
5961
* [Missions](flying/missions.md)

en/assembly/quick_start_cube.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Customized screws are supposed to be M2.5 with thread length inside Cube in rang
4848

4949
## GPS + Compass + Safety Switch + LED {#gps}
5050

51-
The recommended GPS modules are the *Here* and [Here+](../gps_compass/rtk_gps_hex_hereplus.md), both of which incorporate a GPS module, Compass, Safety Switch and [LEDs](../flying/led_meanings.md).
51+
The recommended GPS modules are the *Here* and [Here+](../gps_compass/rtk_gps_hex_hereplus.md), both of which incorporate a GPS module, Compass, Safety Switch and [LEDs](../getting_started/led_meanings.md).
5252

5353
> **Note** The difference between the modules is that *Here+* supports centimeter level positioning via [RTK](../advanced_features/rtk-gps.md). Otherwise they are used/connected in the same way.
5454

en/flight_controller/pixhawk3_pro.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ From [Drotek store](https://store.drotek.com/) (EU) :
2929
* [Pixhawk 3 Pro (Pack)](https://store.drotek.com/autopilots/844-pixhawk-3-pro-pack.html)
3030
* [Pixhawk 3 Pro](https://store.drotek.com/autopilots/821-pixhawk-pro-autopilot-8944595120557.html)
3131

32-
From [readymaderc](www.readymaderc.com) (USA) :
32+
From [readymaderc](https://www.readymaderc.com) (USA) :
3333
* [Pixhawk 3 Pro](https://www.readymaderc.com/products/details/pixhawk-3-pro-flight-controller)
3434

3535
## Building Firmware

en/flight_controller/pixhawk_series.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -93,4 +93,4 @@ All *Pixhawk-series* flight controllers support:
9393
* A user facing RGB *UI LED* to indicate the current *readiness to fly* status of the vehicle. This is typically a superbright I2C peripheral, which may or may not be mounted on the board (i.e. FMUv4 does not have one on board and typically uses an LED mounted on the GPS).
9494
* Three *Status LED*s that provide lower level power status, bootloader mode and activity, and error information.
9595

96-
To interpret the LEDs see: [LED Meanings](../flying/led_meanings.md).
96+
To interpret the LEDs see: [LED Meanings](../getting_started/led_meanings.md).

en/flying/README.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,11 @@ It covers both (autopilot-assisted) manual flight and mission planning for fully
55

66
[First Flight Guidelines](../flying/first_flight_guidelines.md) — Guidelines to ensure that your first flight is enjoyable, educational, and safe.
77

8-
[LED Meanings (Pixhawk)](../flying/led_meanings.md) — Understanding vehicle status from the status LEDs (Pixhawk-series).
9-
10-
[Preflight Checks (Internal)](../flying/pre_flight_checks.md) — Interpreting pre-flight errors ("Why won't my vehicle arm?").
11-
128
[Flying 101](../flying/basic_flying.md) — How to fly a vehicle manually, using an RC Transmitter.
139

1410
[Missions](../flying/missions.md) — How to fly an autonomous mission.
1511

1612
[Flight Modes](../flight_modes/README.md) — Summary table + detailed information about flight modes.
13+
14+
15+
> **Tip** [Vehicle Status Notifications](../getting_started/vehicle_status.md) can help you work out when your vehicle is ready to fly (and if not, why not).

en/flying/basic_flying.md

+32-14
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,38 @@ This topic explains the basics of flying a vehicle using an [RC Transmitter](../
44

55
> **Note** Before you fly for the first time you should read our [First Flight Guidelines](../flying/first_flight_guidelines.md).
66
7+
8+
## Arm the Vehicle
9+
10+
Before you can fly the vehicle it must first be *armed* (this will start the propellers rotating).
11+
12+
13+
> **Tip** The vehicle will not arm until it is [calibrated/configured](../config/README.md) and have a position lock.
14+
[Vehicle Status Notifications](../getting_started/vehicle_status.md) (including on-vehicle LEDs, audio notifications and *QGroundControl* updates) can tell you when the vehicle is ready to fly (and help you work out the cause when it is not ready to fly).
15+
16+
To arm the drone, put the throttle stick in the bottom right corner.
17+
This will start the propellers on a multicopter.
18+
19+
To disarm, put the throttle stick in the bottom left corner.
20+
Alternatively arming and disarming can also be performed in *QGroundControl* (PX4 does not require a radio control for flying autonomously).
21+
22+
23+
## Takeoff and Landing
24+
25+
The easiest way to takeoff is to use the automatic [Takeoff mode](../flight_modes/takeoff.md) (remembering that you need to arm the vehicle before you can engage the vehicle motors).
26+
To land again automatically you can use [Land](../flight_modes/land.md) or [Return](../flight_modes/return.md) modes.
27+
28+
> **Tip** The automatic takeoff/landing modes are highly recommended, in particular for Fixed Wing vehicles.
29+
30+
For multicopter (and VTOL in multicopter mode) pilots can:
31+
32+
* Take off manually by enabling [position mode](../flight_modes/README.md#assisted-modes), arming the vehicle, and then raising the throttle stick above 62.5%.
33+
Above this value all controllers are enabled and the vehicle goes to the throttle level required for hovering ([MPC_THR_HOVER](../advanced_config/parameter_reference.md#MPC_THR_HOVER)).
34+
* Land manually by pressing the throttle stick down until the vehicle lands and disarms (or set [COM_DISARM_LAND](../advanced_config/parameter_reference.md#COM_DISARM_LAND) > 0 to disarm automatically on landing).
35+
36+
> **Note** If you see the vehicle "twitch" during landing (turn down the motors, and then immediately turn them back up) this is probably caused by a poor [Land Detector Configuration](../advanced_config/land_detector.md) (specifically, a poorly set [MPC_THR_HOVER](../advanced_config/parameter_reference.md#MPC_THR_HOVER)).
37+
38+
739
## Flight Controls/Commands
840

941
All flying, including takeoff and landing, is controlled using the 4 basic commands: roll, yaw, pitch and throttle.
@@ -55,17 +87,3 @@ The following three modes are highly recommended for new users:
5587
> **Tip** You can also access automatic modes through the buttons on the bottom of the *QGroundControl* main flight screen.
5688
5789

58-
## Takeoff and Landing
59-
60-
The easiest way to takeoff is to use the automatic [Takeoff mode](../flight_modes/takeoff.md) (remembering that you need to arm the vehicle before you can engage the vehicle motors).
61-
To land again automatically you can use [Land](../flight_modes/land.md) or [Return](../flight_modes/return.md) modes.
62-
63-
> **Tip** The automatic takeoff/landing modes are highly recommended, in particular for Fixed Wing vehicles.
64-
65-
For multicopter (and VTOL in multicopter mode) pilots can:
66-
67-
* Take off manually by enabling [position mode](../flight_modes/README.md#assisted-modes), arming the vehicle, and then raising the throttle stick above 62.5%.
68-
Above this value all controllers are enabled and the vehicle goes to the throttle level required for hovering ([MPC_THR_HOVER](../advanced_config/parameter_reference.md#MPC_THR_HOVER)).
69-
* Land manually by pressing the throttle stick down until the vehicle lands and disarms (or set [COM_DISARM_LAND](../advanced_config/parameter_reference.md#COM_DISARM_LAND) > 0 to disarm automatically on landing).
70-
71-
> **Note** If you see the vehicle "twitch" during landing (turn down the motors, and then immediately turn them back up) this is probably caused by a poor [Land Detector Configuration](../advanced_config/land_detector.md) (specifically, a poorly set [MPC_THR_HOVER](../advanced_config/parameter_reference.md#MPC_THR_HOVER)).

en/flying/first_flight_guidelines.md

+17-23
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,41 @@
11
# First Flight Guidelines
22

3-
[Learning to fly](../flying/basic_flying.md) is a lot of fun! These guidelines are designed
4-
to ensure that your first flight experience is enjoyable, educational, and safe.
3+
[Learning to fly](../flying/basic_flying.md) is a lot of fun!
4+
These guidelines are designed to ensure that your first flight experience is enjoyable, educational, and safe.
55

66
## Select a Good Location
77

88
Selecting the right location for your first flight is critical.
99
The main things to look for are:
1010

11-
- Make sure the space is open. No high trees, hills or buildings next
12-
to it, because it will impair the GPS reception.
11+
- Make sure the space is open.
12+
No high trees, hills or buildings next to it, because it will impair the GPS reception.
1313
- Make sure no people are within 100 m / 300 feet.
14-
- Make sure there is nothing that you shouldn't crash onto within 100 m / 300 feet:
15-
No houses, structures, cars, water, corn fields (hard to find drones in).
14+
- Make sure there is nothing that you shouldn't crash onto within 100 m / 300 feet - no houses, structures, cars, water, corn fields (hard to find drones in).
15+
16+
> **Note** 100m clearance is a good "rule of thumb", but you should also ensure you comply with flight regulations in your area.
1617
1718
## Bring a Pro
1819

19-
Bring someone with experience for your first flight. Get them to help you to run through the pre-flight
20-
checks and let them intervene if something goes wrong!
20+
Bring someone with experience for your first flight.
21+
Get them to help you to run through the pre-flight checks and let them intervene if something goes wrong!
2122

2223
## Plan the Flight
2324

24-
Plan the flight before taking off. Make sure you know the whole route and where/how the vehicle will land.
25+
Plan the flight before taking off.
26+
Make sure you know the whole route and where/how the vehicle will land.
2527

2628
## Limit the Damage
2729

28-
Damaging property or injuring people with your UAV can have significant legal and financial
29-
consequences (far in excess of the value of the UAV itself).
30+
Damaging property or injuring people with your UAV can have significant legal and financial consequences (far in excess of the value of the UAV itself).
3031

31-
The UAV should always be manually flown within a safe zone where there are no obstacles or people,
32-
and it must be clearly visible at all times.
32+
The UAV should always be manually flown within a safe zone where there are no obstacles or people, and it must be clearly visible at all times.
3333

34-
If you start to lose control over the vehicle, and cannot bring it back under control,
35-
crash it in an empty area as soon as possible.
34+
If you start to lose control over the vehicle, and cannot bring it back under control, crash it in an empty area as soon as possible.
3635

37-
> **Note** It can be useful to
38-
[set a safety switch on your transmitter](../config/safety.md#safety_switch).
36+
> **Note** It can be useful to [set a safety switch on your transmitter](../config/safety.md#safety_switch).
3937
This allows you to immediately return or crash your drone if necessary.
4038

41-
## Arm the Drone
4239

43-
To arm the drone, put the throttle stick in the bottom right corner.
44-
This will start the propellers on a multicopter. To disarm, put the
45-
throttle stick in the bottom left corner. Alternatively arming and
46-
disarming can also be performed in QGroundControl (PX4 does not require
47-
a radio control for flying autonomously).
40+
41+
File renamed without changes.

0 commit comments

Comments
 (0)