Screensaver

The screensaver screen type is special in that the contents of this screen type are defined in the static configuration.

warning

Screensavers are configured via MyPayter.

Screen Type Id : screensaver

The screensaver consists of a set of info screen types defined in settings via MyPayter. When this screen type is selected for display the info screens are displayed according to this preset configuration.

The configuration in MyPayter is set with the following advanced settings keys. The screen saver will be activated when the screen is not used for a configured amount of time or can be triggered by sending the screensaver command as described in the example.

MyPayter Key	Type	Description
`screensaver-screens-x-title`	utf-8 string	The primary title field on the screen. The field wraps when text overflows the width.
`screensaver-screens-x-subtitle`	utf-8 string	The subtitle field on the screen. The field wraps when text overflows the width.
`screensaver-screens-x-qrcode`	utf-8 string	String to be encoded in a QR code that is displayed at the top of the screen.
`screensaver-screens-x-offset`	integer (0-420)	Controls the offset (in px) of the title and subtitle as measured from the top of the screen. If omitted a default of 235 is used.
`screensaver-screens-x-delay`	integer	Delay before next screen in ms.
screensaver-screens-x-background	ascii string	Name of the asset to use as background image on the UI. See UI Assets The asset must be a 320x480 px png file.

note

These keys all follow the same pattern screensaver-screens-<n>-<key> where <x> is the index of the screen from 0-(n-1) for n screensaver screens. All the keys are the same as the properties set for an info screen, with the exception of delay. This determines how long this info screen is displayed before the next one becomes active.

info

The screensaver configured via MyPayter can also be displayed by the UI after a period of UI inactivity. By default this is after 30 seconds of display inactivity. Activity is defined as any change in the UI. To set this value, the following two settings need to be changed. One applies to a terminal that is always in reading mode. The other for terminals with an idle screen:

Set screen-saver-time under tab nexo-terminal-config (always reading).
Set screensaver-timeout under tab apollo-ui (idle screen mode).

warning

While it is possible to disable the automatic screensaver it is recommended to leave it enabled to ensure the LCD does not suffer from image persistence or excessive backlight wear. Deploying without a screensaver may affect your backlight warranty terms.

Properties

The screensaver screen has no properties as it is configured in MyPayter.

Example

curl -X 'POST' ${CPS_UI_URL} \
  -H 'Authorization: CPS apikey="'${CPS_API_KEY}'"' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "my-screensaver-screen",
    "type": "screensaver",
    "properties": {
    }
  }'

Properties​

Example​

Properties

Example