homeassistant.components.thread.dataset_store.DatasetStore Class Reference

Public Member Functions
None	__init__ (self, HomeAssistant hass)
None	async_add (self, str source, str tlv, str|None preferred_border_agent_id, str|None preferred_extended_address)
None	async_delete (self, str dataset_id)
DatasetEntry|None	async_get (self, str dataset_id)
None	async_load (self)
None	async_schedule_save (self)
None	async_set_preferred_border_agent (self, str dataset_id, str|None border_agent_id, str extended_address)
str|None	preferred_dataset (self)
None	preferred_dataset (self, str dataset_id)

Public Attributes
	datasets
	hass
	preferred_dataset

Private Member Functions
dict[str, list[dict[str, str|None]]]	_data_to_save (self)
None	_set_preferred_dataset_if_only_network (self, str dataset_id, str|None extended_address)

Private Attributes
	_preferred_dataset
	_set_preferred_dataset_task

Detailed Description

Class to hold a collection of thread datasets.

Definition at line 184 of file dataset_store.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.thread.dataset_store.DatasetStore.__init__	(		self,
		HomeAssistant	hass
	)

Initialize the dataset store.

Definition at line 187 of file dataset_store.py.

Member Function Documentation

_data_to_save()

dict[str, list[dict[str, str | None]]] homeassistant.components.thread.dataset_store.DatasetStore._data_to_save (   self )

private

Return data of datasets to store in a file.

Definition at line 444 of file dataset_store.py.

_set_preferred_dataset_if_only_network()

None homeassistant.components.thread.dataset_store.DatasetStore._set_preferred_dataset_if_only_network (   self, str  dataset_id, str | None   extended_address  )

private

Set the preferred dataset, unless there are other routers present.

Definition at line 359 of file dataset_store.py.

async_add()

None homeassistant.components.thread.dataset_store.DatasetStore.async_add	(		self,
		str	source,
		str	tlv,
		str | None	preferred_border_agent_id,
		str | None	preferred_extended_address
	)

Add dataset, does nothing if it already exists.

Definition at line 202 of file dataset_store.py.

async_delete()

None homeassistant.components.thread.dataset_store.DatasetStore.async_delete	(		self,
		str	dataset_id
	)

Delete dataset.

Definition at line 313 of file dataset_store.py.

async_get()

DatasetEntry | None homeassistant.components.thread.dataset_store.DatasetStore.async_get	(		self,
		str	dataset_id
	)

Get dataset by id.

Definition at line 321 of file dataset_store.py.

async_load()

None homeassistant.components.thread.dataset_store.DatasetStore.async_load

(

self

)

Load the datasets.

Definition at line 415 of file dataset_store.py.

async_schedule_save()

None homeassistant.components.thread.dataset_store.DatasetStore.async_schedule_save

(

self

)

Schedule saving the dataset store.

Definition at line 439 of file dataset_store.py.

async_set_preferred_border_agent()

None homeassistant.components.thread.dataset_store.DatasetStore.async_set_preferred_border_agent	(		self,
		str	dataset_id,
		str | None	border_agent_id,
		str	extended_address
	)

Set preferred border agent id and extended address of a dataset.

Definition at line 326 of file dataset_store.py.

preferred_dataset() [1/2]

str | None homeassistant.components.thread.dataset_store.DatasetStore.preferred_dataset

(

self

)

Get the id of the preferred dataset.

Definition at line 346 of file dataset_store.py.

preferred_dataset() [2/2]

None homeassistant.components.thread.dataset_store.DatasetStore.preferred_dataset	(		self,
		str	dataset_id
	)

Set the preferred dataset.

Definition at line 352 of file dataset_store.py.

Member Data Documentation

_preferred_dataset

homeassistant.components.thread.dataset_store.DatasetStore._preferred_dataset

private

Definition at line 315 of file dataset_store.py.

_set_preferred_dataset_task

homeassistant.components.thread.dataset_store.DatasetStore._set_preferred_dataset_task

private

Definition at line 306 of file dataset_store.py.

datasets

homeassistant.components.thread.dataset_store.DatasetStore.datasets

Definition at line 435 of file dataset_store.py.

hass

homeassistant.components.thread.dataset_store.DatasetStore.hass

Definition at line 189 of file dataset_store.py.

preferred_dataset

homeassistant.components.thread.dataset_store.DatasetStore.preferred_dataset

Definition at line 409 of file dataset_store.py.

---

The documentation for this class was generated from the following file:

• core/homeassistant/components/thread/dataset_store.py