PIXILAB Wiki

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
blocks:player-setup [2024-10-23 08:24]
fredrik [PIXILAB Player] 		blocks:player-setup [2025-03-28 16:13] (current)
admin Added notre on updating the player
Line 1: Line 1:
 ====== PIXILAB Player ====== ====== PIXILAB Player ======
-PIXILAB Player is free software for making a player or interactive kiosk out of an NUC computer, or other similar small form-factor PC, for use with Blocks as a Display Spot. This article describes how to install PIXILAB Player.+PIXILAB Player is a free software for making a player or interactive kiosk out of a small form-factor PC (such as a "NUC computer"), for use with Blocks as a Display Spot. This article describes how to install PIXILAB Player. 
 + 
 +:!: **NOTE**: This article describes the current version of the player, recommended for new installations. This player version requires Blocks version 7 or later. For systems based on previous Blocks versions, you may prefer to use the [[blocks:player-setup-pre-seven|legacy version]] of PIXILAB Player. That legacy version also supports network (PXE) booting which this newer version doesn't.
  
 ===== PIXILAB Player System Requirements ===== ===== PIXILAB Player System Requirements =====
Line 8: Line 10:
  
 For best performance and additional capabilities, an internal SSD is recommended.  For best performance and additional capabilities, an internal SSD is recommended. 
-Alternatively, the player can be started directly from a USB memory stick.+Alternatively, the player can be started directly from a USB memory stick, without the need for an internal SSD
  
 ===== Getting Started ===== ===== Getting Started =====
-To create a player, you need a USB stick of at least 8GB in size and a Mac/Windows laptop or similar for creating the installation media. You will also need to [[https://www.balena.io/etcher/|download Etcher]] to your laptop, which is then used to transfer a disk image file (.img) onto the USB stick. +Start by going to https://pixilab.se/outgoing/blocks/player-maker7/ (see below) which provides instructions for downloading the latest PIXILAB Player image as well as creating a configuration file for your player. Store the downloaded files somewhere on your computer. For more information about the various configuration options, see the Configuration Options section below.
- +
-PIXILAB Player can be installed on an internal SSD or run directly from a USB stick. Installing on an internal SSD is recommended for best reliability and performance (see the remarks under “Install on internal disk” in the Configuration Options section). The instructions in this section apply to both installation methods. +
- +
-Start by going to https://pixilab.se/outgoing/blocks/player-maker7/ (see below) which provides instructions for downloading the latest PIXILAB Player image as well as creating a configuration file for your player. Store the downloaded files somewhere on your computer. For more information about the various configuration options, see the Configuration Options section.  +
- +
-:!: IMPORTANT: If you want to run PIXILAB Player from the USB stick rather than installing to SSD, set the “Install on internal disk” configuration option to “no”.+
  
 {{ :blocks:player7:playermaker1.png?nolink&500 |}} {{ :blocks:player7:playermaker1.png?nolink&500 |}}
Line 50: Line 46:
  
 When the installation has finished, remove the USB drive and power off the player. Connect the player to the network used by the Blocks server (if it is not already connected) and power on the player again. If everything works as expected, you should see the PIXILAB logo on screen with an ID string below, allowing you to add it as a Display Spot to Blocks. When the installation has finished, remove the USB drive and power off the player. Connect the player to the network used by the Blocks server (if it is not already connected) and power on the player again. If everything works as expected, you should see the PIXILAB logo on screen with an ID string below, allowing you to add it as a Display Spot to Blocks.
 +
 +=====Updating the Player=====
 +PIXILAB Player version 7 and later can be remotely updated from Blocks. This is done using the "Update PIXILAB Player" setting in the Advanced tab in the Display Spot Settings dialog box. This feature is only available when:
 +  * The player starts from an internal SSD (i.e., not from a USB stick).
 +  * The current user has the role of Manager or Admin.
 +  * Another version of PIXILAB Player software is found on your Blocks server.
 +
 +Player updates must be stored here inside Blocks’ root directory on your server:
 +<code>
 +public/PIXILAB_Player/updates/pixilab-player-XXX.img
 +</code>
 +
 +where XXX is the version number. The current version of PIXILAB Player can be obtained from the link in point 1 on the web page shown above under "Getting Started". Updates must be named exactly as shown above, so don’t rename them after download.
  
 =====Configuration Options===== =====Configuration Options=====
Line 92: Line 101:
 This string will be appended to the Spot page URL. It can be used to append query parameters to the URL. This string will be appended to the Spot page URL. It can be used to append query parameters to the URL.
  
-=====Configuration File====+=====Configuration File=====
 The configuration set through the web-based user interface described above results in settings in the //playerconfig.txt// file. As an alternative to using the web-based user interface, you can set options directly in the playerconfig.txt file. This can also be used to change settings for a player later.  The configuration set through the web-based user interface described above results in settings in the //playerconfig.txt// file. As an alternative to using the web-based user interface, you can set options directly in the playerconfig.txt file. This can also be used to change settings for a player later. 
  
Line 121: Line 130:
   * **url_append** String added to the end of the Spot url. Occasionally useful to apply extra query parameters.   * **url_append** String added to the end of the Spot url. Occasionally useful to apply extra query parameters.
   * **rgb_range** Can be set to //auto//, //full// or //limited//. The default is //auto//, where the range to be used is governed by the EDID data provided by the display. Set to //full// to force the full 0…255 range, which is occasionally useful for non-compliant display devices that fail to show full black/white levels. Applies to Intel graphics chipsets only.   * **rgb_range** Can be set to //auto//, //full// or //limited//. The default is //auto//, where the range to be used is governed by the EDID data provided by the display. Set to //full// to force the full 0…255 range, which is occasionally useful for non-compliant display devices that fail to show full black/white levels. Applies to Intel graphics chipsets only.
-  * ** headless_mode** Set to //yes// to use the player without a display, e.g. for audio only playback. Default is //no//.+  * **headless_mode** Set to //yes// to use the player without a display, e.g. for audio only playback. Default is //no//. 
 +  * **auto_install** Set this to //yes// to install the player on an internal SSD without prompting. This option is available in PIXILAB Player 7.1 and later. 
 + 
 +:!: **CAUTION**: Make sure to mark any USB stick set to //auto_install// clearly, as inserting this into a random computer set to boot frmo USB may damage it. 
 + 
 +====Debugging options==== 
 + 
 +:!: Only ever use debugging settings temporary, **do not leave this options on permanent**.  
 + 
 +  * **debug_mode**  When set to yes access to browser web developer tools is enabled. 
 + 
 +  * **ssh_password** When a password is set, ssh becomes enabled on the player.