This action cancels a current connection attempt You need to provide the address or the connection code that was used to initiate the connection attempt

CancelSearchAction

class CancelSearchAction : IAction

This action cancels the search for new devices

ConnectToAddressAction

class ConnectToAddressAction(address: String, scanTimeout: Int?) : IAction

This action triggers a connection attempt to a device with the given address

ConnectToConnectionCodeAction

class ConnectToConnectionCodeAction(connectionCode: String, scanTimeout: Int?) : IAction

This action triggers a connection attempt to a device with the given connection code

DetachLightTagAction

class DetachLightTagAction(val macAddress: String) : IAction

This action detaches a location from a light tag.

DisconnectAction

class DisconnectAction(shutdown: Boolean = false) : IAction

This action disconnects a device (and shutdowns it if wanted)

DisplayConnectActivityAction

class DisplayConnectActivityAction : IAction

This action displays the connect activity to connect a new scanner

GetConnectionCodeAction

class GetConnectionCodeAction : IAction

Action that gets a newly generated connection code from the api To see what data gets returned see GetConnectionCodeResponse

GetConnectionCodeResponse

@Serializable

class GetConnectionCodeResponse

GetDeviceInfoAction

class GetDeviceInfoAction : IAction

Action that gets infos of the scanner

GetDeviceInfoResponse

@Serializable

class GetDeviceInfoResponse : DeviceState

GetInitialConnectionManagerInfosAction

class GetInitialConnectionManagerInfosAction : IAction

This action gets a list of devices and the manager settings

IAction

interface IAction

Interface for actions we send to the NIMMSTA App

IsConnectedAction

class IsConnectedAction : IAction

Action that gets infos of the scanner

PerformSoftwareUpdateAction

class PerformSoftwareUpdateAction(filePath: String, securityToken: String, selectedComponents: List<SoftwareUpdateInfo>?) : IAction

Performs a software update. Make sure to check the update with ValidateSoftwareUpdateAction first.

SearchForLightTagsAction

class SearchForLightTagsAction : IAction

SearchForNimmstaDevicesAction

class SearchForNimmstaDevicesAction : IAction

This action starts the search for new devices Use the Events (com.nimmsta.intent_library.NIMMSTAManagerEventHandler.deviceFound, com.nimmsta.intent_library.NIMMSTAManagerEventHandler.deviceRemoved) of the com.nimmsta.intent_library.NIMMSTAManagerEventHandler to get informed about newly discovered or lost devices

SetAppInBackgroundScreenAction

class SetAppInBackgroundScreenAction(layout: NIMMSTALayout) : IAction

This action sets the layout used when no app is connected to intent service.

SetConnectionManagerSettingsAction

class SetConnectionManagerSettingsAction(settings: ManagerSettings) : IAction

This action sets the settings for the connection manager

SetDecoderBoardSettingsAction

class SetDecoderBoardSettingsAction(settings: JsonObject) : IAction

Action that sends and sets new decoderboard settings

SetDesiredLightTagsAction

class SetDesiredLightTagsAction(val locations: List<String>, val config: LightTagIlluminationConfig = LightTagIlluminationConfig.Default) : IAction

This action illuminates light tags or turns them off (providing locations an empty array will turn off all light tags).

SetDesiredLightTagsWithMacAddressAction

class SetDesiredLightTagsWithMacAddressAction(val macAddresses: List<String>, val config: LightTagIlluminationConfig = LightTagIlluminationConfig.Default) : IAction

This action illuminates light tags or turns them off (providing locations an empty array will turn off all light tags).

SetDeviceSettingsAction

class SetDeviceSettingsAction(state: DeviceState) : IAction

Action that sets the information about the device.

SetLayoutAction

class SetLayoutAction(layout: NIMMSTALayout) : IAction

This action sets the layout on the scanner

SetLayoutForAction

class SetLayoutForAction(layout: NIMMSTALayout, timeout: Int) : IAction

This action set the layout on the scanner for a given time. Previous layout is shown afterwards

SetLEDColorAction

class SetLEDColorAction(red: Int, green: Int, blue: Int) : IAction

This actions sets the color of the LED of the scanner

SetScreenOrientationAction

class SetScreenOrientationAction(val rotation: ScreenOrientation) : IAction

This action sets the screen orientation of the device See ScreenOrientation for possible values

SoftwareUpdateInfo

@Serializable

class SoftwareUpdateInfo

StopReconnectingAction

class StopReconnectingAction : IAction

This action stops reconnecting to a device

StopSearchForLightTagsAction

class StopSearchForLightTagsAction : IAction

TriggerBeeperBurstAction

class TriggerBeeperBurstAction(repeat: Int, duration: Int, pulseDuration: Int, intensity: Int) : IAction

This action triggers the beeper of the scanner in a given pattern

TriggerImagerAction

class TriggerImagerAction(duration: Int) : IAction

This action triggers the imager on the scanner for the given duration

TriggerLEDBurstAction

class TriggerLEDBurstAction(repeat: Int, duration: Int, pulseDuration: Int, red: Int, green: Int, blue: Int) : IAction

This action triggers the LED of the scanner in a given pattern and color

TriggerSOSAction

class TriggerSOSAction : IAction

This action triggers the SOS signal on the scanner 3x Beep, red LED, vibration

TriggerVibratorBurstAction

class TriggerVibratorBurstAction(repeat: Int, duration: Int, pulseDuration: Int, intensity: Int) : IAction

This action triggers the vibrator of the scanner in a given pattern

UpdateLayoutAction

class UpdateLayoutAction(parameters: Map<String, String>) : IAction

This action updates a given layout on the scanner Parameters have to be the names of the elements in the already displayed layout for this to have any effect

ValidateSoftwareUpdateAction

class ValidateSoftwareUpdateAction(file: String, securityToken: String) : IAction

This action disconnects a device (and shutdowns it if wanted)