Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.motioneye Namespace Reference

Namespaces

 camera
 
 config_flow
 
 const
 
 entity
 
 media_source
 
 sensor
 
 switch
 

Functions

None _add_camera (HomeAssistant hass, dr.DeviceRegistry device_registry, MotionEyeClient client, ConfigEntry entry, int camera_id, dict[str, Any] camera, tuple[str, str] device_identifier)
 
None _async_entry_updated (HomeAssistant hass, ConfigEntry config_entry)
 
dict[str, str] _get_media_event_data (HomeAssistant hass, dr.DeviceEntry device, str event_file_path, int event_file_type)
 
str|None async_generate_motioneye_webhook (HomeAssistant hass, str webhook_id)
 
bool async_setup_entry (HomeAssistant hass, ConfigEntry entry)
 
bool async_unload_entry (HomeAssistant hass, ConfigEntry entry)
 
MotionEyeClient create_motioneye_client (*Any args, **Any kwargs)
 
dict[str, Any]|None get_camera_from_cameras (int camera_id, dict[str, Any]|None data)
 
str|None get_media_url (MotionEyeClient client, int camera_id, str path, bool image)
 
tuple[str, str] get_motioneye_device_identifier (str config_entry_id, int camera_id)
 
Response|None handle_webhook (HomeAssistant hass, str webhook_id, Request request)
 
bool is_acceptable_camera (dict[str, Any]|None camera)
 
None listen_for_new_cameras (HomeAssistant hass, ConfigEntry entry, Callable add_func)
 
tuple[str, str, int]|None split_motioneye_device_identifier (tuple[str, str] identifier)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
list PLATFORMS = [CAMERA_DOMAIN, SENSOR_DOMAIN, SWITCH_DOMAIN]
 

Detailed Description

The motionEye integration.

Function Documentation

◆ _add_camera()

None homeassistant.components.motioneye._add_camera ( HomeAssistant  hass,
dr.DeviceRegistry  device_registry,
MotionEyeClient  client,
ConfigEntry  entry,
int  camera_id,
dict[str, Any]  camera,
tuple[str, str]  device_identifier 
)
private
Add a motionEye camera to hass.

Definition at line 170 of file __init__.py.

◆ _async_entry_updated()

None homeassistant.components.motioneye._async_entry_updated ( HomeAssistant  hass,
ConfigEntry  config_entry 
)
private
Handle entry updates.

Definition at line 280 of file __init__.py.

◆ _get_media_event_data()

dict[str, str] homeassistant.components.motioneye._get_media_event_data ( HomeAssistant  hass,
dr.DeviceEntry  device,
str  event_file_path,
int  event_file_type 
)
private

Definition at line 459 of file __init__.py.

◆ async_generate_motioneye_webhook()

str | None homeassistant.components.motioneye.async_generate_motioneye_webhook ( HomeAssistant  hass,
str   webhook_id 
)
Generate the full local URL for a webhook_id.

Definition at line 155 of file __init__.py.

◆ async_setup_entry()

bool homeassistant.components.motioneye.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Set up motionEye from a config entry.

Definition at line 285 of file __init__.py.

◆ async_unload_entry()

bool homeassistant.components.motioneye.async_unload_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Unload a config entry.

Definition at line 390 of file __init__.py.

◆ create_motioneye_client()

MotionEyeClient homeassistant.components.motioneye.create_motioneye_client ( *Any  args,
**Any  kwargs 
)
Create a MotionEyeClient.

Definition at line 92 of file __init__.py.

◆ get_camera_from_cameras()

dict[str, Any] | None homeassistant.components.motioneye.get_camera_from_cameras ( int  camera_id,
dict[str, Any] | None   data 
)
Get an individual camera dict from a multiple cameras data response.

Definition at line 121 of file __init__.py.

◆ get_media_url()

str | None homeassistant.components.motioneye.get_media_url ( MotionEyeClient  client,
int  camera_id,
str  path,
bool   image 
)
Get the URL for a motionEye media item.

Definition at line 511 of file __init__.py.

◆ get_motioneye_device_identifier()

tuple[str, str] homeassistant.components.motioneye.get_motioneye_device_identifier ( str  config_entry_id,
int   camera_id 
)
Get the identifiers for a motionEye device.

Definition at line 100 of file __init__.py.

◆ handle_webhook()

Response | None homeassistant.components.motioneye.handle_webhook ( HomeAssistant  hass,
str  webhook_id,
Request   request 
)
Handle webhook callback.

Definition at line 402 of file __init__.py.

◆ is_acceptable_camera()

bool homeassistant.components.motioneye.is_acceptable_camera ( dict[str, Any] | None  camera)
Determine if a camera dict is acceptable.

Definition at line 132 of file __init__.py.

◆ listen_for_new_cameras()

None homeassistant.components.motioneye.listen_for_new_cameras ( HomeAssistant  hass,
ConfigEntry  entry,
Callable  add_func 
)
Listen for new cameras.

Definition at line 138 of file __init__.py.

◆ split_motioneye_device_identifier()

tuple[str, str, int] | None homeassistant.components.motioneye.split_motioneye_device_identifier ( tuple[str, str]  identifier)
Get the identifiers for a motionEye device.

Definition at line 107 of file __init__.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.motioneye._LOGGER = logging.getLogger(__name__)
private

Definition at line 88 of file __init__.py.

◆ PLATFORMS

list homeassistant.components.motioneye.PLATFORMS = [CAMERA_DOMAIN, SENSOR_DOMAIN, SWITCH_DOMAIN]

Definition at line 89 of file __init__.py.