homeassistant.components.folder.sensor Namespace Reference

Classes
class	Folder

Functions
list[str]	get_files_list (str folder_path, str filter_term)
int	get_size (list[str] files_list)
None	setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback add_entities, DiscoveryInfoType|None discovery_info=None)

Variables
	_LOGGER = logging.getLogger(__name__)
string	CONF_FILTER = "filter"
string	CONF_FOLDER_PATHS = "folder"
string	DEFAULT_FILTER = "*"
	PLATFORM_SCHEMA
	SCAN_INTERVAL = timedelta(minutes=1)

Detailed Description

Sensor for monitoring the contents of a folder.

Function Documentation

get_files_list()

list[str] homeassistant.components.folder.sensor.get_files_list	(	str	folder_path,
		str	filter_term
	)

Return the list of files, applying filter.

Definition at line 39 of file sensor.py.

get_size()

int homeassistant.components.folder.sensor.get_size

(

list[str]

files_list

)

Return the sum of the size in bytes of files in the list.

Definition at line 45 of file sensor.py.

setup_platform()

None homeassistant.components.folder.sensor.setup_platform	(	HomeAssistant	hass,
		ConfigType	config,
		AddEntitiesCallback	add_entities,
		DiscoveryInfoType | None	discovery_info = None
	)

Set up the folder sensor.

Definition at line 51 of file sensor.py.

Variable Documentation

_LOGGER

homeassistant.components.folder.sensor._LOGGER = logging.getLogger(__name__)

private

Definition at line 23 of file sensor.py.

CONF_FILTER

string homeassistant.components.folder.sensor.CONF_FILTER = "filter"

Definition at line 26 of file sensor.py.

CONF_FOLDER_PATHS

string homeassistant.components.folder.sensor.CONF_FOLDER_PATHS = "folder"

Definition at line 25 of file sensor.py.

DEFAULT_FILTER

string homeassistant.components.folder.sensor.DEFAULT_FILTER = "*"

Definition at line 27 of file sensor.py.

PLATFORM_SCHEMA

homeassistant.components.folder.sensor.PLATFORM_SCHEMA

Initial value:

=  SENSOR_PLATFORM_SCHEMA.extend(
    {
        vol.Required(CONF_FOLDER_PATHS): cv.isdir,
        vol.Optional(CONF_FILTER, default=DEFAULT_FILTER): cv.string,
    }
)

Definition at line 31 of file sensor.py.

SCAN_INTERVAL

homeassistant.components.folder.sensor.SCAN_INTERVAL = timedelta(minutes=1)

Definition at line 29 of file sensor.py.