PIXILAB Wiki

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
blocks:player-setup [2025-03-05 15:13] – [Configuration File] adminblocks:player-setup [2026-10-29 15:07] (current) – [Configuration File] mattias
Line 1: Line 1:
 ====== PIXILAB Player ====== ====== 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.+PIXILAB Player is 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. :!: **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.
Line 9: Line 9:
 The player needs 8 GB of RAM to be installed. Choose RAM of the fastest type supported by the computer. For optimal video performance, two RAM modules are recommended for best memory bandwidth.  The player needs 8 GB of RAM to be installed. Choose RAM of the fastest type supported by the computer. For optimal video performance, two RAM modules are recommended for best memory bandwidth. 
  
-For best performance and additional capabilities, an internal SSD is recommended.  +Pixilab player must be installed on an internal SSD for production applications.  
-Alternatively, the player can be started directly from a USB memory stick, without the need for an internal SSD +The player can be started directly from a USB memory stick for temporary computer compatibility testing, without the need to install.
 ===== Getting Started ===== ===== Getting Started =====
-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.+Start by going to https://pixilab.se/outgoing/blocks/player-maker/ (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.
  
 {{ :blocks:player7:playermaker1.png?nolink&500 |}} {{ :blocks:player7:playermaker1.png?nolink&500 |}}
Line 46: Line 45:
  
 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 88: Line 100:
 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====+===AoIP (AES67)=== 
 +More information about the AES67 implementation here: [[.:player-setup:aes67|PIXILAB Player AES67 Audio over IP]] 
 +====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. 
 +
  
 Each setting in the //playerconfig.txt// file consist of a single line in the form: Each setting in the //playerconfig.txt// file consist of a single line in the form:
Line 99: Line 114:
 Valid keys are listed below in bold, with values described in the following text. Valid keys are listed below in bold, with values described in the following text.
  
-  * **disable_hardware_video_acceleration** When set to //yes//, disables hardware video acceleration in chromium. Hardware video acceleration is enabled by default. +===General=== 
-  * **dns** The address to the DNS server when using manual network configuration.+  * **server_location** Address + optional port number (separated by colon) to the Blocks server. 
 +  * **server_protocol** Set to //http// or https depending on the connection type to the Blocks server. 
 +  * **disable_hardware_video_acceleration** When set to //yes//, disables hardware video acceleration. Hardware video acceleration is enabled by default.
   * **enable_mouse** When set to //yes//, shows the mouse cursor when a mouse device is connected. Mouse devices are disabled by default.   * **enable_mouse** When set to //yes//, shows the mouse cursor when a mouse device is connected. Mouse devices are disabled by default.
 +  * **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//. //deprecated: no longer required from player version 7.3//
 +  * **touchpad_tap** Set to //no// to disable tap-to-click. Tap-to-click is enabled by default. This option is available in PIXILAB Player 7.1 and later.
 +  * **url_append** String added to the end of the Spot url. Occasionally useful to apply extra query parameters.
 +
 +
 +  * **run_from_usb** Set to yes to run the player from the USB stick instead of installing to an internal disk. Disabled by default.
 +  * **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 from USB may damage it.
 +
 +===Network===
 +  * **ip_address** The IP address + subnet mask in CIDR notation when using manual network configuration. 
 +  * **dns** The address to the DNS server when using manual network configuration.
 +  * **gateway** The address of the default gateway when using manual network configuration.
 +  * **proxy_server** Address to a proxy server.
 +  * **proxy_bypass** Comma-separated list of addresses to bypass proxy server (applies only when proxy_server is used).
 +===WiFi===
   * **enable_wifi** When set to //yes//, enables WiFi. WiFi is disabled by default. The SSID of the WiFi network must be specified using the ssid option.   * **enable_wifi** When set to //yes//, enables WiFi. WiFi is disabled by default. The SSID of the WiFi network must be specified using the ssid option.
   * **ssid** SSID (name) of WiFi network.    * **ssid** SSID (name) of WiFi network. 
 +  * **hidden_ssid** Set to //yes// when connecting to a network with a hidden SSID. Default is //no//. This option is available in PIXILAB Player 7.2 and later.
   * **wifi_encryption** Set to //wpa// to specify WPA encryption for the WiFi network. When set to wpa, wpa_password must also be set. Default is no encryption (open network).   * **wifi_encryption** Set to //wpa// to specify WPA encryption for the WiFi network. When set to wpa, wpa_password must also be set. Default is no encryption (open network).
   * **wpa_password** Password for connecting to a WPA encrypted WiFi network.   * **wpa_password** Password for connecting to a WPA encrypted WiFi network.
-  * **gateway** The address of the default gateway when using manual network configuration. + 
-  * **ip_address** The IP address + subnet mask in CIDR notation when using manual network configuration.  + ===Locale===
   * **ntp_server** Address to an NTP server for time synchronization. If not set, a default NTP server is used.   * **ntp_server** Address to an NTP server for time synchronization. If not set, a default NTP server is used.
-  * **proxy_server** Address to a proxy server. 
-  * **proxy_bypass** Comma-separated list of addresses to bypass proxy server (applies only when proxy_server is used). 
-  * **run_from_usb** Set to yes to run the player from the USB stick instead of installing to an internal disk. Disabled by default. 
-  * **server_location** Address + optional port number (separated by colon) to the Blocks server. 
-  * **server_protocol** Set to //http// or https depending on the connection type to the Blocks server. 
   * **timezone** Time zone used by the player's internal clock.   * **timezone** Time zone used by the player's internal clock.
-  * **url_append** String added to the end of the Spot url. Occasionally useful to apply extra query parameters. +  * **keyboard** Keyboard layout, e.g. //gb// 
-  * **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//. +===AES67 AoIP=== 
-  * **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.+PIXILAB Player 8 and later. 
 +  * **aes67_dest**  enables AES67 provided the system has a valid licence, must be set to a valid multicast address (e.g.,  239.69.x.x) that is not in use by any other AES67 (multicast) transmitter on the network. 
 +  * **aes67_channels** optional (default is 8 channels) set to the required channel number between 2 and 8. Be conservative, a silent channel consumes as much bandwidth as one with audio. 
 +  * **aes67_ifname** optional routes AoIP traffic to a named NIC. Use this for cases where audio network is separated from Blocks network. 
 + 
 +====Troubleshooting Settings==== 
 + 
 +:!: Use these troubleshooting and debugging settings only after consulting with PIXILAB. Do not leave these options on permanently. 
 + 
 +  * **debug_mode**  When set to //yes// access to browser developer tools is enabled. 
 + 
 +  * **ssh_password** When a password is set, ssh network access is enabled on the player with the user name //root// and the specified password.  
 + 
 +====Release notes==== 
 + 
 +[[blocks:player-setup:release_notes|PIXILAB Player release notes]]
  
-:!: **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.