Skip to main content

Advanced device configuration options for Android players

Where can you set these configurations?

1.x UI

You can set advanced configuration from the context menu of the device: Manage screen >> Set Advanced config

  • A modal will appear where you can type or paste the config and send it to the device.

2.0 UI

Navigate yourself to Devices menu, select the device where you wish to set the advanced configs.

  • In the details tab, select settings, scroll down until you find the Advanced config modal.
  • Click on the edit then place the config to the box

You can set the Advanced configuration in the Right click menu of a Screen > Manage screen > Device properties > Set advanced configuration option for devices that support this option:

advanced_config_rightclick

This will open up the json editor modal

advanced_config_modal

Please note

Clear button only clears the input field to an empty json. Sending this json doesn't disable the previous configuration of the device.

Generic advanced configuration options for Android devices

These advanced configuration options work on all supported Android devices.

The basic configuration structure is the following json array, which contains the actual configuration objects

{
"configuration": [
{
}
]
}

There can be multiple objects inside a singe command. For example you can enable both debug mode and memory watchdog in the same Advanced configuration json

{
"configuration": [
{
"type": "DEBUG_MODE",
"enabled": true
},
{
"type": "MEMORY_WATCHDOG",
"enabled": true,
"maxMemoryLimitFraction": 0.8
}
]
}
info
  • enabled key has to be defined, value has to be a non-empty boolean
  • maxMemoryLimitFraction key has to be defined, value has to be number. The minimum limit is 0.4, the maximum is 1.0.

Screen control

Control screens

{
"configuration": [
{
"type": "SCREEN_CONTROL",
"serialConnection": {
"baudrate": 9600,
"port": "0",
"dataBits": 8,
"stopBits": 1,
"parity": 0,
"flowControl": 1
},
"socketConnection": {
"address": "localhost",
"port": 1234
},
"commands": [
{
"action": "SCREEN_ON",
"method": "serial",
"messageType": "string",
"message": "TOF/n"
},
{
"action": "SCREEN_OFF",
"method": "cec",
"messageType": "byte",
"message": "x64x13"
}
]
}
]
}
info

The port parameter here must be specified, you can find more information about how to find the port here

Parameters

  • commands has to be an array type containing valid ScreenControlCommand objects
  • action key has to be defined, and one of the following values: SCREEN_ON, SCREEN_OFF
  • method key has to be defined, one of the following values: serial,socket,cec
  • messageType key has to be defined, and one of the following values: byte, string
  • message has to be defined
    • In case of string messageType they have to be non-empty strings for example TOF/n
    • In case of byte messageType they have to be separated by an x for example x25x24x12 or x64x54

Screen configuration

info

Currently the Screen configuration is only supported on the Giada D77 Android device

{
"configuration": [
{
"mode": "SPLIT",
"type": "SCREEN_CONFIGURATION",
"enabled": true,
"fullWidth": 3840,
"fullHeight": 2160,
"screens": [
{
"screenX": 0,
"screenY": 0,
"outputName": "HDMI-A-1",
"screenWidth": 1920,
"screenHeight": 1080
},
{
"screenX": 1920,
"screenY": 0,
"outputName": "HDMI-A-2",
"screenWidth": 1920,
"screenHeight": 1080
},
{
"screenX": 0,
"screenY": 1080,
"outputName": "DP",
"screenWidth": 1920,
"screenHeight": 1080
},
{
"screenX": 1920,
"screenY": 1080,
"outputName": "DSI",
"screenWidth": 1920,
"screenHeight": 1080
}
]
}
]
}

Parameters

  • mode defines the multi-screen configuration mode the value can be MIRROR or SPLIT
  • fullWidth fullHeight these define the maximum width and height of the multi-screen configuration
  • screenX screenY defines the physical screen position in the multi-screen configuration
  • outputName the name of the Hdmi connector
  • screenWidth screenHeight define the physical resolution of the screen

Show debug logs

Sometimes the support team requires a device log from the users to find out what causes a problem on the device. Enabling the debug log on the device will show more information for us in the device log.

{
"configuration": [
{
"type": "DEBUG_MODE",
"enabled": true
}
]
}
info
  • enabled key has to be defined, value has to be a non-empty boolean

Set WebView basic authentication for HTTP stream

Set authentication details for secured HTTP streams

{
"configuration": [
{
"type": "WEBVIEW_BASIC_AUTHENTICATION",
"credentialList": [
{
"domainUrl": "PROTOCOL://DOMAIN:PORT/PATH",
"userName": "AUTH_USER_NAME",
"password": "AUTH_PASSWORD"
}
]
}
]
}
info
  • credentialList has to be an array type containing valid credentialList objects

Examples on how to fill data in the configuration:

{
"configuration": [
{
"type": "WEBVIEW_BASIC_AUTHENTICATION",
"credentialList": [
{
"domainUrl": "http://192.168.1.166:8080/",
"userName": "MyUserName",
"password": "MyPassword"
}
]
}
]
}
{
"configuration": [
{
"type": "WEBVIEW_BASIC_AUTHENTICATION",
"credentialList": [
{
"domainUrl": "http://mystreamhost.infoo/",
"userName": "MyUserName",
"password": "MyPassword"
}
]
}
]
}

Set stream playback delay

Overwrites the default stream playback delay of the Hardware Accelerated Player to start playing the stream from the buffer faster or more delayed. The default value is 1500 (ms), and the configuration only accepts values between 500 and 5000.

{
"configuration": [
{
"type": "NETWORK_STREAM_DELAY",
"delay": 2000
}
]
}
info
  • delay key has to be defined, value has to be number, time is in milliseconds. The minimum limit is 500, the maximum is 5000.

Turn on Wifi automatically

After the configuration is sent, the device turns on the Wifi, and every time the Wallboard application starts, it turns on the Wifi if it is turned off.

If the configuration is sent with a false value, it turns off the function.

{
"configuration": [
{
"type": "WIFI_ALWAYS_ON",
"enabled": true
}
]
}
info
  • enabled key has to be defined, value has to be a non-empty boolean.

Turn on trust all webpages

This command allows the device to load untrusted sources into the WebView.

Please note

Enabling this feature carries a certain level of risk. Once this feature is activated, we cannot accept responsibility for any unexpected outcomes that may occur

{
"configuration": [
{
"type": "TRUST_ALL_PAGES",
"enabled": true
}
]
}
info
  • enabled key has to be defined, value has to be a non-empty boolean.

Turn on system memory watchdog

This command turns on a system memory watcher. If the device reaches the given percent limitation the application makes steps to free up used memory by restarting itself. If the memory limit is exceeded a few times the application reboots the device to free up even more memory.

The minimum limit is 0.4, the maximum is 1.0.

{
"configuration": [
{
"type": "MEMORY_WATCHDOG",
"enabled": true,
"maxMemoryLimitFraction": 0.7
}
]
}
info
  • enabled key has to be defined, value has to be a non-empty boolean
  • maxMemoryLimitFraction key has to be defined, value has to be number. The minimum limit is 0.4, the maximum is 1.0.

Turn on IR handling

The Wallboard application disables the IR handling of the device by default to prevent people from turning off the device or causing any trouble. With this command, you can turn it on to allow the users to control the device with IR remote controllers.

Please note

If you turn on this function the Wallboard signage contents will not react to IR commands, only the device will receive them.

{
"configuration": [
{
"type": "DEVICE_IR_HANDLING",
"enabled": true
}
]
}
info
  • enabled key has to be defined, value has to be a non-empty boolean.

Device Preview

The Preview creation/upload can be disabled with this command

{
"configuration": [
{
"type": "DEVICE_PREVIEW",
"enabled": true
}
]
}

Device Statistics

The device Metric and Proof of Display statistics collection can be triggered with this command

{
"configuration": [
{
"type": "STATISTICS_SETTINGS",
"deviceMetricsEnabled": true,
"displayTimeStatEnabled": true
}
]
}
  • The deviceMetricsEnabled parameter can be used to turn on or off the device metric Metric collection and upload
  • The displayTimeStatEnabled parameter can be used to turn on or off the Proof of Display statistics collection and upload

ProDvx API authorization token

The ProDvx device management API requires an authorization token, the application has a base token built into it, but if another token is necessary then it can be changed with this configuration.

{
"configuration": [
{
"type": "PRODVX_TOKEN",
"enabled": true,
"token":"TOKEN"
}
]
}
info

If the the enabled property is set to false the application will fall back to using the built-in base token

Watchdog

The built-in watchdog can be disabled or enabled by this configuration.

info

The watchdog is enabled by default except on Amino devices!

{
"configuration": [
{
"type": "WATCHDOG",
"enabled": true
}
]
}

Qbic specific advanced configuration options

These advanced configuration options are only available on Qbic players.

Set Qbic application update URL

Change Qbic device's application update URL

{
"configuration": [
{
"type": "QBIC_APPLICATION_UPDATE_URL",
"url": "PLACE_URL_HERE"
}
]
}

Set Qbic firmware update URL

Change Qbic device's firmware update URL

{
"configuration": [
{
"type": "QBIC_FIRMWARE_UPDATE_URL",
"url": "PLACE_URL_HERE"
}
]
}

Qbic HDMI / CEC control

Enable HDMI / CEC control for Qbic device

{
"configuration": [
{
"type": "QBIC_HDMI_CEC",
"enabled": true
}
]
}

Qbic on/off type

This configuration only allows choosing the turn on/off method.

HDMI output

Allows the device to turn on/off the output source, the device gives to the screen. The disadvantage is that it does not turn off the screen.

{
"configuration": [
{
"type": "QBIC_DISPLAY_STATE_COMMAND",
"command": "HDMI"
}
]
}

CEC

Allows the device to turn on/off the CEC capable screen through HDMI.

{
"configuration": [
{
"type": "QBIC_DISPLAY_STATE_COMMAND",
"command": "CEC"
}
]
}