ProGlove documentation

One of the biggest hardware features of MAI is its display. Compared to our previous display device, MARK Display, which has an e-ink static display, MAI has a larger, touch-sensitive, color display. Since the improvement is significant, we consider the MAI display as Display v2.

This new display enables better content presentation and user interaction by:

Besides Display v2, MAI has four physical buttons. They are located on the left and right side, two on each side.

These buttons can be assigned while setting the screen to be used as an additional input from the workers, especially in cases where touch-screen is not preferred. Since they are set for each screen (inside Set Screen Request), they are relevant for that screen only.

Display connection states are received by subscribing to display events.

Subscribe by calling pgManager.subscribeToDisplayEvents() with your IDisplayOutput implementation. Override the callback methods of interest. The onDisplayConnected() callback is triggered when a display device connects, either v1 (e.g., MARK Display) or v2 (e.g., MAI).

Note that this subscribes not only to display connection state but to all display events as well, such as screen events (MAI-specific feature).

Make sure you unsubscribe from display events once you donʼt need them anymore to prevent memory leaks, e.g., inside the onDestroy or onClear callback functions.

Since onDisplayConnected() is triggered when any display device is connected, the next step is to check which display device type is connected.

To check the type of the display that is connected, call pgManager.getConnectedDisplayType(). This function returns the DisplayType enum, where:

Checking the connected display type by calling the pgManager.getConnectedDisplayType() is safe to be done anywhere in the code.

//...

val displayOutput = object : IDisplayOutput {

    override fun onDisplayConnected() {
        val displayType = pgManager.getConnectedDisplayType()
        when (displayType) {
            DisplayType.V1 -> {
                // Inform the user that a Display v1 device is connected (MARK Display)
               }
            DisplayType.V2 -> {
                // Inform the user that a Display v2 device is connected (MAI)
            }
            DisplayType.NOT_DISPLAY_DEVICE -> {
                // Inform the user that the connected device is not a display device
            }
            DisplayType.NOT_CONNECTED -> {
                // Inform the user that there is no device connected
            }
            DisplayType.UNKNOWN -> {
                // No clear information about connected display device type.
                // If you receive this, you should probably update
                // INSIGHT Mobile and SDK to the latest version.
            }
        }
    }

    override fun onDisplayDisconnected() {
        // Inform the user that the display has been disconnected
    }
}

override fun onCreate(savedInstanceState: Bundle?) {
    //...
    pgManager.subscribeToDisplayEvents(displayOutput)

    //...
}

override fun onDestroy() {
    super.onDestroy()
    pgManager.unsubscribeFromDisplayEvents(displayOutput)

    //...
}

//...

Display connection state can be read from the implicit Intent with:

This Intent is received after the display device connection state is changed or after requesting the state by broadcasting an implicit Intent with action com.proglove.api.GET_DISPLAY_STATE.

To request just the connected display type without the state info, broadcast an implicit Intent with action com.proglove.api.GET_DISPLAY_DEVICE_TYPE. Response will be sent in the implicit Intent with action com.proglove.api.DISPLAY_DEVICE_TYPE and relevant extras from the table above.

//...

// 1. Implement a broadcast receiver:
val broadcastReceiver = object : BroadcastReceiver() {

    override fun onReceive(context: Context?, intent: Intent?) {
        if (intent != null && intent.action == "com.proglove.api.DISPLAY_STATE") {
            val displayState = intent.getStringExtra("com.proglove.api.extra.DISPLAY_STATE")
            if (displayState != null) {
                // use displayState
                when (displayState) {
                    "CONNECTED" -> {
                        val displayType = intent.getStringExtra("com.proglove.api.extra.DISPLAY_DEVICE_TYPE")
                        when (displayType) {
                            "DISPLAY_V1" -> {
                                // Inform the user that a Display v1 device is connected (MARK Display)
                            }
                            "DISPLAY_V2" -> {
                                // Inform the user that a Display v2 device is connected (MAI)
                            }
                            "NOT_DISPLAY_DEVICE" -> {
                                // Inform the user that the connected device is not a display device 
                            }
                            "NOT_CONNECTED" -> {
                                // Inform the user that there is no device connected
                            }
                            "UNKNOWN" -> {
                                // No clear information about connected display device type.
                                // If you receive this, you should probably update
                                // INSIGHT Mobile to the latest version.
                            }
                        }
                    }
                    "DISCONNECTED" -> {
                        // Inform the user that the display has been disconnected
                    }
                    else -> {
                        // remaining display states
                    }
                }
            }
        }
    }
}

// 2. Define an `IntentFilter` for the desired actions:
val filter = IntentFilter().apply {
    filter.addAction("com.proglove.api.DISPLAY_STATE")
    filter.addCategory(Intent.CATEGORY_DEFAULT)
}

// 3. Finally, register the broadcast receiver instance. The usual place for this call would be in the `onCreate` method of a
`Service` or an `Activity` class:
override fun onCreate(savedInstanceState: Bundle?) {
    //...
    registerReceiver(broadcastReceiver, filter)

    //...
}

// 4. Do not forget to unregister the receiver, for example in `onDestroy`:
override fun onDestroy() {
    super.onDestroy()
    unregisterReceiver(broadcastReceiver)

    //...
}


//..