access granted

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

access granted v15.0.0

Starts the flow when someone is let in: a valid card, PIN, wave or mobile credential. The actor and method are on the out-pins.

In pins 3
  • device v15.0.0
    value

    Only fire for this door. Leave empty for every door.

  • room v15.0.0
    value

    Only fire for devices in this room. Leave empty for every room.

  • method v15.0.0
    value

    Only fire for this method. Leave empty for any. • Suggestions: nfc pin wave mobile touchpass

Out pins 12 + flow
  • flow v15.0.0
    flow
  • device v15.0.0
    object

    The full device: id, name, room, type, capabilities, current state.

  • device id v15.0.0
    value

    Stable platform id, e.g. zigbee:0x00158d0007e1a2b3.

  • name v15.0.0
    value

    The device's friendly name.

  • room v15.0.0
    value

    The room the device is assigned to, empty if none.

  • type v15.0.0
    value

    sensor, light, switch, climate, cover, lock or button.

  • capability v15.0.0
    value

    Which capability changed, e.g. occupancy, contact, power.

  • value v15.0.0
    value

    The new value.

  • previous v15.0.0
    value

    The value before this change, empty on the first report.

  • at v15.0.0
    number

    Unix seconds the device reported.

  • actor v15.0.0
    value

    Who: the user or credential name, empty when the reader could not identify them.

  • method v15.0.0
    value

    How: nfc, pin, wave, mobile, touchpass or manual.

  • granted v15.0.0
    condition

    True when access was allowed, false when the reader denied it.

Start-of-flow trigger for a SUCCESSFUL entry. Fires when an access_entry event is granted. The `actor` out-pin is who, `method` is how (nfc, pin, wave, mobile, touchpass, manual). Use this for 'unlock logging', 'welcome home' scenes, or 'notify when the cleaner's card is used'. It does NOT fire on a denied attempt : use access denied for that.

unifi
access
nfc
card
door
entry
trigger

access granted fires once per accepted credential and carries both the actor and the method, so the door log writes down who came in and whether they used a card, a code or an app. Storing it through create document rather than only logging it is what makes "who was in the building on Tuesday" answerable later.

Studio canvas example for the access granted block: recording every accepted entry.

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