Skip to content

Commit 3eb0e32

Browse files
committed
lint and fix readme for default value of minimal_response when fetching attributes
1 parent 59c04f9 commit 3eb0e32

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

readme.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -243,14 +243,14 @@ entities:
243243
Note that `5minute` period statistics are limited in time as normal recorder history is, contrary to other periods which keep data for years.
244244

245245
## Offsets
246+
246247
Offsets are useful to shift data in the temporal axis. For example, if you have a sensor that reports the forecasted temperature 3 hours from now, it means that the current value should be plotted in the future. With the `offset` attribute you can shift the data so it is placed in the correct position.
247248
Another possible use is to compare past data with the current one. For example, you can plot yesterday's temperature and the current one on top of each other.
248249

249250
The `offset` flag can be specified in two places.
250251
**1)** When used at the top level of the configuration, it specifies how much "future" the graph shows by default. For example, if `hours_to_show` is 16 and `offset` is 3h, the graph shows the past 13 hours (16-3) plus the next 3 hours.
251252
**2)** When used at the trace level, it offsets the trace by the specified amount.
252253

253-
254254
```yaml
255255
type: custom:plotly-graph
256256
hours_to_show: 16
@@ -279,6 +279,7 @@ entities:
279279
![Graph with offsets](docs/resources/offset-temperature.png)
280280

281281
### Now line
282+
282283
When using offsets, it is useful to have a line that indicates the current time. This can be done by using a lambda function that returns a line with the current time as x value and 0 and 1 as y values. The line is then hidden from the legend.
283284

284285
```yaml
@@ -310,10 +311,11 @@ layout:
310311
![Graph with offsets and now-line](docs/resources/offset-nowline.png)
311312

312313
## Duration
314+
313315
Whenever a time duration can be specified, this is the notation to use:
314316

315317
| Unit | Suffix | Notes |
316-
|--------------|--------|----------|
318+
| ------------ | ------ | -------- |
317319
| Milliseconds | `ms` | |
318320
| Seconds | `s` | |
319321
| Minutes | `m` | |
@@ -324,6 +326,7 @@ Whenever a time duration can be specified, this is the notation to use:
324326
| Years | `y` | 365 days |
325327

326328
Example:
329+
327330
```yaml
328331
offset: 3h
329332
```
@@ -543,7 +546,7 @@ More here: https://developers.home-assistant.io/docs/api/rest/ under `/api/histo
543546

544547
Caveats:
545548

546-
1. This configuration will be ignored (will be true) while fetching [Attribute Values](#Attribute-Values).
549+
1. This configuration will be ignored (will be false) while fetching [Attribute Values](#Attribute-Values).
547550

548551
```yaml
549552
minimal_response: false # defaults to true

0 commit comments

Comments
 (0)