docs
Getting started Quickstart First CRUD App Core Concepts Core versions
v15.0.0 development v14.0.6 latest v14.0.5 v14.0.4 v14.0.3 v14.0.2 v14.0.1 v13.0.9 v13.0.8 v13.0.7 v13.0.6 v13.0.5 v13.0.4 v13.0.3 v13.0.2 v13.0.1 v12.1.6 v12.1.1 v12.1.0 v12.0.7 v12.0.6 v12.0.5 v12.0.4 v12.0.3 v12.0.1 v12.0.0 v11.5.18 v11.5.15 v11.5.13 v11.5.7 v11.5.5 v11.5.3 v11.4.7 v11.3.3 v11.3.2 v11.3.0 v11.2.5 v11.2.1 v11.1.17 v11.0.1 v11.0.0 v10.6.7 v10.6.2 v10.6.1 v10.5.10 v10.5.2 v10.4.54 v10.4.53 v10.4.52 v10.4.51 v10.4.47 v10.4.46 v10.4.29 v10.4.28 v10.4.21 v10.4.20 v10.4.16 v10.4.15 v10.4.14 v10.4.7 v10.3.14 v10.3.13 v10.3.11 v10.3.2 v10.2.9 v10.2.7 v10.2.1 v10.1.2 v10.0.18 v9.4.42 v9.4.39 v9.4.4 v9.3.25 v9.3.13 v9.3.5 v9.3.2 v9.2.15 v9.2.5

Cluster

Getting Access User Access User Roles Explained Token Device Data Deployment Usage Build Your First API API Guide API's
api-history audit-logs authentication authentication-groups blueprint-action-types blueprint-actions blueprint-activity blueprint-changes blueprint-comments blueprint-components blueprint-events blueprint-fields blueprint-flows blueprint-tags blueprint-templates blueprint-validation blueprints cache-management cluster-statistics entity-management feedback ip-management language language-management languages local-devices node-settings password-reset queue react-components redis-keys settings storage storage-events system system---languages system-assets system-hints system-information system-key-value system-logs system-nodes system-security system-storages system-threads system-upgrades system-users user-activity user-groups user-logs users well-known

Blocks

All blocks
Apple API NS a* path finding aggregation alias amazon aws android anthropic apn array attributes banking base64 broadcast browser condition crypto currency date discord dns dobot edifact events field validation fields files finance float floriday flow foreach ftp function execution function selectors funnels geopoint github globals google google maps home automation http http connection injectable functions json json web token jsonp lettermint line stop listener locking logging mailchimp math messagebird modal functions mollie mssgs mssql mutations nginx number object openstreetmap pathfinding payments places postmark postmark account printer query querystring queue redis references regexp saltedge scopes session management sftp shipping soap connection state state actions state elements state events state execution state triggers state ui storage stripe studio functions stylesheet styling system settings threads tikkie timers timezone translations twilio twinfield type casting ui ui class users value vat video virtualisation webhooks websocket xml zip zpl
Block Templates Finding Blocks

Interfaces

Context Menu Components RUAL Library RUAL Components RUAL Studio Handle Iterations Overwrite Defaults Login Escape Hatch

Blueprints

Introduction Tips & tricks Best Practices Common Blueprint Patterns Block Execution Object References Locking & Concurrency Storages Storage Events Storage Examples Repeating Events Queue Assets System Settings System Settings Reference Common pitfals Precompiling Remote access control Places and Geo Search

Tutorials

Building User Authentication Creating a REST API Dashboard with Charts File Upload & Processing Email System Setup Third-Party Integrations Building AI Endpoints Building a Login Page Building a Reporting API City Filter Uploads API with Locking Local Home Automation

Home Automation

Introduction Setting Up a Nano Discovering and Adopting Trigger Reference Action Reference Example Flows History and Energy Troubleshooting

Examples

Simple Blog E-Commerce Catalog User Management Booking System Inventory Tracker Task Management

Reference

Block Quick Reference API Endpoint Reference System Settings Quick Ref Component Props Reference Error Code Reference Location Blocks

Architecture

Choosing Your Approach Version Management RUAL Core Nano

Troubleshooting

Common Issues & Fixes Debugging Blueprints

Other

React Native
Support
© 2026 Deverence Group B.V.

Blocks within home

List of all the block within the home group. If you're running an older core version, there may be groups listed here that are not available to you (yet).

light off condition v15.0.0 Turns a light off. switch turned off object v15.0.0 Starts the flow when a plug, relay or switch is turned off. pairing open condition v15.0.0 Opens the radio for new devices to join, for a bounded number of seconds. temperature changed object v15.0.0 Starts the flow when a temperature reading changes. Set above or below to fire only when it crosses a threshold. device set condition v15.0.0 Sets any capability on any device. The escape hatch for things the specific blocks do not cover. door or gate closed object v15.0.0 Starts the flow when a controlled door or gate physically closes. light toggle condition v15.0.0 Flips a light: on if it is off, off if it is on. gate close condition v15.0.0 Closes a gate or garage door. climate set condition v15.0.0 Sets an air conditioner or thermostat: on/off, mode, target temperature, fan speed. get all devices array v15.0.0 Returns every adopted device, optionally filtered by type, room or adapter. contact opened object v15.0.0 Starts the flow when a door or window is opened. door or gate opened object v15.0.0 Starts the flow when a controlled door or gate physically opens. get device condition v15.0.0 Returns one device: its name, room, capabilities and current state. light dim condition v15.0.0 Sets a light's brightness without changing anything else. door or gate locked object v15.0.0 Starts the flow when the lock engages. device state changed object v15.0.0 Starts the flow on ANY change from a device. The catch-all — use a specific trigger where one exists. door unlock condition v15.0.0 Unlocks a door. By default this is a momentary unlock — the door releases long enough for one person, then re-locks — matching the 'let them in' button. humidity changed object v15.0.0 Starts the flow when a humidity reading changes. Set above or below to fire only when it crosses a threshold. device forget condition v15.0.0 Removes a device from RUAL. It stays paired to the radio and will reappear, unadopted, on its next report. switch turned on object v15.0.0 Starts the flow when a plug, relay or switch is turned on. light turned on object v15.0.0 Starts the flow when a light is switched on — by anyone, including a wall switch or the vendor's own app. switch on condition v15.0.0 Turns a plug, relay or switch on. get status array v15.0.0 Returns which radios are connected and how many devices are known. presence cleared object v15.0.0 Starts the flow when a room becomes empty. door or gate unlocked object v15.0.0 Starts the flow when the lock releases, whether or not the door then opens. get device state condition v15.0.0 Reads one capability from one device — is the motion sensor triggered, what is the temperature. device adopted object v15.0.0 Starts the flow when a device is taken into service. water leak detected object v15.0.0 Starts the flow when a leak sensor finds water. switch off condition v15.0.0 Turns a plug, relay or switch off. sensor activated object v15.0.0 Starts the flow when a sensor turns ON: motion detected, a door opened, water found, smoke detected. battery low object v15.0.0 Starts the flow when a device's battery drops below the threshold, or reports its own low-battery flag. gate closed object v15.0.0 Starts the flow when the gate physically closes. light on condition v15.0.0 Turns a light on. Optionally set brightness, colour temperature or colour in the same command. security alarm activated object v15.0.0 Starts the flow when the security system's own alarm goes active. device unavailable object v15.0.0 Starts the flow when a device stops responding. contact closed object v15.0.0 Starts the flow when a door or window is closed. light turned off object v15.0.0 Starts the flow when a light is switched off. presence detected object v15.0.0 Starts the flow when someone is detected in a room. gate opened object v15.0.0 Starts the flow when the gate physically opens. get rooms array v15.0.0 Returns the list of rooms that have devices assigned to them. doorbell rang object v15.0.0 Starts the flow when someone rings a doorbell or door station. gate open condition v15.0.0 Opens a gate or garage door. nfc card swiped object v15.0.0 Starts the flow when any NFC card or fob is presented to a reader, whether or not it was accepted. access granted object 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. camera motion detected object v15.0.0 Starts the flow when a camera detects motion. get lights that are on array v15.0.0 Returns every light currently switched on. get active sensors array v15.0.0 Returns every sensor that is currently triggered: motion present, doors open, leaks found. button pressed object v15.0.0 Starts the flow when a button or scene switch is pressed. The `value` pin says which press it was: single, double, hold, release. device discovered object v15.0.0 Starts the flow when a NEW device appears on the radio, before it is adopted. smoke detected object v15.0.0 Starts the flow when a smoke alarm triggers. get device history array v15.0.0 Returns recorded readings for one capability of one device, optionally bucketed for charting. sensor deactivated object v15.0.0 Starts the flow when a sensor turns OFF: motion cleared, a door closed, a leak stopped. device rename condition v15.0.0 Sets a device's friendly name and/or room. door lock condition v15.0.0 Locks a door, and holds it locked unless you ask it not to. access denied object v15.0.0 Starts the flow when someone is refused: an unknown card, a wrong PIN, a credential outside its schedule. device adopt condition v15.0.0 Takes a discovered device into service, so triggers fire for it and blocks can command it.
Back to home automation Return to the main group to view all sub-groups

Was this page helpful? Tell us what to improve · RUAL Docs is an integral component of the RUAL ecosystem