Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.unifiprotect.switch Namespace Reference

Classes

class  ProtectBaseSwitch
 
class  ProtectNVRSwitch
 
class  ProtectPrivacyModeSwitch
 
class  ProtectSwitch
 
class  ProtectSwitchEntityDescription
 

Functions

None _set_highfps (Camera obj, bool value)
 
None async_setup_entry (HomeAssistant hass, UFPConfigEntry entry, AddEntitiesCallback async_add_entities)
 

Variables

string ATTR_PREV_MIC = "prev_mic_level"
 
string ATTR_PREV_RECORD = "prev_record_mode"
 
 PRIVACY_MODE_SWITCH
 

Detailed Description

Component providing Switches for UniFi Protect.

Function Documentation

◆ _set_highfps()

None homeassistant.components.unifiprotect.switch._set_highfps ( Camera  obj,
bool  value 
)
private

Definition at line 48 of file switch.py.

◆ async_setup_entry()

None homeassistant.components.unifiprotect.switch.async_setup_entry ( HomeAssistant  hass,
UFPConfigEntry  entry,
AddEntitiesCallback  async_add_entities 
)
Set up sensors for UniFi Protect integration.

Definition at line 568 of file switch.py.

Variable Documentation

◆ ATTR_PREV_MIC

string homeassistant.components.unifiprotect.switch.ATTR_PREV_MIC = "prev_mic_level"

Definition at line 37 of file switch.py.

◆ ATTR_PREV_RECORD

string homeassistant.components.unifiprotect.switch.ATTR_PREV_RECORD = "prev_record_mode"

Definition at line 38 of file switch.py.

◆ PRIVACY_MODE_SWITCH

homeassistant.components.unifiprotect.switch.PRIVACY_MODE_SWITCH
Initial value:
1 = ProtectSwitchEntityDescription[Camera](
2  key="privacy_mode",
3  name="Privacy mode",
4  icon="mdi:eye-settings",
5  entity_category=EntityCategory.CONFIG,
6  ufp_required_field="feature_flags.has_privacy_mask",
7  ufp_value="is_privacy_on",
8  ufp_perm=PermRequired.WRITE,
9 )

Definition at line 327 of file switch.py.