Jump to content

Player web interface

From SpinetiX Wiki
(Redirected from Player landing page)
Note  
This page is related to Embedded web server.

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.

Connect to the web interface

Note  
See also the "Get started with the player" tutorial for more details about connecting the device to your network.
http(s)://Player_address/

To access the player web interface, enter one of the player addresses: IPv4, IPv6, or hostname address, in the browser's address bar. You get directed to Control Center (built-in interface) or to SpinetiX ARYA™ (external website).

Notes for Control Center:

Notes for ARYA:

Top bar menu

The top bar menu is present on all the pages of the player web interface and provides the following quick links:

Note Note:
An additional link to a custom HTML interface (details below) could also be present on the top bar.

Custom HTML interface

Note  
Applies to DSOS players, except for DiVA, and requires WIDGETS Feature Set or higher. Added in firmware 4.2.0.

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:

  1. 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.
  2. Add the HTML interface file(s) within the root of an Elementi project.
  3. Publish the project onto the player.
  4. Access the player web interface and log in with a user having "Content authoring" or "Admin" rights.
  5. Click the link for your HTML interface on the top-bar menu and test it.
Note Tip:
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. This scenario requires SYSTEMS Feature Set.

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.