Contains all SiteKiosk system relevant settings.
Path:

system

Hierarchy

  • System

Properties

audio: Audio

Audio settings

system.audio

browser: Browser

The configuration for the main browser.

system.browser

dailyReboot: boolean

Default: false

Whether SiteKiosk should reboot the device daily at a defined time (requires root)

system.dailyReboot

dailyRebootTime: number

Default: 0

The time in seconds since midnight, where SiteKiosk will perform a reboot (requires root)

system.dailyRebootTime

dailySleep: boolean

Default: false

Whether SiteKiosk should allow the display to turn off during a defined period within the day

system.dailySleep

dailySleepTime: number

Default: 66600

The start of the period of the day in seconds since midnight where SiteKiosk will allow the display/keyboard to turn off

system.dailySleepTime

dailyWakeupTime: number

Default: 32400

The end of the period of the day in seconds since midnight where SiteKiosk will allow the display/keyboard to turn off

system.dailyWakeupTime

dim: boolean

Default: false

Instead of keeping the screen bright during non-sleep hours, allow the screen to dim during inactivity

system.dim

dimOnlyOnSleep: any
forceSoftwareRendering: boolean

Default: false

Disables hardware acceleration within SiteKiosk and can solve rendering issues

system.forceSoftwareRendering

keepScreenOn: boolean

Default: true

Whether SiteKiosk will automatically wake up the device during non-sleep hours, eg. if the user manualy turns of the display

system.keepScreenOn

logging: LoggingConfig

Defines the log behaviour, log path, eg.

system.logging

nfc: boolean

Default: false

When enabled SiteKiosk will listen for NDEF tokens and navigate to their URL contents

system.nfc

onlyDimOnSleep?: boolean

Default: false

Modifies the sleep mode to dim the screen instead of turning it off completely

system.onlyDimOnSleep

orientation: Orientation

Default: "Sensor"

Sets the desired system-wide screen orientation.

system.orientation

scheduledMaintenanceTasks: MaintenanceTaskConfig[]

Default:

[
  {
    "day": "Daily",
    "hour": 4,
    "minute": 0,
    "action": "Restart"
  }
]


List of scheduled maintenance tasks.

system.scheduledMaintenanceTasks

screenBrightness: number

Default: 255

Sets the screen brightness in manual mode (may require device owner provisioning). Only integers between 0 and 255 are allowed .

system.screenBrightness

screenBrightnessMode: BrightnessMode

Default: "Automatic"

The system brightness mode to be set (may require device owner provisioning)

system.screenBrightnessMode

screenOffTimeout: number

Default: 30000

The amount of inactiviy in milliseconds before Android allows the screen to turn off (may require device owner provisioning). This system settings will affect SiteKiosk sleep hours: the display only turns off when SiteKiosk is allowing it and the screen off timeout is also expired.

system.screenOffTimeout

setupWifi: boolean

Default: false

When enabled, SiteKiosk will require a WiFi setup on start

system.setupWifi

siteKioskRestart: boolean

Default: true

Whether SiteKiosk restarts daily at a defined time

system.siteKioskRestart

siteKioskRestartTime: number

Default: 43200

The uptime in seconds after which SiteKiosk will restart when the user also becomes idle

system.siteKioskRestartTime

sleepOnBattery: boolean

Default: false

When enabled, SiteKiosk will allow the display/keyboard to turn of, when the device it not connected to main power

system.sleepOnBattery

syncTime: boolean

Default: false

Whether SiteKiosk should sync the system time with siteremote.net (requires root)

system.syncTime

watchDog: WatchDog

These settings allow to customize the watchdog behavior

system.watchDog

Generated using TypeDoc