Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.knx.project.KNXProject Class Reference

Public Member Functions

None __init__ (self, HomeAssistant hass, ConfigEntry entry)
 
GroupAddressType get_address_format (self)
 
KNXProjectModel|None get_knxproject (self)
 
None initial_state (self)
 
None load_project (self, XKNX xknx, KNXProjectModel|None data=None)
 
None process_project_file (self, XKNX xknx, str file_id, str password)
 
None remove_project_file (self)
 

Public Attributes

 devices
 
 group_addresses
 
 hass
 
 info
 
 loaded
 

Private Attributes

 _store
 

Detailed Description

Manage KNX project data.

Definition at line 61 of file project.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.knx.project.KNXProject.__init__ (   self,
HomeAssistant  hass,
ConfigEntry  entry 
)
Initialize project data.

Definition at line 69 of file project.py.

Member Function Documentation

◆ get_address_format()

GroupAddressType homeassistant.components.knx.project.KNXProject.get_address_format (   self)
Return the address format for group addresses used in the project.

Definition at line 139 of file project.py.

◆ get_knxproject()

KNXProjectModel | None homeassistant.components.knx.project.KNXProject.get_knxproject (   self)
Load the project file from local storage.

Definition at line 135 of file project.py.

◆ initial_state()

None homeassistant.components.knx.project.KNXProject.initial_state (   self)
Set initial state for project data.

Definition at line 80 of file project.py.

◆ load_project()

None homeassistant.components.knx.project.KNXProject.load_project (   self,
XKNX  xknx,
KNXProjectModel | None   data = None 
)
Load project data from storage.

Definition at line 87 of file project.py.

◆ process_project_file()

None homeassistant.components.knx.project.KNXProject.process_project_file (   self,
XKNX  xknx,
str  file_id,
str   password 
)
Process an uploaded project file.

Definition at line 112 of file project.py.

◆ remove_project_file()

None homeassistant.components.knx.project.KNXProject.remove_project_file (   self)
Remove project file from storage.

Definition at line 130 of file project.py.

Member Data Documentation

◆ _store

homeassistant.components.knx.project.KNXProject._store
private

Definition at line 76 of file project.py.

◆ devices

homeassistant.components.knx.project.KNXProject.devices

Definition at line 83 of file project.py.

◆ group_addresses

homeassistant.components.knx.project.KNXProject.group_addresses

Definition at line 84 of file project.py.

◆ hass

homeassistant.components.knx.project.KNXProject.hass

Definition at line 75 of file project.py.

◆ info

homeassistant.components.knx.project.KNXProject.info

Definition at line 85 of file project.py.

◆ loaded

homeassistant.components.knx.project.KNXProject.loaded

Definition at line 82 of file project.py.


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