Added option for state_class=total sensors (statistic: "state"). Fixes #92, #93

Author: dbuezas

readme.md

@@ -184,8 +184,12 @@ Fetch and plot long-term statistics of an entity
 type: custom:plotly-graph
 entities:
   - entity: sensor.temperature
-    statistic: max # `min`, `mean`, `max` or `sum`
-    period: 5minute # `5minute`, `hour`, `day`, `month`
+    # for entities with state_class=measurement (normal sensors, like temperature):
+    statistic: max # `min`, `mean` of `max`
+    # for entities with state_class=total (such as utility meters):
+    statistic: state # `state` or `sum`
+
+    period: 5minute # `5minute`, `hour`, `day`, `week`, `month`
 ```
 
 Note that `5minute` period statistics are limited in time as normal recorder history is, contrary to other periods which keep data for years.
@@ -424,5 +428,3 @@ Update data every `refresh_interval` seconds. Use `0` or delete the line to disa
 - click on releases/new draft from tag in github
 
 Automated release pending.
-
-

src/plotly-graph-card.ts

@@ -20,6 +20,7 @@ import { sleep } from "./utils";
 import { Datum } from "plotly.js";
 import colorSchemes, { isColorSchemeArray } from "./color-schemes";
 import { parseISO } from "date-fns";
+import { STATISTIC_PERIODS, STATISTIC_TYPES } from "./recorder-types";
 
 const componentName = isProduction ? "plotly-graph" : "plotly-graph-dev";
 
@@ -228,13 +229,9 @@ export class PlotlyGraph extends HTMLElement {
           entity.lambda = window.eval(entity.lambda);
         }
         if ("statistic" in entity || "period" in entity) {
-          const validStatistic = ["mean", "min", "max", "sum"].includes(
-            entity.statistic || ""
-          );
+          const validStatistic = STATISTIC_TYPES.includes(entity.statistic!);
           if (!validStatistic) entity.statistic = "mean";
-          const validPeriod = ["5minute", "hour", "day", "month"].includes(
-            entity.period || ""
-          );
+          const validPeriod = STATISTIC_PERIODS.includes(entity.period!);
           if (!validPeriod) entity.period = "hour";
         }
         const [oldAPI_entity, oldAPI_attribute] = entity.entity.split("::");

src/recorder-types.ts

@@ -14,6 +14,14 @@ export interface StatisticValue {
 export interface Statistics {
   [statisticId: string]: StatisticValue[];
 }
-export type StatisticType = "state" | "sum" | "min" | "max" | "mean";
+export const STATISTIC_TYPES = ["state", "sum", "min", "max", "mean"] as const;
+export type StatisticType = typeof STATISTIC_TYPES[number];
 
-export type StatisticPeriod = "5minute" | "hour" | "day" | "month";
+export const STATISTIC_PERIODS = [
+  "5minute",
+  "hour",
+  "day",
+  "week",
+  "month",
+] as const;
+export type StatisticPeriod = typeof STATISTIC_PERIODS[number];