various minor changes, including managing hidden entities in customization screen #527

proddy · 2022-05-26T15:50:33Z

No description provided.

MichaelDvP · 2022-05-26T16:12:58Z

interface/src/project/SettingsCustomization.tsx

@@ -464,7 +471,7 @@ const SettingsCustomization: FC = () => {
                          setMasks(['']);
                        }}
                      >
-                        <ToggleButton value="8" disabled={(de.m & 1) !== 0 || de.id === ''}>
+                        <ToggleButton value="8" disabled={(de.m & 1) !== 0 || de.id === '' || de.s === de.id}>


i think the check for === '' is not needed anymore.

yes, good spot

MichaelDvP · 2022-05-26T16:49:23Z

Another point, the reset have short- and fullname "reset", we have to rename to different names now to allow to show in web ui.

And same for some other values with identical texts: heatmetering, pumpkick, doublematchflow, activated, status. Isn't it easier to leave fullname blank and use a combined string(de.id + de.s) as unique key?

proddy · 2022-05-26T20:23:15Z

Another point, the reset have short- and fullname "reset", we have to rename to different names now to allow to show in web ui.

And same for some other values with identical texts: heatmetering, pumpkick, doublematchflow, activated, status. Isn't it easier to leave fullname blank and use a combined string(de.id + de.s) as unique key?

that's an option. but how would we detect in the web UI if it's a hidden entity or not?

MichaelDvP · 2022-05-27T05:56:22Z

I have not read the table documentation, so maybe i'm wrong. As you mentioned the unique id i thought this is this key: https://github.com/emsesp/EMS-ESP32/blob/9d25f8049c92b024e33c0bceefc66306a008018d/interface/src/project/SettingsCustomization.tsx#L453
And changing to key={de.id + de.s} should make the key unique also with empty id.

proddy · 2022-05-27T06:01:18Z

I have not read the table documentation, so maybe i'm wrong. As you mentioned the unique id i thought this is this key: https://github.com/emsesp/EMS-ESP32/blob/9d25f8049c92b024e33c0bceefc66306a008018d/interface/src/project/SettingsCustomization.tsx#L453 And changing to key={de.id + de.s} should make the key unique also with empty id.

the data object takes an array of nodes which must contain the id property. It's internally and not the key attribute of the map function. The solution I'll use for hidden entities is using a special char in the name (like a *) and handle the check in the typescript code

…name

proddy · 2022-05-27T07:50:44Z

ok Michael, think this should work now

MichaelDvP · 2022-05-27T08:36:37Z

src/emsdevice.cpp

-            obj["s"] = dv.short_name;
+        // n is the fullname, and can be optional
+        // don't add the fullname if its a command
+        if (dv.type != DeviceValueType::CMD) {


Why do you skip the fullname for commands? I think show them as normal and delete line 842/843/853

there is only one command, in the boiler called reset and it shows up in the Customizations as reset (reset) which is silly. The shortname is also not relevant as it's not part of the API and MQTT. If you think we still need to show the shortname then I would suggest changing the fullname to something more descriptive like 'reset command' ?

But you skip the fullname for command and so it's handled as hidden, but it is not hidden, we want to have all options to show in web. Since you are using now the shortname as id, you can not skip the shortname.

You can modify formatName() to

if (de.n === undefined || de.n === de.id) { return de.id;

to avoid "reset (reset)" and "pumpkick (pumpkick)", "activated (activated)", etc. This have no effect to the customization logic.

Ok that's a much better option. Thanks

I'm still not sending the entity fullname if its a command as this is the only way the Customizations web page knows whether it's a command or not.

MichaelDvP · 2022-05-28T08:32:13Z

You are mixing commands and hidden values with the result that now both are not working correctly.
Why not add a de.c for commands, like in dashboard, or use de.n undefined for hidden and de.n empty for commands, but not the same for both.
Correction: the de.c in dashboard is different aand not commandonly. don't use this to avoid misunderstanding.,

proddy · 2022-05-28T13:26:31Z

You are mixing commands and hidden values with the result that now both are not working correctly. Why not add a de.c for commands, like in dashboard, or use de.n undefined for hidden and de.n empty for commands, but not the same for both. Correction: the de.c in dashboard is different aand not commandonly. don't use this to avoid misunderstanding.,

not sure I follow. It works for me. What is a 'hidden' entity?

MichaelDvP · 2022-05-28T14:25:40Z

not sure I follow. It works for me. What is a 'hidden' entity?

hidden iswhat you have introduced for id and ha-mode, a entitiy not shown in the web with missing fullname. Now it's only the climate generation, not shown in web and mqtt, no command but customization button for mqtt/api to disable the climate generation. Shoul look like this:

The command reset does not show in mqtt (but is subscribed via wildcard), because it have no value, but shows in web to send the right command. It is and has a command, so we could disable write, but than it should also disable the web. Should look like this:

But you handle both the same way without fullname.

I'm using now de.n undefined for hidden and de.n empty for command:

        if (dv.type == DeviceValueType::CMD) {
            obj["n"] = "";

  function formatName(de: DeviceEntity) {
    if (de.n === undefined || de.n === de.id) {
      return de.id;
    } else if (de.n === '') {
      return 'Command: ' + de.id;
    }
    return de.n + ' (' + de.id + ')';
  }

                          if (de.n === '' && (de.m & DeviceEntityMask.DV_READONLY)) {
                            de.m = de.m | DeviceEntityMask.DV_WEB_EXCLUDE;
                          }
                          if (de.m & DeviceEntityMask.DV_WEB_EXCLUDE) {
                            de.m = de.m & ~DeviceEntityMask.DV_FAVORITE;
                          }
                          setMasks(['']);
                        }}
                      >
                        <ToggleButton value="8" disabled={(de.m & 1) !== 0 || de.n === undefined}>
                          <StarIcon sx={{ fontSize: 14 }} />
                        </ToggleButton>
                        <ToggleButton value="4" disabled={!de.w || (de.m & 3) === 3}>
                          <EditOffOutlinedIcon sx={{ fontSize: 14 }} />
                        </ToggleButton>
                        <ToggleButton value="2" disabled={de.n === ''}>
                          <CommentsDisabledOutlinedIcon sx={{ fontSize: 14 }} />
                        </ToggleButton>
                        <ToggleButton value="1" disabled={de.n === undefined}>
                          <VisibilityOffOutlinedIcon sx={{ fontSize: 14 }} />
                        </ToggleButton>
                      </ToggleButtonGroup>

proddy · 2022-05-28T15:54:02Z

wow, you know the code better than I do. I'll incorporate your changes. One last thing, should we show the value for ha/climate creation. Now it looks like:

MichaelDvP · 2022-05-29T07:09:53Z

Yes, i think leave the value to climate, it's a good feedback that it's active and shows the right value. (as you see above in my screenshot for ha disabled the value is empty).

proddy · 2022-05-29T07:14:10Z

Yes, i think leave the value to climate, it's a good feedback that it's active and shows the right value. (as you see above in my screenshot for ha disabled the value is empty).

ok, so if you're ok with PR can you approve and merge it? (or I'll do it, either way)

proddy added 10 commits May 26, 2022 17:46

update test data for customizations

c4cfabf

remove debug_flags

31627bb

3.4.1b1

a9064ba

rename generate_values_web_customization

cba0813

rename generate_values_web_customization

af7cd7b

formatting

2c468c7

rename ha_climate_config_creation

6ec67f7

if no fullname, use shortname in customizations json

be844a5

fix isCmdOnly() function for commands like reset

f8bf6b5

added formatName so hidden entities render nicely

8824f4f

proddy requested a review from MichaelDvP May 26, 2022 15:50

MichaelDvP approved these changes May 26, 2022

View reviewed changes

customizations, swap shortname and fullname, using id as unique short…

1e082f9

…name

MichaelDvP reviewed May 27, 2022

View reviewed changes

proddy added 2 commits May 27, 2022 17:16

fixes to customizations

1fbd69b

typo

55133b0

fix standalone server for handling customizations

356390c

improved icon toggling

e4447ee

proddy requested a review from MichaelDvP May 29, 2022 07:14

proddy added 3 commits May 29, 2022 13:57

update packages

c693ef6

updated changelog for 3.4.1

3e7b743

emsesp#513

4352188

MichaelDvP approved these changes May 29, 2022

View reviewed changes

proddy merged commit e65f507 into emsesp:dev May 29, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

various minor changes, including managing hidden entities in customization screen #527

various minor changes, including managing hidden entities in customization screen #527

proddy commented May 26, 2022

MichaelDvP May 26, 2022

proddy May 26, 2022

MichaelDvP commented May 26, 2022 •

edited

Loading

proddy commented May 26, 2022

MichaelDvP commented May 27, 2022

proddy commented May 27, 2022

proddy commented May 27, 2022

MichaelDvP May 27, 2022

proddy May 27, 2022

MichaelDvP May 27, 2022

MichaelDvP May 27, 2022

proddy May 27, 2022

proddy May 27, 2022

MichaelDvP commented May 28, 2022 •

edited

Loading

proddy commented May 28, 2022

MichaelDvP commented May 28, 2022

proddy commented May 28, 2022

MichaelDvP commented May 29, 2022

proddy commented May 29, 2022

various minor changes, including managing hidden entities in customization screen #527

various minor changes, including managing hidden entities in customization screen #527

Conversation

proddy commented May 26, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MichaelDvP commented May 26, 2022 • edited Loading

proddy commented May 26, 2022

MichaelDvP commented May 27, 2022

proddy commented May 27, 2022

proddy commented May 27, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MichaelDvP commented May 28, 2022 • edited Loading

proddy commented May 28, 2022

MichaelDvP commented May 28, 2022

proddy commented May 28, 2022

MichaelDvP commented May 29, 2022

proddy commented May 29, 2022

MichaelDvP commented May 26, 2022 •

edited

Loading

MichaelDvP commented May 28, 2022 •

edited

Loading