Player web interface
From SpinetiX Support Wiki
Contents
Introduction
The player built-in web interface is user-friendly, responsive, and offers different tools for managing the technical aspects of DSOS players, making it easier to deploy and maintain digital signage solutions. It allows users to interact directly with the players, both to configure various settings and for requesting information from the device. It is running on the device's embedded web server and can be accessed from any regular browser.
The player web interface comes with the following tools for:
Connect to the web interface
To access the player web interface, enter http(s)://Player_address/ in the browser's address bar, where Player_address can be its IPv4, IPv6, or hostname address.
At this point, you get directed to:
- SpinetiX ARYA™ website in case of DiVA, HMP300, and HMP350 having ARYA mode enabled, or HMP400, HMP400W, iBX410, iBX440 and third-party players without a DSOS license activated.
- Configuration Wizard when the player has not been yet configured.
- Control Center home page or its Login screen where you need to enter your username and password.
- Simplified home page on DiVA, HMP300, and HMP350 models, when the user doesn't have admin rights, composed of three big, clickable areas: Create, Schedule, and player snapshot.
Notes:- It is always possible to return to the home page by clicking on the player name on the left side of the top bar menu.
- The default user created on the player is "admin" (it cannot be changed, nor removed), with its default password set to "admin"; you are prompted to enter a new password at the last step of the Configuration Wizard, or gets automatically changed when the player is added into ARYA.
- If the player is in ARYA and you want to access its Control Center, you need to remove it first from ARYA and/or create a new admin user (players with more than one admin user, allow access to Control Center instead of redirecting to ARYA).
The top bar menu is present on all the pages of the player web interface and provides the following quick links:
- Device name ⇾ click to go to Home page
- CREATE ⇾ click to open the content creation tool (only on DiVA, HMP300, and HMP350 models)
- SCHEDULE ⇾ click to open the content scheduling tool (only on DiVA, HMP300, and HMP350 models)
-
⇾ click the gear icon to open the Control Center home page -
⇾ click the user icon to open the User manager tool -
⇾ click the logout icon to log out from the player interface
Note:Control Center home page
The Control Center home page displays general information about the device: player status summary, current settings, the content snapshot, plus some quick links to maintenance tasks. A left side menu provides links to all the other pages in Control Center.
Player status
This section contains the player logo, its date/time information, plus six information boxes (clicking on any of them, brings out more information and/or links to configuration pages), as following:
- Up time
- Current running time of the player.
- CPU Load
- Current CPU usage of the player; clicking on the box gives extended info about CPU distribution and frame drops.
- Storage
- Current use of the player internal storage.
- Display
- Current display status.
- Network
- Status of the network connection. An exclamation mark may be shown in case of network issues. Clicking on the box gives extra network information such as IP addresses, hostname address, and MAC address.
- Firmware
- Current player firmware. An exclamation mark may be shown in case the firmware needs to be updated. Clicking on the box gives extra information about the firmware update.
Current Settings
This section gives a brief summary of the important settings of the player:
- License type (if any)
- Serial number of the player
- Name
- Time zone
- Display settings
Plus two buttons:
- Enable/Disable ARYA
- Toggles the ARYA mode on the player.
- Starting with firmware 4.7.1, HMP350 and HMP300 players have ARYA enabled by default and maintain a connection to the SpinetiX cloud even when ARYA is not enabled, as it was already the case for DiVA players. For firmware 4.6.3 to 4.6.5, you can apply a special configuration file to enable it.
- Configuration Wizard
- Starts the Configuration Wizard, allowing to redo the initial steps of configuring the player.
- The Configuration Wizard is automatically started the first time Control Center is accessed; during the initial setup, an additional step is required to configure the admin password of the device.
Quick Links
This section allows the user to do the following maintenance operations:
- Restore Config
- This allows restoring a configuration backup (for instance, when a reset to factory default settings was performed on the device) or applying a custom configuration file.
- Configure Cockpit / Open in Cockpit
- The former is displayed when the device is not yet monitored by Cockpit - pressing the button opens the System → Cockpit page, from where you can add the device in Cockpit.
- The latter is displayed when the device is already monitored by Cockpit - pressing the button opens the player monitoring page of Cockpit for that device (login required).
- Generate Report
- Generate a standard player report.
- This is usually required by SpinetiX Support for troubleshooting whenever the device is not functioning properly.
- Restart Now
- Restart the device in case of configuration changes, or any other maintenance operation.
Snapshot
This section shows a snapshot image of what is currently displayed by the player. Click the "Refresh" button to reload the snapshot image.
Custom HTML interface
This neat feature provides a way to integrate your custom HTML interface to be served by the player, thus removing the need for a dedicated web server. Such an interface could make use of the player APIs for remote control, retrieve different player information, monitoring, etc.
Here are the steps to follow:
- Create your HTML interface
- The main file must be named "index.html".
- If other files are used for your HTML interface, like CSS, scripts, etc., then group them in a folder named "interface"; you can do this even if there's only the index.html file.
- The title element on the index.html file is used on the top-bar menu in Control Center to add a link towards your custom HTML interface; up to 20 Western-Latin alphabet characters (or less if extended characters are present) are used for its label.
- If there's an index.html file present in the root of the project and another one inside an "interface" folder, the file in the project's root takes precedence over one in the interface folder.
- The interface should not contain absolute links to other files, only relative links are guaranteed to work reliably.
- Add the HTML interface file(s) within the root of an Elementi project.
- Publish the project onto the player.
- Access the player web interface and log in with a user having "Content authoring" or "Admin" rights.
- Click the link for your HTML interface on the top-bar menu and test it.
One of the most common scenarios is to provide an easy mean for the users to interact/control the content displayed by the player – for that, you'll need an "Action to Switch" interactive widget inside your project and the custom HTML interface would use Web Storage REST API calls to update the Shared Variable controlling that widget.
Troubleshooting
- Internal Server Error - The server encountered an internal error or misconfiguration and was unable to complete your request.
- If this error is received when trying to connect to the player web interface, then either the firmware got corrupted or the player is incorrectly configured - the solution is to install the latest firmware package from Recovery mode.