Creating an Asteroid app - Revision history

Beroset: Refactored previous Creating an Asteroid app page to give better and more complete guidance

2026-01-14T21:11:07Z

Refactored previous Creating an Asteroid app page to give better and more complete guidance

Beroset: /* Translations */ added note about updating translation files

2025-02-28T21:42:09Z

Translations: added note about updating translation files

← Older revision		Revision as of 21:42, 28 February 2025
Line 146:		Line 146:

	Qt and therefore AsteroidOS also supports national language variants, so if you want to create the Argentinian Spanish version or the Great Britain English version those would be named <code>es_AR</code> and <code>en_GB</code> respectively.		Qt and therefore AsteroidOS also supports national language variants, so if you want to create the Argentinian Spanish version or the Great Britain English version those would be named <code>es_AR</code> and <code>en_GB</code> respectively.

			==== Updating language translation files ====
			Once they are created, to update language translation files, and assuming you have all source files in <code>src</code> and translation files in <code>i18n</code> (which is short for "internationalization"), you can use this command to update the files.

			<pre>
			lupdate-qt5 -no-obsolete src/* i18n/.h -ts i18n/.ts
			</pre>

	==Deploy an app from QtCreator==		==Deploy an app from QtCreator==

Beroset: /* Translations */ Added note about national language variants

2025-02-28T14:49:14Z

Translations: Added note about national language variants

← Older revision		Revision as of 14:49, 28 February 2025
Line 132:		Line 132:
	Within the AsteroidOS project, we use Qt Linguist and Weblate to enable [[Translating AsteroidOS]] and applications within it. If you're starting on "my-cool-project", you may want to add some language translations to it. This is done using the <code>lupdate</code> tool. Because Qt5 is nearing the end of support and Qt6 has been out for a while, the tool is named <code>lupdate-qt5</code> to differentiate between the two tools on most Linux distributions.		Within the AsteroidOS project, we use Qt Linguist and Weblate to enable [[Translating AsteroidOS]] and applications within it. If you're starting on "my-cool-project", you may want to add some language translations to it. This is done using the <code>lupdate</code> tool. Because Qt5 is nearing the end of support and Qt6 has been out for a while, the tool is named <code>lupdate-qt5</code> to differentiate between the two tools on most Linux distributions.

	Example: Let's say that you want to start with English, French, Spanish, German and Italian translations. You will have to create them before they can be translated. To do this, within your top level <code>my-cool-project</code> directory, execute the following command line code:		'''Example''': Let's say that you want to start with English, French, Spanish, German and Italian translations. You will have to create them before they can be translated. To do this, within your top level <code>my-cool-project</code> directory, execute the following command line code:

	<pre>		<pre>
Line 144:		Line 144:

	Once they are created, you or others who know the languages may use [https://doc.qt.io/qt-5/qtlinguist-index.html Qt Linguist] to actually translate the strings. Note that AsteroidOS uses the [https://doc.qt.io/qt-5/linguist-id-based-i18n.html id based] translation mechanism which uses <code>qsTrId</code> rather than <code>qsTr</code>.		Once they are created, you or others who know the languages may use [https://doc.qt.io/qt-5/qtlinguist-index.html Qt Linguist] to actually translate the strings. Note that AsteroidOS uses the [https://doc.qt.io/qt-5/linguist-id-based-i18n.html id based] translation mechanism which uses <code>qsTrId</code> rather than <code>qsTr</code>.

			Qt and therefore AsteroidOS also supports national language variants, so if you want to create the Argentinian Spanish version or the Great Britain English version those would be named <code>es_AR</code> and <code>en_GB</code> respectively.

	==Deploy an app from QtCreator==		==Deploy an app from QtCreator==

Beroset: /* Translations */ added why lupdate-qt5 is so named

2025-02-28T14:45:13Z

Translations: added why lupdate-qt5 is so named

← Older revision		Revision as of 14:45, 28 February 2025
Line 130:		Line 130:

	==== Translations ====		==== Translations ====
	Within the AsteroidOS project, we use Qt Linguist and Weblate to enable [[Translating AsteroidOS]] and applications within it. If you're starting on "my-cool-project", you may want to add some language translations to it. This is done using the <code>lupdate</code> tool. Because Qt5 is nearing the end of support and Qt6 has been out for a while, the tool is named <code>lupdate-qt5</code> on most Linux distributions.		Within the AsteroidOS project, we use Qt Linguist and Weblate to enable [[Translating AsteroidOS]] and applications within it. If you're starting on "my-cool-project", you may want to add some language translations to it. This is done using the <code>lupdate</code> tool. Because Qt5 is nearing the end of support and Qt6 has been out for a while, the tool is named <code>lupdate-qt5</code> to differentiate between the two tools on most Linux distributions.

	Example: Let's say that you want to start with English, French, Spanish, German and Italian translations. You will have to create them before they can be translated. To do this, within your top level <code>my-cool-project</code> directory, execute the following command line code:		Example: Let's say that you want to start with English, French, Spanish, German and Italian translations. You will have to create them before they can be translated. To do this, within your top level <code>my-cool-project</code> directory, execute the following command line code:

Beroset: Added section on translating, including how to create the .ts files for translations

2025-02-28T14:43:15Z

Added section on translating, including how to create the .ts files for translations

@@ Line 125: / Line 125: @@
 </pre>
-Try to build and deploy the app. If it wasn’t already installed, a new icon should have already appeared on asteroid-launcher.
+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].
+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==

Beroset: /* Prepare the watch to use certificates */

2024-11-16T23:13:02Z

Prepare the watch to use certificates

← Older revision		Revision as of 23:13, 16 November 2024
Line 66:		Line 66:
	ssh-copy-id -i ~/.ssh/id_rsa.pub ceres@192.168.2.15		ssh-copy-id -i ~/.ssh/id_rsa.pub ceres@192.168.2.15
	</pre>		</pre>

			==Install additional packages==
			Two other software packages must be installed on the watch for QtCreator's "Test" to pass. They are <code>base64</code> and <code>rsync</code>. The <code>base64</code> software is part of the <code>coreutils</code> package and can be installed with this command as the <code>root</code> user on the watch:

			<pre>
			opkg install coreutils
			</pre>

			The <code>rsync</code> package is, at this time, not built as part of the packages, and so it must be built using <code>bitbake</code> as described [[https://wiki.asteroidos.org/index.php/Building_AsteroidOS]]. Instead of <code>bitbake asteroid-image</code>, one can just build the <code>rsync</code> package with <code>bitbake rsync</code>.

	==Configure QtCreator for cross compilation==		==Configure QtCreator for cross compilation==

Beroset: /* Using QtCreator */

2024-11-16T22:57:14Z

Using QtCreator

← Older revision		Revision as of 22:57, 16 November 2024
Line 45:		Line 45:
	= Using QtCreator =		= Using QtCreator =

	QtCreator is an integrated development environment for making Qt QML applications.		QtCreator is an integrated development environment for making Qt QML applications. Previous versions of QtCreator allowed the use of passwords on the watch, but more recent versions require using SSH certificates. For this reason, the first thing to do is to prepare the watch to allow logging in using certificates.

			==Prepare the watch to use certificates==
			By default, there are two configured users on the watch: <code>root</code> and <code>ceres</code> both without passwords. The first step in deploying is to set up passwords for both users. This can be done by logging into the watch as each user and then running the <code>passwd</code> command to change the password. Remember each password because they will be needed later.

			The next step is to modify the <code>/etc/ssh/sshd_config</code> file on the watch. The two settings to modify are:

			<pre>
			PubkeyAuthentication yes
			PermitEmptyPasswords no
			</pre>

			Once this is done, log out and then try to log back in via <code>ssh</code>. You should be asked for the password. If so, then type in the password you just set and verify that things work.

			The next step is to generate and copy a public key from your Linux computer to the watch. Although this can, in theory, be done from within QtCreator, doing so can be difficult to debug if things don't work perfectly. For that reason, this guide will only describe the command-line method.

			First generate a key pair on the host Linux computer if there isn't already one there. This is typically done by running <code>ssh-keygen</code>. Different kinds of keys may be generated, but this example assumes an RSA key is generated. Once the key pair is created, you can deploy the public key to the watch:

			<pre>
			ssh-copy-id -i ~/.ssh/id_rsa.pub ceres@192.168.2.15
			</pre>

	==Configure QtCreator for cross compilation==		==Configure QtCreator for cross compilation==
Line 62:		Line 82:

	<ul>		<ul>
	<li>Add a new ~~Generic~~ Linux Device.</li>		<li>Add a new Remote Linux Device</li>
	<li>Name it "AsteroidOS Watch"</li>		<li>Name it "AsteroidOS Watch"</li>
	<li>Choose 192.168.2.15 as IP address</li>		<li>Choose 192.168.2.15 as IP address</li>
	<li>~~Use root~~ as ~~user~~</li>		<li>Choose 22 as the port</li>
	<li>~~Choose Password authentication and leave the password field empty~~</li>		<li>Use ceres as user</li>
	</ul>		</ul>
	<br>		<br>

Matejr5: Fixed probable typo in Environment setup QT_QPA_WAYLAND to QT_QPA_PLATFORM, allowing qtcreator to successfully deploy hello-world

2024-03-12T12:29:27Z

Fixed probable typo in Environment setup QT_QPA_WAYLAND to QT_QPA_PLATFORM, allowing qtcreator to successfully deploy hello-world

← Older revision		Revision as of 12:29, 12 March 2024
Line 117:		Line 117:
	<ul>		<ul>
	<li>Change <code>XDG_RUNTIME_DIR</code> and set its value to <code>/run/user/1000</code>. So that the invoker works under the root user</li>		<li>Change <code>XDG_RUNTIME_DIR</code> and set its value to <code>/run/user/1000</code>. So that the invoker works under the root user</li>
	<li>Add <code>~~QT_QPA_WAYLAND~~</code> and set its value to <code>wayland</code></li>		<li>Add <code>QT_QPA_PLATFORM</code> and set its value to <code>wayland</code></li>
	<li>(Optional) Add <code>QT_WAYLAND_DISABLE_WINDOWDECORATION</code> with value <code>1</code>to make the app full screen and hide the titlebar</li>		<li>(Optional) Add <code>QT_WAYLAND_DISABLE_WINDOWDECORATION</code> with value <code>1</code>to make the app full screen and hide the titlebar</li>
	</ul>		</ul>

Beroset: /* Example project */ Fixed sentence fragment.

2023-11-28T22:56:57Z

Example project: Fixed sentence fragment.

← Older revision		Revision as of 22:56, 28 November 2023
Line 41:		Line 41:
	Note that we specify the <code>CMAKE_INSTALL_PREFIX</code> in the commands above. This is to assure that the package is built to install the software in <code>/usr/lib/</code> rather than <code>/usr/local/lib/</code> which would otherwise be the default. The <code>--target package</code> instructs CMake to build a package the <code>.ipk</code> file in our case.		Note that we specify the <code>CMAKE_INSTALL_PREFIX</code> in the commands above. This is to assure that the package is built to install the software in <code>/usr/lib/</code> rather than <code>/usr/local/lib/</code> which would otherwise be the default. The <code>--target package</code> instructs CMake to build a package the <code>.ipk</code> file in our case.

	Once the software is installed, it should show up as the last item on the launcher page. Pressing the icon should show an orange background with the words "Hello World!" in white. You should make sure all of this works before ~~working~~ with		Once the software is installed, it should show up as the last item on the launcher page. Pressing the icon should show an orange background with the words "Hello World!" in white. You should make sure all of this works before going further with development.

	= Using QtCreator =		= Using QtCreator =

Beroset at 21:56, 27 November 2023

2023-11-27T21:56:57Z

← Older revision		Revision as of 21:56, 27 November 2023
Line 12:		Line 12:
	</pre>		</pre>

	If you're building for the [[Emulator]] ~~instead~~, ~~substitute~~ this ~~line for the <code>source</code> above~~:		If you're building for the [[Emulator]], use this instead:
	<pre>		<pre>
			export CMAKE_PROGRAM_PATH=/usr/local/oecore-x86_64/sysroots/core2-32-oe-linux/usr/bin
	source /usr/local/oecore-x86_64/environment-setup-core2-32-oe-linux		source /usr/local/oecore-x86_64/environment-setup-core2-32-oe-linux
			cmake -B build
			cmake --build build
	</pre>		</pre>