Skip to main content

Screensaver

info

The primary purpose of a Screensaver is to extend the life of the backlight and reduce energy consumption while the terminal is not in use.

The core functionality of the Apollo Screensaver is provided by a proximity sensor in the front of the terminal. This sensor detects objects in a configurable proximity to the terminal, and suppresses the screensaver when it is triggered.

More than one screensaver can be shown. The default is for two different Payter screens to rotate. The period of time that a screen is shown, and the order each screen is shown in, is configurable.

Screensaver Basics

  • A screensaver should be a PNG image that measures 320 pixels wide by 480 pixels tall
  • A screensaver will be shown with a reduced backlight
  • A screensaver should reinforce or compliment the solution
  • A screensaver should NOT be used as an operational screen.

Screensaver Configuration

Screensavers are added in the Basic Configuration UI - Screens tab in MyPayter when viewing a terminal.

  1. Ensure the asset you are going to use as a screensaver is already uploaded to your terminal 'Domain' Assets section. You can find more information on how to do this here: Assets - Uploading Assets
  2. Click +Add UI Asset and then select the Asset from the drop down in the first blank box on the right hand side.
  3. Scroll to the "Screensaver(s)" section
  4. Change the Asset Ref to the Asset you just added.
  5. Add a value in seconds to the Screensaver timeout setting. You can set 2147483647 to disable the screensaver completely.

This is the minimum number of steps to apply a single basic screensaver.

Detailed Screensaver Configuration

NameFormatDescription
TitleStringA text overlay that can be placed over a plain screen. Centered and at the top of the screen by default.
Sub TitleStringA text overlay that is placed over a plain screen and directly under the Title.
Asset RefDropdownAllows the asset to be selected that has been uploaded to MyPayter and assigned to the terminal.
Text Y OffsetIntegerThe number of Pixels from the top of the screen that the Title will be positioned. Screen is 480 pixels tall.
Show DurationStringThis is a required field to indicate how long this screen will be shown for, before the next screen is displayed. Even when only a single screensaver is being used, this field should be included as we typically transition screens through a black screen to further improve terminal longevity.
Screensaver TimeoutIntegerThe number of seconds of no proximity contacts before the screensaver is engaged. Set to 2147483647 to disable the screensaver.

Advanced Screensaver Configuration

The following settings can be applied in the Advanced Configuration apollo-ui tab. It will usually be needed to add each of these settings as they are not exposed by default.

NameFormatDefaultDescription
proximity-thresholdInteger30A number that determines how sensitive the proximity sensor is.
0 = Maximum sensitivity
2147483647 = Disabled
backlight-brightnessNumber 0-710 turns the backlight off, and 7 is maximum brightness.
caution

Using a screensaver with Maximum brightness negates the core value of this functionality. It can impact energy saving credentials and may detrimentally impact the long-term life of the terminal.

Screensaver use at Trade Shows

It can be very useful to display several branded and enticing assets as a form of short presentation when demonstrating or exhibiting terminals at Trade Shows or when visiting clients. Payter can set this up for our Test terminals upon request.