UniFi Protect icon

UniFi Protect

Interact with UniFi Protect API
Join our community

Actions18

Overview

This node interacts with the UniFi Protect API to upload custom images or messages to a camera's LCD display. It is useful for scenarios where you want to remotely display custom messages, such as notifications or alerts, on a camera's screen. For example, you can display a 'Do Not Disturb' message or a 'Leave Package at Door' message on the camera's LCD to communicate with visitors or delivery personnel.

Use Case Examples

  1. Display a custom message on a camera's LCD screen to notify visitors.
  2. Set a 'Do Not Disturb' message on the camera for a specified duration.
  3. Show a 'Leave Package at Door' message to delivery personnel.

Properties

Name Meaning
Camera ID The unique identifier (UUID) of the camera to which the custom image or message will be uploaded. This is required to specify the target camera.
Message Type The type of LCD message to display on the camera. Options include Custom Message, Do Not Disturb, and Leave Package at Door.
Message Text The custom message text to display on the camera's LCD. This is only applicable when the Message Type is 'Custom Message'.
Duration The duration in seconds for which the message should be displayed. A value of 0 means the message is permanent.
Request Options Additional options for the request such as batching, SSL certificate validation, proxy settings, and timeout configuration.

Output

JSON

  • cameraId - The unique identifier of the camera to which the image or message was uploaded.
  • type - The type of message displayed on the camera's LCD.
  • text - The custom message text displayed (if applicable).
  • resetAt - The timestamp when the message will reset or disappear (null if permanent).

Dependencies

  • UniFi Protect API
  • An API key credential for authentication

Troubleshooting

  • Ensure the Camera ID is correct and corresponds to an existing camera in the UniFi Protect system.
  • Verify that the API credentials are valid and have the necessary permissions to upload images or messages.
  • Check network connectivity and proxy settings if requests fail or time out.
  • If SSL certificate validation fails, consider enabling the option to ignore SSL issues, but be aware of security risks.

Links

Discussion