WiiM Receiver and Amplifier

Version History

Version 1.00: Initial public release.

Version 1.01: Fixed certification issues and removed unnecessary variables.

Version 1.02: Fixed settings, variables, and synchronization issues.

Version 1.03: Fixed a crash issue and resolved the device online issue.

Version 1.04: Fixed volume repeat and connectivity-related issues.

Version 1.05: Fixed the Volume issue and add Set and Clear functions for Repeat Ex.

Driver Features

This driver enables network control of WiiM devices and has been built and tested with Mini, Pro, Plus, Amp, and Ultra models.

System Requirements & Prerequisites

RTI System Requirements

Integration Designer: 11.8.1

XP FW: 24.3.29

Driver Configuration

Device Names

Number of Players

– The number of players you wish to control.

Player

– Name: Give the player a display name (this does not need to match the WiiM defined name).

– MAC address: Enter the MAC address of the device to be controlled.

Template Page Name:

Default: WiiM

Secondary: Music Player

Works with WiiM

To clarify: You do not need to add every WiiM device on the network to the driver configuration. Only add the devices you wish to control.

Identifying Players

The driver requires the MAC address of the players, which can be found on the packaging or in the WiiM Home app. The configured names will appear when programming in Integration Designer (ID). When the system is running, you can choose between the configured name or the current name of the player in the system.

**Important note**: Only players which you wish to control should be put in the driver properties, this will help alleviate some CPU load from the driver.

Audio Player Control

The driver gives you all the audio controls for up to 32 players, including a 'selected' player: Transport, volume, play mode (shuffle, repeat) etc. It also allows you to choose any of the programmed 'Favorites' in the WiiM System.

Favorites/Playlist

The driver keeps a copy of the WiiM Favorites and Playlist. The main interface to this list is through the Favorites List and Playlist variables. Clicking a song in the Favorites list will play the corresponding track on the WiiM device. Similarly, clicking a song in the Playlist will play the track on the WiiM device.

Groups

You can complete the grouping and ungrouping functions on the Grouping page by selecting and deselecting speakers.

When grouping two players, caution is required. This must be done through the app, not the driver. The master device in the pair will receive all commands, while the other speaker becomes 'invisible' in the system and cannot respond to commands. Only the master needs to be included in the configuration. If both players are left in the configuration, the driver will automatically send commands to the correct player.

If you need to create a new group, you must start adding from Player 1 again when adding the WiiM driver in Integration Designer.

Driver Events

Driver events will be triggered on a change in the players transport status. Events are available for Stop, Pause, Play and Buffering. An additional event is available for a change in song title.

A driver event will also be triggered every time a player is sent a volume up or down command. This will help when volume commands are being sent to selected players.

Transport Control

Visibility variables accompanying each of the transport commands. Using the variables allow you to display only the buttons for currently relevant commands. For instance, the Show Previous Command will be false when a Pandora station is playing. If you use that as visibility on a Skip Back button it will disappear when a Pandora Station is playing. In addition a similar variable is available for Repeat and Shuffle; using that variable will allow your repeat buttons to only appear when they are relevant.

Template Information

The driver uses the following template: WiiM, Music Player

System Testing

Integration Designer: 11.8.1

XP Processor Model: KX4

XP Processor Firmware: 24.3.29

Device Model(s): Mini, Pro, Plus, Amp, Ultra