Skip to content
This repository has been archived by the owner on Jul 22, 2024. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@Yevgenium
Yevgenium authored Feb 28, 2022
1 parent 458ca1e commit cf2932b
Showing 1 changed file with 26 additions and 18 deletions.
44 changes: 26 additions & 18 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
![image](https://user-images.githubusercontent.com/33804747/139556051-d60c824d-0480-4812-a4c0-4f612ab4015b.png)
![image](https://user-images.githubusercontent.com/33804747/155938742-67770857-33b2-4e95-9601-737677895115.png)

## Configuration

Expand All @@ -24,26 +24,34 @@ entity: weather.home
##### Card options
| Name | Type | Default | Description |
| --------------- | ------- | -------------------------|--------------------------------------------------------------------------------------------------- |
| type | string | **Required** | Should be `custom:weather-chart-card` |
| entity | string | **Required** | An entity_id with the `weather` domain |
| title | string | none | Card title |
| show_main | boolean | true | Show or hide a section with current weather condition and temperature |
| show_attributes | boolean | true | Show or hide a section with attributes such as pressure, humidity, wind direction and speed, etc |
| icons | string | none | Path to the location of custom icons in svg format, for example `/local/weather-icons/` |
| icons_size | number | 25 | The size of custom icons in pixels |
| units | object | none | See [units of measurement](#units-of-measurement) for available options |
| temp1_color | string | rgba(230, 100, 100, 1.0) | Temperature first line chart color |
| temp2_color | string | rgba(68, 115, 158, 1.0) | Temperature second line chart color |
| precip_color | string | rgba(132, 209, 253, 1.0) | Precipitation bar chart color |
| Name | Type | Default | Description |
| -------------------- | ------- | -------------------------|--------------------------------------------------------------------------------------------------- |
| type | string | **Required** | Should be `custom:weather-chart-card`. |
| entity | string | **Required** | An entity_id with the `weather` domain. |
| title | string | none | Card title. |
| show_main | boolean | true | Show or hide a section with current weather condition and temperature. |
| show_attributes | boolean | true | Show or hide a section with attributes such as pressure, humidity, wind direction and speed, etc. |
| icons | string | none | Path to the location of custom icons in svg format, for example `/local/weather-icons/`. |
| icons_size | number | 25 | The size of custom icons in pixels. |
| forecast | object | none | See [forecast options](#forecast-options) for available options. |
| units | object | none | See [units of measurement](#units-of-measurement) for available options. |

##### Forecast options

| Name | Type | Default | Description |
| -------------------- | ------- | -------------------------|--------------------------------------------------------------------------------------------------- |
| labels_font_size | string | 11 | Font size for temperature and precipitation labels. |
| temperature1_color | string | rgba(255, 152, 0, 1.0) | Temperature first line chart color. |
| temperature2_color | string | rgba(68, 115, 158, 1.0) | Temperature second line chart color. |
| precipitation_color | string | rgba(132, 209, 253, 1.0) | Precipitation bar chart color. |
| condition_icons | boolean | true | Show or hide forecast condition icons. |

##### Units of measurement

| Name | Type | Default | Description |
| --------------- | ------- | -------------------------|--------------------------------------------------------------------------------------------------- |
| pressure | string | 'hPa' | Can be 'hPa' or 'mmHg' |
| speed | string | 'km/h' | Can be 'km/h' or 'm/s' |
| Name | Type | Default | Description |
| -------------------- | ------- | -------------------------|--------------------------------------------------------------------------------------------------- |
| pressure | string | 'hPa' | Can be 'hPa' or 'mmHg' |
| speed | string | 'km/h' | Can be 'km/h' or 'm/s' |

###### What custom icons can I use?
Icons should be in svg format. Icons should have names as shown [here](https://github.com/Yevgenium/weather-chart-card/blob/a9f795f2fd02028bdad9b771d383fa38c5f3148c/src/const.js#L24). Example:
Expand Down

0 comments on commit cf2932b

Please sign in to comment.