docs/Buzzer.md

   1 # Buzzer
   2
   3 INAV supports a buzzer which is used for the following purposes:
   4
   5  * Low and critical battery alarms (when battery monitoring enabled)
   6  * Arm/disarm tones (and warning beeps while armed)
   7  * Notification of calibration complete status
   8  * TX-AUX operated beeping - useful for locating your aircraft after a crash
   9  * Failsafe status
  10  * Flight mode change
  11  * Rate profile change (via TX-AUX switch)
  12
  13 If the arm/disarm is via the control stick, holding the stick in the disarm position will sound a repeating tone.  This can be used as a lost-model locator.
  14
  15 Three beeps immediately after powering the board means that the gyroscope calibration has completed successfully. INAV calibrates the gyro automatically upon every power-up. It is important that the copter stay still on the ground until the three beeps sound, so that gyro calibration isn't thrown off. If you move the copter significantly during calibration, INAV will detect this, and will automatically re-start the calibration once the copter is still again. This will delay the "three beeps" tone. If you move the copter just a little bit, the gyro calibration may be incorrect, and the copter may not fly correctly. In this case, the gyro calibration can be performed manually via [stick command](Controls.md), or you may simply power cycle the board.
  16
  17 There is a special arming tone used if a GPS fix has been attained, and there's a "ready" tone sounded after a GPS fix has been attained (only happens once).  The tone sounded via the TX-AUX-switch will count out the number of satellites (if GPS fix).
  18
  19 The CLI command `play_sound` is useful for demonstrating the buzzer tones. Repeatedly entering the command will play the various tones in turn. Entering the command with a numeric-index parameter (see below) will play the associated tone.
  20
  21 Buzzer is enabled by default on platforms that have buzzer connections.
  22
  23 ## Tone sequences
  24
  25 Buzzer tone sequences (square wave generation) are made so that : 1st, 3rd, 5th, .. are the delays how long the beeper is on and 2nd, 4th, 6th, .. are the delays how long beeper is off. Delays are in milliseconds/10 (i.e., 5 => 50ms).
  26
  27 Sequences:
  28
  29     0    GYRO_CALIBRATED       20, 10, 20, 10, 20, 10   Gyro is calibrated
  30     1    RX_LOST_LANDING       10, 10, 10, 10, 10, 40, 40, 10, 40, 10, 40, 40, 10, 10, 10, 10, 10, 70    SOS morse code
  31     2    RX_LOST               50, 50           TX off or signal lost (repeats until TX is okay)
  32     3    DISARMING             15, 5, 15, 5             Disarming the board
  33     4    ARMING                30, 5, 5, 5              Arming the board
  34     5    ARMING_GPS_FIX        5, 5, 15, 5, 5, 5, 15, 30        Arming and GPS has fix
  35     6    BAT_CRIT_LOW          50, 2            Battery is critically low (repeats)
  36     7    BAT_LOW               25, 50           Battery is getting low (repeats)
  37     8    NULL                  multi beeps              GPS status (sat count)
  38     9    RX_SET                10, 10           RX is set (when aux channel is set for beep or beep sequence how many satellites has found if GPS enabled)
  39     10   ACC_CALIBRATION       5, 5, 5, 5               ACC inflight calibration completed
  40     11   ACC_CALIBRATION_FAIL  20, 15, 35, 5    ACC inflight calibration failed
  41     12   READY_BEEP            4, 5, 4, 5, 8, 5, 15, 5, 8, 5, 4, 5, 4, 5        GPS locked and copter ready
  42     13   NULL                  multi beeps              Variable # of beeps (confirmation, GPS sat count, etc)
  43     14   DISARM_REPEAT         0, 100, 10               Stick held in disarm position (after pause)
  44     15   ARMED                 0, 245, 10, 5    Board is armed (after pause ; repeats until board is disarmed or throttle is increased)
  45
  46 You can use [this tool](https://www.mrd-rc.com/tutorials-tools-and-testing/useful-tools/helpful-inav-buzzer-code-checker/) to hear current buzzer sequences or enter custom sequences.
  47
  48 ## Controlling buzzer usage
  49
  50 The usage of the buzzer can be controlled by the CLI `beeper` command.
  51
  52 ### List current usage
  53
  54 ```
  55 beeper
  56 ```
  57 ### List all buzzer setting options
  58
  59 ```
  60 beeper list
  61 ```
  62 giving:
  63
  64 ```
  65 Available:  RUNTIME_CALIBRATION  HW_FAILURE  RX_LOST  RX_LOST_LANDING  DISARMING  ARMING  ARMING_GPS_FIX  BAT_CRIT_LOW
  66 BAT_LOW  GPS_STATUS  RX_SET  ACTION_SUCCESS  ACTION_FAIL  READY_BEEP  MULTI_BEEPS  DISARM_REPEAT  ARMED  SYSTEM_INIT
  67 ON_USB LAUNCH_MODE  CAM_CONNECTION_OPEN  CAM_CONNECTION_CLOSED  ALL  PREFERED
  68 ```
  69
  70 The `beeper` command  syntax follows that of the `feature` command; a minus (`-`) in front of a name disables that function.
  71
  72 So to disable the beeper / buzzer when  powered by USB (may enhance domestic harmony):
  73
  74 ```
  75 beeper -ON_USB
  76 ```
  77
  78 Now the `beeper` command will show:
  79
  80 ```
  81 # beeper
  82 Disabled:  ON_USB
  83 ```
  84
  85 *Note: SYSTEM_INIT sequence is not affected by ON_USB setting and will still be played on USB connection. Disable both ON_USB and SYSTEM_INIT to disable buzzer completely when FC is powered from USB.*
  86
  87 *Note: ON_USB setting requires present and configured battery voltage metter.*
  88
  89 To disable all features use:
  90
  91 ```
  92 beeper -ALL
  93 ```
  94
  95 To store current set to preferences use (preferences also require ```save```):
  96
  97 ```
  98 beeper PREFERED
  99 ```
 100
 101 To restore set from preferences use:
 102
 103 ```
 104 beeper -PREFERED
 105
 106 As with other CLI commands, the `save` command is needed to save the new settings.
 107
 108 ## Types of buzzer supported
 109
 110 Most FCs require ACTIVE buzzers. Active buzzers are enabled/disabled by simply enabling or disabling a GPIO output pin on the board.
 111 This means the buzzer must be able to generate its own tone simply by having power applied to it.
 112
 113 Passive buzzers that need an analog or PWM signal do not work and will make clicking noises or no sound at all.
 114
 115 Passive buzzers are supported on FCs which are designed to work with passive buzzers only (so far there is no available, except rare cases like Matek F765-WSE where passive buzzer is preinstalled).
 116
 117 Examples of a known-working buzzers.
 118
 119  * [Hcm1205x Miniature Buzzer 5v](http://www.rapidonline.com/Audio-Visual/Hcm1205x-Miniature-Buzzer-5v-35-0055)
 120  * [5V Electromagnetic Active Buzzer Continuous Beep](https://inavflight.com/shop/s/bg/943524)
 121  * [Radio Shack Model: 273-074 PC-BOARD 12VDC (3-16v) 70DB PIEZO BUZZER](http://www.radioshack.com/pc-board-12vdc-70db-piezo-buzzer/2730074.html#.VIAtpzHF_Si)
 122  * [MultiComp MCKPX-G1205A-3700 TRANSDUCER, THRU-HOLE, 4V, 30MA](http://uk.farnell.com/multicomp/mckpx-g1205a-3700/transducer-thru-hole-4v-30ma/dp/2135914?CMP=i-bf9f-00001000)
 123  * [3-24V Piezo Electronic Tone Buzzer Alarm 95DB](https://inavflight.com/shop/s/bg/919348)