diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..f2b976f --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,30 @@ +# 1.0.0 (2021-01-25) + + +### Bug Fixes + +* 1st color was not using transparency ([77a9c8d](https://github.com/RomRider/apexcharts-card/commit/77a9c8d0ac37039816d516bd2305b7c942a3fcc1)) +* **legend:** Change ` - ` to `: ` between name and state ([4e3cdc6](https://github.com/RomRider/apexcharts-card/commit/4e3cdc6776349f171fc1d0b043f6e48371773569)) +* Last computed history data shouldn't be null ([ec875d5](https://github.com/RomRider/apexcharts-card/commit/ec875d52ea7e07eddfa37d243e983d6dc1b2513c)) +* **axis:** X and Y Axis Tooltip color matches theme ([fb717ef](https://github.com/RomRider/apexcharts-card/commit/fb717ef012c18fe50703eae4c4f6ee1350fbaddb)) +* **build:** Missing dependancy ([7d7d637](https://github.com/RomRider/apexcharts-card/commit/7d7d637325e20f578de44da69f83b30d703e62ca)) +* **build:** Remove comments from build ([268ef77](https://github.com/RomRider/apexcharts-card/commit/268ef77467295d0263373235a9d59c3704edc059)) +* **graph:** Loading message didn't appear ([ce3c45c](https://github.com/RomRider/apexcharts-card/commit/ce3c45cc58f50ae2b2a8365842e492db56155173)) +* **graph:** Not displaying the latest state in graph ([280e328](https://github.com/RomRider/apexcharts-card/commit/280e3281871652c1bafcfefcc820d1b89694cc04)) +* **tooltip:** Use colors from the theme ([5c263f1](https://github.com/RomRider/apexcharts-card/commit/5c263f1851518303d9751d66d9db1812485bc62f)) + + +### Features + +* Add delta and median function ([4a77e55](https://github.com/RomRider/apexcharts-card/commit/4a77e55a8ff0adba7cc7cf3d8d5263448ab94580)) +* Better cache handling ([#1](https://github.com/RomRider/apexcharts-card/issues/1)) ([804415f](https://github.com/RomRider/apexcharts-card/commit/804415f295e015e35c6fcc070e0766a988cf446b)) +* **group_by:** Add more functions and fix buckets ([c7324e0](https://github.com/RomRider/apexcharts-card/commit/c7324e04f7d1b196ccf9f7437bc2f44671f1ba84)) +* Add spinner while data is loading ([39d4b8e](https://github.com/RomRider/apexcharts-card/commit/39d4b8e2155e0b691d07f38fc0c2419ae7f09d65)) +* Display warning if sensor doesn't exist ([a69df3d](https://github.com/RomRider/apexcharts-card/commit/a69df3d9a1e0d8ae69be671b219b15a1b30ea2e4)) +* Floating header ([1eccee8](https://github.com/RomRider/apexcharts-card/commit/1eccee87bc59fb0f3eb012f6b3024fd8ddef04d4)) +* Initial support for aggregating data ([13dfd89](https://github.com/RomRider/apexcharts-card/commit/13dfd89d5be3ad62db73f9daea8ab5c92a3478a0)) +* Show value in legend ([869a7f8](https://github.com/RomRider/apexcharts-card/commit/869a7f83dc3740ffe7b5d2f3827070d9c391101e)) +* Support for all ApexCharts options ([03efa8d](https://github.com/RomRider/apexcharts-card/commit/03efa8da00015bbd954b923b3a83ce545ca7d681)) +* Support for header ([c5a8ee2](https://github.com/RomRider/apexcharts-card/commit/c5a8ee2a3e92567fcdc7f327cb838d39bcb372f8)) +* **card:** Support for pre-defined layouts ([c5987f8](https://github.com/RomRider/apexcharts-card/commit/c5987f8df0589b556235379d2ced172fee6facbd)) +* **graph:** Extends graph's last value to the current time ([bfe64c5](https://github.com/RomRider/apexcharts-card/commit/bfe64c5fcf4869676bf6eac584de612fa6e8d6a2)) diff --git a/README.md b/README.md index 3ec5de0..18f6981 100644 --- a/README.md +++ b/README.md @@ -51,7 +51,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/v0.0.1/apexcharts-card.js +$ wget https://github.com/RomRider/apexcharts-card/releases/download/v1.0.0/apexcharts-card.js ``` 3. Add the resource reference as decribed below. @@ -62,7 +62,7 @@ If you configure Lovelace via YAML, add a reference to `apexcharts-card.js` insi ```yaml resources: - - url: /local/apexcharts-card.js?v=0.0.1 + - url: /local/apexcharts-card.js?v=1.0.0 type: module ``` @@ -86,15 +86,15 @@ The card stricly validates all the options available (but not for the `apex_conf | Name | Type | Default | Since | Description | | ---- | :--: | :-----: | :---: | ----------- | -| :white_check_mark: `type` | string | | NEXT_VERSION | `custom:apexcharts-card` | -| :white_check_mark: `series` | object | | NEXT_VERSION | See [series](#series-options) | -| `hours_to_show` | number | `24` | NEXT_VERSION | The span of the graph in hours (Use `0.25` for 15min for eg.) | -| `show` | object | | NEXT_VERSION | See [show](#show-options) | -| `cache` | boolean | `true` | NEXT_VERSION | Use in-browser data caching to reduce the load on Home Assistant's server | -| `stacked` | boolean | `false` | NEXT_VERSION | Enable if you want the data to be stacked on the graph | -| `layout` | string | | NEXT_VERSION | See [layouts](#layouts) | -| `header` | string | | NEXT_VERSION | See [header](#header-options) | -| `apex_config`| object | | NEXT_VERSION | Apexcharts API 1:1 mapping. You call see all the options [here](https://apexcharts.com/docs/installation/) --> `Options (Reference)` in the Menu. See [Apex Charts](#apex-charts-options-example) | +| :white_check_mark: `type` | string | | v1.0.0 | `custom:apexcharts-card` | +| :white_check_mark: `series` | object | | v1.0.0 | See [series](#series-options) | +| `hours_to_show` | number | `24` | v1.0.0 | The span of the graph in hours (Use `0.25` for 15min for eg.) | +| `show` | object | | v1.0.0 | See [show](#show-options) | +| `cache` | boolean | `true` | v1.0.0 | Use in-browser data caching to reduce the load on Home Assistant's server | +| `stacked` | boolean | `false` | v1.0.0 | Enable if you want the data to be stacked on the graph | +| `layout` | string | | v1.0.0 | See [layouts](#layouts) | +| `header` | string | | v1.0.0 | See [header](#header-options) | +| `apex_config`| object | | v1.0.0 | Apexcharts API 1:1 mapping. You call see all the options [here](https://apexcharts.com/docs/installation/) --> `Options (Reference)` in the Menu. See [Apex Charts](#apex-charts-options-example) | @@ -102,49 +102,49 @@ The card stricly validates all the options available (but not for the `apex_conf | Name | Type | Default | Since | Description | | ---- | :--: | :-----: | :---: | ----------- | -| :white_check_mark: `entity` | string | | NEXT_VERSION | The `entity_id` of the sensor to display | -| `name` | string | | NEXT_VERSION | Override the name of the entity | -| `type` | string | `line` | NEXT_VERSION | `line`, `area` or `bar` are supported for now | -| `curve` | string | `smooth` | NEXT_VERSION | `smooth` (nice curve), `straight` (direct line between points) or `stepline` (flat line until next point then straight up or down) | -| `extend_to_end` | boolean | `true` | NEXT_VERSION | If the last data is older than the end time displayed on the graph, setting to true will extend the value until the end of the timeline. Only works for `line` and `area` types. | -| `unit` | string | | NEXT_VERSION | Override the unit of the sensor | -| `group_by` | object | | NEXT_VERSION | See [group_by](#group_by-options) | +| :white_check_mark: `entity` | string | | v1.0.0 | The `entity_id` of the sensor to display | +| `name` | string | | v1.0.0 | Override the name of the entity | +| `type` | string | `line` | v1.0.0 | `line`, `area` or `bar` are supported for now | +| `curve` | string | `smooth` | v1.0.0 | `smooth` (nice curve), `straight` (direct line between points) or `stepline` (flat line until next point then straight up or down) | +| `extend_to_end` | boolean | `true` | v1.0.0 | If the last data is older than the end time displayed on the graph, setting to true will extend the value until the end of the timeline. Only works for `line` and `area` types. | +| `unit` | string | | v1.0.0 | Override the unit of the sensor | +| `group_by` | object | | v1.0.0 | See [group_by](#group_by-options) | ### `show` Options | Name | Type | Default | Since | Description | | ---- | :--: | :-----: | :---: | ----------- | -| `loading` | boolean | `true` | NEXT_VERSION | Displays a spinning icon while the data is loading/updating | +| `loading` | boolean | `true` | v1.0.0 | Displays a spinning icon while the data is loading/updating | ### `header` Options | Name | Type | Default | Since | Description | | ---- | :--: | :-----: | :---: | ----------- | -| `show` | boolean | `true` | NEXT_VERSION | Show or hide the header | -| `floating` | boolean | `false` | NEXT_VERSION | Makes the header float above the graph. Positionning will be supported later | +| `show` | boolean | `true` | v1.0.0 | Show or hide the header | +| `floating` | boolean | `false` | v1.0.0 | Makes the header float above the graph. Positionning will be supported later | ### `group_by` Options | Name | Type | Default | Since | Description | | ---- | :--: | :-----: | :---: | ----------- | -| `func` | string | `raw` | NEXT_VERSION | See [func](#func-options) | -| `duration` | string | `1h` | NEXT_VERSION | If `func` is **not** `raw` only. It build buckets of states over `duration` period of time. Doesn't work for months. Eg of valid values: `2h`, `1d`, `10s`, `25min`, `1h30`, ... | -| `fill` | string | `last` | NEXT_VERSION | If `func` is **not** `raw` only. If there is any missing value in the states history, `last` will replace it will the last non-empty state, `zero` will fill missing values with `0`, `null` will fill missing values with `null` +| `func` | string | `raw` | v1.0.0 | See [func](#func-options) | +| `duration` | string | `1h` | v1.0.0 | If `func` is **not** `raw` only. It build buckets of states over `duration` period of time. Doesn't work for months. Eg of valid values: `2h`, `1d`, `10s`, `25min`, `1h30`, ... | +| `fill` | string | `last` | v1.0.0 | If `func` is **not** `raw` only. If there is any missing value in the states history, `last` will replace it will the last non-empty state, `zero` will fill missing values with `0`, `null` will fill missing values with `null` ### `func` Options | Name | Since | Description | | ---- | :---: | ----------- | -| `raw` | NEXT_VERSION | Displays all the state history as known by Home Assistant | -| `avg` | NEXT_VERSION | Will return the average of all the states in each bucket | -| `min` | NEXT_VERSION | Will return the smallest state of each bucket | -| `max` | NEXT_VERSION | Will return the biggest state of each bucket | -| `last` | NEXT_VERSION | Will return the last state of each bucket | -| `first` | NEXT_VERSION | Will return the first state of each bucket | -| `sum` | NEXT_VERSION | Will return the sum of all the states in each bucket | -| `median` | NEXT_VERSION | Will return the median of all the states in each bucket | -| `delta` | NEXT_VERSION | Will return the delta between the biggest and smallest state in each bucket | +| `raw` | v1.0.0 | Displays all the state history as known by Home Assistant | +| `avg` | v1.0.0 | Will return the average of all the states in each bucket | +| `min` | v1.0.0 | Will return the smallest state of each bucket | +| `max` | v1.0.0 | Will return the biggest state of each bucket | +| `last` | v1.0.0 | Will return the last state of each bucket | +| `first` | v1.0.0 | Will return the first state of each bucket | +| `sum` | v1.0.0 | Will return the sum of all the states in each bucket | +| `median` | v1.0.0 | Will return the median of all the states in each bucket | +| `delta` | v1.0.0 | Will return the delta between the biggest and smallest state in each bucket | ### Apex Charts Options Example diff --git a/package-lock.json b/package-lock.json index 2667d1d..aee6ee8 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "apexcharts-card", - "version": "0.0.1", + "version": "1.0.0", "lockfileVersion": 2, "requires": true, "packages": { diff --git a/package.json b/package.json index 2f2d699..6b6eeb3 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "apexcharts-card", - "version": "0.0.1", + "version": "1.0.0", "description": "A Home Assistant Lovelace card using ApexCharts to render graphs", "main": "src/apexcharts-card.ts", "scripts": {