From ffe4c4a56f350512f07bb90f5faec380b7842c6f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Karl=20Kihlstr=C3=B6m?= Date: Thu, 30 May 2019 16:42:15 +0200 Subject: [PATCH] :bookmark: Update docs & version --- README.md | 23 ++++++++++++----------- changelog.md | 37 +++++++++++++++++++++++++++++++++++++ package.json | 2 +- tracker.json | 6 +++--- 4 files changed, 53 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 03d908c..8e23c7e 100755 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ The card works with entities from within the **sensor** domain and displays the ```yaml resources: - - url: /local/mini-graph-card-bundle.js?v=0.4.2 + - url: /local/mini-graph-card-bundle.js?v=0.4.3 type: module ``` @@ -26,14 +26,14 @@ The card works with entities from within the **sensor** domain and displays the 2. Grab `mini-graph-card-bundle.js` ``` - $ wget https://github.com/kalkih/mini-graph-card/releases/download/v0.4.2/mini-graph-card-bundle.js + $ wget https://github.com/kalkih/mini-graph-card/releases/download/v0.4.3/mini-graph-card-bundle.js ``` 3. Add a reference to `mini-graph-card-bundle.js` inside your `ui-lovelace.yaml`. ```yaml resources: - - url: /local/mini-graph-card-bundle.js?v=0.4.2 + - url: /local/mini-graph-card-bundle.js?v=0.4.3 type: module ``` @@ -60,7 +60,7 @@ The card works with entities from within the **sensor** domain and displays the ```yaml resources: - - url: /local/mini-graph-card-bundle.js?v=0.4.2 + - url: /local/mini-graph-card-bundle.js?v=0.4.3 type: module ``` @@ -72,7 +72,7 @@ The card works with entities from within the **sensor** domain and displays the #### Card options | Name | Type | Default | Since | Description | -|------|:----:|:-------:|:-----:|-------------| +|------|------|---------|-------|-------------| | type | string | **required** | v0.0.1 | `custom:mini-graph-card`. | entities | list | **required** | v0.2.0 | One or more sensor entities in a list, see [entities object](#entities-object) for additional entity options. | icon | string | optional | v0.0.1 | Set a custom icon from any of the available mdi icons. @@ -89,6 +89,7 @@ The card works with entities from within the **sensor** domain and displays the | line_width | number | 5 | v0.0.1 | Set the thickness of the line. | line_color | string/list | var(--accent-color) | v0.0.1 | Set a custom color for the graph line, provide a list of colors for multiple graph entries. | color_thresholds | list | optional | v0.2.3 | Set thresholds for dynamic graph colors, see [Line color object](#line-color-object). +| color_thresholds_transition | string | `smooth` | v0.4.3 | Color threshold transition, `smooth` or `hard`. | decimals | integer | optional | v0.0.9 | Specify the exact number of decimals to show for states. | hour24 | boolean | false | v0.2.1 | Set to `true` to display times in 24-hour format. | font_size | number | 100 | v0.0.3 | Adjust the font size of the state, as percentage of the original size. @@ -103,7 +104,7 @@ The card works with entities from within the **sensor** domain and displays the Providing options are optional, entities can be listed directly, see example below. | Name | Type | Default | Description | -|------|:----:|:-------:|:------------| +|------|:----:|:-------:|-------------| | entity | string | **required** | Entity id of the sensor. | name | string | optional | Set a custom display name, defaults to entity's friendly_name. | color | string | optional | Set a custom color, overrides all other color options including thresholds. @@ -124,8 +125,8 @@ entities: #### Available show options All options are optional. -| Name | Default | parameter | Description | -|:----:|:-------:|:---------:|:-----------:| +| Name | Default | Parameter | Description | +|------|:-------:|:---------:|-------------| | name | true | `true` / `false` | Display name | icon | true | `true` / `false` | Display icon | state | true | `true` / `false` | Display current state @@ -142,9 +143,9 @@ All options are optional. See [dynamic line color](#dynamic-line-color) for example usage. | Name | Type | Default | Description | -|------|:----:|:-------:|:------------| -| value | number | **required** | The threshold at where the color should apply if state is above. -| color | string | **required** | Color to apply to line graph, most formats supported (`hex`, `rgb`, `rgba` or just the name of the color etc.) +|------|:----:|:-------:|-------------| +| value | number | **required** | The threshold for the color stop. +| color | string | **required** | Color in 6 digit hex format (e.g. #008080) ### Example usage diff --git a/changelog.md b/changelog.md index eaefed3..904cbc7 100755 --- a/changelog.md +++ b/changelog.md @@ -1,3 +1,40 @@ +## v0.4.3 + +### ADDED +- Color threshold transition option, `color_thresholds_transition` (yeah...very long name) (#91) +- Added hover effect to legend to highlight entity and display current entity state +- Purging of old cached history (#96) - (@bramkragten) + +### CHANGED +- Interpolate fill, name & icon color based on color thresholds +- Redesign of line point hover (#99) +- Moved to localForage for caching (#96) - (@bramkragten) + +### FIXED +- Center state misalignment +- Interpolate color for out of bound thresholds (#91) +- Error when localStorage quota was exceeded (#95, #97) +- Empty graph when color thresholds wasn't being used (#92) +- Invisible graph lines when color thresholds where out of bounds (#91, #92) +- Invalid rendering of color thresholds when lower bound wasn't at zero (#91, #92) + +## v0.4.3-beta2 + +### CHANGED +- Redesign of line point hover (#99) +- Moved to localForage for caching (#96) - (@bramkragten) + +### FIXED +- Interpolate color for out of bound thresholds (#91) +- Error when localStorage quota was exceeded (#95, #97) + +## v0.4.3-beta + +### FIXED +- Empty graph when color thresholds wasn't being used (#92) +- Invisible graph lines when color thresholds where out of bounds (#91, #92) +- Invalid rendering of color thresholds when lower bound wasn't at zero (#91, #92) + ## v0.4.2 ### FIXED diff --git a/package.json b/package.json index 46667cf..2db8700 100755 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "mini-graph-card", - "version": "0.4.2", + "version": "0.4.3", "description": "A minimalistic and customizable graph card for Home Assistant Lovelace UI", "keywords": [ "home-assistant", diff --git a/tracker.json b/tracker.json index 036a528..6f28b75 100755 --- a/tracker.json +++ b/tracker.json @@ -1,8 +1,8 @@ { "mini-graph-card-bundle": { - "updated_at": "2019-05-18", - "version": "0.4.2", - "remote_location": "https://github.com/kalkih/mini-graph-card/releases/download/v0.4.2/mini-graph-card-bundle.js", + "updated_at": "2019-05-30", + "version": "0.4.3", + "remote_location": "https://github.com/kalkih/mini-graph-card/releases/download/v0.4.3/mini-graph-card-bundle.js", "visit_repo": "https://github.com/kalkih/mini-graph-card", "changelog": "https://github.com/kalkih/mini-graph-card/releases/latest" }