diff --git a/README.md b/README.md index cc0d8bc..f976670 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ # Nintendo Wishlist Component -[![](https://img.shields.io/github/release/custom-components/sensor.nintendo_wishlist/all.svg?style=for-the-badge)](https://github.com/boralyl/steam-wishlist/releases) +[![](https://img.shields.io/github/release/custom-components/sensor.nintendo_wishlist/all.svg?style=for-the-badge)](https://github.com/custom-components/sensor.nintendo_wishlist/releases) [![hacs_badge](https://img.shields.io/badge/HACS-Default-orange.svg?style=for-the-badge)](https://github.com/custom-components/hacs) [![](https://img.shields.io/github/license/custom-components/sensor.nintendo_wishlist?style=for-the-badge)](LICENSE) -> **_NOTE:_** This component currently only works in certain countries. See [Supported Countries](#supported-countries) below. +> **_NOTE:_** This component currently only works in certain countries. See [Supported Countries](#supported-countries) below. -> **_Migrating to v3?_** See the [migration guide](./MIGRATION_TO_V3.md). +> **_Migrating to v3?_** See the [migration guide](https://github.com/custom-components/sensor.nintendo_wishlist/blob/master/MIGRATION_TO_V3.md). Home Assistant component that keeps track of Nintendo Switch games that are on sale on your wish list in home assistant. @@ -21,15 +21,15 @@ sale on your wish list in home assistant. ## Configuration -|Name|Required|Description| -|-|-|-| -|country|yes|The 2 letter country code. See [Supported Countries](#supported-countries) below.| -|wishlist|yes|A list of Nintendo Switch titles. Each item can be the exact title or just the beginning of a title in order to match multiple games. For example `Shantae` would trigger when any one of the many `Shantae` games goes on sale. Read [how wishlist matching works](#how-wish-list-matching-works) below. +| Name | Required | Description | +| -------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| country | yes | The 2 letter country code. See [Supported Countries](#supported-countries) below. | +| wishlist | yes | A list of Nintendo Switch titles. Each item can be the exact title or just the beginning of a title in order to match multiple games. For example `Shantae` would trigger when any one of the many `Shantae` games goes on sale. Read [how wishlist matching works](#how-wish-list-matching-works) below. | ## Sample Configuration -*Note:* If the title contains characters that might confuse yaml like a `:` or `'` quote the entire string -like the last game in the example below. If you do not do this your yaml may +_Note:_ If the title contains characters that might confuse yaml like a `:` or `'` quote the entire string +like the last game in the example below. If you do not do this your yaml may be invalid in your configuration file. ```yaml @@ -49,34 +49,33 @@ nintendo_wishlist: ### Supported Countries -|Country Code|Country Name| -|-|-| -|AT|Austria| -|BE|Belgium| -|CA|Canada| -|CH|Schweiz/Suisse/Svizzera| -|DE|Germany| -|ES|Spain| -|FR|France| -|GB|UK/Ireland| -|IT|Italy| -|NL|Netherlands| -|PT|Portugal| -|RU|Russia| -|US|United States| -|ZA|South Africa| - +| Country Code | Country Name | +| ------------ | ----------------------- | +| AT | Austria | +| BE | Belgium | +| CA | Canada | +| CH | Schweiz/Suisse/Svizzera | +| DE | Germany | +| ES | Spain | +| FR | France | +| GB | UK/Ireland | +| IT | Italy | +| NL | Netherlands | +| PT | Portugal | +| RU | Russia | +| US | United States | +| ZA | South Africa | ### How wish list matching works -Currently wish list matching uses a very simple string comparison. It's +Currently wish list matching uses a very simple string comparison. It's possible to get false positives as it checks to see if any game on your wish -list starts with any title that is on sale. In order to avoid false positives +list starts with any title that is on sale. In order to avoid false positives try to have the title match that on the nintendo e-store as closely as possible. Conversely, if you would like to match multiple titles that have a similar name -you can specify less of the title. An example of this would be to add an item -to your wishlist like `Shantae`. This would match any of the Shantae titles on +you can specify less of the title. An example of this would be to add an item +to your wishlist like `Shantae`. This would match any of the Shantae titles on the e-shop (e.g. `Shantae and the Pirate's Curse` and `Shantae: Half-Genie Hero`. ### Sensors @@ -94,26 +93,26 @@ This sensor can be used with the [Nintendo Wishlist Custom Card](https://github. The following state attributes are available for this sensor: -|attribute|description| -|-|-| -|on_sale|An array of [games on sale](#game-on-sale-object).| +| attribute | description | +| --------- | -------------------------------------------------- | +| on_sale | An array of [games on sale](#game-on-sale-object). | #### Game on Sale Object This object represents a single Nintendo Switch game on sale. -|attribute|description| -|-|-| -|box_art_url|The URL for the box art of the game.| -|normal_price|The normal price of the game.| -|nsuid|The Nintendo Switch unique ID of the game.| -|percent_off|The percentage off of the normal price.| -|sale_price|The sale price of the game.| -|title|The title of the game.| +| attribute | description | +| ------------ | ------------------------------------------ | +| box_art_url | The URL for the box art of the game. | +| normal_price | The normal price of the game. | +| nsuid | The Nintendo Switch unique ID of the game. | +| percent_off | The percentage off of the normal price. | +| sale_price | The sale price of the game. | +| title | The title of the game. | #### `sensor.nintendo_wishlist_` -A binary sensor will be created for each game on your wishlist. It's state will +A binary sensor will be created for each game on your wishlist. It's state will indicate if it is on sale or not. [![sensor.nintendo_wishlist_the_touryst](./assets/sensor.nintendo_wishlist_the_touryst.png)](./assets/sensor.nintendo_wishlist_the_touryst.png) @@ -122,15 +121,14 @@ indicate if it is on sale or not. The following state attributes are available for this sensor: -|attribute|description| -|-|-| -|matches|An array of [games on sale](#game-on-sale-object) that matched your wishlist search term.| - +| attribute | description | +| --------- | ----------------------------------------------------------------------------------------- | +| matches | An array of [games on sale](#game-on-sale-object) that matched your wishlist search term. | #### Example Node-RED Flow You can import an [example of a node-red flow](./assets/flow.json) that sends a -notification when an item on your wish list produces an on sale match. The flow +notification when an item on your wish list produces an on sale match. The flow will send a notification for each match. You can use the inject node to test the flow and customize it to your preferences.