device adopt

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

device adopt v15.0.0

Takes a discovered device into service, so triggers fire for it and blocks can command it.

In pins 3 + 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.

  • name v15.0.0
    value

    Rename while adopting.

  • room v15.0.0
    value

    Assign a room while adopting.

Out pins 4 + flow
  • flow v15.0.0
    flow
  • ok v15.0.0
    condition
  • newly adopted v15.0.0
    condition

    True only when this call is what adopted it.

  • device v15.0.0
    object
  • error v15.0.0
    value

Adoption is the gate between 'the radio can hear this' and 'this is part of my system'. An unadopted device is tracked and visible but fires no triggers and refuses every command. Idempotent: adopting an already-adopted device succeeds and reports adopted=false for `newly`. Typically wired to a device discovered trigger, or called from an onboarding screen.

zigbee
zwave
matter
thread
hue
smart home

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

Studio canvas example for the device adopt block: typical wiring for device adopt.

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