rustuya-local

Local control of Tuya devices through rustuya-bridge, as IL (ildevice) devices, and in Home Assistant. It replaces rustuya-homeassistant.

rustuya-bridge ──MQTT──► rustuya-local ──MQTT (il/…)──► il-ha (Home Assistant integration), or any IL consumer
 raw LAN dps             Service:
                         BridgeClient + rustuya_local.host.Hub

• tuya-interpreter is the only place that interprets Tuya: Home Assistant core's tuya behaviour and user overrides for non-standard devices, through its Sans-I/O Rust engine and Python wrapper.
• rustuya-local is one Service (src/rustuya_local/service.py) and three thin shells that run it: the rustuya-local run daemon, the custom_components/rustuya Home Assistant integration, and a rustuya-manager plugin. Its host package owns the runner, transports and file watchers. It only produces IL and knows nothing of Home Assistant entities.
• il-ha turns IL descriptors into Home Assistant entities.

Daemon

uv venv && uv pip install -e .
rustuya-local run --config config.json

config.json (see src/rustuya_local/config.py): the bridge and IL brokers, the IL prefix, the device list, a custom_converters directory, and options for the Hub (allow_hazardous, expose_unused, overrides). The device list is the tuyadevices.json that rustuya-manager keeps (its QR-login wizard writes it, with each device's cloud category/function/status_range/local_strategy); rustuya-local follows it as it changes and never writes it. IL carries only the devices that are also registered on the bridge. The bridge's own topic templates are read from its retained {root}/bridge/config.

Stopping the daemon only marks it offline; its devices stay in IL (retained) for the next start. To retire it, stop it and run rustuya-local purge --config config.json: the retained descriptors, values and presence of its IL prefix and source are cleared (other sources on the prefix are left alone), so IL consumers drop the devices.

tuya-interpreter host boundary

The shared Rust core interprets one device and has no MQTT or rule-file loading API. rustuya_local.host.Hub owns the device registry and maps TuyaDriver outputs to IL MQTT wire data; host.rules discovers and loads the bundled builtin rules and user layers, passing decoded rules to Rust for composition. The service preloads native code and rules in a worker thread before starting devices. Timers, retained-message policy, bridge get requests, presence and settings persistence remain in this host. MQTT and in-process transport tests exercise the same adapter and the bidirectional Rust driver.

Home Assistant

Coming from rustuya-homeassistant: docs/MIGRATING.md.

Install il-ha, and run one IL producer per bridge: the daemon, the integration below, or the manager plugin. A second one with the same IL prefix and source refuses to start while the first runs (every device would show twice): the daemon exits, the integration is retried by Home Assistant, the plugin's tab shows it and retries. To move from one to another, stop the old one first.

The rustuya integration (HACS: add this repository as a custom repository of type Integration, install Rustuya, restart, then Add Integration → Rustuya) is the service tied to a config entry, with the QR login wizard, bridge registration and an optional embedded bridge. It creates no entities itself. Setup asks only for the bridge mode, the broker and the IL prefix (it checks an external bridge answers there, and asks for its topic root if it is not on the default one), then offers to fetch the devices from Tuya Cloud (a saved login is reused; a QR login only when there is none), which closing its window skips (it is in Configure later, and in the panel); the rest starts at its defaults and is changed in the panel's Settings. Deleting the integration takes its devices out of IL (so il-ha removes them); with the embedded bridge it also clears that bridge's retained topics and its state file. The device list and Tuya login it kept under .storage/rustuya/ are deleted; a device file you pointed elsewhere, and everything on an external bridge, are left as they are.

Overrides for non-standard devices

Tuya's cloud schemas are fragmented; fixes go in a custom_converters/ directory (daemon: custom_converters in the config; integration: <config>/rustuya_converters; manager plugin: its data dir), followed live:

• *.json: tuya-interpreter override blocks by product or device id: rename a dp, define one the schema lacks, map the device's words to the standard ones (remap.alias), fix labels and classes, define a declarative converter. A cover's direction is not set here but with its settings (below). Each file is a rule object with fixes under overrides, for example {"overrides": {"product_id": {"cover": {"invert_position": true}}}}.
• Converters are JSON programs under converters.declarative; Python code plugins are not loaded.

See tuya-interpreter's device customization guide for the format. Official builtin rules, including 00-default.json, ship with tuya-interpreter and update when that package is upgraded. They are applied before your own rule files.

Online updates fetch the latest builtin rules into rules/builtin/ inside the overrides directory at start and daily. In the Rustuya panel, use Update builtin rules to fetch them now or Automatically update builtin rules to control automatic updates. Opening the panel checks for updates: with automatic updates on, available changes are installed immediately without a yellow dot. With automatic updates off, available changes enable the manual update button with a yellow dot. The button is disabled while checking or when the installed rules are current. The daemon uses "pack": false to disable automatic updates; the manager plugin has the same option in its settings. Installed builtin rules remain available when automatic updates are off, and the panel still allows manual updates. Updates only replace or remove files they downloaded, preserving user edits.

Cover settings

A curtain or blind whose position runs the other way, or whose opening / closing state is wrong, can be fixed from its own configuration switches and motion-source selector. Each appears only where it changes something:

With one position data point for both, Invert current position turns both. Motion defaults to inferred when device settings are enabled, unless an override selects another source. A setting changes nothing on the device: the setting is saved as the device's block in zz_settings.json in the converters directory and applied at once, so it survives a restart and can be edited there too. Without a converters directory (a daemon with no custom_converters) the switches are not offered; "options": {"device_settings": false} turns them off. A block with the same cover keys in your own file or the builtin rules sets a model's starting point; the saved settings win. Older cover.infer_motion and converters.cover_motion blocks are upgraded on loading to cover.state_source (inferred, or none for infer_motion: false) and cover.settle; see migration notes.

In Home Assistant the files can be edited from a sidebar panel: the integration's Configure → Add the Rustuya panel to the sidebar adds it and links to it. The panel is for administrators. It fetches the device list from Tuya Cloud, shows the bridge's devices using the running service's complete registry and MQTT connection against the cloud list (missing, bridge only, mismatch, online and offline, each a filter you can turn off; sub-devices under their gateway; each device's bridge connection, live while the panel is open) with add / update / remove. Online and offline split devices whose cloud and bridge records match; selecting both shows the previous synced view. Sub-devices use their own link state, falling back to their gateway when unavailable; an offline gateway makes its sub-devices offline. Unknown state is grouped under offline. A gateway stays visible for context when one of its children matches the filters. Register manually adds Wi-Fi devices or sub-devices without a cloud login, using the same fields as rustuya-manager. Devices absent from the cloud list appear under Bridge only; their removal is not preselected in bulk sync. The panel lists, edits and deletes user converter files (drop JSON rule files on it to copy them in), updates builtin rules on demand, and has the Options (remote control of locks, alarms and garage doors; data points Home Assistant core would not classify; the automatic builtin rule updates), and the Settings setup leaves at their defaults: the bridge topic root, the IL prefix and source, the device file, and the embedded bridge's state file and log level. Saving restarts the integration; moving the IL prefix or source first clears what the old one left on the broker. Hide panel in its toolbar turns it off again. The integration and the panel follow Home Assistant's language: Korean, or English.

rustuya-manager plugin

Installed next to rustuya-manager, as a pip package (pip install rustuya-local in the manager's environment) or as the drop-in zip each release carries (rustuya_local-<version>-dropin.zip, tuya-interpreter binding, native library and builtin rules vendored inside, built by scripts/build_dropin.py; unpack it into the manager's plugin directory, or install it from the manager's plugin catalog once listed there), it appears as a Tuya (IL) tab and runs the service under the manager: the manager's broker and bridge root, the manager's device list (followed). Its data dir (rustuya-local/ next to the manager's plugins) holds settings.json (il, options) and custom_converters/, and the tab edits both: saved settings restart the service in place, saved converter files are picked up while it runs. A settings file it cannot use is shown on the tab until it is fixed.

The drop-in zip includes native code for the platform on which it was built; use a matching OS and architecture, or install with pip to select the appropriate wheel. It freezes the tuya-interpreter it was built with: a tuya-interpreter fix reaches manager users with the next rustuya-local release (bump the patch version and tag; the manager's catalog follows the release). Installed both ways (pip and the plugin directory), the plugin runs once.

Tests

.venv/bin/python -m pytest

Everything here needs the sibling repos and, for the last two groups, mosquitto, pyrustuya-bridge and tuyamock (pip install -e ".[test,fullstack]"); those are skipped when missing. Parity with Home Assistant core's fixtures lives in tuya-interpreter/tests/chain, the wire and topic vectors in ildevice/vectors.

• tests/unit/: the configuration.
• tests/e2e/test_service.py: the service on in-memory brokers (overrides directory, a failed start).
• tests/e2e/test_chain_*.py, test_daemon.py: the runner with il-ha's consumer model on the other side, in one process and over a real broker; the daemon as a subprocess.
• tests/e2e/test_manager_plugin.py: the plugin under rustuya-manager's real plugin host (skipped without it).
• tests/ha/: the integration (config flow, setup).
• tests/e2e/test_full_stack*.py: the real rustuya-bridge (pyrustuyabridge, in process) and Tuya device emulators (tuyamock) around the daemon: state, commands, rejections, a device dropping off and returning, a daemon restart, and a differential check that 38 real device shapes come out of the whole chain exactly as tuya-interpreter computes them.

Status

Planning, progress and open decisions: docs/REDESIGN.md.

Licence: LICENSE (MIT).