Using a buzzer with ESPEasy

Sometimes we need our ESPEasy-based project to generate sound alerts, for warnings, alarms, confirmation of certain actions, or other reasons. In this article, we will see, step by step, how we can add a buzzer to our project with ESPEasy.

In this case, let's do the example with the CO2 meter I published a few days ago, but the same can be done with any other type of project..

Because ESPEasy allows you to connect to our project many different accessories without having to program or complicate our lives. with firmware modifications or adaptations, adding a buzzer is trivial.

Connection of the buzzer module

In this case, we are going to use a buzzer module, one of those that come on a small board with its transistor and resistor.

Connecting the module is extremely easy, we only need to make three connections:

• Positive wire, from the Vin pin of the NodeMCU to the pin marked as positive on the buzzer module (normally marked VCC).
• Negative wire, from the GND pin of the NodeMCU to the pin marked as positive on the buzzer module.
• Data cable, from a NodeMCU Input/Output pin to the buzzer signal input pin (usually marked I/O).

In this example we are going to use the D6 output of the NodeMCU, although we could use another one.

Use and control of the buzzer with ESPEasy

The first thing to know is that to use a buzzer with ESPEasy we do not need to create a device. The control is done directly through the commands that ESPEasy has available:

Protocol	Syntax	Additional information
HTTP	http:///control?cmd=	Sends commands via HTTP protocol.
MQTT	/cmd with payload:	Sends commands via MQTT protocol.
Serial (TTL)		Send commands using the serial port (RX/TX). Simply type the
UDP	SendTo,,	Sends commands from one ESP Easy unit to another. Configures the ESP Easy controller's peer-to-peer UDP server first.
Rules		Internally within ESP Easy. Simply enter the   in an event block or conditional block.

We have two possibilitieswhen sending commands to ESPEasy to sound our buzzer. The command tone and the command rtttl.

Playing a sound

http:///control?cmd=tone,14,1300,200

Plays a 1300 Hz tone for 200 ms on the GPIO-14 pin.

Command (GPIO/Value)	Additional information
tone,,,. GPIO: 12 ... 16 Tone: 20 ... 13000 Hz Duration: 100 ... 15000 msec	Try to use GPIO 12...16 as these are usually not used by the ESO internal functions. The recommended tone range is 20 Hz ... 13 kHz. It is possible to generate tones up to 40 kHz but they are inaudible to humans. Frequencies above 30 kHz are not stable and may block the ESP. The duration is given in milliseconds. Note: Tones with a duration of less than 50 msec temporarily block the ESP. Longer duration tones are created by timer, which may cause changes in duration.
rtttl,,. GPIO: 12 ... 16 Value: d=,o=,b=,,o=,b=,	Try to use GPIO 12...16 as these are not normally used by the ESO's internal functions. N.B. the tones temporarily block the ESP while sounding. Value can be defined as . For example: rtttl,14,test:d=8,o=5,b=180,c6,b,c6,p,g,g- More RTTTL Ringtone Downloads

Play a melody

http:///control?cmd=rtttl,14:d=4,o=5,b=112:8a,8a,a,8a,8a,a,8a,8c6,8f.,16g,2a,8a-,8a-,8a-.,16a-,8a-,8a,8a.,16a,8a,8g,8g,8a,g,c6

This plays a tune via RTTTL on the GPIO-14 pin.

RTTTL is a musical notation designed to create ringtones for old mobile phones. RTTTL libraries exist, so it will not be difficult to find your favourite music or, if you have musical notions, to create your own.

RTTTL (Ringtone Transfer Language [Text]) was developed by Nokia to play more "easy-to-listen-to" melodies as ringtones for mobile phones. The melodies for all features are created using three different commands:

d - duration
o - octave
b - tempo (rhythm)

After that, the actual pitch is created using standard notes (a, b, c, d, e, f and g), before the note the duration is set, after the note the octave is set:

.

To compose a melody, notes are separated by a comma.

Examples of using the buzzer with ESPEasy

Here are some simple examples of how to use the buzzer with the different protocols.

The command we have to send is similar in all cases:

To play a note: tone,14,1300,200

Para reproducir una melodía: rtttl,14:d=4,o=5,b=112:8a,8a,a,8a,8a,a,8a,8c6,8f.,16g,2a,8a-,8a-,8a-.,16a-,8a-,8a,8a.,16a,8a,8g,8g,8a,g,c6

Use of the buzzer via HTTP

http:///control?cmd=tone,14,1300,200

http:///control?cmd=rtttl,14:d=4,o=5,b=112:8a,8a,a,8a,8a,a,8a,8c6,8f.,16g,2a,8a-,8a-,8a-.,16a-,8a-,8a,8a.,16a,8a,8g,8g,8a,g,c6

Use of the buzzer via MQTT

Use of the buzzer by rules (ESPEasy Rules)

To play a melody at ESPEasy start-up:

On System#Boot do
  rtttl,14:d=10,o=6,b=180,c,e,g
endon

Integration with CO2 meter

We are going to use what we have learned to create a system of warnings, or alarms, for our CO2 meter.

By means of rules, the meter will play a warning and/or alarm sound when certain CO2 concentrations are reached.

To do so, we will make use of the ESPEasy rules.

Activating the ESPEasy rules engine

The first thing to do is to activate the ESPEasy rules engineThe default, when we install it, will be disabled.

To do this, go to the tab "Tools(Tools) and click on the button " ".Advanced"(Advanced):

The ESPEasy advanced configuration options window will open.

There we have to activate the options "Rules"(Rules) and "Old Engine"(Old Engine):

Writing our rules

Finally, we have to write our rules, in the "Rules" tab. This tab will not appear until we have enabled the rules engine, as we have seen in the previous point:

In the rule editor that appears in ESPEasy, we will write the following rules (I recommend copying and pasting, to avoid errors and leave comments - lines starting with // - which ESPEasy will ignore).

You will need to replace CO2#PPM with your chosen device name and value (in the "Devices" tab):

// We set a minimum time for the alarm to repeat, so that the alarm is repeated,
// is not continuously beeping if the CO2 concentration value is exceeded.
// Create a timer to run every second

On System#Boot do
  Let,1,60 // Minimum time, in seconds, to repeat the alarm
  Let,2,1500 // CO2 concentration to trigger alarm
  loopTimerSet,8,1 // Set a timer to run every second
EndOn

// This timer runs every second
// Decrements the time remaining to activate the alarm by one second.
// It will set a timer again

On Rules#Timer=8 Do
  Let,1,[var#1]-1
EndOn

// Each time the PPM value of the CO2 device changes:
// We check that the CO2 value is higher than the concentration at
// from which we want the alarm to go off and the time has passed
// minimum time we want before the alarm sounds.
// If the PPM concentration is higher and the minimum time has elapsed:
// We sound the buzzer connected to the GPIO-12 pin at 1000 Hz.
// for 60 milliseconds.
// We set the minimum time we want the alarm to be repeated.

on CO2#PPM do
  if [CO2#PPM] > [var#2] and [var#1] < 1
    tone,12,1000,60
    Let,1,60 // Time to repeat alarm again
  endif
endon

Buy the buzzer

I recommend you buy the passive buzzer moduleThis allows you to play the tones you want (beeps or melodies). For example, this one:

If you prefer to buy it on AliExpress, cheaper, even if it takes a little longer to reach you, you can buy the buzzer at this link.

Be careful not to get confused and buy a module active buzzerif that's not what you want. With an active buzzer You will only be able to play the factory default tone and will not be able to play melodies.. It is not easy to differentiate at first glance because the board is the same as that of a passive buzzer module.

Don't get confused and buy a buzzer module that doesn't have the necessary components (transistor and resistor, at least).

The NodeMCU does not have enough output current for it.

It has to be a passive buzzer module (a component board, as in the connection example or similar).

High or low level buzzer

Logic tells us that when we give voltage to the signal pin of the buzzer module, it should sound and when we remove it, it should stop sounding (high level control), but this is not always the case. There are buzzer modules (many) that work by low level.The signal pins are silent, i.e. they ring when there is no voltage on the signal pin and are silent when there is voltage on the signal pin.

Checking this is very easy. Just go to connect GND and VCC (without connecting the signal pin) and if it buzzes non-stop, the module is active low (and if you connect the buzzer module signal pin to VCC it should be muted).

This should be borne in mind, since in many cases the rules will have to be adapted for it to work properly.