Quick Start Guide: Difference between revisions

Latest revision as of 08:29, 20 April 2026

Welcome to AsteroidOS! This guide will help you get set up after a successful installation. For a full reference of the UI and system features, see the links in the What's next section below.

Initial setup

After booting your watch for the first time you will be guided through a quick setup:

Set your language, time, date, and timezone — adjust these as prompted.
Intro slideshow — a non-interactive slideshow introduces the swipe gestures and UI. Once it finishes you will land on the watchface homescreen. You can skip it at any point with a long press on the on-screen next button.

Navigating the UI

AsteroidOS is controlled entirely by swipe gestures. Swipe down from the watchface to open the Quick Settings panel, swipe up to open the App Launcher, swipe left for notifications, and swipe right for the Agenda and Weather panels. Inside any app, swipe from the left edge to go back and swipe from the top to close the app and return to the watchface.

See the Interface Overview page for a full description of all gestures including the peek gesture.

Syncing with your phone

AsteroidOS can sync with your phone using community-built apps.

Android — [Gadgetbridge] provides the best overall experience. [AsteroidOSSync] is also available but known for an unstable stable connection on newer Android versions.
iOS — Notifications can be received by pairing with an iPhone. Time and weather sync are not currently supported.
Ubuntu Touch and SailfishOS — Good support via [Amazfish].
Linux desktop — Amazfish is also available via [Flathub]. [Buran], [AsteroidOSLinux], and [asteroid-ctrl] are available Github.

Full details are on the Synchronization Clients page.

Connecting to your watch

To install apps, update the system, or run commands, connect your computer to the watch via USB. Enable ADB or SSH in Settings > USB, then follow the SSH and IP Connection guides to establish a connection.

With a connection established you can update AsteroidOS with:

opkg update && opkg upgrade

And install apps with:

opkg install name-of-the-app

What's next

Interface Overview — full gesture reference and navigation model
Quick Settings Panel — what each toggle in the Quick Settings panel does
Settings Reference — a description of every settings page and option
Applications — stock and community apps available for AsteroidOS
Synchronization Clients — phone and desktop sync options in detail
Frequently Asked Questions (FAQ) — common questions and known limitations

Hack, tinker, contribute

AsteroidOS is built by enthusiasts for enthusiasts. Whether you want to write your own apps in QML/Qt, create watchfaces, or contribute code, everything is open. Explore the source, report issues, or get involved at [github.com/AsteroidOS].

Join the community

Join us on Matrix at [#Asteroid:matrix.org] — questions, progress sharing, and smartwatch hacking chat all welcome.

@@ Line 1: / Line 1: @@
-Welcome to AsteroidOS! This guide will help you set up and personalize your smartwatch after a successful installation. Follow these steps to get started and make the most of your device.
+Welcome to AsteroidOS! This guide will help you get set up after a successful installation. For a full reference of the UI and system features, see the links in the ''What's next'' section below.
-== Initial Setup ==
+== Initial setup ==
-After booting your watch for the first time, you’ll be guided through a quick setup:
-# '''Set your Language, Time, Date, and Timezone''': Adjust these settings as prompted.
-# '''Intro Slideshow''': A non-interactive slideshow will introduce you to the UI and swipe gestures. Once it’s done, you’ll land on the Watchface Homescreen with the stock watchface. Hint: You can skip the tutorial slideshow via long press on the arrow/next button
-Now, let’s explore your watch!
+After booting your watch for the first time you will be guided through a quick setup:
-== Understanding the Interface ==
+# '''Set your language, time, date, and timezone''' — adjust these as prompted.
-AsteroidOS uses swipe gestures to navigate. Here’s what each swipe does from the Watchface Homescreen:
+# '''Intro slideshow''' — a non-interactive slideshow introduces the swipe gestures and UI. Once it finishes you will land on the watchface homescreen. You can skip it at any point with a long press on the on-screen next button.
-* '''Swipe from Top''': Opens the Quick Settings panel (work in progress, more shortcuts coming soon).
-* '''Swipe from Left''': Shows notifications synced from your paired phone.
-* '''Swipe from Right''': Displays events from the Agenda and Weather apps.
-* '''Swipe from Bottom''': Opens the configurable App Launcher.
-Gestures are real gestures—you don’t need to complete them fully. For example, swipe down from the top to close an app but stop halfway and reverse the swipe to peek at the Watchface Homescreen without leaving the app. This is super useful when choosing a watchface or wallpaper in Settings, letting you preview how they look on the Watchface Homescreen.
-== Accessing Settings ==
+== Navigating the UI ==
-To personalize your watch, head to the Settings page:
-* Open the App Launcher (swipe up from the Watchface Homescreen).
-* Tap the '''gear icon''' to enter Settings.
-* Alternatively, use the Quick Settings shortcut (coming soon).
-Settings include subpages like Display, Nightstand, Wallpaper, Watchface, and more. Let’s tweak some key options next.
+AsteroidOS is controlled entirely by swipe gestures. Swipe down from the watchface to open the Quick Settings panel, swipe up to open the App Launcher, swipe left for notifications, and swipe right for the Agenda and Weather panels. Inside any app, swipe from the left edge to go back and swipe from the top to close the app and return to the watchface.
-== Optimizing Battery Life ==
+See the [[Interface Overview]] page for a full description of all gestures including the peek gesture.
-Some features can drain your battery quickly. Adjust these early based on your needs:
-=== Tilt-to-Wake ===
+== Syncing with your phone ==
-* '''What it does''': Wakes the screen when you tilt your wrist.
-* '''Battery Impact''': High – it often triggers accidentally.
-* '''Recommendation''': Turn it off unless you really need it.
-* '''How to adjust''': Go to Settings > Display > Toggle “Tilt-to-Wake” off.
-=== Always-On Display (AoD) ===
+AsteroidOS can sync with your phone using community-built apps.
-* '''What it does''': Keeps the screen on with a low-power watchface.
-* '''Battery Impact''':
-* High on LCD screens – avoid using it.
-* Moderate on OLED screens – safe to use.
-* Disable on watches with a secondary display (e.g., hybrid watches) to use the secondary screen instead of the AoD watchface.
-* '''How to adjust''': Go to Settings > Display > Toggle “Always-On Display” on/off.
-== Connecting to Your Watch ==
+* '''Android''' — [[https://f-droid.org/packages/nodomain.freeyourgadget.gadgetbridge Gadgetbridge]] provides the best overall experience. [[https://f-droid.org/packages/org.asteroidos.sync AsteroidOSSync]] is also available but known for an unstable stable connection on newer Android versions.
-To unlock more features like updates and app installation, connect your computer to your watch via SSH or ADB:
+* '''iOS''' — Notifications can be received by pairing with an iPhone. Time and weather sync are not currently supported.
-* '''Enable IP Connection''':
+* '''Ubuntu Touch and SailfishOS''' — Good support via [[https://open-store.io/app/uk.co.piggz.amazfish Amazfish]].
-* Use a computer or phone with `adb shell` or an SSH client.
+* '''Linux desktop''' — Amazfish is also available via [[https://flathub.org/apps/uk.co.piggz.amazfish Flathub]]. [[https://github.com/dodoradio/Buran Buran]], [[https://github.com/atx/AsteroidOSLinux AsteroidOSLinux]], and [[https://github.com/AsteroidOS/asteroid-ctrl asteroid-ctrl]] are available Github.
-* For SSH, follow the [[SSH|SSH guide]]
-* Establish an IP Connection by following the [[IP_Connection|IP Connection guide]].
-Once connected, your watch is ready for advanced setup.
-== Next Steps ==
+Full details are on the [[Synchronization Clients]] page.
-With an IP connection established, you can:
-=== Update AsteroidOS ===
+== Connecting to your watch ==
-* Keep your watch up-to-date with the latest features and fixes using `opkg update && opkg upgrade`.
-* See the [[Updating AsteroidOS|Updating AsteroidOS guide]] for instructions.
-=== Install Apps ===
+To install apps, update the system, or run commands, connect your computer to the watch via USB. Enable ADB or SSH in Settings > USB, then follow the [[SSH]] and [[IP Connection]] guides to establish a connection.
-* Add community-provided apps via the command line.
-* Check the [[Applications|Applications guide]] for details.
-=== Customize Watchfaces ===
+With a connection established you can update AsteroidOS with:
-* Install community watchfaces to match your style.
-* Follow the [[Watchface_and_Package_Installation|Watchface Installation guide]].
-== Tips for New Users ==
+<code>opkg update && opkg upgrade</code>
-* Experiment with Settings to find what works best for you.
-* Pair your watch with a phone for notifications (setup via the AsteroidOS app).
-* Visit the [[Frequently_Asked_Questions_(FAQ)|FAQ pages]] if you’re curious about pre-install details or troubleshooting.
+And install apps with:
-Enjoy your AsteroidOS smartwatch!
+<code>opkg install name-of-the-app</code>
+== What's next ==
+* [[Interface Overview]] — full gesture reference and navigation model
+* [[Quick Settings Panel]] — what each toggle in the Quick Settings panel does
+* [[Settings Pages|Settings Reference]] — a description of every settings page and option
+* [[Applications]] — stock and community apps available for AsteroidOS
+* [[Synchronization Clients]] — phone and desktop sync options in detail
+* [[Frequently Asked Questions (FAQ)]] — common questions and known limitations
+=== Hack, tinker, contribute ===
+AsteroidOS is built by enthusiasts for enthusiasts. Whether you want to write your own apps in QML/Qt, create watchfaces, or contribute code, everything is open. Explore the source, report issues, or get involved at [[https://github.com/AsteroidOS github.com/AsteroidOS]].
+=== Join the community ===
+Join us on Matrix at [[https://matrix.to/#/#Asteroid:matrix.org #Asteroid:matrix.org]] — questions, progress sharing, and smartwatch hacking chat all welcome.