Quick Start Guide: Difference between revisions

From AsteroidOS
(→‎Syncing with Your Phone: Extend to reflect importance)
m (→‎Syncing with your phone: correcting github availability)
 
(8 intermediate revisions by 3 users not shown)
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.
=== Homescreen Swipe Gestures ===
* '''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.


=== In-App Swipe Gestures ===
== Navigating the UI ==
When using an app, you can swipe from the '''left edge''' of the screen toward the right to go '''back''' — either to the previous page in the app, or to the launcher if you're already on the app's main screen.


This behavior is consistent across all apps and is a quick way to navigate without needing buttons. Think of it like the "back" gesture on Android phones.
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.


Swipe from the top will close any app and return to the Homescreen.
See the [[Interface Overview]] page for a full description of all gestures including the peek gesture.


Gestures are real gestures—you don’t need to complete them fully and can pause them. For example, swipe down from the top to close an app but stop halfway to peek at the Watchface Homescreen without leaving the app. Then reverse the swipe to go back to the app. This is super useful when choosing a watchface or wallpaper in Settings, letting you preview how they look on the Watchface Homescreen.
== Syncing with your phone ==


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


AsteroidOS can sync with your phone or PC using various community-built apps.
* '''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.
* '''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 [[https://open-store.io/app/uk.co.piggz.amazfish Amazfish]].
* '''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 Android, the official [https://f-droid.org/packages/org.asteroidos.sync AsteroidOSSync] app provides the best overall experience. [https://f-droid.org/packages/nodomain.freeyourgadget.gadgetbridge Gadgetbridge] is also compatible and is known for a very stable connection, though missing a few features.
Full details are on the [[Synchronization Clients]] page.


* iOS users can receive notifications by pairing the watch with an iPhone, but syncing time or weather is not supported.
== Connecting to your watch ==


* Ubuntu Touch and SailfishOS offer partial support via [https://open-store.io/app/uk.co.piggz.amazfish Amazfish on open-store] and [https://sailfishos-chum.github.io/apps/harbour-amazfish/ Amazfish on chum].
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.


* Desktop users can explore [https://github.com/AsteroidOS/buran Buran], [https://github.com/AsteroidOS/AsteroidOSLinux AsteroidOSLinux], or CLI tools like [https://github.com/AsteroidOS/asteroid-ctrl asteroid-ctrl]. Amazfish is also available for linux desktop via [https://flathub.org/apps/uk.co.piggz.amazfish flathub].
With a connection established you can update AsteroidOS with:


Full details and links are listed here: [[Synchronization Clients]]
<code>opkg update && opkg upgrade</code>


==Accessing Settings==
And install apps with:
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.
<code>opkg install name-of-the-app</code>


===Battery Life ===
== What's next ==
With a healthy battery, all supported watches typically achieve '''at least 48 hours''' of battery life running AsteroidOS.


Some models with secondary displays can reach '''3 to 5 days'''. However, if you enable features like '''Tilt-to-Wake''', expect runtime to drop — in most cases down to '''30 hours''' or more, depending on usage.
* [[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


As always, battery life varies by device, usage habits, and power-saving settings. But these two settings are most power hungry:
=== Hack, tinker, contribute ===


===Tilt-to-Wake===
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]].
*'''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)===
=== Join the community ===
*'''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.


==Connect Your Watch to the Internet==
Join us on Matrix at [[https://matrix.to/#/#Asteroid:matrix.org #Asteroid:matrix.org]] — questions, progress sharing, and smartwatch hacking chat all welcome.
To unlock more features like updates and app installation, connect your computer to your watch via SSH or ADB by enabling either of them in the settings app -> USB.
Use a computer or phone with ADB (Android Debug Bridge from the Google Platform Tools):<syntaxhighlight lang="shell">
adb shell
</syntaxhighlight>or an SSH client to connect to your watch via USB.
For SSH, follow the [[SSH|SSH guide]].
 
When connected to the watch, establish an IP Connection by following the [[IP_Connection|IP Connection guide]].
 
With an IP connection established, you can:
 
===Update AsteroidOS===
*Keep your watch up-to-date with the latest features and fixes using: <syntaxhighlight lang="shell">opkg update && opkg upgrade</syntaxhighlight>
*See the [[Updating AsteroidOS|Updating AsteroidOS guide]] for instructions.
 
===Install Apps===
*Add community-provided apps via the command line.
*Check the [[Applications|Applications guide]] for details.
*Install apps using: <syntaxhighlight lang="shell">opkg install name-of-the-app</syntaxhighlight>
 
=== Customize Watchfaces ===
*Install community watchfaces to match your style.
*Follow the [[Watchface_and_Package_Installation|Watchface Installation guide]].
 
==What's next ==
*Experiment with Settings to find what works best for you.
* <big>'''Visit the [[Frequently_Asked_Questions_(FAQ)|FAQ pages]]'''</big> if you’re curious about pre-install details or troubleshooting.
 
===Hack, Tinker, Contribute===
AsteroidOS is built by enthusiasts for enthusiasts — and you're encouraged to make it your own!
 
Whether you want to customize watchfaces, write your own apps in QML/Qt, explore via SSH, or even contribute code, everything is open and waiting for your ideas.
 
You can explore the source code, report issues, or get involved at: [https://github.com/AsteroidOS github.com/AsteroidOS]
 
===Join the Community Chat===
Got questions, want to share progress, or just hang out with fellow AsteroidOS users and developers?
 
Join us on Matrix at [https://matrix.to/#/#Asteroid:matrix.org #Asteroid:matrix.org] — we’re a friendly bunch and always happy to help or chat about smartwatch hacking!
 
 
Enjoy your AsteroidOS smartwatch!

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:

  1. Set your language, time, date, and timezone — adjust these as prompted.
  2. 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

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.

Retrieved from "https://wiki.asteroidos.org/index.php?title=Quick_Start_Guide&oldid=871"