Personal tools

Linn Crestron Module

From LinnDocs

Jump to: navigation, search

Contents

Update

For information on the new Crestron control module under development, see here.


Overview

The Linn Crestron module allows a Linn system to be easily added into a Crestron installation. It provides all basic functionality required for using your Linn DS or DSM. The module makes use of the LPEC protocol to allow your Linn device to communicate with a Crestron system.

Full source code for this module has been released and can be used as is or modified to suit any given installation.

The module was developed using a Crestron CP3 processor and will require that or better to function.

Sample Crestron Application: Basic Functionality

Basic Functionality (Main room)

All core control functions are available for the main room:

Sample Crestron Application: Track Selection
  • Standby
  • Volume and mute
  • Source selection
  • Playback commands (play, pause, stop, skip, seek, repeat, shuffle)
  • Track selection from existing playlist
  • Radio selection from preset list (as well as radio next and previous)


All core feedback is provided as well:

  • Album art
  • Track metadata
  • Track details
  • Time
  • Playback state
  • All other states (i.e. volume, mute, standby)

Multi-room

The module also provides multi-room control for a configurable number of other rooms in the house.

  • Select another room to listen to using Songcast.
  • Change volume, mute and standby on all Linn devices from one place.
  • Toggle which Linn device is the main room for further control.
  • Tested with a six room installation but more can be added.

Sample Crestron Application: Multi-room Control

Kazoo Integration

  • For more rich functionality (i.e. playlist creation), the module provides integration with Kazoo.
  • It allows Kazoo to be opened directly to the selected room and view (i.e. music, radio, songcast, external inputs).
  • It also provides an option to open Kazoo in Tidal or Qobuz browse mode as well.
  • Kazoo is opened with a button in the top left to quickly return to Crestron.
  • The module also provides the ability to open the Linn device's configuration page in a web browser or jump directly to the TuneIn website for radio preset configuration.

Sample Crestron Application: Kazoo Integration

Download

Location

http://products.linn.co.uk/VersionInfo/Downloads/Releases/LinnCrestronModule_latest.zip

Contents

ExternalUrlSelector.usp

Small helper program for jumping to various Kazoo urls on mobile platforms.

LinnDsModule_SIMPL_Demo_CP3.smw

A complete Simpl Windows project demonstrating the Linn Crestron module.

This project includes a CP3 processor, 6 rooms and sample iPad and XPanel control applications (which can toggle control between the 6 rooms, created in Vt-Pro-e).

The rooms will need to have static IP addresses allocated to them (normally using a network router) and entered in the system setup.

LinnSimplModule vX.Y.umc

The Linn simpl module that can be easily dropped in to any Crestron program.

LinnSimplModuleHelp_vX.Y.pdf

A pdf file with a copy of the signal description documentation below.

LinnSimplPlusModule vX.Y.usp

The Simpl+ program used for proving Linn functionality.

LinnSimplSharpModule.clz

Compiled Simpl# code required by the Linn Simpl+ program.

LinnVtpExample_MobileSG.vtp

VT Pro example program for use with the Crestron App (mobile platforms i.e. iPad).

LinnVtpExample_XPanelSG.vtp

VT Pro example program for use with XPanel.

Lpec.cs

Simpl# source, handles the bulk of the Lpec processing required for providing Linn functionality.

Release Notes

4.3.1 (Released 16 Jul 2015)

  • Added support for international characters/fonts.

4.2.1 (Released 15 Jun 2015)

  • New and improved Simpl module.
  • New and improved Simpl Windows demo program which uses the new Simpl module.
  • New and improved VT Pro-e example control for mobile platforms.
  • New VT Pro-e example control for X-Panel.
  • Removed all UI formatting references from the Linn Simpl+ code.
  • Added Qobuz launch URL functionality.
  • Track playback duration now used to correctly track the progress of each track.
  • Fixed source selection bug (selecting internal sources via lists).

4.1.4 (Released 31 Mar 2015)

  • Disabled LPEC log messages from printing to the debug console.

4.1.3 (Released 31 Mar 2015)

  • Added a Simpl Windows demo program.
  • Added a VT Pro-e example GUI for demonstrating the full range of functionality.
  • Added a Simpl module that wraps the Simpl+ module.
  • Fixed bug in main processing loop that was causing CPU usage to go very high.
  • Fixed bug where source count and source index with an RS232 connected preamp could become out of sync.

4.1.2 (Released 27 Jan 2015)

  • Fixed bug on opening Kazoo from Crestron module when the selected room contains spaces in the room name.

4.1.1 (Released 26 Jan 2015)

  • Initial release of the Linn Crestron Module.
  • Includes support for all Linn products including DS and DSM at Davaar level.
  • Also handles connections with legacy preamp devices (i.e. Klimax Kontrol, Akurate Kontrol, etc).
  • Includes multi-room support (tested with 6 rooms but can handle more).
  • Includes Kazoo URL integration (jump to Kazoo which will present a back to Crestron button).

Getting Started

The demonstration programs using your preferred Crestron development environment (Crestron Studio or Simpl Windows/VT Pro-e) is the best way to see what the module is capable of and to help you get up and running with it.

Basic Setup

To get you started, each Linn DS or DSM in an installation needs a corresponding TCP/IP Client device to represent it – you must supply the static IP address of the DS/M (this must be allocated, normally using a network router).

The device then needs to be connected as per the image below. The signal names correspond to the signal names in the Linn Simpl module.

Connection

TCP/IP Client		Linn Simpl Module		Type
-------------    	----------------------------	------
Connect                 Lpec_Connect                   DIGITAL_OUTPUT
TX$			LpecRoom1/Main_tx$		STRING_OUTPUT
Connect-F		LpecRoom1/Main_Connected	DIGITAL_INPUT 
status		 	                                N/C
RX$		 	LpecRoom1/Main_rx$		BUFFER_INPUT

You should no longer need to worry about the LPEC command format (i.e. ACTION Ds/Volume...) as the module handles this for you. To establish volume control, you would just need to use the following from the Linn simpl module:

SetVolumeLevel#: supply an integer value to set the volume on the DS (ANALOG_INPUT)
VolumeLevel#: provides feedback from the DS as to its current volume (ANALOG_OUTPUT)

Simpl+ Constants

#DEFINE_CONSTANT ciROOMCOUNT 6 // number of rooms for module (including main room)
#DEFINE_CONSTANT ciMAINROOMINITIAL 1 // main room number (will boot to this initially)
#DEFINE_CONSTANT ciMAXSOURCES 50 // can be decreased as required
#DEFINE_CONSTANT ciMAXCHANNELS 100 // radio stations/presets referred to as channels
#DEFINE_CONSTANT ciMAXTRACKS 1000 // playlist
#DEFINE_CONSTANT ciSEEKSECONDS 20 // number of seconds to jump for each seek button press
#DEFINE_CONSTANT ciUSEVISIBLESOURCESONLY ciTRUE // true: use only configured visible sources
                                                // false: always use all sources

Signal Descriptions

Connection

InputDescription OutputDescription
LpecRoom1/Main_Connected Connect to the TCP/IP Connect-F signal for the main room (Room 1) Lpec_Connect Connect to the TCP/IP Connect signal for each room
[LpecRoomX_Connected] Connect to the TCP/IP Connect-F signal for the given room (X = 2 to ciROOMCOUNT)
LpecRoom1/Main_rx$ Connect to the TCP/IP RX$ signal for the main room (Room 1) LpecRoom1/Main_tx$ Connect to the TCP/IP TX$ signal for the main room (Room 1)
[LpecRoomX_rx$] Connect to the TCP/IP RX$ signal for the given room (X = 2 to ciROOMCOUNT) [LpecRoomX_tx$] Connect to the TCP/IP TX$ signal for the given room (X = 2 to ciROOMCOUNT)
[Refresh] Refresh the current state of all signals (performs a disconnect then reconnect) [HasProxyPreamp_fb] Flag to determine if a separate preamp device is connected over RS232 as a proxy device

Main

InputDescription OutputDescription
[StandbyToggle] Toggle the standby state of the main room [Standby_fb] The standby state of the main room
StandbyOn Put main room into standby
StandbyOff Bring main room out of standby [RoomName$] The user configured name of the main room
VolumeInc Increment volume of main room by 1dB [HasVolume_fb] Flag to determine if volume functions are currently available for the main room
VolumeDec Decrement volume of main room by 1dB [VolumeLevel$] The volume level in the main room as a string
[SetVolumeLevel#] Set the volume level of the main room (0 to 100, 1dB steps) [VolumeLevel#] The volume level of the main room
MuteToggle Toggle the mute state of the main room [Mute_fb] The mute state of the main room
[MuteOn] Mute the main room
[MuteOff] Unmute the main room
[SourceCount#] The number of sources available in the main room
SetSource# Select the given source index in the main room (1 to ciMAXSOURCES) [SourceIndex#] The currently selected source index in the main room
[SourceIndexDeselect#] The source index in the main room that is no longer selected (used to reflect when an invisible source has been selected by the user)
[CurrentSource$] The name of the current source in the main room

Transports

InputDescription OutputDescription
[Play] Start playback in the main room [IsPlayable_fb] Flag to determine if play function is currently available
[Pause] Pause playback in the main room
[Stop] Stop playback in the main room
[Next] Select the next track/channel in the main room [IsSkippable_fb] Flag to determine if skip (next/previous) functions are currently available
[Prev] Select the previous track/channel in the main room
[Fwd] Seek forward on the current track/channel by ciSEEKSECONDS [IsSeekable_fb] Flag to determine if time seek functions are currently available
[Rew] Seek backward on the current track/channel by ciSEEKSECONDS

Now Playing

InputDescription OutputDescription
[ShuffleToggle] Toggle the shuffle state of the main room [ShuffleOn_fb] The shuffle state of the main room
[ShuffleOn] Put main room into shuffle mode
[ShuffleOff] Bring main room out of shuffle mode
[RepeatToggle] Toggle the repeat state of the main room [RepeatOn_fb] The repeat state of the main room
[RepeatOn] Put main room into repeat mode
[RepeatOff] Bring main room out of repeat mode
[RadioSourceSelected_fb] Flag for radio source being selected in the main room
[PlaylistSourceSelected_fb] Flag for playlist source being selected in the main room
[SongcastSourceSelected_fb] Flag for songcast source being selected in the main room
[ChannelCount#] The number of Radio channels (presets) available in the main room
[SetChannel#] Select the given channel index in the main room (1 to ciMAXCHANNELS) [ChannelIndex#] The currently selected channel index in the main room
[ChannelIndexDeselect#] The channel index in the main room that is no longer selected (used to reflect when a non-indexed channel has been selected by the user)
[TrackCount#] The number of tracks available in the main room
[SetTrack#] Select the given track index in the main room (1 to ciMAXTRACKS) [TrackIndex#] The currently selected track index in the main room
[TrackIndexDeselect#] The track index in the main room that is no longer selected (used to reflect when a non-indexed track has been selected by the user)
[TimeModeToggle] Toggle the time output mode between elapsed and remaining (see Time$) [Duration#] The length in time (in seconds) of the current track in the main room
[SetTimeInSeconds#] Seek to the given second in the current track [TimeInSeconds#] The current time (in seconds) of the current track in the main room
[CurrentSender$] The name of the current songcast sender the main room is listening to
[Time$] The time of the current track in the main room as a string ('0:00:00' or '-0:00:00' depending on TimeModeToggle)
[ArtworkUrl$] The URL of the artwork for the current track in the main room
[Composer$] The composer of the current track in the main room
[Title$] The title of the current track in the main room
[Artist$] The artist of the current track in the main room
[ArtistAndComposer$] The artist and composer of the current track in the main room. Format is 'Artist Name (composed by: Composer Name)'. If no composer listed, format is 'Artist Name'
[Album$] The album of the current track in the main room
[Details$] The details of the current track in the main room (i.e. 'FLAC 96 kHz / 24 bits 4609 kbps')
[TransportState$] The current transport state of the main room (playing/paused/stopped/waiting/buffering)

Launch URLs

InputDescription OutputDescription
[ConfigurationUrl$] The URL used to open the configuration page of the main room
[ConfigurationUrlProxy$] The URL used to open the configuration page of the optional proxy preamp connected to the main room over RS232 (see HasProxyPreamp_fb)
[KazooUrl$] The URL used to open Kazoo in source mode (mobile only). Kazoo opens in the following state: selected main room as the focus device, source view of the current source selected in the main room (playlist/radio/songcast/inputs), 'Crestron' button in the top left corner to jump back quickly to the native Crestron app
[KazooTidalUrl$] The URL used to open Kazoo in Tidal mode (mobile only). Kazoo opens in the following state: selected main room as the focus device, Tidal browse/search view, 'Crestron' button in the top left corner to jump back quickly to the native Crestron app
[KazooQobuzUrl$] The URL used to open Kazoo in Qobuz mode (mobile only). Kazoo opens in the following state: selected main room as the focus device, Qobuz browse/search view, 'Crestron' button in the top left corner to jump back quickly to the native Crestron app
[TuneInUrl$] The URL to open the TuneIn website to setup radio presets

Multiroom

InputDescription OutputDescription
[StandbyToggleRoomX] Toggle the standby state of the given room (X = 1 to ciROOMCOUNT) [StandbyRoomX_fb] The standby state of the given room (X = 1 to ciROOMCOUNT)
[StandbyOnRoomX] Put the given room into standby (X = 1 to ciROOMCOUNT) [RoomXSelectable_fb] Flag to determine if the given room is available to be selected as the main room (i.e. device powered on and not already selected as the main room) (X = 1 to ciROOMCOUNT)
[StandbyOffRoomX] Bring the given room out of standby (X = 1 to ciROOMCOUNT) [RoomNameRoomX$] The user configured name of the given room (X = 1 to ciROOMCOUNT)
[ListenToRoomX] Select the given room that the main room will listen to via Songcast (X = 1 to ciROOMCOUNT) [RoomXSelected_fb] Flag to determine if the given room is currently selected as the main room. The main room can not select itself to listen to as a Songcast sender (X = 1 to ciROOMCOUNT)
[RoomXAvailableAsSongcastSender_fb] Flag to determine if the given room can be listened to as a Songcast sender (will always be false for preamp only devices) (X = 1 to ciROOMCOUNT)
[VolumeIncRoomX] Increment volume of the given room by 1dB (X = 1 to ciROOMCOUNT) [HasVolumeRoomX_fb] Flag to determine if volume functions are currently available for the given room (X = 1 to ciROOMCOUNT)
[VolumeDecRoomX] Decrement volume of the given room by 1dB (X = 1 to ciROOMCOUNT) [VolumeLevelRoomX$] The volume level in the given room as a string (X = 1 to ciROOMCOUNT)
[SetVolumeLevelRoomX#] Set the volume level of the given room (0 to 100, 1dB steps) (X = 1 to ciROOMCOUNT) [VolumeLevelRoomX#] The volume level of the given room (X = 1 to ciROOMCOUNT)
[MuteToggleRoomX] Toggle the mute state of the given room (X = 1 to ciROOMCOUNT) [MuteRoomX_fb] The mute state of the given room (X = 1 to ciROOMCOUNT)
[MuteOnRoomX] Mute the given room (X = 1 to ciROOMCOUNT)
[MuteOffRoomX] Unmute the given room (X = 1 to ciROOMCOUNT)
[RoomSwapRoomX] Make the given room the main room (X = 1 to ciROOMCOUNT) [CurrentSourceRoomX$] The name of the current source in the given room

Source Names

InputDescription OutputDescription
[SourceXName$] Source name by source index for creating a selectable list of sources for the main room (X = 1 to ciMAXSOURCES)

Channel Names

InputDescription OutputDescription
[ChannelXName$] Channel name by channel index for creating a selectable list of radio channels (aka presets) for the main room (format is '1. Linn Radio (Eclectic)') (X = 1 to ciMAXSOURCES)

Track Names

InputDescription OutputDescription
[TrackXName$] Track name by track index for creating a selectable list of tracks for the main room (format is '1. Marooned (Pink Floyd - The Division Bell)') (X = 1 to ciMAXSOURCES)
TOOLBOX
LANGUAGES