WIP/Control4

From LinnDocs
Revision as of 07:04, 17 August 2023 by Yoda (talk | contribs) (→‎Linn DS/Control4 versions)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

CTRL4.png Control 4 Linn DS Driver

The Control4 drivers do not look for Linn DS/DSM players by their names but for capabilities. That is, searches for UPnP services of the Linn DS/DSM products and adjusts accordingly.

Kazoo Server can be downloaded from Linn.co.uk > Software & Apps

This allows new firmware features and new product support WITHOUT the need for any Control4 driver updates.

IMPORTANT NOTICE

If you are installing Linn Network, DS or Kustom drivers into a system that already contains versions of these drivers older than version 147 you must update all of these existing drivers to the latest version as the connections and internal communication protocols have changed. To do this:
- Download the latest online version of the drivers by going to the Search tab, unticking “Local”, finding the driver and then right-clicking and selecting “Download Driver”.
- Update each driver by right-clicking on an instance of it in your project hierarchy, selecting “Update Driver” and choosing the driver file you have downloaded.
If a simple update does not appear to have resulted in a working system, you may need to reinstall the drivers:
- Delete all instances of all Linn drivers in your project
- Re-install the drivers and their connections. The previous stages are necessary to ensure that you get the latest version of the driver when you do this install; just deleting and re-installing can end up with an older version that has been cached on the Director.

Linn DS/Control4 versions

Linn DS Series V171 25th March 2023 (for C4 OS 3.20 onwards)

  • It can be downloaded from
  • OS 3.20 onwards compatible
  • This is compatible with Kustom DSM
  • Requires Linn DS firmware Davaar 100 or higher
Added:
> Support of embedded "CI Gateway" on newer Linn DS/DSM products
> airable radio support.
> Modular operation to allow easier future improvements. This also allows you to remove any/all service modules except "Linn Songcast Network" to give you basic source selection, volume control & room grouping .
> Gateway V2 support
Requirements
• Gateway API Server
○ Kazoo Server 4.11.27+ or
○ Linn DS with Davaar 4.100+ with CI Gateway enabled.
Note
Using the CI Gateway disables the Create/Recall Playlist option.
Variable summary (also listed in each Module Documentation section)
Variable Summary
Linn Network
The driver has the following read-only variables in addition to the standard variables defined by Control4:
Variable Purpose
CONNECT_STATE Indicates the state of the connection from the driver to the Kazoo server gateway:
0 Not connected.
1 Connecting.
2 Connected.
32767 Fully initialised and operational.

Linn DS Series
The driver has the following read-only variables in addition to the standard variables defined by Control4:
Variable Purpose
INPUT_NUMBER Indicates which input is currently supplying audio to the room output:
-2 Songcast from a remote streamer.
-1 The local streamer.(Playlist/Radio)
0 Nothing
1..32 External input 1..32; see Properties to determine which input number corresponds to which input device.
Note that it is not guaranteed that the input number is 0 when the room is off, so programming should not rely on this nor on receiving a change in this value when the room switches on.

SOURCE_NAME The name of the currently playing source. Names are as defined on the DS using Konfig.
PAUSED true if playback is paused, else false.
PLAYING true if playback active, else false.
STOPPED true if playback stopped, else false.
PLAY_STATUS One of the following values:
PLAYBACK_STATE_IDLE Playback has stopped.
PLAYBACK_STATE_PAUSED Playback is paused.
PLAYBACK_STATE_PLAYING Playback is active.



Kustom DSM
The driver has the following read-only variables in addition to the standard variables defined by Control4:
Variable Purpose
ZONE_N_INPUT_NUMBER Indicates which input is currently supplying audio to zone N:
-2 Songcast from a remote streamer.
-1 The local streamer.(Playlist/Radio)
0 Nothing
1..4 External input 1..4; see Properties to determine which input number corresponds to which input device.
Note that it is not guaranteed that the input number is 0 when the room is off, so programming should not rely on this nor on receiving a change in this value when the room switches on.

ZONE_N_SOURCE_NAME The name of the currently playing source in zone N. Names are as defined on the Kustom using Konfig.
STREAMER_N_PAUSED true if playback on streamer N is paused, else false.
STREAMER_N_PLAYING true if playback on streamer N active, else false.
STREAMER_N_STOPPED true if playback on streamer N stopped, else false.
STREAMER_N_PLAY_STATUS A string value giving playback state on streamer N:
PLAYBACK_STATE_IDLE Playback has stopped.
PLAYBACK_STATE_PAUSED Playback is paused.
PLAYBACK_STATE_PLAYING Playback is active.
  • If you wish to update your Control4 from an earlier "Linn DS Series" driver, then we would recommend a fresh Project is created with V171
  • Or if you already have the "Linn DS Network (32 Players) + Pins" or "Linn DS Network (32 Players)":
IMPORTANT NOTICE
If you are installing Linn Songcast Network, DS or Kustom drivers into a system that already contains versions of these drivers older than version 170 you must update all of these existing drivers to the latest version as the connections and internal communication protocols have changed.
To do this:
- Remove any instances of the Linn DS Network or Linn DS Network + Pins driver in the system (these are replaced by the new Linn Songcast Network driver).
- For off-line drivers, that you have downloaded from above:
- In the top menu select Driver > Add or Update Driver or Agent
* Add each of the .c4z files one at a time
- For online drivers: Download and install the latest online version of the Linn Songcast Network driver by going to the Search tab, unticking “Local”, finding the driver and then right-clicking and selecting “Download Driver”.
- Download the latest online version of the any DS or Kustom drivers by going to the Search tab, unticking “Local”, finding the drivers and then right-clicking and selecting “Download Driver”.
- Update each driver either by using the Driver->Manage Drivers and Agents dialog, or by right-clicking on an instance of it in your project hierarchy, selecting “Update Driver” and choosing the driver file you have downloaded.
NOTE: It is important for the smooth installation of media player drivers that the network driver is added prior to the player drivers. The configuration of the player drivers cannot be completed without the network driver being in place and communicating correctly with a Linn CI-Gateway.


If a simple update does not appear to have resulted in a working system, you may need to reinstall the drivers:
- Delete all instances of all Linn drivers in your project.
- From the "Connect to Project" dialog that Composer shows when selecting a local system, right-click on your controller and select Terminal.
- Type the following commands at the terminal prompt (shown in grey):
~# cd /mnt/internal/c4z
/mnt/internal/c4z# rm -r comms_ip_linn*
/mnt/internal/c4z# rm -r mediaservice_ip_linn*
/mnt/internal/c4z# reboot
The terminal window will lose connection after the reboot and you can close it.
- Close all open instances of Composer.
- Re-open Composer and re-install the drivers and their connections.
The previous stages are necessary to ensure that you get the latest version of the driver when you do this install; just deleting and re-installing can end up with an older version that has been cached on the Director.
---RECOMMEND USING KAZOO SERVER V4.11.27 or system that do not have Products providing Gateway API ---
---Or CI GATEWAY on newer products



Linn DS Series V168 5th Oct 2022 (for C4 OS 3.20 onwards)

  • It can be downloaded from
  • OS 3.23 onwards compatible
  • This is compatible with Kustom DSM
Added:
> Improved browsing of Streaming services, (Qobuz, Tidal, Calm Radio)
> Improvements in Kustom DSM control.
Variable summary (also listed in each Module Documentation section)
Variable Summary
Linn Network
The driver has the following read-only variables in addition to the standard variables defined by Control4:
Variable Purpose
CONNECT_STATE Indicates the state of the connection from the driver to the Kazoo server gateway:
0 Not connected.
1 Connecting.
2 Connected.
32767 Fully initialised and operational.

Linn DS Series
The driver has the following read-only variables in addition to the standard variables defined by Control4:
Variable Purpose
INPUT_NUMBER Indicates which input is currently supplying audio to the room output:
-2 Songcast from a remote streamer.
-1 The local streamer.(Playlist/Radio)
0 Nothing
1..32 External input 1..32; see Properties to determine which input number corresponds to which input device.
Note that it is not guaranteed that the input number is 0 when the room is off, so programming should not rely on this nor on receiving a change in this value when the room switches on.

SOURCE_NAME The name of the currently playing source. Names are as defined on the DS using Konfig.
PAUSED true if playback is paused, else false.
PLAYING true if playback active, else false.
STOPPED true if playback stopped, else false.
PLAY_STATUS One of the following values:
PLAYBACK_STATE_IDLE Playback has stopped.
PLAYBACK_STATE_PAUSED Playback is paused.
PLAYBACK_STATE_PLAYING Playback is active.



Kustom DSM
The driver has the following read-only variables in addition to the standard variables defined by Control4:
Variable Purpose
ZONE_N_INPUT_NUMBER Indicates which input is currently supplying audio to zone N:
-2 Songcast from a remote streamer.
-1 The local streamer.(Playlist/Radio)
0 Nothing
1..4 External input 1..4; see Properties to determine which input number corresponds to which input device.
Note that it is not guaranteed that the input number is 0 when the room is off, so programming should not rely on this nor on receiving a change in this value when the room switches on.

ZONE_N_SOURCE_NAME The name of the currently playing source in zone N. Names are as defined on the Kustom using Konfig.
STREAMER_N_PAUSED true if playback on streamer N is paused, else false.
STREAMER_N_PLAYING true if playback on streamer N active, else false.
STREAMER_N_STOPPED true if playback on streamer N stopped, else false.
STREAMER_N_PLAY_STATUS A string value giving playback state on streamer N:
PLAYBACK_STATE_IDLE Playback has stopped.
PLAYBACK_STATE_PAUSED Playback is paused.
PLAYBACK_STATE_PLAYING Playback is active.
  • If you wish to update your Control4 from an earlier "Linn DS Series" driver, then we would recommend a fresh Project is created with V156
---RECOMMEND USING KAZOO SERVER V4.11.16 or later---

Linn DS Series V167 Beta 23rd Dec 2021 (for C4 OS 3.20 onwards)

  • It can be downloaded from
  • OS 3.23 onwards compatible
  • This is compatible with Kustom DSM
Added:
> Updated common operational libraries
Variable summary (also listed in each Module Documentation section)
Variable Summary
Linn Network
The driver has the following read-only variables in addition to the standard variables defined by Control4:
Variable Purpose
CONNECT_STATE Indicates the state of the connection from the driver to the Kazoo server gateway:
0 Not connected.
1 Connecting.
2 Connected.
32767 Fully initialised and operational.

Linn DS Series
The driver has the following read-only variables in addition to the standard variables defined by Control4:
Variable Purpose
INPUT_NUMBER Indicates which input is currently supplying audio to the room output:
-2 Songcast from a remote streamer.
-1 The local streamer.(Playlist/Radio)
0 Nothing
1..32 External input 1..32; see Properties to determine which input number corresponds to which input device.
Note that it is not guaranteed that the input number is 0 when the room is off, so programming should not rely on this nor on receiving a change in this value when the room switches on.

SOURCE_NAME The name of the currently playing source. Names are as defined on the DS using Konfig.
PAUSED true if playback is paused, else false.
PLAYING true if playback active, else false.
STOPPED true if playback stopped, else false.
PLAY_STATUS One of the following values:
PLAYBACK_STATE_IDLE Playback has stopped.
PLAYBACK_STATE_PAUSED Playback is paused.
PLAYBACK_STATE_PLAYING Playback is active.



Kustom DSM
The driver has the following read-only variables in addition to the standard variables defined by Control4:
Variable Purpose
ZONE_N_INPUT_NUMBER Indicates which input is currently supplying audio to zone N:
-2 Songcast from a remote streamer.
-1 The local streamer.(Playlist/Radio)
0 Nothing
1..4 External input 1..4; see Properties to determine which input number corresponds to which input device.
Note that it is not guaranteed that the input number is 0 when the room is off, so programming should not rely on this nor on receiving a change in this value when the room switches on.

ZONE_N_SOURCE_NAME The name of the currently playing source in zone N. Names are as defined on the Kustom using Konfig.
STREAMER_N_PAUSED true if playback on streamer N is paused, else false.
STREAMER_N_PLAYING true if playback on streamer N active, else false.
STREAMER_N_STOPPED true if playback on streamer N stopped, else false.
STREAMER_N_PLAY_STATUS A string value giving playback state on streamer N:
PLAYBACK_STATE_IDLE Playback has stopped.
PLAYBACK_STATE_PAUSED Playback is paused.
PLAYBACK_STATE_PLAYING Playback is active.
  • If you wish to update your Control4 from an earlier "Linn DS Series" driver, then we would recommend a fresh Project is created with V156
---RECOMMEND USING KAZOO SERVER V4.11.16 or later---



Linn DS Series V166 Certified & released 14th Oct 2021 (for C4 OS 3.20 onwards)

  • It can be downloaded from
  • GITHUB if you have given permission as a Collaborator
  • Linn Docs NOTES section or downloaded from >HERE< until available in Composer Pro
  • Linn Resources (Retailer only website, listed under any Linn DS/DSM product)
  • OS 3.20 onwards compatible
  • This is compatible with Kustom DSM
Added:
> Fix for defining Kazoo Server IP
> Report Transport states Inputs
> On screen reports when Tidal or Qobuz is not logged in.
> Reports connection state of Kazoo Server
Variable summary (also listed in each Module Documentation section)
Variable Summary
Linn Network
The driver has the following read-only variables in addition to the standard variables defined by Control4:
Variable Purpose
CONNECT_STATE Indicates the state of the connection from the driver to the Kazoo server gateway:
0 Not connected.
1 Connecting.
2 Connected.
32767 Fully initialised and operational.

Linn DS Series
The driver has the following read-only variables in addition to the standard variables defined by Control4:
Variable Purpose
INPUT_NUMBER Indicates which input is currently supplying audio to the room output:
-2 Songcast from a remote streamer.
-1 The local streamer.(Playlist/Radio)
0 Nothing
1..32 External input 1..32; see Properties to determine which input number corresponds to which input device.
Note that it is not guaranteed that the input number is 0 when the room is off, so programming should not rely on this nor on receiving a change in this value when the room switches on.

SOURCE_NAME The name of the currently playing source. Names are as defined on the DS using Konfig.
PAUSED true if playback is paused, else false.
PLAYING true if playback active, else false.
STOPPED true if playback stopped, else false.
PLAY_STATUS One of the following values:
PLAYBACK_STATE_IDLE Playback has stopped.
PLAYBACK_STATE_PAUSED Playback is paused.
PLAYBACK_STATE_PLAYING Playback is active.



Kustom DSM
The driver has the following read-only variables in addition to the standard variables defined by Control4:
Variable Purpose
ZONE_N_INPUT_NUMBER Indicates which input is currently supplying audio to zone N:
-2 Songcast from a remote streamer.
-1 The local streamer.(Playlist/Radio)
0 Nothing
1..4 External input 1..4; see Properties to determine which input number corresponds to which input device.
Note that it is not guaranteed that the input number is 0 when the room is off, so programming should not rely on this nor on receiving a change in this value when the room switches on.

ZONE_N_SOURCE_NAME The name of the currently playing source in zone N. Names are as defined on the Kustom using Konfig.
STREAMER_N_PAUSED true if playback on streamer N is paused, else false.
STREAMER_N_PLAYING true if playback on streamer N active, else false.
STREAMER_N_STOPPED true if playback on streamer N stopped, else false.
STREAMER_N_PLAY_STATUS A string value giving playback state on streamer N:
PLAYBACK_STATE_IDLE Playback has stopped.
PLAYBACK_STATE_PAUSED Playback is paused.
PLAYBACK_STATE_PLAYING Playback is active.
  • If you wish to update your Control4 from an earlier "Linn DS Series" driver, then we would recommend a fresh Project is created with V156
---RECOMMEND USING KAZOO SERVER V4.11.16 or later---



Linn DS Series V161 Certified & released 29th January 2021 (for C4 OS 3.20 onwards)

  • It can be downloaded from
  • GITHUB if you have given permission as a Collaborator
  • Linn Docs NOTES section or downloaded from >HERE< until available in Composer Pro
  • Linn Resources (Retailer only website, listed under any Linn DS/DSM product)
  • OS 3.20 onwards compatible
  • This is compatible with Kustom DSM
Added:
> Button images added for PIN selection
  • If you wish to update your Control4 from an earlier "Linn DS Series" driver, then we would recommend a fresh Project is created with V156
---RECOMMEND USING KAZOO SERVER V4.10.14 or later---



Linn DS Series V160 Certified, January 2021 (for C4 OS 3.20 onwards)

  • It can be downloaded from
  • GITHUB if you have given permission as a Collaborator
  • Linn Docs NOTES section or downloaded from >HERE< until available in Composer Pro
  • Linn Resources (Retailer only website, listed under any Linn DS/DSM product)
  • OS 3.20 onwards compatible
  • This is compatible with Kustom DSM
Added:
> Better integration from earlier module versions
> Refresh button to force Linn DS current input setup into Control4
  • If you wish to update your Control4 from an earlier "Linn DS Series" driver, then we would recommend a fresh Project is created with V156
---RECOMMEND USING KAZOO SERVER V4.10.14 or later---



Linn DS Series V157 Certified November 2020 (for C4 OS 3.20 onwards)

  • It can be downloaded from
  • GITHUB if you have given permission as a Collaborator
  • Linn Docs NOTES section or downloaded from >HERE< until available in Composer Pro
  • Linn Resources (Retailer only website, listed under any Linn DS/DSM product)
  • OS 3.20 onwards compatible
  • This is compatible with Kustom DSM
Added:
> Put Zone/Room into Standby to break from Songcast/Grouping
  • If you wish to update your Control4 from an earlier "Linn DS Series" driver, then we would recommend a fresh Project is created with V156
---RECOMMEND USING KAZOO SERVER V4.10.14 or later---



Linn DS Series V156 October 2020 (for C4 OS 3.20 onwards)

  • It can be downloaded from
Added:
> OS 3.20 onwards compatible
  • If you wish to update your Control4 from an earlier "Linn DS Series" driver, then we would recommend a fresh Project is created with V156
---RECOMMEND USING KAZOO SERVER V4.10.14 or later---

Linn DS Series V154 Certification June 2020

  • It can be downloaded from
  • OS 3 compatible (UPDATE: This works up to and including Control4 OS 3.1.3. OS 3.20 loses streaming sources)
  • This is compatible with Kustom DSM
Added:
> Linn PINS (Make sure you update your Linn DS Network driver to Linn DS Network + Pins driver)
> Improved Room Songcast/Grouping
  • If you wish to update your Control4 from an earlier "Linn DS Series" driver, then we would recommend a fresh Project is created with V154

Linn DS Series V146 December 2019

  • It can be downloaded from
Added
> OS 3 compatible
> This is compatible with Kustom DSM
  • If you wish to update your Control4 from an earlier "Linn DS Series" driver, then we would recommend a fresh Project is created with V146.

Linn DS Series V129 Certified February 2019

  • OS 2 & OS 3 compatible

Added:

> External audio switches such as TRIAD
> Source only used for use with other Pre-amplifiers
  • This driver is incompatible with Kustom DSM, but can be used with all other Linn DS players.

Setting up the CI Gateway for Control4 use

A Crestron (driver V1.0.2 onwards) or Control (driver V171 onwards) system, requires a Gateway to interpret between control system and Linn DS control. In earlier versions of drivers, this was solely using Linn Kazoo Server with Gateway enabled.
But with update is Linn DS/DSM firmware - Davaar 100 or higher, and updated hardware, allows the Gateway interface to be embedded into these Linn products, removing the requirement of Linn Kazoo Server. Products with updated hardware are listed >HERE<
To enable the embedded CI Gateway
  1. Go into Manage System and select a Linn DS/DSM with the embedded Gateway
  2. Go into Advanced
  3. And turn ON the "CI Gateway" option
  4. If the CI Gateway was previously turned off, and you have turned it on, then you will need to reboot/power cycle your Linn DS/DSM to provide this service.
MS CI Gateway.png
Note
  • On reboot, the "CI Gateway" service is available approx 3 minutes after a power cycle/reboot.
  • If the CI Gateway is not shown, then either the Linn DS/DSM does not have the hardware to support this option, or it does not have Davaar97 or higher version.

Products providing Gateway API - Davaar 100 onwards
▼ Gateway API
  Klimax DSM /3 (2020 Variant)
  Kustom DSM
  Majik DSM /4 (2020 Variant)
  Selekt DSM /0
  Selekt DSM /0 Classic Hub
  Selekt DSM /1 Classic Hub
  Selekt DSM /1 Edition Hub
  Series 3

Change streaming service account logins

Gateway Embedded Settings.png
On CI Gateway you will require to enter the Usernames and Password for the streaming services used.
To enter these Service Usernames etc, you need to know the IP address of the Linn DS/DSM and go into port 4100
That is: for Kustom DSM on IP address 192.168.1.49 then go into https://192.168.1.49:4100 into a web browser.


This will open the page on the right. You can now go into each section and either enter the Username and password for each Linn DS/DSM or global username and password for each service.






No CI Gateway then getting Kazoo Server Gateway enabled

If you do not have any of the products listed in the Products providing Gateway API in the system, then you will still require a PC/MAC or QNAP running.
For Crestron Linn-Lite, Crestron Linn DSM 4-Series driver or Control4 V171 and above then this requires Kazoo Server V4.11.27
To enable the CI Gateway, go to Kazoo Server setting and enable Gateway API
Kazoo Server Gateway.png

Troubleshooting:

I cannot get any of the Linn DS/Streamer services to appear in Navigator

* The Service will only appear if you have the Linn DS connected to an Audio End-Point.
If you are using this with a Matrix Switch then the Linn DS MUST be connected to Audio End-Point 2
* After installing the updated drivers, you will need to unbind and then rebind all the audio and video RoomControl connections to get the Streaming service to appear.


Sometimes my Control4 system operation slows down for a few minutes then works OK

This will be due to Control4 processor checking that all expected LInn DS players are alive. If one or more have been powered down or disconnected from the Network the Control4 will periodically interrogate the network for this/these missing Linn DS products.

In Tidal, I press the "Genres" button and Tidal stops working.

You are using an older verison of CI Gateway/Kazoo Server.
CI Gateway: Make sure you are using a Linn DS/DSM with Davaar100+ firmware
Or if you are using Kazoo Server check you are using V4.11.27+


I cannot control airable and/or Tidal on the Control4 touchpanel

Suspect that you are using Control4 driver V171, you are using an older verison of CI Gateway/Kazoo Server that is not compatible with V171.
CI Gateway: Make sure you are using a Linn DS/DSM with Davaar100+ firmware
Or if you are using Kazoo Server check you are using V4.11.27+
Retrieved from "https://docs.linn.co.uk/wiki/index.php?title=WIP/Control4&oldid=28704"