Play tunes on a passive piezo buzzer

Plays a tune at startup, and any tune on request from the GCS settings. The buzzer is driven with a PWM output, the board defines BUZZER_GPIO, BUZZER_PIN, BUZZER_AF, BUZZER_PWMD and BUZZER_PWM_CHANNEL. On the Cube Orange this is the ALARM pin (TIM2_CH1), on the BUZZER pin (5) of the carrier board USB port. Implementation for ChibiOS. To add a melody from an audio file (mp3, wav, ...), sw/tools/buzzer/mp3_to_buzzer.py writes the buzzer_note C array to add to buzzer_tunes.c (needs ffmpeg and numpy, see its –help).

Example for airframe file

Add to your firmware section: This example contains all possible configuration options, not all of them are mandatory!

<module name="buzzer_tunes">
  b'<define name="BUZZER_TUNES_STARTUP_TUNE" value="BUZZER_TUNES_STARTUP" />\n    '
  b'<define name="BUZZER_TUNES_EVENTS_ON" value="FALSE" />\n    '
  b'<define name="BUZZER_TUNES_ARMED_TUNE" value="BUZZER_TUNES_STARTUP" />\n    '
  b'<define name="BUZZER_TUNES_ALERT" value="electrical.bat_low" />\n    '
  b'<define name="BUZZER_TUNES_ALERT_HEADER" value="modules/energy/electrical.h" type="string" />\n    '
  b'<define name="BUZZER_TUNES_ALERT_TUNE" value="BUZZER_TUNES_STAR" />\n    '
  b'<define name="BUZZER_TUNES_ALERT_END_TUNE" value="BUZZER_TUNES_NONE" />\n    '
  b'<define name="BUZZER_TUNES_RTTTL_1" value="&quot;name:d=4,o=6,b=120:c,e,g&quot;" />\n  '
  b'<configure name="BUZZER_TIM" value="TIM2" />\n    '
</module>

Module configuration options

Configure Options

name: BUZZER_TIM value: TIM2
Description: Timer of the buzzer pin

Define Options

name: BUZZER_TUNES_STARTUP_TUNE value: BUZZER_TUNES_STARTUP
Description: Tune at startup (BUZZER_TUNES_x), BUZZER_TUNES_NONE for silence
name: BUZZER_TUNES_EVENTS_ON value: FALSE
Description: Armed and alert tunes enabled at startup (also a GCS setting), off by default
name: BUZZER_TUNES_ARMED_TUNE value: BUZZER_TUNES_STARTUP
Description: Optional tune played in a loop while the motors are armed, stopped when disarmed
name: BUZZER_TUNES_ALERT value: electrical.bat_low
Description: Optional C condition: while true, BUZZER_TUNES_ALERT_TUNE plays in a loop (Stop from the GCS mutes it until the next alert)
name: BUZZER_TUNES_ALERT_HEADER value: modules/energy/electrical.h
Description: Header to include for the alert condition
name: BUZZER_TUNES_ALERT_TUNE value: BUZZER_TUNES_STAR
Description: Tune played in a loop while the alert condition is true
name: BUZZER_TUNES_ALERT_END_TUNE value: BUZZER_TUNES_NONE
Description: Tune played once when the alert condition becomes false (stopped if the motors are disarmed)
name: BUZZER_TUNES_RTTTL_1 value: "name:d=4,o=6,b=120:c,e,g"
Description: Custom tunes 1 to 3 (BUZZER_TUNES_RTTTL_1..3) in RTTTL format, set them in an airframe section with type string

Module functions

Init Functions

These initialization functions are called once on startup.

buzzer_tunes_init()

Periodic Functions

These functions are called periodically at the specified frequency from the module periodic loop.

buzzer_tunes_periodic()
- Frequency in Hz: 100
- Autorun: LOCK
  Periodic function automatically starts after init and can't be stopped.

Files

Header Files

The following headers are automatically included in modules.h

buzzer_tunes.h

Source Files

modules/sound/buzzer_tunes.c
arch dependent: modules/sound/buzzer_arch.c

Raw buzzer_tunes.xml file:

<!DOCTYPE module SYSTEM "module.dtd">
 
<module name="buzzer_tunes" dir="sound">
  <doc>
    <description>
      Play tunes on a passive piezo buzzer
 
      Plays a tune at startup, and any tune on request from the GCS settings.
      The buzzer is driven with a PWM output, the board defines BUZZER_GPIO, BUZZER_PIN,
      BUZZER_AF, BUZZER_PWMD and BUZZER_PWM_CHANNEL.
      On the Cube Orange this is the ALARM pin (TIM2_CH1), on the BUZZER pin (5) of the carrier board USB port.
      Implementation for ChibiOS.
      To add a melody from an audio file (mp3, wav, ...), sw/tools/buzzer/mp3_to_buzzer.py writes the
      buzzer_note C array to add to buzzer_tunes.c (needs ffmpeg and numpy, see its --help).
    </description>
    <configure name="BUZZER_TIM" value="TIM2" description="Timer of the buzzer pin"/>
    <define name="BUZZER_TUNES_STARTUP_TUNE" value="BUZZER_TUNES_STARTUP" description="Tune at startup (BUZZER_TUNES_x), BUZZER_TUNES_NONE for silence"/>
    <define name="BUZZER_TUNES_EVENTS_ON" value="FALSE" description="Armed and alert tunes enabled at startup (also a GCS setting), off by default"/>
    <define name="BUZZER_TUNES_ARMED_TUNE" value="BUZZER_TUNES_STARTUP" description="Optional tune played in a loop while the motors are armed, stopped when disarmed"/>
    <define name="BUZZER_TUNES_ALERT" value="electrical.bat_low" description="Optional C condition: while true, BUZZER_TUNES_ALERT_TUNE plays in a loop (Stop from the GCS mutes it until the next alert)"/>
    <define name="BUZZER_TUNES_ALERT_HEADER" value="modules/energy/electrical.h" type="string" description="Header to include for the alert condition"/>
    <define name="BUZZER_TUNES_ALERT_TUNE" value="BUZZER_TUNES_STAR" description="Tune played in a loop while the alert condition is true"/>
    <define name="BUZZER_TUNES_ALERT_END_TUNE" value="BUZZER_TUNES_NONE" description="Tune played once when the alert condition becomes false (stopped if the motors are disarmed)"/>
    <define name="BUZZER_TUNES_RTTTL_1" value="&quot;name:d=4,o=6,b=120:c,e,g&quot;" description="Custom tunes 1 to 3 (BUZZER_TUNES_RTTTL_1..3) in RTTTL format, set them in an airframe section with type string"/>
  </doc>
  <settings>
    <dl_settings>
      <dl_settings name="Buzzer">
        <dl_setting var="buzzer_tunes_tune" min="0" max="16" step="1" values="Stop|Startup|Ode to Joy|Twinkle|Italy|Netherlands|France|Happy Birthday|Mushroom Song|Nokia|Fur Elise|La Cucaracha|William Tell|Star Song|Custom 1|Custom 2|Custom 3" shortname="tune" type="uint8_t" module="sound/buzzer_tunes" handler="play"/>
        <dl_setting var="buzzer_tunes_events_on" min="0" max="1" step="1" values="OFF|ON" shortname="event_tunes" type="uint8_t" module="sound/buzzer_tunes" handler="set_events"/>
      </dl_settings>
    </dl_settings>
  </settings>
  <header>
    <file name="buzzer_tunes.h"/>
  </header>
  <init fun="buzzer_tunes_init()"/>
  <periodic fun="buzzer_tunes_periodic()" freq="100"/>
  <makefile target="ap">
    <configure name="BUZZER_TIM" default="TIM2" case="upper"/>
    <define name="STM32_PWM_USE_$(BUZZER_TIM)" cond="ifeq ($(RTOS),chibios)"/>
    <file name="buzzer_tunes.c"/>
    <file_arch name="buzzer_arch.c"/>
    <test firmware="rotorcraft">
      <define name="BUZZER_TUNES_ALERT" value="false"/>
      <define name="BUZZER_TUNES_ARMED_TUNE" value="BUZZER_TUNES_STARTUP"/>
    </test>
  </makefile>
</module>