iRidium for SpinetiX

A set of tools to create control interfaces for equipment by SpinetiX.

The documentation was updated on 12.5.2023

Description

SpinetiX Media Player is a full content generator, a hardware and software complex developed by Swiss specialists. It constructs the picture right at the moment of playback. Layers with objects are displayed on the screen. You can set the place, time, effects, transparency and many other properties for each layer. Layers can include videos, pictures, texts, playlists, schedules, layouts, streaming video, graphics, widgets, etc. The information is stored inside the player. The player automatically gets the necessary information from external sources (e.g., RSS or data for a chart). SpinetiX content generators can animate any objects. This is a great solution for attracting attention and generating beautiful content with built-in tools!

iRidium for SpinetiX allows to:

Activate previously prepared scenarios and control power (reboot and shutdown).
Get up-to-date information from the player at a configurable interval, such as: name, model and operating mode of the device, firmware version and status, amount of free and used storage space, temperature and uptime, display type and connection status, error data.

Tested with the following equipment:

HMP400.

Connection

1 Connect the SpinetiX equipment to the network and configure it according to the instructions (connection and set up the HMP400)

2 Create playlists in the SpinetiX player. It will be switched by keywords sent by text to the Action to Switch command. To do this, use the standard Action to Switch widget in the program Elementi.

Make sure, that "Enable CORS requests" is enabled for the SpinetiX player in the player's web interface under the "Advanced Applications, APIs Security" section.

3 To implement external control, use the standard Action to Switch widget from the Elementi library. It is located in the "Widgets > Interactive and Control > Action to Switch.svg" section.

In the widget settings on the Properties tab, indicate the name of the Shared Variable, which will be later used to configure the Action to Switch command in the iRidium project.

On the "Transformations" tab, indicate the possible values of this variable.

Each value of the variable is assigned an element for playback, which is passed as text in the "Action to Switch" command in the iRidium project. It can be a playlist, a video file or any other supported playback object in the Elementi software.

Work in iRidium

1 Add the SpinetiX driver in the Devices tab to a created project:

2 Enter the driver connection settings:

Log Level - the level of logging;
Host - IP-address of equipment;
Port - port (80 by default);
Login / Password - a login and password to access equipment;
Keep Alive - interval to check TCP connection. If there is no answer to Keep Alive request, the driver will be forced to the turned off state;
Api Key - a product key (copy the API Key from the Advanced Applications, Apps Security page of the player web interface);

The API (RPC) key protects the player from Cross-Site Request Forgery (CSRF) for requests originating from a different host (cross-origin resource sharing) to the player's API interfaces: RPC API, REST API and state API.

Update time - frequency of requests to equipment (ms.);
Driver Version - a version of a driver.

Setting Commands and Feedback Channels

To control equipment it is required to set Commands and Feedbacks. To send a command, drag'n'drop it on a graphic item and enter a value to send. To display feedback drag'n'drop a feedback channel on a graphic item and choose how to output or display a value.

Read more about work with graphic items in the "Types of graphic items" article.

Commands

Parameter	Values	Description
Restart	Any value	Restarting the device.
Shutdown	Any value	Complete device shutdown.
Action to Switch	String	Activating the script by the name specified in the "Conversions" tab when setting up the "Action to Switch" widget in Elementi. The "Shared Variable" parameter should be taken from the "Common variable" field.

Feedbacks

Parameter	Values	Description
Device Name	String	Device name.
Model Num	String	Device model.
Mode	Normal, Safe	Operating mode, normal or safe.
Firmware Version	String	Firmware version.
Firmware Status	Normal, Corrupted	Firmware status, normal or corrupted.
Error Messages	String	Feedback containing data about content errors, if the display is activated in the feedback settings. Feedback setting options: Included time - show date and time of error (ISO-8601 format); Included code - show an error code; Included desc - show error description; Included source - show the URI of the file that caused the error; Included custom - user error description.
Storage Free Content	Value	Amount of free storage space occupied by content, MB.
Storage Used Content	Value	Amount of used storage space occupied by content, MB.
Display Type	String	Display connector type (e.g., HDMI).
Display Power	On, Off, Unknown, Gone	Display status, where "Unknown" indicates that the display provides information but not about its power state and "Gone" indicates that the display is either absent or not providing any information.
Temperature (C)	Value	Feedback containing data about the internal temperature of the player in degrees Celsius (C).
Uptime (min)	Value	Uptime in minutes.
Uptime (hours)	Value	Uptime in hours.
Storage Free System	Value	Amount of free storage space occupied by system, MB.
Storage Used System	Value	Amount of used storage space occupied by system, MB.

Contents