Repository navigation
Guide Setup Tour
A new MowDeck account starts with a short, guided setup. It shows what is still missing for a MowDeck that is ready to mow and leads you into the right place for each step. Every step notices by itself when it is done; nothing needs to be ticked off by hand.
- On the mower list. A new account without a mower sees the Einrichtung card at the top: the progress, the next step and its button. Tour öffnen shows all steps, Später hides the card.
- Under Einstellungen → Einrichtung. The status of the tour and a button to open or continue it. Opening it there brings back a hidden tour with everything you did so far.
- Accounts that were set up before the tour existed see one line on the mower list instead ("Einrichtungshilfe: …"). Prüfen opens the tour, the cross hides the line for good.
The progress is stored with your user, not in the browser: what you skipped in the browser stays skipped in the iPhone app.
| Step | Done when | Leads to |
|---|---|---|
| Mammotion-Konto verbinden | a Mammotion account is linked (or you already have a mower of another kind) | Einstellungen → Verbundene Konten |
| Mäher hinzufügen | you have a mower | Mäher → Mäher hinzufügen |
| Karte prüfen | MowDeck has read the map of your mower (a few minutes after it connects) | the mower's page |
| Benachrichtigungen einrichten | push in this or another browser, the iPhone app or ntfy is set up | Einstellungen → Benachrichtigungen |
| Passkey anlegen (optional) | you have a passkey | Einstellungen → Konto |
| Ersten Mähplan anlegen | a schedule exists | Zeitpläne → Neuer Zeitplan |
| Anmeldung verknüpfen (optional) | GitHub or Apple is linked for sign-in | Einstellungen → Konto |
| Widgets und Apple Watch (optional, iPhone app only) | the widgets are on on this iPhone | Einstellungen → Benachrichtigungen (this app) |
Steps that do not apply are left out: without the right to manage mowers you do not see the first two, the passkey and sign-in steps appear only when the server offers them, and the widget step only inside the iPhone app.
Überspringen puts a step aside; it no longer holds up the tour, and Wieder aufnehmen brings it back at any time. The tour is complete when every step is done or skipped; optional steps may stay open. Fertig closes it; Einstellungen → Einrichtung keeps it reachable.
On an iPhone in Safari, the notification step points to the existing install hint: push notifications arrive only in the installed app.
While you are new, the mower page and the schedules show a short Zum ersten Mal hier note at the top. Verstanden hides it on every device. Accounts that were set up before the tour existed never see these notes.
The tour needs no configuration. Identity stores each user's choices in the table onboarding_progress (GET/PUT /api/v1/identity/me/onboarding); the decision record is ADR 0062.
Mirrored from docs/guides/setup-tour.md at commit 39f6a7b11a834ca2c25cb9bc29734489243fce8d. Edit the file in the repository, not this wiki page.
Mirrored from the docs/ directory at commit 39f6a7b11a834ca2c25cb9bc29734489243fce8d. Edit the files in the repository, not this wiki.
MowDeck documentation
- Home
- Phases
- Architecture
-
Decisions (ADR)
- Architecture decisions
- ADR 0001: OpenFGA instead of self-built authorization
- ADR 0002: Self-built Identity service in FastAPI instead of Keycloak or Zitadel
- ADR 0003: SvelteKit for the web app
- ADR 0004: Monorepo with a uv workspace
- ADR 0005: AGPL-3.0 for services and apps, Apache-2.0 for libraries
- ADR 0006: PostgreSQL for all persistence, no SQLite
- ADR 0007: NATS JetStream as event bus
- ADR 0008: Traefik as gateway
- ADR 0009: Command and event envelopes, subject naming and de-duplication
- ADR 0010: Python 3.13 for all services and libraries
- ADR 0011: Separate GPL-3.0 package for the PyMammotion adapter
- ADR 0012: Mower control interface and safety rules
- ADR 0013: Device-Gateway registry, sharding and per-mower concurrency
- ADR 0014: Authorization model, tuple ownership and the mowdeck-authz client
- ADR 0015: Tokens, sessions and key rotation
- ADR 0016: Fleet commands and authorization per command kind
- ADR 0017: Telemetry storage and retention
- ADR 0018: Realtime WebSocket protocol
- ADR 0019: Mammotion adapter transports, manual drive and secrets
- ADR 0020: Web app architecture
- ADR 0021: Browser authentication flow
- ADR 0022: Notifications: rules, recipients and delivery
- ADR 0023: Map rendering and projection
- ADR 0024: Scheduler: recurrence, rain pause and command issuing
- ADR 0025: Home Assistant integration as a pure API client
- ADR 0026: Manual drive channel over the Realtime WebSocket
- ADR 0027: Health history and theft alarm
- ADR 0028: Entitlements: plans as data and enforcement
- ADR 0029: Helm chart and release pipeline
- ADR 0030: Mowing patterns as plug-ins and the Planner
- ADR 0031: Billing with a Stripe adapter
- ADR 0032: Live camera over Agora, joined directly by the browser
- ADR 0033: Vision-assisted recovery with human approval
- ADR 0034: Linked cloud accounts and device discovery
- ADR 0035: Server-side camera frames and automatic AI analysis on errors
- ADR 0036: Native app shells with Capacitor, loading the web app from the server
- ADR 0037: Camera panorama calibration in the browser, with the AI supplying points only
- ADR 0038: Dual link per mower and firmware updates
- ADR 0039: Spot mowing by MowDeck-driven paths
- ADR 0040: Link heartbeat for online status
- ADR 0041: Spot runs from the dock: undock, transit and return
- ADR 0042: Drive calibration
- ADR 0043: Turn styles
- ADR 0044: Drive view with camera
- ADR 0045: Camera relay
- ADR 0046: Device settings as capabilities
- ADR 0047: The RTK base station as a Fleet device
- ADR 0048: Maintenance commands
- ADR 0049: Manual driving over the Mammotion cloud
- ADR 0050: Passkeys and the app login hand-off
- ADR 0051: Sign in with GitHub
- ADR 0052: Sign in with Apple
- ADR 0053: Retention and downsampling of the position track
- ADR 0054: Aerial photo under the mower map
- ADR 0055: Deploy maintenance window
- ADR 0056: Camera photo in push notifications for errors and theft alarms
- ADR 0057: Step-up re-authentication for critical actions
- ADR 0058: Theft tracking mode
- ADR 0059: iOS widgets and the mowing Live Activity
- ADR 0060: Apple Watch app
- ADR 0061: Mowing angle rotation
- ADR 0062: Setup tour for new users
- ADR 0063: Matter server (mowers in Apple Home and Google Home)
- ADR 0064: Personal access tokens and the public API documentation
- ADR 0065: Security center and new-login alerts
- ADR 0066: Cloud provider plugins and adapters for more vendors
- ADR 0067: Error code lexicon, provider independent
- ADR 0068: Public demo mode
-
Development
- Getting started
- Service template
- Shared libraries
- Cloud providers: adding a vendor
- Adding an error lexicon for a vendor
- Design: identity and authorization
- Design: fleet, telemetry, realtime
- Design: web app
- Web app
- Home Assistant integration
- Camera source bridge protocol
- Fuzzing and property-based tests
- GitHub wiki mirror
-
Operations
- Operating the Compose stack
- Operating MowDeck on Kubernetes (Helm)
- Building the Bluetooth bridge (ESPHome on a XIAO ESP32-S3)
- Releases
- Billing operations
- Telemetry: retention and position downsampling
- iPhone and Android apps
- Passkeys
- Sign in with GitHub
- Aerial photo under the map
- Sign in with Apple
- Theft tracking mode
- Matter server
- Source code offer (AGPL-3.0 section 13)
- Public demo
- Spikes
-
Guides
- Guides
- ESP32 bridge: purchase and setup
- Signing in with a passkey
- Signing in with GitHub
- Error codes in plain words
- Aerial photo under the map
- Signing in with Apple
- Confirming critical actions
- Your security page
- iPhone widgets and the mowing Live Activity
- Apple Watch
- The setup tour
- Apple Home and Google Home (Matter)
- Scripting MowDeck
- API reference
- Original plan (German)