Skip to content

Commit

Permalink
docs: update docs on external data type
Browse files Browse the repository at this point in the history
  • Loading branch information
jvandenaardweg committed Jan 13, 2023
1 parent 9c42fb6 commit e870827
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -95,15 +95,15 @@ export interface BasicInformationResponse {
* @link: https://homewizard-energy-api.readthedocs.io/endpoints.html#external-datapoint
*/
export interface ExternalData {
/** The unique identifier from the smart meter. Available for: `HWE-P1` */
/** The unique identifier from the smart meter.` */
unique_id?: string;
/** The type of the device, can be gas_meter heat_meter warm_water_meter water_meter or inlet_heat_meter. Available for: `HWE-P1` */
/** The type of the device, can be `"gas_meter"`, `"heat_meter"`, `"warm_water_meter"`, `"water_meter"` or `"inlet_heat_meter"`. */
type?: 'gas_meter' | 'heat_meter' | 'warm_water_meter' | 'water_meter' | 'inlet_heat_meter';
/** The most recent value update time stamp structured as YYMMDDhhmmss. */
timestamp?: number;
/** The raw value */
value?: number;
/** The unit of the value, for example: “m3” or “GJ” */
/** The unit of the value, for example: `“m3”` or `“GJ”` */
unit?: string;
}

Expand Down

0 comments on commit e870827

Please sign in to comment.