YoLink Driver

v1.0 - Custom Control Drivers LLC

Control YoLink devices from RTI - works with any YoLink account over the cloud (User Access Credentials), or fully local if you have a YS1606 Local Hub. The driver authenticates, auto-discovers your YoLink devices, and exposes one generic, type-aware control surface: sensors report state and battery; controllable devices get on/off, valve, lock, siren, speaker, thermostat, and IR commands. YoLink's long-range LoRa radios make it ideal for sensors at the far reaches of a property - the gate, the well house, the dock - where Wi-Fi, Zigbee, and Z-Wave can't reach.

Requirements

· A YoLink account with a hub and your devices added in the YoLink app.

User Access Credentials (UAC): in the YoLink app go to Me/Settings > Account > Advanced Settings > User Access Credentials and note your UAID (starts with `ua_`) and Secret Key (starts with `sec_`). That's all Cloud mode needs.

An RTI XP processor (firmware v24+) with internet access (Cloud mode reaches api.yosmart.com over HTTPS).

*Optional, Local Hub mode:* only if you have a YS1606 Local Hub with Local API enabled (Local Hub > Local Network > Integrations > Local API) for fully-local, no-cloud control.

Setup

1. Leave Connection Mode on Cloud (default). Paste your UAID into "UAID / Client ID" and your Secret Key into "Secret Key / Client Secret". Leave Hub IP blank. (For Local Hub mode: switch the mode, fill in the Hub IP, and use the Local API Client ID/Secret instead.)

2. Under Devices, each slot pre-fills with "Device 1...24". Change the slots you're using to match your YoLink device names exactly as they appear in the YoLink app (case-insensitive); leave the rest as "Device N" and they stay disabled. (The name typed when adding a source to a room is an RTI label only - the driver binds by the name set here in Driver Properties, and that name is what shows in the Variables/Events tree.)

3. Transfer the system. The driver authenticates, runs discovery, and binds each named slot to its device automatically. Hub Connected goes true and devices come online within a poll cycle.

4. Run Discover Devices any time you add YoLink devices; telnet the debug console (port 12509, command `devices`) to see the exact device names YoLink reports.

What the driver gives you

Per-device state - each configured slot exposes: Online, State (open/closed, normal/alert, locked/unlocked, etc.), a normalized Active flag, Alert, Battery percent (mapped from YoLink's 0-4 scale), Low Battery, Temperature, Humidity, Brightness, Valve, Lock, Mode, thermostat setpoints, plus Last Event / Last Error. The driver populates whichever fields a given device type reports.

Generic, type-routed commands - one set of functions that dispatch to the right YoLink method based on each slot's discovered type:

· On / Off / Toggle / Set Brightness - Switch, Outlet, MultiOutlet, Dimmer, Manipulator; Toggle also drives GarageDoor / Finger momentary pulses.

Open Valve / Close Valve - Manipulator, WaterLeakController, WaterMeterController.

Lock / Unlock - LockV2 smart locks.

Siren Start / Stop.

Speaker Play Tone / Say Message (TTS) / Set Volume - SpeakerHub.

Thermostat Set Mode / Heat / Cool / Fan.

IR Send Key, CO/Smoke Self Check.

Aggregates - Total Devices, Total Online, Any Alert, Any Low Battery, Active Alerts List - perfect for a panel header.

The signature automation: a leak sensor goes to alert -> macro closes the water valve and the SpeakerHub announces "Water leak in the basement." Property protection a dealer can actually sell, entirely local.

Events - per device: Online / Offline, State Changed, Alert / Alert Cleared, Low Battery, Button Pressed (FlexFob remotes). Plus Hub Connected / Disconnected, Devices Discovered, and trial/license events.

v1.0 scope notes

· State is polled (default every 15 seconds). Real-time MQTT push from the Local Hub broker lands in v1.1 for instant leak/door alerts. For most automations the poll interval is more than adequate.

Lock control requires a LockV2 device. First-generation YoLink locks expose state only (no remote lock/unlock) by YoLink's design.

GarageDoor / Finger are momentary - they send a press, not an absolute open/close, and report no position. Pair with a YoLink door sensor on a separate slot to know the actual open/closed state.

Siren is alarm on/off only; tone and volume are configured in the YoLink app.

Troubleshooting

Hub Status shows "Auth Failed" or "Offline".

Cloud mode: re-check your UAID + Secret Key from Account > Advanced Settings > User Access Credentials (UAID starts with `ua_`, Secret Key with `sec_`), and confirm Connection Mode is Cloud. Local Hub mode: re-check the Local API Client ID/Secret and that the Hub IP is reachable from the processor's subnet.

A device slot shows no Type / "no YoLink device named ...".

The slot name must match the device name in the YoLink app. Open the debug console and run `devices` to list the exact names the hub reports, then correct the slot name.

Diagnostic debug console.

Telnet the processor IP on port 12509 (configurable under Debug). Commands: `state`, `devices` (lists discovered devices + types + IDs), `discover`, `refresh`, `log off|low|med|high`, `quit`.

Licensing

A 120-minute trial is included for evaluation. Paste your purchased licence key under Licensing to unlock permanently. The licence is bound to the processor's MAC address.