UniFi Protect icon

UniFi Protect

Interact with UniFi Protect API
Join our community

Actions18

Overview

This node updates the properties of a smart light in the UniFi Protect system. It allows users to modify attributes such as the light's name, whether the light is forced on, and the light activation mode (motion, when dark, or manual). This is useful for automating and managing smart lighting setups in a UniFi Protect environment, for example, changing light settings based on time of day or specific events.

Use Case Examples

  1. Update the name of a specific light by providing its unique Light ID and the new name.
  2. Force a light to stay on regardless of other conditions by setting the 'Light On' property to true.
  3. Change the light activation mode to 'manual' to control the light manually instead of automatic triggers.

Properties

Name Meaning
Light ID The unique identifier (UUID) of the light to update. This is required to specify which light to modify.
Update Fields A collection of fields to update on the light, including the light's name, whether the light is forced on, and the light activation mode.
Request Options Settings for the HTTP request such as batching, SSL certificate validation, proxy configuration, and timeout duration.

Output

JSON

  • id - The unique identifier of the updated light.
  • name - The updated name of the light.
  • lightOnSettings
    • isLedForceOn - Indicates if the light is forced on.
  • lightModeSettings
    • mode - The mode of light activation after the update.

Dependencies

  • UniFi Protect API

Troubleshooting

  • Ensure the Light ID is correct and exists in the UniFi Protect system; otherwise, the update will fail.
  • If SSL certificate validation fails and the 'Ignore SSL Issues' option is not enabled, the request may be blocked.
  • Proxy settings must be correctly configured if used; incorrect proxy details can cause request failures.
  • Timeout settings should be adjusted based on network conditions to avoid premature request termination.

Links

Discussion