Skip to main content
Homescript is a home automation system designed to simplify the management and control of smart home devices. It provides an easy way to script and automate tasks within your home environment.

​
Why Homescript?

None of the existing home automation systems provided the combination of flexibility and simplicity many users wanted. Homescript was created to address this by offering a lightweight, Lua-based scripting environment that is both powerful and easy to learn.

​
Key Features

  • User-friendly scripting: Homescript uses the Lua language, which is straightforward to learn even for non-programmers.
  • Device integration: Supports a wide range of smart home devices and protocols for seamless control.
  • Clear directory structure: Organizes scripts and configurations in a logical layout that reflects their purpose.
  • Event-driven automation: Lets users create scripts that respond to events or triggers within the home.
  • Extensibility: Supports custom modules and libraries to extend functionality.

​
Integration

Homescript integrates with many smart home platforms and devices, allowing you to build a cohesive automated environment. It supports popular protocols such as Zigbee, Z-Wave, and Thread.
  • Zigbee2MQTT: Use the Zigbee2MQTT bridge to connect Zigbee devices.
  • Frigate: Monitor and control Frigate NVR systems.
Devices that can be controlled via MQTT can be integrated with Homescript.

​
Discovery mode

Homescript includes a discovery mode to help find and add new devices. When enabled, it scans the MQTT broker for compatible devices and generates basic configuration scripts to get you started quickly.

​
Run mode

In run mode, Homescript executes user-defined scripts and automations. It continuously monitors device states and reacts to events according to the defined logic, providing real-time control.

​
Resource usage

Homescript is lightweight and suitable for resource-constrained devices such as Raspberry Pi or other single-board computers. Memory and CPU usage depend on script complexity and the number of connected devices; Homescript aims to minimize resource consumption while remaining reliable.