Skip to content

Add support for effects_v2 #586

@renssies

Description

@renssies

A while back Signify added effects_v2 to the API to allow for customizing the color, color temperature and speed of an effect. With this change the old effects on a scene or light is now deprecated. effects_v2 is available on all lights that support effects, even newer white only lights.

It would be great to add support for the color and color temperature property of effects.

Request example

{
  "on": {
    "on": true
  },
  "effects": {
    "effect": "fire"
  },
  "effects_v2": {
    "action": {
      "effect": "fire",
      "parameters": {
        "color": {
          "xy": {
            "x": 0.2,
            "y": 0.8
          }
        },
        "color_temperature": {
          "mirek": 233
        },
        "speed": 0.5
      }
    }
  }
}

Backwards Compatibility

  • Sending both effects and effects_v2 will simply ignore effects and succeed with applying all other properties including effects_v2.
    • The response will be a 207 (Multi-Status) with data and an error about an invalid argument for effects.
  • Sending color or color-temperature to white only lights will not result in an error.
  • Omitting parameters for effects_v2 will apply the effect in the same way as the deprecated effects property

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions