PolyOs API/com.poly.polyos.system/IPolySystemService

IPolySystemService

interface IPolySystemService

System service exposed for PolyClients

Functions

collateLogPackage

abstract fun collateLogPackage(): String

Collect logs from the system and all connected secondary devices (e.g.

abstract fun decryptData(data: Array<Byte>): Array<Byte>

Decrypts the specified data using the Poly manufacturer installed private key on the com.poly.polyos.room.DeviceType PRIMARY.

abstract fun encryptData(data: Array<Byte>): Array<Byte>

Encrypts the specified data using the Poly manufacturer installed private key on the com.poly.polyos.room.DeviceType PRIMARY.

abstract fun endDeviceMode(): Boolean

Ends any current device mode session.

endDigitalSignage

abstract fun endDigitalSignage(): Boolean

Ends digital signage.

getConnectedDisplays

abstract fun getConnectedDisplays(): List<Display>

Returns a list of Displays connected to the room device

getCurrentActivity

abstract fun getCurrentActivity(): ActivityPath

Get the current activity running on the targeted endpoint.

getDeviceCertificates

abstract fun getDeviceCertificates(includeCAChain: Boolean): String

Retrieves the Poly manufacturer installed device certificate on the com.poly.polyos.room.DeviceType PRIMARY.

abstract fun getDeviceId(): String

Returns a unique id of the device of PRIMARY This can be targeted to CONTROLLER, if called on an instance returned by targetLocal

getDevicePluginState

abstract fun getDevicePluginState(): DevicePluginState

Returns the current state of the HDMI/USB connections.

getFirmwareVersion

abstract fun getFirmwareVersion(): String

Returns firmware version of PRIMARY.

abstract fun getPackageInfo(packageName: String): PackageInfo

Get the Package info

getSleepTimeOut

abstract fun getSleepTimeOut(): Int

Returns the sleep timeout

getSoftwareUpdateInfo

abstract fun getSoftwareUpdateInfo(url: String): SoftwareUpdateInfo

Check if there is a new software update version.

abstract fun getSystemState(): SystemState

Returns current SystemState

abstract fun getUsbDevices(): List<UsbDevice>

Returns a java.util.List of available UsbDevices

isDeviceModeEnabled

abstract fun isDeviceModeEnabled(): Boolean

Returns whether device mode capability is enabled

isDigitalSigangeEnabled

abstract fun isDigitalSigangeEnabled(): Boolean

Returns whether digital signage capability is enabled

abstract fun isInDeviceMode(): Boolean

Returns whether system is currently in device mode session

isInDigitalSignage

abstract fun isInDigitalSignage(): Boolean

Returns whether system is currently in digital signage

launchSystemSettings

abstract fun launchSystemSettings()

Launches settings on the com.poly.polyos.room.DeviceType PRIMARY.

prepareSystemLogs

abstract fun prepareSystemLogs( destPath: String, maxSize: Long, includeAppLogs: Boolean): Boolean

Collect logs from the system and all connected secondary devices (if called from primary), optionally including ecosystem application logs from apps running on the system/secondaries, optionally limit the size of the collected logs, collate them into a single gzipped tarball file, and write them to a caller-supplied path.

registerSystemListener

abstract fun registerSystemListener(listener: IPolySystemListener)

Registers a IPolySystemListener

abstract fun resetLedState()

Restores control of the device's LED lighting to the default LED state machine control.

abstract fun resetSystem(resetOptions: ResetOptions): Boolean

Perform factory reset on the system.

abstract fun restartSystem(): Boolean

Restarts the system This can be targeted to CONTROLLER, if called on an instance returned by targetLocal.

setCustomLedColorWithAnimation

abstract fun setCustomLedColorWithAnimation(rgb: Int, animation: LightAnimation): Boolean

Overrides the default LED light behavior, instructing the controller to illuminate its LEDs using a specified 24-bit RGB color and animation pattern.

setDeviceModeEnabled

abstract fun setDeviceModeEnabled(enabled: Boolean)

Enable or disable device mode capability

setDisplayResolution

abstract fun setDisplayResolution(displayId: Int, resolution: Resolution): ResponseStatus

Sets the resolution of the given display

setSleepTimeOut

abstract fun setSleepTimeOut(timeout: Int): Boolean

Sets the time out for sleep.

abstract fun shutdownSystem(): Boolean

Shuts down the system.

abstract fun signData(data: Array<Byte>): Array<Byte>

Generates a digital signature, for the specified data, using the Poly manufacturer installed device private key, on the com.poly.polyos.room.DeviceType PRIMARY.

abstract fun sleep(): Boolean

Put the system to sleep

abstract fun startActivity(packageName: String, activityName: String): Boolean

Start an activity on the targeted endpoint.

startDeviceMode

abstract fun startDeviceMode(): Boolean

Starts a device mode session.

startDigitalSignage

abstract fun startDigitalSignage(): Boolean

Starts digital signage.

abstract fun targetLocal(): IPolySystemService

Returns a IPolySystemService targeting the calls to the local com.poly.polyos.room.DeviceType Returns the same instance if called from PRIMARY.

unRegisterSystemListener

abstract fun unRegisterSystemListener(listener: IPolySystemListener)

Un Registers a IPolySystemListener

~~abstract~~ ~~fun~~ ~~updateApp~~(url: String): Boolean

Update the client application from the given url.

updateApplication

abstract fun updateApplication(url: String): ResponseStatus

Update the client application from the given url.

abstract fun updateFirmware(url: String): Boolean

Updates firmware using URL provided.

abstract fun wakeup(): Boolean

Wakes up the system