Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.haveibeenpwned.sensor Namespace Reference

Classes

class  HaveIBeenPwnedData
 
class  HaveIBeenPwnedSensor
 

Functions

None setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback add_entities, DiscoveryInfoType|None discovery_info=None)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
string DATE_STR_FORMAT = "%Y-%m-%d %H:%M:%S"
 
string HA_USER_AGENT = "Home Assistant HaveIBeenPwned Sensor Component"
 
 MIN_TIME_BETWEEN_FORCED_UPDATES = timedelta(seconds=5)
 
 MIN_TIME_BETWEEN_UPDATES = timedelta(minutes=15)
 
 PLATFORM_SCHEMA
 
string URL = "https://haveibeenpwned.com/api/v3/breachedaccount/"
 

Detailed Description

Support for haveibeenpwned (email breaches) sensor.

Function Documentation

◆ setup_platform()

None homeassistant.components.haveibeenpwned.sensor.setup_platform ( HomeAssistant  hass,
ConfigType  config,
AddEntitiesCallback  add_entities,
DiscoveryInfoType | None   discovery_info = None 
)
Set up the HaveIBeenPwned sensor.

Definition at line 44 of file sensor.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.haveibeenpwned.sensor._LOGGER = logging.getLogger(__name__)
private

Definition at line 25 of file sensor.py.

◆ DATE_STR_FORMAT

string homeassistant.components.haveibeenpwned.sensor.DATE_STR_FORMAT = "%Y-%m-%d %H:%M:%S"

Definition at line 27 of file sensor.py.

◆ HA_USER_AGENT

string homeassistant.components.haveibeenpwned.sensor.HA_USER_AGENT = "Home Assistant HaveIBeenPwned Sensor Component"

Definition at line 29 of file sensor.py.

◆ MIN_TIME_BETWEEN_FORCED_UPDATES

homeassistant.components.haveibeenpwned.sensor.MIN_TIME_BETWEEN_FORCED_UPDATES = timedelta(seconds=5)

Definition at line 31 of file sensor.py.

◆ MIN_TIME_BETWEEN_UPDATES

homeassistant.components.haveibeenpwned.sensor.MIN_TIME_BETWEEN_UPDATES = timedelta(minutes=15)

Definition at line 32 of file sensor.py.

◆ PLATFORM_SCHEMA

homeassistant.components.haveibeenpwned.sensor.PLATFORM_SCHEMA
Initial value:
1 = SENSOR_PLATFORM_SCHEMA.extend(
2  {
3  vol.Required(CONF_EMAIL): vol.All(cv.ensure_list, [cv.string]),
4  vol.Required(CONF_API_KEY): cv.string,
5  }
6 )

Definition at line 36 of file sensor.py.

◆ URL

string homeassistant.components.haveibeenpwned.sensor.URL = "https://haveibeenpwned.com/api/v3/breachedaccount/"

Definition at line 34 of file sensor.py.