Michel2/ESPEasy
1
0
Fork 0
mirror of https://github.com/letscontrolit/ESPEasy.git synced 2026-07-28 04:07:47 +00:00
Code Issues Releases Activity

[P104] Add Inverted option (dark on light), incl. docs

Browse Source
This commit is contained in:
Ton Huisman
2021-10-03 20:31:44 +02:00
parent cba5f7deca
commit 2c239c3fba
8 changed files with 109 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/source/Plugin/P104.rst
+16
View File
@@ -260,6 +260,22 @@ Available options:
.. spacer
* **Inverted** With the Inverted option the text or bargraph on the display is either light on a dark background (Normal) or black on a light background (Inverted).
.. warning::
When using the Inverted option, the displays in the zone use **much** more power, so selecting the correct power supply is very important!
Available options:
.. image:: P104_ZoneInvertedOptions.png
:alt: Zone inverted options
* *Normal* Light content on dark background
* *Inverted* Dark content on light background
.. spacer
* **Special Effects** These effects can be used to turn a display 'upside down', in left/right 'mirror-image' or both.
Available options:
docs/source/Plugin/P104_DeviceSettings.png
BIN
View File
Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 73 KiB

After

Width:  |  Height:  |  Size: 71 KiB

docs/source/Plugin/P104_ZoneInvertedOptions.png
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 4.4 KiB

docs/source/Plugin/P104_ZoneSpecialEffectsOptions.png
BIN
View File
Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 4.5 KiB

After

Width:  |  Height:  |  Size: 5.2 KiB

docs/source/Plugin/P104_commands.repl
+10
View File
@@ -100,6 +100,16 @@
1. Double, upper
2. Double, lower
Will cause a reconfiguration of all zones.
"
"
``DotMatrix,inverted,<zone>,<invertedstate>``
","
Set the Inverted state for the indicated zone.
0. Normal, light content on dark background
1. Inverted, dark content on light background
Will cause a reconfiguration of all zones.
"
"
src/_P104_max7219_Dotmatrix.ino
+2
View File
@@ -43,6 +43,7 @@
// pause,<zone>,<pause> : Set the Pause of the zone, determining the delay in millis after Animation In is completed before
// Animation Out starts
// font,<zone>,<font ID> : Set the font for the zone. The font ID is visible in the UI in the Font selection combobox.
// inverted,<zone>,<inv.option> : Set the content display to normal (0), light on dar3k, or inverted (1), dark on light background.
// layout,<zone>,<layout ID> : Set the Layout type if a double-height font is included (upper(1) or lower(2) part) else only Default (0)
// is available
// specialeffect,<zone>,<effect>: Set the Special Effects field, 0 = None, 1 = Flip Up/Done, 2 = Flip Left/Right, 3 = Flip u/d & l/r
@@ -67,6 +68,7 @@
// The bar width is determined by the number of graph-strings
//
// History:
// 2021-10-03 tonhuisman: Add Inverted option per zone
// 2021-09 tonhuisman: Minor improvements, attempts to fix stack failures
// 2021-08-08 tonhuisman: Reworked loading & saving the settings from A huge fixed size pre-allocated block to dynamic allocation
// and saving/loading per zone. That should sove the numerous stack related crashes.
src/src/PluginStructs/P104_data_struct.cpp
+76 -28
View File
@@ -52,10 +52,10 @@ P104_data_struct::~P104_data_struct() {
# endif // ifdef P104_USE_BAR_GRAPH
if (nullptr != P) {
P->~MD_Parola(); // Call destructor directly, as delete of the object fails miserably
// P->~MD_Parola(); // Call destructor directly, as delete of the object fails miserably
// do not: delete P; // Warning: the MD_Parola object doesn't have a virtual destructor, and when changed,
// a reboot uccurs when the object is deleted here!
P = nullptr; // Reset only
P = nullptr; // Reset only
}
}
@@ -269,6 +269,10 @@ void P104_data_struct::loadSettings() {
zones[zoneIndex].repeatDelay = tmp_int;
}
if (validIntFromString(parseString(tmp, 1 + P104_OFFSET_INVERTED, P104_FIELD_SEP), tmp_int)) {
zones[zoneIndex].inverted = tmp_int;
}
delay(0);
numDevices += zones[zoneIndex].size + zones[zoneIndex].offset;
@@ -442,6 +446,9 @@ void P104_data_struct::configureZones() {
}
}
// Inverted
P->setInvert(currentZone, it->inverted);
// Special Effects
P->setZoneEffect(currentZone, (it->specialEffect & P104_SPECIAL_EFFECT_UP_DOWN) == P104_SPECIAL_EFFECT_UP_DOWN, PA_FLIP_UD);
P->setZoneEffect(currentZone, (it->specialEffect & P104_SPECIAL_EFFECT_LEFT_RIGHT) == P104_SPECIAL_EFFECT_LEFT_RIGHT, PA_FLIP_LR);
@@ -499,7 +506,9 @@ void P104_data_struct::displayOneZoneText(uint8_t zone,
const P104_zone_struct& zstruct,
const String & text) {
if ((nullptr == P) || (zone < 0) || (zone > P104_MAX_ZONES)) { return; } // double check
sZoneInitial[zone].reserve(text.length());
sZoneInitial[zone] = text; // Keep the original string for future use
sZoneBuffers[zone].reserve(text.length());
sZoneBuffers[zone] = text; // We explicitly want a copy here so it can be modified by parseTemplate()
sZoneBuffers[zone] = parseTemplate(sZoneBuffers[zone]);
@@ -1084,6 +1093,15 @@ bool P104_data_struct::handlePluginWrite(taskIndex_t taskIndex,
break;
}
if (sub.equals(F("inverted")) && // subcommand: inverted,<zone>,<invertedstate> (disable/enable)
(value4 >= 0) &&
(value4 <= 1)) {
reconfigure = (it->inverted != value4);
it->inverted = value4;
success = true;
break;
}
# if defined(P104_USE_NUMERIC_DOUBLEHEIGHT_FONT) || defined(P104_USE_FULL_DOUBLEHEIGHT_FONT)
if (sub.equals(F("layout")) && // subcommand: layout,<zone>,<layout> (0..2), only when double-height font is available
@@ -1138,7 +1156,7 @@ bool P104_data_struct::handlePluginWrite(taskIndex_t taskIndex,
# else // ifdef P104_USE_COMMANDS
{
String validCommands = F(
"|size|content|alignment|anim.in|speed|anim.out|pause|font|layout|specialeffect|offset|brightness|repeat|");
"|size|content|alignment|anim.in|speed|anim.out|pause|font|inverted|layout|specialeffect|offset|brightness|repeat|");
String testSub = '|';
testSub += sub;
testSub += '|';
@@ -1612,6 +1630,7 @@ bool P104_data_struct::saveSettings() {
zones[zoneIndex].layout = getFormItemIntCustomArgName(index + P104_OFFSET_LAYOUT);
zones[zoneIndex].specialEffect = getFormItemIntCustomArgName(index + P104_OFFSET_SPEC_EFFECT);
zones[zoneIndex].offset = getFormItemIntCustomArgName(index + P104_OFFSET_OFFSET);
zones[zoneIndex].inverted = getFormItemIntCustomArgName(index + P104_OFFSET_INVERTED);
if (zones[zoneIndex].size != 0) { // for newly added zone, use defaults
zones[zoneIndex].brightness = getFormItemIntCustomArgName(index + P104_OFFSET_BRIGHTNESS);
@@ -1691,8 +1710,10 @@ bool P104_data_struct::saveSettings() {
zbuffer += P104_FIELD_SEP; // 1
zbuffer += it->repeatDelay; // 4
zbuffer += P104_FIELD_SEP; // 1
zbuffer += it->inverted; // 1
zbuffer += P104_FIELD_SEP; // 1
// 45 total + (max) 100 characters for it->text requires a buffer of ~150 (P104_SETTINGS_BUFFER_V2), but only required length is
// 47 total + (max) 100 characters for it->text requires a buffer of ~150 (P104_SETTINGS_BUFFER_V2), but only the required length is
// stored with the length prefixed
numDevices += (it->size != 0 ? it->size : 1) + it->offset; // Count corrected for newly added zones
@@ -2070,49 +2091,49 @@ bool P104_data_struct::webform_load(struct EventStruct *event) {
F("Default (0)")
# ifdef P104_USE_NUMERIC_DOUBLEHEIGHT_FONT
, F("Numeric, double height (1)")
# endif // ifdef P104_USE_NUMERIC_DOUBLEHEIGHT_FONT
# endif // ifdef P104_USE_NUMERIC_DOUBLEHEIGHT_FONT
# ifdef P104_USE_FULL_DOUBLEHEIGHT_FONT
, F("Full, double height (2)")
# endif // ifdef P104_USE_FULL_DOUBLEHEIGHT_FONT
# endif // ifdef P104_USE_FULL_DOUBLEHEIGHT_FONT
# ifdef P104_USE_VERTICAL_FONT
, F("Vertical (3)")
# endif // ifdef P104_USE_VERTICAL_FONT
# endif // ifdef P104_USE_VERTICAL_FONT
# ifdef P104_USE_EXT_ASCII_FONT
, F("Extended ASCII (4)")
# endif // ifdef P104_USE_EXT_ASCII_FONT
# ifdef P104_USE_ARABIC_FONT
, F("Arabic (5)")
# endif // ifdef P104_USE_ARABIC_FONT
# endif // ifdef P104_USE_ARABIC_FONT
# ifdef P104_USE_GREEK_FONT
, F("Greek (6)")
# endif // ifdef P104_USE_GREEK_FONT
# endif // ifdef P104_USE_GREEK_FONT
# ifdef P104_USE_KATAKANA_FONT
, F("Katakana (7)")
# endif // ifdef P104_USE_KATAKANA_FONT
# endif // ifdef P104_USE_KATAKANA_FONT
};
const int fontOptions[] = {
P104_DEFAULT_FONT_ID
# ifdef P104_USE_NUMERIC_DOUBLEHEIGHT_FONT
, P104_DOUBLE_HEIGHT_FONT_ID
# endif // ifdef P104_USE_NUMERIC_DOUBLEHEIGHT_FONT
# endif // ifdef P104_USE_NUMERIC_DOUBLEHEIGHT_FONT
# ifdef P104_USE_FULL_DOUBLEHEIGHT_FONT
, P104_FULL_DOUBLEHEIGHT_FONT_ID
# endif // ifdef P104_USE_FULL_DOUBLEHEIGHT_FONT
# endif // ifdef P104_USE_FULL_DOUBLEHEIGHT_FONT
# ifdef P104_USE_VERTICAL_FONT
, P104_VERTICAL_FONT_ID
# endif // ifdef P104_USE_VERTICAL_FONT
# endif // ifdef P104_USE_VERTICAL_FONT
# ifdef P104_USE_EXT_ASCII_FONT
, P104_EXT_ASCII_FONT_ID
# endif // ifdef P104_USE_EXT_ASCII_FONT
# ifdef P104_USE_ARABIC_FONT
, P104_ARABIC_FONT_ID
# endif // ifdef P104_USE_ARABIC_FONT
# endif // ifdef P104_USE_ARABIC_FONT
# ifdef P104_USE_GREEK_FONT
, P104_GREEK_FONT_ID
# endif // ifdef P104_USE_GREEK_FONT
# endif // ifdef P104_USE_GREEK_FONT
# ifdef P104_USE_KATAKANA_FONT
, P104_KATAKANA_FONT_ID
# endif // ifdef P104_USE_KATAKANA_FONT
# endif // ifdef P104_USE_KATAKANA_FONT
};
int layoutCount = 1;
@@ -2151,11 +2172,11 @@ bool P104_data_struct::webform_load(struct EventStruct *event) {
const __FlashStringHelper *contentTypes[] = {
F("Text"),
F("Text reverse"),
F("Clock (4 mod.)"),
F("Clock sec (6 mod.)"),
F("Date (4 mod.)"),
F("Date yr (6/7 mod.)"),
F("Date/time (9/13 mod.)")
F("Clock (4 mod)"),
F("Clock sec (6 mod)"),
F("Date (4 mod)"),
F("Date yr (6/7 mod)"),
F("Date/time (9/13 mod)")
# ifdef P104_USE_BAR_GRAPH
, F("Bar graph")
# endif // ifdef P104_USE_BAR_GRAPH
@@ -2172,6 +2193,14 @@ bool P104_data_struct::webform_load(struct EventStruct *event) {
, P104_CONTENT_BAR_GRAPH
# endif // ifdef P104_USE_BAR_GRAPH
};
const __FlashStringHelper *invertedTypes[3] = {
F("Normal"),
F("Inverted")
};
const int invertedOptions[] = {
0,
1
};
# ifdef P104_USE_ZONE_ACTIONS
uint8_t actionCount = 0;
const __FlashStringHelper *actionTypes[4];
@@ -2204,10 +2233,10 @@ bool P104_data_struct::webform_load(struct EventStruct *event) {
html_table_header(F("Text"), 180);
html_table_header(F("Content"));
html_table_header(F("Alignment"));
html_table_header(F("Animation In/Out")); // 1st and 2nd row title
html_table_header(F("Speed/Pause")); // 1st and 2nd row title
html_table_header(F("Font/Layout")); // 1st and 2nd row title
html_table_header(F("Special Effects"));
html_table_header(F("Animation In/Out")); // 1st and 2nd row title
html_table_header(F("Speed/Pause")); // 1st and 2nd row title
html_table_header(F("Font/Layout")); // 1st and 2nd row title
html_table_header(F("Inverted/ Special&nbsp;Effects")); // 1st and 2nd row title
html_table_header(F("Offset"));
html_table_header(F("Brightness"));
html_table_header(F("Repeat (sec)"));
@@ -2319,7 +2348,22 @@ bool P104_data_struct::webform_load(struct EventStruct *event) {
# endif // ifdef P104_USE_TOOLTIPS
);
html_TD(4); // Fill columns
html_TD(); // Inverted
addSelector(getPluginCustomArgName(index + P104_OFFSET_INVERTED),
2,
invertedTypes,
invertedOptions,
NULL,
zones[zone].inverted,
false,
true,
EMPTY_STRING
# ifdef P104_USE_TOOLTIPS
, F("Inverted") // title
# endif // ifdef P104_USE_TOOLTIPS
);
html_TD(3); // Fill columns
# ifdef P104_USE_ZONE_ACTIONS
html_TD(); // Spacer
@@ -2392,7 +2436,11 @@ bool P104_data_struct::webform_load(struct EventStruct *event) {
zones[zone].specialEffect,
false,
true,
EMPTY_STRING);
EMPTY_STRING
# ifdef P104_USE_TOOLTIPS
, F("Special Effects") // title
# endif // ifdef P104_USE_TOOLTIPS
);
html_TD(); // Offset
addNumericBox(getPluginCustomArgName(index + P104_OFFSET_OFFSET), zones[zone].offset, 0, 254);
@@ -2445,7 +2493,7 @@ bool P104_data_struct::webform_load(struct EventStruct *event) {
}
addFormNote(F("- 'Animation In' or 'Animation Out' and 'Special Effects' marked with <b>*</b> should <b>not</b> be combined in a Zone."));
# if defined(P104_USE_NUMERIC_DOUBLEHEIGHT_FONT) && !defined(P104_USE_FULL_DOUBLEHEIGHT_FONT)
addFormNote(F("- 'Layout' 'Double upper' and 'Double lower' are only supported for 'Content' types 'Clock' and 'Date'."));
addFormNote(F("- 'Layout' 'Double upper' and 'Double lower' are only supported for numeric 'Content' types like 'Clock' and 'Date'."));
# endif // if defined(P104_USE_NUMERIC_DOUBLEHEIGHT_FONT) && !defined(P104_USE_FULL_DOUBLEHEIGHT_FONT)
# endif // ifdef P104_ADD_SETTINGS_NOTES
src/src/PluginStructs/P104_data_struct.h
+5 -2
View File
@@ -169,9 +169,10 @@
# define P104_OFFSET_OFFSET 11u
# define P104_OFFSET_BRIGHTNESS 12u
# define P104_OFFSET_REPEATDELAY 13u
# define P104_OFFSET_ACTION 14u
# define P104_OFFSET_INVERTED 14u
# define P104_OFFSET_ACTION 15u // Should be the last settings option, after all the settings that are stored
# define P104_OFFSET_COUNT 15u // Highest P104_OFFSET_* defined + 1
# define P104_OFFSET_COUNT 16u // Highest P104_OFFSET_* defined + 1
# define P104_CONFIG_ZONE_COUNT PCONFIG(0)
# define P104_CONFIG_TOTAL_UNITS PCONFIG(1)
@@ -318,6 +319,7 @@ struct P104_zone_struct {
offset = 0u;
brightness = -1;
repeatDelay = -1;
inverted = 0u;
}
String text;
@@ -334,6 +336,7 @@ struct P104_zone_struct {
uint8_t specialEffect;
uint8_t offset;
int8_t brightness;
int8_t inverted;
int8_t _lastChecked = -1;
# ifdef P104_USE_BAR_GRAPH
uint16_t _lower, _upper; // lower and upper pixel numbers