2 * This file is part of Cleanflight and Betaflight.
4 * Cleanflight and Betaflight are free software. You can redistribute
5 * this software and/or modify this software under the terms of the
6 * GNU General Public License as published by the Free Software
7 * Foundation, either version 3 of the License, or (at your option)
10 * Cleanflight and Betaflight are distributed in the hope that they
11 * will be useful, but WITHOUT ANY WARRANTY; without even the implied
12 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
13 * See the GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this software.
18 * If not, see <http://www.gnu.org/licenses/>.
26 #include "common/utils.h"
28 #include "config/feature.h"
30 #include "drivers/dshot_command.h"
31 #include "drivers/io.h"
32 #include "drivers/pwm_output.h"
33 #include "drivers/sound_beeper.h"
34 #include "drivers/system.h"
35 #include "drivers/time.h"
37 #include "flight/mixer.h"
39 #include "config/config.h"
41 #include "fc/runtime_config.h"
43 #include "io/statusindicator.h"
44 #include "io/vtx_control.h"
54 #include "pg/beeper.h"
56 #include "scheduler/scheduler.h"
58 #include "sensors/battery.h"
59 #include "sensors/sensors.h"
63 #ifdef BEEPER_INVERTED
64 #define IS_OPEN_DRAIN false
65 #define IS_INVERTED true
67 #define IS_OPEN_DRAIN true
68 #define IS_INVERTED false
73 #define BEEPER_PWM_HZ 0
76 #define BEEPER_PIN NONE
77 #define BEEPER_PWM_HZ 0
80 #define MAX_MULTI_BEEPS 64 //size limit for 'beep_multiBeeps[]'
82 #define BEEPER_COMMAND_REPEAT 0xFE
83 #define BEEPER_COMMAND_STOP 0xFF
86 static timeUs_t lastDshotBeaconCommandTimeUs
;
90 /* Beeper Sound Sequences: (Square wave generation)
91 * Sequence must end with 0xFF or 0xFE. 0xFE repeats the sequence from
92 * start when 0xFF stops the sound when it's completed.
94 * "Sound" Sequences are made so that 1st, 3rd, 5th.. are the delays how
95 * long the beeper is on and 2nd, 4th, 6th.. are the delays how long beeper
96 * is off. Delays are in milliseconds/10 (i.e., 5 => 50ms).
99 static const uint8_t beep_shortBeep
[] = {
100 10, 10, BEEPER_COMMAND_STOP
103 static const uint8_t beep_armingBeep
[] = {
104 30, 5, 5, 5, BEEPER_COMMAND_STOP
106 // Arming when GPS is fixed
107 static const uint8_t beep_armingGpsFix
[] = {
108 5, 5, 15, 5, 5, 5, 15, 30, BEEPER_COMMAND_STOP
110 // Arming when GPS is not fixed
111 static const uint8_t beep_armingGpsNoFix
[] = {
112 30, 5, 30, 5, 30, 5, BEEPER_COMMAND_STOP
114 // armed beep (first pause, then short beep)
115 static const uint8_t beep_armedBeep
[] = {
116 0, 245, 10, 5, BEEPER_COMMAND_STOP
119 static const uint8_t beep_disarmBeep
[] = {
120 15, 5, 15, 5, BEEPER_COMMAND_STOP
122 // beeps while stick held in disarm position (after pause)
123 static const uint8_t beep_disarmRepeatBeep
[] = {
124 0, 100, 10, BEEPER_COMMAND_STOP
126 // Long beep and pause after that
127 static const uint8_t beep_lowBatteryBeep
[] = {
128 25, 50, BEEPER_COMMAND_STOP
130 // critical battery beep
131 static const uint8_t beep_critBatteryBeep
[] = {
132 50, 2, BEEPER_COMMAND_STOP
135 // transmitter-signal-lost tone
136 static const uint8_t beep_txLostBeep
[] = {
137 50, 50, BEEPER_COMMAND_STOP
140 static const uint8_t beep_sos
[] = {
141 10, 10, 10, 10, 10, 40, 40, 10, 40, 10, 40, 40, 10, 10, 10, 10, 10, 70, BEEPER_COMMAND_STOP
143 // Ready beeps. When gps has fix and copter is ready to fly.
144 static const uint8_t beep_readyBeep
[] = {
145 4, 5, 4, 5, 8, 5, 15, 5, 8, 5, 4, 5, 4, 5, BEEPER_COMMAND_STOP
147 // 2 fast short beeps
148 static const uint8_t beep_2shortBeeps
[] = {
149 5, 5, 5, 5, BEEPER_COMMAND_STOP
152 static const uint8_t beep_2longerBeeps
[] = {
153 20, 15, 35, 5, BEEPER_COMMAND_STOP
156 static const uint8_t beep_gyroCalibrated
[] = {
157 20, 10, 20, 10, 20, 10, BEEPER_COMMAND_STOP
160 // Cam connection opened
161 static const uint8_t beep_camOpenBeep
[] = {
162 5, 15, 10, 15, 20, BEEPER_COMMAND_STOP
165 // Cam connection close
166 static const uint8_t beep_camCloseBeep
[] = {
167 10, 8, 5, BEEPER_COMMAND_STOP
170 // RC Smoothing filter not initialized - 3 short + 1 long
171 static const uint8_t beep_rcSmoothingInitFail
[] = {
172 10, 10, 10, 10, 10, 10, 50, 25, BEEPER_COMMAND_STOP
175 // array used for variable # of beeps (reporting GPS sat count, etc)
176 static uint8_t beep_multiBeeps
[MAX_MULTI_BEEPS
+ 1];
178 #define BEEPER_CONFIRMATION_BEEP_DURATION 2
179 #define BEEPER_CONFIRMATION_BEEP_GAP_DURATION 20
181 #define BEEPER_WARNING_LONG_BEEP_MULTIPLIER 5
183 #define BEEPER_WARNING_BEEP_1_DURATION 20
184 #define BEEPER_WARNING_BEEP_2_DURATION 5
185 #define BEEPER_WARNING_BEEP_GAP_DURATION 10
187 static bool beeperIsOn
= false;
189 // Place in current sequence
190 static uint16_t beeperPos
= 0;
191 // Time when beeper routine must act next time
192 static uint32_t beeperNextToggleTime
= 0;
193 // Time of last arming beep in microseconds (for blackbox)
194 static uint32_t armingBeepTimeMicros
= 0;
196 static void beeperProcessCommand(timeUs_t currentTimeUs
);
198 typedef struct beeperTableEntry_s
{
200 uint8_t priority
; // 0 = Highest
201 const uint8_t *sequence
;
203 } beeperTableEntry_t
;
205 #define BEEPER_ENTRY(a,b,c,d) a,b,c,d
207 // IMPORTANT: these are in priority order, 0 = Highest
208 static const beeperTableEntry_t beeperTable
[] = {
209 { BEEPER_ENTRY(BEEPER_GYRO_CALIBRATED
, 0, beep_gyroCalibrated
, "GYRO_CALIBRATED") },
210 { BEEPER_ENTRY(BEEPER_RX_LOST
, 1, beep_txLostBeep
, "RX_LOST") },
211 { BEEPER_ENTRY(BEEPER_RX_LOST_LANDING
, 2, beep_sos
, "RX_LOST_LANDING") },
212 { BEEPER_ENTRY(BEEPER_DISARMING
, 3, beep_disarmBeep
, "DISARMING") },
213 { BEEPER_ENTRY(BEEPER_ARMING
, 4, beep_armingBeep
, "ARMING") },
214 { BEEPER_ENTRY(BEEPER_ARMING_GPS_FIX
, 5, beep_armingGpsFix
, "ARMING_GPS_FIX") },
215 { BEEPER_ENTRY(BEEPER_ARMING_GPS_NO_FIX
, 6, beep_armingGpsNoFix
, "ARMING_GPS_NO_FIX") },
216 { BEEPER_ENTRY(BEEPER_BAT_CRIT_LOW
, 7, beep_critBatteryBeep
, "BAT_CRIT_LOW") },
217 { BEEPER_ENTRY(BEEPER_BAT_LOW
, 8, beep_lowBatteryBeep
, "BAT_LOW") },
218 { BEEPER_ENTRY(BEEPER_GPS_STATUS
, 9, beep_multiBeeps
, "GPS_STATUS") },
219 { BEEPER_ENTRY(BEEPER_RX_SET
, 10, beep_shortBeep
, "RX_SET") },
220 { BEEPER_ENTRY(BEEPER_ACC_CALIBRATION
, 11, beep_2shortBeeps
, "ACC_CALIBRATION") },
221 { BEEPER_ENTRY(BEEPER_ACC_CALIBRATION_FAIL
, 12, beep_2longerBeeps
, "ACC_CALIBRATION_FAIL") },
222 { BEEPER_ENTRY(BEEPER_READY_BEEP
, 13, beep_readyBeep
, "READY_BEEP") },
223 { BEEPER_ENTRY(BEEPER_MULTI_BEEPS
, 14, beep_multiBeeps
, "MULTI_BEEPS") }, // FIXME having this listed makes no sense since the beep array will not be initialised.
224 { BEEPER_ENTRY(BEEPER_DISARM_REPEAT
, 15, beep_disarmRepeatBeep
, "DISARM_REPEAT") },
225 { BEEPER_ENTRY(BEEPER_ARMED
, 16, beep_armedBeep
, "ARMED") },
226 { BEEPER_ENTRY(BEEPER_SYSTEM_INIT
, 17, NULL
, "SYSTEM_INIT") },
227 { BEEPER_ENTRY(BEEPER_USB
, 18, NULL
, "ON_USB") },
228 { BEEPER_ENTRY(BEEPER_BLACKBOX_ERASE
, 19, beep_2shortBeeps
, "BLACKBOX_ERASE") },
229 { BEEPER_ENTRY(BEEPER_CRASH_FLIP_MODE
, 20, beep_2longerBeeps
, "CRASH_FLIP") },
230 { BEEPER_ENTRY(BEEPER_CAM_CONNECTION_OPEN
, 21, beep_camOpenBeep
, "CAM_CONNECTION_OPEN") },
231 { BEEPER_ENTRY(BEEPER_CAM_CONNECTION_CLOSE
, 22, beep_camCloseBeep
, "CAM_CONNECTION_CLOSE") },
232 { BEEPER_ENTRY(BEEPER_RC_SMOOTHING_INIT_FAIL
,23, beep_rcSmoothingInitFail
, "RC_SMOOTHING_INIT_FAIL") },
233 { BEEPER_ENTRY(BEEPER_ALL
, 24, NULL
, "ALL") },
236 static const beeperTableEntry_t
*currentBeeperEntry
= NULL
;
238 #define BEEPER_TABLE_ENTRY_COUNT (sizeof(beeperTable) / sizeof(beeperTableEntry_t))
241 * Called to activate/deactivate beeper, using the given "BEEPER_..." value.
242 * This function returns immediately (does not block).
244 void beeper(beeperMode_e mode
)
247 mode
== BEEPER_SILENCE
|| (
248 (beeperConfig()->beeper_off_flags
& BEEPER_GET_FLAG(BEEPER_USB
))
249 && getBatteryState() == BATTERY_NOT_PRESENT
250 ) || IS_RC_MODE_ACTIVE(BOXBEEPERMUTE
)
256 const beeperTableEntry_t
*selectedCandidate
= NULL
;
257 for (uint32_t i
= 0; i
< BEEPER_TABLE_ENTRY_COUNT
; i
++) {
258 const beeperTableEntry_t
*candidate
= &beeperTable
[i
];
259 if (candidate
->mode
!= mode
) {
263 if (!currentBeeperEntry
) {
264 selectedCandidate
= candidate
;
268 if (candidate
->priority
< currentBeeperEntry
->priority
) {
269 selectedCandidate
= candidate
;
275 if (!selectedCandidate
) {
279 currentBeeperEntry
= selectedCandidate
;
282 beeperNextToggleTime
= 0;
285 void beeperSilence(void)
293 beeperNextToggleTime
= 0;
296 currentBeeperEntry
= NULL
;
300 * Emits the given number of 20ms beeps (with 200ms spacing).
301 * This function returns immediately (does not block).
303 void beeperConfirmationBeeps(uint8_t beepCount
)
306 uint32_t cLimit
= beepCount
* 2;
307 if (cLimit
> MAX_MULTI_BEEPS
) {
308 cLimit
= MAX_MULTI_BEEPS
;
311 beep_multiBeeps
[i
++] = BEEPER_CONFIRMATION_BEEP_DURATION
;
312 beep_multiBeeps
[i
++] = BEEPER_CONFIRMATION_BEEP_GAP_DURATION
;
313 } while (i
< cLimit
);
314 beep_multiBeeps
[i
] = BEEPER_COMMAND_STOP
;
316 beeper(BEEPER_MULTI_BEEPS
);
319 void beeperWarningBeeps(uint8_t beepCount
)
321 uint8_t longBeepCount
= beepCount
/ BEEPER_WARNING_LONG_BEEP_MULTIPLIER
;
322 uint8_t shortBeepCount
= beepCount
% BEEPER_WARNING_LONG_BEEP_MULTIPLIER
;
327 while (i
< MAX_MULTI_BEEPS
- 1 && count
< WARNING_FLASH_COUNT
) {
328 beep_multiBeeps
[i
++] = WARNING_FLASH_DURATION_MS
/ 10;
329 if (++count
< WARNING_FLASH_COUNT
) {
330 beep_multiBeeps
[i
++] = WARNING_FLASH_DURATION_MS
/ 10;
332 beep_multiBeeps
[i
++] = WARNING_PAUSE_DURATION_MS
/ 10;
336 while (i
< MAX_MULTI_BEEPS
- 1 && longBeepCount
> 0) {
337 beep_multiBeeps
[i
++] = WARNING_CODE_DURATION_LONG_MS
/ 10;
338 if (--longBeepCount
> 0) {
339 beep_multiBeeps
[i
++] = WARNING_CODE_DURATION_LONG_MS
/ 10;
341 beep_multiBeeps
[i
++] = WARNING_PAUSE_DURATION_MS
/ 10;
345 while (i
< MAX_MULTI_BEEPS
- 1 && shortBeepCount
> 0) {
346 beep_multiBeeps
[i
++] = WARNING_CODE_DURATION_SHORT_MS
/ 10;
347 if (--shortBeepCount
> 0) {
348 beep_multiBeeps
[i
++] = WARNING_CODE_DURATION_LONG_MS
/ 10;
352 beep_multiBeeps
[i
] = BEEPER_COMMAND_STOP
;
354 beeper(BEEPER_MULTI_BEEPS
);
358 static void beeperGpsStatus(void)
360 if (!(beeperConfig()->beeper_off_flags
& BEEPER_GET_FLAG(BEEPER_GPS_STATUS
))) {
361 // if GPS 3D fix and at least the minimum number available, then beep out number of satellites
362 if (STATE(GPS_FIX
) && gpsSol
.numSat
> GPS_MIN_SAT_COUNT
) {
365 beep_multiBeeps
[i
++] = 5;
366 beep_multiBeeps
[i
++] = 10;
367 } while (i
< MAX_MULTI_BEEPS
&& gpsSol
.numSat
> i
/ 2);
369 beep_multiBeeps
[i
- 1] = 50; // extend last pause
370 beep_multiBeeps
[i
] = BEEPER_COMMAND_STOP
;
372 beeper(BEEPER_MULTI_BEEPS
); //initiate sequence
379 * Beeper handler function to be called periodically in loop. Updates beeper
380 * state via time schedule.
382 void beeperUpdate(timeUs_t currentTimeUs
)
384 // If beeper option from AUX switch has been selected
385 if (IS_RC_MODE_ACTIVE(BOXBEEPERON
)) {
386 beeper(BEEPER_RX_SET
);
388 } else if (featureIsEnabled(FEATURE_GPS
) && IS_RC_MODE_ACTIVE(BOXBEEPGPSCOUNT
)) {
393 // Beeper routine doesn't need to update if there aren't any sounds ongoing
394 if (currentBeeperEntry
== NULL
) {
398 if (beeperNextToggleTime
> currentTimeUs
) {
399 schedulerIgnoreTaskExecTime();
404 if (!areMotorsRunning() && (currentBeeperEntry
->mode
== BEEPER_RX_SET
|| currentBeeperEntry
->mode
== BEEPER_RX_LOST
)
405 && !(beeperConfig()->dshotBeaconOffFlags
& BEEPER_GET_FLAG(currentBeeperEntry
->mode
))) {
406 if (cmpTimeUs(currentTimeUs
, getLastDisarmTimeUs()) > DSHOT_BEACON_GUARD_DELAY_US
&& !isTryingToArm()) {
407 const timeDelta_t dShotBeaconInterval
= (currentBeeperEntry
->mode
== BEEPER_RX_SET
) ? DSHOT_BEACON_MODE_INTERVAL_US
: DSHOT_BEACON_RXLOSS_INTERVAL_US
;
408 if (cmpTimeUs(currentTimeUs
, lastDshotBeaconCommandTimeUs
) > dShotBeaconInterval
) {
409 // at least 500ms between DShot beacons to allow time for the sound to fully complete
410 // the DShot Beacon tone duration is determined by the ESC, and should not exceed 250ms
411 lastDshotBeaconCommandTimeUs
= currentTimeUs
;
412 dshotCommandWrite(ALL_MOTORS
, getMotorCount(), beeperConfig()->dshotBeaconTone
, DSHOT_CMD_TYPE_INLINE
);
419 if (currentBeeperEntry
->sequence
[beeperPos
] != 0) {
420 if (!(beeperConfig()->beeper_off_flags
& BEEPER_GET_FLAG(currentBeeperEntry
->mode
))) {
427 // if this was arming beep then mark time (for blackbox)
430 && (currentBeeperEntry
->mode
== BEEPER_ARMING
|| currentBeeperEntry
->mode
== BEEPER_ARMING_GPS_FIX
431 || currentBeeperEntry
->mode
== BEEPER_ARMING_GPS_NO_FIX
)) {
432 armingBeepTimeMicros
= micros();
436 if (currentBeeperEntry
->sequence
[beeperPos
] != 0) {
446 static bool beeperWasOn
= false;
447 if (beeperIsOn
&& !beeperWasOn
) {
448 osdSetVisualBeeperState(true);
450 beeperWasOn
= beeperIsOn
;
453 beeperProcessCommand(currentTimeUs
);
457 * Calculates array position when next to change beeper state is due.
459 static void beeperProcessCommand(timeUs_t currentTimeUs
)
461 if (currentBeeperEntry
->sequence
[beeperPos
] == BEEPER_COMMAND_REPEAT
) {
463 } else if (currentBeeperEntry
->sequence
[beeperPos
] == BEEPER_COMMAND_STOP
) {
466 // Otherwise advance the sequence and calculate next toggle time
467 beeperNextToggleTime
= currentTimeUs
+ 1000 * 10 * currentBeeperEntry
->sequence
[beeperPos
];
473 * Returns the time that the last arming beep occurred (in system-uptime
474 * microseconds). This is fetched and logged by blackbox.
476 uint32_t getArmingBeepTimeMicros(void)
478 return armingBeepTimeMicros
;
482 * Returns the 'beeperMode_e' value for the given beeper-table index,
483 * or BEEPER_SILENCE if none.
485 beeperMode_e
beeperModeForTableIndex(int idx
)
487 return (idx
>= 0 && idx
< (int)BEEPER_TABLE_ENTRY_COUNT
) ? beeperTable
[idx
].mode
: BEEPER_SILENCE
;
491 * Returns the binary mask for the 'beeperMode_e' value corresponding to a given
492 * beeper-table index, or 0 if the beeperMode is BEEPER_SILENCE.
494 uint32_t beeperModeMaskForTableIndex(int idx
)
496 beeperMode_e beeperMode
= beeperModeForTableIndex(idx
);
497 if (beeperMode
== BEEPER_SILENCE
)
499 return BEEPER_GET_FLAG(beeperMode
);
503 * Returns the name for the given beeper-table index, or NULL if none.
505 const char *beeperNameForTableIndex(int idx
)
507 return (idx
>= 0 && idx
< (int)BEEPER_TABLE_ENTRY_COUNT
) ? beeperTable
[idx
].name
: NULL
;
511 * Returns the number of entries in the beeper-sounds table.
513 int beeperTableEntryCount(void)
515 return (int)BEEPER_TABLE_ENTRY_COUNT
;
519 * Returns true if the beeper is on, false otherwise
521 bool isBeeperOn(void)
528 // Stub out beeper functions if #BEEPER not defined
529 void beeper(beeperMode_e mode
) {UNUSED(mode
);}
530 void beeperSilence(void) {}
531 void beeperConfirmationBeeps(uint8_t beepCount
) {UNUSED(beepCount
);}
532 void beeperWarningBeeps(uint8_t beepCount
) {UNUSED(beepCount
);}
533 void beeperUpdate(timeUs_t currentTimeUs
) {UNUSED(currentTimeUs
);}
534 uint32_t getArmingBeepTimeMicros(void) {return 0;}
535 beeperMode_e
beeperModeForTableIndex(int idx
) {UNUSED(idx
); return BEEPER_SILENCE
;}
536 uint32_t beeperModeMaskForTableIndex(int idx
) {UNUSED(idx
); return 0;}
537 const char *beeperNameForTableIndex(int idx
) {UNUSED(idx
); return NULL
;}
538 int beeperTableEntryCount(void) {return 0;}
539 bool isBeeperOn(void) {return false;}
544 timeUs_t
getLastDshotBeaconCommandTimeUs(void)
546 return lastDshotBeaconCommandTimeUs
;