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

Find me

Purpose

Helps a user or support staff locate a misplaced device by playing an audible alert, either on remote request or automatically at low battery.

Location

features/findme/ (FindMeHandler, NotificationSoundManager, PlayNotificationSound), workers/FindMeWorker.kt, ui/findme/, ui/findme/FindMeActivity.

Responsibilities

  • Play an alert sound (internal bundled media or an external/configured media file) at a configurable volume.

  • Trigger on: an MQTT-forwarded remote "find me" command from the BlueFletch Launcher/backend, or automatically when battery drops below findMeBatteryLevelWarning.

  • Support "stop on motion" — silence the alert once the device is picked up/moved (MovementDetector, findMeStopAlertOnMotion).

  • Fire the findmealert event whenever the alert UI is actually shown to the user (payload includes Do Not Disturb status).

Configuration

Configuration
Type
Default
Description

findMeAutoEnabled

Boolean

true

Enables automatic low-battery Find Me alerts (remote-triggered Find Me still works if false)

findMePlayMedia

Boolean

true

Play media (true) vs. a system notification sound (false)

findMePlayInternalMedia

Boolean

true

Use bundled internal media vs. findMeExternalMedia

findMeTimeToPlay

Integer

10

Duration for a "long" play (remote-triggered)

findMeTimeToPlayShort

Integer

1

Duration for a "short" play (low-battery-triggered)

findMeExternalMedia

String

-

Path to external alert media

findMeBatteryLevelWarning

Integer

10

Battery percentage that triggers the low-battery alert; 0 defers to the OS low-battery signal instead

findMeIgnoreScreenState

Boolean

true

If true, play the alert sound regardless of whether the screen is on

findMeMovementThresholdSeconds

Integer

0 (disabled)

Seconds of non-movement to wait before playing

findMeStopAlertOnMotion

Boolean

false

Stop the alert if 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

Events

findmealert — sent whenever the Find Me UI is displayed to the user, including DND status. See Event Catalog. <link to event catalog>

Last updated