intent_library/com.nimmsta.intent_library/NIMMSTAManager

NIMMSTAManager

Holds the connected devices of the NIMMSTA App and some settings. Now uses dependency injection instead of singleton pattern.

Constructors

NIMMSTAManager

constructor()

Types

Companion

object Companion

Properties

allowMultiDevice

var allowMultiDevice: Boolean?

Indicates whether the system allows managing multiple connected devices simultaneously. This property can be null if the setting value is not initialized or retrieved.

connectedDevices

val connectedDevices: List<NIMMSTADevice>

Returns currently connected devices

devices

val devices: List<NIMMSTADevice>

Provides a list of currently managed NIMMSTA devices. Each device in the list represents an instance of NIMMSTADevice, which is managed maintained by this NIMMSTAManager instance.

interpretButtonAsMotionTrigger

var interpretButtonAsMotionTrigger: Boolean?

Determines whether a button input should be interpreted as a motion trigger.

isActive

val isActive: Boolean

Indicates whether the NIMMSTAService currently has an active instance.

settings

var settings: ManagerSettings?

Stores and manages the current settings of the NIMMSTAManager.

Functions

addOrUpdateDevice

fun addOrUpdateDevice(json: JsonObject): NIMMSTADevice

Adds or updates NIMMSTADevice in devices

attachLightTag

fun attachLightTag(macAddress: String, location: String): Task<Unit>

Associates a light tag with a specific location on a device, identified by its MAC address.

cancelAllConnect

fun cancelAllConnect(): Task<Unit>

Cancels all ongoing connect attempts

cancelConnect

fun cancelConnect(addressOrCode: String): Task<Unit>

Cancels a specific ongoing connect attempt with the given connectionCode or address

cancelSearch

fun cancelSearch(): Task<Unit>

Cancels the search for scanners

canChangeCompatibilityMode

fun canChangeCompatibilityMode(): Task<Boolean>

Gets info if compatibility mode can be changed.

changeBluetoothCompatibilityMode

fun changeBluetoothCompatibilityMode(active: Boolean): Task<Unit>

Gets and sets compatibility mode. Please check canChangeCompatibilityMode if can be changed.

connectToAddress

fun connectToAddress(address: String, scanTimeout: Int? = null): Task<NIMMSTADevice>

Tries to connect to a device with the given address Can be canceled with cancelConnect

connectToConnectionCode

fun connectToConnectionCode(connectionCode: String, scanTimeout: Int? = null): Task<NIMMSTADevice>

Tries to connect to a device with the given connection code Can be canceled with cancelConnect

detachLightTag

fun detachLightTag(macAddress: String): Task<Unit>

Detaches a light tag associated with a specific MAC address.

displayConnectActivity

fun displayConnectActivity(): Task<Unit>

Displays the connect activity to scan with a scanner

getConnectionCode

fun getConnectionCode(): Task<GetConnectionCodeResponse>

Gets a new connection code from the NIMMSTA App

getDeviceWithAddress

fun getDeviceWithAddress(address: String): NIMMSTADevice?

Tries to return the device with the given address null if not found

getInitialManagerInfos

fun getInitialManagerInfos(): Task<Unit>

Initial request after creation to get devices and settings

removeDevice

fun removeDevice(device: NIMMSTADevice, removeFromGlobalDevices: Boolean = false)

Removes a specific device from the list of managed devices.

fun removeDevice(address: String, removeFromGlobalDevices: Boolean = false)

Removes a device with the specified address from the list of managed devices.

searchForLightTags

fun searchForLightTags(): Task<Unit>

Starts the search for light tags

searchForNimmstaDevices

fun searchForNimmstaDevices(): Task<Unit>

Starts the search for scanners.

setAppInBackgroundScreen

fun setAppInBackgroundScreen(nimmstaLayout: NIMMSTALayout): Task<Unit>

fun setAppInBackgroundScreen(xmlString: String, parameters: Map<String, String> = mapOf()): Task<Unit>

Sets a custom layout to be displayed on the NIMMSTA device when the app is in the background.

setDesiredLightTags

fun setDesiredLightTags(lightTags: List<String>): Task<Unit>

Sets the desired light tags, associating each tag with the default illumination configuration.

fun setDesiredLightTags(lightTags: List<String>, config: LightTagIlluminationConfig = LightTagIlluminationConfig.Default): Task<Unit>

Sets the desired light tags with the specified illumination configuration.

fun setDesiredLightTags(lightTags: List<String>, color: LTColor, intensity: Int = LightTagIlluminationConfig.Default.intensity, pattern: LTBlinkingPattern = LightTagIlluminationConfig.Default.pattern): Task<Unit>

Sets the desired light tags with a specific illumination configuration.

setDesiredLightTagsWithMacAddress

fun setDesiredLightTagsWithMacAddress(macAddresses: List<String>): Task<Unit>

Sets the desired light tags associated with the specified MAC addresses, applying the default illumination configuration for each light tag.

fun setDesiredLightTagsWithMacAddress(macAddresses: List<String>, config: LightTagIlluminationConfig = LightTagIlluminationConfig.Default): Task<Unit>

Sets the desired light tags associated with the given MAC addresses, applying the specified illumination configuration to each tag.

fun setDesiredLightTagsWithMacAddress(macAddresses: List<String>, color: LTColor, intensity: Int = LightTagIlluminationConfig.Default.intensity, pattern: LTBlinkingPattern = LightTagIlluminationConfig.Default.pattern): Task<Unit>

Sets the desired light tags for the specified devices, identified by their MAC addresses, applying the given illumination configuration settings which include color, intensity, and blinking pattern.

stopSearchForLightTags

fun stopSearchForLightTags(): Task<Unit>

Cancels the search for light tags