light toggle

This block is part of the globals group and was last modified in core v15.0.0.

light toggle v15.0.0

Flips a light: on if it is off, off if it is on.

In pins 1 + flow
  • flow v15.0.0
    flow
  • device v15.0.0
    value

    Device id, native address, or exact device name. Leave empty to use the device picked on the block.

Out pins 3 + flow
  • flow v15.0.0
    flow
  • ok v15.0.0
    condition

    True when the command reached the device.

  • device v15.0.0
    object

    The device the command was sent to.

  • error v15.0.0
    value

    Empty on success. HOMEASSIST_DEVICE_NOT_FOUND, HOMEASSIST_DEVICE_NOT_ADOPTED, HOMEASSIST_CAPABILITY_UNSUPPORTED or HOMEASSIST_NOT_AVAILABLE.

Reads the light's current power state from the registry and sends the opposite. If the state is unknown : the node restarted and the lamp has not reported since : the block turns the light ON and sets ok, because the overwhelmingly likely intent of a toggle a human just triggered is to get light.

zigbee
zwave
matter
thread
hue
smart home

A typical wiring for light toggle: a function trigger starts the flow; the flow out pin feeds debug.

Studio canvas example for the light toggle block: typical wiring for light toggle.

Used in these guides

These documentation pages use or explain this block:

Version history

Introduced in v15.0.0.


Back to globals Return to the main group to view all sub-groups Back to home Return to the group to view all blocks within this group