Porting Guide - Revision history

Dodoradio at 19:23, 27 June 2026

2026-06-27T19:23:56Z

Dodoradio: /* Setting up the layer */

2026-06-27T14:17:42Z

Setting up the layer

← Older revision		Revision as of 14:17, 27 June 2026
Line 25:		Line 25:
	* You may also want to go into meta-smartwatch and create a new branch for your port. As you're working, it's a good idea to make frequent commits so you can revert any changes.		* You may also want to go into meta-smartwatch and create a new branch for your port. As you're working, it's a good idea to make frequent commits so you can revert any changes.

	== Setting up the ~~layer ==~~		== Setting up the OpenEmbedded layer ==

	~~=== Creating an~~ OpenEmbedded ~~BSP~~ layer ===
	In order to add the support of your watch to AsteroidOS, you’ll need to write an OpenEmbedded layer. An overview of layers is available in the [[OpenEmbedded]] page.		In order to add the support of your watch to AsteroidOS, you’ll need to write an OpenEmbedded layer. An overview of layers is available in the [[OpenEmbedded]] page.

Dodoradio: rewrites of kernel and boot testing section, as well as part of android blobs section

2026-06-27T13:54:42Z

rewrites of kernel and boot testing section, as well as part of android blobs section

Show changes

Dodoradio: rewrite first half of the porting process

2026-06-26T15:47:23Z

rewrite first half of the porting process

Show changes

Dodoradio: Summarise prerequisites for port & restructure summary of resulting OE layer.

2026-06-26T15:07:09Z

Summarise prerequisites for port & restructure summary of resulting OE layer.

← Older revision		Revision as of 15:07, 26 June 2026
Line 1:		Line 1:
	[[Category:Porters]]		[[Category:Porters]]
	An AsteroidOS hardware adaptation layer consists of:
			== Prerequisites ==
			In order to run AsteroidOS using Hybris, your watch needs to meet the following criteria:

			* It likely needs to run WearOS or Android
			* It needs to have an unlockable bootloader, and you need a way to write boot images to the device.
			** This means you need a USB data connection to the watch. A significant number of watches do not expose USB data connections (either charging wirelessly, or charging via a connector that only supports USB power), but USB can be found on the inside by a determined hacker. You will need USB - porting without USB is outside the scope of this guide.
			* You need to have a copy of the kernel source.
			** This kernel needs to include the DTS, a structure of files that describe the device's hardware - Most vendor kernels include the DTS, but on newer watches the DTS has often been found to be incomplete.

			AsteroidOS is a Linux distribution, and therefore it should be possible to run it on devices with mainline kernels, or with vendor kernels and hardware abstraction from other platforms such as Tizen. Most devices right now use Android kernels and Hybris, and therefore that's what this guide covers.

			== Goal ==
			By the end, you should end up with an AsteroidOS hardware adaptation layer, which consists of:
	* OpenEmbedded recipes describing the compilation of the various HW adaptation components.		* 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~~.		** An appropriate vendor kernel, likely with some patches applied to fix compilation issues, or add functionality needed by Hybris and AsteroidOS.
	* A set of Wear OS’s proprietary binary blobs used through libhybris in order to access some of the Android’s HALs.		** 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.		*** These may either be shipped as part of the AsteroidOS install, or be mounted from an existing partition on the watch
			** Some middleware configuration files to use your HW adaptation.
	== Creating an OpenEmbedded BSP layer ==		== Creating an OpenEmbedded BSP layer ==

Beroset: /* Creating an OpenEmbedded BSP layer */ first pass at pointing to new meta-smartwatch files

2026-01-19T20:17:40Z

Creating an OpenEmbedded BSP layer: first pass at pointing to new meta-smartwatch files

← Older revision		Revision as of 20:17, 19 January 2026
Line 10:		Line 10:
	* [[OpenEmbedded]]		* [[OpenEmbedded]]
	* [[Building AsteroidOS]]		* [[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~~].		The easiest way to create an OpenEmbedded layer for hardware adaptation is to modify one that already exists within [https://github.com/AsteroidOS/meta-smartwatch meta-smartwatch]. 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-smartwatch/tree/master/meta-dory meta-dory]. If you want to base your port on an Android 6 base, you should base your layer on [https://github.com/AsteroidOS/meta-smartwatch/tree/master/meta-swift meta-swift]. If you want to base your port on an Android 8 base, you should base your layer on [https://github.com/AsteroidOS/meta-smartwatch/tree/master/meta-mooneye meta-mooneye].

	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.		Start by cloning the most appropriate layer into an <code>src/meta-XXX-hybris/</code> directory in your AsteroidOS build tree. Using the [https://github.com/AsteroidOS/meta-smartwatch/blob/master/scripts/new-watch.sh new-watch.sh] script makes this easy. 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.		The layer should describe a machine configuration to bitbake in <code>[https://github.com/AsteroidOS/meta-smartwatch/blob/master/meta-dory/conf/machine/dory.conf conf/machine/XXX.conf]</code>. The definition of a machine allows to [https://github.com/AsteroidOS/meta-smartwatch/blob/master/meta-dory/conf/machine/dory.conf#L16 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-smartwatch/blob/master/meta-dory/conf/machine/dory.conf#L9 screen characteristics] 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-smartwatch/blob/master/meta-dory/recipes-android/brcm-patchram-plus/brcm-patchram-plus_git.bbappend#L1 modify built files], [https://github.com/AsteroidOS/meta-smartwatch/blob/master/meta-dory/recipes-qt/qt5/qt5-qpa-hwcomposer-plugin_git.bbappend#L1 apply patches], [https://github.com/AsteroidOS/meta-smartwatch/blob/master/meta-dory/recipes-nemomobile/sensorfw/sensorfw_git.bbappend#L1 add build dependencies], [https://github.com/AsteroidOS/meta-smartwatch/blob/master/meta-dory/recipes-multimedia/pulseaudio/pulseaudio_%25.bbappend#L1 add runtime dependencies] or [https://github.com/AsteroidOS/meta-smartwatch/blob/master/meta-dory/recipes-android/brcm-patchram-plus/brcm-patchram-plus_git.bbappend#L3 change compilation flags]. bbappends are very powerful but should be used sparingly 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.		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-smartwatch/blob/master/meta-dory/recipes-kernel/linux/linux-dory_lp-mr1.bb kernel recipe] and the [https://github.com/AsteroidOS/meta-smartwatch/blob/master/meta-dory/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 ==		== Creating an appropriate Linux kernel recipe ==

Beroset: Edited to change old `tmp-glibc` to current `tmp` directory under `build`.

2025-10-10T00:33:30Z

Edited to change old `tmp-glibc` to current `tmp` directory under `build`.

← Older revision		Revision as of 00:33, 10 October 2025
Line 58:		Line 58:
	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.		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.		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/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 ==		== Display ==
Line 74:		Line 74:

	== Audio ==		== 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/armv7vehf-neon-oe-linux-gnueabi/pulseaudio/15.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].		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/work/armv7vehf-neon-oe-linux-gnueabi/pulseaudio/15.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.		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.

MagneFire: Audio: Fix command padding

2024-07-07T14:37:50Z

Audio: Fix command padding

← Older revision		Revision as of 14:37, 7 July 2024
Line 80:		Line 80:
	To play an audio file use the following command:		To play an audio file use the following command:
	<pre>		<pre>
	gst-launch-1.0 filesrc location=input.mp3 ! mpegaudioparse! mpg123audiodec ! pulsesink		gst-launch-1.0 filesrc location=input.mp3 ! mpegaudioparse ! mpg123audiodec ! pulsesink
	</pre>		</pre>

Beroset: fixed directory name in audio section

2023-07-06T16:10:53Z

fixed directory name in audio section

← Older revision		Revision as of 16:10, 6 July 2023
Line 74:		Line 74:

	== Audio ==		== 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/armv7vehf-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].		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/armv7vehf-neon-oe-linux-gnueabi/pulseaudio/15.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.		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.

Beroset: fixed directory name in audio section

2023-07-06T16:09:23Z

fixed directory name in audio section

← Older revision		Revision as of 16:09, 6 July 2023
Line 74:		Line 74:

	== Audio ==		== 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].		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/armv7vehf-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.		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.