mappings for 4 main stat boxes

warmfire540 · warmfire540 · commit 66bd9d6cefcf · 2025-11-14T14:44:39.000-05:00
diff --git a/README.md b/README.md
@@ -254,23 +254,23 @@ If you're unsure what your AdGuard device ID is, here are several ways to find i
 
 ## Configuration Options
 
-| Name               | Type            | Default      | Description                                                        |
-| ------------------ | --------------- | ------------ | ------------------------------------------------------------------ |
-| device_id          | string or array | **Required** | The ID(s) of your AdGuard device(s) in Home Assistant              |
-| title              | string          | AdGuard      | Custom title for the card header                                   |
+| Name               | Type            | Default          | Description                                                        |
+| ------------------ | --------------- | ---------------- | ------------------------------------------------------------------ |
+| device_id          | string or array | **Required**     | The ID(s) of your AdGuard device(s) in Home Assistant              |
+| title              | string          | AdGuard          | Custom title for the card header                                   |
 | icon               | string          | mdi:shield-check | Custom icon for the card header                                    |
-| badge              | object          | _none_       | Configure actions for the card icon/badge                          |
-| pause_durations    | array           | [60,300,900] | Durations for pause buttons (supports numbers, strings with units) |
-| stats              | object          | _none_       | Configure actions for statistics tiles                             |
-| info               | object          | _none_       | Configure actions for additional info items                        |
-| controls           | object          | _none_       | Configure actions for control buttons                              |
-| exclude_sections   | list            | _none_       | Sections of entities to exclude. See below.                        |
-| exclude_entities   | list            | _none_       | Entities to remove from the card.                                  |
-| entity_order       | list            | _none_       | Custom order for switch, button, sensor entities or dividers.      |
-| collapsed_sections | list            | _none_       | Sections to be initially collapsed. See below.                     |
-| switch_spacing     | string          | flex         | Layout style for switches: flex, space-around, space-between       |
-| chart              | object          | _none_       | Chart configuration options. See below.                            |
-| features           | list            | See below    | Optional flags to toggle different features                        |
+| badge              | object          | _none_           | Configure actions for the card icon/badge                          |
+| pause_durations    | array           | [60,300,900]     | Durations for pause buttons (supports numbers, strings with units) |
+| stats              | object          | _none_           | Configure actions for statistics tiles                             |
+| info               | object          | _none_           | Configure actions for additional info items                        |
+| controls           | object          | _none_           | Configure actions for control buttons                              |
+| exclude_sections   | list            | _none_           | Sections of entities to exclude. See below.                        |
+| exclude_entities   | list            | _none_           | Entities to remove from the card.                                  |
+| entity_order       | list            | _none_           | Custom order for switch, button, sensor entities or dividers.      |
+| collapsed_sections | list            | _none_           | Sections to be initially collapsed. See below.                     |
+| switch_spacing     | string          | flex             | Layout style for switches: flex, space-around, space-between       |
+| chart              | object          | _none_           | Chart configuration options. See below.                            |
+| features           | list            | See below        | Optional flags to toggle different features                        |
 
 ### Action Configuration
 
@@ -576,8 +576,8 @@ device_id: adguard_device_1
 switch_spacing: 'space-around'
 entity_order:
   - button.adguard_action_refresh_data
-  - sensor.adguard_dns_queries_today
-  - sensor.adguard_ads_blocked_today
+  - sensor.adguard_dns_queries
+  - sensor.adguard_dns_queries_blocked
   - switch.adguard
 ```
 
@@ -589,8 +589,8 @@ device_id: adguard_device_1
 entity_order:
   - button.adguard_action_refresh_data
   - divider
-  - sensor.adguard_dns_queries_today
-  - sensor.adguard_ads_blocked_today
+  - sensor.adguard_dns_queries
+  - sensor.adguard_dns_queries_blocked
   - divider
   - switch.adguard
 ```
diff --git a/src/common/get-stats.ts b/src/common/get-stats.ts
@@ -10,7 +10,7 @@ export const getDashboardStats = (
 ): DashboardStatConfig[][] => [
   [
     {
-      sensorKey: 'dns_queries_today',
+      sensorKey: 'dns_queries',
       title: 'card.stats.total_queries',
       footer: {
         key: 'card.stats.active_clients',
@@ -21,7 +21,7 @@ export const getDashboardStats = (
       icon: 'mdi:earth',
     },
     {
-      sensorKey: 'ads_blocked_today',
+      sensorKey: 'dns_queries_blocked',
       title: 'card.stats.queries_blocked',
       footer: 'card.stats.list_blocked_queries',
       className: 'blocked-box',
@@ -30,18 +30,18 @@ export const getDashboardStats = (
   ],
   [
     {
-      sensorKey: 'ads_percentage_blocked_today',
+      sensorKey: 'dns_queries_blocked_ratio',
       title: 'card.stats.percentage_blocked',
       footer: 'card.stats.list_all_queries',
       className: 'percentage-box',
       icon: 'mdi:chart-pie',
     },
     {
-      sensorKey: 'domains_blocked',
-      title: 'card.stats.domains_on_lists',
-      footer: 'card.stats.manage_lists',
+      sensorKey: 'average_processing_speed',
+      title: 'card.stats.average_processing_speed',
+      footer: 'card.stats.processing_speed_info',
       className: 'domains-box',
-      icon: 'mdi:format-list-bulleted',
+      icon: 'mdi:speedometer',
     },
   ],
 ];
diff --git a/src/common/map-entities.ts b/src/common/map-entities.ts
@@ -1,4 +1,4 @@
-import type { EntityInformation, AdGuardDevice } from '@type/types';
+import type { AdGuardDevice, EntityInformation } from '@type/types';
 
 /**
  * Maps entities to the AdGuard device object based on their translation keys.
@@ -11,10 +11,12 @@ export const mapEntitiesByTranslationKey = (
   device: AdGuardDevice,
 ) => {
   const keyToPropertyMap = {
-    dns_queries_today: 'dns_queries_today',
-    domains_blocked: 'domains_blocked',
-    ads_percentage_blocked_today: 'ads_percentage_blocked_today',
-    ads_blocked_today: 'ads_blocked_today',
+    dns_queries: 'dns_queries',
+    dns_queries_blocked: 'dns_queries_blocked',
+    dns_queries_blocked_ratio: 'dns_queries_blocked_ratio',
+    average_processing_speed: 'average_processing_speed',
+
+    // not vetted yet
     dns_unique_clients: 'dns_unique_clients',
     remaining_until_blocking_mode: 'remaining_until_blocking_mode',
     action_refresh_data: 'action_refresh_data',
@@ -24,11 +26,11 @@ export const mapEntitiesByTranslationKey = (
     action_ftl_purge_diagnosis_messages: 'purge_diagnosis_messages',
 
     // backwards compatibility for HA integration
-    dns_queries: 'dns_queries_today',
-    ads_blocked: 'ads_blocked_today',
-    percent_ads_blocked: 'ads_percentage_blocked_today',
-    ads_percentage_today: 'ads_percentage_blocked_today',
-    domains_being_blocked: 'domains_blocked',
+    // dns_queries: 'dns_queries',
+    // ads_blocked: 'dns_queries_blocked',
+    // percent_ads_blocked: 'dns_queries_blocked_ratio',
+    // ads_percentage_today: 'dns_queries_blocked_ratio',
+    // domains_being_blocked: 'domains_blocked',
   };
 
   const key = entity.translation_key;
diff --git a/src/translations/bg.json b/src/translations/bg.json
@@ -7,8 +7,8 @@
       "list_blocked_queries": "Списък с блокирани заявки",
       "percentage_blocked": "Процент блокирани",
       "list_all_queries": "Списък с всички заявки",
-      "domains_on_lists": "Списък с домейни",
-      "manage_lists": "Управление на списъци"
+      "average_processing_speed": "Средна Скорост на Обработка",
+      "processing_speed_info": "Средно време за обработка на заявки"
     },
     "sections": {
       "pause": "Пауза на блокирането на реклами",
diff --git a/src/translations/de.json b/src/translations/de.json
@@ -7,8 +7,8 @@
       "list_blocked_queries": "Blockierte Anfragen anzeigen",
       "percentage_blocked": "Prozentual blockiert",
       "list_all_queries": "Alle Anfragen anzeigen",
-      "domains_on_lists": "Domains auf Listen",
-      "manage_lists": "Listen verwalten"
+      "average_processing_speed": "Durchschnittliche Verarbeitungsgeschwindigkeit",
+      "processing_speed_info": "Durchschnittliche Abfrageverarbeitungszeit"
     },
     "sections": {
       "pause": "Werbeblockierung pausieren",
diff --git a/src/translations/el.json b/src/translations/el.json
@@ -7,8 +7,8 @@
       "list_blocked_queries": "Λίστα αποκλεισμένων ερωτημάτων",
       "percentage_blocked": "Ποσοστό που αποκλείστηκε",
       "list_all_queries": "Λίστα όλων των ερωτημάτων",
-      "domains_on_lists": "Τομείς στις Λίστες",
-      "manage_lists": "Διαχείριση Λιστών"
+      "average_processing_speed": "Μέση Ταχύτητα Επεξεργασίας",
+      "processing_speed_info": "Μέσος χρόνος επεξεργασίας ερωτημάτων"
     },
     "sections": {
       "pause": "Παύση Αποκλεισμού Διαφημίσεων",
diff --git a/src/translations/en.json b/src/translations/en.json
@@ -7,8 +7,8 @@
       "list_blocked_queries": "List blocked queries",
       "percentage_blocked": "Percentage Blocked",
       "list_all_queries": "List all queries",
-      "domains_on_lists": "Domains on Lists",
-      "manage_lists": "Manage lists"
+      "average_processing_speed": "Average Processing Speed",
+      "processing_speed_info": "Average query processing time"
     },
     "sections": {
       "pause": "Pause Ad-Blocking",
diff --git a/src/translations/es.json b/src/translations/es.json
@@ -7,8 +7,8 @@
       "list_blocked_queries": "Listar peticiones bloqueadas",
       "percentage_blocked": "Porcentaje bloqueos",
       "list_all_queries": "Listar todas las peticiones",
-      "domains_on_lists": "Dominios bloqueados",
-      "manage_lists": "Gestionar listas"
+      "average_processing_speed": "Velocidad de Procesamiento Promedio",
+      "processing_speed_info": "Tiempo promedio de procesamiento de consultas"
     },
     "sections": {
       "pause": "Pausar Bloqueo de Anuncios",
diff --git a/src/translations/fr.json b/src/translations/fr.json
@@ -7,8 +7,8 @@
       "list_blocked_queries": "Liste des requêtes bloquées",
       "percentage_blocked": "Pourcentage bloqué",
       "list_all_queries": "Liste de toutes les requêtes",
-      "domains_on_lists": "Domaines listés",
-      "manage_lists": "Gérer les listes"
+      "average_processing_speed": "Vitesse de Traitement Moyenne",
+      "processing_speed_info": "Temps moyen de traitement des requêtes"
     },
     "sections": {
       "pause": "Pause du bloqueur de pubs",
diff --git a/src/translations/it.json b/src/translations/it.json
@@ -7,8 +7,8 @@
       "list_blocked_queries": "Elenco richieste bloccate",
       "percentage_blocked": "Percentuale bloccate",
       "list_all_queries": "Elenca tutte le richieste",
-      "domains_on_lists": "Domini in elenco",
-      "manage_lists": "Gestisci le liste"
+      "average_processing_speed": "Velocità di Elaborazione Media",
+      "processing_speed_info": "Tempo medio di elaborazione delle richieste"
     },
     "sections": {
       "pause": "Metti in pausa gli Ad-Blocking",
diff --git a/src/types/locale.ts b/src/types/locale.ts
@@ -8,8 +8,8 @@ export type TranslationKey =
   | 'card.stats.list_blocked_queries'
   | 'card.stats.percentage_blocked'
   | 'card.stats.list_all_queries'
-  | 'card.stats.domains_on_lists'
-  | 'card.stats.manage_lists'
+  | 'card.stats.average_processing_speed'
+  | 'card.stats.processing_speed_info'
   | 'card.sections.pause'
   | 'card.sections.switches'
   | 'card.sections.actions'
diff --git a/src/types/types.ts b/src/types/types.ts
@@ -8,16 +8,16 @@ export interface AdGuardDevice {
   device_id: string;
 
   /** Total DNS Queries */
-  dns_queries_today?: EntityInformation;
+  dns_queries?: EntityInformation;
 
-  /** Total Domains Blocked */
-  domains_blocked?: EntityInformation;
+  /** Average Processing Speed */
+  average_processing_speed?: EntityInformation;
 
   /** Percentage of Ads Blocked Today */
-  ads_percentage_blocked_today?: EntityInformation;
+  dns_queries_blocked_ratio?: EntityInformation;
 
   /** Total Ads Blocked Today */
-  ads_blocked_today?: EntityInformation;
+  dns_queries_blocked?: EntityInformation;
 
   /** Total Unique Clients Queried */
   dns_unique_clients?: EntityInformation;
diff --git a/test/cards/card.spec.ts b/test/cards/card.spec.ts
@@ -47,11 +47,11 @@ describe('AdGuardCard', () => {
         attributes: {},
         translation_key: undefined,
       },
-      dns_queries_today: {
-        entity_id: 'sensor.dns_queries_today',
+      dns_queries: {
+        entity_id: 'sensor.dns_queries',
         state: '12345',
         attributes: {},
-        translation_key: 'dns_queries_today',
+        translation_key: 'dns_queries',
       },
     } as any as AdGuardDevice;
 
diff --git a/test/common/get-stats.spec.ts b/test/common/get-stats.spec.ts
@@ -19,7 +19,7 @@ describe('dashboard-stats.ts', () => {
 
       // Check first row, first stat
       expect(result[0]![0]).to.deep.include({
-        sensorKey: 'dns_queries_today',
+        sensorKey: 'dns_queries',
         title: 'card.stats.total_queries',
         className: 'queries-box',
         icon: 'mdi:earth',
@@ -32,11 +32,11 @@ describe('dashboard-stats.ts', () => {
 
       // Check second row, second stat
       expect(result[1]![1]).to.deep.include({
-        sensorKey: 'domains_blocked',
-        title: 'card.stats.domains_on_lists',
-        footer: 'card.stats.manage_lists',
+        sensorKey: 'average_processing_speed',
+        title: 'card.stats.average_processing_speed',
+        footer: 'card.stats.processing_speed_info',
         className: 'domains-box',
-        icon: 'mdi:format-list-bulleted',
+        icon: 'mdi:speedometer',
       });
     });
 
diff --git a/test/common/map-entities.spec.ts b/test/common/map-entities.spec.ts
@@ -1,5 +1,5 @@
 import { mapEntitiesByTranslationKey } from '@common/map-entities';
-import type { EntityInformation, AdGuardDevice } from '@type/types';
+import type { AdGuardDevice, EntityInformation } from '@type/types';
 import { expect } from 'chai';
 
 describe('map-entities.ts', () => {
@@ -20,18 +20,18 @@ describe('map-entities.ts', () => {
     it('should map entity with known translation key to correct device property', () => {
       // Create test entity with a known translation key
       const entity: EntityInformation = {
-        entity_id: 'sensor.dns_queries_today',
+        entity_id: 'sensor.dns_queries',
         state: '1234',
         attributes: { friendly_name: 'DNS Queries Today' },
-        translation_key: 'dns_queries_today',
+        translation_key: 'dns_queries',
       };
 
       // Map the entity to the device
       const result = mapEntitiesByTranslationKey(entity, device);
 
       // Check that the mapping was successful
       expect(result).to.be.true;
-      expect(device.dns_queries_today).to.equal(entity);
+      expect(device.dns_queries).to.equal(entity);
     });
 
     it('should map action_ftl_purge_diagnosis_messages to purge_diagnosis_messages property', () => {
@@ -54,13 +54,13 @@ describe('map-entities.ts', () => {
     it('should map all supported translation keys correctly', () => {
       // Define all supported translation keys and their corresponding property names
       const supportedKeys = [
-        { key: 'dns_queries_today', prop: 'dns_queries_today' },
-        { key: 'domains_blocked', prop: 'domains_blocked' },
+        { key: 'dns_queries', prop: 'dns_queries' },
+        { key: 'average_processing_speed', prop: 'average_processing_speed' },
         {
-          key: 'ads_percentage_blocked_today',
-          prop: 'ads_percentage_blocked_today',
+          key: 'dns_queries_blocked_ratio',
+          prop: 'dns_queries_blocked_ratio',
         },
-        { key: 'ads_blocked_today', prop: 'ads_blocked_today' },
+        { key: 'dns_queries_blocked', prop: 'dns_queries_blocked' },
         { key: 'dns_unique_clients', prop: 'dns_unique_clients' },
         {
           key: 'remaining_until_blocking_mode',
@@ -129,30 +129,28 @@ describe('map-entities.ts', () => {
 
     it('should not modify other properties of the device object', () => {
       // Set up a device with some existing properties
-      device.dns_queries_today = {
+      device.dns_queries = {
         entity_id: 'sensor.existing_queries',
         state: '5000',
         attributes: { friendly_name: 'Existing Queries' },
-        translation_key: 'dns_queries_today',
+        translation_key: 'dns_queries',
       };
 
       // Create test entity with a different translation key
       const entity: EntityInformation = {
-        entity_id: 'sensor.domains_blocked',
-        state: '50000',
-        attributes: { friendly_name: 'Domains Blocked' },
-        translation_key: 'domains_blocked',
+        entity_id: 'sensor.average_processing_speed',
+        state: '12.5',
+        attributes: { friendly_name: 'Average Processing Speed' },
+        translation_key: 'average_processing_speed',
       };
 
       // Map the new entity to the device
       mapEntitiesByTranslationKey(entity, device);
 
       // Check that the existing property wasn't modified
-      expect(device.dns_queries_today.entity_id).to.equal(
-        'sensor.existing_queries',
-      );
+      expect(device.dns_queries.entity_id).to.equal('sensor.existing_queries');
       // Check that the new property was added
-      expect(device.domains_blocked).to.equal(entity);
+      expect(device.average_processing_speed).to.equal(entity);
     });
   });
 });
diff --git a/test/delegates/utils/card-entities.spec.ts b/test/delegates/utils/card-entities.spec.ts
diff --git a/test/delegates/utils/get-adguard.spec.ts b/test/delegates/utils/get-adguard.spec.ts
diff --git a/test/html/components/is-graph-sensor.spec.ts b/test/html/components/is-graph-sensor.spec.ts
diff --git a/test/html/components/stat-box.spec.ts b/test/html/components/stat-box.spec.ts
diff --git a/test/html/pi-fillings.spec.ts b/test/html/pi-fillings.spec.ts
diff --git a/test/localize/localize.spec.ts b/test/localize/localize.spec.ts
