Advanced device configuration options for Windows 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 theconfig
to the box
Clear button only clears the input field to an empty json. Sending this json doesn't disable the previous configuration of the device.
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": "AUTO_START",
"enabled": true
}
]
}
enabled
key has to be defined, value has to be a non-empty booleanmaxMemoryLimitFraction
key has to be defined, value has to be number. The minimum limit is0.4
, the maximum is1.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": "64 13"
}
]
}
]
}
-
commands
has to be an array type containing validScreenControlCommand
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 exampleTOF/n
- In case of
byte
messageType
they have to be separated by a space for example25 24 12
or64 54
- In case of
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
}
]
}
enabled
key has to be defined, value has to be a non-empty boolean
Set WebView basic authentication for HTTP stream, and external websites
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"
}
]
}
]
}
credentialList
has to be an array type containing validcredentialList
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 Power button behavior
Set the behavior of the power button
{
"configuration": [
{
"type": "POWER_BUTTON",
"mode": "DO_NOTHING"
}
]
}
mode
key has to be defined, and one of the following values:DO_NOTHING
,SLEEP
,SHUTDOWN
Turn off websecurity
This command disables device's websecurity.
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": "WEB_SECURITY",
"enabled": false
}
]
}
Set application's automatic start
Set the application's behavior, to start when system starts.
{
"configuration": [
{
"type": "AUTO_START",
"enabled": true
}
]
}
Set application's window properties
Set the application's window properties and behavior
{
"configuration": [
{
"type": "APPLICATION_WINDOW",
"windowMode": "FullScreen",
"windowPosition": "LeftTop",
"width": 1280,
"height": 720
}
]
}
windowMode
key has to be defined, and one of the following values:FullScreen
,FullScreenMultiple
,Windowed
windowPosition
key has to be defined, and one of the following values:LeftTop
,Center
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