jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-22 16:56:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Align documented camera attributes with implementation (#1913)

Browse Source
This commit is contained in:
Erik Montnemery 2023-09-15 12:20:03 +02:00 committed by GitHub
parent 8ff798ccf6
commit 64f8ea12b1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/core/entity/camera.md
View File

@ -11,17 +11,17 @@ A camera entity can display images, and optionally a video stream. Derive a plat
Properties should always only return information from memory and not do I/O (like network requests). Implement `update()` or `async_update()` to fetch data.
:::
| Name | Type | Default | Description |
| ------------------------ | ----- | ------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| is_recording | bool | `None` | Indication of whether the camera is recording. Used to determine `state`. |
| is_streaming | bool | `None` | Indication of whether the camera is streaming. Used to determine `state`. |
| motion_detection_enabled | bool | False | Indication of whether the camera has motion detection enabled. |
| is_on | bool | `None` | Indication camera is on. |
| brand | str | `None` | The brand (manufacturer) of the camera. |
| model | str | `None` | The model of the camera. |
| frame_interval | float | 0.5 | The interval between frames of the stream. |
| frontend_stream_type | str | None | Used with `CameraEntityFeature.STREAM` to tell the frontend which type of stream to use (`StreamType.HLS` or `StreamType.WEB_RTC`) |
| use_stream_for_stills | bool | False | Determines whether or not to use the `Stream` integration to generate still images |
| Name | Type | Default | Description |
| ------------------------ | ------------------------------------| ------- | --------------------------------------------------------------------------------------------------- |
| brand | <code>str &#124; None</code> | `None` | The brand (manufacturer) of the camera. |
| frame_interval | `float` | 0.5 | The interval between frames of the stream. |
| frontend_stream_type | <code>StreamType &#124; None</code> | `None` | Used with `CameraEntityFeature.STREAM` to tell the frontend which type of stream to use (`StreamType.HLS` or `StreamType.WEB_RTC`) |
| is_on | `bool` | `True` | Indication of whether the camera is on. |
| is_recording | `bool` | `False` | Indication of whether the camera is recording. Used to determine `state`. |
| is_streaming | `bool` | `False` | Indication of whether the camera is streaming. Used to determine `state`. |
| model | <code>str &#124; None</code> | `None` | The model of the camera. |
| motion_detection_enabled | `bool` | `False` | Indication of whether the camera has motion detection enabled. |
| use_stream_for_stills | `bool` | `False` | Determines whether or not to use the `Stream` integration to generate still images |
## Supported Features