Add blacklist/remove entities emsesp#891

MichaelDvP · Jan 24, 2023 · 0e0e9ec · 0e0e9ec
1 parent ede8e7d
commit 0e0e9ec
Show file tree

Hide file tree

Showing 15 changed files with 207 additions and 133 deletions.
diff --git a/CHANGELOG_LATEST.md b/CHANGELOG_LATEST.md
@@ -32,7 +32,8 @@
 - Add Rego 3000, TR120RF thermostats [#917](https://github.com/emsesp/EMS-ESP32/issues/917)
 - Add config for ESP32-S3
 - Add heatpump silent mode and other entities [#896](https://github.com/emsesp/EMS-ESP32/issues/896)
-- Allow reboot to other partition (factory or asymmetric OTA)
+- Allow reboot to other partition (factory or asymetric OTA)
+- blacklist entities to remove from memory [#891](https://github.com/emsesp/EMS-ESP32/issues/891)
 
 ## Fixed
 

diff --git a/interface/src/i18n/de/index.ts b/interface/src/i18n/de/index.ts
@@ -157,6 +157,7 @@ const de: Translation = {
   CUSTOMIZATIONS_HELP_3: 'Schreibaktion deaktivieren',
   CUSTOMIZATIONS_HELP_4: 'von MQTT und API ausschließen',
   CUSTOMIZATIONS_HELP_5: 'Aus dem Kontrollzentrum ausblenden',
+  CUSTOMIZATIONS_HELP_6: 'Aus dem Speicher löschen',
   SELECT_DEVICE: 'Wählen Sie ein Gerät aus',
   SET_ALL: 'setzen Sie alle',
   OPTIONS: 'Optionen',

diff --git a/interface/src/i18n/en/index.ts b/interface/src/i18n/en/index.ts
@@ -157,6 +157,7 @@ const en: Translation = {
   CUSTOMIZATIONS_HELP_3: 'disable write action',
   CUSTOMIZATIONS_HELP_4: 'exclude from MQTT and API',
   CUSTOMIZATIONS_HELP_5: 'hide from Dashboard',
+  CUSTOMIZATIONS_HELP_6: 'remove from memory',
   SELECT_DEVICE: 'Select a device',
   SET_ALL: 'set all',
   OPTIONS: 'Options',

diff --git a/interface/src/i18n/fr/index.ts b/interface/src/i18n/fr/index.ts
@@ -157,6 +157,7 @@ const fr: Translation = {
   CUSTOMIZATIONS_HELP_3: 'désactiver l\'action d\'écriture',
   CUSTOMIZATIONS_HELP_4: 'exclure de MQTT et de l\'API',
   CUSTOMIZATIONS_HELP_5: 'cacher du Tableau de bord',
+  CUSTOMIZATIONS_HELP_6: 'remove from memory',
   SELECT_DEVICE: 'Sélectionnez un appareil',
   SET_ALL: 'tout régler',
   OPTIONS: 'Options',

diff --git a/interface/src/i18n/nl/index.ts b/interface/src/i18n/nl/index.ts
@@ -157,6 +157,7 @@ const nl: Translation = {
   CUSTOMIZATIONS_HELP_3: 'Zet schrijfacties uit',
   CUSTOMIZATIONS_HELP_4: 'Uitsluiten van MQTT en API',
   CUSTOMIZATIONS_HELP_5: 'verberg van het Dashboard',
+  CUSTOMIZATIONS_HELP_6: 'remove from memory',
   SELECT_DEVICE: 'Selecteer een apparaat',
   SET_ALL: 'Alles aanzetten',
   OPTIONS: 'Opties',

diff --git a/interface/src/i18n/no/index.ts b/interface/src/i18n/no/index.ts
@@ -157,6 +157,7 @@ const no: Translation = {
   CUSTOMIZATIONS_HELP_3: 'inaktiviser skriving',
   CUSTOMIZATIONS_HELP_4: 'ekskludere fra MQTT og API',
   CUSTOMIZATIONS_HELP_5: 'gjemme fra Dashboard',
+  CUSTOMIZATIONS_HELP_6: 'remove from memory',
   SELECT_DEVICE: 'Velg en enhet',
   SET_ALL: 'sett alle',
   OPTIONS: 'Alternativ',

diff --git a/interface/src/i18n/pl/index.ts b/interface/src/i18n/pl/index.ts
@@ -157,6 +157,7 @@ const pl: BaseTranslation = {
   CUSTOMIZATIONS_HELP_3: 'zablokuj akcje zapisu',
   CUSTOMIZATIONS_HELP_4: 'wyklucz z MQTT i API',
   CUSTOMIZATIONS_HELP_5: 'ukryj na pulpicie',
+  CUSTOMIZATIONS_HELP_6: 'remove from memory',
   SELECT_DEVICE: 'wybierz urządzenie',
   SET_ALL: 'Ustaw wszystko jako',
   OPTIONS: 'Opcje',

diff --git a/interface/src/i18n/sv/index.ts b/interface/src/i18n/sv/index.ts
@@ -157,6 +157,7 @@ const sv: Translation = {
   CUSTOMIZATIONS_HELP_3: 'Inaktivera skrivningar',
   CUSTOMIZATIONS_HELP_4: 'Exkludera från MQTT & API',
   CUSTOMIZATIONS_HELP_5: 'Göm från Kontrollpanel',
+  CUSTOMIZATIONS_HELP_6: 'remove from memory',
   SELECT_DEVICE: 'Välj en enhet',
   SET_ALL: 'ställ in alla',
   OPTIONS: 'Alternativ',

diff --git a/interface/src/project/OptionIcon.tsx b/interface/src/project/OptionIcon.tsx
@@ -13,9 +13,13 @@ import VisibilityOutlinedIcon from '@mui/icons-material/VisibilityOutlined';
 import CommentsDisabledOutlinedIcon from '@mui/icons-material/CommentsDisabledOutlined';
 import InsertCommentOutlinedIcon from '@mui/icons-material/InsertCommentOutlined';
 
-type OptionType = 'readonly' | 'web_exclude' | 'api_mqtt_exclude' | 'favorite';
+import DeleteOutlineIcon from '@mui/icons-material/DeleteOutline';
+import DeleteForeverIcon from '@mui/icons-material/DeleteForever';
+
+type OptionType = 'deleted' | 'readonly' | 'web_exclude' | 'api_mqtt_exclude' | 'favorite';
 
 const OPTION_ICONS: { [type in OptionType]: [React.ComponentType<SvgIconProps>, React.ComponentType<SvgIconProps>] } = {
+  deleted: [DeleteForeverIcon, DeleteOutlineIcon],
   readonly: [EditOffOutlinedIcon, EditOutlinedIcon],
   web_exclude: [VisibilityOffOutlinedIcon, VisibilityOutlinedIcon],
   api_mqtt_exclude: [CommentsDisabledOutlinedIcon, InsertCommentOutlinedIcon],

diff --git a/interface/src/project/SettingsCustomization.tsx b/interface/src/project/SettingsCustomization.tsx
@@ -17,6 +17,9 @@ import {
   Link
 } from '@mui/material';
 
+import { MessageBox } from '../components';
+import PowerSettingsNewIcon from '@mui/icons-material/PowerSettingsNew';
+
 import { Table } from '@table-library/react-table-library/table';
 import { useTheme } from '@table-library/react-table-library/theme';
 import { Header, HeaderRow, HeaderCell, Body, Row, Cell } from '@table-library/react-table-library/table';
@@ -41,11 +44,14 @@ import { extractErrorMessage, updateValue } from '../utils';
 import { DeviceShort, Devices, DeviceEntity, DeviceEntityMask } from './types';
 
 import { useI18nContext } from '../i18n/i18n-react';
+import RestartMonitor from '../framework/system/RestartMonitor';
 
 export const APIURL = window.location.origin + '/api/';
 
 const SettingsCustomization: FC = () => {
   const { LL } = useI18nContext();
+  const [restarting, setRestarting] = useState<boolean>(false);
+  const [restartNeeded, setRestartNeeded] = useState<boolean>(false);
 
   const { enqueueSnackbar } = useSnackbar();
 
@@ -66,7 +72,7 @@ const SettingsCustomization: FC = () => {
 
   const entities_theme = useTheme({
     Table: `
-      --data-table-library_grid-template-columns: 120px repeat(1, minmax(80px, 1fr)) 45px 45px 120px;
+      --data-table-library_grid-template-columns: 150px repeat(1, minmax(80px, 1fr)) 45px 45px 120px;
     `,
     BaseRow: `
       font-size: 14px;
@@ -210,6 +216,9 @@ const SettingsCustomization: FC = () => {
     if ((m & 8) === 8) {
       new_masks.push('8');
     }
+    if ((m & 128) === 128) {
+      new_masks.push('128');
+    }
     return new_masks;
   };
 
@@ -249,6 +258,15 @@ const SettingsCustomization: FC = () => {
     }
   };
 
+  const restart = async () => {
+    try {
+      await EMSESP.restart();
+      setRestarting(true);
+    } catch (error) {
+      enqueueSnackbar(extractErrorMessage(error, LL.PROBLEM_UPDATING()), { variant: 'error' });
+    }
+  };
+
   const saveCustomization = async () => {
     if (devices && deviceEntities && selectedDevice !== -1) {
       const masked_entities = deviceEntities
@@ -277,6 +295,8 @@ const SettingsCustomization: FC = () => {
         });
         if (response.status === 200) {
           enqueueSnackbar(LL.CUSTOMIZATIONS_SAVED(), { variant: 'success' });
+        } else if (response.status === 201) {
+          setRestartNeeded(true);
         } else {
           enqueueSnackbar(LL.PROBLEM_UPDATING(), { variant: 'error' });
         }
@@ -300,7 +320,8 @@ const SettingsCustomization: FC = () => {
             <OptionIcon type="favorite" isSet={true} />={LL.CUSTOMIZATIONS_HELP_2()}&nbsp;&nbsp;
             <OptionIcon type="readonly" isSet={true} />={LL.CUSTOMIZATIONS_HELP_3()}&nbsp;&nbsp;
             <OptionIcon type="api_mqtt_exclude" isSet={true} />={LL.CUSTOMIZATIONS_HELP_4()}&nbsp;&nbsp;
-            <OptionIcon type="web_exclude" isSet={true} />={LL.CUSTOMIZATIONS_HELP_5()}
+            <OptionIcon type="web_exclude" isSet={true} />={LL.CUSTOMIZATIONS_HELP_5()}&nbsp;&nbsp;
+            <OptionIcon type="deleted" isSet={true} />={LL.CUSTOMIZATIONS_HELP_6()}
           </Typography>
         </Box>
         <ValidatedTextField
@@ -413,6 +434,9 @@ const SettingsCustomization: FC = () => {
               <ToggleButton value="1">
                 <OptionIcon type="web_exclude" isSet={true} />
               </ToggleButton>
+              <ToggleButton value="128">
+                <OptionIcon type="deleted" isSet={true} />
+              </ToggleButton>
             </ToggleButtonGroup>
           </Grid>
 
@@ -467,53 +491,61 @@ const SettingsCustomization: FC = () => {
                 {tableList.map((de: DeviceEntity) => (
                   <Row key={de.id} item={de} onClick={() => editEntity(de)}>
                     <Cell stiff>
-                      <ToggleButtonGroup
-                        size="small"
-                        color="secondary"
-                        value={getMaskString(de.m)}
-                        onChange={(event, mask) => {
-                          de.m = getMaskNumber(mask);
-                          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}>
-                          <OptionIcon
-                            type="favorite"
-                            isSet={(de.m & DeviceEntityMask.DV_FAVORITE) === DeviceEntityMask.DV_FAVORITE}
-                          />
-                        </ToggleButton>
-                        <ToggleButton value="4" disabled={!de.w || (de.m & 3) === 3}>
-                          <OptionIcon
-                            type="readonly"
-                            isSet={(de.m & DeviceEntityMask.DV_READONLY) === DeviceEntityMask.DV_READONLY}
-                          />
-                        </ToggleButton>
-                        <ToggleButton value="2" disabled={de.n === ''}>
-                          <OptionIcon
-                            type="api_mqtt_exclude"
-                            isSet={
-                              (de.m & DeviceEntityMask.DV_API_MQTT_EXCLUDE) === DeviceEntityMask.DV_API_MQTT_EXCLUDE
+                      {!deviceEntity && (
+                        <ToggleButtonGroup
+                          size="small"
+                          color="secondary"
+                          value={getMaskString(de.m)}
+                          onChange={(event, mask) => {
+                            de.m = getMaskNumber(mask);
+                            if (de.n === '' && (de.m & DeviceEntityMask.DV_READONLY)) {
+                              de.m = de.m | DeviceEntityMask.DV_WEB_EXCLUDE;
                             }
-                          />
-                        </ToggleButton>
-                        <ToggleButton value="1" disabled={de.n === undefined}>
-                          <OptionIcon
-                            type="web_exclude"
-                            isSet={(de.m & DeviceEntityMask.DV_WEB_EXCLUDE) === DeviceEntityMask.DV_WEB_EXCLUDE}
-                          />
-                        </ToggleButton>
-                      </ToggleButtonGroup>
+                            if (de.m & DeviceEntityMask.DV_WEB_EXCLUDE) {
+                              de.m = de.m & ~DeviceEntityMask.DV_FAVORITE;
+                            }
+                            setMasks(['']);
+                          }}
+                        >
+                          <ToggleButton value="8" disabled={(de.m & 0x81) !== 0 || de.n === undefined}>
+                            <OptionIcon
+                              type="favorite"
+                              isSet={(de.m & DeviceEntityMask.DV_FAVORITE) === DeviceEntityMask.DV_FAVORITE}
+                            />
+                          </ToggleButton>
+                          <ToggleButton value="4" disabled={!de.w || (de.m & 0x83) >= 3}>
+                            <OptionIcon
+                              type="readonly"
+                              isSet={(de.m & DeviceEntityMask.DV_READONLY) === DeviceEntityMask.DV_READONLY}
+                            />
+                          </ToggleButton>
+                          <ToggleButton value="2" disabled={de.n === '' || (de.m & 0x80) !== 0}>
+                            <OptionIcon
+                              type="api_mqtt_exclude"
+                              isSet={
+                                (de.m & DeviceEntityMask.DV_API_MQTT_EXCLUDE) === DeviceEntityMask.DV_API_MQTT_EXCLUDE
+                              }
+                            />
+                          </ToggleButton>
+                          <ToggleButton value="1" disabled={de.n === undefined || (de.m & 0x80) !== 0}>
+                            <OptionIcon
+                              type="web_exclude"
+                              isSet={(de.m & DeviceEntityMask.DV_WEB_EXCLUDE) === DeviceEntityMask.DV_WEB_EXCLUDE}
+                            />
+                          </ToggleButton>
+                          <ToggleButton value="128" >
+                            <OptionIcon
+                              type="deleted"
+                              isSet={(de.m & DeviceEntityMask.DV_DELETED) === DeviceEntityMask.DV_DELETED}
+                            />
+                          </ToggleButton>
+                        </ToggleButtonGroup>
+                      )}
                     </Cell>
-                    <Cell>{formatName(de)}</Cell>
-                    <Cell>{!(de.m & DeviceEntityMask.DV_READONLY) && formatValue(de.mi)}</Cell>
-                    <Cell>{!(de.m & DeviceEntityMask.DV_READONLY) && formatValue(de.ma)}</Cell>
-                    <Cell>{formatValue(de.v)}</Cell>
+                    <Cell>{!deviceEntity && (formatName(de))}</Cell>
+                    <Cell>{!deviceEntity && !(de.m & DeviceEntityMask.DV_READONLY) && formatValue(de.mi)}</Cell>
+                    <Cell>{!deviceEntity && !(de.m & DeviceEntityMask.DV_READONLY) && formatValue(de.ma)}</Cell>
+                    <Cell>{!deviceEntity && (formatValue(de.v))}</Cell>
                   </Row>
                 ))}
               </Body>
@@ -552,25 +584,34 @@ const SettingsCustomization: FC = () => {
       </Typography>
       {renderDeviceList()}
       {renderDeviceData()}
-      <Box display="flex" flexWrap="wrap">
-        <Box flexGrow={1}>
+      {restartNeeded && (
+        <MessageBox my={2} level="warning" message={LL.RESTART_TEXT()}>
+          <Button startIcon={<PowerSettingsNewIcon />} variant="contained" color="error" onClick={restart}>
+            {LL.RESTART()}
+          </Button>
+        </MessageBox>
+      )}
+      {!restartNeeded && (
+        <Box display="flex" flexWrap="wrap">
+          <Box flexGrow={1}>
+            <ButtonRow>
+              <Button startIcon={<SaveIcon />} variant="outlined" color="primary" onClick={() => saveCustomization()}>
+                {LL.SAVE()}
+              </Button>
+            </ButtonRow>
+          </Box>
           <ButtonRow>
-            <Button startIcon={<SaveIcon />} variant="outlined" color="primary" onClick={() => saveCustomization()}>
-              {LL.SAVE()}
+            <Button
+              startIcon={<SettingsBackupRestoreIcon />}
+              variant="outlined"
+              color="error"
+              onClick={() => setConfirmReset(true)}
+            >
+              {LL.RESET(0)}
             </Button>
           </ButtonRow>
         </Box>
-        <ButtonRow>
-          <Button
-            startIcon={<SettingsBackupRestoreIcon />}
-            variant="outlined"
-            color="error"
-            onClick={() => setConfirmReset(true)}
-          >
-            {LL.RESET(0)}
-          </Button>
-        </ButtonRow>
-      </Box>
+      )}
       {renderResetDialog()}
     </>
   );
@@ -582,48 +623,7 @@ const SettingsCustomization: FC = () => {
         <Dialog open={!!deviceEntity} onClose={() => setDeviceEntity(undefined)}>
           <DialogTitle>{LL.EDIT() + ' ' + LL.ENTITY() + ' "' + de.id + '"'}</DialogTitle>
           <DialogContent dividers>
-            <ToggleButtonGroup
-              size="small"
-              color="secondary"
-              value={getMaskString(de.m)}
-              onChange={(event, mask) => {
-                de.m = getMaskNumber(mask);
-                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}>
-                <OptionIcon
-                  type="favorite"
-                  isSet={(de.m & DeviceEntityMask.DV_FAVORITE) === DeviceEntityMask.DV_FAVORITE}
-                />
-              </ToggleButton>
-              <ToggleButton value="4" disabled={!de.w || (de.m & 3) === 3}>
-                <OptionIcon
-                  type="readonly"
-                  isSet={(de.m & DeviceEntityMask.DV_READONLY) === DeviceEntityMask.DV_READONLY}
-                />
-              </ToggleButton>
-              <ToggleButton value="2" disabled={de.n === ''}>
-                <OptionIcon
-                  type="api_mqtt_exclude"
-                  isSet={(de.m & DeviceEntityMask.DV_API_MQTT_EXCLUDE) === DeviceEntityMask.DV_API_MQTT_EXCLUDE}
-                />
-              </ToggleButton>
-              <ToggleButton value="1" disabled={de.n === undefined}>
-                <OptionIcon
-                  type="web_exclude"
-                  isSet={(de.m & DeviceEntityMask.DV_WEB_EXCLUDE) === DeviceEntityMask.DV_WEB_EXCLUDE}
-                />
-              </ToggleButton>
-            </ToggleButtonGroup>
-
-            <Box color="warning.main" p={0} pl={0} pr={0} mt={2} mb={2}>
+            <Box color="warning.main" mb={2}>
               <Typography variant="body2">
                 {LL.DEFAULT(1) + ' ' + LL.NAME(1)}:&nbsp;{deviceEntity.n}
               </Typography>
@@ -689,7 +689,7 @@ const SettingsCustomization: FC = () => {
 
   return (
     <SectionContent title={LL.USER_CUSTOMIZATION()} titleGutter>
-      {renderContent()}
+      {restarting ? <RestartMonitor /> : renderContent()}
       {renderEditDialog()}
     </SectionContent>
   );

diff --git a/interface/src/project/types.ts b/interface/src/project/types.ts
@@ -298,5 +298,6 @@ export enum DeviceEntityMask {
   DV_WEB_EXCLUDE = 1,
   DV_API_MQTT_EXCLUDE = 2,
   DV_READONLY = 4,
-  DV_FAVORITE = 8
+  DV_FAVORITE = 8,
+  DV_DELETED = 128
 }