Home automation

Run Zigbee, Thread and Matter, Z-Wave, Hue and Daikin devices from blueprints on a RUAL Nano, with no vendor cloud.

Guides

Blocks

Add these blocks on the canvas by searching for their name. Each block page lists its pins and how it behaves.

• climate set homeassist_climate_set Sets an air conditioner or thermostat: on/off, mode, target temperature, fan speed.
• device adopt homeassist_device_adopt Takes a discovered device into service, so triggers fire for it and blocks can command it.
• device forget homeassist_device_forget Removes a device from RUAL. It stays paired to the radio and will reappear, unadopted, on its next report.
• get device homeassist_device_get Returns one device: its name, room, capabilities and current state.
• get device history homeassist_device_history Returns recorded readings for one capability of one device, optionally bucketed for charting.
• device rename homeassist_device_rename Sets a device's friendly name and/or room.
• device set homeassist_device_set Sets any capability on any device. The escape hatch for things the specific blocks do not cover.
• get device state homeassist_device_state Reads one capability from one device : is the motion sensor triggered, what is the temperature.
• get all devices homeassist_devices_all Returns every adopted device, optionally filtered by type, room or adapter.
• door lock homeassist_door_lock Locks a door, and holds it locked unless you ask it not to.
• door unlock homeassist_door_unlock 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.
• gate close homeassist_gate_close Closes a gate or garage door.
• gate open homeassist_gate_open Opens a gate or garage door.
• light dim homeassist_light_dim Sets a light's brightness without changing anything else.
• light off homeassist_light_off Turns a light off.
• light on homeassist_light_on Turns a light on. Optionally set brightness, colour temperature or colour in the same command.
• light toggle homeassist_light_toggle Flips a light: on if it is off, off if it is on.
• get lights that are on homeassist_lights_on Returns every light currently switched on.
• pairing open homeassist_pairing_open Opens the radio for new devices to join, for a bounded number of seconds.
• get rooms homeassist_rooms Returns the list of rooms that have devices assigned to them.
• get active sensors homeassist_sensors_active Returns every sensor that is currently triggered: motion present, doors open, leaks found.
• get status homeassist_status Returns which radios are connected and how many devices are known.
• switch off homeassist_switch_off Turns a plug, relay or switch off.
• switch on homeassist_switch_on Turns a plug, relay or switch on.
• access denied homeassist_trigger_access_denied Starts the flow when someone is refused: an unknown card, a wrong PIN, a credential outside its schedule.
• access granted homeassist_trigger_access_granted 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.
• security alarm activated homeassist_trigger_alarm Starts the flow when the security system's own alarm goes active.
• battery low homeassist_trigger_battery_low Starts the flow when a device's battery drops below the threshold, or reports its own low-battery flag.
• button pressed homeassist_trigger_button_pressed Starts the flow when a button or scene switch is pressed. The `value` pin says which press it was: single, double, hold, release.
• camera motion detected homeassist_trigger_camera_motion Starts the flow when a camera detects motion.
• contact closed homeassist_trigger_contact_closed Starts the flow when a door or window is closed.
• contact opened homeassist_trigger_contact_opened Starts the flow when a door or window is opened.
• device adopted homeassist_trigger_device_adopted Starts the flow when a device is taken into service.
• device discovered homeassist_trigger_device_discovered Starts the flow when a NEW device appears on the radio, before it is adopted.
• device state changed homeassist_trigger_device_state_changed Starts the flow on ANY change from a device. The catch-all : use a specific trigger where one exists.
• device unavailable homeassist_trigger_device_unavailable Starts the flow when a device stops responding.
• door or gate closed homeassist_trigger_door_closed Starts the flow when a controlled door or gate physically closes.
• door or gate locked homeassist_trigger_door_locked Starts the flow when the lock engages.
• door or gate opened homeassist_trigger_door_opened Starts the flow when a controlled door or gate physically opens.
• door or gate unlocked homeassist_trigger_door_unlocked Starts the flow when the lock releases, whether or not the door then opens.
• doorbell rang homeassist_trigger_doorbell Starts the flow when someone rings a doorbell or door station.
• gate closed homeassist_trigger_gate_closed Starts the flow when the gate physically closes.
• gate opened homeassist_trigger_gate_opened Starts the flow when the gate physically opens.
• humidity changed homeassist_trigger_humidity_changed Starts the flow when a humidity reading changes. Set above or below to fire only when it crosses a threshold.
• light turned off homeassist_trigger_light_off Starts the flow when a light is switched off.
• light turned on homeassist_trigger_light_on Starts the flow when a light is switched on : by anyone, including a wall switch or the vendor's own app.
• NFC card swiped homeassist_trigger_nfc Starts the flow when any NFC card or fob is presented to a reader, whether or not it was accepted.
• presence cleared homeassist_trigger_presence_cleared Starts the flow when a room becomes empty.
• presence detected homeassist_trigger_presence_detected Starts the flow when someone is detected in a room.
• sensor activated homeassist_trigger_sensor_activated Starts the flow when a sensor turns ON: motion detected, a door opened, water found, smoke detected.
• sensor deactivated homeassist_trigger_sensor_deactivated Starts the flow when a sensor turns OFF: motion cleared, a door closed, a leak stopped.
• smoke detected homeassist_trigger_smoke_detected Starts the flow when a smoke alarm triggers.
• switch turned off homeassist_trigger_switch_off Starts the flow when a plug, relay or switch is turned off.
• switch turned on homeassist_trigger_switch_on Starts the flow when a plug, relay or switch is turned on.
• temperature changed homeassist_trigger_temperature_changed Starts the flow when a temperature reading changes. Set above or below to fire only when it crosses a threshold.
• water leak detected homeassist_trigger_water_leak Starts the flow when a leak sensor finds water.
• selector storage Lets you choose a storage to be used on the connected blocks.
• create trigger_custom_function Creates a new function that can be executed using the given name.
• is on electron user_is_electron Returns true if the user is an electron user.
• is on iPad user_is_ipad Returns true if the user is on an iPad.
• is loggedin user_is_loggedin Returns true if currently a user is logged-in.
• is on mobile user_is_on_mobile Returns true if the user is on mobile.

Next steps