Implemented tone and noTone; fixes #980

[PilnyTomas]

Issue #980 requested tone to be implemented.
tone in Arduino documentation
noTone in Arduino documentation

Summary

This PR provides new implementation of functions tone and noTone to be used with esp32.

Impact

New functions are written with almost the same API as Arduino original functions. This implementation adds the option to change duty (default is 50% the same as in Arduino).

Closes #980

[SuGlider]

@PilnyTomas - will you also implement the Queue mode to this PR, in order to allow tone() to run in background in a separated task, as @me-no-dev suggested?

[PilnyTomas]

Yeah, I can do that...

[P-R-O-C-H-Y]

PTAL

[luc-github]

Sorry to ask, may be I misunderstood something - I see channel must be done manually before calling tone(...) using void setToneChannel(uint8_t channel = 0); as by default channel is 0 static uint8_t _channel = 0; and do not change unless void setToneChannel(uint8_t channel = 0); what ever the pin is used.

Any reason not to set channel according pin number when calling tone(...) as it is defined here:
https://github.com/espressif/arduino-esp32/blob/master/tools/sdk/esp32/include/driver/include/driver/adc.h#L23

Sorry if it is stupid question

[PilnyTomas]

Hi, the channel can be ignored altogether- it is preset by default to 0, but you can, if you want, change it with the setToneChannel. Calling the function without a parameter will set the channel to default zero.
setToneChannel(); // will set to 0
The tone is not using ADC, it is using PWM (see LED Control in IDF and LED Control in Arduino-ESP32).
The PWM channel is independent of a pin so you can really create any permutation of pin x channel.
This implementation simply provides same API as Arduino tone() and noTone(). The intention is to be compatible with Arduino standard functions. The tone is unfortunately limited to one channel at a time.
If you want really want to take advantage of ESP32 I suggest taking look at the mentioned LED Control in Arduino-ESP32 - you will be able to use all the channels in parallel.

[luc-github]

ok understood - thank you for the clarification ^_^

[TS6000]

Hello
I have big problems on UART2.
Since the change from 1.xx to 2.02 data is lost.
I work with Arduino Studio.

I use UART2 with the pins (GPIO) 12 and 13

Torsten

[SuGlider]

Hello
I have big problems on UART2.
Since the change from 1.xx to 2.02 data is lost.
I work with Arduino Studio.

I use UART2 with the pins (GPIO) 12 and 13

Torsten

Please open a new issue, with more details and a sketch that demonstrate the issue.

[SrGalindo]

Is there any example on how to use this new Tone library? I can't make it work.
Thanks.

[SuGlider]

@SrGalindo - https://www.arduino.cc/reference/en/language/functions/advanced-io/tone/ has a lot of examples linked at the end of the web page.

This example is nice: https://www.arduino.cc/en/Tutorial/BuiltInExamples/toneMelody

[SrGalindo]

@SrGalindo - https://www.arduino.cc/reference/en/language/functions/advanced-io/tone/ has a lot of examples linked at the end of the web page.

This example is nice: https://www.arduino.cc/en/Tutorial/BuiltInExamples/toneMelody

@SuGlider I've started with that example in my esp8266 without problem, although using it in my ESP32 it doesn't work, that's why I was looking for some example of this tone library for ESP32. If I'm not wrong I think is not as easy as tone(pin,frequenzy,duration).
Thanks

[SuGlider]

Yes, it is as simples as tone(pin, freq, duration);
I tested the Melody example directly from Arduino IDE -> Menu -> File -> Examples -> 02 Digital -> toneMelody
It worked fine, just had to setup the pin.

What exactly do you see as issue?

[SuGlider]

Working Example:

Connection:
ESP32 PIN 4 ---> (+) Buzzer ---> GND

/*
  This example code is in the public domain.

  https://www.arduino.cc/en/Tutorial/BuiltInExamples/toneMelody
*/

#include "pitches.h"

#define TONE_PIN 4

// notes in the melody:
int melody[] = {
  NOTE_C4, NOTE_G3, NOTE_G3, NOTE_A3, NOTE_G3, 0, NOTE_B3, NOTE_C4
};

// note durations: 4 = quarter note, 8 = eighth note, etc.:
int noteDurations[] = {
  4, 8, 8, 4, 4, 4, 4, 4
};

void setup() {
  // iterate over the notes of the melody:
  for (int thisNote = 0; thisNote < 8; thisNote++) {

    // to calculate the note duration, take one second divided by the note type.
    //e.g. quarter note = 1000 / 4, eighth note = 1000/8, etc.
    int noteDuration = 1000 / noteDurations[thisNote];
    tone(TONE_PIN, melody[thisNote], noteDuration);

    // to distinguish the notes, set a minimum time between them.
    // the note's duration + 30% seems to work well:
    int pauseBetweenNotes = noteDuration * 1.30;
    delay(pauseBetweenNotes);
    // stop the tone playing:
    noTone(TONE_PIN);
  }
}

void loop() {
  // no need to repeat the melody.
}