Skip to content

Commit

Permalink
[CODESPELL] Added Codespell
Browse files Browse the repository at this point in the history
  • Loading branch information
rick.stokkingreef committed Jul 29, 2022
1 parent 005c2b3 commit b83ac9f
Show file tree
Hide file tree
Showing 17 changed files with 42 additions and 30 deletions.
2 changes: 1 addition & 1 deletion .codespell
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# list of words ignored by codespell
# list of words ignored by codespell
3 changes: 2 additions & 1 deletion .codespellrc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
[codespell]
skip = *.svg
count =
quiet-level = 3
quiet-level = 3
# write-changes =
4 changes: 2 additions & 2 deletions .devcontainer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ First we need to install some dependencies to get a basic Home Assistant instanc
**Prerequisites**

```bash
# start terminal in contianer
# start terminal in container
pip install -r requirements_dev.txt
# install pre-commit
pre-commit install
Expand Down Expand Up @@ -106,4 +106,4 @@ wget -O - https://get.hacs.xyz | bash -
- To get the best experience with the themes that come with the integration:
- Go to Configuration -> Blueprints
- Create an automation from `System Set Default Theme`, and select what theme you want. And after restart it will be set.
- Restart home assitant to make sure everything is located
- Restart home assistant to make sure everything is located
1 change: 1 addition & 0 deletions .github/workflows/codespell.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@ jobs:
with:
ignore_words_list: .codespell
config: .codespellrc
path: docs
10 changes: 10 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -107,3 +107,13 @@ repos:
- "--format=custom"
# - "--configfile=bandit.yaml"
<<: *python-files-with-tests
- repo: https://github.com/codespell-project/codespell.git
rev: "v2.1.0"
hooks:
- id: codespell
files: "(.*.md|translations/en.json)"
name: codespell
description: Checks for common misspellings in text files.
entry: codespell
language: python
types: [text]
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ If any of you have used this before, you should take a look at @saxel's pull req
- Add custom single icon chip card @CM000n (#38)
- Add custom card custom\_card\_schumijo\_car @schumijo (#39)
- Round temperature when the temperature has decimal points @bavo (#46)
- Add Alarm Chip to availabe templates @tombo12354 (#50)
- Add Alarm Chip to available templates @tombo12354 (#50)
- Create SE.yaml @EmilZackrisson (#53)
- Vertical buttons custom state @saxel (#66)
- Add release drafter @CM000n (#72)
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
![hacs installs](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Flauwbier.nl%2Fhacs%2Fui_lovelace_minimalist)
![Downloads](https://img.shields.io/github/downloads/UI-Lovelace-Minimalist/UI/total)

It's kind of hard to explain what this is, so let's call it a "theme" (in quotation marks). But one thing is for sure, it is very nice! Taking the exceptional work of tben as a basis, this repository is aimed to ease installation and maintainance of his wonderful work. You can use this interpretation of a SmartHomeUI more or less like a theme in HomeAssistant.
It's kind of hard to explain what this is, so let's call it a "theme" (in quotation marks). But one thing is for sure, it is very nice! Taking the exceptional work of tben as a basis, this repository is aimed to ease installation and maintenance of his wonderful work. You can use this interpretation of a SmartHomeUI more or less like a theme in HomeAssistant.

<img src="https://raw.githubusercontent.com/UI-Lovelace-Minimalist/UI/main/docs/assets/img/example_home.png" width="200"> <img src="https://raw.githubusercontent.com/UI-Lovelace-Minimalist/UI/main/docs/assets/img/example_temperature.png" width="200"> <img src="https://raw.githubusercontent.com/UI-Lovelace-Minimalist/UI/main/docs/assets/img/example_consumption.png" width="200"> <img src="https://raw.githubusercontent.com/UI-Lovelace-Minimalist/UI/main/docs/assets/img/example_localisation.png" width="200">

Expand Down Expand Up @@ -68,19 +68,19 @@ We can offer you in-depth instructions for installation, as well as for future u

## List of templates

The actual version of this "theme" has 20 different cards, seven chips and other templates bundled into the download. We're sorry, but the list wouldn't fit into this readme. [Please see this page, where you can find an extensive list of templates with code examples, screenshots and explaination](https://ui-lovelace-minimalist.github.io/UI/usage/cards/card_battery/).
The actual version of this "theme" has 20 different cards, seven chips and other templates bundled into the download. We're sorry, but the list wouldn't fit into this readme. [Please see this page, where you can find an extensive list of templates with code examples, screenshots and explanation](https://ui-lovelace-minimalist.github.io/UI/usage/cards/card_battery/).

## Custom cards

The same goes for our `custom_cards`. As the number grows, the list would be to big for this readme, so we provide you with an overview page with pictures, code examples and additional informations. [Find the list here](https://ui-lovelace-minimalist.github.io/UI/usage/custom_cards/custom_card_bar_card/).
The same goes for our `custom_cards`. As the number grows, the list would be to big for this readme, so we provide you with an overview page with pictures, code examples and additional information. [Find the list here](https://ui-lovelace-minimalist.github.io/UI/usage/custom_cards/custom_card_bar_card/).

### Credits & Contributors

- This design was made by [tben](https://community.home-assistant.io/u/tben/summary)
- A lot of inspiration is taken from [7ahang’s work](https://www.behance.net/gallery/88433905/Redesign-Smart-Home) found on Behance.
- Contributions from others in the HomeAssistant forum thread, you can find it here.
- The technical part is realised mostly by taking advantage of the great work RomRaider did with his [button-card](https://github.com/custom-cards/button-card).
- Code refactor, cleanup and maintainance by [schumijo](https://github.com/schumijo) and [paddy0174](https://github.com/Paddy0174) & [CM000n](https://github.com/CM000n).
- Code refactor, cleanup and maintenance by [schumijo](https://github.com/schumijo) and [paddy0174](https://github.com/Paddy0174) & [CM000n](https://github.com/CM000n).
- [dwainscheeren](https://github.com/dwainscheeren) for his inspiration to deliver themes via HACS.
- Wiki by [paddy0174](https://github.com/Paddy0174).
- Special thanks to clemalex and [schumijo](https://github.com/schumijo)for contributing their cards to the main repository.
Expand Down
2 changes: 1 addition & 1 deletion custom_cards/custom_card_more_power_outlet/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This is the power outlet card is very similar to the default `power-outlet-card`

## Credits

Author: Wranglatang - 2022 Vesion 1.0.0
Author: Wranglatang - 2022 Version 1.0.0

## Variables

Expand Down
4 changes: 2 additions & 2 deletions custom_cards/custom_card_mpse_gauge/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ hide:

# Custom-card "Gauge"

The `custom_card_mpse_gauge` is used present a value in form of a gauge. The card can handle two gauges so it would be easy to adapt the card to that if required. I prefered the minimal look.
The `custom_card_mpse_gauge` is used present a value in form of a gauge. The card can handle two gauges so it would be easy to adapt the card to that if required. I preferred the minimal look.

![Printer](../../docs/assets/img/custom_gauge.png)

Expand Down Expand Up @@ -51,7 +51,7 @@ Uses this card: <https://github.com/custom-cards/dual-gauge-card> which can be i
<td>ulm_card_mpse_gauge_min</td>
<td>0</td>
<td>no</td>
<td>Minium value, defaults to 0.</td>
<td>Minimum value, defaults to 0.</td>
</tr>
<tr>
<td>ulm_card_mpse_gauge_max</td>
Expand Down
2 changes: 1 addition & 1 deletion custom_cards/custom_card_mpse_printer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Version: 0.3.0

<details>
<summary>0.3.0</summary>
Updated documention.
Updated documentation.
Cleanup code in card.
Updated colors to match input values.
</details>
Expand Down
2 changes: 1 addition & 1 deletion custom_cards/custom_card_mpse_wifisignal/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ hide:

# Custom-card "WiFi Signal"

The `custom_card_mpse_wifisignal` is used to display the status of a wifi signal (dBm). Icon changes based on signal strenght.
The `custom_card_mpse_wifisignal` is used to display the status of a wifi signal (dBm). Icon changes based on signal strength.

![WiFi Signal](../../docs/assets/img/custom_wifisignal.png)

Expand Down
8 changes: 4 additions & 4 deletions custom_cards/custom_card_nik_tablet/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ Fix for UI Minimalist v1.0.1.
<td>ulm_custom_card_nik_tablet_button1</td>
<td>switch.sonoff_tablet_1p</td>
<td>Yes</td>
<td>A Switch that enables or not USB Power for the Tablet. If not present you can replace it with another Switch of your choise. (check your device configs)</td>
<td>A Switch that enables or not USB Power for the Tablet. If not present you can replace it with another Switch of your choice. (check your device configs)</td>
</tr>
<tr>
<td>ulm_custom_card_nik_tablet_button2</td>
Expand Down Expand Up @@ -135,19 +135,19 @@ Fix for UI Minimalist v1.0.1.
<td>ulm_custom_card_nik_tablet_par1</td>
<td>sensor.example</td>
<td>Yes</td>
<td>An entity of your choise to monitor a specific tablet parameter</td>
<td>An entity of your choice to monitor a specific tablet parameter</td>
</tr>
<tr>
<td>ulm_custom_card_nik_tablet_par2</td>
<td>sensor.example</td>
<td>Yes</td>
<td>An entity of your choise to monitor a specific tablet parameter</td>
<td>An entity of your choice to monitor a specific tablet parameter</td>
</tr>
<tr>
<td>ulm_custom_card_nik_tablet_par3</td>
<td>sensor.example</td>
<td>Yes</td>
<td>An entity of your choise to monitor a specific tablet parameter</td>
<td>An entity of your choice to monitor a specific tablet parameter</td>
</tr>
<tr>
<td>ulm_custom_card_nik_tablet_par1_name</td>
Expand Down
2 changes: 1 addition & 1 deletion custom_cards/custom_card_paddy_welcome/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ This card needs the following to function correctly:
> #### Note \_welcome_with_news
> This card is based on [home-feed-card](https://github.com/gadgetchnnel/lovelace-home-feed-card) and needs a little different configuration in the variables.
> To allow almost all entites from HomeAssistant to show in the news, you're able to set all options that `home-feed-card` provides. This makes it necessary, that you set these entities in a list. Let me show you an example:
> To allow almost all entities from HomeAssistant to show in the news, you're able to set all options that `home-feed-card` provides. This makes it necessary, that you set these entities in a list. Let me show you an example:
>
> ```yaml
> # normally you do this
Expand Down
10 changes: 5 additions & 5 deletions custom_cards/custom_card_ristou_person/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The `custom_card_ristou_person` shows if a person is `home` or `not_home`. If yo

Showing driving state is also possible with a binary sensor.

In addition, this card can display a map (either static or using buit in map) in a second row.
In addition, this card can display a map (either static or using built in map) in a second row.

## Icon style

Expand All @@ -61,7 +61,7 @@ As the main icon of this card you can choose the following set up
## About Static maps

The advantage of static map is that it is easy to custom and non-draggable.
For instance when you scroll down and you accidently press first on map card.
For instance when you scroll down and you accidentally press first on map card.

I choose map box for the following reasons:

Expand All @@ -70,7 +70,7 @@ I choose map box for the following reasons:
- Add many custom markers, I decided to represent my current location , home, and work.
- Possibility to remove attribution and logo.

URL can be direclty used inside a camera entity using dynamic markers as explain [here](https://www.home-assistant.io/examples/google_maps_card/)
URL can be directly used inside a camera entity using dynamic markers as explain [here](https://www.home-assistant.io/examples/google_maps_card/)

below is an example of the url I use for mapbox:

Expand All @@ -90,15 +90,15 @@ built in map is not always rendering properly. I observed 2 issues:
### Static map

Static map can be blurry if ratio does not fit card width.
In my case I used developper tool to find out exact width of the card (which is 466px) and then I ajusted the heigh to my needs.
In my case I used developer tool to find out exact width of the card (which is 466px) and then I adjusted the height to my needs.

## Variables

| Variable | Default | Required | Notes |
|----------|---------|------------------|-------------------|
| entity | | ✔️ | person entity |
| ulm_custom_card_ristou_use_entity_picture | false || If you set this to true, the card shows the entity picture from your user, otherwise (set to false) shows the icon. Default is false. |
| ulm_custom_card_ristou_use_badge | true || Show a notification badge on the icon. if set to false and not sing entity picture, then icon will be dinamically displayed to (Home, Away, Known place, or CAR) |
| ulm_custom_card_ristou_use_badge | true || Show a notification badge on the icon. if set to false and not sing entity picture, then icon will be dynamically displayed to (Home, Away, Known place, or CAR) |
| ulm_custom_card_ristou_map_enable |false|| Display built in map as a second row |
| ulm_custom_card_ristou_map_aspect_ratio |16:5|| Display built in map as a second row |
| ulm_custom_card_ristou_map_hours_to_show |24|| Display built in map as a second row |
Expand Down
6 changes: 3 additions & 3 deletions custom_cards/custom_card_saxel_fan/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ This card needs the following to function correctly:
entity: fan.smart_fan
name: Fan
variables:
collapsable: false
collapsible: false
oscillate_attribute: oscillate
```
Expand All @@ -77,7 +77,7 @@ This card needs the following to function correctly:
entity: fan.smart_fan
name: Fan
variables:
collapsable: true
collapsible: true
oscillate_attribute: oscillate
```
Expand All @@ -103,7 +103,7 @@ This card needs the following to function correctly:
<td>Name to show. If not specified the attribute <i>friendly_name</i> is shown instead</td>
</tr>
<tr>
<td>collapsable</td>
<td>collapsible</td>
<td>true</td>
<td>no</td>
<td>true/false if the fan speed row should collapse when the fan is turned off. Default: true</td>
Expand Down
2 changes: 1 addition & 1 deletion custom_cards/custom_card_schumijo_car/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ hide:

# Custom-card "Car"

This is a `custom-card` to informations about your car.
This is a `custom-card` to information about your car.

![Generic](../../docs/assets/img/car.png)

Expand Down
4 changes: 2 additions & 2 deletions custom_components/ui_lovelace_minimalist/translations/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
"error": {
"github_cards": "Something went wrong when fetching cards from Github.",
"ack": "You need to acknowledge all statements.",
"gh_token": "Github Token not set. Please re-install this integration to go throught the setup procedure. (No custom configuration will be lost)"
"gh_token": "Github Token not set. Please re-install this integration to go through the setup procedure. (No custom configuration will be lost)"
}
}
}
}

0 comments on commit b83ac9f

Please sign in to comment.