Picture glance card: procedure showing how to use card to PTZ control a camera (#29954)

* Picture glance card: PTZ camera control

- add procedure how to use card for panning camera
- add links to procedure from camera integrations that support PTZ
- add abbreviation tag to PTZ

* Rephrase

* Fix typo

* Add title back in - Feedback by starkillerOG
This commit is contained in:
c0ffeeca7 2023-11-22 11:42:23 +01:00 committed by GitHub
parent 9b76d2c63a
commit dd8db242a6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 97 additions and 15 deletions

View File

@ -5,7 +5,7 @@ sidebar_label: Picture glance
description: "The picture glance card shows an image and corresponding entity states as an icon. The entities on the right side allow toggle actions, others show the more information dialog."
---
The picture glance card shows an image and corresponding entity states as an icon. The entities on the right side allow toggle actions, others show the more information dialog.
The picture glance card shows an image and lets you place small icons of entity states on top of that card to control those entities from there. In the image below: the entities on the right allow toggle actions, the others show the more information dialog.
<p class='img'>
<img src='/images/dashboards/picture_glance.gif' alt='Picture glance card for a living room'>
@ -154,6 +154,74 @@ entity: switch.decorative_lights
### Examples
This section lists a few examples of how the picture glance card can be used.
### Creating a card to control the camera
If your camera supports <abbr title="pan, tilt, and zoom">PTZ</abbr> (can be moved in different directions), you can use the picture glance card to control the camera.
<p class='img'>
<img src='/images/dashboards/picture_glance_camera_control.gif' alt='Picture glance card to control the camera'>
Picture glance card to control the camera.
</p>
1. Select your camera entity.
- **Image path** and **Image entity** are not required.
![Select camera entity](/images/dashboards/picture_glance_card_select_camera_entity.png)
2. If you want something to happen when you tap the card itself, define a tap action.
- Here, we toggle a light.
![Select camera entity](/images/dashboards/picture_glance_card_define_tap_action.png)
3. Select the entities to move the camera left, right, up, or down.
![Select camera entity](/images/dashboards/picture_glance_card_select_camera_arrows.png)
4. Select **Show code editor**.
5. For each of the entities, specify an icon, as indicated in the YAML example.
6. For the buttons to react on press (instead of bringing up the dialog):
- For each of the entities, under `tap_action`, call a `button.press` service.
```yaml
camera_view: live
type: picture-glance
title: Desk
entities:
- entity: button.camera1_ptz_left
icon: mdi:pan-left
tap_action:
action: call-service
service: button.press
data:
entity_id: button.camera1_ptz_left
- entity: button.camera1_ptz_right
icon: mdi:pan-right
tap_action:
action: call-service
service: button.press
data:
entity_id: button.camera1_ptz_right
- entity: button.camera1_ptz_up
icon: mdi:pan-up
tap_action:
action: call-service
service: button.press
data:
entity_id: button.camera1_ptz_up
- entity: button.camera1_ptz_down
icon: mdi:pan-down
tap_action:
action: call-service
service: button.press
data:
entity_id: button.camera1_ptz_down
camera_image: camera.camera1_sub
tap_action:
action: call-service
service: light.toggle
target:
entity_id: light.philips_929003052501_01_huelight
```
7. That's it. You can now control your camera from the picture glance card on your dashboard.
### More examples
```yaml
type: picture-glance
title: Living room

View File

@ -226,7 +226,7 @@ Service data attribute | Optional | Description
### Service `goto_preset`
This service will cause the camera to move to one of the PTZ locations configured within the camera.
This service will cause the camera to move to one of the <abbr title="pan, tilt, and zoom">PTZ</abbr> locations configured within the camera.
Service data attribute | Optional | Description
-|-|-
@ -244,7 +244,7 @@ Service data attribute | Optional | Description
### Service `start_tour`/`stop_tour`
These services start or stop the camera's PTZ tour function.
These services start or stop the camera's <abbr title="pan, tilt, and zoom">PTZ</abbr> tour function.
Service data attribute | Optional | Description
-|-|-
@ -252,7 +252,7 @@ Service data attribute | Optional | Description
### Service `ptz_control`
If your Amcrest or Dahua camera supports PTZ, you will be able to pan, tilt or zoom your camera.
If your Amcrest or Dahua camera supports <abbr title="pan, tilt, and zoom">PTZ</abbr>, you will be able to pan, tilt or zoom your camera.
Service data attribute | Optional | Description
-|-|-

View File

@ -81,7 +81,7 @@ If your EZVIZ camera supports warning sounds, you can use this service to set th
### Service `ezviz.ptz`
If your EZVIZ camera supports PTZ, you will be able to pan or tilt your camera.
If your EZVIZ camera supports <abbr title="pan, tilt, and zoom">PTZ</abbr>, you will be able to pan or tilt your camera.
| Service data attribute | Description |
| -----------------------| ----------- |
@ -149,7 +149,7 @@ Once triggered, the siren will automatically deactivate after 60 seconds (EZVIZ
### PTZ
PTZ up/down/left/right buttons are available on supported PTZ cameras for pan and tilt control.
<abbr title="pan, tilt, and zoom">PTZ</abbr> up/down/left/right buttons are available on supported <abbr title="pan, tilt, and zoom">PTZ</abbr> cameras for pan and tilt control.
### Warning sound
@ -166,3 +166,7 @@ The image entity represents the last detected event from a camera and visually r
## Troubleshooting
- `authentication failed`: The authentication requires an EZVIZ account with two-step verification disabled. Google, Facebook, TikTok, or other Oauth-based accounts will not work.
## Related topics
- [Controlling the camera from the dashboard](/dashboards/picture-glance/#creating-a-card-to-control-the-camera)

View File

@ -28,7 +28,7 @@ Most Foscam IP Cameras supports two video streams, by default the `Main` stream
### Service `foscam.ptz`
If your Foscam camera supports PTZ, you will be able to pan or tilt your camera.
If your Foscam camera supports <abbr title="pan, tilt, and zoom">PTZ</abbr>, you will be able to pan or tilt your camera.
| Service data attribute | Description |
| -----------------------| ----------- |
@ -38,7 +38,7 @@ If your Foscam camera supports PTZ, you will be able to pan or tilt your camera.
### Service `foscam.ptz_preset`
If your Foscam camera supports PTZ presets, you will be able to move the camera to a predefined preset using the preset name.
If your Foscam camera supports <abbr title="pan, tilt, and zoom">PTZ</abbr> presets, you will be able to move the camera to a predefined preset using the preset name.
| Service data attribute | Description |
| -----------------------| ----------- |

View File

@ -87,7 +87,7 @@ If you are running into trouble with this sensor, please refer to the [Troublesh
### Service `onvif.ptz`
If your ONVIF camera supports PTZ, you will be able to pan, tilt or zoom your camera.
If your ONVIF camera supports <abbr title="pan, tilt, and zoom">PTZ</abbr>, you will be able to pan, tilt or zoom your camera.
| Service data attribute | Description |
| -----------------------| ----------- |
@ -95,7 +95,7 @@ If your ONVIF camera supports PTZ, you will be able to pan, tilt or zoom your ca
| `tilt` | Tilt direction. Allowed values: `UP`, `DOWN`, `NONE` |
| `pan` | Pan direction. Allowed values: `RIGHT`, `LEFT`, `NONE` |
| `zoom` | Zoom. Allowed values: `ZOOM_IN`, `ZOOM_OUT`, `NONE` |
| `distance` | Distance coefficient. Sets how much PTZ should be executed in one request. Allowed values: floating point numbers, 0 to 1. Default : 0.1 |
| `distance` | Distance coefficient. Sets how much <abbr title="pan, tilt, and zoom">PTZ</abbr> should be executed in one request. Allowed values: floating point numbers, 0 to 1. Default : 0.1 |
| `speed` | Speed coefficient. Sets how fast PTZ will be executed. Allowed values: floating point numbers, 0 to 1. Default : 0.5 |
| `preset` | PTZ preset profile token. Sets the preset profile token which is executed with GotoPreset. |
| `move_mode` | PTZ moving mode. Allowed values: `ContinuousMove`, `RelativeMove`, `AbsoluteMove`, `GotoPreset`, `Stop`. Default :`RelativeMove` |

View File

@ -102,7 +102,7 @@ If the **Auto tracking** switch entity is enabled, and a object disappears from
Depending on the supported features of the camera, button entities are added for:
- PTZ stop
- <abbr title="pan, tilt, and zoom">PTZ</abbr> stop
- PTZ left
- PTZ right
- PTZ up
@ -124,7 +124,7 @@ Depending on the supported features of the camera, select entities are added for
- Floodlight mode (Off, Auto, Schedule)
- Day night mode (Auto, Color, Black&White)
- PTZ preset
- <abbr title="pan, tilt, and zoom">PTZ</abbr> preset
- Auto quick reply message
- Auto track method (Digital, Digital first, Pan/Tilt first)
- Status LED (Doorbell only: Stay off, Auto, Auto & always on at night)
@ -240,14 +240,14 @@ However, these cameras can work with this integration through an NVR in which th
A brand new Reolink camera first needs to be connected to the network and initialized. During initialization, the credentials for the camera need to be set.
There are several ways to achieve this.
### To connect Reolink via app/client
### Connecting Reolink via app/client
The recommended way is to use the [Reolink mobile app, Windows, or Mac client](https://reolink.com/software-and-manual/).
1. Follow the on-screen instructions.
2. In Home Assistant, use the credentials you just configured in the Reolink app/client.
### To connect Reolink via a web browser
### Connecting Reolink via a web browser
When your camera has a LAN port (most Wi-Fi cameras also have a LAN port):
@ -273,10 +273,15 @@ Normally, the digits are printed directly under the QR code. Alternatively, you
Then power up the camera while pointing it at the QR code. It takes about a minute to initialize, read the QR code, and connect to your Wi-Fi.
## Showing the camera in the dashboard
1. One way to show the camera in the dashboard is by using the picture glance card.
2. For example, you can place arrow buttons on the card to [control the camera](/dashboards/picture-glance/#creating-a-card-to-control-the-camera).
## Troubleshooting
- Older firmware versions do not expose the necessary information the integration needs to function. Ensure the camera is updated to the [latest firmware](https://reolink.com/download-center/) prior to setting up the integration. Note that Reolink auto update and check for update functions in the app/windows/web client often do not show the latest available firmware version. Therefore check the version in the [Reolink download center](https://reolink.com/download-center/) online.
- Ensure at least one of the HTTP/HTTPS ports is enabled in the [windows](https://reolink.com/software-and-manual/)/web client under `Settings`->`Network`->`Advanced`->`Port Settings`, see [additional instructions](https://support.reolink.com/hc/en-us/articles/900004435763-How-to-Set-up-Reolink-Ports-Settings-via-Reolink-Client-New-Client-) on the Reolink site.
- Ensure at least one of the HTTP/HTTPS ports is enabled in the [windows](https://reolink.com/software-and-manual/)/web client under **Settings** > **Network** > **Advanced** > **Port Settings**, see [additional instructions](https://support.reolink.com/hc/en-us/articles/900004435763-How-to-Set-up-Reolink-Ports-Settings-via-Reolink-Client-New-Client-) on the Reolink site.
- On some camera models, the RTMP port needs to be enabled in order for the HTTP(S) port to function properly. Make sure this port is also enabled if you get a `Cannot connect to host` error while one of the HTTP/HTTPS ports is already enabled.
- Setting a static IP address for Reolink cameras/NVRs in your router is advisable to prevent (temporal) connectivity issues when the IP address changes.
- Do not set a static IP in the Reolink device itself, but leave the **Connection Type** on **DHCP** under **Settings** > **Network** > **Network Information** > **Set Up**. If you set it to **static** on the Reolink device itself, this is known to cause incorrect DHCP requests on the network. The incorrect DHCP request causes Home Assistant to use the wrong IP address for the camera, resulting in connection issues. The issue originates from the Reolink firmware, which keeps sending DCHP requests even when you set a static IP address in the Reolink device.
@ -295,3 +300,8 @@ A valid address could, for example, be `http://192.168.1.10:8123` where `192.168
- Since a HTTP address is needed, Reolink push is incompatible with a global SSL certificate.
Therefore, ensure no Global SSL certificate is configured in the [`configuration.yaml` under HTTP](/integrations/http/#ssl_certificate).
An SSL certificate can still be enforced for external connections, by, for instance, using the [NGINX add-on](https://github.com/home-assistant/addons/tree/master/nginx_proxy) or [NGINX Proxy Manager add-on](https://github.com/hassio-addons/addon-nginx-proxy-manager) instead of a globally enforced SSL certificate.
## Related topics
- [Controlling the camera from the dashboard](/dashboards/picture-glance/#creating-a-card-to-control-the-camera)
- [Reolink product page](https://reolink.com/)

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB