Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.rachio.webhooks Namespace Reference

Functions

str async_get_or_create_registered_webhook_id_and_url (HomeAssistant hass, ConfigEntry entry)
 
None async_register_webhook (HomeAssistant hass, ConfigEntry entry)
 
None async_unregister_webhook (HomeAssistant hass, ConfigEntry entry)
 

Variables

list LISTEN_EVENT_TYPES
 
dictionary SIGNAL_MAP
 
string SUBTYPE_BROWNOUT_VALVE = "BROWNOUT_VALVE"
 
string SUBTYPE_COLD_REBOOT = "COLD_REBOOT"
 
string SUBTYPE_OFFLINE = "OFFLINE"
 
string SUBTYPE_OFFLINE_NOTIFICATION = "OFFLINE_NOTIFICATION"
 
string SUBTYPE_ONLINE = "ONLINE"
 
string SUBTYPE_RAIN_DELAY_OFF = "RAIN_DELAY_OFF"
 
string SUBTYPE_RAIN_DELAY_ON = "RAIN_DELAY_ON"
 
string SUBTYPE_RAIN_SENSOR_DETECTION_OFF = "RAIN_SENSOR_DETECTION_OFF"
 
string SUBTYPE_RAIN_SENSOR_DETECTION_ON = "RAIN_SENSOR_DETECTION_ON"
 
string SUBTYPE_SCHEDULE_COMPLETED = "SCHEDULE_COMPLETED"
 
string SUBTYPE_SCHEDULE_STARTED = "SCHEDULE_STARTED"
 
string SUBTYPE_SCHEDULE_STOPPED = "SCHEDULE_STOPPED"
 
string SUBTYPE_SLEEP_MODE_OFF = "SLEEP_MODE_OFF"
 
string SUBTYPE_SLEEP_MODE_ON = "SLEEP_MODE_ON"
 
string SUBTYPE_WEATHER_CLIMATE_SKIP = "WEATHER_INTELLIGENCE_CLIMATE_SKIP"
 
string SUBTYPE_WEATHER_FREEZE = "WEATHER_INTELLIGENCE_FREEZE"
 
string SUBTYPE_WEATHER_NO_SKIP = "WEATHER_INTELLIGENCE_NO_SKIP"
 
string SUBTYPE_WEATHER_SKIP = "WEATHER_INTELLIGENCE_SKIP"
 
string SUBTYPE_ZONE_COMPLETED = "ZONE_COMPLETED"
 
string SUBTYPE_ZONE_CYCLING = "ZONE_CYCLING"
 
string SUBTYPE_ZONE_CYCLING_COMPLETED = "ZONE_CYCLING_COMPLETED"
 
string SUBTYPE_ZONE_PAUSED = "ZONE_PAUSED"
 
string SUBTYPE_ZONE_STARTED = "ZONE_STARTED"
 
string SUBTYPE_ZONE_STOPPED = "ZONE_STOPPED"
 
string TYPE_CONTROLLER_STATUS = "DEVICE_STATUS"
 
string TYPE_RAIN_DELAY_STATUS = "RAIN_DELAY"
 
string TYPE_RAIN_SENSOR_STATUS = "RAIN_SENSOR_DETECTION"
 
string TYPE_SCHEDULE_STATUS = "SCHEDULE_STATUS"
 
string TYPE_ZONE_STATUS = "ZONE_STATUS"
 
string WEBHOOK_CONST_ID = "homeassistant.rachio:"
 
 WEBHOOK_PATH = URL_API + DOMAIN
 

Detailed Description

Webhooks used by rachio.

Function Documentation

◆ async_get_or_create_registered_webhook_id_and_url()

str homeassistant.components.rachio.webhooks.async_get_or_create_registered_webhook_id_and_url ( HomeAssistant  hass,
ConfigEntry   entry 
)
Generate webhook url.

Definition at line 123 of file webhooks.py.

◆ async_register_webhook()

None homeassistant.components.rachio.webhooks.async_register_webhook ( HomeAssistant  hass,
ConfigEntry  entry 
)
Register a webhook.

Definition at line 86 of file webhooks.py.

◆ async_unregister_webhook()

None homeassistant.components.rachio.webhooks.async_unregister_webhook ( HomeAssistant  hass,
ConfigEntry  entry 
)
Unregister a webhook.

Definition at line 117 of file webhooks.py.

Variable Documentation

◆ LISTEN_EVENT_TYPES

list homeassistant.components.rachio.webhooks.LISTEN_EVENT_TYPES
Initial value:
1 = [
2  "DEVICE_STATUS_EVENT",
3  "ZONE_STATUS_EVENT",
4  "RAIN_DELAY_EVENT",
5  "RAIN_SENSOR_DETECTION_EVENT",
6  "SCHEDULE_STATUS_EVENT",
7 ]

Definition at line 66 of file webhooks.py.

◆ SIGNAL_MAP

dictionary homeassistant.components.rachio.webhooks.SIGNAL_MAP
Initial value:
1 = {
2  TYPE_CONTROLLER_STATUS: SIGNAL_RACHIO_CONTROLLER_UPDATE,
3  TYPE_RAIN_DELAY_STATUS: SIGNAL_RACHIO_RAIN_DELAY_UPDATE,
4  TYPE_RAIN_SENSOR_STATUS: SIGNAL_RACHIO_RAIN_SENSOR_UPDATE,
5  TYPE_SCHEDULE_STATUS: SIGNAL_RACHIO_SCHEDULE_UPDATE,
6  TYPE_ZONE_STATUS: SIGNAL_RACHIO_ZONE_UPDATE,
7 }

Definition at line 76 of file webhooks.py.

◆ SUBTYPE_BROWNOUT_VALVE

string homeassistant.components.rachio.webhooks.SUBTYPE_BROWNOUT_VALVE = "BROWNOUT_VALVE"

Definition at line 34 of file webhooks.py.

◆ SUBTYPE_COLD_REBOOT

string homeassistant.components.rachio.webhooks.SUBTYPE_COLD_REBOOT = "COLD_REBOOT"

Definition at line 31 of file webhooks.py.

◆ SUBTYPE_OFFLINE

string homeassistant.components.rachio.webhooks.SUBTYPE_OFFLINE = "OFFLINE"

Definition at line 28 of file webhooks.py.

◆ SUBTYPE_OFFLINE_NOTIFICATION

string homeassistant.components.rachio.webhooks.SUBTYPE_OFFLINE_NOTIFICATION = "OFFLINE_NOTIFICATION"

Definition at line 30 of file webhooks.py.

◆ SUBTYPE_ONLINE

string homeassistant.components.rachio.webhooks.SUBTYPE_ONLINE = "ONLINE"

Definition at line 29 of file webhooks.py.

◆ SUBTYPE_RAIN_DELAY_OFF

string homeassistant.components.rachio.webhooks.SUBTYPE_RAIN_DELAY_OFF = "RAIN_DELAY_OFF"

Definition at line 39 of file webhooks.py.

◆ SUBTYPE_RAIN_DELAY_ON

string homeassistant.components.rachio.webhooks.SUBTYPE_RAIN_DELAY_ON = "RAIN_DELAY_ON"

Definition at line 38 of file webhooks.py.

◆ SUBTYPE_RAIN_SENSOR_DETECTION_OFF

string homeassistant.components.rachio.webhooks.SUBTYPE_RAIN_SENSOR_DETECTION_OFF = "RAIN_SENSOR_DETECTION_OFF"

Definition at line 44 of file webhooks.py.

◆ SUBTYPE_RAIN_SENSOR_DETECTION_ON

string homeassistant.components.rachio.webhooks.SUBTYPE_RAIN_SENSOR_DETECTION_ON = "RAIN_SENSOR_DETECTION_ON"

Definition at line 43 of file webhooks.py.

◆ SUBTYPE_SCHEDULE_COMPLETED

string homeassistant.components.rachio.webhooks.SUBTYPE_SCHEDULE_COMPLETED = "SCHEDULE_COMPLETED"

Definition at line 50 of file webhooks.py.

◆ SUBTYPE_SCHEDULE_STARTED

string homeassistant.components.rachio.webhooks.SUBTYPE_SCHEDULE_STARTED = "SCHEDULE_STARTED"

Definition at line 48 of file webhooks.py.

◆ SUBTYPE_SCHEDULE_STOPPED

string homeassistant.components.rachio.webhooks.SUBTYPE_SCHEDULE_STOPPED = "SCHEDULE_STOPPED"

Definition at line 49 of file webhooks.py.

◆ SUBTYPE_SLEEP_MODE_OFF

string homeassistant.components.rachio.webhooks.SUBTYPE_SLEEP_MODE_OFF = "SLEEP_MODE_OFF"

Definition at line 33 of file webhooks.py.

◆ SUBTYPE_SLEEP_MODE_ON

string homeassistant.components.rachio.webhooks.SUBTYPE_SLEEP_MODE_ON = "SLEEP_MODE_ON"

Definition at line 32 of file webhooks.py.

◆ SUBTYPE_WEATHER_CLIMATE_SKIP

string homeassistant.components.rachio.webhooks.SUBTYPE_WEATHER_CLIMATE_SKIP = "WEATHER_INTELLIGENCE_CLIMATE_SKIP"

Definition at line 53 of file webhooks.py.

◆ SUBTYPE_WEATHER_FREEZE

string homeassistant.components.rachio.webhooks.SUBTYPE_WEATHER_FREEZE = "WEATHER_INTELLIGENCE_FREEZE"

Definition at line 54 of file webhooks.py.

◆ SUBTYPE_WEATHER_NO_SKIP

string homeassistant.components.rachio.webhooks.SUBTYPE_WEATHER_NO_SKIP = "WEATHER_INTELLIGENCE_NO_SKIP"

Definition at line 51 of file webhooks.py.

◆ SUBTYPE_WEATHER_SKIP

string homeassistant.components.rachio.webhooks.SUBTYPE_WEATHER_SKIP = "WEATHER_INTELLIGENCE_SKIP"

Definition at line 52 of file webhooks.py.

◆ SUBTYPE_ZONE_COMPLETED

string homeassistant.components.rachio.webhooks.SUBTYPE_ZONE_COMPLETED = "ZONE_COMPLETED"

Definition at line 60 of file webhooks.py.

◆ SUBTYPE_ZONE_CYCLING

string homeassistant.components.rachio.webhooks.SUBTYPE_ZONE_CYCLING = "ZONE_CYCLING"

Definition at line 61 of file webhooks.py.

◆ SUBTYPE_ZONE_CYCLING_COMPLETED

string homeassistant.components.rachio.webhooks.SUBTYPE_ZONE_CYCLING_COMPLETED = "ZONE_CYCLING_COMPLETED"

Definition at line 62 of file webhooks.py.

◆ SUBTYPE_ZONE_PAUSED

string homeassistant.components.rachio.webhooks.SUBTYPE_ZONE_PAUSED = "ZONE_PAUSED"

Definition at line 63 of file webhooks.py.

◆ SUBTYPE_ZONE_STARTED

string homeassistant.components.rachio.webhooks.SUBTYPE_ZONE_STARTED = "ZONE_STARTED"

Definition at line 58 of file webhooks.py.

◆ SUBTYPE_ZONE_STOPPED

string homeassistant.components.rachio.webhooks.SUBTYPE_ZONE_STOPPED = "ZONE_STOPPED"

Definition at line 59 of file webhooks.py.

◆ TYPE_CONTROLLER_STATUS

string homeassistant.components.rachio.webhooks.TYPE_CONTROLLER_STATUS = "DEVICE_STATUS"

Definition at line 27 of file webhooks.py.

◆ TYPE_RAIN_DELAY_STATUS

string homeassistant.components.rachio.webhooks.TYPE_RAIN_DELAY_STATUS = "RAIN_DELAY"

Definition at line 37 of file webhooks.py.

◆ TYPE_RAIN_SENSOR_STATUS

string homeassistant.components.rachio.webhooks.TYPE_RAIN_SENSOR_STATUS = "RAIN_SENSOR_DETECTION"

Definition at line 42 of file webhooks.py.

◆ TYPE_SCHEDULE_STATUS

string homeassistant.components.rachio.webhooks.TYPE_SCHEDULE_STATUS = "SCHEDULE_STATUS"

Definition at line 47 of file webhooks.py.

◆ TYPE_ZONE_STATUS

string homeassistant.components.rachio.webhooks.TYPE_ZONE_STATUS = "ZONE_STATUS"

Definition at line 57 of file webhooks.py.

◆ WEBHOOK_CONST_ID

string homeassistant.components.rachio.webhooks.WEBHOOK_CONST_ID = "homeassistant.rachio:"

Definition at line 73 of file webhooks.py.

◆ WEBHOOK_PATH

homeassistant.components.rachio.webhooks.WEBHOOK_PATH = URL_API + DOMAIN

Definition at line 74 of file webhooks.py.