Skip to content

A sensor that monitors a Nintendo Switch wish list for when games are on sale.

License

Notifications You must be signed in to change notification settings

custom-components/sensor.nintendo_wishlist

Repository files navigation

Nintendo Wishlist Component

hacs_badge

NOTE: This component currently only works in certain countries. See Supported Countries below.

Migrating to v3? See the migration guide.

Home Assistant component that keeps track of Nintendo Switch games that are on sale on your wish list in home assistant.

HACS Installation

  1. Search for Nintendo Wishlist Component in the HACS Store tab.
  2. Add the code to your configuration.yaml using the config options below.
  3. You will need to restart after installation for the component to start working.
  4. Display it in your lovelace UI using the nintendo-wishlist-card.
  5. Create an automation to notify you when a game on your wishlist goes on sale.

Configuration

Name Required Description
country yes The 2 letter country code. See 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 below.
scan_interval no The minimum time interval between updates. See time period dictionary below for an example of accepted values. Defaults to 1 hour.

Time Period Dictionary

scan_interval:
  # at least one of the following must be specified:
  days: 0
  hours: 0
  minutes: 3
  seconds: 30
  milliseconds: 0

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 be invalid in your configuration file.

nintendo_wishlist:
  country: US
  wishlist:
    - Katana ZERO
    - Shantae
    - OKAMI HD
    - Salt and Sanctuary
    - Dead Cells
    - Bloodstained
    - Dark Souls
    - Velocity X
    - "The Legend of Zelda: Breath of the Wild"

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

How wish list matching works

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 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 the e-shop (e.g. Shantae and the Pirate's Curse and Shantae: Half-Genie Hero.

Sensors

After you successfully setup the integration a number of sensors will be created.

sensor.nintendo_wishlist

This sensor will report the number of games on sale from your wishlist. This sensor can be used with the Nintendo Wishlist Custom Card.

sensor.nintendo_wishlist

Attributes

The following state attributes are available for this sensor:

attribute description
on_sale An array of games on sale.

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.

sensor.nintendo_wishlist_<title>

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

Attributes

The following state attributes are available for this sensor:

attribute description
matches An array of games on sale that matched your wishlist search term.

Example Node-RED Flow

You can import an example of a node-red flow that sends a 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.

Node-RED Flow

About

A sensor that monitors a Nintendo Switch wish list for when games are on sale.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages