projects/awtrix-light
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

release

Browse Source
This commit is contained in:
Stephan Mühl
2023-03-22 12:15:18 +01:00
committed by GitHub
parent 3e12414a87
commit adb5102869
203 changed files with 35010 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.gitattributes vendored Normal file
View File

@@ -0,0 +1,2 @@
# Auto detect text files and perform LF normalization
* text=auto

6
.gitignore vendored Normal file
View File

@@ -0,0 +1,6 @@
.pio
.vscode/.browse.c_cpp.db*
.vscode/c_cpp_properties.json
.vscode/launch.json
.vscode/ipch
/Tools

39
Shares.md Normal file
View File

@@ -0,0 +1,39 @@
**Adafruit_SHT31**
https://github.com/adafruit/Adafruit_SHT31
https://github.com/adafruit/Adafruit_SHT31/blob/master/license.txt
**Arduino JSON**
https://github.com/bblanchon/ArduinoJson
https://github.com/bblanchon/ArduinoJson/blob/6.x/LICENSE.txt
**EasyButton**
https://github.com/evert-arias/EasyButton
https://github.com/evert-arias/EasyButton/blob/main/LICENSE
**FastLED**
https://github.com/FastLED/FastLED
https://github.com/FastLED/FastLED/blob/master/LICENSE
**FastLED NeoMatrix**
https://github.com/marcmerlin/FastLED_NeoMatrix
https://github.com/marcmerlin/FastLED_NeoMatrix/blob/master/COPYING
**pubsubclient**
https://github.com/knolleary/pubsubclient
https://github.com/knolleary/pubsubclient/blob/master/LICENSE.txt
**ESP32-audioI2S**
https://github.com/schreibfaul1/ESP32-audioI2S
https://github.com/schreibfaul1/ESP32-audioI2S/blob/master/
**GifPLayer (Highly customized by me)**
https://github.com/pixelmatix/aurora
https://github.com/pixelmatix/aurora/blob/master/LICENSE.txt
**Melody Player (Customized by me)**
https://github.com/fabianoriccardi/melody-player
https://github.com/fabianoriccardi/melody-player/blob/main/LICENSE
**TJpg_Decoder (Customized by me)**
https://github.com/Bodmer/TJpg_Decoder
https://github.com/Bodmer/TJpg_Decoder/blob/master/license.txt
**LDR**
https://github.com/QuentinCG/Arduino-Light-Dependent-Resistor-Library
https://github.com/QuentinCG/Arduino-Light-Dependent-Resistor-Library/blob/master/LICENSE.md
**Homeassistant integration (Customized by me)**
https://github.com/dawidchyrzynski/arduino-home-assistant
https://github.com/dawidchyrzynski/arduino-home-assistant/blob/main/LICENSE
**Webserver (Highly customized by me)**
https://github.com/cotestatnt/esp-fs-webserver
https://github.com/cotestatnt/esp-fs-webserver/blob/master/LICENSE

5
awtrix_partition.csv Normal file
View File

@@ -0,0 +1,5 @@
nvs, data, nvs, 0x9000, 0x5000,
otadata, data, ota, 0xe000, 0x2000,
app0, app, ota_0, 0x10000, 0x1D0000,
app1, app, ota_1, 0x1F0000,0x1D0000,
spiffs, data, spiffs, 0x3C0000,0x40000,
1 nvs data nvs 0x9000 0x5000
2 otadata data ota 0xe000 0x2000
3 app0 app ota_0 0x10000 0x1D0000
4 app1 app ota_1 0x1F0000 0x1D0000
5 spiffs data spiffs 0x3C0000 0x40000

203
lib/LightResistor/LightDependentResistor.cpp Normal file
View File

@@ -0,0 +1,203 @@
/*
* \brief Get light intensity value (Lux & FootCandles) from Light dependent Resistor (implementation)
*
* \author Quentin Comte-Gaz <quentin@comte-gaz.com>
* \date 30 January 2023
* \license MIT License (contact me if too restrictive)
* \copyright Copyright (c) 2023 Quentin Comte-Gaz
* \version 1.4
*/
#include "LightDependentResistor.h"
LightDependentResistor::LightDependentResistor(int pin, unsigned long other_resistor, ePhotoCellKind kind, unsigned int adc_resolution_bits, unsigned int smoothing_history_size) :
_pin (pin),
_other_resistor (other_resistor),
_mult_value(32017200),
_pow_value(1.5832),
_photocell_on_ground (true),
_adc_resolution_bits(adc_resolution_bits),
_smoothing_sum(0.0f),
_smoothing_history_size(smoothing_history_size),
_smoothing_history_next(0),
_smoothing_history_values(new float[smoothing_history_size])
{
switch (kind)
{
case GL5516:
_mult_value = 29634400;
_pow_value = 1.6689;
break;
case GL5537_1:
_mult_value = 32435800;
_pow_value = 1.4899;
break;
case GL5537_2:
_mult_value = 2801820;
_pow_value = 1.1772;
break;
case GL5539:
_mult_value = 208510000;
_pow_value = 1.4850;
break;
case GL5549:
_mult_value = 44682100;
_pow_value = 1.2750;
break;
case GL5528:
default:
_mult_value = 32017200;
_pow_value = 1.5832;
}
for (unsigned int i = 0 ; i < _smoothing_history_size ; i++)
{
// We initialize the values as impossible value (lux can't be negative)
_smoothing_history_values[i] = -1.0f;
}
}
LightDependentResistor::LightDependentResistor(int pin, unsigned long other_resistor, float mult_value, float pow_value, unsigned int adc_resolution_bits, unsigned int smoothing_history_size) :
_pin (pin),
_other_resistor (other_resistor),
_mult_value (mult_value),
_pow_value (pow_value),
_photocell_on_ground (true),
_adc_resolution_bits(adc_resolution_bits),
_smoothing_sum(0.0f),
_smoothing_history_size(smoothing_history_size),
_smoothing_history_next(0),
_smoothing_history_values(new float[smoothing_history_size])
{
for (unsigned int i = 0 ; i < _smoothing_history_size ; i++)
{
// We initialize the values as impossible value (lux can't be negative)
_smoothing_history_values[i] = -1.0f;
}
}
LightDependentResistor::~LightDependentResistor()
{
// De-allocate the table at the end of the use of the class
delete[] _smoothing_history_values;
}
void LightDependentResistor::updatePhotocellParameters(float mult_value, float pow_value)
{
_mult_value = mult_value;
_pow_value = pow_value;
}
float LightDependentResistor::luxToFootCandles(float intensity_in_lux)
{
return intensity_in_lux/10.764;
}
float LightDependentResistor::footCandlesToLux(float intensity_in_footcandles)
{
return 10.764*intensity_in_footcandles;
}
void LightDependentResistor::setPhotocellPositionOnGround(bool on_ground)
{
_photocell_on_ground = on_ground;
}
int LightDependentResistor::getCurrentRawAnalogValue() const
{
// Analog resolution setter is not handled on all boards (not compatible boards: MEGA, ESP8266, Uno)
#if !defined(__AVR_ATmega1280__) && !defined(__AVR_ATmega2560__) && !defined(ESP8266) && !defined(__AVR_ATmega328P__) && !defined(__AVR_ATmega168__)
analogReadResolution(_adc_resolution_bits);
#endif
return analogRead(_pin);
}
float LightDependentResistor::rawAnalogValueToLux(int raw_analog_value) const
{
unsigned long photocell_resistor;
if (pow(2, _adc_resolution_bits) == raw_analog_value)
{
raw_analog_value--;
}
float ratio = ((float)pow(2, _adc_resolution_bits) / (float)raw_analog_value) - 1;
if (_photocell_on_ground)
{
photocell_resistor = _other_resistor / ratio;
}
else
{
photocell_resistor = _other_resistor * ratio;
}
return _mult_value / (float)pow(photocell_resistor, _pow_value);
}
float LightDependentResistor::getCurrentLux() const
{
return rawAnalogValueToLux(getCurrentRawAnalogValue());
}
float LightDependentResistor::getCurrentFootCandles() const
{
return luxToFootCandles(getCurrentLux());
}
float LightDependentResistor::getSmoothedLux()
{
float sumResult = 0;
if (_smoothing_history_size == 0)
{
// Smoothing disabled, return current value.
sumResult = getCurrentLux();
}
else
{
if (_smoothing_history_values[_smoothing_history_next] < -0.1f)
{
// Smoothing enabled but not all values are filled yet
// (Let's fill one more)
_smoothing_history_values[_smoothing_history_next] = getCurrentLux();
_smoothing_sum += _smoothing_history_values[_smoothing_history_next];
if (_smoothing_history_next < _smoothing_history_size - 1)
{
// Still not all buffers filled
_smoothing_history_next++;
sumResult = _smoothing_sum / _smoothing_history_next;
}
else
{
// All buffers filled now, start regular operation
_smoothing_history_next = 0;
sumResult = _smoothing_sum / _smoothing_history_size;
}
}
else
{
// Smoothing enabled and buffer filled previously.
// => Regular operation from now on:
// Replace previous value by the new one (from buffer and sum)
_smoothing_sum -= _smoothing_history_values[_smoothing_history_next];
_smoothing_history_values[_smoothing_history_next] = getCurrentLux();
_smoothing_sum += _smoothing_history_values[_smoothing_history_next];
// Update next value tu acquire
_smoothing_history_next = (_smoothing_history_next < _smoothing_history_size - 1) ? _smoothing_history_next + 1 : 0;
sumResult = _smoothing_sum / _smoothing_history_size;
}
}
return sumResult;
}
float LightDependentResistor::getSmoothedFootCandles()
{
return luxToFootCandles(getSmoothedLux());
}

196
lib/LightResistor/LightDependentResistor.h Normal file
View File

@@ -0,0 +1,196 @@
/*
* \brief Get light intensity value (Lux & FootCandles) from Light dependent Resistor (LDR) a.k.a. photocell or photoresistor
*
* This library is easily usable with most GL55xx photoresistors (at ~25°C).
*
* It is also possible to use it with any other photocell (with the right parameters).
* If you use this library with other photocells, please send me the parameters in
* order to add them in the list.
*
* Schematics:
* ^
* _____ ___/___
* 5V |---|_____|----|__/____|--| GND
* or Other /
* 3.3V Resistor Photocell
*
* Note: By default, the photocell must be on the ground.
* It is possible to exchange the position of the photocell and the other resistor
* but you will have to call \p setPhotocellPositionOnGround(false).
*
* \author Quentin Comte-Gaz <quentin@comte-gaz.com>
* \date 30 January 2023
* \license MIT License (contact me if too restrictive)
* \copyright Copyright (c) 2023 Quentin Comte-Gaz
* \version 1.4
*/
#ifndef LightDependentResistor_h
#define LightDependentResistor_h
#if defined(ARDUINO) && ARDUINO >= 100
#include "Arduino.h"
#else
#include "WProgram.h"
#endif
class LightDependentResistor
{
public:
/*!
* \enum ePhotoCellKind Photocell component
*/
enum ePhotoCellKind {
GL5516,
GL5528,
GL5537_1,
GL5537_2,
GL5539,
GL5549
};
/*!
* \brief LightDependentResistor Initialize the light intensity getter class
*
* \param pin (int) Analog pin connected to the voltage divider
* \param other_resistor (unsigned long) Resistor used for the voltage divider
* \param kind (ePhotoCellKind) Used photocell
* \param adc_resolution_bits (unsigned int, optional, default: 10) Number of resolution bits for the ADC pin (more information here: https://www.arduino.cc/reference/en/language/functions/analog-io/analogread/)
* \param smoothing_history_size (unsigned int, optional, default: 10) Max number of raw values used for \f getSmoothedLux or \f getSmoothedFootCandles
*/
LightDependentResistor(int pin, unsigned long other_resistor, ePhotoCellKind kind = GL5528, unsigned int adc_resolution_bits = 10, unsigned int smoothing_history_size = 10);
/*!
* \brief LightDependentResistor Initialize the light intensity getter class
*
* Even thought some photocells are already defined, it is possible to
* define your own photocell.
* The relation between the photocell resistor and the lux intensity can be
* approximated to I[lux]=mult_value/(R[Ω]^pow_value).
*
* Example for GL5528 photocell:
* 1) Find curve Resistor->Lux intensity: http://cdn.sparkfun.com/datasheets/Sensors/LightImaging/SEN-09088.pdf
* 2) Get 2 points from the datasheet log curve: log(55000[Ω])->log(1[lux]) and log(3000[Ω])->log(100[lux])
* 3) Convert those 2 point into a "log linear curve" (with Excel for example): log(R[Ω]) = -0.6316 * log(I[lux]) + 4.7404 (linear)
* 4) Solve the equation to get I[lux]=mult_value/(R[Ω]^pow_value) approximation (with wolframalpha for example): I[lux] ~= 32017200/R[Ω]^1.5832
* https://www.wolframalpha.com/input/?i=log10(x)%3D-0.6316*log10(y)%2B4.7404
* 5) You just found the 2 parameters: mult_value=32017200 and pow_value=1.5832
*
* \param pin (int) Analog pin connected to the voltage divider
* \param other_resistor (unsigned long) Resistor used for the voltage divider
* \param mult_value (float) Multiplication parameter in "I[lux]=mult_value/(R[Ω]^pow_value)" expression
* \param pow_value (float) Power parameter in "I[lux]=mult_value/(R[Ω]^pow_value)" expression
* \param adc_resolution_bits (unsigned int, optional, default: 10) Number of resolution bits for the ADC pin (more information here: https://www.arduino.cc/reference/en/language/functions/analog-io/analogread/)
* \param smoothing_history_size (unsigned int, optional, default: 10) Max number of raw values used for \f getSmoothedLux or \f getSmoothedFootCandles
*/
LightDependentResistor(int pin, unsigned long other_resistor, float mult_value, float pow_value, unsigned int adc_resolution_bits = 10, unsigned int smoothing_history_size = 10);
~LightDependentResistor();
/*!
* \brief getCurrentLux Get light intensity (in lux) from the photocell
*
* \return (float) Light intensity (in lux)
*/
float getCurrentLux() const;
/*!
* \brief getCurrentFootCandles Get light intensity (in footcandles) from the photocell
*
* \return (float) Light intensity (in footcandles)
*/
float getCurrentFootCandles() const;
/*!
* \brief getCurrentRawAnalogValue Read light intensity from the photocell, and provide the sensor raw analogic value (not a really readable value)
*
* \return (int) Light intensity (in sensor raw analogic value), not a really readable value, prefer \f getCurrentLux or \f getCurrentFootCandles
*/
int getCurrentRawAnalogValue() const;
/*!
* \brief rawAnalogValueToLux Convert raw value from photocell sensor into lux
*
* This function is only needed if the sensor MUST NOT be handled by this library...
* Else, it is better to directly use \f getCurrentLux that will read sensor value and convert it into lux.
*
* \param raw_value (int) Analog value of the photocell sensor (WARNING: This value must be with the same adc resolution as the one in the constructor)
*
* \return (float) Light intensity (in lux)
*/
float rawAnalogValueToLux(int raw_analog_value) const;
/*!
* \brief luxToFootCandles Get footcandles from lux intensity
*
* \param intensity_in_lux (float) Intensity in lux
*
* \return Footcandles retrieved from \p intensity_in_lux
*/
static float luxToFootCandles(float intensity_in_lux);
/*!
* \brief footCandlesToLux Get Lux intensity from footcandles
*
* \param intensity_in_footcandles (float) Footcandles
*
* \return Intensity in lux retrieved from \p intensity_in_footcandles
*/
static float footCandlesToLux(float intensity_in_footcandles);
/*!
* \brief setPhotocellPositionOnGround Configure the photocell as connected to +5V/3.3V or GND
*
* \param on_ground (bool) True if the photocell is connected to GND, else false
*
* True: ^
* _____ ___/___
* 5V |---|_____|----|__/____|--| GND
* or Other /
* 3.3V Resistor Photocell
*
* False: ^
* _____ ___/___
* GND |---|_____|----|__/____|--| 5V
* Other / or
* Resistor Photocell 3.3V
*/
void setPhotocellPositionOnGround(bool on_ground);
/*!
* \brief updatePhotocellParameters Redefine the photocell parameters
*
* \param mult_value (float) Multiplication parameter in "I[lux]=mult_value/(R[Ω]^pow_value)" expression
* \param pow_value (float) Power parameter in "I[lux]=mult_value/(R[Ω]^pow_value)" expression
*/
void updatePhotocellParameters(float mult_value, float pow_value);
/*!
* \brief getSmoothedLux Read light intensity (in lux) from the photocell, apply linear smoothing using the number of historic values specified with the constructor.
*
* \return (float) Light intensity (in lux) after applying linear smoothing
*/
float getSmoothedLux();
/*!
* \brief getCurrentFootCandles Read light intensity from the photocell, apply linear smoothing using the number of historic values specified with the constructor, convert to footcandles.
*
* \return (float) Light intensity (in footcandles) after applying linear smoothing
*/
float getSmoothedFootCandles();
private:
int _pin; //!< Analog pin connected to the voltage divider
unsigned long _other_resistor; //!< Resistor used for the voltage divider
float _mult_value; //!< Multiplication parameter in "I[lux]=mult_value/(R[Ω]^pow_value)" expression
float _pow_value; //!< Power parameter in "I[lux]=mult_value/(R[Ω]^pow_value)" expression
bool _photocell_on_ground; //!< Photocell is connected to +5V/3.3V (false) or GND (true) ?
unsigned int _adc_resolution_bits; //!< Number of resolution bits for the ADC pin
float _smoothing_sum; //!< (smoothing only) Current sum of valid values of \v _smoothing_history_values
unsigned int _smoothing_history_size; //!< (smoothing only) Size of the table of values
unsigned int _smoothing_history_next; //!< (smoothing only) Next value to get/replace
float* _smoothing_history_values; //!< (smoothing only) All valid values (in lux) in a table of \v _smoothing_history_size values maximum (oldest value will be replaced by a new one if table is full)
};
#endif //LightDependentResistor_h

473
lib/MatrixUI/AwtrixFont.h Normal file
View File

@@ -0,0 +1,473 @@
/**
** The original 3x5 font is licensed under the 3-clause BSD license:
**
** Copyright 1999 Brian J. Swetland
** Copyright 1999 Vassilii Khachaturov
** Portions (of vt100.c/vt100.h) copyright Dan Marks
** Modifications for Awtrix for improved readability and LaMetric Style Copyright 2023 Blueforcer
** All rights reserved.
**
** Redistribution and use in source and binary forms, with or without
** modification, are permitted provided that the following conditions
** are met:
** 1. Redistributions of source code must retain the above copyright
** notice, this list of conditions, and the following disclaimer.
** 2. Redistributions in binary form must reproduce the above copyright
** notice, this list of conditions, and the following disclaimer in the
** documentation and/or other materials provided with the distribution.
** 3. The name of the authors may not be used to endorse or promote products
** derived from this software without specific prior written permission.
**
** THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
** IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
** OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
** IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
** INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
** NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
** THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
**
** Modifications to TomThumb for improved readability are from Robey Pointer,
** see:
** http://robey.lag.net/2010/01/23/tiny-monospace-font.html
**
** Modifications for Awtrix for improved readability and LaMetric Style are from
** Blueforcer, Yann and hollyghost
**
** The original author does not have any objection to relicensing of Robey
** Pointer's modifications (in this file) in a more permissive license. See
** the discussion at the above blog, and also here:
** http://opengameart.org/forumtopic/how-to-submit-art-using-the-3-clause-bsd-license
**
** Feb 21, 2016: Conversion from Linux BDF --> Adafruit GFX font,
** with the help of this Python script:
** https://gist.github.com/skelliam/322d421f028545f16f6d
** William Skellenger (williamj@skellenger.net)
** Twitter: @skelliam
**
*/
// AwtrixFont Version 20230215
const uint8_t AwtrixBitmaps[] PROGMEM = {
0x00, /*[0] 0x20 space */
0x80, 0x80, 0x80, 0x00, 0x80, /*[1] 0x21 exclam */
0xA0, 0xA0, /*[2] 0x22 quotedbl */
0xA0, 0xE0, 0xA0, 0xE0, 0xA0, /*[3] 0x23 numbersign */
0x60, 0xC0, 0x60, 0xC0, 0x40, /*[4] 0x24 dollar */
0xA0, 0x20, 0x40, 0x80, 0xA0, /*[5] 0x25 percent */
0xC0, 0xC0, 0xE0, 0xA0, 0x60, /*[6] 0x26 ampersand */
0x80, 0x80, /*[7] 0x27 quotesingle */
0x40, 0x80, 0x80, 0x80, 0x40, /*[8] 0x28 parenleft */
0x80, 0x40, 0x40, 0x40, 0x80, /*[9] 0x29 parenright */
0xA0, 0x40, 0xA0, /*[10] 0x2A asterisk */
0x40, 0xE0, 0x40, /*[11] 0x2B plus */
0x40, 0x80, /*[12] 0x2C comma */
0xE0, /*[13] 0x2D hyphen */
0x80, /*[14] 0x2E period */
0x20, 0x20, 0x40, 0x80, 0x80, /*[15] 0x2F slash */
0xE0, 0xA0, 0xA0, 0xA0, 0xE0, /*[16] 0x30 zero */
0x40, 0xC0, 0x40, 0x40, 0xE0, /*[17] 0x31 one */
0xE0, 0x20, 0xE0, 0x80, 0xE0, /*[18] 0x32 two */
0xE0, 0x20, 0xE0, 0x20, 0xE0, /*[19] 0x33 three */
0xA0, 0xA0, 0xE0, 0x20, 0x20, /*[20] 0x34 four */
0xE0, 0x80, 0xE0, 0x20, 0xE0, /*[21] 0x35 five */
0xE0, 0x80, 0xE0, 0xA0, 0xE0, /*[22] 0x36 six */
0xE0, 0x20, 0x20, 0x20, 0x20, /*[23] 0x37 seven */
0xE0, 0xA0, 0xE0, 0xA0, 0xE0, /*[24] 0x38 eight */
0xE0, 0xA0, 0xE0, 0x20, 0xE0, /*[25] 0x39 nine */
0x80, 0x00, 0x80, /*[26] 0x3A colon */
0x40, 0x00, 0x40, 0x80, /*[27] 0x3B semicolon */
0x20, 0x40, 0x80, 0x40, 0x20, /*[28] 0x3C less */
0xE0, 0x00, 0xE0, /*[29] 0x3D equal */
0x80, 0x40, 0x20, 0x40, 0x80, /*[30] 0x3E greater */
0xE0, 0x20, 0x40, 0x00, 0x40, /*[31] 0x3F question */
0x40, 0xA0, 0xE0, 0x80, 0x60, /*[32] 0x40 at */
0xC0, 0xA0, 0xE0, 0xA0, 0xA0, /*[33] 0x41 A */
0xC0, 0xA0, 0xC0, 0xA0, 0xC0, /*[34] 0x42 B */
0x40, 0xA0, 0x80, 0xA0, 0x40, /*[35] 0x43 C */
0xC0, 0xA0, 0xA0, 0xA0, 0xC0, /*[36] 0x44 D */
0xE0, 0x80, 0xE0, 0x80, 0xE0, /*[37] 0x45 E */
0xE0, 0x80, 0xE0, 0x80, 0x80, /*[38] 0x46 F */
0x60, 0x80, 0xA0, 0xA0, 0x60, /*[39] 0x47 G */
0xA0, 0xA0, 0xE0, 0xA0, 0xA0, /*[40] 0x48 H */
0x80, 0x80, 0x80, 0x80, 0x80, /*[41] 0x49 I */
0x20, 0x20, 0x20, 0xA0, 0x40, /*[42] 0x4A J */
0xA0, 0xA0, 0xC0, 0xA0, 0xA0, /*[43] 0x4B K */
0x80, 0x80, 0x80, 0x80, 0xE0, /*[44] 0x4C L */
0x88, 0xD8, 0xA8, 0x88, 0x88, /*[45] 0x4D M */
0x90, 0xD0, 0xB0, 0x90, 0x90, /*[46] 0x4E N */
0x40, 0xA0, 0xA0, 0xA0, 0x40, /*[47] 0x4F O */
0xE0, 0xA0, 0xC0, 0x80, 0x80, /*[48] 0x50 P */
0x40, 0xA0, 0xA0, 0xA0, 0x70, /*[49] 0x51 Q */
0xE0, 0xA0, 0xC0, 0xA0, 0xA0, /*[50] 0x52 R */
0xE0, 0x80, 0xE0, 0x20, 0xE0, /*[51] 0x53 S */
0xE0, 0x40, 0x40, 0x40, 0x40, /*[52] 0x54 T */
0xA0, 0xA0, 0xA0, 0xA0, 0xE0, /*[53] 0x55 U */
0xA0, 0xA0, 0xA0, 0xA0, 0x40, /*[54] 0x56 V */
0x88, 0x88, 0x88, 0xA8, 0x50, /*[55] 0x57 W */
0xA0, 0xA0, 0x40, 0xA0, 0xA0, /*[56] 0x58 X */
0xA0, 0xA0, 0xE0, 0x20, 0xC0, /*[57] 0x59 Y */
0xE0, 0x20, 0x40, 0x80, 0xE0, /*[58] 0x5A Z */
0xE0, 0x80, 0x80, 0x80, 0xE0, /*[59] 0x5B bracketleft */
0x80, 0x40, 0x20, /*[60] 0x5C backslash */
0xE0, 0x20, 0x20, 0x20, 0xE0, /*[61] 0x5D bracketright */
0x40, 0xA0, /*[62] 0x5E asciicircum */
0xE0, /*[63] 0x5F underscore */
0x80, 0x40, /*[64] 0x60 grave */
0xC0, 0x60, 0xA0, 0xE0, /*[65] 0x61 a */
0x80, 0xC0, 0xA0, 0xA0, 0xC0, /*[66] 0x62 b */
0x60, 0x80, 0x80, 0x60, /*[67] 0x63 c */
0x20, 0x60, 0xA0, 0xA0, 0x60, /*[68] 0x64 d */
0x60, 0xA0, 0xC0, 0x60, /*[69] 0x65 e */
0x20, 0x40, 0xE0, 0x40, 0x40, /*[70] 0x66 f */
0x60, 0xA0, 0xE0, 0x20, 0x40, /*[71] 0x67 g */
0x80, 0xC0, 0xA0, 0xA0, 0xA0, /*[72] 0x68 h */
0x80, 0x00, 0x80, 0x80, 0x80, /*[73] 0x69 i */
0x20, 0x00, 0x20, 0x20, 0xA0, 0x40, /*[74] 0x6A j */
0x80, 0xA0, 0xC0, 0xC0, 0xA0, /*[75] 0x6B k */
0xC0, 0x40, 0x40, 0x40, 0xE0, /*[76] 0x6C l */
0xE0, 0xE0, 0xE0, 0xA0, /*[77] 0x6D m */
0xC0, 0xA0, 0xA0, 0xA0, /*[78] 0x6E n */
0x40, 0xA0, 0xA0, 0x40, /*[79] 0x6F o */
0xC0, 0xA0, 0xA0, 0xC0, 0x80, /*[80] 0x70 p */
0x60, 0xA0, 0xA0, 0x60, 0x20, /*[81] 0x71 q */
0x60, 0x80, 0x80, 0x80, /*[82] 0x72 r */
0x60, 0xC0, 0x60, 0xC0, /*[83] 0x73 s */
0x40, 0xE0, 0x40, 0x40, 0x60, /*[84] 0x74 t */
0xA0, 0xA0, 0xA0, 0x60, /*[85] 0x75 u */
0xA0, 0xA0, 0xE0, 0x40, /*[86] 0x76 v */
0xA0, 0xE0, 0xE0, 0xE0, /*[87] 0x77 w */
0xA0, 0x40, 0x40, 0xA0, /*[88] 0x78 x */
0xA0, 0xA0, 0x60, 0x20, 0x40, /*[89] 0x79 y */
0xE0, 0x60, 0xC0, 0xE0, /*[90] 0x7A z */
0x60, 0x40, 0x80, 0x40, 0x60, /*[91] 0x7B braceleft */
0x80, 0x80, 0x00, 0x80, 0x80, /*[92] 0x7C bar */
0xC0, 0x40, 0x20, 0x40, 0xC0, /*[93] 0x7D braceright */
0x60, 0xC0, /*[94] 0x7E asciitilde */
0x80, 0x00, 0x80, 0x80, 0x80, /*[95] 0xA1 exclamdown */
0x40, 0xE0, 0x80, 0xE0, 0x40, /*[96] 0xA2 cent */
0x60, 0x40, 0xE0, 0x40, 0xE0, /*[97] 0xA3 sterling */
0xA0, 0x40, 0xE0, 0x40, 0xA0, /*[98] 0xA4 currency */
0xA0, 0xA0, 0x40, 0xE0, 0x40, /*[99] 0xA5 yen */
0x80, 0x80, 0x00, 0x80, 0x80, /*[100] 0xA6 brokenbar */
0x60, 0x40, 0xA0, 0x40, 0xC0, /*[101] 0xA7 section */
0xA0, /*[102] 0xA8 dieresis */
0x60, 0x80, 0x60, /*[103] 0xA9 copyright */
0x60, 0xA0, 0xE0, 0x00, 0xE0, /*[104] 0xAA ordfeminine */
0x40, 0x80, 0x40, /*[105] 0xAB guillemotleft */
0xE0, 0x20, /*[106] 0xAC logicalnot */
0xC0, /*[107] 0xAD softhyphen */
0xC0, 0xC0, 0xA0, /*[108] 0xAE registered */
0xE0, /*[109] 0xAF macron */
0xC0, 0xC0, 0x00, /*[110] 0xB0 degree */
0x40, 0xE0, 0x40, 0x00, 0xE0, /*[111] 0xB1 plusminus */
0xC0, 0x40, 0x60, /*[112] 0xB2 twosuperior */
0xE0, 0x60, 0xE0, /*[113] 0xB3 threesuperior */
0x40, 0x80, /*[114] 0xB4 acute */
0xA0, 0xA0, 0xA0, 0xC0, 0x80, /*[115] 0xB5 mu */
0x60, 0xA0, 0x60, 0x60, 0x60, /*[116] 0xB6 paragraph */
0xE0, 0xE0, 0xE0, /*[117] 0xB7 periodcentered */
0x40, 0x20, 0xC0, /*[118] 0xB8 cedilla */
0x80, 0x80, 0x80, /*[119] 0xB9 onesuperior */
0x40, 0xA0, 0x40, 0x00, 0xE0, /*[120] 0xBA ordmasculine */
0x80, 0x40, 0x80, /*[121] 0xBB guillemotright */
0x80, 0x80, 0x00, 0x60, 0x20, /*[122] 0xBC onequarter */
0x80, 0x80, 0x00, 0xC0, 0x60, /*[123] 0xBD onehalf */
0xC0, 0xC0, 0x00, 0x60, 0x20, /*[124] 0xBE threequarters */
0x40, 0x00, 0x40, 0x80, 0xE0, /*[125] 0xBF questiondown */
0x40, 0x20, 0x40, 0xE0, 0xA0, /*[126] 0xC0 Agrave */
0x40, 0x80, 0x40, 0xE0, 0xA0, /*[127] 0xC1 Aacute */
0xE0, 0x00, 0x40, 0xE0, 0xA0, /*[128] 0xC2 Acircumflex */
0x60, 0xC0, 0x40, 0xE0, 0xA0, /*[129] 0xC3 Atilde */
0xA0, 0x40, 0xA0, 0xE0, 0xA0, /*[130] 0xC4 Adieresis */
0xC0, 0xC0, 0xA0, 0xE0, 0xA0, /*[131] 0xC5 Aring */
0x60, 0xC0, 0xE0, 0xC0, 0xE0, /*[132] 0xC6 AE */
0x60, 0x80, 0x80, 0x60, 0x20, 0x40, /*[133] 0xC7 Ccedilla */
0x40, 0x20, 0xE0, 0xC0, 0xE0, /*[134] 0xC8 Egrave */
0x40, 0x80, 0xE0, 0xC0, 0xE0, /*[135] 0xC9 Eacute */
0xE0, 0x00, 0xE0, 0xC0, 0xE0, /*[136] 0xCA Ecircumflex */
0xA0, 0x00, 0xE0, 0xC0, 0xE0, /*[137] 0xCB Edieresis */
0x40, 0x20, 0xE0, 0x40, 0xE0, /*[138] 0xCC Igrave */
0x40, 0x80, 0xE0, 0x40, 0xE0, /*[139] 0xCD Iacute */
0xE0, 0x00, 0xE0, 0x40, 0xE0, /*[140] 0xCE Icircumflex */
0xA0, 0x00, 0xE0, 0x40, 0xE0, /*[141] 0xCF Idieresis */
0xC0, 0xA0, 0xE0, 0xA0, 0xC0, /*[142] 0xD0 Eth */
0xC0, 0x60, 0xA0, 0xE0, 0xA0, /*[143] 0xD1 Ntilde */
0x40, 0x20, 0xE0, 0xA0, 0xE0, /*[144] 0xD2 Ograve */
0x40, 0x80, 0xE0, 0xA0, 0xE0, /*[145] 0xD3 Oacute */
0xE0, 0x00, 0xE0, 0xA0, 0xE0, /*[146] 0xD4 Ocircumflex */
0xC0, 0x60, 0xE0, 0xA0, 0xE0, /*[147] 0xD5 Otilde */
0xA0, 0x00, 0xE0, 0xA0, 0xE0, /*[148] 0xD6 Odieresis */
0xA0, 0x40, 0xA0, /*[149] 0xD7 multiply */
0x60, 0xA0, 0xE0, 0xA0, 0xC0, /*[150] 0xD8 Oslash */
0x80, 0x40, 0xA0, 0xA0, 0xE0, /*[151] 0xD9 Ugrave */
0x20, 0x40, 0xA0, 0xA0, 0xE0, /*[152] 0xDA Uacute */
0xE0, 0x00, 0xA0, 0xA0, 0xE0, /*[153] 0xDB Ucircumflex */
0xA0, 0x00, 0xA0, 0xA0, 0xE0, /*[154] 0xDC Udieresis */
0x20, 0x40, 0xA0, 0xE0, 0x40, /*[155] 0xDD Yacute */
0x80, 0xE0, 0xA0, 0xE0, 0x80, /*[156] 0xDE Thorn */
0x60, 0xA0, 0xC0, 0xA0, 0xC0, 0x80, /*[157] 0xDF germandbls */
0x40, 0x20, 0x60, 0xA0, 0xE0, /*[158] 0xE0 agrave */
0x40, 0x80, 0x60, 0xA0, 0xE0, /*[159] 0xE1 aacute */
0xE0, 0x00, 0x60, 0xA0, 0xE0, /*[160] 0xE2 acircumflex */
0x60, 0xC0, 0x60, 0xA0, 0xE0, /*[161] 0xE3 atilde */
0xA0, 0x00, 0x60, 0xA0, 0xE0, /*[162] 0xE4 adieresis */
0x60, 0x60, 0x60, 0xA0, 0xE0, /*[163] 0xE5 aring */
0x60, 0xE0, 0xE0, 0xC0, /*[164] 0xE6 ae */
0x60, 0x80, 0x60, 0x20, 0x40, /*[165] 0xE7 ccedilla */
0x40, 0x20, 0x60, 0xE0, 0x60, /*[166] 0xE8 egrave */
0x40, 0x80, 0x60, 0xE0, 0x60, /*[167] 0xE9 eacute */
0xE0, 0x00, 0x60, 0xE0, 0x60, /*[168] 0xEA ecircumflex */
0xA0, 0x00, 0x60, 0xE0, 0x60, /*[169] 0xEB edieresis */
0x80, 0x40, 0x80, 0x80, 0x80, /*[170] 0xEC igrave */
0x40, 0x80, 0x40, 0x40, 0x40, /*[171] 0xED iacute */
0xE0, 0x00, 0x40, 0x40, 0x40, /*[172] 0xEE icircumflex */
0xA0, 0x00, 0x40, 0x40, 0x40, /*[173] 0xEF idieresis */
0x60, 0xC0, 0x60, 0xA0, 0x60, /*[174] 0xF0 eth */
0xC0, 0x60, 0xC0, 0xA0, 0xA0, /*[175] 0xF1 ntilde */
0x40, 0x20, 0x40, 0xA0, 0x40, /*[176] 0xF2 ograve */
0x40, 0x80, 0x40, 0xA0, 0x40, /*[177] 0xF3 oacute */
0xE0, 0x00, 0x40, 0xA0, 0x40, /*[178] 0xF4 ocircumflex */
0xC0, 0x60, 0x40, 0xA0, 0x40, /*[179] 0xF5 otilde */
0xA0, 0x00, 0x40, 0xA0, 0x40, /*[180] 0xF6 odieresis */
0x40, 0x00, 0xE0, 0x00, 0x40, /*[181] 0xF7 divide */
0x60, 0xE0, 0xA0, 0xC0, /*[182] 0xF8 oslash */
0x80, 0x40, 0xA0, 0xA0, 0x60, /*[183] 0xF9 ugrave */
0x20, 0x40, 0xA0, 0xA0, 0x60, /*[184] 0xFA uacute */
0xE0, 0x00, 0xA0, 0xA0, 0x60, /*[185] 0xFB ucircumflex */
0xA0, 0x00, 0xA0, 0xA0, 0x60, /*[186] 0xFC udieresis */
0x20, 0x40, 0xA0, 0x60, 0x20, 0x40, /*[187] 0xFD yacute */
0x80, 0xC0, 0xA0, 0xC0, 0x80, /*[188] 0xFE thorn */
0xA0, 0x00, 0xA0, 0x60, 0x20, 0x40, /*[189] 0xFF ydieresis */
0x00, /*[190] 0x11D gcircumflex */
0x60, 0xC0, 0xE0, 0xC0, 0x60, /*[191] 0x152 OE */
0x60, 0xE0, 0xC0, 0xE0, /*[192] 0x153 oe */
0xA0, 0x60, 0xC0, 0x60, 0xC0, /*[193] 0x160 Scaron */
0xA0, 0x60, 0xC0, 0x60, 0xC0, /*[194] 0x161 scaron */
0xA0, 0x00, 0xA0, 0x40, 0x40, /*[195] 0x178 Ydieresis */
0xA0, 0xE0, 0x60, 0xC0, 0xE0, /*[196] 0x17D Zcaron */
0xA0, 0xE0, 0x60, 0xC0, 0xE0, /*[197] 0x17E zcaron */
0x00, /*[198] 0xEA4 uni0EA4 */
0x00, /*[199] 0x13A0 uni13A0 */
0x80, /*[200] 0x2022 bullet */
0xA0, /*[201] 0x2026 ellipsis */
0x60, 0xE0, 0xE0, 0xC0, 0x60, /*[202] 0x20AC Euro */
0xE0, 0xA0, 0xA0, 0xA0, 0xE0, /*[203] 0xFFFD uniFFFD */
};
/* {offset, width, height, advance cursor, x offset, y offset} */
const GFXglyph AwtrixFontGlyphs[] PROGMEM = {
{0, 8, 1, 2, 0, -5}, /*[0] 0x20 space */
{1, 8, 5, 2, 0, -5}, /*[1] 0x21 exclam */
{6, 8, 2, 4, 0, -5}, /*[2] 0x22 quotedbl */
{8, 8, 5, 4, 0, -5}, /*[3] 0x23 numbersign */
{13, 8, 5, 4, 0, -5}, /*[4] 0x24 dollar */
{18, 8, 5, 4, 0, -5}, /*[5] 0x25 percent */
{23, 8, 5, 4, 0, -5}, /*[6] 0x26 ampersand */
{28, 8, 2, 2, 0, -5}, /*[7] 0x27 quotesingle */
{30, 8, 5, 3, 0, -5}, /*[8] 0x28 parenleft */
{35, 8, 5, 3, 0, -5}, /*[9] 0x29 parenright */
{40, 8, 3, 4, 0, -5}, /*[10] 0x2A asterisk */
{43, 8, 3, 4, 0, -4}, /*[11] 0x2B plus */
{46, 8, 2, 3, 0, -2}, /*[12] 0x2C comma */
{48, 8, 1, 4, 0, -3}, /*[13] 0x2D hyphen */
{49, 8, 1, 2, 0, -1}, /*[14] 0x2E period */
{50, 8, 5, 4, 0, -5}, /*[15] 0x2F slash */
{55, 8, 5, 4, 0, -5}, /*[16] 0x30 zero */
{60, 8, 5, 4, 0, -5}, /*[17] 0x31 one */
{65, 8, 5, 4, 0, -5}, /*[18] 0x32 two */
{70, 8, 5, 4, 0, -5}, /*[19] 0x33 three */
{75, 8, 5, 4, 0, -5}, /*[20] 0x34 four */
{80, 8, 5, 4, 0, -5}, /*[21] 0x35 five */
{85, 8, 5, 4, 0, -5}, /*[22] 0x36 six */
{90, 8, 5, 4, 0, -5}, /*[23] 0x37 seven */
{95, 8, 5, 4, 0, -5}, /*[24] 0x38 eight */
{100, 8, 5, 4, 0, -5}, /*[25] 0x39 nine */
{105, 8, 3, 2, 0, -4}, /*[26] 0x3A colon */
{108, 8, 4, 3, 0, -4}, /*[27] 0x3B semicolon */
{112, 8, 5, 4, 0, -5}, /*[28] 0x3C less */
{117, 8, 3, 4, 0, -4}, /*[29] 0x3D equal */
{120, 8, 5, 4, 0, -5}, /*[30] 0x3E greater */
{125, 8, 5, 4, 0, -5}, /*[31] 0x3F question */
{130, 8, 5, 4, 0, -5}, /*[32] 0x40 at */
{135, 8, 5, 4, 0, -5}, /*[33] 0x41 A */
{140, 8, 5, 4, 0, -5}, /*[34] 0x42 B */
{145, 8, 5, 4, 0, -5}, /*[35] 0x43 C */
{150, 8, 5, 4, 0, -5}, /*[36] 0x44 D */
{155, 8, 5, 4, 0, -5}, /*[37] 0x45 E */
{160, 8, 5, 4, 0, -5}, /*[38] 0x46 F */
{165, 8, 5, 4, 0, -5}, /*[39] 0x47 G */
{170, 8, 5, 4, 0, -5}, /*[40] 0x48 H */
{175, 8, 5, 2, 0, -5}, /*[41] 0x49 I */
{180, 8, 5, 4, 0, -5}, /*[42] 0x4A J */
{185, 8, 5, 4, 0, -5}, /*[43] 0x4B K */
{190, 8, 5, 4, 0, -5}, /*[44] 0x4C L */
{195, 8, 5, 6, 0, -5}, /*[45] 0x4D M */
{200, 8, 5, 5, 0, -5}, /*[46] 0x4E N */
{205, 8, 5, 4, 0, -5}, /*[47] 0x4F O */
{210, 8, 5, 4, 0, -5}, /*[48] 0x50 P */
{215, 8, 5, 5, 0, -5}, /*[49] 0x51 Q */
{220, 8, 5, 4, 0, -5}, /*[50] 0x52 R */
{225, 8, 5, 4, 0, -5}, /*[51] 0x53 S */
{230, 8, 5, 4, 0, -5}, /*[52] 0x54 T */
{235, 8, 5, 4, 0, -5}, /*[53] 0x55 U */
{240, 8, 5, 4, 0, -5}, /*[54] 0x56 V */
{245, 8, 5, 6, 0, -5}, /*[55] 0x57 W */
{250, 8, 5, 4, 0, -5}, /*[56] 0x58 X */
{255, 8, 5, 4, 0, -5}, /*[57] 0x59 Y */
{260, 8, 5, 4, 0, -5}, /*[58] 0x5A Z */
{265, 8, 5, 4, 0, -5}, /*[59] 0x5B bracketleft */
{270, 8, 3, 4, 0, -4}, /*[60] 0x5C backslash */
{273, 8, 5, 4, 0, -5}, /*[61] 0x5D bracketright */
{278, 8, 2, 4, 0, -5}, /*[62] 0x5E asciicircum */
{280, 8, 1, 4, 0, -1}, /*[63] 0x5F underscore */
{281, 8, 2, 3, 0, -5}, /*[64] 0x60 grave */
{283, 8, 4, 4, 0, -4}, /*[65] 0x61 a */
{287, 8, 5, 4, 0, -5}, /*[66] 0x62 b */
{292, 8, 4, 4, 0, -4}, /*[67] 0x63 c */
{296, 8, 5, 4, 0, -5}, /*[68] 0x64 d */
{301, 8, 4, 4, 0, -4}, /*[69] 0x65 e */
{305, 8, 5, 4, 0, -5}, /*[70] 0x66 f */
{310, 8, 5, 4, 0, -4}, /*[71] 0x67 g */
{315, 8, 5, 4, 0, -5}, /*[72] 0x68 h */
{320, 8, 5, 2, 0, -5}, /*[73] 0x69 i */
{325, 8, 6, 4, 0, -5}, /*[74] 0x6A j */
{331, 8, 5, 4, 0, -5}, /*[75] 0x6B k */
{336, 8, 5, 4, 0, -5}, /*[76] 0x6C l */
{341, 8, 4, 4, 0, -4}, /*[77] 0x6D m */
{345, 8, 4, 4, 0, -4}, /*[78] 0x6E n */
{349, 8, 4, 4, 0, -4}, /*[79] 0x6F o */
{353, 8, 5, 4, 0, -4}, /*[80] 0x70 p */
{358, 8, 5, 4, 0, -4}, /*[81] 0x71 q */
{363, 8, 4, 4, 0, -4}, /*[82] 0x72 r */
{367, 8, 4, 4, 0, -4}, /*[83] 0x73 s */
{371, 8, 5, 4, 0, -5}, /*[84] 0x74 t */
{376, 8, 4, 4, 0, -4}, /*[85] 0x75 u */
{380, 8, 4, 4, 0, -4}, /*[86] 0x76 v */
{384, 8, 4, 4, 0, -4}, /*[87] 0x77 w */
{388, 8, 4, 4, 0, -4}, /*[88] 0x78 x */
{392, 8, 5, 4, 0, -4}, /*[89] 0x79 y */
{397, 8, 4, 4, 0, -4}, /*[90] 0x7A z */
{401, 8, 5, 4, 0, -5}, /*[91] 0x7B braceleft */
{406, 8, 5, 2, 0, -5}, /*[92] 0x7C bar */
{411, 8, 5, 4, 0, -5}, /*[93] 0x7D braceright */
{416, 8, 2, 4, 0, -5}, /*[94] 0x7E asciitilde */
{418, 8, 5, 2, 0, -5}, /*[95] 0xA1 exclamdown */
{423, 8, 5, 4, 0, -5}, /*[96] 0xA2 cent */
{428, 8, 5, 4, 0, -5}, /*[97] 0xA3 sterling */
{433, 8, 5, 4, 0, -5}, /*[98] 0xA4 currency */
{438, 8, 5, 4, 0, -5}, /*[99] 0xA5 yen */
{443, 8, 5, 2, 0, -5}, /*[100] 0xA6 brokenbar */
{448, 8, 5, 4, 0, -5}, /*[101] 0xA7 section */
{453, 8, 1, 4, 0, -5}, /*[102] 0xA8 dieresis */
{454, 8, 3, 4, 0, -5}, /*[103] 0xA9 copyright */
{457, 8, 5, 4, 0, -5}, /*[104] 0xAA ordfeminine */
{462, 8, 3, 3, 0, -5}, /*[105] 0xAB guillemotleft */
{465, 8, 2, 4, 0, -4}, /*[106] 0xAC logicalnot */
{467, 8, 1, 3, 0, -3}, /*[107] 0xAD softhyphen */
{468, 8, 3, 4, 0, -5}, /*[108] 0xAE registered */
{471, 8, 1, 4, 0, -5}, /*[109] 0xAF macron */
{472, 8, 3, 4, 0, -5}, /*[110] 0xB0 degree */
{475, 8, 5, 4, 0, -5}, /*[111] 0xB1 plusminus */
{480, 8, 3, 4, 0, -5}, /*[112] 0xB2 twosuperior */
{483, 8, 3, 4, 0, -5}, /*[113] 0xB3 threesuperior */
{486, 8, 2, 3, 0, -5}, /*[114] 0xB4 acute */
{488, 8, 5, 4, 0, -5}, /*[115] 0xB5 mu */
{493, 8, 5, 4, 0, -5}, /*[116] 0xB6 paragraph */
{498, 8, 3, 4, 0, -4}, /*[117] 0xB7 periodcentered */
{501, 8, 3, 4, 0, -3}, /*[118] 0xB8 cedilla */
{504, 8, 3, 2, 0, -5}, /*[119] 0xB9 onesuperior */
{507, 8, 5, 4, 0, -5}, /*[120] 0xBA ordmasculine */
{512, 8, 3, 3, 0, -5}, /*[121] 0xBB guillemotright */
{515, 8, 5, 4, 0, -5}, /*[122] 0xBC onequarter */
{520, 8, 5, 4, 0, -5}, /*[123] 0xBD onehalf */
{525, 8, 5, 4, 0, -5}, /*[124] 0xBE threequarters */
{530, 8, 5, 4, 0, -5}, /*[125] 0xBF questiondown */
{535, 8, 5, 4, 0, -5}, /*[126] 0xC0 Agrave */
{540, 8, 5, 4, 0, -5}, /*[127] 0xC1 Aacute */
{545, 8, 5, 4, 0, -5}, /*[128] 0xC2 Acircumflex */
{550, 8, 5, 4, 0, -5}, /*[129] 0xC3 Atilde */
{555, 8, 5, 4, 0, -5}, /*[130] 0xC4 Adieresis */
{560, 8, 5, 4, 0, -5}, /*[131] 0xC5 Aring */
{565, 8, 5, 4, 0, -5}, /*[132] 0xC6 AE */
{570, 8, 6, 4, 0, -5}, /*[133] 0xC7 Ccedilla */
{576, 8, 5, 4, 0, -5}, /*[134] 0xC8 Egrave */
{581, 8, 5, 4, 0, -5}, /*[135] 0xC9 Eacute */
{586, 8, 5, 4, 0, -5}, /*[136] 0xCA Ecircumflex */
{591, 8, 5, 4, 0, -5}, /*[137] 0xCB Edieresis */
{596, 8, 5, 4, 0, -5}, /*[138] 0xCC Igrave */
{601, 8, 5, 4, 0, -5}, /*[139] 0xCD Iacute */
{606, 8, 5, 4, 0, -5}, /*[140] 0xCE Icircumflex */
{611, 8, 5, 4, 0, -5}, /*[141] 0xCF Idieresis */
{616, 8, 5, 4, 0, -5}, /*[142] 0xD0 Eth */
{621, 8, 5, 4, 0, -5}, /*[143] 0xD1 Ntilde */
{626, 8, 5, 4, 0, -5}, /*[144] 0xD2 Ograve */
{631, 8, 5, 4, 0, -5}, /*[145] 0xD3 Oacute */
{636, 8, 5, 4, 0, -5}, /*[146] 0xD4 Ocircumflex */
{641, 8, 5, 4, 0, -5}, /*[147] 0xD5 Otilde */
{646, 8, 5, 4, 0, -5}, /*[148] 0xD6 Odieresis */
{651, 8, 3, 4, 0, -4}, /*[149] 0xD7 multiply */
{654, 8, 5, 4, 0, -5}, /*[150] 0xD8 Oslash */
{659, 8, 5, 4, 0, -5}, /*[151] 0xD9 Ugrave */
{664, 8, 5, 4, 0, -5}, /*[152] 0xDA Uacute */
{669, 8, 5, 4, 0, -5}, /*[153] 0xDB Ucircumflex */
{674, 8, 5, 4, 0, -5}, /*[154] 0xDC Udieresis */
{679, 8, 5, 4, 0, -5}, /*[155] 0xDD Yacute */
{684, 8, 5, 4, 0, -5}, /*[156] 0xDE Thorn */
{689, 8, 6, 4, 0, -5}, /*[157] 0xDF germandbls */
{695, 8, 5, 4, 0, -5}, /*[158] 0xE0 agrave */
{700, 8, 5, 4, 0, -5}, /*[159] 0xE1 aacute */
{705, 8, 5, 4, 0, -5}, /*[160] 0xE2 acircumflex */
{710, 8, 5, 4, 0, -5}, /*[161] 0xE3 atilde */
{715, 8, 5, 4, 0, -5}, /*[162] 0xE4 adieresis */
{720, 8, 5, 4, 0, -5}, /*[163] 0xE5 aring */
{725, 8, 4, 4, 0, -4}, /*[164] 0xE6 ae */
{729, 8, 5, 4, 0, -4}, /*[165] 0xE7 ccedilla */
{734, 8, 5, 4, 0, -5}, /*[166] 0xE8 egrave */
{739, 8, 5, 4, 0, -5}, /*[167] 0xE9 eacute */
{744, 8, 5, 4, 0, -5}, /*[168] 0xEA ecircumflex */
{749, 8, 5, 4, 0, -5}, /*[169] 0xEB edieresis */
{754, 8, 5, 3, 0, -5}, /*[170] 0xEC igrave */
{759, 8, 5, 3, 0, -5}, /*[171] 0xED iacute */
{764, 8, 5, 4, 0, -5}, /*[172] 0xEE icircumflex */
{769, 8, 5, 4, 0, -5}, /*[173] 0xEF idieresis */
{774, 8, 5, 4, 0, -5}, /*[174] 0xF0 eth */
{779, 8, 5, 4, 0, -5}, /*[175] 0xF1 ntilde */
{784, 8, 5, 4, 0, -5}, /*[176] 0xF2 ograve */
{789, 8, 5, 4, 0, -5}, /*[177] 0xF3 oacute */
{794, 8, 5, 4, 0, -5}, /*[178] 0xF4 ocircumflex */
{799, 8, 5, 4, 0, -5}, /*[179] 0xF5 otilde */
{804, 8, 5, 4, 0, -5}, /*[180] 0xF6 odieresis */
{809, 8, 5, 4, 0, -5}, /*[181] 0xF7 divide */
{814, 8, 4, 4, 0, -4}, /*[182] 0xF8 oslash */
{818, 8, 5, 4, 0, -5}, /*[183] 0xF9 ugrave */
{823, 8, 5, 4, 0, -5}, /*[184] 0xFA uacute */
{828, 8, 5, 4, 0, -5}, /*[185] 0xFB ucircumflex */
{833, 8, 5, 4, 0, -5}, /*[186] 0xFC udieresis */
{838, 8, 6, 4, 0, -5}, /*[187] 0xFD yacute */
{844, 8, 5, 4, 0, -4}, /*[188] 0xFE thorn */
{849, 8, 6, 4, 0, -5}, /*[189] 0xFF ydieresis */
{855, 8, 1, 2, 0, -1}, /*[190] 0x11D gcircumflex */
{856, 8, 5, 4, 0, -5}, /*[191] 0x152 OE */
{861, 8, 4, 4, 0, -4}, /*[192] 0x153 oe */
{865, 8, 5, 4, 0, -5}, /*[193] 0x160 Scaron */
{870, 8, 5, 4, 0, -5}, /*[194] 0x161 scaron */
{875, 8, 5, 4, 0, -5}, /*[195] 0x178 Ydieresis */
{880, 8, 5, 4, 0, -5}, /*[196] 0x17D Zcaron */
{885, 8, 5, 4, 0, -5}, /*[197] 0x17E zcaron */
{890, 8, 1, 2, 0, -1}, /*[198] 0xEA4 uni0EA4 */
{891, 8, 1, 2, 0, -1}, /*[199] 0x13A0 uni13A0 */
{892, 8, 1, 2, 0, -3}, /*[200] 0x2022 bullet */
{893, 8, 1, 4, 0, -1}, /*[201] 0x2026 ellipsis */
{894, 8, 5, 4, 0, -5}, /*[202] 0x20AC Euro */
{899, 8, 5, 4, 0, -5}, /*[203] 0xFFFD uniFFFD */
};
const GFXfont AwtrixFont PROGMEM = {
(uint8_t *)AwtrixBitmaps,
(GFXglyph *)AwtrixFontGlyphs,
0x20, 0xFF, 6};

299
lib/MatrixUI/MatrixDisplayUi.cpp Normal file
View File

@@ -0,0 +1,299 @@
/**
* The MIT License (MIT)
*
* Copyright (c) 2016 by Daniel Eichhorn
* Copyright (c) 2016 by Fabrice Weinberg
* Copyright (c) 2016 by Fabrice Weinberg
* Highly modified 2023 for AWTRIX Light by Stephan Muehl (Blueforcer)
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
*/
#include "MatrixDisplayUi.h"
#include "AwtrixFont.h"
MatrixDisplayUi::MatrixDisplayUi(FastLED_NeoMatrix *matrix)
{
this->matrix = matrix;
}
void MatrixDisplayUi::init()
{
this->matrix->begin();
this->matrix->setTextWrap(false);
this->matrix->setBrightness(70);
this->matrix->setFont(&AwtrixFont);
}
void MatrixDisplayUi::setTargetFPS(uint8_t fps)
{
float oldInterval = this->updateInterval;
this->updateInterval = ((float)1.0 / (float)fps) * 1000;
// Calculate new ticksPerFrame
float changeRatio = oldInterval / (float)this->updateInterval;
this->ticksPerFrame *= changeRatio;
this->ticksPerTransition *= changeRatio;
}
// -/------ Automatic controll ------\-
void MatrixDisplayUi::enableAutoTransition()
{
this->autoTransition = true;
}
void MatrixDisplayUi::disableAutoTransition()
{
this->autoTransition = false;
}
void MatrixDisplayUi::setAutoTransitionForwards()
{
this->state.frameTransitionDirection = 1;
this->lastTransitionDirection = 1;
}
void MatrixDisplayUi::setAutoTransitionBackwards()
{
this->state.frameTransitionDirection = -1;
this->lastTransitionDirection = -1;
}
void MatrixDisplayUi::setTimePerApp(uint16_t time)
{
this->ticksPerFrame = (int)((float)time / (float)updateInterval);
}
void MatrixDisplayUi::setTimePerTransition(uint16_t time)
{
this->ticksPerTransition = (int)((float)time / (float)updateInterval);
}
// -/----- Frame settings -----\-
void MatrixDisplayUi::setAppAnimation(AnimationDirection dir)
{
this->frameAnimationDirection = dir;
}
void MatrixDisplayUi::setApps(const std::vector<std::pair<uint16_t, AppCallback>> &appPairs)
{
delete[] AppFunctions;
AppCount = appPairs.size();
AppFunctions = new AppCallback[AppCount];
for (size_t i = 0; i < AppCount; ++i)
{
AppFunctions[i] = appPairs[i].second;
}
this->resetState();
}
// -/----- Overlays ------\-
void MatrixDisplayUi::setOverlays(OverlayCallback *overlayFunctions, uint8_t overlayCount)
{
this->overlayFunctions = overlayFunctions;
this->overlayCount = overlayCount;
}
// -/----- Manuel control -----\-
void MatrixDisplayUi::nextApp()
{
if (this->state.frameState != IN_TRANSITION)
{
this->state.manuelControll = true;
this->state.frameState = IN_TRANSITION;
this->state.ticksSinceLastStateSwitch = 0;
this->lastTransitionDirection = this->state.frameTransitionDirection;
this->state.frameTransitionDirection = 1;
}
}
void MatrixDisplayUi::previousApp()
{
if (this->state.frameState != IN_TRANSITION)
{
this->state.manuelControll = true;
this->state.frameState = IN_TRANSITION;
this->state.ticksSinceLastStateSwitch = 0;
this->lastTransitionDirection = this->state.frameTransitionDirection;
this->state.frameTransitionDirection = -1;
}
}
void MatrixDisplayUi::switchToApp(uint8_t frame)
{
if (frame >= this->AppCount)
return;
this->state.ticksSinceLastStateSwitch = 0;
if (frame == this->state.currentFrame)
return;
this->state.frameState = FIXED;
this->state.currentFrame = frame;
}
void MatrixDisplayUi::transitionToApp(uint8_t frame)
{
if (frame >= this->AppCount)
return;
this->state.ticksSinceLastStateSwitch = 0;
if (frame == this->state.currentFrame)
return;
this->nextAppNumber = frame;
this->lastTransitionDirection = this->state.frameTransitionDirection;
this->state.manuelControll = true;
this->state.frameState = IN_TRANSITION;
this->state.frameTransitionDirection = frame < this->state.currentFrame ? -1 : 1;
}
// -/----- State information -----\-
MatrixDisplayUiState *MatrixDisplayUi::getUiState()
{
return &this->state;
}
int8_t MatrixDisplayUi::update()
{
long frameStart = millis();
int8_t timeBudget = this->updateInterval - (frameStart - this->state.lastUpdate);
if (timeBudget <= 0)
{
// Implement frame skipping to ensure time budget is keept
if (this->autoTransition && this->state.lastUpdate != 0)
this->state.ticksSinceLastStateSwitch += ceil(-timeBudget / this->updateInterval);
this->state.lastUpdate = frameStart;
this->tick();
}
return this->updateInterval - (millis() - frameStart);
}
void MatrixDisplayUi::tick()
{
this->state.ticksSinceLastStateSwitch++;
switch (this->state.frameState)
{
case IN_TRANSITION:
if (this->state.ticksSinceLastStateSwitch >= this->ticksPerTransition)
{
this->state.frameState = FIXED;
this->state.currentFrame = getnextAppNumber();
this->state.ticksSinceLastStateSwitch = 0;
this->nextAppNumber = -1;
}
break;
case FIXED:
// Revert manuelControll
if (this->state.manuelControll)
{
this->state.frameTransitionDirection = this->lastTransitionDirection;
this->state.manuelControll = false;
}
if (this->state.ticksSinceLastStateSwitch >= this->ticksPerFrame)
{
if (this->autoTransition)
{
this->state.frameState = IN_TRANSITION;
}
this->state.ticksSinceLastStateSwitch = 0;
}
break;
}
this->matrix->clear();
this->drawApp();
this->drawOverlays();
this->matrix->show();
}
void MatrixDisplayUi::drawApp()
{
switch (this->state.frameState)
{
case IN_TRANSITION:
{
float progress = (float)this->state.ticksSinceLastStateSwitch / (float)this->ticksPerTransition;
int16_t x, y, x1, y1;
switch (this->frameAnimationDirection)
{
case SLIDE_LEFT:
x = -32 * progress;
y = 0;
x1 = x + 32;
y1 = 0;
break;
case SLIDE_RIGHT:
x = 32 * progress;
y = 0;
x1 = x - 32;
y1 = 0;
break;
case SLIDE_UP:
x = 0;
y = -8 * progress;
x1 = 0;
y1 = y + 8;
break;
case SLIDE_DOWN:
x = 0;
y = 8 * progress;
x1 = 0;
y1 = y - 8;
break;
}
// Invert animation if direction is reversed.
int8_t dir = this->state.frameTransitionDirection >= 0 ? 1 : -1;
x *= dir;
y *= dir;
x1 *= dir;
y1 *= dir;
bool FirstFrame = progress < 0.1;
bool LastFrame = progress > 0.9;
this->matrix->drawRect(x, y, x1, y1, matrix->Color(0, 0, 0));
(this->AppFunctions[this->state.currentFrame])(this->matrix, &this->state, x, y, FirstFrame, LastFrame);
(this->AppFunctions[this->getnextAppNumber()])(this->matrix, &this->state, x1, y1, FirstFrame, LastFrame);
break;
}
case FIXED:
(this->AppFunctions[this->state.currentFrame])(this->matrix, &this->state, 0, 0, false, false);
break;
}
}
void MatrixDisplayUi::resetState()
{
this->state.lastUpdate = 0;
this->state.ticksSinceLastStateSwitch = 0;
this->state.frameState = FIXED;
this->state.currentFrame = 0;
}
void MatrixDisplayUi::drawOverlays()
{
for (uint8_t i = 0; i < this->overlayCount; i++)
{
(this->overlayFunctions[i])(this->matrix, &this->state);
}
}
uint8_t MatrixDisplayUi::getnextAppNumber()
{
if (this->nextAppNumber != -1)
return this->nextAppNumber;
return (this->state.currentFrame + this->AppCount + this->state.frameTransitionDirection) % this->AppCount;
}

196
lib/MatrixUI/MatrixDisplayUi.h Normal file
View File

@@ -0,0 +1,196 @@
/**
* The MIT License (MIT)
*
* Copyright (c) 2016 by Daniel Eichhorn
* Copyright (c) 2016 by Fabrice Weinberg
* Highly modified 2023 for AWTRIX Light by Stephan Muehl (Blueforcer)
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
*/
#ifndef MatrixDisplayUi_h
#define MatrixDisplayUi_h
#include <Arduino.h>
#include "FastLED_NeoMatrix.h"
#include <vector>
// #define DEBUG_MatrixDisplayUi(...) Serial.printf( __VA_ARGS__ )
#ifndef DEBUG_MatrixDisplayUi
#define DEBUG_MatrixDisplayUi(...)
#endif
enum AnimationDirection
{
SLIDE_UP,
SLIDE_DOWN,
SLIDE_LEFT,
SLIDE_RIGHT
};
enum FrameState
{
IN_TRANSITION,
FIXED
};
// Structure of the UiState
struct MatrixDisplayUiState
{
u_int64_t lastUpdate = 0;
uint16_t ticksSinceLastStateSwitch = 0;
FrameState frameState = FIXED;
uint8_t currentFrame = 0;
// Normal = 1, Inverse = -1;
int8_t frameTransitionDirection = 1;
bool manuelControll = false;
// Custom data that can be used by the user
void *userData = NULL;
};
typedef void (*AppCallback)(FastLED_NeoMatrix *matrix, MatrixDisplayUiState *state, int16_t x, int16_t y, bool firstFrame, bool lastFrame);
typedef void (*OverlayCallback)(FastLED_NeoMatrix *matrix, MatrixDisplayUiState *state);
class MatrixDisplayUi
{
private:
FastLED_NeoMatrix *matrix;
// Values for the Frames
AnimationDirection frameAnimationDirection = SLIDE_RIGHT;
int8_t lastTransitionDirection = 1;
uint16_t ticksPerFrame = 151; // ~ 5000ms at 30 FPS
uint16_t ticksPerTransition = 15; // ~ 500ms at 30 FPS
bool autoTransition = true;
AppCallback *AppFunctions;
uint8_t AppCount = 0;
// Internally used to transition to a specific frame
int8_t nextAppNumber = -1;
// Values for Overlays
OverlayCallback *overlayFunctions;
uint8_t overlayCount = 0;
// UI State
MatrixDisplayUiState state;
// Bookeeping for update
uint8_t updateInterval = 33;
uint8_t getnextAppNumber();
void drawIndicator();
void drawApp();
void drawOverlays();
void tick();
void resetState();
public:
MatrixDisplayUi(FastLED_NeoMatrix *matrix);
/**
* Initialise the display
*/
void init();
/**
* Configure the internal used target FPS
*/
void setTargetFPS(uint8_t fps);
// Automatic Controll
/**
* Enable automatic transition to next frame after the some time can be configured with `setTimePerApp` and `setTimePerTransition`.
*/
void enableAutoTransition();
/**
* Disable automatic transition to next frame.
*/
void disableAutoTransition();
/**
* Set the direction if the automatic transitioning
*/
void setAutoTransitionForwards();
void setAutoTransitionBackwards();
/**
* Set the approx. time a frame is displayed
*/
void setTimePerApp(uint16_t time);
/**
* Set the approx. time a transition will take
*/
void setTimePerTransition(uint16_t time);
// Customize indicator position and style
// Frame settings
/**
* Configure what animation is used to transition from one frame to another
*/
void setAppAnimation(AnimationDirection dir);
/**
* Add frame drawing functions
*/
void setApps(const std::vector<std::pair<uint16_t, AppCallback>> &appPairs);
// Overlay
/**
* Add overlays drawing functions that are draw independent of the Frames
*/
void setOverlays(OverlayCallback *overlayFunctions, uint8_t overlayCount);
// Manual Control
void nextApp();
void previousApp();
/**
* Switch without transition to frame `frame`.
*/
void switchToApp(uint8_t frame);
/**
* Transition to frame `frame`, when the `frame` number is bigger than the current
* frame the forward animation will be used, otherwise the backwards animation is used.
*/
void transitionToApp(uint8_t frame);
// State Info
MatrixDisplayUiState *getUiState();
int8_t update();
};
#endif

154
lib/Melody Player/.clang-format Normal file
View File

@@ -0,0 +1,154 @@
# Config file found in Arduino Language Server (https://github.com/arduino/arduino-language-server/blob/0.6.0/ls/ls_formatter.go)
# CHANGES:
# - ReflowComments: true
# - MaxEmptyLinesToKeep: 1
# - ColumnLimit: 100
# - BreakStringLiterals: true
# - AlignConsecutiveMacros: AcrossEmptyLines
# - AlignArrayOfStructures: Left
Language: Cpp
# LLVM is the default style setting, used when a configuration option is not set here
BasedOnStyle: LLVM
AccessModifierOffset: -2
AlignAfterOpenBracket: Align
AlignConsecutiveAssignments: false
AlignConsecutiveBitFields: false
AlignConsecutiveDeclarations: false
AlignConsecutiveMacros: false
AlignEscapedNewlines: DontAlign
AlignOperands: Align
AlignTrailingComments: true
AllowAllArgumentsOnNextLine: true
AllowAllConstructorInitializersOnNextLine: true
AllowAllParametersOfDeclarationOnNextLine: true
AllowShortBlocksOnASingleLine: Always
AllowShortCaseLabelsOnASingleLine: true
AllowShortEnumsOnASingleLine: true
AllowShortFunctionsOnASingleLine: Empty
AllowShortIfStatementsOnASingleLine: Always
AllowShortLambdasOnASingleLine: Empty
AllowShortLoopsOnASingleLine: true
AlwaysBreakAfterDefinitionReturnType: None
AlwaysBreakAfterReturnType: None
AlwaysBreakBeforeMultilineStrings: false
AlwaysBreakTemplateDeclarations: No
BinPackArguments: true
BinPackParameters: true
# Only used when "BreakBeforeBraces" set to "Custom"
BraceWrapping:
AfterCaseLabel: false
AfterClass: false
AfterControlStatement: Never
AfterEnum: false
AfterFunction: false
AfterNamespace: false
#AfterObjCDeclaration:
AfterStruct: false
AfterUnion: false
AfterExternBlock: false
BeforeCatch: false
BeforeElse: false
BeforeLambdaBody: false
BeforeWhile: false
IndentBraces: false
SplitEmptyFunction: false
SplitEmptyRecord: false
SplitEmptyNamespace: false
# Java-specific
#BreakAfterJavaFieldAnnotations:
BreakBeforeBinaryOperators: NonAssignment
BreakBeforeBraces: Attach
BreakBeforeTernaryOperators: true
BreakConstructorInitializers: BeforeColon
BreakInheritanceList: BeforeColon
BreakStringLiterals: true
ColumnLimit: 100
# "" matches none
CommentPragmas: ""
CompactNamespaces: false
ConstructorInitializerAllOnOneLineOrOnePerLine: true
ConstructorInitializerIndentWidth: 2
ContinuationIndentWidth: 2
Cpp11BracedListStyle: false
DeriveLineEnding: true
DerivePointerAlignment: true
DisableFormat: false
# Docs say "Do not use this in config files". The default (LLVM 11.0.1) is "false".
#ExperimentalAutoDetectBinPacking:
FixNamespaceComments: false
ForEachMacros: []
IncludeBlocks: Preserve
IncludeCategories: []
# "" matches none
IncludeIsMainRegex: ""
IncludeIsMainSourceRegex: ""
IndentCaseBlocks: true
IndentCaseLabels: true
IndentExternBlock: Indent
IndentGotoLabels: false
IndentPPDirectives: None
IndentWidth: 2
IndentWrappedFunctionNames: false
InsertTrailingCommas: None
# Java-specific
#JavaImportGroups:
# JavaScript-specific
#JavaScriptQuotes:
#JavaScriptWrapImports
KeepEmptyLinesAtTheStartOfBlocks: true
MacroBlockBegin: ""
MacroBlockEnd: ""
# Set to a large number to effectively disable
MaxEmptyLinesToKeep: 1
NamespaceIndentation: None
NamespaceMacros: []
# Objective C-specific
#ObjCBinPackProtocolList:
#ObjCBlockIndentWidth:
#ObjCBreakBeforeNestedBlockParam:
#ObjCSpaceAfterProperty:
#ObjCSpaceBeforeProtocolList
PenaltyBreakAssignment: 1
PenaltyBreakBeforeFirstCallParameter: 1
PenaltyBreakComment: 1
PenaltyBreakFirstLessLess: 1
PenaltyBreakString: 1
PenaltyBreakTemplateDeclaration: 1
PenaltyExcessCharacter: 1
PenaltyReturnTypeOnItsOwnLine: 1
# Used as a fallback if alignment style can't be detected from code (DerivePointerAlignment: true)
PointerAlignment: Right
RawStringFormats: []
ReflowComments: true
SortIncludes: false
SortUsingDeclarations: false
SpaceAfterCStyleCast: false
SpaceAfterLogicalNot: false
SpaceAfterTemplateKeyword: false
SpaceBeforeAssignmentOperators: true
SpaceBeforeCpp11BracedList: false
SpaceBeforeCtorInitializerColon: true
SpaceBeforeInheritanceColon: true
SpaceBeforeParens: ControlStatements
SpaceBeforeRangeBasedForLoopColon: true
SpaceBeforeSquareBrackets: false
SpaceInEmptyBlock: false
SpaceInEmptyParentheses: false
SpacesBeforeTrailingComments: 2
SpacesInAngles: false
SpacesInCStyleCastParentheses: false
SpacesInConditionalStatement: false
SpacesInContainerLiterals: false
SpacesInParentheses: false
SpacesInSquareBrackets: false
Standard: Auto
StatementMacros: []
TabWidth: 2
TypenameMacros: []
# Default to LF if line endings can't be detected from the content (DeriveLineEnding).
UseCRLF: false
UseTab: Never
WhitespaceSensitiveMacros: []
AlignConsecutiveMacros: AcrossEmptyLines
AlignArrayOfStructures: Left

5
lib/Melody Player/.gitignore vendored Normal file
View File

@@ -0,0 +1,5 @@
.pio
.vscode/.browse.c_cpp.db*
.vscode/c_cpp_properties.json
.vscode/launch.json
.vscode/ipch

1
lib/Melody Player/.piopm Normal file
View File

@@ -0,0 +1 @@
{"type": "library", "name": "Melody Player", "version": "2.4.0", "spec": {"owner": "fabianoriccardi", "id": 7443, "name": "Melody Player", "requirements": null, "uri": null}}

504
lib/Melody Player/LICENSE Normal file
View File

@@ -0,0 +1,504 @@
GNU LESSER GENERAL PUBLIC LICENSE
Version 2.1, February 1999
Copyright (C) 1991, 1999 Free Software Foundation, Inc.
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
[This is the first released version of the Lesser GPL. It also counts
as the successor of the GNU Library Public License, version 2, hence
the version number 2.1.]
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
Licenses are intended to guarantee your freedom to share and change
free software--to make sure the software is free for all its users.
This license, the Lesser General Public License, applies to some
specially designated software packages--typically libraries--of the
Free Software Foundation and other authors who decide to use it. You
can use it too, but we suggest you first think carefully about whether
this license or the ordinary General Public License is the better
strategy to use in any particular case, based on the explanations below.
When we speak of free software, we are referring to freedom of use,
not price. Our General Public Licenses are designed to make sure that
you have the freedom to distribute copies of free software (and charge
for this service if you wish); that you receive source code or can get
it if you want it; that you can change the software and use pieces of
it in new free programs; and that you are informed that you can do
these things.
To protect your rights, we need to make restrictions that forbid
distributors to deny you these rights or to ask you to surrender these
rights. These restrictions translate to certain responsibilities for
you if you distribute copies of the library or if you modify it.
For example, if you distribute copies of the library, whether gratis
or for a fee, you must give the recipients all the rights that we gave
you. You must make sure that they, too, receive or can get the source
code. If you link other code with the library, you must provide
complete object files to the recipients, so that they can relink them
with the library after making changes to the library and recompiling
it. And you must show them these terms so they know their rights.
We protect your rights with a two-step method: (1) we copyright the
library, and (2) we offer you this license, which gives you legal
permission to copy, distribute and/or modify the library.
To protect each distributor, we want to make it very clear that
there is no warranty for the free library. Also, if the library is
modified by someone else and passed on, the recipients should know
that what they have is not the original version, so that the original
author's reputation will not be affected by problems that might be
introduced by others.
Finally, software patents pose a constant threat to the existence of
any free program. We wish to make sure that a company cannot
effectively restrict the users of a free program by obtaining a
restrictive license from a patent holder. Therefore, we insist that
any patent license obtained for a version of the library must be
consistent with the full freedom of use specified in this license.
Most GNU software, including some libraries, is covered by the
ordinary GNU General Public License. This license, the GNU Lesser
General Public License, applies to certain designated libraries, and
is quite different from the ordinary General Public License. We use
this license for certain libraries in order to permit linking those
libraries into non-free programs.
When a program is linked with a library, whether statically or using
a shared library, the combination of the two is legally speaking a
combined work, a derivative of the original library. The ordinary
General Public License therefore permits such linking only if the
entire combination fits its criteria of freedom. The Lesser General
Public License permits more lax criteria for linking other code with
the library.
We call this license the "Lesser" General Public License because it
does Less to protect the user's freedom than the ordinary General
Public License. It also provides other free software developers Less
of an advantage over competing non-free programs. These disadvantages
are the reason we use the ordinary General Public License for many
libraries. However, the Lesser license provides advantages in certain
special circumstances.
For example, on rare occasions, there may be a special need to
encourage the widest possible use of a certain library, so that it becomes
a de-facto standard. To achieve this, non-free programs must be
allowed to use the library. A more frequent case is that a free
library does the same job as widely used non-free libraries. In this
case, there is little to gain by limiting the free library to free
software only, so we use the Lesser General Public License.
In other cases, permission to use a particular library in non-free
programs enables a greater number of people to use a large body of
free software. For example, permission to use the GNU C Library in
non-free programs enables many more people to use the whole GNU
operating system, as well as its variant, the GNU/Linux operating
system.
Although the Lesser General Public License is Less protective of the
users' freedom, it does ensure that the user of a program that is
linked with the Library has the freedom and the wherewithal to run
that program using a modified version of the Library.
The precise terms and conditions for copying, distribution and
modification follow. Pay close attention to the difference between a
"work based on the library" and a "work that uses the library". The
former contains code derived from the library, whereas the latter must
be combined with the library in order to run.
GNU LESSER GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License Agreement applies to any software library or other
program which contains a notice placed by the copyright holder or
other authorized party saying it may be distributed under the terms of
this Lesser General Public License (also called "this License").
Each licensee is addressed as "you".
A "library" means a collection of software functions and/or data
prepared so as to be conveniently linked with application programs
(which use some of those functions and data) to form executables.
The "Library", below, refers to any such software library or work
which has been distributed under these terms. A "work based on the
Library" means either the Library or any derivative work under
copyright law: that is to say, a work containing the Library or a
portion of it, either verbatim or with modifications and/or translated
straightforwardly into another language. (Hereinafter, translation is
included without limitation in the term "modification".)
"Source code" for a work means the preferred form of the work for
making modifications to it. For a library, complete source code means
all the source code for all modules it contains, plus any associated
interface definition files, plus the scripts used to control compilation
and installation of the library.
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running a program using the Library is not restricted, and output from
such a program is covered only if its contents constitute a work based
on the Library (independent of the use of the Library in a tool for
writing it). Whether that is true depends on what the Library does
and what the program that uses the Library does.
1. You may copy and distribute verbatim copies of the Library's
complete source code as you receive it, in any medium, provided that
you conspicuously and appropriately publish on each copy an
appropriate copyright notice and disclaimer of warranty; keep intact
all the notices that refer to this License and to the absence of any
warranty; and distribute a copy of this License along with the
Library.
You may charge a fee for the physical act of transferring a copy,
and you may at your option offer warranty protection in exchange for a
fee.
2. You may modify your copy or copies of the Library or any portion
of it, thus forming a work based on the Library, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) The modified work must itself be a software library.
b) You must cause the files modified to carry prominent notices
stating that you changed the files and the date of any change.
c) You must cause the whole of the work to be licensed at no
charge to all third parties under the terms of this License.
d) If a facility in the modified Library refers to a function or a
table of data to be supplied by an application program that uses
the facility, other than as an argument passed when the facility
is invoked, then you must make a good faith effort to ensure that,
in the event an application does not supply such function or
table, the facility still operates, and performs whatever part of
its purpose remains meaningful.
(For example, a function in a library to compute square roots has
a purpose that is entirely well-defined independent of the
application. Therefore, Subsection 2d requires that any
application-supplied function or table used by this function must
be optional: if the application does not supply it, the square
root function must still compute square roots.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Library,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Library, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote
it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Library.
In addition, mere aggregation of another work not based on the Library
with the Library (or with a work based on the Library) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may opt to apply the terms of the ordinary GNU General Public
License instead of this License to a given copy of the Library. To do
this, you must alter all the notices that refer to this License, so
that they refer to the ordinary GNU General Public License, version 2,
instead of to this License. (If a newer version than version 2 of the
ordinary GNU General Public License has appeared, then you can specify
that version instead if you wish.) Do not make any other change in
these notices.
Once this change is made in a given copy, it is irreversible for
that copy, so the ordinary GNU General Public License applies to all
subsequent copies and derivative works made from that copy.
This option is useful when you wish to copy part of the code of
the Library into a program that is not a library.
4. You may copy and distribute the Library (or a portion or
derivative of it, under Section 2) in object code or executable form
under the terms of Sections 1 and 2 above provided that you accompany
it with the complete corresponding machine-readable source code, which
must be distributed under the terms of Sections 1 and 2 above on a
medium customarily used for software interchange.
If distribution of object code is made by offering access to copy
from a designated place, then offering equivalent access to copy the
source code from the same place satisfies the requirement to
distribute the source code, even though third parties are not
compelled to copy the source along with the object code.
5. A program that contains no derivative of any portion of the
Library, but is designed to work with the Library by being compiled or
linked with it, is called a "work that uses the Library". Such a
work, in isolation, is not a derivative work of the Library, and
therefore falls outside the scope of this License.
However, linking a "work that uses the Library" with the Library
creates an executable that is a derivative of the Library (because it
contains portions of the Library), rather than a "work that uses the
library". The executable is therefore covered by this License.
Section 6 states terms for distribution of such executables.
When a "work that uses the Library" uses material from a header file
that is part of the Library, the object code for the work may be a
derivative work of the Library even though the source code is not.
Whether this is true is especially significant if the work can be
linked without the Library, or if the work is itself a library. The
threshold for this to be true is not precisely defined by law.
If such an object file uses only numerical parameters, data
structure layouts and accessors, and small macros and small inline
functions (ten lines or less in length), then the use of the object
file is unrestricted, regardless of whether it is legally a derivative
work. (Executables containing this object code plus portions of the
Library will still fall under Section 6.)
Otherwise, if the work is a derivative of the Library, you may
distribute the object code for the work under the terms of Section 6.
Any executables containing that work also fall under Section 6,
whether or not they are linked directly with the Library itself.
6. As an exception to the Sections above, you may also combine or
link a "work that uses the Library" with the Library to produce a
work containing portions of the Library, and distribute that work
under terms of your choice, provided that the terms permit
modification of the work for the customer's own use and reverse
engineering for debugging such modifications.
You must give prominent notice with each copy of the work that the
Library is used in it and that the Library and its use are covered by
this License. You must supply a copy of this License. If the work
during execution displays copyright notices, you must include the
copyright notice for the Library among them, as well as a reference
directing the user to the copy of this License. Also, you must do one
of these things:
a) Accompany the work with the complete corresponding
machine-readable source code for the Library including whatever
changes were used in the work (which must be distributed under
Sections 1 and 2 above); and, if the work is an executable linked
with the Library, with the complete machine-readable "work that
uses the Library", as object code and/or source code, so that the
user can modify the Library and then relink to produce a modified
executable containing the modified Library. (It is understood
that the user who changes the contents of definitions files in the
Library will not necessarily be able to recompile the application
to use the modified definitions.)
b) Use a suitable shared library mechanism for linking with the
Library. A suitable mechanism is one that (1) uses at run time a
copy of the library already present on the user's computer system,
rather than copying library functions into the executable, and (2)
will operate properly with a modified version of the library, if
the user installs one, as long as the modified version is
interface-compatible with the version that the work was made with.
c) Accompany the work with a written offer, valid for at
least three years, to give the same user the materials
specified in Subsection 6a, above, for a charge no more
than the cost of performing this distribution.
d) If distribution of the work is made by offering access to copy
from a designated place, offer equivalent access to copy the above
specified materials from the same place.
e) Verify that the user has already received a copy of these
materials or that you have already sent this user a copy.
For an executable, the required form of the "work that uses the
Library" must include any data and utility programs needed for
reproducing the executable from it. However, as a special exception,
the materials to be distributed need not include anything that is
normally distributed (in either source or binary form) with the major
components (compiler, kernel, and so on) of the operating system on
which the executable runs, unless that component itself accompanies
the executable.
It may happen that this requirement contradicts the license
restrictions of other proprietary libraries that do not normally
accompany the operating system. Such a contradiction means you cannot
use both them and the Library together in an executable that you
distribute.
7. You may place library facilities that are a work based on the
Library side-by-side in a single library together with other library
facilities not covered by this License, and distribute such a combined
library, provided that the separate distribution of the work based on
the Library and of the other library facilities is otherwise
permitted, and provided that you do these two things:
a) Accompany the combined library with a copy of the same work
based on the Library, uncombined with any other library
facilities. This must be distributed under the terms of the
Sections above.
b) Give prominent notice with the combined library of the fact
that part of it is a work based on the Library, and explaining
where to find the accompanying uncombined form of the same work.
8. You may not copy, modify, sublicense, link with, or distribute
the Library except as expressly provided under this License. Any
attempt otherwise to copy, modify, sublicense, link with, or
distribute the Library is void, and will automatically terminate your
rights under this License. However, parties who have received copies,
or rights, from you under this License will not have their licenses
terminated so long as such parties remain in full compliance.
9. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Library or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Library (or any work based on the
Library), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Library or works based on it.
10. Each time you redistribute the Library (or any work based on the
Library), the recipient automatically receives a license from the
original licensor to copy, distribute, link with or modify the Library
subject to these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties with
this License.
11. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Library at all. For example, if a patent
license would not permit royalty-free redistribution of the Library by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Library.
If any portion of this section is held invalid or unenforceable under any
particular circumstance, the balance of the section is intended to apply,
and the section as a whole is intended to apply in other circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
12. If the distribution and/or use of the Library is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Library under this License may add
an explicit geographical distribution limitation excluding those countries,
so that distribution is permitted only in or among countries not thus
excluded. In such case, this License incorporates the limitation as if
written in the body of this License.
13. The Free Software Foundation may publish revised and/or new
versions of the Lesser General Public License from time to time.
Such new versions will be similar in spirit to the present version,
but may differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Library
specifies a version number of this License which applies to it and
"any later version", you have the option of following the terms and
conditions either of that version or of any later version published by
the Free Software Foundation. If the Library does not specify a
license version number, you may choose any version ever published by
the Free Software Foundation.
14. If you wish to incorporate parts of the Library into other free
programs whose distribution conditions are incompatible with these,
write to the author to ask for permission. For software which is
copyrighted by the Free Software Foundation, write to the Free
Software Foundation; we sometimes make exceptions for this. Our
decision will be guided by the two goals of preserving the free status
of all derivatives of our free software and of promoting the sharing
and reuse of software generally.
NO WARRANTY
15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Libraries
If you develop a new library, and you want it to be of the greatest
possible use to the public, we recommend making it free software that
everyone can redistribute and change. You can do so by permitting
redistribution under these terms (or, alternatively, under the terms of the
ordinary General Public License).
To apply these terms, attach the following notices to the library. It is
safest to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least the
"copyright" line and a pointer to where the full notice is found.
<one line to give the library's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library 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
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
USA
Also add information on how to contact you by electronic and paper mail.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the library, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the
library `Frob' (a library for tweaking knobs) written by James Random
Hacker.
<signature of Ty Coon>, 1 April 1990
Ty Coon, President of Vice
That's all there is to it!

104
lib/Melody Player/README.md Normal file
View File

@@ -0,0 +1,104 @@
# Melody Player
[![arduino-library-badge](https://www.ardu-badge.com/badge/Melody%20Player.svg)](https://www.ardu-badge.com/Melody%20Player) ![Compile Library Examples](https://github.com/fabianoriccardi/melody-player/actions/workflows/LibraryBuild.yml/badge.svg)
Melody Player is an Arduino library to play melodies on buzzers on ESP8266 and ESP32 in a non-blocking manner. Melodies can be written directly in code or loaded from file. It supports Ring Tone Text Transfer Language (RTTTL) format and a custom format developed specifically to enjoy all the benefits of this library.
## Motivation
Arduino cores provide tone() function to emit a PWM signal, and it is often used to play beeps on a buzzer. Modulating the PWM frequency, you can play sounds at a given frequency, i.e., you can play a note, and it is relatively easy to play a monophonic melody. However, the Arduino ecosystem lacks of a structured and easy way to accomplish this task (i.e., each developer have to write bloating code for it). So, I started to write a simple snippet to asynchronously play sequences of notes on a buzzer without bloating user-code with long parsing and playback methods. Moreover, since ESP8266 and ESP32 cores provide a file system for the embedded flash melody, I wanted a melody format easy to remember, human-readable and editable with a simple text editor. From this context Melody Player was born, improved, and extended over time.
## Features
* Non-blocking playback
* Support RTTTL format (allow reuse of ringtones popular on old mobile phones)
* Support custom format to allow finer control of frequencies
* For ESP8266 and ESP32
* Load melodies from file (support both LittleFS and SPIFFS file systems)
* Control the melody playback through trivial *play*, *pause*, *stop* methods
* Support multiple playing buzzers
* *Migration* and *duplication* of melodies among buzzers
## Installation
You can find Melody Player on Arduino and PlatformIO library registries. You can install it through Arduino IDE, or you can use the respective command-line tools running:
arduino-cli lib install "Melody Player"
or:
pio lib install "fabianoriccardi/Melody Player"
## Usage
Here a quick overview of the main methods to use this library. Initialize MelodyPlayer by specifying the pin where the buzzer is attached to:
MelodyPlayer player(4);
Load the RTTTL melody from file (remember to initialize the file system before this call):
Melody melody = MelodyFactory.loadRtttlFile("/the-anthem.rtttl");
Check if the melody is loaded correctly:
if(!melody) {
Serial.println("Cannot play this melody");
}
Play it using blocking or non-blocking methods:
player.play(melody);
or
player.playAsync(melody);
In case of non-blocking playback, you can check if the melody is running:
if(player.isPlaying()){
Serial.println("Playing...");
}
and pause/continue to play/stop the melody through:
player.pause();
player.play();
player.stop();
## Details about the custom format
You can write a melody in a text file, accordingly to the following specifications:
title={Name of the melody}
timeUnit={Base time in millisecond}
length={Array length}
format={This value can be "integer" or "string", and it specifies how the tone frequency is represented in the following array}
{Array composed by pair <frequency; duration> and spit by '|' (pipe character)}
where:
* *frequency* can be either an integer number or a string, depending on what specified in "format" parameter. If format type is "string", it represents a note in English convention e.g. E5, F1
* *duration* is an integer expressed in "timeUnits"
A small pause is automatically added between 2 consecutive pairs. You can add comments using '#' at the begin of the line.
Example 1: this melody codifies 2 "beeps" using the "string" codification:
title=Beep
timeUnit=200
length=1
format=string
G7,3|SILENCE,1|G7,3
Example 2: the same melody using the "integer" codification:
title=Beep
timeUnit=200
length=1
format=integer
3136,3|0,1|3136,3
## Useful links
* <https://panuworld.net/nuukiaworld/download/nokix/rtttl.htm>: RTTTL specification
* <https://adamonsoon.github.io/rtttl-play/>: Test and listen RTTTL melodies

20
lib/Melody Player/keywords.txt Normal file
View File

@@ -0,0 +1,20 @@
Melody KEYWORD1
MelodyPlayer KEYWORD1
MelodyFactory KEYWORD1
play KEYWORD2
playAsync KEYWORD2
isPlaying KEYWORD2
stop KEYWORD2
pause KEYWORD2
transferMelodyTo KEYWORD2
duplicateMelodyTo KEYWORD2
getTitle KEYWORK2
getTimeUnit KEYWORD2
getLength KEYWORD2
getNote KEYWORD2
getAutomaticSilence KEYWORD2
isValid KEYWORD2
load KEYWORD2

81
lib/Melody Player/library.json Normal file
View File

@@ -0,0 +1,81 @@
{
"name": "Melody Player",
"version": "2.4.0",
"authors": {
"name": "Fabiano Riccardi",
"email": "fabiano.riccardi@outlook.com"
},
"description": "This library provides an intuitive interface to play melodies on buzzers. The melodies can be stored in file systems (SPIFFS or LittleFS) or hardcoded in your sketch. Support RTTTL.",
"keywords": [
"buzzer",
"tune",
"melody",
"rtttl",
"piezo",
"arduino-library",
"sound"
],
"repository": {
"type": "git",
"url": "https://github.com/fabianoriccardi/melody-player"
},
"licence": "LGPL-2.1-or-later",
"frameworks": [
"arduino"
],
"platforms": [
"espressif8266",
"espressif32"
],
"examples": [
{
"name": "1_simple_play",
"base": "examples/1_simple_play",
"files": [
"1_simple_play.ino"
]
},
{
"name": "2_control_melody",
"base": "examples/2_control_melody",
"files": [
"2_control_melody.ino"
]
},
{
"name": "3_load_melody_from_file",
"base": "examples/3_load_melody_from_file",
"files": [
"3_load_melody_from_file.ino"
]
},
{
"name": "4_load_rtttl_melody",
"base": "examples/4_load_rtttl_melody",
"files": [
"4_load_rtttl_melody.ino"
]
},
{
"name": "5_play_melodies_simultaneously",
"base": "examples/5_play_melodies_simultaneously",
"files": [
"5_play_melodies_simultaneously.ino"
]
},
{
"name": "6_transfer_playing_melody",
"base": "examples/6_transfer_playing_melody",
"files": [
"6_transfer_playing_melody.ino"
]
},
{
"name": "7_duplicate_playing_melody",
"base": "examples/7_duplicate_playing_melody",
"files": [
"7_duplicate_playing_melody.ino"
]
}
]
}

9
lib/Melody Player/library.properties Normal file
View File

@@ -0,0 +1,9 @@
name=Melody Player
version=2.4.0
author=Fabiano Riccardi <fabiano.riccardi@outlook.com>
maintainer=Fabiano Riccardi <fabiano.riccardi@outlook.com>
sentence=This library provides an intuitive interface to play melodies on buzzers
paragraph=The melodies can be stored in file systems (SPIFFS or LittleFS) or hardcoded in your sketch. Support RTTTL.
category=Device Control
url=https://github.com/fabianoriccardi/melody-player
architectures=esp8266,esp32

28
lib/Melody Player/platformio.ini Normal file
View File

@@ -0,0 +1,28 @@
[env]
monitor_speed = 115200
upload_speed = 921600
#upload_port = COM6
build_flags = -Wall -Wextra
#board_build.filesystem = littlefs
[platformio]
# Uncomment the example to need to compile
src_dir = examples/1_simple_play
#src_dir = examples/2_control_melody
#src_dir = examples/3_load_melody_from_file
#src_dir = examples/4_load_rtttl_melody
#src_dir = examples/5_play_melodies_simultaneously
#src_dir = examples/6_transfer_playing_melody
#src_dir = examples/7_duplicate_playing_melody
lib_dir = .
#data_dir=examples/4_load_rtttl_melody/data
[env:esp8266]
platform = espressif8266
board = d1_mini
framework = arduino
[env:esp32]
platform = espressif32
board = lolin32
framework = arduino

114
lib/Melody Player/src/melody.h Normal file
View File

@@ -0,0 +1,114 @@
/***************************************************************************
* This file is part of Melody Player, a library for Arduino *
* to play notes on piezoelectric buzzers. *
* *
* Copyright (C) 2020-2022 Fabiano Riccardi *
* *
* This library is free software; you can redistribute *
* it and/or modify it under the terms of the GNU Lesser General Public *
* License as published by the Free Software Foundation; either *
* version 2.1 of the License, or (at your option) any later version. *
* *
* This library 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 *
* Lesser General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this library; if not, see <http://www.gnu.org/licenses/> *
***************************************************************************/
#ifndef MELODY_H
#define MELODY_H
#include <Arduino.h>
#include <memory>
#include <vector>
/**
* A note and its duration.
*/
struct NoteDuration {
// The note frequency.
unsigned short frequency;
// The note duration. The representation can be either relative (fixed-point, decimal
// part = 1 bit) to time units or absolute (in milliseconds)
unsigned short duration;
};
/**
* This class stores the data melody (notes and metadata).
* To ease the creation of a melody, you should use MelodyFactory class.
*/
class Melody {
public:
Melody() : notes(nullptr){};
Melody(String title, unsigned short timeUnit, std::shared_ptr<std::vector<NoteDuration>> notes, bool automaticSilence)
: title(title), timeUnit(timeUnit), notes(notes), automaticSilence(automaticSilence){};
/**
* Return the title of the melody.
*/
String getTitle() const {
return title;
};
/**
* Return the time unit (i.e. the minimum length of a note), in milliseconds.
*/
unsigned short getTimeUnit() const {
return timeUnit;
};
/**
* Get the number of notes.
*/
unsigned short getLength() const {
if (notes == nullptr) return 0;
return (*notes).size();
}
/**
* Get the note at the given position.
* If the melody or the position is invalid, return a zeroed NoteDuration.
*/
NoteDuration getNote(unsigned short i) const {
if (i < getLength()) { return (*notes)[i]; }
return { 0, 0 };
}
/**
* Return true if the melody should be played with a small delay between each note.
*/
bool getAutomaticSilence() const {
return automaticSilence;
}
/**
* Return true if the melody is valid, false otherwise.
*/
bool isValid() const {
return notes != nullptr && (*notes).size() != 0;
}
/**
* Return true if the melody is valid, false otherwise.
*/
explicit operator bool() const {
return isValid();
}
private:
String title;
// in milliseconds
unsigned short timeUnit;
std::shared_ptr<std::vector<NoteDuration>> notes;
const static unsigned short maxLength = 1000;
bool automaticSilence;
// Enable debug messages over serial port
const static bool debug = false;
};
#endif // END MELODY_H

229
lib/Melody Player/src/melody_factory.cpp Normal file
View File

@@ -0,0 +1,229 @@
/***************************************************************************
* This file is part of Melody Player, a library for Arduino *
* to play notes on piezoelectric buzzers. *
* *
* Copyright (C) 2020-2022 Fabiano Riccardi *
* *
* This library is free software; you can redistribute *
* it and/or modify it under the terms of the GNU Lesser General Public *
* License as published by the Free Software Foundation; either *
* version 2.1 of the License, or (at your option) any later version. *
* *
* This library 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 *
* Lesser General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this library; if not, see <http://www.gnu.org/licenses/> *
***************************************************************************/
#include "melody_factory.h"
#include "notes_array.h"
#include <LittleFS.h>
#include <algorithm>
static void removeCarriageReturn(String& s) {
if (s.charAt(s.length() - 1) == '\r') { s = s.substring(0, s.length() - 1); }
}
Melody MelodyFactoryClass::load(String filepath, FS& fs) {
File f = LittleFS.open(filepath, "r");
f.setTimeout(0);
if (!f) {
if (debug) Serial.println("Opening file error");
return Melody();
}
// Skip multi-line comments at the begin of the file
String line = f.readStringUntil('\n');
while (line.charAt(0) == '#') { line = f.readStringUntil('\n'); }
bool success = false;
success = loadTitle(line);
if (!success) { return Melody(); }
success = loadTimeUnit(f.readStringUntil('\n'));
if (!success) { return Melody(); }
success = loadNumberOfNotes(f.readStringUntil('\n'));
if (!success) { return Melody(); }
NoteFormat noteFormat = loadNoteFormat(f.readStringUntil('\n'));
if (noteFormat == NoteFormat::ERROR) {
return Melody();
} else {
this->noteFormat = noteFormat;
}
if (debug)
Serial.println(String("This melody object will take at least: ") + (sizeof(NoteDuration) * nNotes) + "bytes");
if (nNotes < maxLength) {
notes = std::make_shared<std::vector<NoteDuration>>();
notes->reserve(nNotes);
bool error = false;
while (f.available() && notes->size() < nNotes && !error) {
// get a token
String noteDuration = f.readStringUntil('|');
error = !loadNote(noteDuration);
}
if (error) {
if (debug) Serial.println("error during the tokens loading!");
return Melody();
}
}
return Melody(title, timeUnit, notes, true);
}
Melody MelodyFactoryClass::load(String title, unsigned short timeUnit, String notesToLoad[],
unsigned short nNotesToLoad, bool autoSilence) {
if (title.length() == 0 && timeUnit <= 20) { return Melody(); }
if (nNotesToLoad == 0 || nNotesToLoad > maxLength) { return Melody(); }
if (notesToLoad == nullptr) { return Melody(); }
notes = std::make_shared<std::vector<NoteDuration>>();
notes->reserve(nNotesToLoad);
noteFormat = NoteFormat::STRING;
bool error = false;
while (this->notes->size() < nNotesToLoad && !error) {
String noteDuration = notesToLoad[notes->size()] + ",1";
error = !loadNote(noteDuration);
}
if (error) { return Melody(); }
return Melody(title, timeUnit, notes, autoSilence);
}
Melody MelodyFactoryClass::load(String title, unsigned short timeUnit, int frequenciesToLoad[],
unsigned short nFrequenciesToLoad, bool autoSilence) {
if (title.length() == 0 && timeUnit <= 20) { return Melody(); }
if (nFrequenciesToLoad == 0 || nFrequenciesToLoad > maxLength) { return Melody(); }
if (frequenciesToLoad == nullptr) { return Melody(); }
notes = std::make_shared<std::vector<NoteDuration>>();
notes->reserve(nFrequenciesToLoad);
noteFormat = NoteFormat::INTEGER;
bool error = false;
while (this->notes->size() < nFrequenciesToLoad && !error) {
String noteDuration = String(frequenciesToLoad[notes->size()]) + ",1";
error = !loadNote(noteDuration);
}
if (error) { return Melody(); }
return Melody(title, timeUnit, notes, autoSilence);
}
bool MelodyFactoryClass::loadTitle(String line) {
removeCarriageReturn(line);
if (debug) Serial.println(String("Reading line:--") + line + "-- Len:" + line.length());
if (line.startsWith("title")) {
// Skip also '='
String title = line.substring(6);
this->title = title;
return true;
}
return false;
}
bool MelodyFactoryClass::loadTimeUnit(String line) {
removeCarriageReturn(line);
if (debug) Serial.println(String("Reading line:--") + line + "-- Len:" + line.length());
if (line.startsWith("timeUnit")) {
// Skip '='
String t = line.substring(9);
this->timeUnit = t.toInt();
if (debug) Serial.println(this->timeUnit);
if (this->timeUnit > 20) { return true; }
}
return false;
}
bool MelodyFactoryClass::loadNumberOfNotes(String line) {
removeCarriageReturn(line);
if (debug) Serial.println(String("Reading line:--") + line + "-- Len:" + line.length());
if (line.startsWith("length")) {
// Skip also '='
String len = line.substring(7);
this->nNotes = len.toInt();
if (debug) Serial.println(this->nNotes);
return true;
}
return false;
}
MelodyFactoryClass::NoteFormat MelodyFactoryClass::loadNoteFormat(String line) {
removeCarriageReturn(line);
if (debug) Serial.println(String("Reading line:--") + line + "-- Len:" + line.length());
String format;
if (line.startsWith("format")) {
// Skip also '='
format = line.substring(7);
if (debug) Serial.println(format);
}
NoteFormat noteFormat = NoteFormat::ERROR;
if (format == "string") {
noteFormat = NoteFormat::STRING;
} else if (format == "integer") {
noteFormat = NoteFormat::INTEGER;
}
return noteFormat;
}
bool MelodyFactoryClass::loadNote(String token) {
token.trim();
NoteDuration note;
if (debug) Serial.println(String("note+duration: ") + token);
String aux;
unsigned int j = 0;
// Get the frequency
while (j < token.length() && token.charAt(j) != ',') {
aux += token.charAt(j);
j++;
}
if (noteFormat == NoteFormat::STRING) {
auto n = std::find_if(noteMapping.cbegin(), noteMapping.cend(),
[&aux](std::pair<StringView, unsigned short> e) {
return e.first == aux.c_str();
});
if (n != noteMapping.cend()) {
note.frequency = n->second;
} else {
if (debug) Serial.println(String("This note doesn't exist: ") + aux);
return false;
}
} else if (noteFormat == NoteFormat::INTEGER) {
note.frequency = aux.toInt();
}
if (debug) Serial.println(String("freq: ") + note.frequency);
j++;
aux = "";
while (j < token.length()) {
aux += token.charAt(j);
j++;
}
note.duration = aux.toInt();
if (debug) Serial.println(String("duration: ") + note.duration);
// The representation of relative note duration is fixed-point with decimal part length = 1bit
note.duration *= 2;
notes->push_back(note);
return true;
}
MelodyFactoryClass MelodyFactory;

163
lib/Melody Player/src/melody_factory.h Normal file
View File

@@ -0,0 +1,163 @@
/***************************************************************************
* This file is part of Melody Player, a library for Arduino *
* to play notes on piezoelectric buzzers. *
* *
* Copyright (C) 2020-2022 Fabiano Riccardi *
* *
* This library is free software; you can redistribute *
* it and/or modify it under the terms of the GNU Lesser General Public *
* License as published by the Free Software Foundation; either *
* version 2.1 of the License, or (at your option) any later version. *
* *
* This library 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 *
* Lesser General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this library; if not, see <http://www.gnu.org/licenses/> *
***************************************************************************/
#ifndef MELODY_FACTORY_H
#define MELODY_FACTORY_H
#include "melody.h"
#include <FS.h>
#ifdef ESP32
#include <SPIFFS.h>
#endif
class MelodyFactoryClass {
public:
/**
* Load the melody from file in MelodyPlayer format.
*/
Melody load(String filePath, FS& fs = SPIFFS);
/**
* Load melody from file in RTTTL format. The file must contain only one melody.
*/
Melody loadRtttlFile(String filePath, FS& fs = SPIFFS);
/**
* Load melody with the given title from a file containing multiple RTTTL melody (one Melody per
* line).
*/
Melody loadRtttlDB(String filepath, String title, FS& fs = SPIFFS);
/**
* Load melody from string in RTTTL format.
*/
Melody loadRtttlString(const char rtttlMelody[]);
/**
* Create a melody with the given parameters.
* Notes are represented as string accordigly to english notation (i.e. "C4", "G3", "G6").
* This method assumes that each note lasts 1 beat.
* frequenciesToLoad are integer numbers expressing the real reproduced frequency.
* automaticSilence, if true, automatically inserts a small silence between 2 consecutive notes.
*/
Melody load(String title, unsigned short timeUnit, String notesToLoad[],
unsigned short nNotesToLoad, bool autoSilence = true);
/**
* Create a melody with the given parameters.
* This method assumes that each note lasts 1 beat.
* frequenciesToLoad are integer numbers expressing the real reproduced frequency.
* The last parameter, automaticSilence, if true, automatically inserts a small silence between 2
* consecutive notes.
*/
Melody load(String title, unsigned short timeUnit, int frequenciesToLoad[],
unsigned short nFrequenciesToLoad, bool autoSilence = true);
private:
enum class NoteFormat { ERROR, STRING, INTEGER };
String title;
unsigned short timeUnit;
NoteFormat noteFormat;
std::shared_ptr<std::vector<NoteDuration>> notes;
// Used to check how many notes are stored in a file.
unsigned short nNotes;
const unsigned short maxLength = 1000;
///////////// RTTTL helpers
/**
* The default duration of a note. For example,
* "4" means that each note with no duration specifier
* is by default considered a quarter note. Possibile values:
* 1 - whole note
* 2 - half note
* 4 - quarter note
* 8 - eighth note
* 16 - sixteenth note
* 32 - thirty-second note
*/
const unsigned short defaultDuration = 4;
unsigned short duration;
/**
* The default octave. There are four octaves in the RTTTL format [4-7].
*/
const unsigned short defaultOctave = 6;
unsigned short octave;
/**
* The default BPM (beats per minute) value. BPM is arbitrarily limited between 10 and 300. Look
* at the implementation of parseBeat for more info.
*/
const unsigned short defaultBeat = 63;
unsigned short beat;
/**
* Try to parse the default parameters of RTTTL melody.
* If user-defined defaults are not found it sets the default values as prescribed by RTTTL
* specification.
*/
void parseDefaultValues(String values);
unsigned int parseDuration(const String& s, int& startFrom);
unsigned int parseOctave(const String& s, int& startFrom);
unsigned int parseBeat(const String& s, int& startFrom);
bool parseRtttlNote(const String& s);
//////////// END RTTTL helpers
/**
* Parse the title from the given string.
* Return true on success.
*/
bool loadTitle(String line);
/**
* Parse the time unit from the given string.
* Return true on success.
*/
bool loadTimeUnit(String line);
/**
* Parse the number of notes from the given string.
* Return true on success.
*/
bool loadNumberOfNotes(String line);
/**
* Parse the note's format from the given string.
*/
NoteFormat loadNoteFormat(String line);
/**
* Parse a token (a note and its duration) from the given string.
* The format of this token is:
* <note> + ',' + <duration>.
* Return true if the parsing succeeds, false otherwise.
*/
bool loadNote(String token);
// Enable debug messages over serial port
static const bool debug = false;
};
extern MelodyFactoryClass MelodyFactory;
#endif // END MELODY_FACTORY_H

368
lib/Melody Player/src/melody_factory_rtttl.cpp Normal file
View File

@@ -0,0 +1,368 @@
/***************************************************************************
* This file is part of Melody Player, a library for Arduino *
* to play notes on piezoelectric buzzers. *
* *
* Copyright (C) 2020-2022 Fabiano Riccardi *
* *
* This library is free software; you can redistribute *
* it and/or modify it under the terms of the GNU Lesser General Public *
* License as published by the Free Software Foundation; either *
* version 2.1 of the License, or (at your option) any later version. *
* *
* This library 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 *
* Lesser General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this library; if not, see <http://www.gnu.org/licenses/> *
***************************************************************************/
#include "melody_factory.h"
#include "notes.h"
#include <LittleFS.h>
// clang-format off
const uint16_t sourceNotes[] = {
0,
NOTE_C4,
NOTE_CS4,
NOTE_D4,
NOTE_DS4,
NOTE_E4,
NOTE_F4,
NOTE_FS4,
NOTE_G4,
NOTE_GS4,
NOTE_A4,
NOTE_AS4,
NOTE_B4,
NOTE_C5,
NOTE_CS5,
NOTE_D5,
NOTE_DS5,
NOTE_E5,
NOTE_F5,
NOTE_FS5,
NOTE_G5,
NOTE_GS5,
NOTE_A5,
NOTE_AS5,
NOTE_B5,
NOTE_C6,
NOTE_CS6,
NOTE_D6,
NOTE_DS6,
NOTE_E6,
NOTE_F6,
NOTE_FS6,
NOTE_G6,
NOTE_GS6,
NOTE_A6,
NOTE_AS6,
NOTE_B6,
NOTE_C7,
NOTE_CS7,
NOTE_D7,
NOTE_DS7,
NOTE_E7,
NOTE_F7,
NOTE_FS7,
NOTE_G7,
NOTE_GS7,
NOTE_A7,
NOTE_AS7,
NOTE_B7,
2 * NOTE_C7,
2 * NOTE_CS7,
2 * NOTE_D7,
2 * NOTE_DS7,
2 * NOTE_E7,
2 * NOTE_F7,
2 * NOTE_FS7,
2 * NOTE_G7,
2 * NOTE_GS7,
2 * NOTE_A7,
2 * NOTE_AS7,
2 * NOTE_B7,
};
// clang-format on
Melody MelodyFactoryClass::loadRtttlFile(String filepath, FS& fs) {
File f = LittleFS.open(filepath, "r");
f.setTimeout(0);
if (!f) {
if (debug) Serial.println("Opening file error");
return Melody();
}
String title = f.readStringUntil(':');
title.trim();
if (debug) Serial.println(String("Title:") + title);
if (title.length() == 0) { return Melody(); }
String values = f.readStringUntil(':');
values.trim();
if (debug) Serial.println(String("Default values:") + values);
if (values.length() == 0) { return Melody(); }
parseDefaultValues(values);
// 32 because it is the shortest note!
int timeUnit = 60 * 1000 * 4 / beat / 32;
notes = std::make_shared<std::vector<NoteDuration>>();
bool result = true;
while (f.available() && notes->size() < maxLength && result) {
String s = f.readStringUntil(',');
s.trim();
result = parseRtttlNote(s);
}
if (result && notes->size() > 0) { return Melody(title, timeUnit, notes, false); }
return Melody();
}
Melody MelodyFactoryClass::loadRtttlDB(String filepath, String title, FS& fs) {
File f = LittleFS.open(filepath, "r");
f.setTimeout(0);
if (!f) {
if (debug) Serial.println("Opening file error");
return Melody();
}
if (title.length() == 0) {
if (debug) Serial.println("Title length = 0");
return Melody();
}
if (!f.find(title.c_str())) {
if (debug) Serial.println("Unable to find melody with title: " + String(title));
return Melody();
}
f.readStringUntil(':');
String values = f.readStringUntil(':');
values.trim();
if (debug) Serial.println(String("Default values:") + values);
if (values.length() == 0) { return Melody(); }
parseDefaultValues(values);
// 32 because it is the shortest note!
int timeUnit = 60 * 1000 * 4 / beat / 32;
size_t position = f.position();
int bytesUntilNewLine = f.readStringUntil('\n').length();
f.seek(position);
notes = std::make_shared<std::vector<NoteDuration>>();
bool result = true;
while (f.available() && notes->size() < maxLength && result && bytesUntilNewLine > 0) {
String s = f.readStringUntil(',');
if (s.length() > bytesUntilNewLine) { s = s.substring(0, bytesUntilNewLine); }
bytesUntilNewLine -= s.length() + 1;
s.trim();
result = parseRtttlNote(s);
}
if (result && notes->size() > 0) { return Melody(title, timeUnit, notes, false); }
return Melody();
}
Melody MelodyFactoryClass::loadRtttlString(const char rtttlMelody[]) {
String title;
int i = 0;
while (rtttlMelody[i] != 0 && rtttlMelody[i] != ':') {
title.concat(rtttlMelody[i]);
i++;
}
if (title.length() == 0 || rtttlMelody[i] == 0) { return Melody(); }
// skip ':'
i++;
String defaultParameters;
while (rtttlMelody[i] != 0 && rtttlMelody[i] != ':') {
defaultParameters.concat(rtttlMelody[i]);
i++;
}
if (rtttlMelody[i] == 0) { return Melody(); }
defaultParameters.trim();
parseDefaultValues(defaultParameters);
// 32 because it is the shortest note!
int timeUnit = 60 * 1000 * 4 / beat / 32;
// skip ':'
i++;
notes = std::make_shared<std::vector<NoteDuration>>();
// Read notes
while (rtttlMelody[i] != 0) {
String note;
while (rtttlMelody[i] != 0 && rtttlMelody[i] != ',') {
note.concat(rtttlMelody[i]);
i++;
}
note.trim();
parseRtttlNote(note);
if (rtttlMelody[i] == ',') { i++; }
}
if (notes->size() > 0) { return Melody(title, timeUnit, notes, false); }
return Melody();
}
/**
* Parse an unsigned integer starting from the given startFrom to the first non-digit char.
* Return zero if it cannot parse a number. *startFrom* will point to the first non-digit char.
*/
unsigned int getUnsignedInt(const String& s, int& startFrom) {
unsigned int temp = 0;
while (isDigit(s.charAt(startFrom))) {
temp = (temp * 10) + s.charAt(startFrom) - '0';
startFrom++;
}
return temp;
}
unsigned int MelodyFactoryClass::parseDuration(const String& s, int& startFrom) {
// Skip '='
startFrom++;
unsigned int temp = getUnsignedInt(s, startFrom);
if (temp != 1 && temp != 2 && temp != 4 && temp != 8 && temp != 16 && temp != 32) { return 0; }
// Discard ','
startFrom++;
return temp;
}
unsigned int MelodyFactoryClass::parseOctave(const String& s, int& startFrom) {
// Skip '='
startFrom++;
unsigned int temp = getUnsignedInt(s, startFrom);
if (temp < 4 || temp > 7) { return 0; }
// Discard ','
startFrom++;
return temp;
}
unsigned int MelodyFactoryClass::parseBeat(const String& s, int& startFrom) {
// Skip '='
startFrom++;
unsigned int temp = getUnsignedInt(s, startFrom);
// BPM is arbitrarily limited to 300. You may try to increase it, but remember that
// actually, the minimum note length is 60(seconds)/300(bpm)/32(minimum note length) = 6.25ms.
// If you reduce this duration, you may not be able to keep up the pace to play a smooth
// async playback while doing other operations.
if (!(10 <= temp && temp <= 300)) { return 0; }
// Discard ','
startFrom++;
return temp;
}
bool MelodyFactoryClass::parseRtttlNote(const String& s) {
int i = 0;
unsigned short relativeDuration = this->duration;
// Optional number: note duration (e.g 4=quarter note, ...)
if (isdigit(s.charAt(i))) {
unsigned int temp = getUnsignedInt(s, i);
if (temp) { relativeDuration = temp; }
}
// To match struct NoteDuration format, I need the direct
// note length, instead RTTTL provides the denominator
// of the whole note
if (relativeDuration == 32) {
relativeDuration = 1;
} else if (relativeDuration == 16) {
relativeDuration = 2;
} else if (relativeDuration == 8) {
relativeDuration = 4;
} else if (relativeDuration == 4) {
relativeDuration = 8;
} else if (relativeDuration == 2) {
relativeDuration = 16;
} else if (relativeDuration == 1) {
relativeDuration = 32;
} else {
relativeDuration = 0;
}
// note (p is silence)
int note = 0;
switch (s.charAt(i)) {
case 'c': note = 1; break;
case 'd': note = 3; break;
case 'e': note = 5; break;
case 'f': note = 6; break;
case 'g': note = 8; break;
case 'a': note = 10; break;
case 'b': note = 12; break;
case 'p':
default: note = 0;
}
i++;
// Optional #
if (s.charAt(i) == '#') {
note++;
i++;
}
// The representation of relative note duration is fixed-point with decimal part length = 1bit
relativeDuration *= 2;
// get optional '.' dotted note
// This note will last 50% more
if (s.charAt(i) == '.') {
relativeDuration += relativeDuration / 2;
i++;
}
int scale;
// now, get scale
if (isdigit(s.charAt(i))) {
scale = s.charAt(i) - '0';
i++;
} else {
scale = octave;
}
unsigned short freq;
if (note) {
freq = sourceNotes[(scale - 4) * 12 + note];
} else {
freq = 0;
}
notes->push_back({ .frequency = freq, .duration = relativeDuration });
return true;
}
void MelodyFactoryClass::parseDefaultValues(String values) {
int i = 0;
if (values.charAt(i) == 'd') { i++; }
duration = parseDuration(values, i);
if (duration == 0) { duration = defaultDuration; }
if (values.charAt(i) == 'o') { i++; }
octave = parseOctave(values, i);
if (octave == 0) { octave = defaultOctave; }
if (values.charAt(i) == 'b') {
i++;
beat = parseBeat(values, i);
}
if (beat == 0) { beat = defaultBeat; }
}

230
lib/Melody Player/src/melody_player.cpp Normal file
View File

@@ -0,0 +1,230 @@
/***************************************************************************
* This file is part of Melody Player, a library for Arduino *
* to play notes on piezoelectric buzzers. *
* *
* Copyright (C) 2020-2022 Fabiano Riccardi *
* *
* This library is free software; you can redistribute *
* it and/or modify it under the terms of the GNU Lesser General Public *
* License as published by the Free Software Foundation; either *
* version 2.1 of the License, or (at your option) any later version. *
* *
* This library 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 *
* Lesser General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this library; if not, see <http://www.gnu.org/licenses/> *
***************************************************************************/
#include "melody_player.h"
/**
* https://stackoverflow.com/questions/24609271/errormake-unique-is-not-a-member-of-std
*/
template<typename T, typename... Args> std::unique_ptr<T> make_unique(Args&&... args) {
return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
}
void MelodyPlayer::play() {
if (melodyState == nullptr) { return; }
turnOn();
state = State::PLAY;
melodyState->advance();
while (melodyState->getIndex() + melodyState->isSilence() < melodyState->melody.getLength()) {
NoteDuration computedNote = melodyState->getCurrentComputedNote();
if (debug)
Serial.println(String("Playing: frequency:") + computedNote.frequency
+ " duration:" + computedNote.duration);
if (melodyState->isSilence()) {
#ifdef ESP32
ledcWriteTone(pwmChannel, 0);
#else
noTone(pin);
#endif
delay(0.3f * computedNote.duration);
} else {
#ifdef ESP32
ledcWriteTone(pwmChannel, computedNote.frequency);
#else
tone(pin, computedNote.frequency);
#endif
delay(computedNote.duration);
}
melodyState->advance();
}
stop();
}
void MelodyPlayer::play(Melody& melody) {
if (!melody) { return; }
melodyState = make_unique<MelodyState>(melody);
play();
}
void changeTone(MelodyPlayer* player) {
// The last silence is not reproduced
player->melodyState->advance();
if (player->melodyState->getIndex() + player->melodyState->isSilence()
< player->melodyState->melody.getLength()) {
NoteDuration computedNote(player->melodyState->getCurrentComputedNote());
float duration = player->melodyState->getRemainingNoteDuration();
if (duration > 0) {
player->melodyState->resetRemainingNoteDuration();
} else {
if (player->melodyState->isSilence()) {
duration = 0.3f * computedNote.duration;
} else {
duration = computedNote.duration;
}
}
if (player->debug)
Serial.println(String("Playing async: freq=") + computedNote.frequency + " dur=" + duration
+ " iteration=" + player->melodyState->getIndex());
if (player->melodyState->isSilence()) {
#ifdef ESP32
ledcWriteTone(player->pwmChannel, 0);
#else
tone(player->pin, 0);
#endif
#ifdef ESP32
player->ticker.once_ms(duration, changeTone, player);
#else
player->ticker.once_ms_scheduled(duration, std::bind(changeTone, player));
#endif
} else {
#ifdef ESP32
ledcWriteTone(player->pwmChannel, computedNote.frequency);
#else
tone(player->pin, computedNote.frequency);
#endif
#ifdef ESP32
player->ticker.once_ms(duration, changeTone, player);
#else
player->ticker.once_ms_scheduled(duration, std::bind(changeTone, player));
#endif
}
player->supportSemiNote = millis() + duration;
} else {
player->stop();
}
}
void MelodyPlayer::playAsync() {
if (melodyState == nullptr) { return; }
turnOn();
state = State::PLAY;
// Start immediately
#ifdef ESP32
ticker.once(0, changeTone, this);
#else
ticker.once_scheduled(0, std::bind(changeTone, this));
#endif
}
void MelodyPlayer::playAsync(Melody& melody) {
if (!melody) { return; }
melodyState = make_unique<MelodyState>(melody);
playAsync();
}
void MelodyPlayer::stop() {
if (melodyState == nullptr) { return; }
haltPlay();
state = State::STOP;
melodyState->reset();
}
void MelodyPlayer::pause() {
if (melodyState == nullptr) { return; }
haltPlay();
state = State::PAUSE;
melodyState->saveRemainingNoteDuration(supportSemiNote);
}
void MelodyPlayer::transferMelodyTo(MelodyPlayer& destPlayer) {
if (melodyState == nullptr) { return; }
destPlayer.stop();
bool playing = isPlaying();
haltPlay();
state = State::STOP;
melodyState->saveRemainingNoteDuration(supportSemiNote);
destPlayer.melodyState = std::move(melodyState);
if (playing) {
destPlayer.playAsync();
} else {
destPlayer.state = state;
}
}
void MelodyPlayer::duplicateMelodyTo(MelodyPlayer& destPlayer) {
if (melodyState == nullptr) { return; }
destPlayer.stop();
destPlayer.melodyState = make_unique<MelodyState>(*(this->melodyState));
destPlayer.melodyState->saveRemainingNoteDuration(supportSemiNote);
if (isPlaying()) {
destPlayer.playAsync();
} else {
destPlayer.state = state;
}
}
#ifdef ESP32
MelodyPlayer::MelodyPlayer(unsigned char pin, unsigned char pwmChannel, bool offLevel)
: pin(pin), pwmChannel(pwmChannel), offLevel(offLevel), state(State::STOP), melodyState(nullptr) {
pinMode(pin, OUTPUT);
digitalWrite(pin, offLevel);
};
#else
MelodyPlayer::MelodyPlayer(unsigned char pin, bool offLevel)
: pin(pin), offLevel(offLevel), state(State::STOP), melodyState(nullptr) {
pinMode(pin, OUTPUT);
digitalWrite(pin, offLevel);
};
#endif
void MelodyPlayer::haltPlay() {
// Stop player, but do not reset the melodyState
ticker.detach();
turnOff();
}
void MelodyPlayer::turnOn() {
#ifdef ESP32
const int resolution = 8;
// 2000 is a frequency, it will be changed at the first play
ledcSetup(pwmChannel, 2000, resolution);
ledcAttachPin(pin, pwmChannel);
ledcWrite(pwmChannel, 125);
#endif
}
void MelodyPlayer::turnOff() {
#ifdef ESP32
ledcWrite(pwmChannel, 0);
ledcDetachPin(pin);
#else
// Remember that this will set LOW output, it doesn't mean that buzzer is off (look at offLevel
// for more info).
noTone(pin);
#endif
pinMode(pin, LOW);
digitalWrite(pin, offLevel);
}

248
lib/Melody Player/src/melody_player.h Normal file
View File

@@ -0,0 +1,248 @@
/***************************************************************************
* This file is part of Melody Player, a library for Arduino *
* to play notes on piezoelectric buzzers. *
* *
* Copyright (C) 2020-2022 Fabiano Riccardi *
* *
* This library is free software; you can redistribute *
* it and/or modify it under the terms of the GNU Lesser General Public *
* License as published by the Free Software Foundation; either *
* version 2.1 of the License, or (at your option) any later version. *
* *
* This library 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 *
* Lesser General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this library; if not, see <http://www.gnu.org/licenses/> *
***************************************************************************/
#ifndef MELODY_PLAYER_H
#define MELODY_PLAYER_H
#include "melody.h"
#include <Ticker.h>
#include <memory>
class MelodyPlayer {
public:
#ifdef ESP32
/**
* pwmChannel is optional and you have to configure it only if you play will
* simultaneous melodies.
*/
MelodyPlayer(unsigned char pin, unsigned char pwmChannel = 0, bool offLevel = HIGH);
#else
MelodyPlayer(unsigned char pin, bool offLevel = HIGH);
#endif
/**
* Play the last melody in a synchrounus (blocking) way.
* If the melody is not valid, this call has no effect.
*/
void play();
/**
* Play the given melody in a synchronous (blocking) way.
* If the melody is not valid, this call has no effect.
*/
void play(Melody& melody);
/**
* Play the last melody in asynchronous way (return immediately).
* If the melody is not valid, this call has no effect.
*/
void playAsync();
/**
* Play the given melody in asynchronous way (return immediately).
* If the melody is not valid, this call has no effect.
*/
void playAsync(Melody& melody);
/**
* Stop the current melody.
* Then, if you will call play() or playAsync(), the melody restarts from the begin.
*/
void stop();
/**
* Pause the current melody.
* Then, if you will call play() or playAsync(), the melody continues from
* where it was paused.
*/
void pause();
/**
* Tell if playing.
*/
bool isPlaying() const {
return state == State::PLAY;
}
/**
* Move the current melody and player's state to the given destination Player.
* The source player stops and lose the reference to the actual melody (i.e. you have to call
* play(Melody) to make the source player play again).
*/
void transferMelodyTo(MelodyPlayer& destination);
/**
* Duplicate the current melody and player's state to the given destination Player.
* Both players remains indipendent from each other (e.g. the melody can be independently
* stopped/paused/played).
*/
void duplicateMelodyTo(MelodyPlayer& destination);
private:
unsigned char pin;
#ifdef ESP32
unsigned char pwmChannel;
#endif
/**
* The voltage to turn off the buzzer.
*
* NOTE: Passive buzzers have 2 states: the "rest" state (no power consumption) and the "active"
* state (high power consumption). To emit sound, it have to oscillate between these 2 states. If
* it stops in the active state, it doesn't emit sound, but it continues to consume energy,
* heating the buzzer and possibly damaging itself.
*/
bool offLevel;
/**
* Store the playback state of a melody and provide the methods to control it.
*/
class MelodyState {
public:
MelodyState() : first(true), index(0), remainingNoteTime(0){};
MelodyState(const Melody& melody)
: melody(melody), first(true), silence(false), index(0), remainingNoteTime(0){};
Melody melody;
unsigned short getIndex() const {
return index;
}
bool isSilence() const {
return silence;
}
/**
* Advance the melody index by one step. If there is a pending partial note it hasn't any
* effect.
*/
void advance() {
if (first) {
first = false;
return;
}
if (remainingNoteTime != 0) { return; }
if (melody.getAutomaticSilence()) {
if (silence) {
index++;
silence = false;
} else {
silence = true;
}
} else {
index++;
}
}
/**
* Reset the state of the melody (i.e. a melody just loaded).
*/
void reset() {
first = true;
index = 0;
remainingNoteTime = 0;
silence = false;
}
/**
* Save the time to finish the current note.
*/
void saveRemainingNoteDuration(unsigned long supportSemiNote) {
remainingNoteTime = supportSemiNote - millis();
// Ignore partial reproduction if the current value is below the threshold. This is needed
// since Ticker may struggle with tight timings.
if (remainingNoteTime < 10) { remainingNoteTime = 0; }
}
/**
* Clear the partial note duration. It should be called after reproduction of the partial note
* and it is propedeutic to advance() method.
*/
void resetRemainingNoteDuration() {
remainingNoteTime = 0;
}
/**
* Get the remaining duration of the latest "saved" note.
*/
unsigned short getRemainingNoteDuration() const {
return remainingNoteTime;
}
/**
* Get the current note. The duration is absolute and expressed in milliseconds.
*/
NoteDuration getCurrentComputedNote() const {
NoteDuration note = melody.getNote(getIndex());
note.duration = melody.getTimeUnit() * note.duration;
// because the fixed point notation
note.duration /= 2;
return note;
}
private:
bool first;
bool silence;
unsigned short index;
/**
* Variable to support precise pauses and move/duplicate melodies between Players.
* Value are expressed in milliseconds.
*/
unsigned short remainingNoteTime;
};
enum class State { STOP, PLAY, PAUSE };
State state;
std::unique_ptr<MelodyState> melodyState;
unsigned long supportSemiNote;
Ticker ticker;
const static bool debug = false;
/**
* Change the current note with the next one.
*/
friend void changeTone(MelodyPlayer* melody);
/**
* Halt the advancement of the melody reproduction.
* This is the shared method for pause and stop.
*/
void haltPlay();
/**
* Configure pin to emit PWM.
*/
void turnOn();
/**
* Disable PWM and put the buzzer is low-power state.
* This calls will fails if PWM is not initialized!
*/
void turnOff();
};
#endif // END MELODY_PLAYER_H

89
lib/Melody Player/src/notes.h Normal file
View File

@@ -0,0 +1,89 @@
#define NOTE_B0 31
#define NOTE_C1 33
#define NOTE_CS1 35
#define NOTE_D1 37
#define NOTE_DS1 39
#define NOTE_E1 41
#define NOTE_F1 44
#define NOTE_FS1 46
#define NOTE_G1 49
#define NOTE_GS1 52
#define NOTE_A1 55
#define NOTE_AS1 58
#define NOTE_B1 62
#define NOTE_C2 65
#define NOTE_CS2 69
#define NOTE_D2 73
#define NOTE_DS2 78
#define NOTE_E2 82
#define NOTE_F2 87
#define NOTE_FS2 93
#define NOTE_G2 98
#define NOTE_GS2 104
#define NOTE_A2 110
#define NOTE_AS2 117
#define NOTE_B2 123
#define NOTE_C3 131
#define NOTE_CS3 139
#define NOTE_D3 147
#define NOTE_DS3 156
#define NOTE_E3 165
#define NOTE_F3 175
#define NOTE_FS3 185
#define NOTE_G3 196
#define NOTE_GS3 208
#define NOTE_A3 220
#define NOTE_AS3 233
#define NOTE_B3 247
#define NOTE_C4 262
#define NOTE_CS4 277
#define NOTE_D4 294
#define NOTE_DS4 311
#define NOTE_E4 330
#define NOTE_F4 349
#define NOTE_FS4 370
#define NOTE_G4 392
#define NOTE_GS4 415
#define NOTE_A4 440
#define NOTE_AS4 466
#define NOTE_B4 494
#define NOTE_C5 523
#define NOTE_CS5 554
#define NOTE_D5 587
#define NOTE_DS5 622
#define NOTE_E5 659
#define NOTE_F5 698
#define NOTE_FS5 740
#define NOTE_G5 784
#define NOTE_GS5 831
#define NOTE_A5 880
#define NOTE_AS5 932
#define NOTE_B5 988
#define NOTE_C6 1047
#define NOTE_CS6 1109
#define NOTE_D6 1175
#define NOTE_DS6 1245
#define NOTE_E6 1319
#define NOTE_F6 1397
#define NOTE_FS6 1480
#define NOTE_G6 1568
#define NOTE_GS6 1661
#define NOTE_A6 1760
#define NOTE_AS6 1865
#define NOTE_B6 1976
#define NOTE_C7 2093
#define NOTE_CS7 2217
#define NOTE_D7 2349
#define NOTE_DS7 2489
#define NOTE_E7 2637
#define NOTE_F7 2794
#define NOTE_FS7 2960
#define NOTE_G7 3136
#define NOTE_GS7 3322
#define NOTE_A7 3520
#define NOTE_AS7 3729
#define NOTE_B7 3951
#define NOTE_C8 4186
#define NOTE_CS8 4435
#define NOTE_D8 4699
#define NOTE_DS8 4978

147
lib/Melody Player/src/notes_array.h Normal file
View File

@@ -0,0 +1,147 @@
/***************************************************************************
* This file is part of Melody Player, a library for Arduino *
* to play notes on piezoelectric buzzers. *
* *
* Copyright (C) 2020-2022 Fabiano Riccardi *
* *
* This library is free software; you can redistribute *
* it and/or modify it under the terms of the GNU Lesser General Public *
* License as published by the Free Software Foundation; either *
* version 2.1 of the License, or (at your option) any later version. *
* *
* This library 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 *
* Lesser General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this library; if not, see <http://www.gnu.org/licenses/> *
***************************************************************************/
#ifndef PITCHES_UNORDERED_MAP_H
#define PITCHES_UNORDERED_MAP_H
#include <array>
/**
* This class resembles the std::string_view class introduced with c++17. MelodyPlayer uses this
* version to ensure retro-compatibility with esp8266-core v2.x.x, which uses GCC v4.8.2.
*/
struct StringView {
StringView() = delete;
constexpr StringView(const char* s) : str(s), lenght(__builtin_strlen(s)) {}
constexpr bool operator==(const StringView& other) const {
return lenght == other.lenght && (__builtin_memcmp(str, other.str, lenght) == 0);
}
constexpr size_t length() const {
return lenght;
}
constexpr const char* data() const {
return str;
}
private:
const char* str;
size_t lenght;
};
// clang-format off
constexpr std::array<std::pair<StringView, unsigned short>, 92> noteMapping{{
{"SILENCE", 0 },
{ "B0", 31 },
{ "C1", 33 },
{ "CS1", 35 },
{ "D1", 37 },
{ "DS1", 39 },
{ "D1", 37 },
{ "DS1", 39 },
{ "E1", 41 },
{ "F1", 44 },
{ "FS1", 46 },
{ "G1", 49 },
{ "GS1", 52 },
{ "A1", 55 },
{ "AS1", 58 },
{ "B1", 62 },
{ "C2", 65 },
{ "CS2", 69 },
{ "D2", 73 },
{ "DS2", 78 },
{ "E2", 82 },
{ "F2", 87 },
{ "FS2", 93 },
{ "G2", 98 },
{ "GS2", 104 },
{ "A2", 110 },
{ "AS2", 117 },
{ "B2", 123 },
{ "C3", 131 },
{ "CS3", 139 },
{ "D3", 147 },
{ "DS3", 156 },
{ "E3", 165 },
{ "F3", 175 },
{ "FS3", 185 },
{ "G3", 196 },
{ "GS3", 208 },
{ "A3", 220 },
{ "AS3", 233 },
{ "B3", 247 },
{ "C4", 262 },
{ "CS4", 277 },
{ "D4", 294 },
{ "DS4", 311 },
{ "E4", 330 },
{ "F4", 349 },
{ "FS4", 370 },
{ "G4", 392 },
{ "GS4", 415 },
{ "A4", 440 },
{ "AS4", 466 },
{ "B4", 494 },
{ "C5", 523 },
{ "CS5", 554 },
{ "D5", 587 },
{ "DS5", 622 },
{ "E5", 659 },
{ "F5", 698 },
{ "FS5", 740 },
{ "G5", 784 },
{ "GS5", 831 },
{ "A5", 880 },
{ "AS5", 932 },
{ "B5", 988 },
{ "C6", 1047},
{ "CS6", 1109},
{ "D6", 1175},
{ "DS6", 1245},
{ "E6", 1319},
{ "F6", 1397},
{ "FS6", 1480},
{ "G6", 1568},
{ "GS6", 1661},
{ "A6", 1760},
{ "AS6", 1865},
{ "B6", 1976},
{ "C7", 2093},
{ "CS7", 2217},
{ "D7", 2349},
{ "DS7", 2489},
{ "E7", 2637},
{ "F7", 2794},
{ "FS7", 2960},
{ "G7", 3136},
{ "GS7", 3322},
{ "A7", 3520},
{ "AS7", 3729},
{ "B7", 3951},
{ "C8", 4186},
{ "CS8", 4435},
{ "D8", 4699},
{ "DS8", 4978}
}};
// clang-format on
#endif // END PITCHES_UNORDERED_MAP_H

17
lib/TJpg_Decoder/.gitattributes vendored Normal file
View File

@@ -0,0 +1,17 @@
# Auto detect text files and perform LF normalization
* text=auto
# Custom for Visual Studio
*.cs diff=csharp
# Standard to msysgit
*.doc diff=astextplain
*.DOC diff=astextplain
*.docx diff=astextplain
*.DOCX diff=astextplain
*.dot diff=astextplain
*.DOT diff=astextplain
*.pdf diff=astextplain
*.PDF diff=astextplain
*.rtf diff=astextplain
*.RTF diff=astextplain

23
lib/TJpg_Decoder/.gitignore vendored Normal file
View File

@@ -0,0 +1,23 @@
# Windows thumbnail cache files
Thumbs.db
ehthumbs.db
ehthumbs_vista.db
# Folder config file
Desktop.ini
# Recycle Bin used on file shares
$RECYCLE.BIN/
# Windows Installer files
*.cab
*.msi
*.msm
*.msp
# Windows shortcuts
*.lnk
# =========================
# Operating System Files
# =========================

1
lib/TJpg_Decoder/.piopm Normal file
View File

@@ -0,0 +1 @@
{"type": "library", "name": "TJpg_Decoder", "version": "1.0.8", "spec": {"owner": "bodmer", "id": 6906, "name": "TJpg_Decoder", "requirements": null, "uri": null}}

19
lib/TJpg_Decoder/README.md Normal file
View File

@@ -0,0 +1,19 @@
Arduino TJpg_Decoder library
===========
This Arduino library supports the rendering of Jpeg files stored both on SD card and in arrays within program memory (FLASH) onto a TFT display. In addition images stored in the SPIFFS (ESP32, ESP8266) and LittleFS (ESP32, ESP8266, RP2040) Flash filing systems or alternatively "PROGMEM" arrays can be used.
The library has been tested on the Arduino Due, ESP32 and ESP8266 (e.g. NodeMCU 1.0), STM32 and RP2040 processors. Other processors should work too if they have sufficient memory. Use with the ESP32 requires Arduino board package 2.0.0 or later.
Jpeg files must be in 24bit format (8 bit not supported). Jpeg files in the "Progressive" format (where image data is compressed in multiple passes with progressively higher detail) are not supported either since this would require much more memory.
When storing the jpeg in a memory array bear in mind that some Arduino boards have a maximum 32767 byte limit for the maximum size of an array (32 KBytes minus 1 byte).
The decompression of Jpeg images needs more RAM than an UNO provides, thus this library is targetted at processors with more RAM. The decoder has a very small memory footprint, typically 3.5K Bytes of RAM (for workspace, Independent of Image Dimensions) and 3.5-8.5K Bytes of ROM for text and constants.
On a Mega the number of images stored in FLASH must be limited because it they are large enough to push the executable code start over the 64K 16 bit address limit then the Mega will fail to boot even though the sketch compiles and uploads correctly. This is a limitation imposed by the Arduino environment not this library! The Arduino Mega is not recommended as it does not reliably decode some jpeg images possibly due to a shortage of RAM. The Due will work fine with much bigger image sets in FLASH.
This library uses the TJpgDec decompressor engine detailed here:
http://elm-chan.org/fsw/tjpgd/00index.html
TJpgDec is a generic JPEG image decompressor module that highly optimized for small embedded systems.

27
lib/TJpg_Decoder/keywords.txt Normal file
View File

@@ -0,0 +1,27 @@
#######################################
# Syntax Coloring Map
#######################################
#######################################
# Datatypes (KEYWORD1)
#######################################
TJpg_Decoder KEYWORD1
#######################################
# Methods and Functions (KEYWORD2)
#######################################
TJpgDec KEYWORD2
TJpg_Decoder KEYWORD2
drawJpg KEYWORD2
drawSdJpg KEYWORD2
drawFsJpg KEYWORD2
getJpgSize KEYWORD2
getSdJpgSize KEYWORD2
getFsJpgSize KEYWORD2
setJpgScale KEYWORD2
setCallback KEYWORD2
//tft_output KEYWORD2

22
lib/TJpg_Decoder/library.json Normal file
View File

@@ -0,0 +1,22 @@
{
"name": "TJpg_Decoder",
"version": "1.0.8",
"keywords": "jpeg, jpg, tft, display, RP2040, STM32, ESP8266, ESP32",
"description": "A JPEG decoder library based on Tiny JPEG Decompressor",
"repository":
{
"type": "git",
"url": "https://github.com/Bodmer/TJpg_Decoder"
},
"authors":
[
{
"name": "Bodmer",
"email": "bodmer@anola.net",
"maintainer": true
}
],
"frameworks": "arduino",
"platforms": "raspberrypi, espressif8266, espressif32, ststm32",
"headers": "TJpg_Decoder.h"
}

10
lib/TJpg_Decoder/library.properties Normal file
View File

@@ -0,0 +1,10 @@
name=TJpg_Decoder
version=1.0.8
author=Bodmer
maintainer=Bodmer
sentence=A JPEG decoder based on tjpgd
paragraph=Renders jpeg images to TFT displays.
category=Display
url=https://github.com/Bodmer/TJpg_Decoder
architectures=*
includes=TJpg_Decoder.h

54
lib/TJpg_Decoder/license.txt Normal file
View File

@@ -0,0 +1,54 @@
This library incorporate the Tiny JPEG Decompressor code files:
"tjpgd.h" and "tjpgd.c". The licence for these files is:
/*----------------------------------------------------------------------------/
/ TJpgDec - Tiny JPEG Decompressor R0.01c (C)ChaN, 2019
/-----------------------------------------------------------------------------/
/ The TJpgDec is a generic JPEG decompressor module for tiny embedded systems.
/ This is a free software that opened for education, research and commercial
/ developments under license policy of following terms.
/
/ Copyright (C) 2019, ChaN, all right reserved.
/
/ * The TJpgDec module is a free software and there is NO WARRANTY.
/ * No restriction on use. You can use, modify and redistribute it for
/ personal, non-profit or commercial products UNDER YOUR RESPONSIBILITY.
/ * Redistributions of source code must retain the above copyright notice.
/
/
/-----------------------------------------------------------------------------/
This Arduino library "TJpd_Decoder" has been created by Bodmer, for all the
additional code the FreeBSD licence applies and is compatible with the GNU GPL:
vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvStartvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
Software License Agreement (FreeBSD License)
Copyright (c) 2019 Bodmer (https://github.com/Bodmer)
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
The views and conclusions contained in the software and documentation are those
of the authors and should not be interpreted as representing official policies,
either expressed or implied, of the FreeBSD Project.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^End^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

197
lib/TJpg_Decoder/src/TJpg_Decoder.cpp Normal file
View File

@@ -0,0 +1,197 @@
/*
TJpg_Decoder.cpp
Created by Bodmer 18/10/19
Modified by Blueforcer 02/23
Latest version here:
https://github.com/Bodmer/TJpg_Decoder
*/
#include "TJpg_Decoder.h"
// Create a class instance to be used by the sketch (defined as extern in header)
TJpg_Decoder TJpgDec;
/***************************************************************************************
** Function name: TJpg_Decoder
** Description: Constructor
***************************************************************************************/
TJpg_Decoder::TJpg_Decoder()
{
// Setup a pointer to this class for static functions
thisPtr = this;
}
/***************************************************************************************
** Function name: ~TJpg_Decoder
** Description: Destructor
***************************************************************************************/
TJpg_Decoder::~TJpg_Decoder()
{
// Bye
}
/***************************************************************************************
** Function name: setJpgScale
** Description: Set the reduction scale factor (1, 2, 4 or 8)
***************************************************************************************/
void TJpg_Decoder::setSwapBytes(bool swapBytes)
{
_swap = swapBytes;
}
/***************************************************************************************
** Function name: setJpgScale
** Description: Set the reduction scale factor (1, 2, 4 or 8)
***************************************************************************************/
void TJpg_Decoder::setJpgScale(uint8_t scaleFactor)
{
switch (scaleFactor)
{
case 1:
jpgScale = 0;
break;
case 2:
jpgScale = 1;
break;
case 4:
jpgScale = 2;
break;
case 8:
jpgScale = 3;
break;
default:
jpgScale = 0;
}
}
/***************************************************************************************
** Function name: setCallback
** Description: Set the sketch callback function to render decoded blocks
***************************************************************************************/
void TJpg_Decoder::setCallback(SketchCallback sketchCallback)
{
tft_output = sketchCallback;
}
/***************************************************************************************
** Function name: jd_input (declared static)
** Description: Called by tjpgd.c to get more data
***************************************************************************************/
unsigned int TJpg_Decoder::jd_input(JDEC *jdec, uint8_t *buf, unsigned int len)
{
TJpg_Decoder *thisPtr = TJpgDec.thisPtr;
jdec = jdec; // Supress warning
// Handle an array input
if (thisPtr->jpg_source == TJPG_ARRAY)
{
// Avoid running off end of array
if (thisPtr->array_index + len > thisPtr->array_size)
{
len = thisPtr->array_size - thisPtr->array_index;
}
// If buf is valid then copy len bytes to buffer
if (buf)
memcpy_P(buf, (const uint8_t *)(thisPtr->array_data + thisPtr->array_index), len);
// Move pointer
thisPtr->array_index += len;
}
#ifdef TJPGD_LOAD_FFS
// Handle SPIFFS input
else if (thisPtr->jpg_source == TJPG_FS_FILE)
{
// Check how many bytes are available
uint32_t bytesLeft = thisPtr->jpgFile.available();
if (bytesLeft < len)
len = bytesLeft;
if (buf)
{
// Read into buffer, pointer moved as well
thisPtr->jpgFile.read(buf, len);
}
else
{
// Buffer is null, so skip data by moving pointer
thisPtr->jpgFile.seek(thisPtr->jpgFile.position() + len);
}
}
#endif
#if defined(TJPGD_LOAD_SD_LIBRARY)
// Handle SD library input
else if (thisPtr->jpg_source == TJPG_SD_FILE)
{
// Check how many bytes are available
uint32_t bytesLeft = thisPtr->jpgSdFile.available();
if (bytesLeft < len)
len = bytesLeft;
if (buf)
{
// Read into buffer, pointer moved as well
thisPtr->jpgSdFile.read(buf, len);
}
else
{
// Buffer is null, so skip data by moving pointer
thisPtr->jpgSdFile.seek(thisPtr->jpgSdFile.position() + len);
}
}
#endif
return len;
}
/***************************************************************************************
** Function name: jd_output (declared static)
** Description: Called by tjpgd.c with an image block for rendering
***************************************************************************************/
// Pass image block back to the sketch for rendering, may be a complete or partial MCU
int TJpg_Decoder::jd_output(JDEC *jdec, void *bitmap, JRECT *jrect)
{
TJpg_Decoder *thisPtr = TJpgDec.thisPtr;
jdec = jdec; // Supress warning as ID is not used
int16_t x = jrect->left + thisPtr->jpeg_x;
int16_t y = jrect->top + thisPtr->jpeg_y;
uint16_t w = jrect->right + 1 - jrect->left;
uint16_t h = jrect->bottom + 1 - jrect->top;
// Pass the image block and rendering parameters in a callback to the sketch
return thisPtr->tft_output(x, y, w, h, (uint16_t *)bitmap);
}
/***************************************************************************************
** Function name: drawFsJpg für AWTRIX
** Description: Draw a jpg with opened file handle at x,y
***************************************************************************************/
JRESULT TJpg_Decoder::drawFsJpg(int32_t x, int32_t y, fs::File inFile)
{
JDEC jdec;
JRESULT jresult = JDR_OK;
jpg_source = TJPG_FS_FILE;
jpeg_x = x;
jpeg_y = y;
jdec.swap = _swap;
jpgFile = inFile;
jresult = jd_prepare(&jdec, jd_input, workspace, TJPGD_WORKSPACE_SIZE, (unsigned int)0);
// Extract image and render
if (jresult == JDR_OK)
{
jresult = jd_decomp(&jdec, jd_output, jpgScale);
}
inFile.seek(0);
return jresult;
}

128
lib/TJpg_Decoder/src/TJpg_Decoder.h Normal file
View File

@@ -0,0 +1,128 @@
/*
TJpg_Decoder.h
JPEG Decoder for Arduino using TJpgDec:
http://elm-chan.org/fsw/tjpgd/00index.html
Incorporated into an Arduino library by Bodmer 18/10/19
Latest version here:
https://github.com/Bodmer/TJpg_Decoder
*/
#ifndef TJpg_Decoder_H
#define TJpg_Decoder_H
#include "User_Config.h"
#include "Arduino.h"
#include "tjpgd.h"
#if defined (ESP8266) || defined (ESP32)
#include <pgmspace.h>
#include <FS.h>
#include <LittleFS.h>
#ifdef ESP32
#include "SPIFFS.h" // ESP32 only
#endif
#define TJPGD_LOAD_FFS
#elif defined (ARDUINO_ARCH_RP2040)
#include <FS.h>
#include <LittleFS.h>
#define SPIFFS LittleFS
#define TJPGD_LOAD_FFS
#endif
#if defined (TJPGD_LOAD_SD_LIBRARY)
#include <SD.h>
#endif
enum {
TJPG_ARRAY = 0,
TJPG_FS_FILE,
TJPG_SD_FILE
};
//------------------------------------------------------------------------------
typedef bool (*SketchCallback)(int16_t x, int16_t y, uint16_t w, uint16_t h, uint16_t *data);
class TJpg_Decoder {
private:
#if defined (TJPGD_LOAD_SD_LIBRARY)
File jpgSdFile;
#endif
#ifdef TJPGD_LOAD_FFS
fs::File jpgFile;
#endif
public:
TJpg_Decoder();
~TJpg_Decoder();
static int jd_output(JDEC* jdec, void* bitmap, JRECT* jrect);
static unsigned int jd_input(JDEC* jdec, uint8_t* buf, unsigned int len);
void setJpgScale(uint8_t scale);
void setCallback(SketchCallback sketchCallback);
#if defined (TJPGD_LOAD_SD_LIBRARY) || defined (TJPGD_LOAD_FFS)
JRESULT drawJpg (int32_t x, int32_t y, const char *pFilename);
JRESULT drawJpg (int32_t x, int32_t y, const String& pFilename);
JRESULT getJpgSize(uint16_t *w, uint16_t *h, const char *pFilename);
JRESULT getJpgSize(uint16_t *w, uint16_t *h, const String& pFilename);
#endif
#if defined (TJPGD_LOAD_SD_LIBRARY)
JRESULT drawSdJpg (int32_t x, int32_t y, const char *pFilename);
JRESULT drawSdJpg (int32_t x, int32_t y, const String& pFilename);
JRESULT drawSdJpg (int32_t x, int32_t y, File inFile);
JRESULT getSdJpgSize(uint16_t *w, uint16_t *h, const char *pFilename);
JRESULT getSdJpgSize(uint16_t *w, uint16_t *h, const String& pFilename);
JRESULT getSdJpgSize(uint16_t *w, uint16_t *h, File inFile);
#endif
#ifdef TJPGD_LOAD_FFS
JRESULT drawFsJpg (int32_t x, int32_t y, const char *pFilename, fs::FS &fs = SPIFFS);
JRESULT drawFsJpg (int32_t x, int32_t y, const String& pFilename, fs::FS &fs = SPIFFS);
JRESULT drawFsJpg (int32_t x, int32_t y, fs::File inFile);
JRESULT getFsJpgSize(uint16_t *w, uint16_t *h, const char *pFilename, fs::FS &fs = SPIFFS);
JRESULT getFsJpgSize(uint16_t *w, uint16_t *h, const String& pFilename, fs::FS &fs = SPIFFS);
JRESULT getFsJpgSize(uint16_t *w, uint16_t *h, fs::File inFile);
#endif
JRESULT drawJpg(int32_t x, int32_t y, const uint8_t array[], uint32_t array_size);
JRESULT getJpgSize(uint16_t *w, uint16_t *h, const uint8_t array[], uint32_t array_size);
void setSwapBytes(bool swap);
bool _swap = false;
const uint8_t* array_data = nullptr;
uint32_t array_index = 0;
uint32_t array_size = 0;
// Must align workspace to a 32 bit boundary
uint8_t workspace[TJPGD_WORKSPACE_SIZE] __attribute__((aligned(4)));
uint8_t jpg_source = 0;
int16_t jpeg_x = 0;
int16_t jpeg_y = 0;
uint8_t jpgScale = 0;
SketchCallback tft_output = nullptr;
TJpg_Decoder *thisPtr = nullptr;
};
extern TJpg_Decoder TJpgDec;
#endif // TJpg_Decoder_H

5
lib/TJpg_Decoder/src/User_Config.h Normal file
View File

@@ -0,0 +1,5 @@
#if defined (ESP32) || defined (ESP8266) || (ARDUINO_ARCH_RP2040) || defined (ARDUINO_ARCH_MBED)
#define TJPGD_LOAD_FFS
#endif
#define TJPGD_LOAD_SD_LIBRARY

1166
lib/TJpg_Decoder/src/tjpgd.c Normal file
View File

File diff suppressed because it is too large Load Diff

103
lib/TJpg_Decoder/src/tjpgd.h Normal file
View File

@@ -0,0 +1,103 @@
/*----------------------------------------------------------------------------/
/ TJpgDec - Tiny JPEG Decompressor R0.03 include file (C)ChaN, 2021
/----------------------------------------------------------------------------*/
#ifndef DEF_TJPGDEC
#define DEF_TJPGDEC
#ifdef __cplusplus
extern "C" {
#endif
#include "tjpgdcnf.h"
#include <string.h>
#if defined(_WIN32) /* VC++ or some compiler without stdint.h */
typedef unsigned char uint8_t;
typedef unsigned short uint16_t;
typedef short int16_t;
typedef unsigned long uint32_t;
typedef long int32_t;
#else /* Embedded platform */
#include <stdint.h>
#endif
#if JD_FASTDECODE >= 1
typedef int16_t jd_yuv_t;
#else
typedef uint8_t jd_yuv_t;
#endif
/* Error code */
typedef enum {
JDR_OK = 0, /* 0: Succeeded */
JDR_INTR, /* 1: Interrupted by output function */
JDR_INP, /* 2: Device error or wrong termination of input stream */
JDR_MEM1, /* 3: Insufficient memory pool for the image */
JDR_MEM2, /* 4: Insufficient stream input buffer */
JDR_PAR, /* 5: Parameter error */
JDR_FMT1, /* 6: Data format error (may be broken data) */
JDR_FMT2, /* 7: Right format but not supported */
JDR_FMT3 /* 8: Not supported JPEG standard */
} JRESULT;
/* Rectangular region in the output image */
typedef struct {
uint16_t left; /* Left end */
uint16_t right; /* Right end */
uint16_t top; /* Top end */
uint16_t bottom; /* Bottom end */
} JRECT;
/* Decompressor object structure */
typedef struct JDEC JDEC;
struct JDEC {
size_t dctr; /* Number of bytes available in the input buffer */
uint8_t* dptr; /* Current data read ptr */
uint8_t* inbuf; /* Bit stream input buffer */
uint8_t dbit; /* Number of bits availavble in wreg or reading bit mask */
uint8_t scale; /* Output scaling ratio */
uint8_t msx, msy; /* MCU size in unit of block (width, height) */
uint8_t qtid[3]; /* Quantization table ID of each component, Y, Cb, Cr */
uint8_t ncomp; /* Number of color components 1:grayscale, 3:color */
int16_t dcv[3]; /* Previous DC element of each component */
uint16_t nrst; /* Restart inverval */
uint16_t width, height; /* Size of the input image (pixel) */
uint8_t* huffbits[2][2]; /* Huffman bit distribution tables [id][dcac] */
uint16_t* huffcode[2][2]; /* Huffman code word tables [id][dcac] */
uint8_t* huffdata[2][2]; /* Huffman decoded data tables [id][dcac] */
int32_t* qttbl[4]; /* Dequantizer tables [id] */
#if JD_FASTDECODE >= 1
uint32_t wreg; /* Working shift register */
uint8_t marker; /* Detected marker (0:None) */
#if JD_FASTDECODE == 2
uint8_t longofs[2][2]; /* Table offset of long code [id][dcac] */
uint16_t* hufflut_ac[2]; /* Fast huffman decode tables for AC short code [id] */
uint8_t* hufflut_dc[2]; /* Fast huffman decode tables for DC short code [id] */
#endif
#endif
void* workbuf; /* Working buffer for IDCT and RGB output */
jd_yuv_t* mcubuf; /* Working buffer for the MCU */
void* pool; /* Pointer to available memory pool */
size_t sz_pool; /* Size of momory pool (bytes available) */
size_t (*infunc)(JDEC*, uint8_t*, size_t); /* Pointer to jpeg stream input function */
void* device; /* Pointer to I/O device identifiler for the session */
uint8_t swap; /* Added by Bodmer to control byte swapping */
};
/* TJpgDec API functions */
JRESULT jd_prepare (JDEC* jd, size_t (*infunc)(JDEC*,uint8_t*,size_t), void* pool, size_t sz_pool, void* dev);
JRESULT jd_decomp (JDEC* jd, int (*outfunc)(JDEC*,void*,JRECT*), uint8_t scale);
#ifdef __cplusplus
}
#endif
#endif /* _TJPGDEC */

44
lib/TJpg_Decoder/src/tjpgdcnf.h Normal file
View File

@@ -0,0 +1,44 @@
/*----------------------------------------------*/
/* TJpgDec System Configurations R0.03 */
/*----------------------------------------------*/
#define JD_SZBUF 512
/* Specifies size of stream input buffer */
#define JD_FORMAT 1
/* Specifies output pixel format.
/ 0: RGB888 (24-bit/pix)
/ 1: RGB565 (16-bit/pix)
/ 2: Grayscale (8-bit/pix)
*/
#define JD_USE_SCALE 1
/* Switches output descaling feature.
/ 0: Disable
/ 1: Enable
*/
#define JD_TBLCLIP 0
/* Use table conversion for saturation arithmetic. A bit faster, but increases 1 KB of code size.
/ 0: Disable
/ 1: Enable
*/
#define JD_FASTDECODE 1
/* Optimization level
/ 0: Basic optimization. Suitable for 8/16-bit MCUs.
/ Workspace of 3100 bytes needed.
/ 1: + 32-bit barrel shifter. Suitable for 32-bit MCUs.
/ Workspace of 3480 bytes needed.
/ 2: + Table conversion for huffman decoding (wants 6 << HUFF_BIT bytes of RAM).
/ Workspace of 9644 bytes needed.
*/
// Do not change this, it is the minimum size in bytes of the workspace needed by the decoder
#if JD_FASTDECODE == 0
#define TJPGD_WORKSPACE_SIZE 3100
#elif JD_FASTDECODE == 1
#define TJPGD_WORKSPACE_SIZE 3500
#elif JD_FASTDECODE == 2
#define TJPGD_WORKSPACE_SIZE (3500 + 6144)
#endif

3
lib/home-assistant-integration/.gitignore vendored Normal file
View File

@@ -0,0 +1,3 @@
docsrc/xml
docsrc/build
.DS_Store

1
lib/home-assistant-integration/.piopm Normal file
View File

@@ -0,0 +1 @@
{"type": "library", "name": "home-assistant-integration", "version": "2.0.0", "spec": {"owner": "dawidchyrzynski", "id": 11661, "name": "home-assistant-integration", "requirements": null, "uri": null}}

85
lib/home-assistant-integration/CHANGELOG.md Normal file
View File

@@ -0,0 +1,85 @@
# Changelog
## 2.0.0
**New features:**
* Added support for the `icon` property in the `HABinarySensor` (you can set the icon using `HABinarySensor::setIcon("iconName")`)
* Added support for changing the current state of the `HABinarySensor` using `HABinarySensor::setCurrentState` method
* Added support for forcing `setState` in `HABinarySensor` using a second argument as follows `HABinarySensor::setState(true, true)`
* Added support for the `device_class` property in the `HACover` (you can set the class using `HACover::setDeviceClass("className")`
* Added support for the `icon` property in the `HACover` (you can set the icon using `HACover::setIcon("iconName")`)
* Added pointer of the sender to the `HACover` callback function
* Added support for `optimistic` property in the `HACover` (you can change the mode using `HACover::setOptimistic(true)`)
* Added support for forcing `setPosition` in `HACover` using a second argument as follows `HACover::setPosition(100, true)`
* Added support for the `device_class` property in the `HASwitch` (you can set the class using `HASwitch::setDeviceClass("className")`
* Added support for the `optimistic` property in the `HASwitch` (you can change the mode using `HASwitch::setOptimistic(true)`)
* Added support for the `force_update` property in the `HASensor` (you can set the mode using `HASensor::setForceUpdate(true)`)
* Added support for the `HAButton` device type
* Added support for the `HADeviceTracker` device type
* Added support for the `HACamera` device type
* Added support for the `HALock` device type
* Added support for the `HASelect` device type
* Added support for the `HANumber` device type
* Added support for the `HAScene` device type
* Added support for the `HALight` device type
**Bugs fixes:**
* Last Will Message is now retained (#70)
* Compilation error on SAMD family (#82)
**New examples:**
* [Button](examples/button/button.ino) - adding simple buttons to the Home Assistant panel.
**Breaking changes:**
* Changed structure of all MQTT topics used in the library.
* Changed constructor of the `HABinarySensor` class (removed `deviceClass` and `initialState` arguments)
* Renamed `HABinarySensor::getState()` method to `HABinarySensor::getCurrentState()`
* Replaced `HATriggers` with `HADeviceTrigger` - the new implementation is not backward compatible. Please check the updated example of the `multi-state-button`.
* Renamed `HADevice::isOnline()` method to `HADevice::isAvailable()`
* Renamed `HASwitch::onStateChanged` method to `HASwitch::onCommand`.
* Renamed `HAFan::onStateChanged` method to `HAFan::onStateCommand`.
* Renamed `HAFan::onSpeedChanged` method to `HAFan::onSpeedCommand`.
* Changed logic of the `HASwitch` callback. Please check the `led-switch` example.
* Refactored `HASensor` logic. It's now divided into two different classes: `HASensor` and `HASensorNumber`.
* Removed all legacy constructors with `HAMqtt` argument
* Removed `onConnectionFailed` callback from the `HAMqtt` class
* The position in the `HACover` is now available as configurable feature. It's disabled by default.
* Refactored `HAHVAC` class to support more features of the MQTT discovery. Please check the update example.
## 1.3.0
**New features:**
* Added `onMessage()` method to HAMqtt class
* Added support for HA Covers
* Added support for setting different prefix for non-discovery topics (see [Advanced MQTT example](examples/mqtt-advanced/mqtt-advanced.ino))
* Added `setName` method to HASensor
* Added `setName` method to HASwitch
* Added `onBeforeStateChanged` callback to HASwitch
**Improvements:**
* Removed legacy properties from HAFan (Home Assistant 2021.4.4). Deprecated methods will be removed after a quarter (2021.7)
* Separated `uniqueID` field from `name` in all devices types
## 1.2.0
**Breaking changes:**
* Refactored HASensor implementation. Please take a look at [updated example](examples/sensor/sensor.ino)
**New features:**
* Added support for HVAC
* Added support for excluding devices types from the compilation using defines (see [src/ArduinoHADefines.h](src/ArduinoHADefines.h))
* Added support for setting icon in HASwitch and HASensor
* Added support for setting retain flag in HASwitch
* Added support for text (const char*) payload in HASensor
* Added support for fans (HAFan)
* Added support for connecting to the MQTT broker using hostname
* Added `onConnected()` method in the HAMqtt
* Added `onConnectionFailed()` method in the HAMqtt
* Added support for MQTT LWT (see [Advanced Availability example](examples/advanced-availability/advanced-availability.ino))
**Improvements:**
* Optimized codebase and logic in all devices types
* Updated all examples
* Fixed compilation warnings in all classes

661
lib/home-assistant-integration/LICENSE Normal file
View File

@@ -0,0 +1,661 @@
GNU AFFERO GENERAL PUBLIC LICENSE
Version 3, 19 November 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU Affero General Public License is a free, copyleft license for
software and other kinds of works, specifically designed to ensure
cooperation with the community in the case of network server software.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
our General Public Licenses are intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
Developers that use our General Public Licenses protect your rights
with two steps: (1) assert copyright on the software, and (2) offer
you this License which gives you legal permission to copy, distribute
and/or modify the software.
A secondary benefit of defending all users' freedom is that
improvements made in alternate versions of the program, if they
receive widespread use, become available for other developers to
incorporate. Many developers of free software are heartened and
encouraged by the resulting cooperation. However, in the case of
software used on network servers, this result may fail to come about.
The GNU General Public License permits making a modified version and
letting the public access it on a server without ever releasing its
source code to the public.
The GNU Affero General Public License is designed specifically to
ensure that, in such cases, the modified source code becomes available
to the community. It requires the operator of a network server to
provide the source code of the modified version running there to the
users of that server. Therefore, public use of a modified version, on
a publicly accessible server, gives the public access to the source
code of the modified version.
An older license, called the Affero General Public License and
published by Affero, was designed to accomplish similar goals. This is
a different license, not a version of the Affero GPL, but Affero has
released a new version of the Affero GPL which permits relicensing under
this license.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU Affero General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Remote Network Interaction; Use with the GNU General Public License.
Notwithstanding any other provision of this License, if you modify the
Program, your modified version must prominently offer all users
interacting with it remotely through a computer network (if your version
supports such interaction) an opportunity to receive the Corresponding
Source of your version by providing access to the Corresponding Source
from a network server at no charge, through some standard or customary
means of facilitating copying of software. This Corresponding Source
shall include the Corresponding Source for any work covered by version 3
of the GNU General Public License that is incorporated pursuant to the
following paragraph.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the work with which it is combined will remain governed by version
3 of the GNU General Public License.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU Affero General Public License from time to time. Such new versions
will be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU Affero General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU Affero General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU Affero General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero 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 Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If your software can interact with users remotely through a computer
network, you should also make sure that it provides a way for users to
get its source. For example, if your program is a web application, its
interface could display a "Source" link that leads users to an archive
of the code. There are many ways you could offer source, and different
solutions will be better for different programs; see section 13 for the
specific requirements.
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU AGPL, see
<https://www.gnu.org/licenses/>.

99
lib/home-assistant-integration/README.md Normal file
View File

@@ -0,0 +1,99 @@
# Arduino Home Assistant integration 🏠
ArduinoHA allows to integrate an Arduino/ESP based device with Home Assistant using MQTT.
The library is designed to use as low resources (RAM/flash) as possible.
Initially, it was optimized to work on Arduino Uno with Ethernet Shield,
but I successfully use it on ESP8266/ESP8255 boards in my projects.
[📘 Documentation](https://dawidchyrzynski.github.io/arduino-home-assistant/)
## Features
* Two-way communication (state reporting and command execution)
* MQTT discovery (device is added to the Home Assistant panel automatically)
* MQTT Last Will and Testament
* Support for custom MQTT messages (publishing and subscribing)
* Auto reconnect with MQTT broker
* Reporting availability (online/offline states) of a device
* Doxygen documentation for all classes
* Covered by unit tests (AUnit + EpoxyDuino + AUniter)
## Supported HA types
| Home Assistant type | Supported |
| ------------------- | :--------: |
| Binary sensor | ✅ |
| Button | ✅ |
| Camera | ✅ |
| Cover | ✅ |
| Device tracker | ✅ |
| Device trigger | ✅ |
| Fan | ✅ |
| Humidifier | ❌ |
| HVAC | ✅ |
| Light | ✅ |
| Lock | ✅ |
| Number | ✅ |
| Scene | ✅ |
| Select | ✅ |
| Sensor | ✅ |
| Switch | ✅ |
| Tag scanner | ✅ |
| Vacuum | ❌ |
## Examples
|Example|Description |
|-------|-----------------------------|
|[Binary sensor](examples/binary-sensor/binary-sensor.ino)|Using the binary sensor as a door contact sensor.|
|[Button](examples/button/button.ino)|Adding simple buttons to the Home Assistant panel.|
|[Camera](examples/esp32-cam/esp32-cam.ino)|Publishing the preview from the ESP32-CAM module.|
|[Cover](examples/cover/cover.ino)|Controlling a window cover (open / close / stop).|
|[Device trigger](examples/multi-state-button/multi-state-button.ino)|Implementation of a simple wall switch that reports press and hold states.|
|[Fan](examples/fan/fan.ino)|Controlling a simple fan (state + speed).|
|[HVAC](examples/hvac/hvac.ino)|HVAC controller with multiple modes, power control and target temperature.|
|[Lock](examples/lock/lock.ino)|A simple door lock that's controlled by the Home Assistant.|
|[Light](examples/light/light.ino)|A simple light that allows changing brightness, color temperature and RGB color.|
|[Number](examples/number/number.ino)|Adding an interactive numeric slider in the Home Assistant panel.|
|[Scene](examples/scene/scene.ino)|Adding a custom scene in the Home Assistant panel. |
|[Select](examples/select/select.ino)|A dropdown selector that's displayed in the Home Assistant panel.|
|[Sensor](examples/sensor/sensor.ino)|A simple sensor that reports a state in a string representation (open / opening / close).|
|[Analog sensor](examples/sensor-analog/sensor-analog.ino)|Reporting the analog pin's voltage to the Home Assistant.|
|[Integer sensor](examples/sensor-integer/sensor-integer.ino)|Reporting the device's uptime to the Home Assistant.|
|[Switch](examples/led-switch/led-switch.ino)|The LED that's controlled by the Home Assistant.|
|[Multi-switch](examples/multi-switch/multi-switch.ino)|Multiple switches controlled by the Home Assistant.|
|[Tag scanner](examples/tag-scanner/tag-scanner.ino)|Scanning RFID tags using the MFRC522 module.|
|[Availability](examples/availability/availability.ino)|Reporting entities' availability (online / offline) to the Home Assistant.|
|[Advanced availability](examples/advanced-availability/advanced-availability.ino)|Advanced availability reporting with MQTT LWT (Last Will and Testament).|
|[MQTT advanced](examples/mqtt-advanced/mqtt-advanced.ino)|Subscribing to custom topics and publishing custom messages.|
|[MQTT with credentials](examples/mqtt-with-credentials/mqtt-with-credentials.ino)|Establishing connection with a MQTT broker using the credentials. |
|[NodeMCU (ESP8266)](examples/nodemcu/nodemcu.ino)|Basic example for ESP8266 devices.|
|[Arduino Nano 33 IoT](examples/nano33iot/nano33iot.ino)|Basic example for Arduino Nano 33 IoT (SAMD family).|
|[mDNS discovery](examples/mdns/mdns.ino)|Make your ESP8266 discoverable via the mDNS.|
## Compatible hardware
The library uses the Arduino Ethernet Client API for interacting with the network hardware.
It should work fine as long as the `Client` class is available.
Here is the list of devices on which the library was tested:
* Arduino Uno
* Arduino Mega
* Arduino Nano
* Arduino Pro Mini
* Arduino Nano 33 IoT
* NodeMCU
* Controllino Mega (Pure)
* Controllino Maxi (Pure)
* ESP-01
* ESP32-CAM
* Sonoff Dual R2
* Sonoff Dual R3
* Sonoff Basic
* Sonoff Mini
* Tuya Wi-Fi switch module
* Tuya Wi-Fi curtain module
Please note that it's not the complete list of supported devices.
You may try to use the library on any device that uses Arduino core.

31
lib/home-assistant-integration/docsrc/Makefile Normal file
View File

@@ -0,0 +1,31 @@
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = source
BUILDDIR = build
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
# Build Github pages
github:
@make clean
@rm -rf xml
@doxygen source/Doxyfile
@make html
@mkdir -p ../docs
@rm -rf ../docs/*
@touch ../docs/.nojekyll
@cp -a build/html/. ../docs
.PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

17
lib/home-assistant-integration/docsrc/Pipfile Normal file
View File

@@ -0,0 +1,17 @@
[[source]]
url = "https://pypi.org/simple"
verify_ssl = true
name = "pypi"
[packages]
exhale = "0.3.4"
breathe = "4.34.0"
sphinx = "5.0.2"
lxml = "4.8.0"
sphinx-press-theme = "0.8.0"
sphinxcontrib-email = "0.3.5"
[dev-packages]
[requires]
python_version = "3.9"

389
lib/home-assistant-integration/docsrc/Pipfile.lock generated Normal file
View File

@@ -0,0 +1,389 @@
{
"_meta": {
"hash": {
"sha256": "06cbc4b751660842e50f1cd113469dcedc03e5f6ed5be43ab74f58b69b09e7f1"
},
"pipfile-spec": 6,
"requires": {
"python_version": "3.9"
},
"sources": [
{
"name": "pypi",
"url": "https://pypi.org/simple",
"verify_ssl": true
}
]
},
"default": {
"alabaster": {
"hashes": [
"sha256:446438bdcca0e05bd45ea2de1668c1d9b032e1a9154c2c259092d77031ddd359",
"sha256:a661d72d58e6ea8a57f7a86e37d86716863ee5e92788398526d58b26a4e4dc02"
],
"version": "==0.7.12"
},
"babel": {
"hashes": [
"sha256:7614553711ee97490f732126dc077f8d0ae084ebc6a96e23db1482afabdb2c51",
"sha256:ff56f4892c1c4bf0d814575ea23471c230d544203c7748e8c68f0089478d48eb"
],
"markers": "python_version >= '3.6'",
"version": "==2.10.3"
},
"beautifulsoup4": {
"hashes": [
"sha256:58d5c3d29f5a36ffeb94f02f0d786cd53014cf9b3b3951d42e0080d8a9498d30",
"sha256:ad9aa55b65ef2808eb405f46cf74df7fcb7044d5cbc26487f96eb2ef2e436693"
],
"markers": "python_version >= '3.6'",
"version": "==4.11.1"
},
"breathe": {
"hashes": [
"sha256:48804dcf0e607a89fb6ad88c729ef12743a42db03ae9489be4ef8f7c4011774a",
"sha256:ac0768a5e84addad3e632028fe67749c567aba2b29088493b64c2c1634bcdba1"
],
"index": "pypi",
"version": "==4.34.0"
},
"certifi": {
"hashes": [
"sha256:84c85a9078b11105f04f3036a9482ae10e4621616db313fe045dd24743a0820d",
"sha256:fe86415d55e84719d75f8b69414f6438ac3547d2078ab91b67e779ef69378412"
],
"markers": "python_version >= '3.6'",
"version": "==2022.6.15"
},
"charset-normalizer": {
"hashes": [
"sha256:5189b6f22b01957427f35b6a08d9a0bc45b46d3788ef5a92e978433c7a35f8a5",
"sha256:575e708016ff3a5e3681541cb9d79312c416835686d054a23accb873b254f413"
],
"markers": "python_version >= '3.6'",
"version": "==2.1.0"
},
"docutils": {
"hashes": [
"sha256:686577d2e4c32380bb50cbb22f575ed742d58168cee37e99117a854bcd88f125",
"sha256:cf316c8370a737a022b72b56874f6602acf974a37a9fba42ec2876387549fc61"
],
"markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'",
"version": "==0.17.1"
},
"exhale": {
"hashes": [
"sha256:0871fa29ff9ac91c14e0dd69ad40db798068b4407e2e7ba5f650e07cedd6f365",
"sha256:8fe83b2d96ef41e0f921b865c1bf46c40c6907cbeff0207ab9b445fd54539a16"
],
"index": "pypi",
"version": "==0.3.4"
},
"idna": {
"hashes": [
"sha256:84d9dd047ffa80596e0f246e2eab0b391788b0503584e8945f2368256d2735ff",
"sha256:9d643ff0a55b762d5cdb124b8eaa99c66322e2157b69160bc32796e824360e6d"
],
"markers": "python_version >= '3.5'",
"version": "==3.3"
},
"imagesize": {
"hashes": [
"sha256:0d8d18d08f840c19d0ee7ca1fd82490fdc3729b7ac93f49870406ddde8ef8d8b",
"sha256:69150444affb9cb0d5cc5a92b3676f0b2fb7cd9ae39e947a5e11a36b4497cd4a"
],
"markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'",
"version": "==1.4.1"
},
"importlib-metadata": {
"hashes": [
"sha256:637245b8bab2b6502fcbc752cc4b7a6f6243bb02b31c5c26156ad103d3d45670",
"sha256:7401a975809ea1fdc658c3aa4f78cc2195a0e019c5cbc4c06122884e9ae80c23"
],
"markers": "python_version < '3.10'",
"version": "==4.12.0"
},
"jinja2": {
"hashes": [
"sha256:31351a702a408a9e7595a8fc6150fc3f43bb6bf7e319770cbc0db9df9437e852",
"sha256:6088930bfe239f0e6710546ab9c19c9ef35e29792895fed6e6e31a023a182a61"
],
"markers": "python_version >= '3.7'",
"version": "==3.1.2"
},
"lxml": {
"hashes": [
"sha256:04da965dfebb5dac2619cb90fcf93efdb35b3c6994fea58a157a834f2f94b318",
"sha256:0538747a9d7827ce3e16a8fdd201a99e661c7dee3c96c885d8ecba3c35d1032c",
"sha256:0645e934e940107e2fdbe7c5b6fb8ec6232444260752598bc4d09511bd056c0b",
"sha256:079b68f197c796e42aa80b1f739f058dcee796dc725cc9a1be0cdb08fc45b000",
"sha256:0f3f0059891d3254c7b5fb935330d6db38d6519ecd238ca4fce93c234b4a0f73",
"sha256:10d2017f9150248563bb579cd0d07c61c58da85c922b780060dcc9a3aa9f432d",
"sha256:1355755b62c28950f9ce123c7a41460ed9743c699905cbe664a5bcc5c9c7c7fb",
"sha256:13c90064b224e10c14dcdf8086688d3f0e612db53766e7478d7754703295c7c8",
"sha256:1423631e3d51008871299525b541413c9b6c6423593e89f9c4cfbe8460afc0a2",
"sha256:1436cf0063bba7888e43f1ba8d58824f085410ea2025befe81150aceb123e345",
"sha256:1a7c59c6ffd6ef5db362b798f350e24ab2cfa5700d53ac6681918f314a4d3b94",
"sha256:1e1cf47774373777936c5aabad489fef7b1c087dcd1f426b621fda9dcc12994e",
"sha256:206a51077773c6c5d2ce1991327cda719063a47adc02bd703c56a662cdb6c58b",
"sha256:21fb3d24ab430fc538a96e9fbb9b150029914805d551deeac7d7822f64631dfc",
"sha256:27e590352c76156f50f538dbcebd1925317a0f70540f7dc8c97d2931c595783a",
"sha256:287605bede6bd36e930577c5925fcea17cb30453d96a7b4c63c14a257118dbb9",
"sha256:2aaf6a0a6465d39b5ca69688fce82d20088c1838534982996ec46633dc7ad6cc",
"sha256:32a73c53783becdb7eaf75a2a1525ea8e49379fb7248c3eeefb9412123536387",
"sha256:41fb58868b816c202e8881fd0f179a4644ce6e7cbbb248ef0283a34b73ec73bb",
"sha256:4780677767dd52b99f0af1f123bc2c22873d30b474aa0e2fc3fe5e02217687c7",
"sha256:4878e667ebabe9b65e785ac8da4d48886fe81193a84bbe49f12acff8f7a383a4",
"sha256:487c8e61d7acc50b8be82bda8c8d21d20e133c3cbf41bd8ad7eb1aaeb3f07c97",
"sha256:49a866923e69bc7da45a0565636243707c22752fc38f6b9d5c8428a86121022c",
"sha256:4beea0f31491bc086991b97517b9683e5cfb369205dac0148ef685ac12a20a67",
"sha256:4cfbe42c686f33944e12f45a27d25a492cc0e43e1dc1da5d6a87cbcaf2e95627",
"sha256:4d5bae0a37af799207140652a700f21a85946f107a199bcb06720b13a4f1f0b7",
"sha256:4e285b5f2bf321fc0857b491b5028c5f276ec0c873b985d58d7748ece1d770dd",
"sha256:57e4d637258703d14171b54203fd6822fda218c6c2658a7d30816b10995f29f3",
"sha256:5974895115737a74a00b321e339b9c3f45c20275d226398ae79ac008d908bff7",
"sha256:5ef87fca280fb15342726bd5f980f6faf8b84a5287fcc2d4962ea8af88b35130",
"sha256:603a464c2e67d8a546ddaa206d98e3246e5db05594b97db844c2f0a1af37cf5b",
"sha256:6653071f4f9bac46fbc30f3c7838b0e9063ee335908c5d61fb7a4a86c8fd2036",
"sha256:6ca2264f341dd81e41f3fffecec6e446aa2121e0b8d026fb5130e02de1402785",
"sha256:6d279033bf614953c3fc4a0aa9ac33a21e8044ca72d4fa8b9273fe75359d5cca",
"sha256:6d949f53ad4fc7cf02c44d6678e7ff05ec5f5552b235b9e136bd52e9bf730b91",
"sha256:6daa662aba22ef3258934105be2dd9afa5bb45748f4f702a3b39a5bf53a1f4dc",
"sha256:6eafc048ea3f1b3c136c71a86db393be36b5b3d9c87b1c25204e7d397cee9536",
"sha256:830c88747dce8a3e7525defa68afd742b4580df6aa2fdd6f0855481e3994d391",
"sha256:86e92728ef3fc842c50a5cb1d5ba2bc66db7da08a7af53fb3da79e202d1b2cd3",
"sha256:8caf4d16b31961e964c62194ea3e26a0e9561cdf72eecb1781458b67ec83423d",
"sha256:8d1a92d8e90b286d491e5626af53afef2ba04da33e82e30744795c71880eaa21",
"sha256:8f0a4d179c9a941eb80c3a63cdb495e539e064f8054230844dcf2fcb812b71d3",
"sha256:9232b09f5efee6a495a99ae6824881940d6447debe272ea400c02e3b68aad85d",
"sha256:927a9dd016d6033bc12e0bf5dee1dde140235fc8d0d51099353c76081c03dc29",
"sha256:93e414e3206779ef41e5ff2448067213febf260ba747fc65389a3ddaa3fb8715",
"sha256:98cafc618614d72b02185ac583c6f7796202062c41d2eeecdf07820bad3295ed",
"sha256:9c3a88d20e4fe4a2a4a84bf439a5ac9c9aba400b85244c63a1ab7088f85d9d25",
"sha256:9f36de4cd0c262dd9927886cc2305aa3f2210db437aa4fed3fb4940b8bf4592c",
"sha256:a60f90bba4c37962cbf210f0188ecca87daafdf60271f4c6948606e4dabf8785",
"sha256:a614e4afed58c14254e67862456d212c4dcceebab2eaa44d627c2ca04bf86837",
"sha256:ae06c1e4bc60ee076292e582a7512f304abdf6c70db59b56745cca1684f875a4",
"sha256:b122a188cd292c4d2fcd78d04f863b789ef43aa129b233d7c9004de08693728b",
"sha256:b570da8cd0012f4af9fa76a5635cd31f707473e65a5a335b186069d5c7121ff2",
"sha256:bcaa1c495ce623966d9fc8a187da80082334236a2a1c7e141763ffaf7a405067",
"sha256:bd34f6d1810d9354dc7e35158aa6cc33456be7706df4420819af6ed966e85448",
"sha256:be9eb06489bc975c38706902cbc6888f39e946b81383abc2838d186f0e8b6a9d",
"sha256:c4b2e0559b68455c085fb0f6178e9752c4be3bba104d6e881eb5573b399d1eb2",
"sha256:c62e8dd9754b7debda0c5ba59d34509c4688f853588d75b53c3791983faa96fc",
"sha256:c852b1530083a620cb0de5f3cd6826f19862bafeaf77586f1aef326e49d95f0c",
"sha256:d9fc0bf3ff86c17348dfc5d322f627d78273eba545db865c3cd14b3f19e57fa5",
"sha256:dad7b164905d3e534883281c050180afcf1e230c3d4a54e8038aa5cfcf312b84",
"sha256:e5f66bdf0976ec667fc4594d2812a00b07ed14d1b44259d19a41ae3fff99f2b8",
"sha256:e8f0c9d65da595cfe91713bc1222af9ecabd37971762cb830dea2fc3b3bb2acf",
"sha256:edffbe3c510d8f4bf8640e02ca019e48a9b72357318383ca60e3330c23aaffc7",
"sha256:eea5d6443b093e1545ad0210e6cf27f920482bfcf5c77cdc8596aec73523bb7e",
"sha256:ef72013e20dd5ba86a8ae1aed7f56f31d3374189aa8b433e7b12ad182c0d2dfb",
"sha256:f05251bbc2145349b8d0b77c0d4e5f3b228418807b1ee27cefb11f69ed3d233b",
"sha256:f1be258c4d3dc609e654a1dc59d37b17d7fef05df912c01fc2e15eb43a9735f3",
"sha256:f9ced82717c7ec65a67667bb05865ffe38af0e835cdd78728f1209c8fffe0cad",
"sha256:fe17d10b97fdf58155f858606bddb4e037b805a60ae023c009f760d8361a4eb8",
"sha256:fe749b052bb7233fe5d072fcb549221a8cb1a16725c47c37e42b0b9cb3ff2c3f"
],
"index": "pypi",
"version": "==4.9.1"
},
"markupsafe": {
"hashes": [
"sha256:0212a68688482dc52b2d45013df70d169f542b7394fc744c02a57374a4207003",
"sha256:089cf3dbf0cd6c100f02945abeb18484bd1ee57a079aefd52cffd17fba910b88",
"sha256:10c1bfff05d95783da83491be968e8fe789263689c02724e0c691933c52994f5",
"sha256:33b74d289bd2f5e527beadcaa3f401e0df0a89927c1559c8566c066fa4248ab7",
"sha256:3799351e2336dc91ea70b034983ee71cf2f9533cdff7c14c90ea126bfd95d65a",
"sha256:3ce11ee3f23f79dbd06fb3d63e2f6af7b12db1d46932fe7bd8afa259a5996603",
"sha256:421be9fbf0ffe9ffd7a378aafebbf6f4602d564d34be190fc19a193232fd12b1",
"sha256:43093fb83d8343aac0b1baa75516da6092f58f41200907ef92448ecab8825135",
"sha256:46d00d6cfecdde84d40e572d63735ef81423ad31184100411e6e3388d405e247",
"sha256:4a33dea2b688b3190ee12bd7cfa29d39c9ed176bda40bfa11099a3ce5d3a7ac6",
"sha256:4b9fe39a2ccc108a4accc2676e77da025ce383c108593d65cc909add5c3bd601",
"sha256:56442863ed2b06d19c37f94d999035e15ee982988920e12a5b4ba29b62ad1f77",
"sha256:671cd1187ed5e62818414afe79ed29da836dde67166a9fac6d435873c44fdd02",
"sha256:694deca8d702d5db21ec83983ce0bb4b26a578e71fbdbd4fdcd387daa90e4d5e",
"sha256:6a074d34ee7a5ce3effbc526b7083ec9731bb3cbf921bbe1d3005d4d2bdb3a63",
"sha256:6d0072fea50feec76a4c418096652f2c3238eaa014b2f94aeb1d56a66b41403f",
"sha256:6fbf47b5d3728c6aea2abb0589b5d30459e369baa772e0f37a0320185e87c980",
"sha256:7f91197cc9e48f989d12e4e6fbc46495c446636dfc81b9ccf50bb0ec74b91d4b",
"sha256:86b1f75c4e7c2ac2ccdaec2b9022845dbb81880ca318bb7a0a01fbf7813e3812",
"sha256:8dc1c72a69aa7e082593c4a203dcf94ddb74bb5c8a731e4e1eb68d031e8498ff",
"sha256:8e3dcf21f367459434c18e71b2a9532d96547aef8a871872a5bd69a715c15f96",
"sha256:8e576a51ad59e4bfaac456023a78f6b5e6e7651dcd383bcc3e18d06f9b55d6d1",
"sha256:96e37a3dc86e80bf81758c152fe66dbf60ed5eca3d26305edf01892257049925",
"sha256:97a68e6ada378df82bc9f16b800ab77cbf4b2fada0081794318520138c088e4a",
"sha256:99a2a507ed3ac881b975a2976d59f38c19386d128e7a9a18b7df6fff1fd4c1d6",
"sha256:a49907dd8420c5685cfa064a1335b6754b74541bbb3706c259c02ed65b644b3e",
"sha256:b09bf97215625a311f669476f44b8b318b075847b49316d3e28c08e41a7a573f",
"sha256:b7bd98b796e2b6553da7225aeb61f447f80a1ca64f41d83612e6139ca5213aa4",
"sha256:b87db4360013327109564f0e591bd2a3b318547bcef31b468a92ee504d07ae4f",
"sha256:bcb3ed405ed3222f9904899563d6fc492ff75cce56cba05e32eff40e6acbeaa3",
"sha256:d4306c36ca495956b6d568d276ac11fdd9c30a36f1b6eb928070dc5360b22e1c",
"sha256:d5ee4f386140395a2c818d149221149c54849dfcfcb9f1debfe07a8b8bd63f9a",
"sha256:dda30ba7e87fbbb7eab1ec9f58678558fd9a6b8b853530e176eabd064da81417",
"sha256:e04e26803c9c3851c931eac40c695602c6295b8d432cbe78609649ad9bd2da8a",
"sha256:e1c0b87e09fa55a220f058d1d49d3fb8df88fbfab58558f1198e08c1e1de842a",
"sha256:e72591e9ecd94d7feb70c1cbd7be7b3ebea3f548870aa91e2732960fa4d57a37",
"sha256:e8c843bbcda3a2f1e3c2ab25913c80a3c5376cd00c6e8c4a86a89a28c8dc5452",
"sha256:efc1913fd2ca4f334418481c7e595c00aad186563bbc1ec76067848c7ca0a933",
"sha256:f121a1420d4e173a5d96e47e9a0c0dcff965afdf1626d28de1460815f7c4ee7a",
"sha256:fc7b548b17d238737688817ab67deebb30e8073c95749d55538ed473130ec0c7"
],
"markers": "python_version >= '3.7'",
"version": "==2.1.1"
},
"packaging": {
"hashes": [
"sha256:dd47c42927d89ab911e606518907cc2d3a1f38bbd026385970643f9c5b8ecfeb",
"sha256:ef103e05f519cdc783ae24ea4e2e0f508a9c99b2d4969652eed6a2e1ea5bd522"
],
"markers": "python_version >= '3.6'",
"version": "==21.3"
},
"pygments": {
"hashes": [
"sha256:5eb116118f9612ff1ee89ac96437bb6b49e8f04d8a13b514ba26f620208e26eb",
"sha256:dc9c10fb40944260f6ed4c688ece0cd2048414940f1cea51b8b226318411c519"
],
"markers": "python_version >= '3.6'",
"version": "==2.12.0"
},
"pyparsing": {
"hashes": [
"sha256:2b020ecf7d21b687f219b71ecad3631f644a47f01403fa1d1036b0c6416d70fb",
"sha256:5026bae9a10eeaefb61dab2f09052b9f4307d44aee4eda64b309723d8d206bbc"
],
"markers": "python_full_version >= '3.6.8'",
"version": "==3.0.9"
},
"pytz": {
"hashes": [
"sha256:1e760e2fe6a8163bc0b3d9a19c4f84342afa0a2affebfaa84b01b978a02ecaa7",
"sha256:e68985985296d9a66a881eb3193b0906246245294a881e7c8afe623866ac6a5c"
],
"version": "==2022.1"
},
"requests": {
"hashes": [
"sha256:7c5599b102feddaa661c826c56ab4fee28bfd17f5abca1ebbe3e7f19d7c97983",
"sha256:8fefa2a1a1365bf5520aac41836fbee479da67864514bdb821f31ce07ce65349"
],
"markers": "python_version >= '3.7' and python_version < '4'",
"version": "==2.28.1"
},
"six": {
"hashes": [
"sha256:1e61c37477a1626458e36f7b1d82aa5c9b094fa4802892072e49de9c60c4c926",
"sha256:8abb2f1d86890a2dfb989f9a77cfcfd3e47c2a354b01111771326f8aa26e0254"
],
"markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'",
"version": "==1.16.0"
},
"snowballstemmer": {
"hashes": [
"sha256:09b16deb8547d3412ad7b590689584cd0fe25ec8db3be37788be3810cbf19cb1",
"sha256:c8e1716e83cc398ae16824e5572ae04e0d9fc2c6b985fb0f900f5f0c96ecba1a"
],
"version": "==2.2.0"
},
"soupsieve": {
"hashes": [
"sha256:3b2503d3c7084a42b1ebd08116e5f81aadfaea95863628c80a3b774a11b7c759",
"sha256:fc53893b3da2c33de295667a0e19f078c14bf86544af307354de5fcf12a3f30d"
],
"markers": "python_version >= '3.6'",
"version": "==2.3.2.post1"
},
"sphinx": {
"hashes": [
"sha256:7bf8ca9637a4ee15af412d1a1d9689fec70523a68ca9bb9127c2f3eeb344e2e6",
"sha256:ebf612653238bcc8f4359627a9b7ce44ede6fdd75d9d30f68255c7383d3a6226"
],
"index": "pypi",
"version": "==4.5.0"
},
"sphinx-press-theme": {
"hashes": [
"sha256:2884caab1dc01ecb11d158d4dd6d3179e2dd97cd48516c769cc27360272e62b3",
"sha256:ddf877d414a2c66e13396d726115aa3f0c94d1ac9133b4df028c261bf388ab25"
],
"index": "pypi",
"version": "==0.8.0"
},
"sphinxcontrib-applehelp": {
"hashes": [
"sha256:806111e5e962be97c29ec4c1e7fe277bfd19e9652fb1a4392105b43e01af885a",
"sha256:a072735ec80e7675e3f432fcae8610ecf509c5f1869d17e2eecff44389cdbc58"
],
"markers": "python_version >= '3.5'",
"version": "==1.0.2"
},
"sphinxcontrib-devhelp": {
"hashes": [
"sha256:8165223f9a335cc1af7ffe1ed31d2871f325254c0423bc0c4c7cd1c1e4734a2e",
"sha256:ff7f1afa7b9642e7060379360a67e9c41e8f3121f2ce9164266f61b9f4b338e4"
],
"markers": "python_version >= '3.5'",
"version": "==1.0.2"
},
"sphinxcontrib-email": {
"hashes": [
"sha256:2387fc0691f3a4ed9c0b7d32acce5a42495340cc45f6e759a1b38e1eb86fe888",
"sha256:74738235afd602b7f692d2b62b4582034e8bb32dbcaa7ecab34be985d8bae590"
],
"index": "pypi",
"version": "==0.3.5"
},
"sphinxcontrib-htmlhelp": {
"hashes": [
"sha256:d412243dfb797ae3ec2b59eca0e52dac12e75a241bf0e4eb861e450d06c6ed07",
"sha256:f5f8bb2d0d629f398bf47d0d69c07bc13b65f75a81ad9e2f71a63d4b7a2f6db2"
],
"markers": "python_version >= '3.6'",
"version": "==2.0.0"
},
"sphinxcontrib-jsmath": {
"hashes": [
"sha256:2ec2eaebfb78f3f2078e73666b1415417a116cc848b72e5172e596c871103178",
"sha256:a9925e4a4587247ed2191a22df5f6970656cb8ca2bd6284309578f2153e0c4b8"
],
"markers": "python_version >= '3.5'",
"version": "==1.0.1"
},
"sphinxcontrib-qthelp": {
"hashes": [
"sha256:4c33767ee058b70dba89a6fc5c1892c0d57a54be67ddd3e7875a18d14cba5a72",
"sha256:bd9fc24bcb748a8d51fd4ecaade681350aa63009a347a8c14e637895444dfab6"
],
"markers": "python_version >= '3.5'",
"version": "==1.0.3"
},
"sphinxcontrib-serializinghtml": {
"hashes": [
"sha256:352a9a00ae864471d3a7ead8d7d79f5fc0b57e8b3f95e9867eb9eb28999b92fd",
"sha256:aa5f6de5dfdf809ef505c4895e51ef5c9eac17d0f287933eb49ec495280b6952"
],
"markers": "python_version >= '3.5'",
"version": "==1.1.5"
},
"urllib3": {
"hashes": [
"sha256:44ece4d53fb1706f667c9bd1c648f5469a2ec925fcf3a776667042d645472c14",
"sha256:aabaf16477806a5e1dd19aa41f8c2b7950dd3c746362d7e3223dbe6de6ac448e"
],
"markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4' and python_version < '4'",
"version": "==1.26.9"
},
"zipp": {
"hashes": [
"sha256:56bf8aadb83c24db6c4b577e13de374ccfb67da2078beba1d037c17980bf43ad",
"sha256:c4f6e5bbf48e74f7a38e7cc5b0480ff42b0ae5178957d564d18932525d5cf099"
],
"markers": "python_version >= '3.7'",
"version": "==3.8.0"
}
},
"develop": {}
}

41
lib/home-assistant-integration/docsrc/README.md Normal file
View File

@@ -0,0 +1,41 @@
# Documentation
This document describes how to generate documentation of the library from the sources.
If you're looking for the documentation please [follow this link](#).
## Prerequsites
1. Doxygen
2. Python 3.9+
3. Pipenv
## Installation
The first time setup is required before generating the documentation. Follow these steps:
1. Open terminal in the `docsrc` directory
2. Run `pipenv install`
### Apple Silicon M1
On Apple M1 processors you may get this error when trying to build the documentation: `Could not parse the contents of index.xml as an xml.`
Most likely this issue is caused by an architecture mismatch of the `lxml` package.
To fix this issue open the Pipenv shell by running `pipenv shell` and follow these steps:
1. Run `pip uninstall lxml`
2. Run `arch -arm64 pip install lxml --no-binary lxml`
This solution forces `lxml` to be built from the sources.
## Generating the documentation
1. Open terminal in the `docsrc` directory
2. Run the Doxygen command `doxygen`
3. Open the Pipenv shell `pipenv shell`
4. Run the build `make html`
The generated documentation will be available in the `docsrc/build/html` directory.
## Github pages
In order to build the documentation that's going to be published as Github pages run `make github`.
The generated HTML build will be automatically moved to the `docs` directory.

35
lib/home-assistant-integration/docsrc/make.bat Normal file
View File

@@ -0,0 +1,35 @@
@ECHO OFF
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=source
set BUILDDIR=build
%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.https://www.sphinx-doc.org/
exit /b 1
)
if "%1" == "" goto help
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end
:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
:end
popd

2603
lib/home-assistant-integration/docsrc/source/Doxyfile Normal file
View File

File diff suppressed because it is too large Load Diff

90
lib/home-assistant-integration/docsrc/source/conf.py Normal file
View File

@@ -0,0 +1,90 @@
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Path setup --------------------------------------------------------------
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
# -- Project information -----------------------------------------------------
project = 'ArduinoHA'
copyright = '2022, Dawid Chyrzynski'
author = 'Dawid Chyrzynski'
# The full version, including alpha/beta/rc tags
release = '2.0.0'
# -- General configuration ---------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'breathe',
'sphinx.ext.extlinks',
'sphinxcontrib.email'
]
# Add any paths that contain templates here, relative to this directory.
# templates_path = ['templates']
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []
# Setup the breathe extension
breathe_projects = {
'ArduinoHA': '../xml'
}
breathe_default_project = 'ArduinoHA'
breathe_show_include = True
breathe_default_members = ('members', 'undoc-members')
# Tell sphinx what the primary language being documented is.
primary_domain = 'cpp'
# Tell sphinx what the pygments highlight language should be.
highlight_language = 'cpp'
extlinks = {
'example': ('https://github.com/dawidchyrzynski/arduino-home-assistant/tree/main/examples/', None)
}
# -- Options for HTML output -------------------------------------------------
html_scaled_image_link = False
html_copy_source = False
html_theme = 'press-ext'
html_theme_path = ['themes']
html_title = 'ArduinoHA'
html_sidebars = {'**': ['util/searchbox.html', 'sidetoc.html']}
html_theme_options = {
'external_links': [
('Github', 'https://github.com/dawidchyrzynski/arduino-home-assistant')
]
}
html_js_files = [
'custom.js'
]
html_css_files = [
'custom.css'
]
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named 'default.css' will overwrite the builtin 'default.css'.
html_static_path = ['static']
# -- Extension ---------------------------------------------------------------
email_automode = False

9
lib/home-assistant-integration/docsrc/source/documents/api/core/ha-device.rst Normal file
View File

@@ -0,0 +1,9 @@
HADevice class
==============
.. doxygenclass:: HADevice
:project: ArduinoHA
:members:
:protected-members:
:private-members:
:undoc-members:

9
lib/home-assistant-integration/docsrc/source/documents/api/core/ha-mqtt.rst Normal file
View File

@@ -0,0 +1,9 @@
HAMqtt class
============
.. doxygenclass:: HAMqtt
:project: ArduinoHA
:members:
:protected-members:
:private-members:
:undoc-members:

7
lib/home-assistant-integration/docsrc/source/documents/api/core/index.rst Normal file
View File

@@ -0,0 +1,7 @@
Core API
========
.. toctree::
ha-device
ha-mqtt

9
lib/home-assistant-integration/docsrc/source/documents/api/device-types/ha-base-device-type.rst Normal file
View File

@@ -0,0 +1,9 @@
HABaseDeviceType class
======================
.. doxygenclass:: HABaseDeviceType
:project: ArduinoHA
:members:
:protected-members:
:private-members:
:undoc-members:

9
lib/home-assistant-integration/docsrc/source/documents/api/device-types/ha-binary-sensor.rst Normal file
View File

@@ -0,0 +1,9 @@
HABinarySensor class
====================
.. doxygenclass:: HABinarySensor
:project: ArduinoHA
:members:
:protected-members:
:private-members:
:undoc-members:

9
lib/home-assistant-integration/docsrc/source/documents/api/device-types/ha-button.rst Normal file
View File

@@ -0,0 +1,9 @@
HAButton class
==============
.. doxygenclass:: HAButton
:project: ArduinoHA
:members:
:protected-members:
:private-members:
:undoc-members:

9
lib/home-assistant-integration/docsrc/source/documents/api/device-types/ha-camera.rst Normal file
View File

@@ -0,0 +1,9 @@
HACamera class
==============
.. doxygenclass:: HACamera
:project: ArduinoHA
:members:
:protected-members:
:private-members:
:undoc-members:

9
lib/home-assistant-integration/docsrc/source/documents/api/device-types/ha-cover.rst Normal file
View File

@@ -0,0 +1,9 @@
HACover class
=============
.. doxygenclass:: HACover
:project: ArduinoHA
:members:
:protected-members:
:private-members:
:undoc-members:

9
lib/home-assistant-integration/docsrc/source/documents/api/device-types/ha-device-tracker.rst Normal file
View File

@@ -0,0 +1,9 @@
HADeviceTracker class
=====================
.. doxygenclass:: HADeviceTracker
:project: ArduinoHA
:members:
:protected-members:
:private-members:
:undoc-members:

9
lib/home-assistant-integration/docsrc/source/documents/api/device-types/ha-device-trigger.rst Normal file
View File

@@ -0,0 +1,9 @@
HADeviceTrigger class
=====================
.. doxygenclass:: HADeviceTrigger
:project: ArduinoHA
:members:
:protected-members:
:private-members:
:undoc-members:

9
lib/home-assistant-integration/docsrc/source/documents/api/device-types/ha-fan.rst Normal file
View File

@@ -0,0 +1,9 @@
HAFan class
===========
.. doxygenclass:: HAFan
:project: ArduinoHA
:members:
:protected-members:
:private-members:
:undoc-members:

9
lib/home-assistant-integration/docsrc/source/documents/api/device-types/ha-hvac.rst Normal file
View File

@@ -0,0 +1,9 @@
HAHVAC class
============
.. doxygenclass:: HAHVAC
:project: ArduinoHA
:members:
:protected-members:
:private-members:
:undoc-members:

9
lib/home-assistant-integration/docsrc/source/documents/api/device-types/ha-light.rst Normal file
View File

@@ -0,0 +1,9 @@
HALight class
=============
.. doxygenclass:: HALight
:project: ArduinoHA
:members:
:protected-members:
:private-members:
:undoc-members:

9
lib/home-assistant-integration/docsrc/source/documents/api/device-types/ha-lock.rst Normal file
View File

@@ -0,0 +1,9 @@
HALock class
============
.. doxygenclass:: HALock
:project: ArduinoHA
:members:
:protected-members:
:private-members:
:undoc-members:

9
lib/home-assistant-integration/docsrc/source/documents/api/device-types/ha-number.rst Normal file
View File

@@ -0,0 +1,9 @@
HANumber class
==============
.. doxygenclass:: HANumber
:project: ArduinoHA
:members:
:protected-members:
:private-members:
:undoc-members:

9
lib/home-assistant-integration/docsrc/source/documents/api/device-types/ha-scene.rst Normal file
View File

@@ -0,0 +1,9 @@
HAScene class
=============
.. doxygenclass:: HAScene
:project: ArduinoHA
:members:
:protected-members:
:private-members:
:undoc-members:

9
lib/home-assistant-integration/docsrc/source/documents/api/device-types/ha-select.rst Normal file
View File

@@ -0,0 +1,9 @@
HASelect class
==============
.. doxygenclass:: HASelect
:project: ArduinoHA
:members:
:protected-members:
:private-members:
:undoc-members:

9
lib/home-assistant-integration/docsrc/source/documents/api/device-types/ha-sensor-number.rst Normal file
View File

@@ -0,0 +1,9 @@
HASensorNumber class
====================
.. doxygenclass:: HASensorNumber
:project: ArduinoHA
:members:
:protected-members:
:private-members:
:undoc-members:

9
lib/home-assistant-integration/docsrc/source/documents/api/device-types/ha-sensor.rst Normal file
View File

@@ -0,0 +1,9 @@
HASensor class
==============
.. doxygenclass:: HASensor
:project: ArduinoHA
:members:
:protected-members:
:private-members:
:undoc-members:

9
lib/home-assistant-integration/docsrc/source/documents/api/device-types/ha-switch.rst Normal file
View File

@@ -0,0 +1,9 @@
HASwitch class
==============
.. doxygenclass:: HASwitch
:project: ArduinoHA
:members:
:protected-members:
:private-members:
:undoc-members:

9
lib/home-assistant-integration/docsrc/source/documents/api/device-types/ha-tag-scanner.rst Normal file
View File

@@ -0,0 +1,9 @@
HATagScanner class
==================
.. doxygenclass:: HATagScanner
:project: ArduinoHA
:members:
:protected-members:
:private-members:
:undoc-members:

23
lib/home-assistant-integration/docsrc/source/documents/api/device-types/index.rst Normal file
View File

@@ -0,0 +1,23 @@
Device types API
================
.. toctree::
ha-base-device-type
ha-binary-sensor
ha-button
ha-camera
ha-cover
ha-device-tracker
ha-device-trigger
ha-fan
ha-hvac
ha-light
ha-lock
ha-number
ha-scene
ha-select
ha-sensor
ha-sensor-number
ha-switch
ha-tag-scanner

8
lib/home-assistant-integration/docsrc/source/documents/api/index.rst Normal file
View File

@@ -0,0 +1,8 @@
API reference
=============
.. toctree::
core/index
device-types/index
utils/index

9
lib/home-assistant-integration/docsrc/source/documents/api/utils/ha-numeric.rst Normal file
View File

@@ -0,0 +1,9 @@
HANumeric class
===============
.. doxygenclass:: HANumeric
:project: ArduinoHA
:members:
:protected-members:
:private-members:
:undoc-members:

9
lib/home-assistant-integration/docsrc/source/documents/api/utils/ha-serializer-array.rst Normal file
View File

@@ -0,0 +1,9 @@
HASerializerArray class
=======================
.. doxygenclass:: HASerializerArray
:project: ArduinoHA
:members:
:protected-members:
:private-members:
:undoc-members:

9
lib/home-assistant-integration/docsrc/source/documents/api/utils/ha-serializer.rst Normal file
View File

@@ -0,0 +1,9 @@
HASerializer class
==================
.. doxygenclass:: HASerializer
:project: ArduinoHA
:members:
:protected-members:
:private-members:
:undoc-members:

9
lib/home-assistant-integration/docsrc/source/documents/api/utils/ha-utils.rst Normal file
View File

@@ -0,0 +1,9 @@
HAUtils class
=============
.. doxygenclass:: HAUtils
:project: ArduinoHA
:members:
:protected-members:
:private-members:
:undoc-members:

9
lib/home-assistant-integration/docsrc/source/documents/api/utils/index.rst Normal file
View File

@@ -0,0 +1,9 @@
Utils API
=========
.. toctree::
ha-numeric
ha-serializer
ha-serializer-array
ha-utils

27
lib/home-assistant-integration/docsrc/source/documents/getting-started/compatible-hardware.rst Normal file
View File

@@ -0,0 +1,27 @@
Compatible Hardware
===================
The library uses the Arduino Ethernet Client API for interacting with the network hardware.
It should work fine as long as the `Client` class is available.
Here is the list of devices on which the library was tested:
- Arduino Uno
- Arduino Mega
- Arduino Nano
- Arduino Pro Mini
- Arduino Nano 33 IoT
- NodeMCU
- Controllino Mega (Pure)
- Controllino Maxi (Pure)
- ESP-01
- ESP32-CAM
- Sonoff Dual R2
- Sonoff Dual R3
- Sonoff Basic
- Sonoff Mini
- Tuya Wi-Fi switch module
- Tuya Wi-Fi curtain module
Please note that it's not the complete list of supported devices.
You may try to use the library on any device that uses Arduino core.

60
lib/home-assistant-integration/docsrc/source/documents/getting-started/examples.rst Normal file
View File

@@ -0,0 +1,60 @@
Examples
========
.. list-table::
:widths: 25 75
:header-rows: 1
:class: examples-table
* - Example
- Description
* - :example:`Binary sensor <binary-sensor/binary-sensor.ino>`
- Using the binary sensor as a door contact sensor.
* - :example:`Button <button/button.ino>`
- Adding simple buttons to the Home Assistant panel.
* - :example:`Camera <esp32-cam/esp32-cam.ino>`
- Publishing the preview from the ESP32-CAM module.
* - :example:`Cover <cover/cover.ino>`
- Controlling a window cover (open / close / stop).
* - :example:`Device trigger <multi-state-button/multi-state-button.ino>`
- Implementation of a simple wall switch that reports press and hold states.
* - :example:`Fan <fan/fan.ino>`
- Controlling a simple fan (state + speed).
* - :example:`HVAC <hvac/hvac.ino>`
- HVAC controller with multiple modes, power control and target temperature.
* - :example:`Lock <lock/lock.ino>`
- A simple door lock that's controlled by the Home Assistant.
* - :example:`Light <light/light.ino>`
- A simple light that allows changing brightness, color temperature and RGB color.
* - :example:`Number <number/number.ino>`
- Adding an interactive numeric slider in the Home Assistant panel.
* - :example:`Scene <scene/scene.ino>`
- Adding a custom scene in the Home Assistant panel.
* - :example:`Select <select/select.ino>`
- A dropdown selector that's displayed in the Home Assistant panel.
* - :example:`Sensor <sensor/sensor.ino>`
- A simple sensor that reports a state in a string representation (open / opening / close).
* - :example:`Analog sensor <sensor-analog/sensor-analog.ino>`
- Reporting the analog pin's voltage to the Home Assistant.
* - :example:`Integer sensor <sensor-integer/sensor-integer.ino>`
- Reporting the device's uptime to the Home Assistant.
* - :example:`Switch <led-switch/led-switch.ino>`
- The LED that's controlled by the Home Assistant.
* - :example:`Multi-switch <multi-switch/multi-switch.ino>`
- Multiple switches controlled by the Home Assistant.
* - :example:`Tag scanner <tag-scanner/tag-scanner.ino>`
- Scanning RFID tags using the MFRC522 module.
* - :example:`Availability <availability/availability.ino>`
- Reporting entities' availability (online / offline) to the Home Assistant.
* - :example:`Advanced availability <advanced-availability/advanced-availability.ino>`
- Advanced availability reporting with MQTT LWT (Last Will and Testament).
* - :example:`MQTT advanced <mqtt-advanced/mqtt-advanced.ino>`
- Subscribing to custom topics and publishing custom messages.
* - :example:`MQTT with credentials <mqtt-with-credentials/mqtt-with-credentials.ino>`
- Establishing connection with a MQTT broker using the credentials.
* - :example:`NodeMCU (ESP8266) <nodemcu/nodemcu.ino>`
- Basic example for ESP8266 devices.
* - :example:`Arduino Nano 33 IoT <nano33iot/nano33iot.ino>`
- Basic example for Arduino Nano 33 IoT (SAMD family).
* - :example:`mDNS discovery <mdns/mdns.ino>`
- Make your ESP8266 discoverable via the mDNS.

17
lib/home-assistant-integration/docsrc/source/documents/getting-started/index.rst Normal file
View File

@@ -0,0 +1,17 @@
Getting started
===============
Welcome to the ArduinoHA library!
This documentation is a step-by-step guide that presents all features of the library.
If you feel that there is anything unclear don't hesitate to open a new GitHub discussion.
Have fun!
.. toctree::
:maxdepth: 2
prerequisites
installation
compatible-hardware
examples

44
lib/home-assistant-integration/docsrc/source/documents/getting-started/installation.rst Normal file
View File

@@ -0,0 +1,44 @@
Installation
============
There are two ways to install the library depending on your project.
If you're using Arduino IDE to compile your project you only need to install the library into the IDE.
The second method is meant for more advanced users that use *makeEspArduino* for building the project for ESP32/ESP8266 devices.
Arduino IDE
-----------
To install the library into your Arduino IDE you can use Library Manager (available from IDE version 1.6.2).
Open the IDE and click to the "Sketch" menu and then *Include Library > Manage Libraries*.
.. image:: images/manage-libraries.png
:width: 500
:align: center
Type "home-assistant-integration" in the search field, select the latest version of the library from the dropdown and then click *Install*.
.. image:: images/library-search.png
:width: 500
:align: center
For other installation methods please refer to `Arduino documentation <https://docs.arduino.cc/software/ide-v1/tutorials/installing-libraries>`_.
makeEspArduino
--------------
The library can be installed in an environment managed by `makeEspArduino <https://github.com/plerup/makeEspArduino>`_.
The best approach is to add the library and its dependency as submodules in the project as follows:
::
git submodule add https://github.com/dawidchyrzynski/arduino-home-assistant.git arduino-home-assistant
cd arduino-home-assistant && git checkout tags/2.0.0 && cd ..
git submodule add https://github.com/knolleary/pubsubclient.git pubsubclient
cd pubsubclient && git checkout tags/v2.8
Then you just need to add one extra line in your `Makefile`:
::
LIBS := $(ROOT)/arduino-home-assistant $(ROOT)/pubsubclient

8
lib/home-assistant-integration/docsrc/source/documents/getting-started/prerequisites.rst Normal file
View File

@@ -0,0 +1,8 @@
Prerequisites
=============
ArduinoHA uses MQTT protocol over TCP to communicate with your Home Assistant instance.
The MQTT broker is not installed by default so you will need to install an extra HA addon in order to get the integration working.
The recommended setup method is to use the `Mosquitto Brokker addon <https://github.com/home-assistant/addons/blob/master/mosquitto/DOCS.md>`_.
After installing the addon your HA instance acts as a broker for all devices you're going to integrate with it.

100
lib/home-assistant-integration/docsrc/source/documents/library/availability-reporting.rst Normal file
View File

@@ -0,0 +1,100 @@
Availability reporting
======================
Home Assistant allows to track online/offline states of devices and device types.
In this way controls available in the panel will be displayed as disabled if a device is offline.
The library allows to expose state of the entire device (i.e. shared availability) or specific type (sensor, switch, light, etc.).
By default this feature is not enabled to save resources (RAM and flash) but you can easily turn it on as shown below.
Shared availability
-------------------
I highly recommend to use shared availability feature as it allows to utilize MQTT LWT.
Basically, shared availability allows to control availability of all types related to a specific device.
For example: if your device has 5 switches and 2 buttons you can control their availability in the HA panel using a single method call.
See example below showing how to enable shared availability of the device.
By default, the device is considered online but you can control its state manually using ``HADevice::setAvailability(bool online)`` method.
In most cases you won't need to control availability manually as the library takes care of availability as long as the device is powered on.
::
#include <ArduinoHA.h>
HADevice device("myUniqueID");
void setup() {
device.enableSharedAvailability();
// device.setAvailability(false); // changes default state to offline
// ...
}
void loop() {
// ...
// device.setAvailability(true); // you can control availability manually if you want
}
MQTT LWT
--------
The shared availability feature is considered a complete solution only if it's used with MQTT LWT feature.
Without LWT if the device is powered off then Home Assistant displays it as online.
That's because availability tracking relies on MQTT messages and if you cut off power of your device then its not capable of publishing the offline message.
When LWT feature is enabled the device becomes offline in the HA panel even if you cut off power supply.
This solution is implemented by MQTT broker that automatically publishes the message when the TCP connection to the device is lost.
::
#include <ArduinoHA.h>
HADevice device("myUniqueID");
void setup() {
device.enableSharedAvailability();
device.enableLastWill();
// ...
}
void loop() {
// ...
}
Device type's availability
--------------------------
There also a way to control availability of specific device types.
Each type can be controlled separately as shown below.
Please note that this solution requires shared availability to be disabled and it's not supported by LWT.
::
#include <Ethernet.h>
#include <ArduinoHA.h>
byte mac[] = {0x00, 0x10, 0xFA, 0x6E, 0x38, 0x4A};
EthernetClient client;
HADevice device(mac, sizeof(mac));
HAMqtt mqtt(client, device);
HASwitch mySwitch("mySwitchId");
void setup() {
Ethernet.begin(mac);
// this line enables availability for your switch
mySwitch.setAvailability(true); // you can also set it to false
// ...
}
void loop() {
// ...
// you can control availability at runtime as follows:
mySwitch.setAvailability(true); // online
mySwitch.setAvailability(false); // offline
}

36
lib/home-assistant-integration/docsrc/source/documents/library/compiler-macros.rst Normal file
View File

@@ -0,0 +1,36 @@
Compiler macros
===============
The library supports couple of macros that are defined in the `ArduinoHADefines.h` file.
You can uncomment them in this specific file or provide flags directly to compiler (for example: via Makefile).
Debug mode
----------
Debug mode unlocks logging feature in the library.
Logs may be useful for debugging the communication with the Home Assistant.
To enable debug mode you need to defined `ARDUINOHA_DEBUG` macro.
Code optimization
-----------------
Defining one of the macros listed below results in truncating the corresponding device type.
It may be useful if you want to save some flash memory occupied by virtual tables of those classes.
* `EX_ARDUINOHA_BINARY_SENSOR`
* `EX_ARDUINOHA_BUTTON`
* `EX_ARDUINOHA_CAMERA`
* `EX_ARDUINOHA_COVER`
* `EX_ARDUINOHA_DEVICE_TRACKER`
* `EX_ARDUINOHA_DEVICE_TRIGGER`
* `EX_ARDUINOHA_FAN`
* `EX_ARDUINOHA_HVAC`
* `EX_ARDUINOHA_LIGHT`
* `EX_ARDUINOHA_LOCK`
* `EX_ARDUINOHA_NUMBER`
* `EX_ARDUINOHA_SCENE`
* `EX_ARDUINOHA_SELECT`
* `EX_ARDUINOHA_SENSOR`
* `EX_ARDUINOHA_SWITCH`
* `EX_ARDUINOHA_TAG_SCANNER`

46
lib/home-assistant-integration/docsrc/source/documents/library/connection-params.rst Normal file
View File

@@ -0,0 +1,46 @@
Connection parameters
=====================
:doc:`HAMqtt </documents/api/core/ha-mqtt>` class exposes a few variants of the ``begin`` method that allows specifying the MQTT connection parameters.
**This method should be called only once and at the end of the setup logic.**
The example below presents all possible variants. Pick one that meets your requirements.
.. NOTE::
Connection to the MQTT broker is established asynchronously.
The :doc:`HAMqtt::begin </documents/api/core/ha-mqtt>` method just sets the parameters of the connection.
The connection attempt is made during the loop cycle.
::
#include <Ethernet.h>
#include <ArduinoHA.h>
byte mac[] = {0x00, 0x10, 0xFA, 0x6E, 0x38, 0x4A};
EthernetClient client;
HADevice device(mac, sizeof(mac));
HAMqtt mqtt(client, device);
void setup() {
Ethernet.begin(mac);
// anoymous connection on default port 1883
mqtt.begin("192.168.1.50");
// anoymous connection on port 8888
mqtt.begin("192.168.1.50", 8888);
// connection with credentials on default port 1883
mqtt.begin("192.168.1.50", "username", "password");
// connection with credentials on port 8888
mqtt.begin("192.168.1.50", 8888, "username", "password");
// you can also use hostname in all variants
mqtt.begin("mybroker.local");
}
void loop() {
Ethernet.maintain();
mqtt.loop();
}

110
lib/home-assistant-integration/docsrc/source/documents/library/device-configuration.rst Normal file
View File

@@ -0,0 +1,110 @@
Device configuration
====================
:doc:`HADevice </documents/api/core/ha-device>` represents the physical device where the library is installed.
Logically it's a group of types like sensors, switches, lights and so on.
In the Home Assistant, it's listed with properties that may be configured using the library's API.
Each property except the unique ID is optional.
Setting optional properties increases flash and RAM usage so it's not recommended to set them on lower-spec MCUs.
The supported properties are:
* unique ID*
* name
* software version
* manufacturer
* model
Unique ID
---------
The ID of a device needs to be unique in a scope of a Home Assistant instance.
The safest solution is to use the MAC address of an Ethernet or Wi-Fi chip but you can also implement your own solution.
There are three different ways to set the ID of the device.
You can pick one depending on your needs.
1) Providing string (const char*) to the :doc:`HADevice </documents/api/core/ha-device>` constructor
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Try to keep the ID simple (alphanumeric characters) and short.
::
#include <ArduinoHA.h>
HADevice device("myUniqueID");
void setup() {
// ...
}
void loop() {
// ...
}
2) Providing byte array to the :doc:`HADevice </documents/api/core/ha-device>` constructor
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
::
#include <ArduinoHA.h>
// use your own unique bytes sequence
byte mac[] = {0x00, 0x10, 0xFA, 0x6E, 0x38, 0x4A};
HADevice device(mac, sizeof(mac));
void setup() {
// ...
}
void loop() {
// ...
}
3) Using :doc:`HADevice::setUniqueId </documents/api/core/ha-device>` method during the setup
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
::
#include <ArduinoHA.h>
HADevice device;
void setup() {
// any length is acceptable
byte myId[] = {0x05, 0xb4, 0xc6, 0x9f, 0xbe, 0xce, 0x8c, 0x1f, 0xc7};
device.setUniqueId(myId, sizeof(myId)); // the input array is cloned internally
// ...
}
void loop() {
// ...
}
Device properties
-----------------
Each property has its corresponding setter method in the :doc:`HADevice </documents/api/core/ha-device>` class.
Please note that all these methods accept const char pointer whose **content is not copied**.
::
#include <ArduinoHA.h>
HADevice device("myUniqueId");
void setup() {
device.setName("Bedroom Light Controller");
device.setSoftwareVersion("1.0.0");
device.setManufacturer("Developer Corp.");
device.setModel("ABC-123");
// ...
}
void loop() {
// ...
}

113
lib/home-assistant-integration/docsrc/source/documents/library/device-types.rst Normal file
View File

@@ -0,0 +1,113 @@
Device types
============
Device type represents a single entity in the Home Assistant panel.
It can be a sensor, lock, camera or anything that's listed in the table below.
Your physical device (for example ESP-01 board) can have multiple device types assigned.
They will be displayed as child entities in the HA panel.
Limitations
-----------
Registering a new device type requires some flash and RAM memory to be utilized.
On less powerful units like Arduino Uno, you may quickly hit the limit of resources, so keeping the device simple is recommended.
Hitting the resource limit will result in random reboots of the device.
By default, the maximum number of device types is 6.
You can increase the limit using the :doc:`HAMqtt </documents/api/core/ha-mqtt>` class constructor as follows:
::
#include <Ethernet.h>
#include <ArduinoHA.h>
byte mac[] = {0x00, 0x10, 0xFA, 0x6E, 0x38, 0x4A};
EthernetClient client;
HADevice device(mac, sizeof(mac));
HAMqtt mqtt(client, device, 12); // <------------ 12 is a new limit of device types
void setup() {
Ethernet.begin(mac);
// your setup logic goes here
}
void loop() {
Ethernet.maintain();
mqtt.loop();
// your loop logic goes here
}
Please note that this limit cannot be changed at runtime.
Supported device types
----------------------
.. list-table::
:widths: 25 15 60
:header-rows: 1
:class: supported-device-types-table
* - Device type
- Supported
- Documentation
* - Binary sensor
- ✅
- :doc:`HABinarySensor </documents/api/device-types/ha-binary-sensor>`
* - Button
- ✅
- :doc:`HAButton </documents/api/device-types/ha-button>`
* - Camera
- ✅
- :doc:`HACamera </documents/api/device-types/ha-camera>`
* - Cover
- ✅
- :doc:`HACover </documents/api/device-types/ha-cover>`
* - Device tracker
- ✅
- :doc:`HADeviceTracker </documents/api/device-types/ha-device-tracker>`
* - Device trigger
- ✅
- :doc:`HADeviceTrigger </documents/api/device-types/ha-device-trigger>`
* - Fan
- ✅
- :doc:`HAFan </documents/api/device-types/ha-fan>`
* - Humidifier
- ❌
- --
* - HVAC
- ✅
- :doc:`HAHVAC </documents/api/device-types/ha-hvac>`
* - Light
- ✅
- :doc:`HALight </documents/api/device-types/ha-light>`
* - Lock
- ✅
- :doc:`HALock </documents/api/device-types/ha-lock>`
* - Number
- ✅
- :doc:`HANumber </documents/api/device-types/ha-number>`
* - Scene
- ✅
- :doc:`HAScene </documents/api/device-types/ha-scene>`
* - Select
- ✅
- :doc:`HASelect </documents/api/device-types/ha-select>`
* - | Sensor (text)
- ✅
- :doc:`HASensor </documents/api/device-types/ha-sensor>`
* - | Sensor (number)
- ✅
- :doc:`HASensorNumber </documents/api/device-types/ha-sensor-number>`
* - Switch
- ✅
- :doc:`HASwitch </documents/api/device-types/ha-switch>`
* - Tag scanner
- ✅
- :doc:`HATagScanner </documents/api/device-types/ha-tag-scanner>`
* - Vacuum
- ❌
- --

44
lib/home-assistant-integration/docsrc/source/documents/library/discovery.rst Normal file
View File

@@ -0,0 +1,44 @@
Discovery
=========
The library automatically maintains connection to the MQTT broker and takes care of the discovery process.
Each device type that you create (sensor, switch, light, fan, etc.) is automatically registered in MQTT manager.
Whenever connection with the MQTT broker is acquired the configuration of all device types is pushed to the Home Assistant.
There is one basic rule that you need to follow: device types need to be constructed after :doc:`HAMqtt </documents/api/core/ha-mqtt>` class.
That's because device types are relying on :doc:`HAMqtt </documents/api/core/ha-mqtt>` instance internally.
Topics prefix
-------------
In some cases you may need to change prefix of MQTT topics.
There are two types of topics utilized by the library:
* **discovery topic** - used for publishing device types' configuration (default: ``homeassistant``)
* **data topic** - used for publishing states, data, etc. (default: ``aha``)
The discovery topic's prefix can be changed using ``HAMqtt::setDiscoveryPrefix(const char* prefix)`` method.
The data topic's prefix can be changed using ``HAMqtt::setDataPrefix(const char* prefix)`` method
::
#include <Ethernet.h>
#include <ArduinoHA.h>
byte mac[] = {0x00, 0x10, 0xFA, 0x6E, 0x38, 0x4A};
EthernetClient client;
HADevice device(mac, sizeof(mac));
HAMqtt mqtt(client, device);
// register your device types here
void setup() {
mqtt.setDiscoveryPrefix("myCustomPrefix");
mqtt.setDataPrefix("myDataPrefix");
// ...
}
void loop() {
// ...
}

19
lib/home-assistant-integration/docsrc/source/documents/library/index.rst Normal file
View File

@@ -0,0 +1,19 @@
Library
=======
This chapter describes basic all of the library's core.
Solid understanding of foundations will allow you to utilize full potential of the library.
.. toctree::
:maxdepth: 2
introduction
device-configuration
availability-reporting
connection-params
discovery
device-types
mqtt-security
mqtt-advanced
compiler-macros

79
lib/home-assistant-integration/docsrc/source/documents/library/introduction.rst Normal file
View File

@@ -0,0 +1,79 @@
Introduction
============
Before implementing the business logic of your application you will need to
add a few necessary pieces of code to your project.
Basically, everything comes up to a few basic rules:
1) :doc:`HADevice </documents/api/core/ha-device>` and :doc:`HAMqtt </documents/api/core/ha-mqtt>` instances need to be initialized once globally or as a part of another global object.
2) :doc:`HAMqtt::begin </documents/api/core/ha-mqtt>` needs to be called at the end of setup logic. It provides MQTT broker credentials that will be used for a connection.
3) :doc:`HAMqtt::loop </documents/api/core/ha-mqtt>` method needs to be called periodically (it doesn't need to be called on each tick).
4) Device types need to be initialized after :doc:`HAMqtt </documents/api/core/ha-mqtt>` class (it will be described later in the documentation).
Here are the minimal boilerplates that you can start with.
Don't worry if you have no idea what's going on here.
Everything will be covered in the following chapters.
Arduino Boilerplate
-------------------
::
#include <Ethernet.h>
#include <ArduinoHA.h>
byte mac[] = {0x00, 0x10, 0xFA, 0x6E, 0x38, 0x4A};
EthernetClient client;
HADevice device(mac, sizeof(mac));
HAMqtt mqtt(client, device);
void setup() {
Ethernet.begin(mac);
// your setup logic goes here
// MQTT broker connection (use your data here)
mqtt.begin("192.168.1.50", "username", "password");
}
void loop() {
Ethernet.maintain();
mqtt.loop();
// your loop logic goes here
}
ESP32/ESP8266 Boilerplate
-------------------------
::
#include <ESP8266WiFi.h>
#include <ArduinoHA.h>
WiFiClient client;
HADevice device;
HAMqtt mqtt(client, device);
void setup() {
byte mac[WL_MAC_ADDR_LENGTH];
WiFi.macAddress(mac);
device.setUniqueId(mac, sizeof(mac));
// you can skip this part if you're already maintaining the connection logic
WiFi.begin("MyNetworkSSID", "MyPassword");
while (WiFi.status() != WL_CONNECTED) {
delay(500); // waiting for the connection
}
// your setup logic goes here
// MQTT broker connection (use your data here)
mqtt.begin("192.168.1.50", "username", "password");
}
void loop() {
mqtt.loop();
// your loop logic goes here
}

110
lib/home-assistant-integration/docsrc/source/documents/library/mqtt-advanced.rst Normal file
View File

@@ -0,0 +1,110 @@
MQTT advanced features
======================
Callbacks
---------
:doc:`HAMqtt </documents/api/core/ha-mqtt>` class exposes some useful callbacks that you can bind to.
Please take a look at the example below.
::
#include <Ethernet.h>
#include <ArduinoHA.h>
byte mac[] = {0x00, 0x10, 0xFA, 0x6E, 0x38, 0x4A};
EthernetClient client;
HADevice device(mac, sizeof(mac));
HAMqtt mqtt(client, device);
void onMessage(const char* topic, const uint8_t* payload, uint16_t length) {
// this method will be called each time the device receives an MQTT message
}
void onConnected() {
// this method will be called when connection to MQTT broker is established
}
void setup() {
Ethernet.begin(mac);
mqtt.onMessage(onMessage);
mqtt.onConnected(onConnected);
mqtt.begin("192.168.1.50", "username", "password");
}
void loop() {
Ethernet.maintain();
mqtt.loop();
}
Subscriptions
-------------
You can also subscribe to a custom topic using ``HAMqtt::subscribe(const char* topic)`` method.
The subscription needs to be made each time a connection to the MQTT broker is established.
::
#include <Ethernet.h>
#include <ArduinoHA.h>
byte mac[] = {0x00, 0x10, 0xFA, 0x6E, 0x38, 0x4A};
EthernetClient client;
HADevice device(mac, sizeof(mac));
HAMqtt mqtt(client, device);
void onMessage(const char* topic, const uint8_t* payload, uint16_t length) {
if (strcmp(topic, "myTopic") == 0) {
// message on "myTopic" received
}
}
void onConnected() {
mqtt.subscribe("myTopic");
}
void setup() {
Ethernet.begin(mac);
mqtt.onMessage(onMessage);
mqtt.onConnected(onConnected);
mqtt.begin("192.168.1.50", "username", "password");
}
void loop() {
Ethernet.maintain();
mqtt.loop();
}
Publishing a message
--------------------
HAMqtt class also exposes the method that allows to publish custom messages.
::
#include <Ethernet.h>
#include <ArduinoHA.h>
byte mac[] = {0x00, 0x10, 0xFA, 0x6E, 0x38, 0x4A};
EthernetClient client;
HADevice device(mac, sizeof(mac));
HAMqtt mqtt(client, device);
void setup() {
Ethernet.begin(mac);
mqtt.begin("192.168.1.50", "username", "password");
}
void loop() {
Ethernet.maintain();
mqtt.loop();
// Publishing the non-retained message:
// mqtt.publish("customTopic", "customPayload");
// Publishing the retained message:
// mqtt.publish("customTopic", "customPayload", true);
}

40
lib/home-assistant-integration/docsrc/source/documents/library/mqtt-security.rst Normal file
View File

@@ -0,0 +1,40 @@
MQTT security
=============
The library allows you to use credentials for acquiring a TCP connection with the MQTT broker.
By default you can use the same credentials you use for login in the Home Assistant panel but you can also configure custom credentials in the Mosquitto broker.
.. DANGER::
This solution is not 100% secure because communication between Arduino and Home Assistant is not encrypted.
Username and password can be easily discovered by analyzing your local network traffic.
However, that's fine as long as your local network is secured against unattended access.
On more powerful devices (like ESP), you should consider using TLS/SSL connection.
::
#include <Ethernet.h>
#include <ArduinoHA.h>
byte mac[] = {0x00, 0x10, 0xFA, 0x6E, 0x38, 0x4A};
EthernetClient client;
HADevice device(mac, sizeof(mac));
HAMqtt mqtt(client, device);
void setup() {
// ...
// replace username and password with your credentials
mqtt.begin("192.168.1.50", "username", "password");
}
void loop() {
// ...
}
SSL connection
--------------
On ESP32/ESP8266 you can use ``WiFiClientSecure`` client to establish encrypted connection between your device and Home Assistant.
Please take a look at :example:`this example <mqtt-with-ssl/mqtt-with-ssl.ino>`.

27
lib/home-assistant-integration/docsrc/source/index.rst Normal file
View File

@@ -0,0 +1,27 @@
ArduinoHA documentation
==================================================
ArduinoHA allows to integrate an Arduino/ESP based device with Home Assistant using MQTT.
The library is designed to use as low resources (RAM/flash) as possible.
Initially, it was optimized to work on Arduino Uno with Ethernet Shield,
but I successfully use it on ESP8266/ESP8255 boards in my projects.
Features
--------
* Two-way communication (state reporting and command execution)
* MQTT discovery (device is added to the Home Assistant panel automatically)
* MQTT Last Will and Testament
* Support for custom MQTT messages (publishing and subscribing)
* Auto reconnect with MQTT broker
* Reporting availability (online/offline states) of a device
* Doxygen documentation
* Covered by unit tests (AUnit + EpoxyDuino + AUniter)
.. toctree::
:caption: Docs
:maxdepth: 3
documents/getting-started/index
documents/library/index
documents/api/index

2
lib/home-assistant-integration/docsrc/source/themes/press-ext/theme.conf Normal file
View File

@@ -0,0 +1,2 @@
[theme]
inherit = press

10
lib/home-assistant-integration/library.properties Normal file
View File

@@ -0,0 +1,10 @@
name=home-assistant-integration
version=2.0.0
author=Dawid Chyrzynski <dev@chyrzynski.pl>
maintainer=Dawid Chyrzynski <dev@chyrzynski.pl>
sentence=Home Assistant MQTT integration for Arduino
paragraph=Lightweight library that provides easy to use API for integrating your Arduino/ESP based device with Home Assistant.
category=Communication
url=https://github.com/dawidchyrzynski/arduino-home-assistant
architectures=*
depends=PubSubClient

33
lib/home-assistant-integration/src/ArduinoHA.h Normal file
View File

@@ -0,0 +1,33 @@
#ifndef AHA_ARDUINOHA_H
#define AHA_ARDUINOHA_H
#include "HADevice.h"
#include "HAMqtt.h"
#include "device-types/HABinarySensor.h"
#include "device-types/HAButton.h"
//#include "device-types/HACamera.h"
//#include "device-types/HACover.h"
//#include "device-types/HADeviceTracker.h"
//#include "device-types/HADeviceTrigger.h"
//#include "device-types/HAFan.h"
//#include "device-types/HAHVAC.h"
#include "device-types/HALight.h"
//#include "device-types/HALock.h"
#include "device-types/HANumber.h"
//#include "device-types/HAScene.h"
#include "device-types/HASelect.h"
#include "device-types/HASensor.h"
#include "device-types/HASensorNumber.h"
#include "device-types/HASwitch.h"
//#include "device-types/HATagScanner.h"
#include "utils/HAUtils.h"
#include "utils/HANumeric.h"
#ifdef ARDUINOHA_TEST
#include "mocks/AUnitHelpers.h"
#include "mocks/PubSubClientMock.h"
#include "utils/HADictionary.h"
#include "utils/HASerializer.h"
#endif
#endif

35
lib/home-assistant-integration/src/ArduinoHADefines.h Normal file
View File

@@ -0,0 +1,35 @@
// Turns on debug information of the ArduinoHA core.
// Please note that you need to initialize serial interface manually
// by calling Serial.begin([baudRate]) before initializing ArduinoHA.
//#define ARDUINOHA_DEBUG
// These macros allow to exclude some parts of the library to save more resources.
#define EX_ARDUINOHA_BINARY_SENSOR
//#define EX_ARDUINOHA_BUTTON
#define EX_ARDUINOHA_CAMERA
#define EX_ARDUINOHA_COVER
#define EX_ARDUINOHA_DEVICE_TRACKER
#define EX_ARDUINOHA_DEVICE_TRIGGER
#define EX_ARDUINOHA_FAN
#define EX_ARDUINOHA_HVAC
//#define EX_ARDUINOHA_LIGHT
#define EX_ARDUINOHA_LOCK
#define EX_ARDUINOHA_NUMBER
#define EX_ARDUINOHA_SCENE
//#define EX_ARDUINOHA_SELECT
// #define EX_ARDUINOHA_SENSOR
// #define EX_ARDUINOHA_SWITCH
#define EX_ARDUINOHA_TAG_SCANNER
#if defined(ARDUINOHA_DEBUG)
#include <Arduino.h>
#define ARDUINOHA_DEBUG_PRINTLN(x) Serial.println(x);
#define ARDUINOHA_DEBUG_PRINT(x) Serial.print(x);
#else
#define ARDUINOHA_DEBUG_INIT()
#define ARDUINOHA_DEBUG_PRINTLN(x)
#define ARDUINOHA_DEBUG_PRINT(x)
#endif
#define AHATOFSTR(x) reinterpret_cast<const __FlashStringHelper*>(x)
#define AHAFROMFSTR(x) reinterpret_cast<const char*>(x)

Some files were not shown because too many files have changed in this diff Show More