Difference between revisions of "Custom:API"

From LinnDocs
Jump to: navigation, search
m
m
 
Line 1: Line 1:
 
The Linn DS/DSM/HUB can be controlled by a number of different formats:
 
The Linn DS/DSM/HUB can be controlled by a number of different formats:
  
1. <u>[http://www.upnp.org/ UPnP]</u>
+
=. <u>[http://www.upnp.org/ UPnP]</u>=
 
: This is the primary control of the Linn DS/DSM/HUB. Using "<u>Ds</u>" as the UPnP Device with a core of common Services. Additional Services are added with the products capabilities.  
 
: This is the primary control of the Linn DS/DSM/HUB. Using "<u>Ds</u>" as the UPnP Device with a core of common Services. Additional Services are added with the products capabilities.  
 
: The Linn DS/DSM/HUB can also be controlled using the "<b>UPnPAv</b>" Device.
 
: The Linn DS/DSM/HUB can also be controlled using the "<b>UPnPAv</b>" Device.
 
<br><br>
 
<br><br>
2.<u>LPEC</u> (Linn Products Event Control)
+
=<u>LPEC</u> (Linn Products Event Control) =
 
: This uses the TELNET port of the Linn DS and uses the same UPnP commands as above but in command line form. Each Linn DS can support up to <u>five</u> simultaneous LPEC sessions and gives you most of the control functionality that you require.  
 
: This uses the TELNET port of the Linn DS and uses the same UPnP commands as above but in command line form. Each Linn DS can support up to <u>five</u> simultaneous LPEC sessions and gives you most of the control functionality that you require.  
 
: Examples of LPEC can be found [[Developer:LPEC#LPEC_Examples|<u>HERE</u>]] with documentation [[Developer:LPEC|<u>HERE</u>]]
 
: Examples of LPEC can be found [[Developer:LPEC#LPEC_Examples|<u>HERE</u>]] with documentation [[Developer:LPEC|<u>HERE</u>]]
 
: Note: Almost all Linn DS/DSM players can be controlled by LPEC. The only exception is the Kustom DSM. In the Kustom DSM LPEC will control the streamer(s) but will not control the attached zones.
 
: Note: Almost all Linn DS/DSM players can be controlled by LPEC. The only exception is the Kustom DSM. In the Kustom DSM LPEC will control the streamer(s) but will not control the attached zones.
 
<br><br>
 
<br><br>
3. <u>Open Home API</u>
+
=<u>Open Home API</u>=
 
: The Linn DS API’s are [http://wiki.openhome.org/wiki/OhMediaDevelopers <u>Oh Media Developers</u>] This is open source code that can be used by anyone. This can be memory hungry due to some of the streaming service options such as Tidal.  
 
: The Linn DS API’s are [http://wiki.openhome.org/wiki/OhMediaDevelopers <u>Oh Media Developers</u>] This is open source code that can be used by anyone. This can be memory hungry due to some of the streaming service options such as Tidal.  
 
<br><br>
 
<br><br>
Line 16: Line 16:
 
:The Linn API is a service provided by Linn which allows your application to control your users' Linn Ds. This is available from [https://api.linn.co.uk/docs/  https://api.linn.co.uk/docs/]
 
:The Linn API is a service provided by Linn which allows your application to control your users' Linn Ds. This is available from [https://api.linn.co.uk/docs/  https://api.linn.co.uk/docs/]
 
<br><br>--->
 
<br><br>--->
4. <u>Kazoo Gateway/CI Gateway</u>
+
=<u>Kazoo Gateway/CI Gateway</u>=
 
:<b>Kazoo Server</b>, (the Linn UPnP Media server), this gives you the option of a Gateway functionality. This will allow you use a websocket and have full control with Tidal, Qobuz, Tunein usage. These can produce very large response strings so the Savant will need a lot of processing power is this is to be used its full capability.
 
:<b>Kazoo Server</b>, (the Linn UPnP Media server), this gives you the option of a Gateway functionality. This will allow you use a websocket and have full control with Tidal, Qobuz, Tunein usage. These can produce very large response strings so the Savant will need a lot of processing power is this is to be used its full capability.
 
:Embedded <b>CI Gateway</b>: The newer design of products, listed in <u>[[Gateway API]]</u>, gives you the option of a Gateway functionality. This will allow you use a websocket and have full control with Tidal, Qobuz, airable usage
 
:Embedded <b>CI Gateway</b>: The newer design of products, listed in <u>[[Gateway API]]</u>, gives you the option of a Gateway functionality. This will allow you use a websocket and have full control with Tidal, Qobuz, airable usage
 
:{{block indent|<categorytree mode="all" >Gateway API</categorytree>  }}
 
:{{block indent|<categorytree mode="all" >Gateway API</categorytree>  }}
 +
: If you have enabled the CI Gateway you can enquire how it is used and go into <b><I>http://<DS IP ADDRESS>:4100/apidoc</i></b>
 +
:If running Kazoo Server, go into its settings, enable "GATEWAY API", jump into its setup page and select Advanced. Finally open the http address given to see its API documentation.
  
 
<br><br>
 
<br><br>
 
<noinclude>[[Category:Custom]]</noinclude>
 
<noinclude>[[Category:Custom]]</noinclude>

Latest revision as of 12:53, 5 June 2023

The Linn DS/DSM/HUB can be controlled by a number of different formats:

. UPnP

This is the primary control of the Linn DS/DSM/HUB. Using "Ds" as the UPnP Device with a core of common Services. Additional Services are added with the products capabilities.
The Linn DS/DSM/HUB can also be controlled using the "UPnPAv" Device.



LPEC (Linn Products Event Control)

This uses the TELNET port of the Linn DS and uses the same UPnP commands as above but in command line form. Each Linn DS can support up to five simultaneous LPEC sessions and gives you most of the control functionality that you require.
Examples of LPEC can be found HERE with documentation HERE
Note: Almost all Linn DS/DSM players can be controlled by LPEC. The only exception is the Kustom DSM. In the Kustom DSM LPEC will control the streamer(s) but will not control the attached zones.



Open Home API

The Linn DS API’s are Oh Media Developers This is open source code that can be used by anyone. This can be memory hungry due to some of the streaming service options such as Tidal.



Kazoo Gateway/CI Gateway

Kazoo Server, (the Linn UPnP Media server), this gives you the option of a Gateway functionality. This will allow you use a websocket and have full control with Tidal, Qobuz, Tunein usage. These can produce very large response strings so the Savant will need a lot of processing power is this is to be used its full capability.
Embedded CI Gateway: The newer design of products, listed in Gateway API, gives you the option of a Gateway functionality. This will allow you use a websocket and have full control with Tidal, Qobuz, airable usage

If you have enabled the CI Gateway you can enquire how it is used and go into http://<DS IP ADDRESS>:4100/apidoc
If running Kazoo Server, go into its settings, enable "GATEWAY API", jump into its setup page and select Advanced. Finally open the http address given to see its API documentation.