Interface ReportSurface

The chart reads every device-level report target answers, on either dialect — the surface a consumer can rely on without branching on the backing API.

interface ReportSurface {
    getEnergyReport: (
        query?: ReportQuery,
    ) => Promise<Result<ReportChartLineOptions>>;
    getSignalStrength: (hour?: Hour) => Promise<Result<ReportChartLineOptions>>;
    getTemperatures: (
        query?: ReportQuery,
    ) => Promise<Result<ReportChartLineOptions>>;
}

Hierarchy (View Summary)

EnergyReportTarget
SignalStrengthReportTarget
TemperaturesReportTarget
- ReportSurface
  - FullReportSurface

Index

Properties

getEnergyReport getSignalStrength getTemperatures

Properties

`Readonly`getEnergyReport

getEnergyReport: (
query?: ReportQuery,
) => Promise<Result<ReportChartLineOptions>>

Fetch the energy report as line chart data (kWh buckets).

`Readonly`getSignalStrength

getSignalStrength: (hour?: Hour) => Promise<Result<ReportChartLineOptions>>

Fetch the Wi-Fi signal strength report as line chart data (dBm).

`Readonly`getTemperatures

getTemperatures: (
query?: ReportQuery,
) => Promise<Result<ReportChartLineOptions>>

Fetch the temperature history as line chart data (°C).