Inheritance diagram for homeassistant.components.syncthing.sensor.FolderSensor:

Collaboration diagram for homeassistant.components.syncthing.sensor.FolderSensor:

Public Member Functions
def	__init__ (self, syncthing, server_id, folder_id, folder_label, version)

None	async_added_to_hass (self)

def	async_update_status (self)

def	available (self)

def	extra_state_attributes (self)

def	native_value (self)

def	subscribe (self)

def	unsubscribe (self)

Public Member Functions inherited from homeassistant.components.sensor.SensorEntity
None	add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore\|None parallel_updates)

None	async_internal_added_to_hass (self)

None	async_registry_entry_updated (self)

dict[str, Any]\|None	capability_attributes (self)

SensorDeviceClass\|None	device_class (self)

er.EntityOptionsType\|None	get_initial_entity_options (self)

datetime\|None	last_reset (self)

str\|None	native_unit_of_measurement (self)

list[str]\|None	options (self)

Any	state (self)

dict[str, Any]\|None	state_attributes (self)

SensorStateClass\|str\|None	state_class (self)

int\|None	suggested_display_precision (self)

str\|None	suggested_unit_of_measurement (self)

str\|None	unit_of_measurement (self)

Public Member Functions inherited from homeassistant.helpers.entity.Entity
None	__init_subclass__ (cls, **Any kwargs)

str	__repr__ (self)

None	add_to_platform_abort (self)

None	add_to_platform_finish (self)

bool	assumed_state (self)

None	async_device_update (self, bool warning=True)

None	async_internal_will_remove_from_hass (self)

None	async_on_remove (self, CALLBACK_TYPE func)

None	async_remove (self, *bool force_remove=False)

None	async_removed_from_registry (self)

None	async_schedule_update_ha_state (self, bool force_refresh=False)

None	async_set_context (self, Context context)

None	async_update_ha_state (self, bool force_refresh=False)

None	async_will_remove_from_hass (self)

None	async_write_ha_state (self)

str\|None	attribution (self)

DeviceInfo\|None	device_info (self)

bool	enabled (self)

EntityCategory\|None	entity_category (self)

str\|None	entity_picture (self)

bool	entity_registry_enabled_default (self)

bool	entity_registry_visible_default (self)

bool	force_update (self)

HassJobType	get_hassjob_type (self, str function_name)

bool	has_entity_name (self)

str\|None	icon (self)

str\|UndefinedType\|None	name (self)

None	schedule_update_ha_state (self, bool force_refresh=False)

bool	should_poll (self)

str\|None	suggested_object_id (self)

int\|None	supported_features (self)

str\|None	translation_key (self)

Mapping[str, str]	translation_placeholders (self)

str\|None	unique_id (self)

bool	use_device_name (self)

Public Member Functions inherited from homeassistant.helpers.entity.CachedProperties
None	__init__ (cls, str name, tuple[type,...] bases, dict[Any, Any] namespace, **Any kwargs)

Any	__new__ (mcs, str name, tuple[type,...] bases, dict[Any, Any] namespace, set[str]\|None cached_properties=None, **Any kwargs)

Static Public Attributes
dictionary	STATE_ATTRIBUTES

Static Public Attributes inherited from homeassistant.components.sensor.SensorEntity
	Decimal

	None

	UndefinedType

Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool

	EntityPlatform

	HomeAssistant

	None

	StateInfo

	StateType

	str

Private Member Functions
def	_filter_state (self, state)

Private Attributes
	_attr_device_info

	_attr_name

	_attr_unique_id

	_folder_id

	_folder_label

	_server_id

	_short_server_id

	_state

	_syncthing

	_unsub_timer

Static Private Attributes
bool	_attr_should_poll = False

string	_attr_translation_key = "syncthing"

Additional Inherited Members
Public Attributes inherited from homeassistant.components.sensor.SensorEntity
	entity_category

	registry_entry

	unit_of_measurement

Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry

	entity_id

	hass

	parallel_updates

	platform

	registry_entry

Detailed Description

A Syncthing folder sensor.

Definition at line 54 of file sensor.py.

Constructor & Destructor Documentation

◆ init()

def homeassistant.components.syncthing.sensor.FolderSensor.__init__	(	self,
		syncthing,
		server_id,
		folder_id,
		folder_label,
		version
	)

Initialize the sensor.

Definition at line 88 of file sensor.py.

Member Function Documentation

◆ _filter_state()

def homeassistant.components.syncthing.sensor.FolderSensor._filter_state	(	self,
		state
	)

private

Definition at line 228 of file sensor.py.

◆ async_added_to_hass()

None homeassistant.components.syncthing.sensor.FolderSensor.async_added_to_hass ( self )

Handle entity which will be added.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 152 of file sensor.py.

◆ async_update_status()

def homeassistant.components.syncthing.sensor.FolderSensor.async_update_status ( self )

Request folder status and update state.

Definition at line 123 of file sensor.py.

◆ available()

def homeassistant.components.syncthing.sensor.FolderSensor.available ( self )

Could the device be accessed during the last update call.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 114 of file sensor.py.

◆ extra_state_attributes()

def homeassistant.components.syncthing.sensor.FolderSensor.extra_state_attributes ( self )

Return the state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 119 of file sensor.py.

◆ native_value()

def homeassistant.components.syncthing.sensor.FolderSensor.native_value ( self )

Return the state of the sensor.

Reimplemented from homeassistant.components.sensor.SensorEntity.

Definition at line 109 of file sensor.py.

◆ subscribe()

def homeassistant.components.syncthing.sensor.FolderSensor.subscribe ( self )

Start polling syncthing folder status.

Definition at line 133 of file sensor.py.

◆ unsubscribe()

def homeassistant.components.syncthing.sensor.FolderSensor.unsubscribe ( self )

Stop polling syncthing folder status.

Definition at line 146 of file sensor.py.

Member Data Documentation

◆ _attr_device_info

homeassistant.components.syncthing.sensor.FolderSensor._attr_device_info

private

Definition at line 100 of file sensor.py.

◆ _attr_name

homeassistant.components.syncthing.sensor.FolderSensor._attr_name

private

Definition at line 98 of file sensor.py.

◆ _attr_should_poll

bool homeassistant.components.syncthing.sensor.FolderSensor._attr_should_poll = False

staticprivate

Definition at line 57 of file sensor.py.

◆ _attr_translation_key

string homeassistant.components.syncthing.sensor.FolderSensor._attr_translation_key = "syncthing"

staticprivate

Definition at line 58 of file sensor.py.

◆ _attr_unique_id

homeassistant.components.syncthing.sensor.FolderSensor._attr_unique_id

private

Definition at line 99 of file sensor.py.

◆ _folder_id

homeassistant.components.syncthing.sensor.FolderSensor._folder_id

private

Definition at line 92 of file sensor.py.

◆ _folder_label

homeassistant.components.syncthing.sensor.FolderSensor._folder_label

private

Definition at line 93 of file sensor.py.

◆ _server_id

homeassistant.components.syncthing.sensor.FolderSensor._server_id

private

Definition at line 91 of file sensor.py.

◆ _short_server_id

homeassistant.components.syncthing.sensor.FolderSensor._short_server_id

private

Definition at line 97 of file sensor.py.

◆ _state

homeassistant.components.syncthing.sensor.FolderSensor._state

private

Definition at line 94 of file sensor.py.

◆ _syncthing

homeassistant.components.syncthing.sensor.FolderSensor._syncthing

private

Definition at line 90 of file sensor.py.

◆ _unsub_timer

homeassistant.components.syncthing.sensor.FolderSensor._unsub_timer

private

Definition at line 95 of file sensor.py.

◆ STATE_ATTRIBUTES

dictionary homeassistant.components.syncthing.sensor.FolderSensor.STATE_ATTRIBUTES

static

Initial value:

=  {
        "errors": "errors",
        "globalBytes": "global_bytes",
        "globalDeleted": "global_deleted",
        "globalDirectories": "global_directories",
        "globalFiles": "global_files",
        "globalSymlinks": "global_symlinks",
        "globalTotalItems": "global_total_items",
        "ignorePatterns": "ignore_patterns",
        "inSyncBytes": "in_sync_bytes",
        "inSyncFiles": "in_sync_files",
        "invalid": "invalid",
        "localBytes": "local_bytes",
        "localDeleted": "local_deleted",
        "localDirectories": "local_directories",
        "localFiles": "local_files",
        "localSymlinks": "local_symlinks",
        "localTotalItems": "local_total_items",
        "needBytes": "need_bytes",
        "needDeletes": "need_deletes",
        "needDirectories": "need_directories",
        "needFiles": "need_files",
        "needSymlinks": "need_symlinks",
        "needTotalItems": "need_total_items",
        "pullErrors": "pull_errors",
        "state": "state",
    }

Definition at line 60 of file sensor.py.

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

core/homeassistant/components/syncthing/sensor.py

Home Assistant Unofficial Reference 2024.12.1

Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _filter_state()

◆ async_added_to_hass()

◆ async_update_status()

◆ available()

◆ extra_state_attributes()

◆ native_value()

◆ subscribe()

◆ unsubscribe()

Member Data Documentation

◆ _attr_device_info

◆ _attr_name

◆ _attr_should_poll

◆ _attr_translation_key

◆ _attr_unique_id

◆ _folder_id

◆ _folder_label

◆ _server_id

◆ _short_server_id

◆ _state

◆ _syncthing

◆ _unsub_timer

◆ STATE_ATTRIBUTES

◆ init()