homeassistant.components.withings Namespace Reference

Namespaces
	application_credentials
	binary_sensor
	calendar
	config_flow
	const
	coordinator
	diagnostics
	entity
	sensor

Classes
class	WithingsData
class	WithingsWebhookManager

Functions
str	_async_cloudhook_generate_url (HomeAssistant hass, WithingsConfigEntry entry)
None	async_remove_entry (HomeAssistant hass, WithingsConfigEntry entry)
bool	async_setup_entry (HomeAssistant hass, WithingsConfigEntry entry)
None	async_subscribe_webhooks (WithingsClient client, str webhook_url)
bool	async_unload_entry (HomeAssistant hass, WithingsConfigEntry entry)
None	async_unsubscribe_webhooks (WithingsClient client)
Callable[[HomeAssistant, str, Request], Awaitable[Response|None]]	get_webhook_handler (WithingsData withings_data)
Response	json_message_response (str message, int message_code)

Variables
string	CONF_CLOUDHOOK_URL = "cloudhook_url"
list	PLATFORMS = [Platform.BINARY_SENSOR, Platform.CALENDAR, Platform.SENSOR]
	SUBSCRIBE_DELAY = timedelta(seconds=5)
	UNSUBSCRIBE_DELAY = timedelta(seconds=1)
	WithingsConfigEntry

Detailed Description

Support for the Withings API.

For more details about this platform, please refer to the documentation at

Function Documentation

_async_cloudhook_generate_url()

str homeassistant.components.withings._async_cloudhook_generate_url ( HomeAssistant  hass, WithingsConfigEntry   entry  )

private

Generate the full URL for a webhook_id.

Definition at line 303 of file __init__.py.

async_remove_entry()

None homeassistant.components.withings.async_remove_entry	(	HomeAssistant	hass,
		WithingsConfigEntry	entry
	)

Cleanup when entry is removed.

Definition at line 320 of file __init__.py.

async_setup_entry()

bool homeassistant.components.withings.async_setup_entry	(	HomeAssistant	hass,
		WithingsConfigEntry	entry
	)

Set up Withings from a config entry.

Definition at line 93 of file __init__.py.

async_subscribe_webhooks()

None homeassistant.components.withings.async_subscribe_webhooks	(	WithingsClient	client,
		str	webhook_url
	)

Subscribe to Withings webhooks.

Definition at line 174 of file __init__.py.

async_unload_entry()

bool homeassistant.components.withings.async_unload_entry	(	HomeAssistant	hass,
		WithingsConfigEntry	entry
	)

Unload Withings config entry.

Definition at line 167 of file __init__.py.

async_unsubscribe_webhooks()

None homeassistant.components.withings.async_unsubscribe_webhooks

(

WithingsClient

client

)

Unsubscribe to all Withings webhooks.

Definition at line 279 of file __init__.py.

get_webhook_handler()

Callable[[HomeAssistant, str, Request], Awaitable[Response | None]] homeassistant.components.withings.get_webhook_handler

(

WithingsData

withings_data

)

Return webhook handler.

Definition at line 337 of file __init__.py.

json_message_response()

Response homeassistant.components.withings.json_message_response	(	str	message,
		int	message_code
	)

Produce common json output.

Definition at line 332 of file __init__.py.

Variable Documentation

CONF_CLOUDHOOK_URL

string homeassistant.components.withings.CONF_CLOUDHOOK_URL = "cloudhook_url"

Definition at line 62 of file __init__.py.

PLATFORMS

list homeassistant.components.withings.PLATFORMS = [Platform.BINARY_SENSOR, Platform.CALENDAR, Platform.SENSOR]

Definition at line 58 of file __init__.py.

SUBSCRIBE_DELAY

homeassistant.components.withings.SUBSCRIBE_DELAY = timedelta(seconds=5)

Definition at line 60 of file __init__.py.

UNSUBSCRIBE_DELAY

homeassistant.components.withings.UNSUBSCRIBE_DELAY = timedelta(seconds=1)

Definition at line 61 of file __init__.py.

WithingsConfigEntry

homeassistant.components.withings.WithingsConfigEntry

Definition at line 63 of file __init__.py.