SPB Git

Repository Public License

README.md 7.1 KB 125 lines markdown

1<!--2ORIX Alarm3File: README.md4Author: Simon-Pierre Boucher5Contact: contact@spboucher.ai6-->7<div align="center">89<img src="docs/brand/logo.svg" alt="ORIX Alarm logo" width="620">1011<br><br>1213<img src="docs/brand/icon.png" alt="ORIX Alarm icon" width="112" height="112">1415# ORIX Alarm1617**Wake smarter. Rise better.**1819Real system alarms, progressive wake, ten wake missions, Alarm Studio and honest statistics —<br>20a native iPhone alarm with no account, no ads, no tracking and no network code.2122**Author: [Simon-Pierre Boucher](https://www.spboucher.ai)**2324![iOS](https://img.shields.io/badge/iOS-26.1%2B-007AFF?style=for-the-badge&logo=apple&logoColor=white)25![iPhone](https://img.shields.io/badge/iPhone-portrait-007AFF?style=for-the-badge&logo=apple&logoColor=white)26![Version](https://img.shields.io/badge/version-1.0.0%20(2)-6366F1?style=for-the-badge)27![Status](https://img.shields.io/badge/status-TestFlight%20internal%20%C2%B7%20never%20run%20on%20a%20device-D97706?style=for-the-badge)28![author](https://img.shields.io/badge/author-Simon--Pierre%20Boucher-0A66C2?style=for-the-badge)2930![Swift](https://img.shields.io/badge/Swift-6-FA7343?style=flat-square&logo=swift&logoColor=white)31![SwiftUI](https://img.shields.io/badge/UI-SwiftUI-007AFF?style=flat-square)32![AlarmKit](https://img.shields.io/badge/Alarms-AlarmKit-007AFF?style=flat-square)33![WidgetKit](https://img.shields.io/badge/Widgets-WidgetKit%20%2B%20Live%20Activity-007AFF?style=flat-square)34![App Intents](https://img.shields.io/badge/Shortcuts-App%20Intents-007AFF?style=flat-square)35![Dependencies](https://img.shields.io/badge/third--party%20code-none-10B981?style=flat-square)3637![Missions](https://img.shields.io/badge/wake%20missions-10-8B5CF6?style=flat-square)38![Tests](https://img.shields.io/badge/automated%20tests-144-10B981?style=flat-square)39![Privacy](https://img.shields.io/badge/data%20collected-none-10B981?style=flat-square)40![Offline](https://img.shields.io/badge/network%20code-none-10B981?style=flat-square)4142</div>4344---4546<p align="center">47<img src="docs/screenshots/01-today.png" width="19%" alt="Today dashboard">48<img src="docs/screenshots/03-editor.png" width="19%" alt="Alarm editor with circular time selector">49<img src="docs/screenshots/04-studio.png" width="19%" alt="Alarm Studio">50<img src="docs/screenshots/12-mission-pattern.png" width="19%" alt="Pattern Lock mission">51<img src="docs/screenshots/07-nightstand.png" width="19%" alt="Nightstand mode">52</p>5354All screenshots in this repository are captured from the running app (`Scripts/screenshots.sh`, demo data).5556## What it is5758ORIX Alarm is an alarm clock built on **AlarmKit**: the alarm belongs to iOS, so it rings when the app is closed, the iPhone is locked, a Focus is on or the ring switch is silent. Around that reliable core:5960- **Alarms** — one-time and weekly, each with its own sound, snooze policy and scenario; every alarm shows a *verified* status read back from the system, never an assumption.61- **Wake missions** — ten of them, chained into a "Morning Combo": Math Blitz, Memory Matrix, QR Escape, Step Challenge, Pattern Lock, Word Scramble (English and French), Logic Gates, Maze Escape, Color Sequence, and the combo itself. Fixed or adaptive difficulty.62- **Progressive wake** — Nightstand mode: a sunrise simulation and a soundscape that rise along a curve you choose (linear, exponential, smoothstep, multi-stage or drawn by hand).63- **Smart snooze** — fixed or decreasing durations, a maximum count, optional difficulty escalation.64- **Alarm Studio** — eight templates, a visual timeline of the whole morning, saved scenarios you can duplicate, reorder and apply.65- **Sleep planner** — bedtime, time in bed, wind-down reminders, evening routine checklist, weekly consistency.66- **Insights** — charts over 7 days, 30 days or a custom range, from recorded events only.67- **Widgets, Live Activity, Shortcuts** — five widgets, the snooze / focus-timer countdown on the Lock Screen and Dynamic Island, seven Siri shortcuts.68- **Design** — five animated clock faces, a midnight-to-sunrise identity, synthesised original sounds, Core Haptics.6970## What it does not pretend7172- iOS always lets you stop or silence a system alarm. A mission is a commitment you set for yourself, not a lock; an emergency exit is always there and is recorded.73- The sunrise and the soundscape need the app open in Nightstand mode. iOS does not let an app start sound or light the screen on its own before the alarm. The alarm itself rings regardless.74- Stopping an alarm is not waking up. Only your "I'm up" confirmation counts as a wake-up in statistics.75- The app does not measure sleep and does not estimate sleep stages.76- Step counting is approximate.7778Details: [docs/ALARMKIT.md](docs/ALARMKIT.md).7980## State of verification8182| | |83|---|---|84| Logic (recurrence, DST, policies, puzzles, storage, statistics) | 100 unit tests, `swift test` |85| Alarm lifecycle against a fake system (create, modify, cancel, reconcile, relaunch, denial, snooze chain, missions, corrupted data) | 27 integration tests |86| Interface (onboarding, alarm creation, denial, tabs, full simulated wake, emergency exit, missions played to the end) | 17 UI tests on the iOS 26.5 simulator |87| Real AlarmKit on the simulator (2 opt-in probe tests) | permission prompt, scheduling, ringing with the app in the background, stop observed and recorded, mission presented |88| Real iPhone | **nothing yet** — lock screen, silent switch, Focus, restart, audio routes, camera, pedometer, haptics are unverified |89| Snooze button and stop-intent delivery from the system alert | **not confirmed**: the simulator's alert could not be driven reliably. See [docs/TESTING.md](docs/TESTING.md) |9091## Build9293Requirements: Xcode 27 (iOS 26.1+ SDK), [XcodeGen](https://github.com/yonaskolb/XcodeGen).9495```bash96Scripts/build.sh build        # generate the project and build for the simulator97(cd Packages/AlarmCore && swift test)98Scripts/build.sh test         # integration tests99Scripts/build.sh uitest       # interface tests100Scripts/probe-alarmkit.sh testObservedStopRetiresOneTimeAlarm   # real AlarmKit on the simulator101Scripts/screenshots.sh        # real screenshots into docs/screenshots102Scripts/release.sh archive | export | validate | upload103```104105## Documentation106107| | |108|---|---|109| [ARCHITECTURE](docs/ARCHITECTURE.md) | modules, data flow, concurrency |110| [ALARMKIT](docs/ALARMKIT.md) | scheduling, reconciliation, intents, limits |111| [MISSIONS](docs/MISSIONS.md) | the ten missions, difficulty, fallbacks |112| [DESIGN_SYSTEM](docs/DESIGN_SYSTEM.md) | palette, typography, components, sound, haptics |113| [TESTING](docs/TESTING.md) | what is tested, how, and what is not |114| [PRIVACY](docs/PRIVACY.md) | data, permissions |115| [TESTFLIGHT](docs/TESTFLIGHT.md) | Apple identity, release procedure, current build |116| [CHANGELOG](CHANGELOG.md) | versions |117118## Privacy119120No account, no server, no analytics, no advertising SDK, no network code. Camera frames and motion data are processed on the device and never stored. See [docs/PRIVACY.md](docs/PRIVACY.md).121122## License123124Copyright © 2026 Simon-Pierre Boucher. All rights reserved. The source is published for reading; see [LICENSE](LICENSE).125
Files main
Menu

Theme