Difference between revisions of "CI-Gateway"
(Created page with "{{HIDE_PAGE_TITLE}}__NOTOC__ =<span style="color:blue">Linn CI Gateway</span>= :The CI Gateway is a piece of software that is required for Linn’s Custom Install options –...") |
m (→Linn CI Gateway) |
||
| Line 4: | Line 4: | ||
:This software discovers all devices on a local network and then offers an API to retrieve information and control functionality for any Linn DS/DSM device. There are two ways of running the CI Gateway: | :This software discovers all devices on a local network and then offers an API to retrieve information and control functionality for any Linn DS/DSM device. There are two ways of running the CI Gateway: | ||
| − | :1. It can be run on any | + | :1. It can be run on any <u>Core4</u> Linn DS/DSM device by enabling it in the system configuration. |
:2. Alternatively, if no suitable device is available then Kazoo Server can be used running on a PC, Mac or QNAP device. The CI Gateway is bundled alongside this media server software, and it simply needs to be installed on a suitable device on the local network. This is enabled through the Kazoo Server’s options. | :2. Alternatively, if no suitable device is available then Kazoo Server can be used running on a PC, Mac or QNAP device. The CI Gateway is bundled alongside this media server software, and it simply needs to be installed on a suitable device on the local network. This is enabled through the Kazoo Server’s options. | ||
:Only one instance of the CI Gateway is required (i.e. no need to enable it on multiple devices) | :Only one instance of the CI Gateway is required (i.e. no need to enable it on multiple devices) | ||
| Line 22: | Line 22: | ||
:You can check that the CI Gateway is operating by accessing the configuration options page for it. For a CI Gateway running on a Linn DS/DSM device, it can be accessed through a web browser. You need to know the IP address of the device, and then it can be accessed through an HTTPS request on port 4100. For example: <span style="color:blue; text-decoration:underline"><nowiki>https://192.168.1.49:4100</nowiki></span> | :You can check that the CI Gateway is operating by accessing the configuration options page for it. For a CI Gateway running on a Linn DS/DSM device, it can be accessed through a web browser. You need to know the IP address of the device, and then it can be accessed through an HTTPS request on port 4100. For example: <span style="color:blue; text-decoration:underline"><nowiki>https://192.168.1.49:4100</nowiki></span> | ||
:This will open the page below where options and configuration for the CI Gateway are located. | :This will open the page below where options and configuration for the CI Gateway are located. | ||
| + | |||
| + | [[File:CI-GatewayMain.png|centre|link=]] | ||
:For a CI Gateway running on Kazoo Server, find the options page for Kazoo Server (for Windows, right-click on the icon in the system tray and click Configure Kazoo Server). You will then find an option for Gateway API. Clicking this option will give you the same configuration page. | :For a CI Gateway running on Kazoo Server, find the options page for Kazoo Server (for Windows, right-click on the icon in the system tray and click Configure Kazoo Server). You will then find an option for Gateway API. Clicking this option will give you the same configuration page. | ||
| − | Logging into streaming service accounts | + | |
| − | It is possible to access third-party streaming services through the CI Gateway. You will see several of these on the configuration page. Some service such as TIDAL and Qobuz require logins for individual devices, but you can login for all using the options at the top. Ensure these are configured before using any custom install support. | + | ==<span style="color:blue; ">Logging into streaming service accounts</span>== |
| − | Note: There is no need to log into Airable radio. Any Linn DS/DSM that is associated with a linn account has access to this server. If you are having difficulties, ensure that every DS/DSM is associated with a Linn account. | + | :It is possible to access third-party streaming services through the CI Gateway. You will see several of these on the configuration page. Some service such as TIDAL and Qobuz require logins for individual devices, but you can login for all using the options at the top. Ensure these are configured before using any custom install support. |
| − | Accessing the CI Gateway Documentation (Advanced) | + | :Note: There is no need to log into Airable radio. Any Linn DS/DSM that is associated with a linn account has access to this server. If you are having difficulties, ensure that every DS/DSM is associated with a Linn account. |
| − | The CI Gateway is open to use by anyone! If you would like to write your own software that features control over Linn DS/DSM devices, then you are free to do so. There is documentation (under API Documentation in gateway options) that provides information about the API endpoints and allows you to try out its functionality. To use it in your own program simply set up a WebSockets connection with port 8088 for CI Gateway running on a Linn DSM (or port 4100 for Kazoo Server) and send JSON messages across the connection using the format demonstrated in the documentation. | + | |
| + | ==<span style="color:blue; ">Accessing the CI Gateway Documentation (Advanced)</span>== | ||
| + | ;The CI Gateway is open to use by anyone! If you would like to write your own software that features control over Linn DS/DSM devices, then you are free to do so. There is documentation (under API Documentation in gateway options) that provides information about the API endpoints and allows you to try out its functionality. To use it in your own program simply set up a WebSockets connection with port 8088 for CI Gateway running on a Linn DSM (or port 4100 for Kazoo Server) and send JSON messages across the connection using the format demonstrated in the documentation. | ||
| + | [[File:CI-GatewayAdvanced.png|centre|link=]] | ||
| − | The first set of tabs (Session->Queue) are legacy endpoints that remain for older Custom Installation support. The session endpoints are the exception; these are shared between all support (the first step to using the CI Gateway is creating a session). Reworked API endpoints have been created more recently under the API V2 tabs of the documentation UI. These beta API endpoints allow for simplified and more intuitive communication, but may be subject to small changes. | + | :The first set of tabs (Session->Queue) are legacy endpoints that remain for older Custom Installation support. The session endpoints are the exception; these are shared between all support (the first step to using the CI Gateway is creating a session). Reworked API endpoints have been created more recently under the API V2 tabs of the documentation UI. These beta API endpoints allow for simplified and more intuitive communication, but may be subject to small changes. |
Revision as of 15:34, 6 December 2023
Linn CI Gateway
- The CI Gateway is a piece of software that is required for Linn’s Custom Install options – Crestron and Control4
- This software discovers all devices on a local network and then offers an API to retrieve information and control functionality for any Linn DS/DSM device. There are two ways of running the CI Gateway:
- 1. It can be run on any Core4 Linn DS/DSM device by enabling it in the system configuration.
- 2. Alternatively, if no suitable device is available then Kazoo Server can be used running on a PC, Mac or QNAP device. The CI Gateway is bundled alongside this media server software, and it simply needs to be installed on a suitable device on the local network. This is enabled through the Kazoo Server’s options.
- Only one instance of the CI Gateway is required (i.e. no need to enable it on multiple devices)
Enabling the CI Gateway on a Linn DSM device.
- The CI Gateway is available on any of the following Linn products:
- To enable it:
- 1. Go to the Manage Systems page and login with your Linn Account.
- 2. Go into the options for one of your devices that is capable of running the CI Gateway.
- 3. Go into the Advanced tab and turn on the CI Gateway option. If your device is one of the above products and this option is not visible, then it could have outdated firmware – ensure it is updated and try again.
- 4. If the device is on, then you will be prompted to reboot the device. Once fully rebooted, the CI Gateway will then be enabled.
Accessing the CI Gateway Configuration
- You can check that the CI Gateway is operating by accessing the configuration options page for it. For a CI Gateway running on a Linn DS/DSM device, it can be accessed through a web browser. You need to know the IP address of the device, and then it can be accessed through an HTTPS request on port 4100. For example: https://192.168.1.49:4100
- This will open the page below where options and configuration for the CI Gateway are located.
- For a CI Gateway running on Kazoo Server, find the options page for Kazoo Server (for Windows, right-click on the icon in the system tray and click Configure Kazoo Server). You will then find an option for Gateway API. Clicking this option will give you the same configuration page.
Logging into streaming service accounts
- It is possible to access third-party streaming services through the CI Gateway. You will see several of these on the configuration page. Some service such as TIDAL and Qobuz require logins for individual devices, but you can login for all using the options at the top. Ensure these are configured before using any custom install support.
- Note: There is no need to log into Airable radio. Any Linn DS/DSM that is associated with a linn account has access to this server. If you are having difficulties, ensure that every DS/DSM is associated with a Linn account.
Accessing the CI Gateway Documentation (Advanced)
- The CI Gateway is open to use by anyone! If you would like to write your own software that features control over Linn DS/DSM devices, then you are free to do so. There is documentation (under API Documentation in gateway options) that provides information about the API endpoints and allows you to try out its functionality. To use it in your own program simply set up a WebSockets connection with port 8088 for CI Gateway running on a Linn DSM (or port 4100 for Kazoo Server) and send JSON messages across the connection using the format demonstrated in the documentation.
- The first set of tabs (Session->Queue) are legacy endpoints that remain for older Custom Installation support. The session endpoints are the exception; these are shared between all support (the first step to using the CI Gateway is creating a session). Reworked API endpoints have been created more recently under the API V2 tabs of the documentation UI. These beta API endpoints allow for simplified and more intuitive communication, but may be subject to small changes.
