intent_library/com.nimmsta.intent_library/NIMMSTADevice

NIMMSTADevice

This class represents a connected scanner within the NIMMSTA App Instances of this class can be used to control the scanner

Properties

address

val address: String

batteryLevel

val batteryLevel: Int?

decoderBoardSettings

var decoderBoardSettings: JsonObject?

deviceState

var deviceState: DeviceState

isCharging

val isCharging: Boolean?

isSearchingToReconnect

val isSearchingToReconnect: Boolean?

preferredAimMode

var preferredAimMode: AimMode?

preferredTriggerMode

var preferredTriggerMode: TriggerMode?

prefersReconnect

var prefersReconnect: Boolean?

prefersShutdownOnCharge

var prefersShutdownOnCharge: Boolean?

reconnectTimeout

var reconnectTimeout: Int?

serialNumber

val serialNumber: String

wasReconnected

val wasReconnected: Boolean?

Functions

disconnect

fun disconnect(): Task<Unit>

Disconnects this device

getDeviceInfo

fun getDeviceInfo(): Task<GetDeviceInfoResponse>

Gets information from the device

isConnected

fun isConnected(): Task<Unit>

Checks if the device is connected

performSoftwareUpdate

fun performSoftwareUpdate(filePath: String, securityToken: String, selectedComponents: List<SoftwareUpdateInfo>? = null): Task<Unit>

Performs software update with given file and optional selected components.

setLayout

fun setLayout(layout: NIMMSTALayout): Task<Unit>

fun setLayout(layoutXML: String): Task<Unit>

Sets a layout on the scanner

setLayoutFor

fun setLayoutFor(layout: NIMMSTALayout, timeout: Int): Task<Unit>

fun setLayoutFor(layoutXML: String, timeout: Int): Task<Unit>

Sets a layout for a given time on the scanner. Returns to the previous layout afterward

setLEDColor

fun setLEDColor(red: Int, green: Int, blue: Int): Task<Unit>

Sets the Color of the LED of the scanner

setLEDColorHex

fun setLEDColorHex(hexStr: String): Task<Unit>

Sends the SetLEDColorAction The hex String supports following formats: "#FFFFFF", "0xFFFFFF", "FFFFFF", "#FFF", "0xFFF", "FFF"

setScreenRotation

fun setScreenRotation(rotation: ScreenOrientation): Task<Unit>

Sets the screen rotation of the scanner

stopReconnecting

fun stopReconnecting(): Task<Unit>

Stops reconnecting this device

triggerBeeperBurst

fun triggerBeeperBurst(repeat: Int, duration: Int, pulseDuration: Int, intensity: Int): Task<Unit>

Triggers the beeper of the scanner in a given pattern

triggerImager

fun triggerImager(duration: Int): Task<Unit>

Triggers the imager for a given duration

triggerLEDBurst

fun triggerLEDBurst(repeat: Int, duration: Int, pulseDuration: Int, red: Int, green: Int, blue: Int): Task<Unit>

Triggers the LED of the scanner in a given pattern and color

triggerSOS

fun triggerSOS(): Task<Unit>

Triggers the SOS signal of the scanner 3x Beep, Red LED, Vibration

triggerVibratorBurst

fun triggerVibratorBurst(repeat: Int, duration: Int, pulseDuration: Int, intensity: Int): Task<Unit>

Triggers the vibration of the scanner in a given pattern

updateLayout

fun updateLayout(parameters: Map<String, String>): Task<Unit>

Updates the current layout with the given parameters

validateSoftwareUpdate

fun validateSoftwareUpdate(filePath: String, securityToken: String): Task<SoftwareUpdateInfo>

Gets info for a software update file.