diff --git a/source/_components/utility_meter.markdown b/source/_components/utility_meter.markdown index 17d13b8763b..1f5bbdd8b59 100644 --- a/source/_components/utility_meter.markdown +++ b/source/_components/utility_meter.markdown @@ -46,9 +46,10 @@ cycle: required: true type: string offset: - description: Cycle reset occur at the beginning of the period (0 minutes, 0h00 hours, Monday, day 1, January). This option enables the offsetting of these beginnings. + description: "Cycle reset occur at the beginning of the period (0 minutes, 0h00 hours, Monday, day 1, January). This option enables the offsetting of these beginnings. Supported formats: `offset: 'HH:MM:SS'`, `offset: 'HH:MM'` and Time period dictionary (see example below)." required: false default: 0 + type: time type: integer net_consumption: description: Set this to True if you would like to treat the source as a net meter. This will allow your counter to go both positive and negative. @@ -62,6 +63,16 @@ tariffs: type: list {% endconfiguration %} +### {% linkable_title Time period dictionary example %} + +```yaml +offset: + # At least one of these must be specified: + days: 1 + hours: 0 + minutes: 0 +``` + ## {% linkable_title Services %} ### {% linkable_title Service `utility_meter.reset` %}