Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oberoner21/itemprogressintminmax
Integer value progress menu item class for use with LcdMenu from forntoh
https://github.com/oberoner21/itemprogressintminmax
arduino arduino-uno lcdmenu liquidcrystal liquidcrystal-i2c
Last synced: about 1 month ago
JSON representation
Integer value progress menu item class for use with LcdMenu from forntoh
- Host: GitHub
- URL: https://github.com/oberoner21/itemprogressintminmax
- Owner: Oberoner21
- Created: 2024-08-04T07:19:40.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2024-08-04T09:01:41.000Z (5 months ago)
- Last Synced: 2024-08-05T09:26:37.963Z (5 months ago)
- Topics: arduino, arduino-uno, lcdmenu, liquidcrystal, liquidcrystal-i2c
- Language: C++
- Homepage:
- Size: 15.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ItemProgressIntMinMax
This is a new menu item class to use with LcdMenu from [forntoh](https://github.com/forntoh/LcdMenu). This item class displays and make changeable int values in range with defined minimal and maximal values. Negative values are also possible.
-----
## Arduino code
### Getting started
Include LcdMenu.h and ItemProgressIntMinMax. Make sure that the library required for the interface of your LCD display is also available.(LiquidCrystal.h or LiquidCrystal_I2C.h).
```
#include
#include
```
### Create the LcdMenu object
```
const uint8_t LCD_ROWS = 2;
const uint8_t LCD_COLS = 16;
LcdMenu menu(LCD_ROWS, LCD_COLS);
```
### Create the menu
Create your own menu with the menu item class ItemProgressIntMinMax (and other). The parameters of the new class item in order are:
- key - The menu item displayed text.
- measure - The measure of menu item value is printed behind them. Can be NULL (not displayed).
- minval - The minimum that can be the item value.
- maxval - The maximum that can be the item value.
- start - The item value, when the menu is created.
- stepLength - The step value with which the item value is incremented or decremented by call menu.right() and menu.left().
- callback - The function that is called when editing the menu item is finished.
```
// Declare the menu call back functions
void bassCallback(uint16_t value);
void middleCallback(uint16_t value);
void trebleCallback(uint16_t value);
void balanceCallback(uint16_t value);
void menuExitCallback();
// Define the main menu
MAIN_MENU(
ITEM_PROGRESS_INT_MINMAX("Bass ", "dB", -21, 6, 0, 1, bassCallback),
ITEM_PROGRESS_INT_MINMAX("Middle ", "dB", -21, 6, 0, 1, middleCallback),
ITEM_PROGRESS_INT_MINMAX("Treble ", "dB", -21, 6, 0, 1, trebleCallback),
ITEM_PROGRESS_INT_MINMAX("Balance", NULL, -21, 21, 0, 1, balanceCallback),
ITEM_COMMAND("Exit", menuExitCallback)
);
```
### Initialize the menu
```
void setup()
{
menu.setupLcdWithMenu(0x27, mainMenu); // LcdMenu use the LiquidCrystal_I2C library
}
```
### Set menu item value
To set the value of the menu item dynamically call for example:
```
menu[1]->setProgress(-5); // set the bass menu item value to -5dB
menu[3]->setProgress(4); // set the treble menu item value to 4dB
menu.update();
```
### Handle negative values
The LcdMenu core library works internally with unsigned data types. Therefore, using negative values involves some tricks.
It is therefore necessary to cast the return value, this is from type uint16_t, in the signed type int16_t.
```
void bassCallback(uint16_t value)
{
Serial.println("Bass", (int16_t)value);
}
```
In order to get the base class to work with negative values, it was necessary to redefine the two macros MIN_PROGRESS and MAX_PROGRESS.
### More
For more Informations check the examples section and the github repro from [forntoh](https://github.com/forntoh/LcdMenu).