2024-06-30 13:58:15 +02:00

1.6 KiB

title description ha_category ha_iot_class ha_release ha_quality_scale ha_domain ha_platforms ha_config_flow ha_integration_type related
One-Time Password (OTP) Instructions on how to add One-Time Password (OTP) sensors into Home Assistant.
Sensor
Utility
Local Polling 0.49 internal otp
sensor
true integration
docs title
/docs/configuration/ Configuration file

The otp {% term integration %} generates One-Time Passwords according to RFC6238 that is compatible with most OTP generators available, including Google Authenticator. You can use this when building custom security solutions and want to use "rolling codes", that change every 30 seconds.

{% include integrations/config_flow.md %}

Generating a token

A simple way to generate a token for a new sensor is to run this snippet of Python code in your Home Assistant virtual environment:

$ pip3 install pyotp
$ python3 -c 'import pyotp; print("Token:", pyotp.random_base32())'
Token: IHEDPEBEVA2WVHB7

To run in a Docker container:

$ docker exec -it home-assistant python -c 'import pyotp; print("Token:", pyotp.random_base32())'
Token: IHEDPEBEVA2WVHB7

Copy and paste the token into your Home Assistant configuration and add it to your OTP generator. Verify that they generate the same code.

{% important %} It is vital that your system clock is correct both on your Home Assistant instance and on your OTP generator device (e.g., your phone). If not, the generated codes will not match! Make sure NTP is running and syncing your time correctly before creating an issue. {% endimportant %}