diff --git a/source/_components/sensor.haveibeenpwned.markdown b/source/_components/sensor.haveibeenpwned.markdown new file mode 100644 index 00000000000..b808954459e --- /dev/null +++ b/source/_components/sensor.haveibeenpwned.markdown @@ -0,0 +1,46 @@ +--- +layout: page +title: "HaveIBeenPwned Sensor" +description: "Instructions how to integrate HaveIBeenPwned sensor into Home Assistant." +date: 2016-09-29 18:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: haveibeenpwned.png +ha_category: Sensor +ha_release: 0.31 +--- + +The `haveibeenpwned` sensor platform creates sensors that check for breached email accounts on [haveibeenpwned](https://haveibeenpwned.com). +To enable this sensor, add the following lines to your `configuration.yaml`, it will list every specified email address as a sensor showing +the number of breaches on that email account: + +```yaml +# Example configuration.yaml entry using cloud based emoncms +sensor: + platform: haveibeenpwned + email: + - your_email1@domain.com + - your_email2@domain.com +``` + +## {% linkable_title Breach meta data %} + +If one of your email accounts is breached the sensor will display breach meta data. It will list the title of the site where your email +account has been breached as well as the added date of the breach data. This data is displayed in descending order so that the state attribute +`breach 1` will always contain the last known breach for the specific email account, if there are any breaches detected. + +

+ +

+ +## {% linkable_title Configuration variables %} + +- **email** (*Required*): List of email addresses. + +

+ The sensor will scan all email addresses specified with a 5 second delay between all breach data requests on Home Assistant startup. + After this initial startup scanning, the sensor will only scan one email account per 15 minutes to prevent abuse, and not hammer "the + Have I been Pwned" service, as this breach data almost never changes. +

diff --git a/source/images/components/haveibeenpwned/sensor.png b/source/images/components/haveibeenpwned/sensor.png new file mode 100644 index 00000000000..1fd4f7598a4 Binary files /dev/null and b/source/images/components/haveibeenpwned/sensor.png differ diff --git a/source/images/supported_brands/haveibeenpwned.png b/source/images/supported_brands/haveibeenpwned.png new file mode 100644 index 00000000000..6848ed88fe9 Binary files /dev/null and b/source/images/supported_brands/haveibeenpwned.png differ