For the complete documentation index, see llms.txt. This page is also available as Markdown.

Find Me (L4 page structure)

Overview

Find Me helps a user or support staff member locate a misplaced device by playing an audible alert. The alert can be triggered remotely (via an MQTT-forwarded "find me" command from the BlueFletch Launcher/backend) or automatically when the battery drops below a configured level.

The alert can play an internal bundled sound or an external/configured media file, at a configurable volume. It supports "stop on motion" - the alert is silenced once the device is picked up or moved.

By default, automatic low-battery Find Me alerts are enabled; remote-triggered Find Me works regardless of this setting.

User Guide

To configure Find Me, complete the following steps:

  1. Enable automatic low-battery alerts and set the trigger battery percentage.

  2. Configure the alert sound, play duration, and volume.

  3. Set the battery percentage that triggers the low-battery alert.

  4. Configure alert playback behavior such as stop-on-motion and ignore-screen-state.

Feature Configuration

Enabling Automatic Low-Battery Alerts

To enable automatic low-battery Find Me alerts, set findMeAutoEnabled to true:

"settings": {
 
 "findMeAutoEnabled": true
}

Configuring the Alert Sound

To play a bundled internal media file, set findMePlayMedia and findMePlayInternalMedia to true:

To play an external/configured media file, set findMePlayInternalMedia to false and specify the path:

To use a system notification sound instead of media, set findMePlayMedia to false.

Configuring Alert Duration

Set how long the alert plays. Use findMeTimeToPlay for the longer duration used by remote-triggered alerts (e.g., 10 seconds), and findMeTimeToPlayShort for the shorter duration used by low-battery alerts (e.g., 1 second):

Configuring Alert Volume

Set the alert volume as a percentage of max (50–100). Use findMeAlarmVolume for remote-triggered alerts and findMeLowBatteryAlarmVolume for low-battery alerts:

Configuring Low-Battery Trigger

Set findMeBatteryLevelWarning to the battery percentage that triggers the alert. Set to 0 to defer to the OS low-battery signal instead:

Configuring Motion-Based Alert Behavior

Configure how motion affects alert playback, delay the alert until the device is still, or stop it once the device moves:

Configuring Ignore Screen State

To play the alert sound regardless of whether the screen is on, set findMeIgnoreScreenState to true:

This table provides the settings for the Find Me feature.

Configuration
Type
Default
Description

findMeAutoEnabled

Boolean

true

Enables automatic low-battery Find Me alerts. Remote-triggered Find Me still works when set to false.

findMePlayMedia

Boolean

true

Determines whether to play a media file (true) or a system notification sound (false).

findMePlayInternalMedia

Boolean

true

Uses the bundled internal media when true; uses the file path specified in findMeExternalMedia when false.

findMeTimeToPlay

Integer

10

Duration, in seconds, of the alert for remote-triggered plays.

findMeTimeToPlayShort

Integer

1

Duration, in seconds, for low-battery-triggered plays.

findMeExternalMedia

String

-

Path to an external alert media.

findMeBatteryLevelWarning

Integer

10

Battery percentage that triggers the low-battery alert; Set to 0 to defer to the OS low-battery signal.

findMeIgnoreScreenState

Boolean

true

When set to true, it plays the alert sound regardless of whether the screen is on.

findMeMovementThresholdSeconds

Integer

0 (disabled)

Number of seconds of non-movement before the alert plays.

findMeStopAlertOnMotion

Boolean

false

When set to true, stops the alert when the device starts moving.

findMeAlarmVolume

String (50-100)

100

Remote-triggered alert volume, as a percentage of max.

findMeLowBatteryAlarmVolume

String (50-100)

100

Low-battery alert volume, as a percentage of max.

Events

Event
Description

findmealert

Sent whenever the Find Me UI is displayed to the user, including DND status. See Event Catalog.

Putting It All Together

For the example described above, the full configuration for the Find Me feature is as follows:

Last updated