From c2f0e8607f314a7298a89a283351700f53b39c25 Mon Sep 17 00:00:00 2001 From: semantic-release-bot Date: Tue, 2 Feb 2021 22:25:51 +0000 Subject: [PATCH] chore(release): 1.4.0 [skip ci] ## [1.4.0](https://github.com/RomRider/apexcharts-card/compare/v1.3.0...v1.4.0) (2021-02-02) ### Features * **series:** Show/Hide a specific serie from the header or the graph ([#36](https://github.com/RomRider/apexcharts-card/issues/36)) ([95c0433](https://github.com/RomRider/apexcharts-card/commit/95c0433833c197d32914ed11260b4dd08885d9f4)) * Support for auto-entities ([060e4c0](https://github.com/RomRider/apexcharts-card/commit/060e4c0f7cdfebb72055d83dada4129a0f699f3c)) * **editor:** Preview in the GUI card selector ([d4cd7a3](https://github.com/RomRider/apexcharts-card/commit/d4cd7a3a28ab9d29300772dbe22331857a3a1efc)) * **graph:** New chart types `scatter`, `donut`, `pie` and `radialBar` ([#24](https://github.com/RomRider/apexcharts-card/issues/24)) ([a0e4f85](https://github.com/RomRider/apexcharts-card/commit/a0e4f8536593dc6f67f7439d77be367af74de736)) * **group_by:** Add new `diff` function ([57fd6a6](https://github.com/RomRider/apexcharts-card/commit/57fd6a640aaee223adaa174ad5d1fb82f496a878)) * **series:** Retrieve an attribute of your entity instead of the state ([#32](https://github.com/RomRider/apexcharts-card/issues/32)) ([b76bf16](https://github.com/RomRider/apexcharts-card/commit/b76bf16e9f3d4dc8c28767d552139de3aa033fa7)), closes [#29](https://github.com/RomRider/apexcharts-card/issues/29) ### Bug Fixes * `group_by` was extending values into the future ([2cb79d2](https://github.com/RomRider/apexcharts-card/commit/2cb79d2bc9f341fff1f03a61c334fd9212e2e4c7)) * Graph stopped updating following ddf6ca9 ([bc54729](https://github.com/RomRider/apexcharts-card/commit/bc547290301e1a5b09725589eaf95a640bdb5752)) * Sometimes card would stay in warning mode ([ddf6ca9](https://github.com/RomRider/apexcharts-card/commit/ddf6ca9105062a8591ba1e9ab702abb01e689592)) * Tooltip should not be in a fixed position ([1762049](https://github.com/RomRider/apexcharts-card/commit/176204901d501bbcee8b328a003770df8d752587)) * **func:** Filter `null` values in `diff` ([cfe736c](https://github.com/RomRider/apexcharts-card/commit/cfe736ccf6ef071b7dfe4ae90804a919c12cb984)) * **header:** Hide unit when `as_duration` is used ([5686931](https://github.com/RomRider/apexcharts-card/commit/56869316476d7d64abb6045e1d40e854300c0836)) * **header:** State was sometimes multi-line ([4187104](https://github.com/RomRider/apexcharts-card/commit/4187104a04bfb2acbf600abfb84bf9bd264d7ccb)) ### Documentation * Add an example to change the line thickness ([fd4a495](https://github.com/RomRider/apexcharts-card/commit/fd4a49542ea2fc7ebee10969c73bcbe26c73b68a)) * Add more example ([ffaa5df](https://github.com/RomRider/apexcharts-card/commit/ffaa5df44fb009b881ba6af8d4d73ec9e7562c26)) * Fix error `data_generator` example ([6d1c7a0](https://github.com/RomRider/apexcharts-card/commit/6d1c7a0d53a74a081b4900f1aa5c7c26b8159945)), closes [#34](https://github.com/RomRider/apexcharts-card/issues/34) * Fix some typos ([3df6aed](https://github.com/RomRider/apexcharts-card/commit/3df6aed4769b8b0b927f961083f7aa16521ddf58)) * Missing `title` documentation in the header section ([ff7f35b](https://github.com/RomRider/apexcharts-card/commit/ff7f35b0b341305600bd0ac9baa86cfec737d20f)) --- CHANGELOG.md | 32 ++++++++++++++++++++++++++++++++ README.md | 26 +++++++++++++------------- package-lock.json | 2 +- package.json | 2 +- 4 files changed, 47 insertions(+), 15 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6674f67..8525aa4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,35 @@ +## [1.4.0](https://github.com/RomRider/apexcharts-card/compare/v1.3.0...v1.4.0) (2021-02-02) + + +### Features + +* **series:** Show/Hide a specific serie from the header or the graph ([#36](https://github.com/RomRider/apexcharts-card/issues/36)) ([95c0433](https://github.com/RomRider/apexcharts-card/commit/95c0433833c197d32914ed11260b4dd08885d9f4)) +* Support for auto-entities ([060e4c0](https://github.com/RomRider/apexcharts-card/commit/060e4c0f7cdfebb72055d83dada4129a0f699f3c)) +* **editor:** Preview in the GUI card selector ([d4cd7a3](https://github.com/RomRider/apexcharts-card/commit/d4cd7a3a28ab9d29300772dbe22331857a3a1efc)) +* **graph:** New chart types `scatter`, `donut`, `pie` and `radialBar` ([#24](https://github.com/RomRider/apexcharts-card/issues/24)) ([a0e4f85](https://github.com/RomRider/apexcharts-card/commit/a0e4f8536593dc6f67f7439d77be367af74de736)) +* **group_by:** Add new `diff` function ([57fd6a6](https://github.com/RomRider/apexcharts-card/commit/57fd6a640aaee223adaa174ad5d1fb82f496a878)) +* **series:** Retrieve an attribute of your entity instead of the state ([#32](https://github.com/RomRider/apexcharts-card/issues/32)) ([b76bf16](https://github.com/RomRider/apexcharts-card/commit/b76bf16e9f3d4dc8c28767d552139de3aa033fa7)), closes [#29](https://github.com/RomRider/apexcharts-card/issues/29) + + +### Bug Fixes + +* `group_by` was extending values into the future ([2cb79d2](https://github.com/RomRider/apexcharts-card/commit/2cb79d2bc9f341fff1f03a61c334fd9212e2e4c7)) +* Graph stopped updating following ddf6ca9 ([bc54729](https://github.com/RomRider/apexcharts-card/commit/bc547290301e1a5b09725589eaf95a640bdb5752)) +* Sometimes card would stay in warning mode ([ddf6ca9](https://github.com/RomRider/apexcharts-card/commit/ddf6ca9105062a8591ba1e9ab702abb01e689592)) +* Tooltip should not be in a fixed position ([1762049](https://github.com/RomRider/apexcharts-card/commit/176204901d501bbcee8b328a003770df8d752587)) +* **func:** Filter `null` values in `diff` ([cfe736c](https://github.com/RomRider/apexcharts-card/commit/cfe736ccf6ef071b7dfe4ae90804a919c12cb984)) +* **header:** Hide unit when `as_duration` is used ([5686931](https://github.com/RomRider/apexcharts-card/commit/56869316476d7d64abb6045e1d40e854300c0836)) +* **header:** State was sometimes multi-line ([4187104](https://github.com/RomRider/apexcharts-card/commit/4187104a04bfb2acbf600abfb84bf9bd264d7ccb)) + + +### Documentation + +* Add an example to change the line thickness ([fd4a495](https://github.com/RomRider/apexcharts-card/commit/fd4a49542ea2fc7ebee10969c73bcbe26c73b68a)) +* Add more example ([ffaa5df](https://github.com/RomRider/apexcharts-card/commit/ffaa5df44fb009b881ba6af8d4d73ec9e7562c26)) +* Fix error `data_generator` example ([6d1c7a0](https://github.com/RomRider/apexcharts-card/commit/6d1c7a0d53a74a081b4900f1aa5c7c26b8159945)), closes [#34](https://github.com/RomRider/apexcharts-card/issues/34) +* Fix some typos ([3df6aed](https://github.com/RomRider/apexcharts-card/commit/3df6aed4769b8b0b927f961083f7aa16521ddf58)) +* Missing `title` documentation in the header section ([ff7f35b](https://github.com/RomRider/apexcharts-card/commit/ff7f35b0b341305600bd0ac9baa86cfec737d20f)) + ## [1.4.0-dev.6](https://github.com/RomRider/apexcharts-card/compare/v1.4.0-dev.5...v1.4.0-dev.6) (2021-02-02) diff --git a/README.md b/README.md index 111b5d5..8503c8f 100644 --- a/README.md +++ b/README.md @@ -70,7 +70,7 @@ This card is available in [HACS](https://hacs.xyz/) (Home Assistant Community St 2. Grab `apexcharts-card.js`: ``` -$ wget https://github.com/RomRider/apexcharts-card/releases/download/v1.3.0/apexcharts-card.js +$ wget https://github.com/RomRider/apexcharts-card/releases/download/v1.4.0/apexcharts-card.js ``` 3. Add the resource reference as decribed below. @@ -81,7 +81,7 @@ If you configure Lovelace via YAML, add a reference to `apexcharts-card.js` insi ```yaml resources: - - url: /local/apexcharts-card.js?v=1.3.0 + - url: /local/apexcharts-card.js?v=1.4.0 type: module ``` @@ -107,9 +107,9 @@ The card stricly validates all the options available (but not for the `apex_conf | ---- | :--: | :-----: | :---: | ----------- | | :white_check_mark: `type` | string | | v1.0.0 | `custom:apexcharts-card` | | :white_check_mark: `series` | array | | v1.0.0 | See [series](#series-options) | -| `chart_type` | string | `line` | NEXT_VERSION | See [chart_type](#chart_type-options) | +| `chart_type` | string | `line` | v1.4.0 | See [chart_type](#chart_type-options) | | `update_interval` | string | | v1.1.0 | By default the card updates on every state change. Setting this overrides the behaviour. Valid values are any time string, eg: `1h`, `12min`, `1d`, `1h25`, `10sec`, ... | -| `update_delay` | string | `1500ms` | NEXT_VERSION | If the chart doesn't display the last state but the one before, you'll want to increase this value, don't go over `10s`, it's not necessary. You'll also want to increase this value if you are using `attribute` in the `series`. Valid values are any time strings. This is because of how Home-Assistant works with history, see [here](https://www.home-assistant.io/integrations/recorder/#commit_interval) | +| `update_delay` | string | `1500ms` | v1.4.0 | If the chart doesn't display the last state but the one before, you'll want to increase this value, don't go over `10s`, it's not necessary. You'll also want to increase this value if you are using `attribute` in the `series`. Valid values are any time strings. This is because of how Home-Assistant works with history, see [here](https://www.home-assistant.io/integrations/recorder/#commit_interval) | | `graph_span` | string | `24h` | v1.1.0 | The span of the graph as a time interval. Valid values are any time string, eg: `1h`, `12min`, `1d`, `1h25`, `10sec`, ... | | `span` | object | | v1.2.0 | See [span](#span-options) | | `show` | object | | v1.0.0 | See [show](#main-show-options) | @@ -127,7 +127,7 @@ The card stricly validates all the options available (but not for the `apex_conf | Name | Type | Default | Since | Description | | ---- | :--: | :-----: | :---: | ----------- | | :white_check_mark: `entity` | string | | v1.0.0 | The `entity_id` of the sensor to display | -| `attribute` | string | | NEXT_VERSION | Instead of retrieving the state, it will retrieve an `attribute` of the entity. Make sure you increase `update_delay` if the chart doesn't reflect the last value of the attribute | +| `attribute` | string | | v1.4.0 | Instead of retrieving the state, it will retrieve an `attribute` of the entity. Make sure you increase `update_delay` if the chart doesn't reflect the last value of the attribute | | `name` | string | | v1.0.0 | Override the name of the entity | | `color` | string | | v1.1.0 | Color of the serie. Supported formats: `yellow`, `#aabbcc`, `rgb(128, 128, 128)` or `var(--css-color-variable)` | | `type` | string | `line` | v1.0.0 | `line`, `area` or `column` are supported for now | @@ -139,8 +139,8 @@ The card stricly validates all the options available (but not for the `apex_conf | `invert` | boolean | `false` | v1.2.0 | Negates the data (`1` -> `-1`). Usefull to display opposites values like network in (standard)/out (inverted) | | `data_generator` | string | | v1.2.0 | See [data_generator](#data_generator-option) | | `offset` | string | | v1.3.0 | This is different from the main `offset` parameter. This is at the series level. It is only usefull if you want to display data from for eg. yesterday on top of the data from today for the same sensor and compare the data. The time displayed in the tooltip will be wrong as will the x axis information. Valid values are any negative time string, eg: `-1h`, `-12min`, `-1d`, `-1h25`, `-10sec`, ... | -| `min` | number | `0` | NEXT_VERSION | Only used when `chart_type = radialBar`, see [chart_type](#chart_type-options). Used to convert the value into a percentage. Minimum value of the sensor | -| `max` | number | `100` | NEXT_VERSION | Only used when `chart_type = radialBar`, see [chart_type](#chart_type-options). Used to convert the value into a percentage. Maximum value of the sensor | +| `min` | number | `0` | v1.4.0 | Only used when `chart_type = radialBar`, see [chart_type](#chart_type-options). Used to convert the value into a percentage. Minimum value of the sensor | +| `max` | number | `100` | v1.4.0 | Only used when `chart_type = radialBar`, see [chart_type](#chart_type-options). Used to convert the value into a percentage. Maximum value of the sensor | ### `series.show` Options @@ -148,8 +148,8 @@ The card stricly validates all the options available (but not for the `apex_conf | ---- | :--: | :-----: | :---: | ----------- | | `legend_value` | boolean | `true` | v1.3.0 | Show/Hide the state in the legend. Will still display the name | | `as_duration` | string | | v1.3.0 | Will pretty print the states as durations. Doesn't affect the graph, only the tooltip/legend/header display. You provide the source unit of your sensor. Valid values are `millisecond`, `second`, `minute`, `hour`, `day`, `week`, `month`, `year`.
Eg: if the state is `345` and `as_duration` is set to `minute` then it would display `5h 45m` | -| `in_header` | boolean | `true` | NEXT_VERSION | If `show_states` is enabled, this would show/hide this specific serie in the header | -| `in_chart` | boolean | `true` | NEXT_VERSION | If `false`, hides the serie from the chart | +| `in_header` | boolean | `true` | v1.4.0 | If `show_states` is enabled, this would show/hide this specific serie in the header | +| `in_chart` | boolean | `true` | v1.4.0 | If `false`, hides the serie from the chart | ### Main `show` Options @@ -196,10 +196,10 @@ The card stricly validates all the options available (but not for the `apex_conf | Name | Since | Description | | ---- | :---: | ----------- | | `line` | v1.0.0 | This is the default and will show a timeline. It is compatible with `series.type` = `column`, `line` and `area` | -| `scatter` | NEXT_VERSION | Displays a cloud of points without a line between the values | -| `pie` | NEXT_VERSION | This will display a pie chart with the last value computed of each sensor | -| `donut` | NEXT_VERSION | This will display a donut chart with the last value computed of each sensor, same as pie but with a hole in the center | -| `radialBar` | NEXT_VERSION | This will display a radial bar chart with the last value computed of each sensor. The value is represented in percentage only. It is required to provide `min` and `max` for each series displayed as it requires to convert the value into percentage. The default value for `min` is `0` and for `max` it is `100`. This graph works well if you want to display sensors natively in percentages | +| `scatter` | v1.4.0 | Displays a cloud of points without a line between the values | +| `pie` | v1.4.0 | This will display a pie chart with the last value computed of each sensor | +| `donut` | v1.4.0 | This will display a donut chart with the last value computed of each sensor, same as pie but with a hole in the center | +| `radialBar` | v1.4.0 | This will display a radial bar chart with the last value computed of each sensor. The value is represented in percentage only. It is required to provide `min` and `max` for each series displayed as it requires to convert the value into percentage. The default value for `min` is `0` and for `max` it is `100`. This graph works well if you want to display sensors natively in percentages | ![Charts Type](docs/charts_type.png) diff --git a/package-lock.json b/package-lock.json index 2a055f3..a5a57ce 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "apexcharts-card", - "version": "1.4.0-dev.6", + "version": "1.4.0", "lockfileVersion": 2, "requires": true, "packages": { diff --git a/package.json b/package.json index 170b0de..66061105 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "apexcharts-card", - "version": "1.4.0-dev.6", + "version": "1.4.0", "description": "A Home Assistant Lovelace card using ApexCharts to render graphs", "main": "src/apexcharts-card.ts", "scripts": {