├── ISSUE.md ├── LICENSE ├── README.md ├── gauge-card.js └── hacs.json /ISSUE.md: -------------------------------------------------------------------------------- 1 | # Issue 2 | On recent releases of HA, I am facing an issue with the display of the gauge, using the default light or dark theme. 3 | 4 | Dark theme: 5 | 6 | ![2022-02-19_094807](https://user-images.githubusercontent.com/58231487/154793886-12c5b1aa-4469-4a7c-9bb7-d7def5421959.png) 7 | 8 | Light theme: 9 | 10 | ![2022-02-19_094830](https://user-images.githubusercontent.com/58231487/154793899-4fa37a60-bcf1-47cd-861e-22c0c1a4bb8a.png) 11 | 12 | 13 | With the style inspector of the browser, the variable `--paper-card-background-color` is not set in `.gauge-b`. Replacing this variable with `--card-background-color` fix the issue. 14 | 15 | ![2022-02-19_101802](https://user-images.githubusercontent.com/58231487/154794766-c07842f9-9bde-4db3-869b-e15151171cb9.png) 16 | 17 | 18 | After: 19 | 20 | ![2022-02-19_101859](https://user-images.githubusercontent.com/58231487/154794849-2f92f890-6f1f-4424-ab05-74d4d5b4f26e.png) 21 | ![2022-02-19_101914](https://user-images.githubusercontent.com/58231487/154794851-75ca8ade-fa21-43d7-a59c-06abe5c18f3b.png) 22 | 23 | ![2022-02-19_102007](https://user-images.githubusercontent.com/58231487/154794852-9e99d0f7-b324-48b7-959a-e55e7eaae87e.png) 24 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Gauge card 2 | 3 | **Please read ISSUE.md for the change i made to the code** 4 | 5 | [ISSUE.md](ISSUE.md) 6 | 7 | A simple gauge implemented in CSS based on https://github.com/JohnrBell/Gauge_CSS. 8 | 9 | ![gauge-card](https://user-images.githubusercontent.com/7738048/42317998-73070c5e-8056-11e8-8621-49c61b5b7be5.gif) 10 | 11 | ![bedroom-temperature](https://user-images.githubusercontent.com/7738048/42344596-806b4a82-80a5-11e8-8e92-9077ad749dfe.gif) 12 | 13 | 14 | **Options** 15 | 16 | | Name | Type | Default | Description 17 | | ---- | ---- | ------- | ----------- 18 | | type | string | **Required** | `custom:gauge-card` 19 | | title | string | optional | Name to display on card 20 | | measurement | string | optional | If not set, uses the unit_of_measurement on the entity 21 | | entity | string | **Required** | `sensor.my_temperature` 22 | | attribute | string | optional | If set, this attribute of the entity is used, instead of its state 23 | | min | number | 0 | Minimum value for graph 24 | | max | number | 100 | Maximum value for graph 25 | | scale | string | '50px' | Base value for graph visual size 26 | | severity | object | optional | Severity object. See below 27 | 28 | Severity object 29 | 30 | | Name | Type | Default | Description 31 | | ---- | ---- | ------- | ----------- 32 | | red | number | **Required** | Value from which to start red color 33 | | green | number | **Required** | Value from which to start green color 34 | | amber | number | **Required** | Value from which to start amber color 35 | 36 | **Example** 37 | 38 | Using two with stack 39 | ```yaml 40 | - type: horizontal-stack 41 | cards: 42 | - type: custom:gauge-card 43 | title: Temperature 44 | entity: sensor.random_temperature 45 | min: -20 46 | max: 35 47 | - type: custom:gauge-card 48 | title: Oil 49 | entity: sensor.my_oil_sensor 50 | severity: 51 | red: 50 52 | green: 0 53 | amber: 40 54 | ``` 55 | 56 | Simple one 57 | ```yaml 58 | - type: custom:gauge-card 59 | entity: sensor.my_oil_sensor 60 | scale: 100px 61 | ``` 62 | 63 | Using an attribute 64 | ```yaml 65 | - type: custom:gauge-card 66 | entity: climate.living_room 67 | attribute: current_temperature 68 | ``` 69 | 70 | Using an attribute with dot notation 71 | ```yaml 72 | - type: custom:gauge-card 73 | entity: climate.living_room.current_temperature 74 | ``` 75 | 76 | ## Credits 77 | - [@ciotlosm](https://github.com/ciotlosm) 78 | - [@isabellaalstrom](https://github.com/isabellaalstrom) 79 | -------------------------------------------------------------------------------- /gauge-card.js: -------------------------------------------------------------------------------- 1 | class GaugeCard extends HTMLElement { 2 | constructor() { 3 | super(); 4 | this.attachShadow({ mode: 'open' }); 5 | } 6 | setConfig(config) { 7 | if (!config.entity) { 8 | throw new Error('Please define an entity'); 9 | } 10 | 11 | const root = this.shadowRoot; 12 | if (root.lastChild) root.removeChild(root.lastChild); 13 | 14 | const cardConfig = Object.assign({}, config); 15 | if (!cardConfig.scale) cardConfig.scale = "50px"; 16 | if (!cardConfig.min) cardConfig.min = 0; 17 | if (!cardConfig.max) cardConfig.max = 100; 18 | 19 | const entityParts = this._splitEntityAndAttribute(cardConfig.entity); 20 | cardConfig.entity = entityParts.entity; 21 | if (entityParts.attribute) cardConfig.attribute = entityParts.attribute; 22 | 23 | const card = document.createElement('ha-card'); 24 | const content = document.createElement('div'); 25 | const style = document.createElement('style'); 26 | style.textContent = ` 27 | ha-card { 28 | --base-unit: ${cardConfig.scale}; 29 | height: calc(var(--base-unit)*3); 30 | position: relative; 31 | } 32 | .container{ 33 | width: calc(var(--base-unit) * 4); 34 | height: calc(var(--base-unit) * 2); 35 | position: absolute; 36 | top: calc(var(--base-unit)*1.5); 37 | left: 50%; 38 | overflow: hidden; 39 | text-align: center; 40 | transform: translate(-50%, -50%); 41 | } 42 | .gauge-a{ 43 | z-index: 1; 44 | position: absolute; 45 | background-color: var(--primary-background-color); 46 | width: calc(var(--base-unit) * 4); 47 | height: calc(var(--base-unit) * 2); 48 | top: 0%; 49 | border-radius:calc(var(--base-unit) * 2.5) calc(var(--base-unit) * 2.5) 0px 0px ; 50 | } 51 | .gauge-b{ 52 | z-index: 3; 53 | position: absolute; 54 | background-color: var(--card-background-color); 55 | width: calc(var(--base-unit) * 2.5); 56 | height: calc(var(--base-unit) * 1.25); 57 | top: calc(var(--base-unit) * 0.75); 58 | margin-left: calc(var(--base-unit) * 0.75); 59 | margin-right: auto; 60 | border-radius: calc(var(--base-unit) * 2.5) calc(var(--base-unit) * 2.5) 0px 0px ; 61 | } 62 | .gauge-c{ 63 | z-index: 2; 64 | position: absolute; 65 | background-color: var(--label-badge-yellow); 66 | width: calc(var(--base-unit) * 4); 67 | height: calc(var(--base-unit) * 2); 68 | top: calc(var(--base-unit) * 2); 69 | margin-left: auto; 70 | margin-right: auto; 71 | border-radius: 0px 0px calc(var(--base-unit) * 2) calc(var(--base-unit) * 2) ; 72 | transform-origin: center top; 73 | transition: all 1.3s ease-in-out; 74 | } 75 | .gauge-data{ 76 | z-index: 4; 77 | color: var(--primary-text-color); 78 | line-height: calc(var(--base-unit) * 0.3); 79 | position: absolute; 80 | width: calc(var(--base-unit) * 4); 81 | height: calc(var(--base-unit) * 2.1); 82 | top: calc(var(--base-unit) * 1.2); 83 | margin-left: auto; 84 | margin-right: auto; 85 | transition: all 1s ease-out; 86 | } 87 | .gauge-data #percent{ 88 | font-size: calc(var(--base-unit) * 0.55); 89 | } 90 | .gauge-data #title{ 91 | padding-top: calc(var(--base-unit) * 0.15); 92 | font-size: calc(var(--base-unit) * 0.30); 93 | } 94 | `; 95 | content.innerHTML = ` 96 |
97 |
98 |
99 |
100 |
101 |
102 | `; 103 | card.appendChild(content); 104 | card.appendChild(style); 105 | card.addEventListener('click', event => { 106 | this._fire('hass-more-info', { entityId: cardConfig.entity }); 107 | }); 108 | root.appendChild(card); 109 | this._config = cardConfig; 110 | } 111 | 112 | _splitEntityAndAttribute(entity) { 113 | let parts = entity.split('.'); 114 | if (parts.length < 3) { 115 | return { entity: entity }; 116 | } 117 | 118 | return { attribute: parts.pop(), entity: parts.join('.') }; 119 | } 120 | 121 | _fire(type, detail, options) { 122 | const node = this.shadowRoot; 123 | options = options || {}; 124 | detail = (detail === null || detail === undefined) ? {} : detail; 125 | const event = new Event(type, { 126 | bubbles: options.bubbles === undefined ? true : options.bubbles, 127 | cancelable: Boolean(options.cancelable), 128 | composed: options.composed === undefined ? true : options.composed 129 | }); 130 | event.detail = detail; 131 | node.dispatchEvent(event); 132 | return event; 133 | } 134 | 135 | _translateTurn(value, config) { 136 | return 5 * (value - config.min) / (config.max - config.min) 137 | } 138 | 139 | _computeSeverity(stateValue, sections) { 140 | let numberValue = Number(stateValue); 141 | const severityMap = { 142 | red: "var(--label-badge-red)", 143 | green: "var(--label-badge-green)", 144 | amber: "var(--label-badge-yellow)", 145 | normal: "var(--label-badge-blue)", 146 | } 147 | if (!sections) return severityMap["normal"]; 148 | let sortable = []; 149 | for (let severity in sections) { 150 | sortable.push([severity, sections[severity]]); 151 | } 152 | sortable.sort((a, b) => { return a[1] - b[1] }); 153 | 154 | if (numberValue >= sortable[0][1] && numberValue < sortable[1][1]) { 155 | return severityMap[sortable[0][0]] 156 | } 157 | if (numberValue >= sortable[1][1] && numberValue < sortable[2][1]) { 158 | return severityMap[sortable[1][0]] 159 | } 160 | if (numberValue >= sortable[2][1]) { 161 | return severityMap[sortable[2][0]] 162 | } 163 | return severityMap["normal"]; 164 | } 165 | 166 | _getEntityStateValue(entity, attribute) { 167 | if (!attribute) { 168 | return entity.state; 169 | } 170 | 171 | return entity.attributes[attribute]; 172 | } 173 | 174 | set hass(hass) { 175 | const config = this._config; 176 | const entityState = this._getEntityStateValue(hass.states[config.entity], config.attribute); 177 | let measurement = ""; 178 | if (config.measurement == null) 179 | measurement = hass.states[config.entity].attributes.unit_of_measurement; 180 | else 181 | measurement = config.measurement; 182 | 183 | const root = this.shadowRoot; 184 | if (entityState !== this._entityState) { 185 | root.getElementById("percent").textContent = `${entityState} ${measurement}`; 186 | root.getElementById("title").textContent = config.title; 187 | const turn = this._translateTurn(entityState, config) / 10; 188 | root.getElementById("gauge").style.transform = `rotate(${turn}turn)`; 189 | root.getElementById("gauge").style.backgroundColor = this._computeSeverity(entityState, config.severity); 190 | this._entityState = entityState; 191 | } 192 | root.lastChild.hass = hass; 193 | } 194 | 195 | getCardSize() { 196 | return 1; 197 | } 198 | } 199 | 200 | customElements.define('gauge-card', GaugeCard); 201 | -------------------------------------------------------------------------------- /hacs.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "gauge-card", 3 | "render_readme": true 4 | } 5 | --------------------------------------------------------------------------------