LinkPlay (WiiM, Arylic…) smart home integration, free and open source
Control WiiM, Arylic, Audio Pro and other LinkPlay players: sources, presets, groups. Local.
Published by guim31
- Devices
- Version 1.0.1
- Requires Gladys >=5.2.0
- ★ 0
Control your streamers and speakers built on the LinkPlay platform — WiiM, Arylic, Audio Pro, iEAST, ArtSound and others — from Gladys, 100 % local: playback, volume, sources, presets, multiroom groups, announcements.
This integration is not affiliated with LinkPlay, WiiM, Arylic or Audio Pro. Developed without the hardware: feedback welcome. It follows the HTTP API these players share, and the answers of real players published by the Home Assistant project; please report what works and what does not on your model.
Overview
The integration talks to each player through its local HTTP API
(/httpapi.asp), the same on every LinkPlay firmware. It needs no account and
no cloud.
Known players: WiiM Mini, Pro, Pro Plus, Amp, Amp Pro, Amp Ultra, Ultra; Arylic Up2Stream (Amp, Pro, Mini, Plate Amp), S10+, S50+, S50 Pro, A30, A50, A50+; Audio Pro C3, C10, A10 (first generation); iEAST AudioCast M5; ArtSound Smart Zone 4, Smart Hyde; GGMM E2; Medion, August, Triangle and Muzo models. Other LinkPlay players usually work too, under a generic name.
LinkPlay or DLNA? The DLNA integration plays media on any UPnP renderer, LinkPlay players included. LinkPlay is the complete control of these players: inputs (TV, optical, Bluetooth...), presets, multiroom groups, WiiM equalizer, announcements over the music. Pick one of the two for a given player, to avoid having it twice in Gladys.
Requirements
- Gladys 5.2.0 or later.
- The players on the network of Gladys, already set up with their app (WiiM Home, 4STREAM, Audio Pro...).
- For the automatic discovery, Gladys and the players on the same network (mDNS and SSDP do not cross routers). Otherwise, give their addresses.
Configuration
Finding the players
Open the Discover tab of the integration: the players found by Gladys
(mDNS _linkplay._tcp and SSDP) appear there; add the ones you want. A player
that follows a multiroom group is found through its group leader.
Configuration fields
| Field | Use |
|---|---|
| Player addresses | Optional. IP addresses or host names, separated by commas, for players the discovery does not see (another network, VLAN). http:// or a port can be given when a player needs it. |
| Language of names and messages | Names of the features of the players added from now on (Gladys keeps them once a player is added), names of the sources, messages of commands and scenes. French by default. |
Actions
- Search for players: searches now, updates the Discover tab, and lists what answered, the configured addresses that did not, and the ignored entries.
- Test an address: asks one address and shows the model, the firmware, how it answers (HTTPS or HTTP) and its sources.
What each player does
Each player is one Gladys device, named as in its app.
Playback and volume
| Feature | Type | What it does |
|---|---|---|
| Play | music / play | Resumes the playback |
| Pause | music / pause | Pauses |
| Stop | television / stop | Stops (a button in the room card) |
| Previous, Next | music / previous, next | Previous or next track |
| Volume | music / volume (0-100) | Reads and sets the volume |
| Mute | television / volume-mute | Mutes, or unmutes when muted (a button) |
| Playback state | music / playback_state | 1 while playing, 0 otherwise (kept in the history) |
The Music widget of the Gladys dashboard uses these features.
Source and equalizer
- Source (a list): the inputs this player has — network (Wi-Fi), Bluetooth, line in, optical, coaxial, HDMI / ARC, phono, USB... Choosing one switches the player to it. While a player follows a group, it has no source of its own.
- Equalizer (WiiM only): the equalizer presets of the WiiM (Flat, Rock, Jazz...) or "Off". The WiiM API tells whether the equalizer is on, not which preset: one chosen in the WiiM Home app shows as unknown until you choose it in Gladys.
Titles and group
- Title, Artist, Album: what plays; "—" when the source gives nothing (an input, a player following a group).
- Multiroom group: "Not grouped", "Leads: Kitchen, Bedroom" or "Follows: Living room".
Talk on a speaker
The Talk on a speaker action of the Gladys scenes speaks on the player. On a WiiM, the announcement plays over the music, which resumes after it. On a firmware without that command, the announcement replaces the music: if an input (TV, line in...) was playing, the player switches back to it afterwards; a network stream (Spotify, a web radio) is not restarted — start it again with a preset in the next action of the scene. Gladys does not pass the volume of the action to the integration.
Widget
The LinkPlay widget (dashboard → add a box → LinkPlay, then choose the player) shows the title, the artist and album, the live volume, the source, the state and the group, and four buttons: Previous, Play / Pause, Next and Presets, which opens the list of presets (with their names on a WiiM) and plays the chosen one.
Scene trigger
LinkPlay source changed: a player switched to another input. Filters: the player (empty: any) and the new sources (empty: any). Variables: player, new source (its name, and its key), previous source (key).
It does not fire for a source chosen from Gladys (a scene could loop on it), nor during an announcement.
Scene actions
| Action | Fields | Result |
|---|---|---|
| Play a LinkPlay preset | Player, preset number, volume (optional) | Preset name (WiiM) |
| Play an address on LinkPlay | Player, http(s) address, volume (optional) | — |
| Group LinkPlay players | Player that joins, group leader | — |
| Ungroup a LinkPlay player | Player | — |
The presets are the ones saved in the app of the player (6 to 12 depending on the model). Ungrouping a group leader dissolves its whole group.
Scene examples
- Movie night: trigger "LinkPlay source changed", player "Living room", source "HDMI ARC" → dim the living room lights.
- Wake up: every weekday at 7:00 → "Play a LinkPlay preset" on "Kitchen", preset 1, volume 20, then "Group LinkPlay players": "Bathroom" joins "Kitchen".
- Doorbell: the doorbell rings → "Talk on a speaker" on "Living room": "Someone is at the door".
- Leaving home: the house is empty → "Ungroup" then stop every player.
Refresh and network traffic
The integration polls the players added to Gladys by itself: every 5 seconds while a player plays, every 30 seconds otherwise, every minute while it does not answer, and right after an order. A poll is one or two requests on the local network; the group and the equalizer are read every 30 seconds, the player details every 10 minutes. The players have no quota; nothing leaves your network.
Only the values that change are sent to Gladys (and every 6 hours anyway, so that Gladys never shows them as old). The network is searched at start-up, on Search for players, and every 5 minutes while an added player is missing (a new address after a router restart is found again by itself).
Troubleshooting
- A player is not found: it is on another network, or mDNS / SSDP do not reach Gladys. Use Test an address, then add its address in the configuration.
- "does not answer": check that the player is on and on the network. The integration tries HTTPS (port 443, the self-signed certificate of the player is accepted), then HTTP (port 80).
- A source is missing from the list: the player does not declare it; tell us its model.
- Titles show "—": the source gives no titles (an input, some services).
- More details: set the
LOG_LEVELvariable todebugon the integration; the logs never show the address of an announcement whole.
Limits
- Developed without the hardware: the commands come from the shared LinkPlay API and from public answers of real players, not from a test on each model.
- The recent Audio Pro players that only answer on port 4443 with a client certificate are not supported yet.
- Preset names come from WiiM players only; elsewhere the presets are numbered.
- No seek, shuffle or repeat, no browsing of a music library: the DLNA integration does that.
- A player following a group shows no titles; the volume of a whole group is not handled (each player keeps its own).
- The equalizer state is unknown when changed from the WiiM Home app.
Configuration settings
These are the settings LinkPlay (WiiM, Arylic…) asks for in its configuration screen in Gladys.
| Setting | Type | Required | Description |
|---|---|---|---|
| Finding your players | section | No | The LinkPlay players of your network (WiiM, Arylic, Audio Pro, iEAST...) are found automatically: open the Discover tab and add the ones you want. A player on another network (VLAN, other subnet) can be added by its address below. |
| Player addresses (optional) | string | No | One or several IP addresses or host names, separated by commas. Use the "Test an address" action to check one first. |
| Language of names and messages | select | No | Names of the features of the players added from now on (Gladys keeps them once a player is added), source names, and messages of commands and scenes. |
How to install LinkPlay (WiiM, Arylic…) in Gladys
- In Gladys, open Integrations: LinkPlay (WiiM, Arylic…) appears in the catalog, next to the native integrations, with a community badge.
- Click Install. Gladys pulls the Docker image (
ghcr.io/guim31/gladys-linkplay:1.0.1), starts it in a sandbox isolated from the core, and generates the integration's interface (devices, discovery and configuration). - Open the Configuration screen of the integration, fill in the settings, and save.
- You can also install it directly from its repository URL: https://github.com/guim31/gladys-linkplay.
LinkPlay (WiiM, Arylic…) requires Gladys >=5.2.0. The catalog inside Gladys refreshes every hour, so a new version becomes available at most one hour after its release.
Not running Gladys yet? It is free and open source: follow the installation guide to get started.
About external integrations
LinkPlay (WiiM, Arylic…) is an external integration: a community integration packaged as a Docker container and published on GitHub, that Gladys installs in one click and runs in a sandbox isolated from its core. It is published and maintained by guim31, not by the Gladys core team.
- Browse all external integrations
- Discover the native integrations built into Gladys
- Build and publish your own external integration
- Source code on GitHub — source of this documentation