Building AsteroidOS

2024-12-11T22:06:53Z

MagneFire:

Installing the SDK

2024-09-22T20:34:26Z

MagneFire: Correct SDK link

[[Category:Developers]]
The Software Development Kit (SDK) for AsteroidOS is a set of tools and libraries for developing software to run on AsteroidOS. Since AsteroidOS is a Linux distribution, you can use just about any programming language to develop software, but most of the core applications use a combination of C++ and Qt, with CMake to build. This page describes how to install and configure the SDK.

==== Which SDK? ====
One thing to note is that while this describes "the SDK", there are actually two versions -- the main one is used to develop software that runs on ARM-based watches running AsteroidOS. The other one is the SDK for developing applications that run on the emulator, which uses qemux86. See the [[Emulator]] page for details on the qemux86 version.

You can install both SDKs on the same machine -- they do not interfere.

= Build or Download =
You can either build the SDK from sources or download a prebuilt version. Using a prebuilt version is much faster and easier, and is recommended for developers who want to get started quickly.

The prebuilt SDK is available [https://release.asteroidos.org/nightlies/sdk/oecore-meta-toolchain-qt5-x86_64-armv7vehf-neon-sturgeon-toolchain-nodistro.0.sh here]. If you wish to build it yourself, see [[Building the SDK]].

== Installing the SDK ==
If you downloaded a prebuilt SDK, run the downloaded script. If you built your own, the generated installation script should be in <code>tmp-glibc/deploy/sdk/</code> (relative to the <code>build</code> directory). In either case, navigate to the directory which contains the <code>oecore-meta-toolchain-qt5-x86_64-armv7vehf-neon-sturgeon-toolchain-nodistro.0.sh</code> script and run it:

<pre>
./oecore-meta-toolchain-qt5-x86_64-armv7vehf-neon-sturgeon-toolchain-nodistro.0.sh
</pre>

This script will install the cross-compiler and ARM libraries in <code>/usr/local/oecore-x86_64</code> by default, along with a script that needs to be sourced before every build. If you want to compile software for AsteroidOS on a watch, the command-line steps generally look like this:

<pre>
source /usr/local/oecore-x86_64/environment-setup-armv7vehf-neon-oe-linux-gnueabi
cmake -B build
cmake --build build
</pre>

=== Installing the emulator version of the SDK ===
Installing the emulator version of the SDK is almost exactly the same. The only difference is that the file name for the installer is <code>oecore-meta-toolchain-qt5-x86_64-core2-32-qemux86-toolchain-nodistro.0.sh</code>.

As noted above, you can install either or both versions on the same computer with no problem. They are completely independent.

See [[Creating an Asteroid app]] for next steps.

Tetra hardware

2024-08-10T18:22:33Z

MagneFire:

The tetra hardware is based on the Broadcom BCM23550 (referred to as ''java'' in the device tree) chipset.
[[File:Front of tetra main board.jpg|alt=Front of tetra main board|thumb|Front of tetra main board]]
[[File:Front of tetra main board NFC antenna removed.jpg|alt=Front of tetra main board NFC antenna removed|thumb|Front of tetra main board NFC antenna removed]]
[[File:Back-of-tetra-main-board.jpg|alt=Back of tetra main board|thumb|Back of tetra main board]]
[[File:Back LCD of tetra.jpg|alt=Back LCD of tetra|thumb|Back LCD of tetra]]
[[File:Back cover of tetra.jpg|alt=Back cover of tetra|thumb|Back cover of tetra]]

=== Front PCB ===
The front of the PCB is covered by a flexible PCB antenna used for NFC. This is connected to the PCB via a U.FL connector.

Removing the NFC antenna reveals the Broadcom SoC and on its left a shield on top of the memory.

The shield with a QR code is covering the BCM43341 Bluetooth/WiFi chip.

The unmarked chip on the top left is most likely the bcmpmu (Broadcom Power Management Unit).

The vibrator motor is permanently soldered on the front PCB. The back has kapton tape to avoid short circuiting against the metal bottom case.

=== Back PCB ===
The back of the PCB has testpoints, pogo pins and space for an unpopulated connector.

=== Casing ===
The case is closed via four screws and a silicone like glue.

The front part consists of the LCD and a transparent part for the ambient light sensor.

The back part contains a epoxied micro USB connector and a (lightly) glued in 1.59Wh battery.

Tetra hardware

2024-08-10T18:21:03Z

MagneFire:

The tetra hardware is based on the Broadcom BCM23550 (referred to as ''java'' in the device tree) chipset.
[[File:Front of tetra main board.jpg|alt=Front of tetra main board|thumb|Front of tetra main board]]
[[File:Front of tetra main board NFC antenna removed.jpg|alt=Front of tetra main board NFC antenna removed|thumb|Front of tetra main board NFC antenna removed]]
[[File:Back-of-tetra-main-board.jpg|alt=Back of tetra main board|thumb|Back of tetra main board]]
[[File:Back LCD of tetra.jpg|alt=Back LCD of tetra|thumb|Back LCD of tetra]]
[[File:Back cover of tetra.jpg|alt=Back cover of tetra|thumb|Back cover of tetra]]

=== Front PCB ===
The front of the PCB is covered by a flexible PCB antenna used for NFC. This is connected to the PCB via a U.FL connector.

Removing the NFC antenna reveals the Broadcom SoC and on its left a shield on top of the memory.

The shield with a QR code is covering the BCM43341 Bluetooth/WiFi chip.

The unmarked chip on the top left is most likely the bcmpmu (Broadcom Power Management Unit).

=== Back PCB ===
The back of the PCB has testpoints, pogo pins and space for an unpopulated connector.

=== Casing ===
The case is closed via four screws and a silicone like glue.

The front part consists of the LCD and a transparent part for the ambient light sensor.

The back part contains a epoxied micro USB connector and a (lightly) glued in 1.59Wh battery.

Tetra hardware

2024-08-10T18:17:24Z

MagneFire:

The tetra hardware is based on the Broadcom BCM23550 (referred to as ''java'' in the device tree) chipset.
[[File:Front of tetra main board.jpg|alt=Front of tetra main board|thumb|Front of tetra main board]]
[[File:Front of tetra main board NFC antenna removed.jpg|alt=Front of tetra main board NFC antenna removed|thumb|Front of tetra main board NFC antenna removed]]
[[File:Back-of-tetra-main-board.jpg|alt=Back of tetra main board|thumb|Back of tetra main board]]
[[File:Back LCD of tetra.jpg|alt=Back LCD of tetra|thumb|Back LCD of tetra]]
[[File:Back cover of tetra.jpg|alt=Back cover of tetra|thumb|Back cover of tetra]]

=== Front ===
The front of the PCB is covered by a flexible PCB antenna used for NFC. This is connected to the PCB via a U.FL connector.

Removing the NFC antenna reveals the Broadcom SoC and on its left a shield on top of the memory.

The shield with a QR code is covering the BCM43341 Bluetooth/WiFi chip.

The unmarked chip on the top left is most likely the bcmpmu (Broadcom Power Management Unit).

=== Back ===
The back of the PCB has testpoints, pogo pins and space for an unpopulated connector.

Tetra hardware

2024-08-10T18:15:55Z

MagneFire:

2023-07-10T17:21:13Z

MagneFire:

{{Watches
|Name=hoki
|Model=Fossil Gen 6
|Picture=hoki.png
|Status=supported
|Stars=2
|Chipset=msm8937
|KernelVersion=4.14
|AndroidVersion=pie
|StatusDisplay=good
|StatusTouch=good
|StatusBluetooth=good
|StatusHaptics=good
|StatusTiltToWake=bad
|StatusLightSensor=bad
|StatusAlwaysOnDisplay=partial
|StatusDualDisplay=missing
|StatusMicrophone=bad
|StatusSpeaker=bad
|StatusCompass=bad
|StatusSteps=bad
|StatusHeartRate=bad
|StatusUSB=partial
|StatusWLAN=bad
|StatusGPS=bad
|StatusNFC=bad
|StatusCellular=missing
|StatusCamera=missing
|StatusCrown=good
|StatusHands=missing
}}
[[Category:Watches]]
Hoki (Fossil Gen 6) is a

= Description =

= Repair =

= Miscellaneous hardware docs =
== Keys ==
== Manually getting to fastboot ==
Press and hold all three buttons, wait until fastboot appears.

Hoki

2023-07-10T17:18:07Z

MagneFire: Created page with "{{Watches |Name=hoki |Model=Fossil Gen 6 |Picture=hoki.png |Status=supported |Stars=2 |Chipset=msm8937 |KernelVersion=4.14 |AndroidVersion=pie |StatusDisplay=good |StatusTouch=good |StatusBluetooth=good |StatusHaptics=good |StatusTiltToWake=bad |StatusLightSensor=bad |StatusAlwaysOnDisplay=partial |StatusDualDisplay=missing |StatusMicrophone=bad |StatusSpeaker=bad |StatusCompass=bad |StatusSteps=bad |StatusHeartRate=bad |StatusUSB=partial |StatusWLAN=bad |StatusGPS=bad |..."

Documentation

2023-07-04T21:23:41Z

MagneFire: Remove welcome message

* [[Code of Conduct]]
* [[:Category:Watches| Watches]]

=== For Users: ===
* [[Synchronization Clients]]
* [[SSH]]
* [[Watchface and Package Installation]]
* [[Backup Guide]]
* [[IP Connection]]
* [[Useful Commands]]
* [[Porting Status]]
* [[Updating AsteroidOS]]
* [[Translating AsteroidOS]]
* [[Licenses]]

=== For Developers: ===
* [[Building AsteroidOS]]
* [[Creating an Asteroid app]]
* [[Creating a Watchface]]
* [[Emulator]]
* [[Local version of asteroidos.org]]
* [[Bluetooth]]
* [[BLE profiles]]

=== For Porters: ===
* [[Porting Guide]]
* [[OpenEmbedded]]
* [[Boot Process]]
* [[Graphic Stack]]
* [[Technical Details of AsteroidOS Watches]]

Porting Guide

2023-07-02T19:58:06Z

MagneFire: Fix some code blocks.

[[Category:Porters]]
An AsteroidOS hardware adaptation layer consists of:
* OpenEmbedded recipes describing the compilation of the various HW adaptation components.
* An appropriate vendor kernel able to boot the watch’s SoC and including the required drivers.
* A set of Wear OS’s proprietary binary blobs used through libhybris in order to access some of the Android’s HALs.
* Some middleware configuration files to use your HW adaptation.
== Creating an OpenEmbedded BSP layer ==

In order to add the support of your watch to AsteroidOS, you’ll need to write an OpenEmbedded layer. Start by making sure you are familiar with the core concepts behind OpenEmbedded by reading the two related documentation pages.
* [[OpenEmbedded]]
* [[Building AsteroidOS]]
The easiest way to create an OpenEmbedded layer for hardware adaptation is to modify one that already exists. If you want to base your port on an Android 5.5.1 base, you should base your layer on [https://github.com/AsteroidOS/meta-dory-hybris meta-dory-hybris]. If you want to base your port on an Android 6 base, you should base your layer on [https://github.com/AsteroidOS/meta-swift-hybris meta-swift-hybris]. If you want to base your port on an Android 8 base, you should base your layer on [https://github.com/AsteroidOS/meta-mooneye-hybris meta-mooneye-hybris].

Start by cloning the most appropriate layer into an <code>src/meta-XXX-hybris/</code> directory in your AsteroidOS build tree. From now on, XXX will be a reference to your watch’s codename. Once you have that layer setup, [https://github.com/AsteroidOS/meta-swift-hybris/commit/b665878f80936f21cec1757cdc4d10fa95af1841 roughly replace] all references to the previous codename with XXX in the layer and add the path to your layer in your <code>build/conf/bblayers.conf</code> file.

The layer should describe a machine configuration to bitbake in <code>[https://github.com/AsteroidOS/meta-dory-hybris/blob/master/conf/machine/dory.conf conf/machine/XXX.conf]</code>. The definition of a machine allows to [https://github.com/AsteroidOS/meta-dory-hybris/blob/master/conf/machine/dory.conf#L25 install hardware-specific packages] in a generated rootfs and to give very general information about the hardware adaptation like the [https://github.com/AsteroidOS/meta-dory-hybris/blob/master/conf/machine/dory.conf#L18 kernel] or [https://github.com/AsteroidOS/meta-dory-hybris/blob/master/conf/machine/dory.conf#L10 egl providers] that should be used. Having a new machine also allows to modify other layers’ recipes based on the build’s target. For example a <code>.bbappend</code> file using the _XXX suffix appropriately can [https://github.com/AsteroidOS/meta-dory-hybris/blob/master/recipes-android/brcm-patchram-plus/brcm-patchram-plus_git.bbappend#L1 modify built files], [https://github.com/AsteroidOS/meta-dory-hybris/blob/master/recipes-qt/qt5/qt5-qpa-hwcomposer-plugin_git.bbappend#L1 apply patches], [https://github.com/AsteroidOS/meta-dory-hybris/blob/master/recipes-nemomobile/sensorfw/sensorfw_git.bbappend#L1 add build dependencies], [https://github.com/AsteroidOS/meta-dory-hybris/blob/master/recipes-multimedia/pulseaudio/pulseaudio_%25.bbappend#L1 add runtime dependencies] or [https://github.com/AsteroidOS/meta-dory-hybris/blob/master/recipes-android/brcm-patchram-plus/brcm-patchram-plus_git.bbappend#L3 change compilation flags]. bbappends are very powerful but should be used scarcely to avoid conflicts with other layers.

An hardware adaptation layer does not only modify other recipes with bbappend, it also provides a couple of new recipes that are hardware-specific. You can usually find two very important recipes: the [https://github.com/AsteroidOS/meta-dory-hybris/blob/master/recipes-kernel/linux/linux-dory_lp-mr1.bb kernel recipe] and the [https://github.com/AsteroidOS/meta-dory-hybris/blob/master/recipes-android/android/android_dory-lp.bb Android’s blobs recipe]. Those recipes will need extra-care and are the topic of the two following paragraphs.

== Creating an appropriate Linux kernel recipe ==
The kernel recipe describes how to fetch/patch/configure/compile/install/package the vendor kernel. All of those steps may need to be modified from your base recipe.

First of all, you need to find the [https://android.googlesource.com/kernel/msm/+refs git repository], branch and commit containing the source code of the watch you want to work on. Adapt [https://github.com/AsteroidOS/meta-dory-hybris/blob/master/recipes-kernel/linux/linux-dory_lp-mr1.bb#L11 SRC_URI] and [https://github.com/AsteroidOS/meta-dory-hybris/blob/master/recipes-kernel/linux/linux-dory_lp-mr1.bb#L16 SRCREV] accordingly.

Then, try to find your watch’s [https://android.googlesource.com/kernel/msm/+/android-msm-dory-3.10-marshmallow-mr1-wear-release/arch/arm/configs/dory_defconfig defconfig] in the kernel’s <code>arch/arm/configs/</code> directory. Copy this base defconfig onto <code>[https://github.com/AsteroidOS/meta-dory-hybris/blob/master/recipes-kernel/linux/linux-dory/defconfig meta-XXX-hybris/recipes-kernel/linux/linux-XXX/defconfig]</code> and use the [https://github.com/AsteroidOS/meta-asteroid/blob/master/scripts/check-config <code>check-config</code> script of meta-asteroid] with the <code>-w</code> flag to fix a couple of configuration values.

If you need to patch your kernel’s tree, add the path to [https://github.com/AsteroidOS/meta-dory-hybris/blob/master/recipes-kernel/linux/linux-dory/0001-Backport-mainline-4.1-Bluetooth-subsystem.patch the patches] to [https://github.com/AsteroidOS/meta-dory-hybris/blob/master/recipes-kernel/linux/linux-dory_lp-mr1.bb#L14 SRC_URI].

The output of a kernel compilation is a single zImage. In order to be started by your watch’s bootloader, this image needs to be packed with an initramfs into a single boot.img file. (for more information cf. [[Boot Process]]) Three different tools can be used to pack the boot.img file: abootimg, mkboot and mkbootimg. Since some watches only work with one of those tools (without any apparent reason), you can [https://github.com/AsteroidOS/meta-dory-hybris/blob/master/recipes-kernel/linux/linux-dory_lp-mr1.bb#L36 inherit] one of the [https://github.com/AsteroidOS/meta-asteroid/tree/master/classes provided bbclass] and adapt the config accordingly.
'''Extra-Note''': The Yocto project provides a [http://www.yoctoproject.org/docs/1.6.1/kernel-dev/kernel-dev.html handy manual] on how to work with the Linux kernel with OpenEmbedded.

== Building the Android's <code>/system/</code> directory ==

In order to get a full AsteroidOS environment, you will need to install the Android HALs required by the usage of libhybris in various AsteroidOS components.

Actually, only a very limited set of libs from Android is needed. Some of those libs (like bionic) need to be patched and must be recompiled from source. Hence, you’ll need to start by cloning a [https://github.com/AsteroidOS/android_manifest/blob/master/default.xml modified and stripped down Android source tree] to compile the needed drivers. You can find detailed info on the build process that has been used for dory in [https://github.com/AsteroidOS/meta-dory-hybris/blob/master/README-system-dir README-system-dir]. You’ll most likely need to adapt those instructions to your own need, thus you are strongly encouraged to document your steps in your own README-system-dir for reproducibility and in order to help future porters.

Once you’ll get your first <code>/system/</code> directory, you can modify <code>meta-XXX-hybris/recipes-android/android/android_XXX-*.bb</code> to use your prebuilt tarball. The next steps in hardware adaptation will most likely require you to iterate various modifications to this system directory so don’t get too emotionally attached to this tarball yet.

== Boot ==
If you boot your generated boot.img from your watch’s bootloader, fastboot should load your kernel which will load the initramfs’s init script which will eventually load you rootfs’s init system. (for more information cf. [[Boot Process]]) You can usually know if those steps have successfully been completed when the watch stays up and running and shows the AsteroidOS boot logo for a while (shown by psplash which is ran by systemd on the rootfs). In case your boot stops earlier, you have a boot problem to debug.

You need to proceed by elimination to find what causes your boot to fail. First of all, disable the ramfs → rootfs switch by adding a bash infinite loop early [https://github.com/AsteroidOS/meta-dory-hybris/blob/master/recipes-core/initrdscripts/initramfs-boot-android/init.sh#L54 in your ramdisk’s init script]. If you notice your watch does not crash anymore, you may have an issue with your rootfs. The Troubleshooting section of the [[Boot Process|Boot Process page]] should help you retrieve your systemd logs and isolate the cause of your boot problem.

If your watch keeps on crashing, you may have a problem with your kernel. Start by making sure you tried the different boot.img packing tools. If the problem persists, you’ll want to retrieve your kernel’s message logs. This can usually be retrieved from a <code>/proc/last_kmsg</code> virtual file in Wear OS when enabling the <code>CONFIG_ANDROID_RAM_CONSOLE</code> kernel option. Analyzing the logs should also help narrowing down the issue to a faulty driver or config.

== USB ==
If you have your AsteroidOS system running, you will want to get a shell access to it with adb or SSH over USB. Use <code>dmesg -w</code> on your computer to check if your watch appears after having been booted for a few seconds. If you don’t see your watch, you may have a problem with your USB setup.

First of all, try to replicate the config of your Wear OS’s init scripts in [https://github.com/AsteroidOS/meta-dory-hybris/blob/master/recipes-core/initrdscripts/initramfs-boot-android/init.sh#L26 your ramdisk’s init script]. Once you’re sure the USB config is the same, you should try to run [https://github.com/AsteroidOS/meta-dory-hybris/blob/master/recipes-core/initrdscripts/initramfs-boot-android/init.sh#L52 adbd from your ramdisk] instead of the rootfs, if it solves the problem you may have an issue with usb_moded not starting adbd or RNDIS properly.

If the problem is the same, you may have a problem with your kernel’s config or drivers. First of all, make sure <code>CONFIG_USB_G_ANDROID</code> is still enabled in the generated <code>build/tmp-glibc/work/XXX-oe-linux-gnueabi/linux-XXX/*/git/.config</code> as it is quite common to find bitbake removing this option. If the option is still there, your kernel may need special patches.

== Display ==
As soon as you’ll get access to a shell on AsteroidOS, you may find yourself without asteroid-launcher running. Checking the system logs with <code>journalctl –no-pager</code> or <code>systemctl –no-pager</code> usually shows a segfault from the asteroid-launcher process. This is to be expected on your first run and there is nothing to worry about. In order to reproduce the bug, you can start asteroid-launcher manually with:
<pre>
EGL_PLATFORM=hwcomposer QT_QPA_PLATFORM=hwcomposer asteroid-launcher
</pre>
asteroid-launcher uses lipstick which uses the hwcomposer QPA which uses libhybris which uses the Android graphic HAL to display things on screen. You may need to adapt the Android graphic HAL to answer the needs of hybris. (usually a matter of starting the right android boot services, having the right files placed in the right directories, having the right <code>system.prop</code> options etc…)

For more information on the Graphic Stack you may want to refer to [[Graphic Stack|the associated documentation page]]. For more information on how to debug an issue, check the Troubleshooting paragraph of this page.

== Touch ==
Once you’ll get asteroid-launcher displaying things on screen, you may have no touch feedback from the UI. If that is the case, you’ll need to modify the asteroid-launcher start command to use a different evdevtouch file. For example, tetra uses [https://github.com/AsteroidOS/meta-tetra-hybris/tree/master/recipes-asteroid/asteroid-launcher this bbappend] to use <code>/dev/input/event1</code> instead of the default event0.

== Audio ==
Smartwatches usually don’t carry speakers but they often have microphones. AsteroidOS does not use those microphones yet but it’s usually easy to support and should be supported for the future of the project. AsteroidOS uses [https://github.com/AsteroidOS/meta-asteroid/tree/master/recipes-multimedia/pulseaudio pulseaudio] for its audio stack. pulseaudio takes benefits from the pulseaudio-droid-card module to use the Android’s Audio HAL. In order to test the microphone, you can install and run parec from the <code>build/tmp-glibc/work/armv7ve-neon-oe-linux-gnueabi/pulseaudio/9.0-r0/packages-split/pulseaudio-misc/</code> package. If you lack an audio interface, make sure you [https://github.com/AsteroidOS/meta-dory-hybris/commit/0276357cdb266ce28eb37ca958c70f5273d588cd loaded the audio firmware].

In case a problem persist, enabling [https://wiki.ubuntu.com/PulseAudio/Log extra debug information] from pulseaudio can give you detailed info on the cause of the issue.

To play an audio file use the following command:
<pre>
gst-launch-1.0 filesrc location=input.mp3 ! mpegaudioparse! mpg123audiodec ! pulsesink
</pre>

To make an audio recording, use the following command:
<pre>
gst-launch-1.0 pulsesrc ! audioconvert ! wavenc ! filesink location=recording.wav
</pre>

== Bluetooth ==
Smartwatches make extensive use of Bluetooth for connectivity. The AsteroidOS project comes with a set of Bluetooth Low Energy profiles implemented in the asteroid-btsyncd server daemon and AsteroidOSSync client. (for more information cf. [[Bluetooth]]) Bluetooth required a few extra steps to work on your port.

asteroid-btsyncd uses BlueZ’s DBus API to create a BLE server. Those APIs require a recent Bluetooth subsystem in your kernel. Unfortunately, Wear OS watches usually come with outdated kernels and a newer BT subsystem needs to be backported. The patch used in dory can be found [https://github.com/AsteroidOS/meta-dory-hybris/blob/master/recipes-kernel/linux/linux-dory/0002-Backport-mainline-4.1-Bluetooth-subsystem.patch here] and should be adaptable to your kernel’s tree with very few conflicts.

Most Wear OS smartwatches carry a Broadcom BT chip that requires a proprietary firmware to be applied with a tool named brcm-patchram-plus. This tool is called from a systemd service named patchram.service, your HW adaptation layer should include a [https://github.com/AsteroidOS/meta-dory-hybris/tree/master/recipes-android/brcm-patchram-plus modified <code>patchram.service</code>] file that uses the provided vendor’s firmware and tty line. Information about the config you should use can be found in the [https://android.googlesource.com/platform/hardware/broadcom/libbt/+/master/include/ Android’s libbt-broadcom repository].

With a backported BT subsystem and patched BT firmware, you should already be able to get Bluetooth connectivity on your port but with very limited battery life. Broadcom’s bluetooth’s low power mode is handled by a kernel module named Bluesleep (or more recently Nitrous) that expects custom information to be written in <code>/proc/lpm/</code>. With BlueZ, this proc interface is never used hence the kernel driver must be adapted to receive HCI events from the BT subsystem with [https://github.com/AsteroidOS/meta-dory-hybris/blob/master/recipes-kernel/linux/linux-dory/0003-bluesleep-Use-kernel-s-HCI-events-instead-of-proc-bl.patch a patch]. Finally, brcm-patchram-plus must also be [https://github.com/AsteroidOS/meta-dory-hybris/blob/master/recipes-android/brcm-patchram-plus/brcm-patchram-plus_git.bbappend#L3 compiled with a special flag] defining the target device and the [https://github.com/AsteroidOS/brcm-patchram-plus/commit/94fb127e614b19a9a95561b8c1a0716e2e1e6293 low power mode options to use].

== Sensors ==
In AsteroidOS, sensors can be used by developers through the QtSensors API that uses the sensorfw backend. Sensorfwd is a sensor daemon that can use libhybris to interface with the Android’s Sensors HAL.

Most watches have a dedicated microcontroller that interfaces with sensors. This means that a daemon or kernel module (or something else) is responsible to upload and interface with the microcontroller from AsteroidOS.

In order to use sensors on AsteroidOS, you need to make sure libhybris recognizes your sensors by running the <code>test_sensors</code> command. For some platforms it is required to start a sensor daemon. This can usually be found in Wear OS's init scripts. A likely output of <code>test_sensor</code> for a platform needing a sensor daemon is:

<code>sensors_open() failed: Operation not permitted</code>

For more information on how to debug an issue, check the Troubleshooting paragraph of this page.

== Haptics ==
In AsteroidOS, vibrations can be used by developers through the QtFeedback and ngfd APIs that usually rely on a libhybris backend which uses the Android’s vibration HAL.
In order to use vibration on Asteroid with the Android HAL, you need to make sure libhybris recognizes your vibrator by running the <code>test_vibrator</code> command. For more information on how to debug an issue, check the Troubleshooting paragraph of this page.

A much cleaner way to vibrate in AsteroidOS would be to use an ffmemless kernel driver and the sensorfwd’s ffmemless backend but most watches don’t come with such a kernel driver and it would need to be developed.

== WLAN ==
WLAN is not used by AsteroidOS’s user-interface yet but it should be supported for the future of the project. Some information about setting up a Wi-Fi interface can be found in the last paragraph of the [[SSH| SSH documentation page]].

== Troubleshooting ==
While porting AsteroidOS to your watch, you will most likely meet all kind of problems. In order to debug what’s going wrong with your setup you should install debug tools such as strace and gdb and the required debug sybols to your generated rootfs. For example, you can temporarily append the <code>strace gdb asteroid-launcher-dbg</code> packages to the [https://github.com/AsteroidOS/meta-asteroid/blob/master/classes/asteroid-image.bbclass#L9 asteroid-image class].

Other logical places to look for information that may help you solve the problems are: <code>dmesg</code>, <code>journalctl --no-pager</code> and <code>/system/bin/logcat</code>.

Once you come up with more information about your bug, your first reflex should be to [https://log.asteroidos.org/search search the asteroid’s IRC logs] for similar issues. The SailfishOS porters community is another great place to search for information, you may also want to try your chance at [[google:site:merproject.org+irc+QCOM_BSP|searching the merproject’s IRC logs]]. Lastly you can also look through the [https://github.com/search?q=org%3AAsteroidOS+mdss_mdp_overlay_pipe_setup&type=Issues GitHub issues] for more information by other porters.

If you still couldn’t find a solution to your problem in the logs, don’t hesitate to ask questions on the #asteroid IRC or [https://matrix.to/#/#Asteroid:matrix.org #Asteroid:matrix.org] channel. There should be several porters able to help you.

== Upstream your work ==
That’s it, you can finally use AsteroidOS on your watch! Sharing your work with the rest community should be the final step to ensure your layer will be maintained through time. Start by requesting on IRC the creation of a new AsteroidOS/meta-XXX-hybris repository and send a pull request to this repository. Your work will be carefully reviewed and commented before being integrated upstream. You’ll also need to send a [https://github.com/AsteroidOS/asteroid/pull/8 pull-request to the AsteroidOS/asteroid repository] to integrate your machine to <code>prepare-build.sh</code> and join the very privileged circle of AsteroidOS porters! Make sure your work is correctly detailed on the [[Porting Status]] page and share a photo of your watch for public twitter announcement.

Frequently Asked Questions (FAQ)

2023-07-02T19:54:49Z

MagneFire: Styling fixes.

== What is AsteroidOS? ==
AsteroidOS is an open source Linux distribution that runs on many different smartwatches. It uses [http://www.qt.io/ Qt] and QML to provide the graphical interface.

One of the main goals of AsteroidOS is to provide users with greater control over their devices and data privacy. The operating system is fully customizable, and users can modify it to meet their specific needs.

== Which features are provided? ==
Currently, AsteroidOS has these features available:

- Always-on-Display

- Tilt-to-Wake

- Palm-to-Sleep

- Phone notifications

- Multiple app launcher styles

- Wallpapers

- [https://github.com/AsteroidOS/unofficial-watchfaces Community watchfaces]

- Nightstand mode

== Are any apps preinstalled? ==
The following apps are delivered with an AsteroidOS installation:

- Agenda, a calendar

- Alarm clock

- Calculator

- Compass

- Diamonds game

- Flashlight

- Heartrate check

- Music, a media remote control

- Settings

- Stopwatch

- Timer

- Weather forecast

== Does an app store exist? ==
A store to install apps does not yet exist. But this is something that is being considered for future implementation. There are a number of contributed apps that are not installed in the default image. These can be [[Watchface and Package Installation|installed manually]] if desired.

== Where can I find a phone synchronization app? ==
A phone is not ''required'' to use AsteroidOS, but several convenient functions are available when an AsteroidOS watch is paired with one of the [[Synchronization Clients|synchronization clients listed in the documentation]].

- Android users can use "AsteroidOSSync" which is available for [https://f-droid.org/packages/org.asteroidos.sync/ download on F-Droid]. Or try [https://f-droid.org/packages/nodomain.freeyourgadget.gadgetbridge/ Gadgetbridge from F-Droid] with initial AsteroidOS support.

- Ubuntu Touch users can download [https://open-store.io/app/telescope.asteroidos Telescope" from OpenStore]

- There is currently no app for iPhone, however notifications can be shared from an iPhone to the watch. See [[Synchronization Clients|this page]] for details.

== What features and apps does AsteroidOS '''not''' provide? ==
There are a great many more ''ideas'' for apps than apps at the moment. Some of the more commonly requested, but not yet available applications and features are:

- Call answering from the watch

- Fitness and health tracking application (step counter, ongoing heartrate monitor, etc.)

- Support for using the watch as a phone (for some watches that incorporate a cellular phone chip)

- ''And many more''

Some of these are being worked on, and others are just ideas at this point. If you think you might like to contribute, see our [https://github.com/AsteroidOS/asteroid/issues GitHub repository] and the [https://asteroidos.org/contact/ Contact] page. There are many opportunities for creativity!

== Is AsteroidOS based on Android? ==
No. AsteroidOS uses [[wikipedia:Hybris_(software)|libhybris]] to simplify porting to most Android and WearOS watches, but it is not Android nor is it WearOS or a derivative of either.

Hardware drivers on modern smartwatches are specifically tailored for Android and WearOS devices. These drivers are closely tied to the hardware and are not compatible with other operating systems, which usually makes porting to alternative platforms a complex and time-consuming process. Libhybris allows AsteroidOS to leverage the proprietary binary drivers and thus greatly helps porting Linux to Android based hardware.

== Can I run WearOS applications? ==
No. [[wikipedia:Wear_OS|WearOS]] is a version of Android that runs on wearable devices. AsteroidOS is a Linux distribution that does not run Android and therefore cannot run either Android or WearOS applications.

== What is different to WearOS? ==
One significant difference is that AsteroidOS is open source software, while WearOS is not. That is, if you want to change something and you are a developer, you can [[Building AsteroidOS|build the software]] yourself. Or perhaps you would like to [[Creating a Watchface|create your own watchface]].

Another significant difference is that AsteroidOS, unlike WearOS, tries to make the watch usable without pairing it with a phone. In contrast, WearOS watches only run when they are paired with a phone.

== Does AsteroidOS have any tracking features? ==
No. AsteroidOS does not collect any tracking data and you don't need to use or establish any accounts to use it. Nothing on the default installation is able to connect to the internet. While it is possible to [[IP Connection|connect an AsteroidOS watch to the internet]] this must be explicitly done by the user.

== Can my watch run AsteroidOS? ==
Maybe. Check the [[Category:Watches|Watches]] page. It lists all devices supported by AsteroidOS. The star rating indicates the current level of support for each device's hardware features. Watches with at least 3 stars can be considered suitable for everyday use.

== My watch isn't listed. ==
Maybe you can still run Asteroid OS in the future. See the [[Porting Status|porting status]] page for details on what kinds of watches might be supported in the future and what the general requirements are for running AsteroidOS.

If you are interested in porting AsteroidOS to a new watch yourself, please read the [[Porting Guide]] page and contact us via our [https://asteroidos.org/contact/ matrix channel] in case of possible questions.

== Which features of my watch are currently supported? ==
The available AsteroidOS features depend on the watch you want to use. Review the table on the installation page for your device to get detailed support information.

Or check the [https://asteroidos.org/watches/features/ features table] to see a matrix of all AsteroidOS watches and their feature support.

== Will I be able to revert to the previous operating system? ==
Yes, very easily if you choose the "temporary install" option.

For most watches, you may choose to only temporarily install AsteroidOS alongside the existing OS, called a "dual-boot". When doing so, the <code>asteroidos.ext4</code> image is pushed to the userdata partition using ADB. With no alteration to the previous OS. The downside of this method being, AsteroidOS needs to be manually booted using <code>fastboot boot boot-image.fastboot</code> while connected via USB, after every reboot or shutdown. Else, the previous OS will start up as usual.

In case you decide to replace your previous OS using the full install method, to make the watch boot into AsteroidOS without manual intervention. It is advised that you [[Backup Guide|make a backup of your entire watch]] before flashing AsteroidOS. Only then, you will be able to re-flash those backups to restore the previous OS later.

== When can I expect updates? ==
The complete rebuild of all packages for all Watch system images and architectures takes almost a week. The build process is started at the beginning of a week. Therefore, it can be expected that new nightlies will be available on the weekend. These will contain all the changes that have been merged up to the start of the build process.

== Can I compile AsteroidOS myself? ==
If you do not want to flash a prebuilt image onto your watch or wait for the nightlies to be updated, review the [[Building AsteroidOS]] page for detailed instructions on how to compile AsteroidOS yourself.

== My question is not answered. ==
There are many additional resources. The [[Documentation]] page should be your first stop. It has a lot of useful information about both using and developing for AsteroidOS. If you can't find your answer on this web site, see [https://asteroidos.org/contact/ Contact].

Frequently Asked Questions (FAQ)

2023-07-02T19:49:15Z

MagneFire: Fix link to package installation.

== What is AsteroidOS? ==
AsteroidOS is an open source Linux distribution that runs on many different smartwatches. It uses [http://www.qt.io/ Qt] and QML to provide the graphical interface.

One of the main goals of AsteroidOS is to provide users with greater control over their devices and data privacy. The operating system is fully customizable, and users can modify it to meet their specific needs.

== Which features are provided? ==
Currently, AsteroidOS has these features available:

- Always-on-Display

- Tilt-to-Wake

- Palm-to-Sleep

- Phone notifications

- Multiple app launcher styles

- Wallpapers

- [https://github.com/AsteroidOS/unofficial-watchfaces Community watchfaces]

- Nightstand mode

== Are any apps preinstalled? ==
The following apps are delivered with an AsteroidOS installation:

- Agenda, a calendar

- Alarm clock

- Calculator

- Compass

- Diamonds game

- Flashlight

- Heartrate check

- Music, a media remote control

- Settings

- Stopwatch

- Timer

- Weather forecast

== Does an app store exist? ==
A store to install apps does not yet exist. But this is something that is being considered for future implementation. There are a number of contributed apps that are not installed in the default image. These can be [[Watchface and Package Installation|installed manually]] if desired.

== Where can I find a phone synchronization app? ==
A phone is not *required* to use AsteroidOS, but several convenient functions are available when an AsteroidOS watch is paired with one of the [[Synchronization Clients|synchronization clients listed in the documentation]].

- Android users can use "AsteroidOSSync" which is available for [https://f-droid.org/packages/org.asteroidos.sync/ download on F-Droid]. Or try [https://f-droid.org/packages/nodomain.freeyourgadget.gadgetbridge/ Gadgetbridge from F-Droid] with initial AsteroidOS support.

- Ubuntu Touch users can download [https://open-store.io/app/telescope.asteroidos Telescope" from OpenStore]

- There is currently no app for iPhone, however notifications can be shared from an iPhone to the watch. See [[Synchronization Clients|this page]] for details.

== What features and apps does AsteroidOS '''not''' provide? ==
There are a great many more *ideas* for apps than apps at the moment. Some of the more commonly requested, but not yet available applications and features are:

- Call answering from the watch

- Fitness and health tracking application (step counter, ongoing heartrate monitor, etc.)

- Support for using the watch as a phone (for some watches that incorporate a cellular phone chip)

- *And many more*

Some of these are being worked on, and others are just ideas at this point. If you think you might like to contribute, see our [https://github.com/AsteroidOS/asteroid/issues GitHub repository] and the [https://asteroidos.org/contact/ Contact] page. There are many opportunities for creativity!

== Is AsteroidOS based on Android? ==
No. AsteroidOS uses [[wikipedia:Hybris_(software)|libhybris]] to simplify porting to most Android and WearOS watches, but it is not Android nor is it WearOS or a derivative of either.

Hardware drivers on modern smartwatches are specifically tailored for Android and WearOS devices. These drivers are closely tied to the hardware and are not compatible with other operating systems, which usually makes porting to alternative platforms a complex and time-consuming process. Libhybris allows AsteroidOS to leverage the proprietary binary drivers and thus greatly helps porting Linux to Android based hardware.

== Can I run WearOS applications? ==
No. [[wikipedia:Wear_OS|WearOS]] is a version of Android that runs on wearable devices. AsteroidOS is a Linux distribution that does not run Android and therefore cannot run either Android or WearOS applications.

== What is different to WearOS? ==
One significant difference is that AsteroidOS is open source software, while WearOS is not. That is, if you want to change something and you are a developer, you can [[Building AsteroidOS|build the software]] yourself. Or perhaps you would like to [[Creating a Watchface|create your own watchface]].

Another significant difference is that AsteroidOS, unlike WearOS, tries to make the watch usable without pairing it with a phone. In contrast, WearOS watches only run when they are paired with a phone.

== Does AsteroidOS have any tracking features? ==
No. AsteroidOS does not collect any tracking data and you don't need to use or establish any accounts to use it. Nothing on the default installation is able to connect to the internet. While it is possible to [[IP Connection|connect an AsteroidOS watch to the internet]] this must be explicitly done by the user.

== Can my watch run AsteroidOS? ==
Maybe. Check the [[Category:Watches|Watches]] page. It lists all devices supported by AsteroidOS. The star rating indicates the current level of support for each device's hardware features. Watches with at least 3 stars can be considered suitable for everyday use.

== My watch isn't listed. ==
Maybe you can still run Asteroid OS in the future. See the [[Porting Status|porting status]] page for details on what kinds of watches might be supported in the future and what the general requirements are for running AsteroidOS.

If you are interested in porting AsteroidOS to a new watch yourself, please read the [[Porting Guide]] page and contact us via our [https://asteroidos.org/contact/ matrix channel] in case of possible questions.

== Which features of my watch are currently supported? ==
The available AsteroidOS features depend on the watch you want to use. Review the table on the installation page for your device to get detailed support information.

Or check the [https://asteroidos.org/watches/features/ features table] to see a matrix of all AsteroidOS watches and their feature support.

== Will I be able to revert to the previous operating system? ==
Yes, very easily if you choose the "temporary install" option.

For most watches, you may choose to only temporarily install AsteroidOS alongside the existing OS, called a "dual-boot". When doing so, the `asteroidos.ext4` image is pushed to the userdata partition using ADB. With no alteration to the previous OS. The downside of this method being, AsteroidOS needs to be manually booted using `fastboot boot boot-image.fastboot` while connected via USB, after every reboot or shutdown. Else, the previous OS will start up as usual.

In case you decide to replace your previous OS using the full install method, to make the watch boot into AsteroidOS without manual intervention. It is advised that you [[Backup Guide|make a backup of your entire watch]] before flashing AsteroidOS. Only then, you will be able to re-flash those backups to restore the previous OS later.

== When can I expect updates? ==
The complete rebuild of all packages for all Watch system images and architectures takes almost a week. The build process is started at the beginning of a week. Therefore, it can be expected that new nightlies will be available on the weekend. These will contain all the changes that have been merged up to the start of the build process.

== Can I compile AsteroidOS myself? ==
If you do not want to flash a prebuilt image onto your watch or wait for the nightlies to be updated, review the [[Building AsteroidOS]] page for detailed instructions on how to compile AsteroidOS yourself.

== My question is not answered. ==
There are many additional resources. The [[Documentation]] page should be your first stop. It has a lot of useful information about both using and developing for AsteroidOS. If you can't find your answer on this web site, see [https://asteroidos.org/contact/ Contact].

Frequently Asked Questions (FAQ)

2023-07-02T19:19:43Z

MagneFire: Initial copy

== What is AsteroidOS? ==
AsteroidOS is an open source Linux distribution that runs on many different smartwatches. It uses [http://www.qt.io/ Qt] and QML to provide the graphical interface.

One of the main goals of AsteroidOS is to provide users with greater control over their devices and data privacy. The operating system is fully customizable, and users can modify it to meet their specific needs.

== Which features are provided? ==
Currently, AsteroidOS has these features available:

- Always-on-Display

- Tilt-to-Wake

- Palm-to-Sleep

- Phone notifications

- Multiple app launcher styles

- Wallpapers

- [https://github.com/AsteroidOS/unofficial-watchfaces Community watchfaces]

- Nightstand mode

== Are any apps preinstalled? ==
The following apps are delivered with an AsteroidOS installation:

- Agenda, a calendar

- Alarm clock

- Calculator

- Compass

- Diamonds game

- Flashlight

- Heartrate check

- Music, a media remote control

- Settings

- Stopwatch

- Timer

- Weather forecast

== Does an app store exist? ==
A store to install apps does not yet exist. But this is something that is being considered for future implementation. There are a number of contributed apps that are not installed in the default image. These can be [[Package Installation|installed manually]] if desired.

== Where can I find a phone synchronization app? ==
A phone is not *required* to use AsteroidOS, but several convenient functions are available when an AsteroidOS watch is paired with one of the [[Synchronization Clients|synchronization clients listed in the documentation]].

- Android users can use "AsteroidOSSync" which is available for [https://f-droid.org/packages/org.asteroidos.sync/ download on F-Droid]. Or try [https://f-droid.org/packages/nodomain.freeyourgadget.gadgetbridge/ Gadgetbridge from F-Droid] with initial AsteroidOS support.

- Ubuntu Touch users can download [https://open-store.io/app/telescope.asteroidos Telescope" from OpenStore]

- There is currently no app for iPhone, however notifications can be shared from an iPhone to the watch. See [[Synchronization Clients|this page]] for details.

== What features and apps does AsteroidOS '''not''' provide? ==
There are a great many more *ideas* for apps than apps at the moment. Some of the more commonly requested, but not yet available applications and features are:

- Call answering from the watch

- Fitness and health tracking application (step counter, ongoing heartrate monitor, etc.)

- Support for using the watch as a phone (for some watches that incorporate a cellular phone chip)

- *And many more*

Some of these are being worked on, and others are just ideas at this point. If you think you might like to contribute, see our [https://github.com/AsteroidOS/asteroid/issues GitHub repository] and the [https://asteroidos.org/contact/ Contact] page. There are many opportunities for creativity!

== Is AsteroidOS based on Android? ==
No. AsteroidOS uses [[wikipedia:Hybris_(software)|libhybris]] to simplify porting to most Android and WearOS watches, but it is not Android nor is it WearOS or a derivative of either.

Hardware drivers on modern smartwatches are specifically tailored for Android and WearOS devices. These drivers are closely tied to the hardware and are not compatible with other operating systems, which usually makes porting to alternative platforms a complex and time-consuming process. Libhybris allows AsteroidOS to leverage the proprietary binary drivers and thus greatly helps porting Linux to Android based hardware.

== Can I run WearOS applications? ==
No. [[wikipedia:Wear_OS|WearOS]] is a version of Android that runs on wearable devices. AsteroidOS is a Linux distribution that does not run Android and therefore cannot run either Android or WearOS applications.

== What is different to WearOS? ==
One significant difference is that AsteroidOS is open source software, while WearOS is not. That is, if you want to change something and you are a developer, you can [[Building AsteroidOS|build the software]] yourself. Or perhaps you would like to [[Creating a Watchface|create your own watchface]].

Another significant difference is that AsteroidOS, unlike WearOS, tries to make the watch usable without pairing it with a phone. In contrast, WearOS watches only run when they are paired with a phone.

== Does AsteroidOS have any tracking features? ==
No. AsteroidOS does not collect any tracking data and you don't need to use or establish any accounts to use it. Nothing on the default installation is able to connect to the internet. While it is possible to [[IP Connection|connect an AsteroidOS watch to the internet]] this must be explicitly done by the user.

== Can my watch run AsteroidOS? ==
Maybe. Check the [[Category:Watches|Watches]] page. It lists all devices supported by AsteroidOS. The star rating indicates the current level of support for each device's hardware features. Watches with at least 3 stars can be considered suitable for everyday use.

== My watch isn't listed. ==
Maybe you can still run Asteroid OS in the future. See the [[Porting Status|porting status]] page for details on what kinds of watches might be supported in the future and what the general requirements are for running AsteroidOS.

If you are interested in porting AsteroidOS to a new watch yourself, please read the [[Porting Guide]] page and contact us via our [https://asteroidos.org/contact/ matrix channel] in case of possible questions.

== Which features of my watch are currently supported? ==
The available AsteroidOS features depend on the watch you want to use. Review the table on the installation page for your device to get detailed support information.

Or check the [https://asteroidos.org/watches/features/ features table] to see a matrix of all AsteroidOS watches and their feature support.

== Will I be able to revert to the previous operating system? ==
Yes, very easily if you choose the "temporary install" option.

For most watches, you may choose to only temporarily install AsteroidOS alongside the existing OS, called a "dual-boot". When doing so, the `asteroidos.ext4` image is pushed to the userdata partition using ADB. With no alteration to the previous OS. The downside of this method being, AsteroidOS needs to be manually booted using `fastboot boot boot-image.fastboot` while connected via USB, after every reboot or shutdown. Else, the previous OS will start up as usual.

In case you decide to replace your previous OS using the full install method, to make the watch boot into AsteroidOS without manual intervention. It is advised that you [[Backup Guide|make a backup of your entire watch]] before flashing AsteroidOS. Only then, you will be able to re-flash those backups to restore the previous OS later.

== When can I expect updates? ==
The complete rebuild of all packages for all Watch system images and architectures takes almost a week. The build process is started at the beginning of a week. Therefore, it can be expected that new nightlies will be available on the weekend. These will contain all the changes that have been merged up to the start of the build process.

== Can I compile AsteroidOS myself? ==
If you do not want to flash a prebuilt image onto your watch or wait for the nightlies to be updated, review the [[Building AsteroidOS]] page for detailed instructions on how to compile AsteroidOS yourself.

== My question is not answered. ==
There are many additional resources. The [[Documentation]] page should be your first stop. It has a lot of useful information about both using and developing for AsteroidOS. If you can't find your answer on this web site, see [https://asteroidos.org/contact/ Contact].

Creating an Asteroid app

2023-06-26T19:33:02Z

MagneFire:

[[Category:Developers]]
= Using QtCreator =
QtCreator is an integrated development environment for making Qt QML applications.

== Getting the Cross Compilation Toolchain ==

The app creation process of AsteroidOS needs a Software Development Kit generated by OpenEmbedded. You can either grab a prebuilt SDK for the nightlies [https://release.asteroidos.org/nightlies/sdk/oecore-x86_64-armv7vehf-neon-toolchain-nodistro.0.sh here] and install it on your system or you can build it yourself as follows:

== Building the Cross Compilation Toolchain ==

Alternatively you can also build the toolchain from source. If you’ve already got an OpenEmbedded build directory via the [[Building AsteroidOS]] page, cd to that directory. Else, create one with:

=== Build without containers ===

<pre>
git clone https://github.com/AsteroidOS/asteroid
cd asteroid/
</pre>

Then, build the cross compilation toolchain with:

<code>
source ./prepare-build.sh dory
bitbake meta-toolchain-qt5
</code>

=== Build with containers===

Assuming you already prepared a docker or podman build environment like in: [[Building AsteroidOS]].

<pre>
sudo docker rm -f asteroidos-toolchain
sudo docker run -it \
--name asteroidos-toolchain \
-v /etc/passwd:/etc/passwd:ro \
-u "$(id -u):$(id -g)" \
-v "$HOME/.gitconfig:/$HOME/.gitconfig:ro" \
-v "$(pwd):/asteroid" asteroidos-toolchain \
bash -c "source ./prepare-build.sh dory && bitbake meta-toolchain-qt5"

<br />
</pre>

or

<code>
podman run --rm -it \
-v "$(pwd)":/asteroid:z \
--userns keep-id asteroidos-toolchain \
bash -c "source ./prepare-build.sh dory && bitbake meta-toolchain-qt5"

<br />
</code>

==Install the SDK ==

If you downloaded a prebuilt SDK, run the downloaded script. If you followed the previous steps, this will have generated the same installation script in <code>tmp-glibc/deploy/sdk/</code>, you can run it as follows:

<code>
./tmp-glibc/deploy/sdk/oecore-x86_64-armv7vehf-neon-toolchain-nodistro.0.sh
</code>

This script will install the cross-compiler and ARM libraries in <code>/usr/local/oecore-x86_64</code> by default, along with a script that needs to be sourced before every build. If you want to build a simple project via the terminal, this can be done like that:

<code>
source /usr/local/oecore-x86_64/environment-setup-armv7vehf-neon-oe-linux-gnueabi
cmake -B build
cmake --build build
</code>

==Configure QtCreator for cross compilation==

Before running QtCreator you must run the previously mentioned script:

<code>
source /usr/local/oecore-x86_64/environment-setup-armv7vehf-neon-oe-linux-gnueabi
qtcreator
</code>
One other environment variable needs to be set to work seamlessly with AsteroidOS:

<code>
export CMAKE_PROGRAM_PATH=/usr/local/oecore-x86_64/sysroots/armv7vehf-neon-oe-linux-gnueabi/usr/bin/
</code>

This can be done automatically by prepending <code>source /usr/local/oecore-x86_64/environment-setup-armv7vehf-neon-oe-linux-gnueabi</code> and the export command before <code>#!/bin/sh</code> in <code>/usr/bin/qtcreator.sh</code>

Now that you are in QtCreator go to <code>Tools</code> → <code>Options</code> → <code>Devices</code>

- Add a new Generic Linux Device.
- Name it "AsteroidOS Watch".
- Choose 192.168.2.15 as IP address.
- Use root as user.
- Choose Password authentication and leave the password field empty.

Under the <code>Kits</code> add a kit with the previously defined device:
- Set <code>Device type</code> to Generic Linux Device.
- Set the <code>Device</code> to AsteroidOS Watch.
- Set the sysroot to <code>/usr/local/oecore-x86_64/sysroots/armv7vehf-neon-oe-linux-gnueabi/</code>.
- In the CMake generator change the <code>Generator</code> to <code>Unix Makefiles</code>.
- Change <code>Qt version</code> to <code>None</code>.
- Change <code>C</code> compiler to <code><No compiler></code>.
- Change <code>C++</code> compiler to <code><No compiler></code>.
- Change <code>CMake Tool</code> to System CMake at /usr/local/oecore-x86_64/usr/bin/cmake
- Clear the <code>CMake Configuration</code> fields.

Note that if these steps are not done *in this order*, QtCreator will not let you change both the <code>C</code> compiler and <code>C++</code> compiler to <code><No compiler></code>. Specifically, setting Qt version to <code>None</code> must be done first.

= First app=

[https://github.com/AsteroidOS/asteroid-helloworld Asteroid-helloworld] can act as a cool QML demo app to make your first steps into AsteroidOS development easier. You can clone it, build it, install it and then modify it to follow your needs:

<code>
git clone https://github.com/AsteroidOS/asteroid-helloworld
cd asteroid-helloworld/
source /usr/local/oecore-x86_64/environment-setup-armv7vehf-neon-oe-linux-gnueabi
qtcreator CMakeLists.txt
</code>

Try to build and deploy the app. If it wasn’t already installed, a new icon should have already appeared on asteroid-launcher.

You can start by modifying occurrences of “asteroid-helloworld” to your app’s name. Then you can change the *.desktop file which describes the icon on the apps launcher. Then modify main.qml to describe your UI. To get started with QML development you can read the [http://doc.qt.io/qt-5/qml-tutorial.html official tutorial].

==Deploy an app from QtCreator==

Open the project as described in the previous sections.

- Click on the <code>Projects</code> button on the left sidebar.
- Under the <code>Build & Run</code> section click on the <code>Run</code> configuration. This opens all run settings.
- Scroll down to the <code>Run</code> settings.

Change the following <code>Run</code> settings:
- Set the <code>Run configuration</code> to <code>Custom Executable (on AsteroidOS Watch)</code>.
- Set the <code>Remote executable</code> to <code>invoker</code>. Add the <code>--single-instance --type=qtcomponents-qt5 /usr/local/bin/asteroid-helloworld</code> command line arguments.

Change the following <code>Environment</code> variables:
- Add <code>XDG_RUNTIME_DIR</code> and set its value to <code>/run/user/1000</code>. So that the invoker works under the root user.
- (Optional) Add <code>QT_WAYLAND_DISABLE_WINDOWDECORATION</code> with value <code>1</code>. To make the app full screen and hide the titlebar.

Your app should now be able to run from the application when you click the start button in the bottom left sidebar.

=Tips and tricks=

If you want to start your app from the command line, open a shell with [[SSH]], connect to ceres and use invoker:

<code>
invoker --type=qtcomponents-qt5 /usr/bin/asteroid-stopwatch
</code>

If you want to disable screen locking for easier development you can enable the demo mode of mce as root with:

<code>
mcetool -D on
</code>
=Troubleshooting=

The most common problems stem from not following these directions *exactly*. QtCreator helpfully tries to find compilers and set variables, but tends to set things up for the desktop as the target rather than AsteroidOS, so it often gets things wrong. The first step for troubleshooting with QtCreator is to go very carefully over each of the steps listed above and verify that they all match exactly.

==Could not find a package configuration file provided by "ECM" ==

This is most often caused not having the environment variables set up as shown above under the topic of [[#Configure QtCreator for cross compilation | configuring QtCreator]]. The environment variables must all be set and then you must lauch <code>qtcreator</code> *in the same shell*. If you're not sure you've done this, an easy way to check is to try this command from the command line:

<code>
echo $CC
</code>

This should result in a line like this:
<code>
arm-oe-linux-gnueabi-gcc -march=armv7ve -mfpu=neon -mfloat-abi=hard --sysroot=/usr/local/oecore-x86_64/sysroots/armv7vehf-neon-oe-linux-gnueabi
</code>

If instead you get an empty line or some other non-ARM compiler, you may have made an error. One common error is to run the script directly instead of running it using <code>source</code> (or <code>.</code> on some Linux distributions). Another common error that causes the error about not finding ECM is if, in the Kit, the system CMake is used instead of the one for the AsteroidOS SDK.

= warning: The project contains C++ source files, but the currently active kit has no C++ compiler. The code model will not be fully functional.

This is not really an error but a warning. It's the result of having correctly chosen <code><No compiler></code> as per the instructions above and may safely be ignored.

== file INSTALL cannot find ... .desktop==

This is probably the result of a missing <code>CMAKE_PROGRAM_PATH</code>. As mentioned above, this must be set in order for a script that generates the desktop file to be correctly found and uses.

==Remote process crashed==

One possibility is that your software has a bug, but another is that the <code>XDG_RUNTIME_DIR</code> is not set to <code>/run/user/1000</code> as mentioned above.

=="I fixed it but I get the same error!"==

This most often happens when something was originally wrong with the configuration, but a CMake scan was made and a possibly faulty Makefile from an earlier attempt still exists. To fix this, choose <code>Build</code> from the menu, and then <code>Rescan project</code>. This will run CMake again, ignoring existing cached values and forcing the recreation of a Makefile.

MediaWiki:Mainpage

2023-06-25T17:22:39Z

MagneFire: Created page with "Documentation"

Documentation

Main Page

2023-06-25T17:22:33Z

MagneFire: MagneFire moved page Main Page to Documentation

#REDIRECT [[Documentation]]