```
public final class NIMMSTADevice

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

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`address`
`private final String`	`serialNumber`
`private Boolean`	`prefersReconnect`
`private Integer`	`reconnectTimeout`
`private AimMode`	`preferredAimMode`
`private TriggerMode`	`preferredTriggerMode`
`private Boolean`	`prefersShutdownOnCharge`
`private JsonObject`	`decoderBoardSettings`
`private final Integer`	`batteryLevel`
`private final Boolean`	`isCharging`
`private final Boolean`	`isSearchingToReconnect`
`private final Boolean`	`wasReconnected`
`private DeviceState`	`deviceState`

Constructor Summary

Constructors
Constructor	Description
`NIMMSTADevice(DeviceState state)`

Method Summary

Modifier and Type	Method	Description
`final String`	`getAddress()`
`final String`	`getSerialNumber()`
`final Boolean`	`getPrefersReconnect()`
`final Unit`	`setPrefersReconnect(Boolean prefersReconnect)`
`final Integer`	`getReconnectTimeout()`
`final Unit`	`setReconnectTimeout(Integer reconnectTimeout)`
`final AimMode`	`getPreferredAimMode()`
`final Unit`	`setPreferredAimMode(AimMode preferredAimMode)`
`final TriggerMode`	`getPreferredTriggerMode()`
`final Unit`	`setPreferredTriggerMode(TriggerMode preferredTriggerMode)`
`final Boolean`	`getPrefersShutdownOnCharge()`
`final Unit`	`setPrefersShutdownOnCharge(Boolean prefersShutdownOnCharge)`
`final JsonObject`	`getDecoderBoardSettings()`
`final Unit`	`setDecoderBoardSettings(JsonObject decoderBoardSettings)`
`final Integer`	`getBatteryLevel()`
`final Boolean`	`getIsCharging()`
`final Boolean`	`getIsSearchingToReconnect()`
`final Boolean`	`getWasReconnected()`
`final DeviceState`	`getDeviceState()`
`final Unit`	`setDeviceState(DeviceState deviceState)`
`final Task<GetDeviceInfoResponse>`	`getDeviceInfo()`	Gets information from the device
`final Task<Unit>`	`isConnected()`	Checks if the device is connected
`final Task<Unit>`	`disconnect()`	Disconnects this device
`final Task<Unit>`	`stopReconnecting()`	Stops reconnecting this device
`final Task<Unit>`	`setLayout(String layoutXML)`	Sets a layout on the scanner
`final Task<Unit>`	`setLayout(NIMMSTALayout layout)`	Sets a layout on the scanner
`final Task<Unit>`	`setLayoutFor(String layoutXML, Integer timeout)`	Sets a layout for a given time on the scanner.
`final Task<Unit>`	`setLayoutFor(NIMMSTALayout layout, Integer timeout)`	Sets a layout for a given time on the scanner.
`final Task<Unit>`	`updateLayout(Map<String, String> parameters)`	Updates the current layout with the given parameters
`final Task<Unit>`	`setLEDColor(Integer red, Integer green, Integer blue)`	Sets the Color of the LED of the scanner
`final Task<Unit>`	`setLEDColorHex(String hexStr)`	Sends the SetLEDColorAction The hex String supports following formats: "#FFFFFF", "0xFFFFFF", "FFFFFF", "#FFF", "0xFFF", "FFF"
`final Task<Unit>`	`triggerBeeperBurst(Integer repeat, Integer duration, Integer pulseDuration, Integer intensity)`	Triggers the beeper of the scanner in a given pattern
`final Task<Unit>`	`triggerLEDBurst(Integer repeat, Integer duration, Integer pulseDuration, Integer red, Integer green, Integer blue)`	Triggers the LED of the scanner in a given pattern and color
`final Task<Unit>`	`triggerVibratorBurst(Integer repeat, Integer duration, Integer pulseDuration, Integer intensity)`	Triggers the vibration of the scanner in a given pattern
`final Task<Unit>`	`triggerSOS()`	Triggers the SOS signal of the scanner 3x Beep, Red LED, Vibration
`final Task<Unit>`	`triggerImager(Integer duration)`	Triggers the imager for a given duration
`final Task<SoftwareUpdateInfo>`	`validateSoftwareUpdate(String filePath, String securityToken)`	Gets info for a software update file.
`final Task<Unit>`	`performSoftwareUpdate(String filePath, String securityToken, List<SoftwareUpdateInfo> selectedComponents)`	Performs software update with given file and optional selected components.
`final Task<Unit>`	`setScreenRotation(ScreenOrientation rotation)`	Sets the screen rotation of the scanner

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- NIMMSTADevice
```
NIMMSTADevice(DeviceState state)
```

Method Detail

getAddress
```
 final String getAddress()
```

getSerialNumber
```
 final String getSerialNumber()
```

getPrefersReconnect
```
 final Boolean getPrefersReconnect()
```

setPrefersReconnect

 final Unit setPrefersReconnect(Boolean prefersReconnect)

getReconnectTimeout
```
 final Integer getReconnectTimeout()
```

setReconnectTimeout

 final Unit setReconnectTimeout(Integer reconnectTimeout)

getPreferredAimMode
```
 final AimMode getPreferredAimMode()
```

setPreferredAimMode

 final Unit setPreferredAimMode(AimMode preferredAimMode)

getPreferredTriggerMode

 final TriggerMode getPreferredTriggerMode()

setPreferredTriggerMode

 final Unit setPreferredTriggerMode(TriggerMode preferredTriggerMode)

getPrefersShutdownOnCharge

 final Boolean getPrefersShutdownOnCharge()

setPrefersShutdownOnCharge

 final Unit setPrefersShutdownOnCharge(Boolean prefersShutdownOnCharge)

getDecoderBoardSettings

 final JsonObject getDecoderBoardSettings()

setDecoderBoardSettings

 final Unit setDecoderBoardSettings(JsonObject decoderBoardSettings)

getBatteryLevel
```
 final Integer getBatteryLevel()
```

getIsCharging
```
 final Boolean getIsCharging()
```

getIsSearchingToReconnect

 final Boolean getIsSearchingToReconnect()

getWasReconnected
```
 final Boolean getWasReconnected()
```

getDeviceState
```
 final DeviceState getDeviceState()
```

setDeviceState

 final Unit setDeviceState(DeviceState deviceState)

getDeviceInfo

 final Task<GetDeviceInfoResponse> getDeviceInfo()

Gets information from the device

isConnected
```
 final Task<Unit> isConnected()
```
Checks if the device is connected

disconnect
```
 final Task<Unit> disconnect()
```
Disconnects this device

stopReconnecting
```
 final Task<Unit> stopReconnecting()
```
Stops reconnecting this device

setLayout

 final Task<Unit> setLayout(String layoutXML)

Sets a layout on the scanner

setLayout

 final Task<Unit> setLayout(NIMMSTALayout layout)

Sets a layout on the scanner

setLayoutFor
```
 final Task<Unit> setLayoutFor(String layoutXML, Integer timeout)
```
Sets a layout for a given time on the scanner. Returns to the previous layout afterward

setLayoutFor
```
 final Task<Unit> setLayoutFor(NIMMSTALayout layout, Integer timeout)
```
Sets a layout for a given time on the scanner. Returns to the previous layout afterward

updateLayout

 final Task<Unit> updateLayout(Map<String, String> parameters)

Updates the current layout with the given parameters

setLEDColor

 final Task<Unit> setLEDColor(Integer red, Integer green, Integer blue)

Sets the Color of the LED of the scanner

setLEDColorHex
```
 final Task<Unit> setLEDColorHex(String hexStr)
```
Sends the SetLEDColorAction The hex String supports following formats: "#FFFFFF", "0xFFFFFF", "FFFFFF", "#FFF", "0xFFF", "FFF"

triggerBeeperBurst

 final Task<Unit> triggerBeeperBurst(Integer repeat, Integer duration, Integer pulseDuration, Integer intensity)

Triggers the beeper of the scanner in a given pattern

triggerLEDBurst

 final Task<Unit> triggerLEDBurst(Integer repeat, Integer duration, Integer pulseDuration, Integer red, Integer green, Integer blue)

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

triggerVibratorBurst

 final Task<Unit> triggerVibratorBurst(Integer repeat, Integer duration, Integer pulseDuration, Integer intensity)

Triggers the vibration of the scanner in a given pattern

triggerSOS
```
 final Task<Unit> triggerSOS()
```
Triggers the SOS signal of the scanner 3x Beep, Red LED, Vibration

triggerImager

 final Task<Unit> triggerImager(Integer duration)

Triggers the imager for a given duration

validateSoftwareUpdate

 final Task<SoftwareUpdateInfo> validateSoftwareUpdate(String filePath, String securityToken)

Gets info for a software update file.

performSoftwareUpdate

 final Task<Unit> performSoftwareUpdate(String filePath, String securityToken, List<SoftwareUpdateInfo> selectedComponents)

Performs software update with given file and optional selected components.

setScreenRotation
```
 final Task<Unit> setScreenRotation(ScreenOrientation rotation)
```
Sets the screen rotation of the scanner

Parameters:

rotation - The ScreenOrientation to be set.

Class NIMMSTADevice

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NIMMSTADevice

Method Detail

getAddress

getSerialNumber

getPrefersReconnect

setPrefersReconnect

getReconnectTimeout

setReconnectTimeout

getPreferredAimMode

setPreferredAimMode

getPreferredTriggerMode

setPreferredTriggerMode

getPrefersShutdownOnCharge

setPrefersShutdownOnCharge

getDecoderBoardSettings

setDecoderBoardSettings

getBatteryLevel

getIsCharging

getIsSearchingToReconnect

getWasReconnected

getDeviceState

setDeviceState

getDeviceInfo

isConnected

disconnect

stopReconnecting

setLayout

setLayout

setLayoutFor

setLayoutFor

updateLayout

setLEDColor

setLEDColorHex

triggerBeeperBurst

triggerLEDBurst

triggerVibratorBurst

triggerSOS

triggerImager

validateSoftwareUpdate

performSoftwareUpdate

setScreenRotation