Feature: Luggage Tag

Overview

This feature allows for locking the device while the user is not connected to an approved network specified in its respective Launcher configuration. If the Launcher is disconnected from the approved network(s) for longer than an approved amount of time, then the Launcher enters Luggage Tag Mode. It locks the device into an inoperable state and shows a message on the screen for the user. If the device is in Luggage Tag Mode, a user is able to unlock or exit the mode if they enter a passcode.

Luggage Tag can be enabled or disabled using the enable key within the Launcher "luggageTag" configuration. The time it takes to enter the mode itself can be adjusted using thresholdInMinutes which is also found within the Launcher "luggageTag" configuration. As for the approved networks, they can be defined in an array list of strings within the Launcher "approvedNetworks" configuration.

Additionally, users are able to enable a FindMe alarm by using alarmLoopInMinutes within the same "luggageTag" configuration. This will prompt launcher to play the FindMe alarm sound once a user enters Luggage Tag Mode and every time the specified number of minutes have been passed since the last alarm.

Flow

If enable is true and the user is on a network not listed in the Launcher "approvedNetworks" configuration, the device will be locked after a set amount of minutes defined by thresholdInMinutes. When locked, the device will display a Luggage Tag view that states why the user is seeing this message, where the device can be returned, and how to contact someone if found.

There will be a button that says "Unlock". When the user taps the Unlock button, they shall be prompted to enter a passcode. The passcode can be any string, configured in an unlockPassword configuration entry. The password configuration entry shall follow the same logic as the admin password (e.g. sha256 hashed string). If unlockPassword is not specified in the configuration, Luggage Tag will default to using the admin password. The following is an example of a locked device:

Upon entering Luggage Tag Mode, a FindMe alarm will play briefly if the configuration entry, alarmLoopInMinutes, is defined with a number greater than zero. If the user is still in Luggage Tag Mode and the defined number of minutes is passed, the alarm will play again. The alarm loop is turned off only when the user exits Luggage Tag Mode.

When a device is unlocked using the passcode, the device shall restart the luggage tag mode logic. For example, if a device goes into luggage tag mode after a 30 min threshold, unlocking using the passcode will unlock the device but reset the timer back to 30 mins if the device is still in an unapproved network.

Technical Notes

Configuration:

Field	Description
enable	boolean Indicates that the device should be locked while the device is connected to an unapproved network. False indicates that the device is free to connect to any network and will not activate Luggage Tag Mode.
thresholdInMinutes	integer Indicates the number of elapsed minutes while the device is on an unapproved network needed before locking the device.
logo	string The URL for an image to be displayed on the Luggage Tag view. If not set, Launcher will skip this and display other information if available.
line1	string Indicates the first line of an address for people to contact on the Luggage Tag view when attempting to help return a device to where it should be.
line2	string Indicates the second line of an address for people to contact on the Luggage Tag view when attempting to help return a device to where it should be.
email	string Indicates a preferred email address for people to contact on the Luggage Tag view when attempting to help return a device to where it should be.
phoneNumber	string Indicates a preferred phone number for people to contact on the Luggage Tag view when attempting to help return a device to where it should be.
unlockPassword	string The password required to unlock the device out of Luggage Tag Mode. If not available, Launcher will default to validating against the admin password. Password must be a SHA-256 hashed string.
alarmLoopInMinutes	integer Indicates the number of elapsed minutes needed while Luggage Tag Mode is activated to play the alarm and continues to replay every time the same minutes has elapsed again until Luggage Tag Mode is deactivated.

Example:

  "luggageTag": {
    "enable": true,
    "thresholdInMinutes": 30,
    "logo": "https://www.image.com/url/to/logo.png",
    "line1": "123 Blue Fletch Street",
    "line2": "Atlanta, GA 45678",
    "email": "help@bluefletch.com",
    "phoneNumber": "(855) 529-6349",
    "unlockPassword": "936A185CAAA266BB9CBE981E9E05CB78CD732B0B3280EB944412BB6F8F8F07AF",
    "alarmLoopInMinutes": 10
  },

  "approvedNetworks": [
    ...
    "office-wifi-1",
    "office-wifi-2",
    ...
  ]

Feature Introduced

Feature Introduced in Launcher 3.8.x.