Nintendo Switch parental controls
The Nintendo Switch Parental Controls integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] integrates with the Nintendo Switch Parental Controls service, allowing parents to monitor and control screentime for their children.
Supported devices
Devices supported by the Nintendo Switch Parental Controls mobile app are supported by this integration.
Prerequisites
To use the Nintendo Switch Parental Controls integration, you must access your Nintendo account’s authentication tokens. This process must be performed on a device without the official Nintendo Switch Parental Controls mobile app installed. The integration needs to intercept the authentication flow, which the app typically handles automatically.
You will need:
- Your Nintendo account credentials.
- A computer or mobile device without the official app installed.
Configuration
-
In the Home Assistant UI, go to Settings > Devices & services.
-
Select Add integration and search for Nintendo Switch Parental Controls.
-
You will be prompted to provide an Access token. Select the link provided in the dialog description. This link is unique to your setup session.
-
A new browser tab will open. Log in to your Nintendo account using your credentials.
-
After successful login, you will see a Linking an External Account screen. For the Nintendo account you wish to link, right-click the red button Select this person and choose Copy Link (or Copy Link Address / Copy URL depending on your browser).
-
Important: Do not select the button directly, as this can redirect you and prevent you from getting the necessary token.
-
The copied link should have a format similar to
npf54789befxxxxxxxx://auth#session_token_code={redacted}&state={redacted}&session_state={redacted}.
-
-
Close the Nintendo Account browser tab.
-
Paste the entire copied link (the full string) into the Access Token field in the Home Assistant configuration dialog.
-
Select Submit.
-
The configuration flow should then present additional options.
-
Select Submit to finalize the setup.
Supported functionality
Entities
The Nintendo Switch Parental Controls integration provides the following entities.
Sensors
-
Used screen time
- Description: The current used screen time for a given device.
-
Unit of measurement:
minutes -
Device class:
duration
-
Time remaining
- Description: The amount total amount of time remaining for a device.
-
Unit of measurement:
minutes -
Device class:
duration
Time
-
Bedtime alarm
- Description: A set bedtime for a given device, at this time, the Switch can either “lock” or show an alert in the top left corner.
Switch
-
Suspend software
- Description: Enable to automatically suspend running software when the Bedtime alarm is reached or the maximum screen time is exceeded. Turn off to allow software to continue running past these limits.
Number
-
Max screentime today
-
Description: Maximum amount of screentime to allow today, for unlimited screentime, set to
-1. By setting this to0and turning the Suspend software switch on, you can ‘lock’ your Nintendo Switch.
-
Description: Maximum amount of screentime to allow today, for unlimited screentime, set to
Actions
The integration provides the following actions.
Action: Add bonus time
The nintendo_parental_controls.add_bonus_time action adds additional bonus screen time to a specified device, which is granted outside of the maximum allowed screentime.
-
Data attribute:
config_entry_id- Description: The ID of the config entry containing the device to grant bonus time.
- Optional: No
-
Data attribute:
device_id- Description: The ID of the device to grant bonus time.
- Optional: No
-
Data attribute:
bonus_time- Description: The amount of time in minutes to grant (minimum of 5, maximum of 30).
- Optional: No
Known limitations
The integration currently does not provide all the functionality found in the mobile app. Future updates will see this extended.
Further, this integration relies on the cloud and cannot make a local connection to your Switch.
The range used for bonus time is set by Nintendo and therefore cannot be changed.
Troubleshooting
Data is not updating in Home Assistant
Make sure the Switch has access to the internet, without this, usage data is not being sent to Nintendo.
Removing the integration
This integration follows standard integration removal.
To remove an integration instance from Home Assistant
- Go to Settings > Devices & services and select the integration card.
- From the list of devices, select the integration instance you want to remove.
- Next to the entry, select the three dots
menu. Then, select Delete.