@homebridge-plugins/homebridge-eufy-security 5.0.0-beta.15 → 5.0.0-beta.17

package/homebridge-ui/public/js/dashboard.js

@@ -37,8 +37,10 @@
    *
    * A row is the whole control — the state names itself and the select beside it says what it means. An
    * unassigned state shows a dash, which is what keeps Night out of HomeKit until it is given a mode.
+   *
+   * It is withheld while the security system it maps is turned off, and the stored map is kept for when it is back.
    */
-  function armingModeControl(device, assigned, messages) {
+  function armingModeControl(device, assigned, messages, securitySystem) {
     const summary = ARMING_SLOTS.map(
       ({ slot, label }) => `${messages[label]} → ${EUFY_MODES.find((mode) => mode.value === assigned[slot])?.label ?? '—'}`,
     ).join(' · ');
@@ -52,17 +54,18 @@
       return `<tr><th scope="row"><label for="${id}">${escapeHtml(messages[label])}</label></th><td><select id="${id}" data-preference="armingModes" data-slot="${slot}" data-serial="${escapeHtml(device.serial)}" data-original="${escapeHtml(value)}"><option value=""${value === '' ? ' selected' : ''}>—</option>${options}</select></td></tr>`;
     }).join('');
     const assignedItself = ARMING_SLOTS.some(({ slot }) => assigned[slot] !== DEFAULT_ARMING_MODES[slot]);
-    return `<details class="arming-setting" data-setting${assignedItself ? ' open' : ''}${device.represented ? '' : ' hidden'} data-requires-representation><summary><span class="setting-label">${escapeHtml(messages.preferenceArmingModes)}</span><span class="arming-summary">${escapeHtml(summary)}</span></summary><table class="arming-table"><thead><tr><th scope="col">HomeKit</th><th scope="col">eufy</th></tr></thead><tbody>${rows}</tbody></table><p class="snapshot-help">${escapeHtml(messages.armingModesHelp)}</p></details>`;
+    return `<details class="arming-setting" data-setting${assignedItself ? ' open' : ''}${device.represented && securitySystem ? '' : ' hidden'} data-requires-representation data-requires-security-system><summary><span class="setting-label">${escapeHtml(messages.preferenceArmingModes)}</span><span class="arming-summary">${escapeHtml(summary)}</span></summary><table class="arming-table"><thead><tr><th scope="col">HomeKit</th><th scope="col">eufy</th></tr></thead><tbody>${rows}</tbody></table><p class="snapshot-help">${escapeHtml(messages.armingModesHelp)}</p></details>`;
   }
 
   function preferenceControl(device, key, preference, messages) {
     const labels = {
       represented: messages.preferenceRepresented,
       audio: messages.preferenceAudio,
+      securitySystem: messages.preferenceSecuritySystem,
       snapshotMode: messages.preferenceSnapshotMode,
     };
     if (key === 'armingModes') {
-      return armingModeControl(device, preference.armingModes, messages);
+      return armingModeControl(device, preference.armingModes, messages, preference.securitySystem);
     }
     const represented = preference.represented;
     const dependent = key === 'represented' ? '' : ` data-requires-representation${represented ? '' : ' hidden'}`;
@@ -260,16 +263,53 @@
    */
   const DIAGNOSABLE = new Set(['incomplete', 'missing', 'stale']);
 
+  /** The diagnostics area a condition's capture belongs to, by its code. A code no entry matches is `other`. */
+  const CONDITION_AREAS = [
+    [/^camera-recording/, 'hksv-recording'],
+    [/^camera-(?:live|media|streaming|snapshot|talkback)/, 'live-media'],
+    [/lock|light|arming|siren|contact|camera-control/, 'control-state'],
+    [/transport-degraded/, 'startup-authentication'],
+  ];
+
+  /**
+   * The problem the diagnostics action points at, or nothing: a state a run explains, then the first active condition
+   * this page has words for, then the first device nothing can reach. Each names the diagnostics area a run on it is
+   * about. A condition is worded under its log keys; the ones left unworded are those the page answers on its own,
+   * such as a sign-in or another owner, and the devices no action makes supported.
+   */
+  function attention(result, state, messages) {
+    if (DIAGNOSABLE.has(result.state)) return { ...state, profile: 'startup-authentication' };
+    const condition = (result.conditions ?? []).find(
+      ({ summaryKey, actionKey }) => messages[summaryKey] && messages[actionKey],
+    );
+    if (condition) {
+      return {
+        title: messages[condition.summaryKey],
+        summary: messages[condition.actionKey],
+        profile: CONDITION_AREAS.find(([code]) => code.test(condition.code))?.[1] ?? 'other',
+      };
+    }
+    const device = result.devices.find((candidate) => candidate.availability === 'unavailable');
+    return (
+      device && {
+        title: (messages.attentionUnreachableTitle ?? '').replace('{device}', device.name),
+        summary: messages.attentionUnreachableSummary ?? '',
+        profile: 'device-representation',
+      }
+    );
+  }
+
+  /** Draws the dashboard, and answers the problem it shows the diagnostics action, if any. */
   function render(result, config, messages, elements) {
     const suffix = result.state
       .split('-')
       .map((part) => part[0].toUpperCase() + part.slice(1))
       .join('');
-    elements.title.textContent = messages[`dashboard${suffix}Title`] ?? messages.dashboardIncompleteTitle;
-    elements.summary.textContent = messages[`dashboard${suffix}Summary`] ?? messages.dashboardIncompleteSummary;
+    const title = messages[`dashboard${suffix}Title`] ?? messages.dashboardIncompleteTitle;
+    const summary = messages[`dashboard${suffix}Summary`] ?? messages.dashboardIncompleteSummary;
+    elements.title.textContent = title;
+    elements.summary.textContent = summary;
     elements.dashboard.dataset.state = result.state;
-    // Offered rather than announced: a run is worth suggesting only where the state is one a run explains.
-    if (elements.diagnose) elements.diagnose.hidden = !DIAGNOSABLE.has(result.state);
     elements.dashboard.hidden = false;
     elements.masthead.hidden = true;
     renderUpdatePending(result, messages, elements);
@@ -281,6 +321,7 @@
     } else if (result.state === 'authentication-required') {
       elements.setup.hidden = false;
     }
+    return attention(result, { title, summary }, messages);
   }
 
   function bindPreferences(elements, getConfig, saveConfig, getMessages, openDevice) {
@@ -311,7 +352,7 @@
       const key = control?.dataset?.preference;
       const existing = getConfig();
       if (!existing || !serial || !key) return;
-      const defaults = { represented: true, audio: true, snapshotMode: 'Refresh' };
+      const defaults = { represented: true, audio: true, securitySystem: true, snapshotMode: 'Refresh' };
       if (key === 'armingModes') {
         await saveArmingMode(control, serial, existing, saveConfig, getMessages, elements);
         return;
@@ -337,9 +378,16 @@
             (candidate) => candidate.dataset.serial === serial,
           );
           tile?.classList.toggle('device-tile-disabled', !value);
+          const grid = control.closest('.preference-grid');
+          const securityOff = grid?.querySelector('[data-preference="securitySystem"]')?.checked === false;
+          grid?.querySelectorAll('[data-requires-representation]').forEach((setting) => {
+            setting.hidden = !value || (securityOff && setting.hasAttribute('data-requires-security-system'));
+          });
+        }
+        if (key === 'securitySystem') {
           control
             .closest('.preference-grid')
-            ?.querySelectorAll('[data-requires-representation]')
+            ?.querySelectorAll('[data-requires-security-system]')
             .forEach((setting) => {
               setting.hidden = !value;
             });
@@ -391,6 +439,7 @@
     const preference = {
       represented: preferences[device.serial]?.represented ?? true,
       audio: preferences[device.serial]?.audio ?? true,
+      securitySystem: preferences[device.serial]?.securitySystem ?? true,
       snapshotMode: preferences[device.serial]?.snapshotMode ?? 'Refresh',
       armingModes: { ...DEFAULT_ARMING_MODES, ...preferences[device.serial]?.armingModes },
     };

package/homebridge-ui/public/js/profile-wizard.js

@@ -9,55 +9,14 @@
     'other',
   ];
 
-  const deviceProfiles = ['device-representation', 'control-state', 'live-media', 'hksv-recording'];
-
   /**
-   * Whether a fault of a given area could be about a given device, per area that can tell.
-   *
-   * A device the fault cannot happen on is not an answer to which ones are affected: offering a HomeBase for a
-   * live view fault invites a report about a stream that device never had. Missing from the list means every
-   * device qualifies, which is what a device missing from HomeKit needs — the ones with no representation at
-   * all are exactly the subject there.
+   * Which screen a session puts on the panel: its file while one can be downloaded, its capture while one runs, and
+   * otherwise the question, since picking an area replaces the session with a capture of that area.
    */
-  const affected = {
-    'control-state': (device) => device.controllable,
-    'live-media': (device) => device.representation.includes('camera.streaming'),
-    'hksv-recording': (device) => device.representation.includes('camera.streaming'),
-  };
-
-  function affectable(profile, devices) {
-    return devices.filter(affected[profile] ?? (() => true));
-  }
-
-  function start() {
-    return { mode: 'tiles', profile: undefined };
-  }
-
-  function select(state, profile) {
-    return { ...state, mode: deviceProfiles.includes(profile) ? 'devices' : 'frequency', profile };
-  }
-
-  function chooseDevices(state, devices) {
-    return { ...state, mode: 'frequency', devices };
-  }
-
-  function reject() {
-    return start();
-  }
-
-  function chooseReproductionMode(state, reproductionMode) {
-    return { ...state, mode: 'match', reproductionMode };
-  }
-
-  function backFromFrequency(state) {
-    return deviceProfiles.includes(state.profile) ? { ...state, mode: 'devices' } : start();
-  }
-
-  function screen(session, startingAnother) {
-    if (session.partialExportAvailable && !startingAnother) return 'review';
-    if (startingAnother || session.status === 'inactive' || session.status === 'expired') return 'choose';
-    if (session.status === 'authorized' || session.status === 'reproducing') return 'reproduce';
-    return 'status';
+  function screen(session) {
+    if (session.partialExportAvailable) return 'review';
+    if (session.status === 'reproducing') return 'reproduce';
+    return 'choose';
   }
 
   function backgroundActive(session) {
@@ -65,16 +24,8 @@
   }
 
   global.HomebridgeEufyDiagnosticsWizard = {
-    affectable,
-    backFromFrequency,
     backgroundActive,
-    chooseDevices,
-    chooseReproductionMode,
-    deviceProfiles,
     profiles,
-    reject,
     screen,
-    select,
-    start,
   };
 })(window);

package/i18n/runtime/en.json

@@ -87,7 +87,7 @@
   "log.notice.stateSubscriberFailed": "A runtime state consumer failed; review Homebridge Eufy health in the dashboard.",
   "log.notice.statusPublicationFailed": "Runtime status could not be published; dashboard status may be stale.",
   "log.notice.channelServeFailed": "Live runtime status could not be served to the plugin settings page; it will show the last published status instead.",
-  "log.notice.diagnosticsAuthorizationArmed": "Diagnostic evidence collection is now active in the plugin runtime.",
+  "log.notice.diagnosticsAuthorizationArmed": "A diagnostics capture started; finish it from the plugin settings before {finishBy}.",
   "log.notice.standDownNotRearmed": "Homebridge Eufy stood down for an authentication and could not take the account session back; restart Homebridge to bring it back.",
   "log.notice.standDownAccountReplaced": "Homebridge Eufy stood down for an authentication that replaced the account; restart Homebridge to use the new account.",
   "log.runtime.authenticationRequired": "Eufy authentication is required",

package/package.json

@@ -1,7 +1,7 @@
 {
   "displayName": "Homebridge Eufy",
   "name": "@homebridge-plugins/homebridge-eufy-security",
-  "version": "5.0.0-beta.15",
+  "version": "5.0.0-beta.17",
   "description": "Control Eufy Security from homebridge.",
   "type": "module",
   "license": "Apache-2.0",