> LocalAssistant has a native app for Android and iPhone, built with Kotlin Multiplatform. It shows the house, drives devices, watches cameras, makes and sets scenes, runs routines…
> Source: https://orochibraru.com/localassistant/canary/docs/mobile-app · Site index: https://orochibraru.com/llms.txt

# Mobile app

LocalAssistant has a native app for Android and iPhone, built with Kotlin
Multiplatform. It shows the house, drives devices, watches cameras, makes and
sets scenes, runs routines, talks to the assistant and reports the phone's
battery and, if you share it, whether you're home. The web app still installs on
phones too.

## Sign in

Either way ends in an ordinary session, listed under **Account, Security** with
the browser ones, where you can sign it out.

- **With the server's address**: type it in the app and tap **Sign in**. A
  browser sheet opens the server, where you sign in as usual (passkeys and
  authenticator apps included) and tap **Sign in** on the question the server
  asks. The sheet closes and the app is signed in.
- **With a pairing code**: in a signed-in browser, open **Account, Mobile app**
  and tap **Show a pairing code**. Scan it with the app, or with the phone's
  camera. The code works once, for two minutes, and needs a recent sign-in.

On plain HTTP the address must start with `http://`; without a scheme the app
assumes HTTPS.

## Devices

Tap a card on Home for the device full screen: everything it reads and every
control it has, like a printer's pause, light and speed, a vacuum's mode,
suction, water and parts, or a speaker's playback, volume and source. The power
button on a card still toggles it from Home.

Admins get a gear on that screen for the device's settings (name, room, owner,
its integration's fields, removing it) and a **+** on Home to add devices: pick
an integration, connect it or look for its devices, or fill in its form. The
MQTT broker is connected once on the web.

## Cameras

A camera's card on Home shows its latest picture, read again every ten seconds.
Tap it for the live view and the recordings its plugin keeps: tap one to play
it, **Back to live** to return.

## Scenes and routines

**Automations** lists the scenes and routines. **Set** brings a scene back, and
tapping it opens it to change: rename it, add a device (it starts the way it is
now), change what each one does, **How they are now** to take every device's
current state, or delete it. **New scene** makes one. Routines run with the play
button and turn off with their switch; they're made on the web.

## Notifications

The bell on Home opens the same inbox as the web app's **Notifications**, with a
badge while some are unread: tap a scene button to set it, remove one, or clear
them all. Opening it marks them read everywhere.

**Settings**, **Notifications on this phone** shows them as the phone's own
notifications while the app is closed:

- On Android with a UnifiedPush app such as ntfy installed, they arrive at once:
  the server pushes them to it like to a browser, end-to-end encrypted, with no
  Google account or key involved. Pick ntfy when the app asks.
- Without one, and on iPhone, the phone checks the inbox in the background,
  every 15 minutes or so on Android and whenever iOS allows on an iPhone.

## This phone in the house

**Settings** in the app adds the phone to the house, owned by you. It then sends
its battery every five minutes while the app is open and, once you turn on
**Share the location** and allow it, its position, which marks you home or away
for routines and the people on Home.

## Updates

On Android, the APK from a GitHub release checks for a newer release when it
opens. **Settings, Updates** downloads it and hands it to Android's installer,
which asks you to allow LocalAssistant to install apps the first time. Builds
from a store or a debug build don't check.

## For developers

The app lives in `apps/mobile`: a `shared` Compose Multiplatform module, the
`androidApp` shell and the `iosApp` one (an `xcodegen` project). It talks to the
server's `/api/v1` with the session token as a bearer token.

```bash
cd apps/mobile
./gradlew :shared:testAndroidHostTest :androidApp:assembleDebug
```

For iOS, run `xcodegen` in `apps/mobile/iosApp` and open the project in Xcode.