2019-08-12 16:18:08 +01:00
|
|
|
/*
|
2019-10-27 10:13:24 +00:00
|
|
|
xdrv_24_Buzzer.ino - buzzer support for Tasmota
|
2019-08-12 16:18:08 +01:00
|
|
|
|
2019-12-31 13:23:34 +00:00
|
|
|
Copyright (C) 2020 Theo Arends
|
2019-08-12 16:18:08 +01:00
|
|
|
|
|
|
|
This program is free software: you can redistribute it and/or modify
|
|
|
|
it under the terms of the GNU General Public License as published by
|
|
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
|
|
(at your option) any later version.
|
|
|
|
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
GNU General Public License for more details.
|
|
|
|
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifdef USE_BUZZER
|
|
|
|
/*********************************************************************************************\
|
|
|
|
* Buzzer support
|
|
|
|
\*********************************************************************************************/
|
2019-08-13 15:10:47 +01:00
|
|
|
|
2019-08-12 16:18:08 +01:00
|
|
|
#define XDRV_24 24
|
|
|
|
|
|
|
|
struct BUZZER {
|
|
|
|
uint32_t tune = 0;
|
|
|
|
bool active = true;
|
|
|
|
bool enable = false;
|
|
|
|
uint8_t inverted = 0; // Buzzer inverted flag (1 = (0 = On, 1 = Off))
|
|
|
|
uint8_t count = 0; // Number of buzzes
|
|
|
|
uint8_t set[2];
|
|
|
|
uint8_t duration;
|
|
|
|
uint8_t state = 0;
|
2019-08-13 15:10:47 +01:00
|
|
|
} Buzzer;
|
2019-08-12 16:18:08 +01:00
|
|
|
|
|
|
|
/*********************************************************************************************/
|
|
|
|
|
2019-10-12 10:06:09 +01:00
|
|
|
void BuzzerOff(void)
|
|
|
|
{
|
2019-12-18 17:21:10 +00:00
|
|
|
DigitalWrite(GPIO_BUZZER, Buzzer.inverted); // Buzzer Off
|
2019-10-12 10:06:09 +01:00
|
|
|
}
|
|
|
|
|
2019-08-12 16:18:08 +01:00
|
|
|
//void BuzzerBeep(uint32_t count = 1, uint32_t on = 1, uint32_t off = 1, uint32_t tune = 0);
|
|
|
|
void BuzzerBeep(uint32_t count, uint32_t on, uint32_t off, uint32_t tune)
|
|
|
|
{
|
2019-10-15 15:23:37 +01:00
|
|
|
Buzzer.set[0] = off; // off duration in 100 mSec steps
|
|
|
|
Buzzer.set[1] = on; // on duration in 100 mSec steps
|
2019-08-13 15:10:47 +01:00
|
|
|
Buzzer.duration = 1; // Start buzzer on first step
|
|
|
|
Buzzer.tune = 0;
|
2019-08-13 10:40:34 +01:00
|
|
|
if (tune) {
|
|
|
|
uint32_t tune1 = tune;
|
|
|
|
uint32_t tune2 = tune;
|
|
|
|
for (uint32_t i = 0; i < 32; i++) {
|
|
|
|
if (!(tune2 & 0x80000000)) {
|
|
|
|
tune2 <<= 1; // Skip leading silence
|
|
|
|
} else {
|
2019-08-13 15:10:47 +01:00
|
|
|
Buzzer.tune <<= 1; // Add swapped tune
|
|
|
|
Buzzer.tune |= tune1 & 1;
|
2019-08-13 10:40:34 +01:00
|
|
|
tune1 >>= 1;
|
|
|
|
}
|
|
|
|
}
|
2019-08-13 15:10:47 +01:00
|
|
|
Buzzer.count = 1; // Allow tune only once
|
2019-08-12 17:20:32 +01:00
|
|
|
} else {
|
2019-08-13 15:10:47 +01:00
|
|
|
Buzzer.count = count * 2; // Start buzzer
|
2019-08-12 17:20:32 +01:00
|
|
|
}
|
2019-08-12 16:18:08 +01:00
|
|
|
|
2019-08-13 15:10:47 +01:00
|
|
|
AddLog_P2(LOG_LEVEL_DEBUG, PSTR("BUZ: %d(%d),%d,%d,0x%08X(0x%08X)"), count, Buzzer.count, on, off, tune, Buzzer.tune);
|
2019-08-12 16:18:08 +01:00
|
|
|
|
2019-10-12 10:06:09 +01:00
|
|
|
Buzzer.enable = (Buzzer.count > 0);
|
|
|
|
if (!Buzzer.enable) {
|
|
|
|
BuzzerOff();
|
|
|
|
}
|
2019-08-12 16:18:08 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
void BuzzerBeep(uint32_t count) {
|
|
|
|
BuzzerBeep(count, 1, 1, 0);
|
|
|
|
}
|
|
|
|
|
2019-10-15 15:23:37 +01:00
|
|
|
void BuzzerEnabledBeep(uint32_t count, uint32_t duration)
|
2019-08-12 16:18:08 +01:00
|
|
|
{
|
2019-11-03 12:51:22 +00:00
|
|
|
if (Settings.flag3.buzzer_enable) { // SetOption67 - Enable buzzer when available
|
2019-10-15 15:23:37 +01:00
|
|
|
BuzzerBeep(count, duration, 1, 0);
|
2019-08-12 16:18:08 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/*********************************************************************************************/
|
|
|
|
|
2019-08-13 16:33:35 +01:00
|
|
|
bool BuzzerPinState(void)
|
2019-08-12 16:18:08 +01:00
|
|
|
{
|
|
|
|
if (XdrvMailbox.index == GPIO_BUZZER_INV) {
|
2019-08-13 15:10:47 +01:00
|
|
|
Buzzer.inverted = 1;
|
2019-08-12 16:18:08 +01:00
|
|
|
XdrvMailbox.index -= (GPIO_BUZZER_INV - GPIO_BUZZER);
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
void BuzzerInit(void)
|
|
|
|
{
|
|
|
|
if (pin[GPIO_BUZZER] < 99) {
|
|
|
|
pinMode(pin[GPIO_BUZZER], OUTPUT);
|
2019-10-12 10:06:09 +01:00
|
|
|
BuzzerOff();
|
2019-08-12 16:18:08 +01:00
|
|
|
} else {
|
2019-08-13 15:10:47 +01:00
|
|
|
Buzzer.active = false;
|
2019-08-12 16:18:08 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
void BuzzerEvery100mSec(void)
|
|
|
|
{
|
2019-08-13 15:10:47 +01:00
|
|
|
if (Buzzer.enable) {
|
|
|
|
if (Buzzer.count) {
|
|
|
|
if (Buzzer.duration) {
|
|
|
|
Buzzer.duration--;
|
|
|
|
if (!Buzzer.duration) {
|
|
|
|
if (Buzzer.tune) {
|
|
|
|
Buzzer.state = Buzzer.tune & 1;
|
|
|
|
Buzzer.tune >>= 1;
|
2019-08-12 17:20:32 +01:00
|
|
|
} else {
|
2019-08-13 15:10:47 +01:00
|
|
|
Buzzer.count--;
|
|
|
|
Buzzer.state = Buzzer.count & 1;
|
2019-08-12 17:20:32 +01:00
|
|
|
}
|
2019-08-13 15:10:47 +01:00
|
|
|
Buzzer.duration = Buzzer.set[Buzzer.state];
|
2019-08-12 16:18:08 +01:00
|
|
|
}
|
|
|
|
}
|
2019-12-18 17:21:10 +00:00
|
|
|
DigitalWrite(GPIO_BUZZER, (Buzzer.inverted) ? !Buzzer.state : Buzzer.state);
|
2019-08-12 16:18:08 +01:00
|
|
|
} else {
|
2019-08-13 15:10:47 +01:00
|
|
|
Buzzer.enable = false;
|
2019-08-12 16:18:08 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/*********************************************************************************************\
|
|
|
|
* Commands
|
|
|
|
\*********************************************************************************************/
|
|
|
|
|
|
|
|
const char kBuzzerCommands[] PROGMEM = "|" // No prefix
|
|
|
|
"Buzzer" ;
|
|
|
|
|
|
|
|
void (* const BuzzerCommand[])(void) PROGMEM = {
|
|
|
|
&CmndBuzzer };
|
|
|
|
|
|
|
|
void CmndBuzzer(void)
|
|
|
|
{
|
2019-08-13 13:52:46 +01:00
|
|
|
// Buzzer <number of beeps>,<duration of beep in 100mS steps>,<duration of silence in 100mS steps>,<tune>
|
2019-08-12 16:18:08 +01:00
|
|
|
// All parameters are optional
|
|
|
|
//
|
2019-08-12 17:20:32 +01:00
|
|
|
// Buzzer = Buzzer 1,1,1 = Beep once with both duration and pause set to 100mS
|
2019-10-12 10:06:09 +01:00
|
|
|
// Buzzer 0 = Stop active beep cycle
|
2019-08-12 17:20:32 +01:00
|
|
|
// Buzzer 2 = Beep twice with duration 200mS and pause 100mS
|
|
|
|
// Buzzer 2,3 = Beep twice with duration 300mS and pause 100mS
|
|
|
|
// Buzzer 2,3,4 = Beep twice with duration 300mS and pause 400mS
|
2019-08-13 10:40:34 +01:00
|
|
|
// Buzzer 2,3,4,0xF54 = Beep a sequence once indicated by 0xF54 = 1111 0101 01 with duration 300mS and pause 400mS
|
2019-08-12 16:18:08 +01:00
|
|
|
|
|
|
|
if (XdrvMailbox.data_len > 0) {
|
2019-10-12 10:06:09 +01:00
|
|
|
if (XdrvMailbox.payload > 0) {
|
|
|
|
uint32_t parm[4] = { 0 };
|
2020-01-22 10:55:48 +00:00
|
|
|
ParseParameters(4, parm);
|
2019-10-12 10:06:09 +01:00
|
|
|
for (uint32_t i = 0; i < 3; i++) {
|
|
|
|
if (parm[i] < 1) { parm[i] = 1; } // Default Count, On time, Off time
|
|
|
|
}
|
|
|
|
BuzzerBeep(parm[0], parm[1], parm[2], parm[3]);
|
|
|
|
} else {
|
|
|
|
BuzzerBeep(0);
|
2019-08-12 16:18:08 +01:00
|
|
|
}
|
|
|
|
} else {
|
|
|
|
BuzzerBeep(1);
|
|
|
|
}
|
|
|
|
ResponseCmndDone();
|
|
|
|
}
|
|
|
|
|
|
|
|
/*********************************************************************************************\
|
|
|
|
* Interface
|
|
|
|
\*********************************************************************************************/
|
|
|
|
|
|
|
|
bool Xdrv24(uint8_t function)
|
|
|
|
{
|
|
|
|
bool result = false;
|
|
|
|
|
2019-08-13 15:10:47 +01:00
|
|
|
if (Buzzer.active) {
|
2019-08-12 16:18:08 +01:00
|
|
|
switch (function) {
|
|
|
|
case FUNC_EVERY_100_MSECOND:
|
|
|
|
BuzzerEvery100mSec();
|
|
|
|
break;
|
|
|
|
case FUNC_COMMAND:
|
|
|
|
result = DecodeCommand(kBuzzerCommands, BuzzerCommand);
|
|
|
|
break;
|
|
|
|
case FUNC_PRE_INIT:
|
|
|
|
BuzzerInit();
|
|
|
|
break;
|
|
|
|
case FUNC_PIN_STATE:
|
|
|
|
result = BuzzerPinState();
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return result;
|
|
|
|
}
|
|
|
|
|
|
|
|
#endif // USE_BUZZER
|