Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/boralyl/steam-wishlist
A home assistant integration that monitors games on sale on your Steam wishlist.
https://github.com/boralyl/steam-wishlist
hacs home-assistant homeassistant python steam
Last synced: 3 months ago
JSON representation
A home assistant integration that monitors games on sale on your Steam wishlist.
- Host: GitHub
- URL: https://github.com/boralyl/steam-wishlist
- Owner: boralyl
- License: mit
- Created: 2020-03-28T01:28:32.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-08-15T03:10:44.000Z (5 months ago)
- Last Synced: 2024-10-19T11:30:12.120Z (3 months ago)
- Topics: hacs, home-assistant, homeassistant, python, steam
- Language: Python
- Homepage:
- Size: 12.1 MB
- Stars: 25
- Watchers: 2
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/boralyl/steam-wishlist/releases)
[](https://github.com/hacs/integration)
[](LICENSE)
[](https://github.com/boralyl/steam-wishlist/actions)
# Steam Wishlist for Home Assistant
A custom component that keeps track of when games on your Steam wishlist are on
sale. This component uses the config flow and can easily be configured via the
Integrations section in the UI.
[](https://github.com/boralyl/steam-wishlist/raw/master/assets/setup.png)
## Pre-Installation
Prior to installing this integration you must first ensure that your wishlist is publicly
viewable. To do this, login to you steam account and edit your profile. Under the
`Privacy Settings` tab, set `Game Details` to `Public`. Without this step, this integration
will not be able to parse your wishlist.
[](https://github.com/boralyl/steam-wishlist/raw/master/assets/steam-profile.png)
## HACS Installation
1. Search for `Steam Wishlist` under the `Integrations` tab on [HACS](https://hacs.xyz/).
2. Install the integration.
3. In the home assistant configuration screen click on `Integrations`.
4. Click on the `+` icon to add a new integration.
5. Search for `Steam Wishlist` and select it.
6. Enter your steam account name and click `Submit`.
## Manual Installation
1. Download the [latest release](https://github.com/boralyl/steam-wishlist/releases).
2. Extract the files and move the `steam_wishlist` folder into the path to your
`custom_components`. e.g. `/config/custom_components`.
3. In the home assistant configuration screen click on `Integrations`.
4. Click on the `+` icon to add a new integration.
5. Search for `Steam Wishlist` and select it.
6. Enter your steam account name and click `Submit`.
## Sensors
After you successfully setup the integration a number of sensors will be created.
### `sensor.steam_wishlist_`
This sensor will report the number of games on sale from your wishlist.
[](https://github.com/boralyl/steam-wishlist/raw/main/assets/sensor.steam_wishlist.png)
#### Attributes
The following state attributes are available for this sensor:
| attribute | description |
| --------- | ------------------------------------------- |
| on_sale | An array of [games on sale](#attributes-1). |
### `binary_sensor.steam_wishlist_`
A binary sensor will be created for each game on your wishlist. It's state will
indicate if it is on sale or not.
[](https://github.com/boralyl/steam-wishlist/raw/main/assets/binary_sensor.steam_wishlist_terraria.png)
#### Attributes
The following state attributes are available for this sensor:
| attribute | description |
| --------------- | -------------------------------------------------------------- |
| title | Title of the game |
| rating | Reviews e.g. `Reviews: 92% (Very Positive)` |
| price | Price description of game |
| genres | Genres of game e.g. `FPS, Action, First-Person` |
| release | Release date of game |
| airdate | Date game was released (Unix timestamp format) |
| normal_price | Price |
| percent_off | Percentage off of the normal price |
| review_desc | Review description |
| reviews_percent | Percentage of positive reviews |
| reviews_total | Total number of reviews |
| sale_price | Sale price of the game |
| steam_id | Steam ID of the game |
| box_art_url | URL for the background 16:9 aspect ratio image |
| fanart | URL for the background 16:9 aspect ratio image |
| poster | URL for the background 3:4 image |
| deep_link | Clickable hyperlink to game on Steam website |
## Displaying in Lovelace
You are able to use any Home Assistant card to display a list of your games that are on sale by utilizing the `sensor.steam_wishlist` sensor. Below, are 2 cards that fully support this integration and its sensor attributes:
### I. upcoming-media-card
You can use [upcoming-media-card](https://github.com/custom-cards/upcoming-media-card) to display your Steam wishlist items that are on sale. You can also toggle displaying your non-sale wishlist items via the YAML setting `collapse: price=🎫` _(along with enabling the **Options** integration setting)_ like so:
Example YAML:
```yaml
- type: custom:upcoming-media-card
entity: sensor.steam_wishlist_978793482343112
title: Steam Wishlist
image_style: fanart
collapse: price=🎫
max: 10
```
##### Enable the Steam Wishlist integration setting below:
---
### II. nintendo-wishlist-card
You can use [nintendo-wishlist-card](https://github.com/custom-cards/nintendo-wishlist-card) to display your Steam wishlist items that are on sale. This is possible since I also maintain the [nintendo-wishlist](https://github.com/custom-components/sensor.nintendo_wishlist) integration. You can add this card to Lovelace like so:
Example YAML:
```yaml
- type: custom:nintendo-wishlist-card
entity: sensor.steam_wishlist_978793482343112
title: Steam Wishlist
image_style: backgroundart
max: 10
```
