Watchface and Package Installation - Revision history

Dodoradio: remove outdated nightly repo warning

2024-12-17T10:47:02Z

remove outdated nightly repo warning

← Older revision		Revision as of 10:47, 17 December 2024
Line 103:		Line 103:
	opkg install asteroid-qmltester		opkg install asteroid-qmltester
	</pre>		</pre>

	~~'''Note:''' as of 10 February 2023, the nightly builds aren't quite working correctly for these extra packages. See [https://github.com/AsteroidOS/asteroid/issues/235 this open issue] for details.~~

	== Installation of local packages ==		== Installation of local packages ==

Mosen at 22:34, 4 July 2023

2023-07-04T22:34:40Z

← Older revision		Revision as of 22:34, 4 July 2023
Line 112:		Line 112:
	</pre>		</pre>
	After that you can use [[SSH]] to login and install the package		After that you can use [[SSH]] to login and install the package
	<pre>		<pre>ssh root@192.168.2.15</pre>
	ssh root@192.168.2.15		<pre>opkg install packagename.ipk</pre>
	opkg install packagename.ipk
	</pre>

	When the package is installed you can remove the installation package from your root users home-directory and close the SSH connection to your watch.		When the package is installed you can remove the installation package from your root users home-directory and close the SSH connection to your watch.
	<pre>		<pre>rm /home/root/packagename.ipk</pre>
	rm /home/root/packagename.ipk		<pre>exit</pre>
	exit
	</pre>

	== Reinstallation of local packages ==		== Reinstallation of local packages ==

Mosen: Change code to pre tags for commands

2023-06-26T22:07:46Z

Change code to pre tags for commands

Show changes

Beroset: Fixed typo in ipv4 address of watch

2023-06-25T14:38:25Z

Fixed typo in ipv4 address of watch

← Older revision		Revision as of 14:38, 25 June 2023
Line 38:		Line 38:
	Installing a watchface requires pushing the .qml file and the required assets (e.g. fonts, images, etc.) into the <code>/usr/share/asteroid-launcher/watchfaces/</code> directory on your watch.		Installing a watchface requires pushing the .qml file and the required assets (e.g. fonts, images, etc.) into the <code>/usr/share/asteroid-launcher/watchfaces/</code> directory on your watch.
	<code>		<code>
	scp watchface-name.qml root@~~19#16##~~15:/usr/share/asteroid-launcher/watchfaces/		scp watchface-name.qml root@192.168.2.15:/usr/share/asteroid-launcher/watchfaces/
	</code>		</code>
	If the watchface has additional dependencies on assets you can push them the same way.		If the watchface has additional dependencies on assets you can push them the same way.
	<code>		<code>
	scp image.png root@~~19#16##~~15:/usr/share/asteroid-launcher/watchfaces-img/		scp image.png root@192.168.2.15:/usr/share/asteroid-launcher/watchfaces-img/
	</code>		</code>
	Some watchfaces include their own font.		Some watchfaces include their own font.
	<code>		<code>
	scp fontname.ttf root@~~19#16##~~15:/usr/share/fonts/		scp fontname.ttf root@192.168.2.15:/usr/share/fonts/
	</code>		</code>

Line 80:		Line 80:

	<code>		<code>
	scp wallpapername.jpg root@~~19#16##~~15:/usr/share/asteroid-launcher/wallpapers/full/		scp wallpapername.jpg root@192.168.2.15:/usr/share/asteroid-launcher/wallpapers/full/
	</code>		</code>

Dodoradio: Added the package page from the current wiki

2023-06-17T14:07:58Z

Added the package page from the current wiki

New page

= Watchface Installation=

== Scripted method ==

Watchfaces listed in the [unofficial-watchface collection](https://github.com/AsteroidOS/unofficial-watchfaces) bring their own installation script.

To use the script you will need to clone the unofficial-watchfaces repo.

<code>
git clone https://github.com/AsteroidOS/unofficial-watchfaces
</code>

Change into the new directory.

<code>
cd unofficial-watchfaces
</code>

Execute the script with no flag to use SSH connection and SCP commands.

<code>
./watchface
</code>

Or use ADB connection and commands with the <code>-a</code> flag.

<code>
./watchface -a
</code>

These commands will display a series of text menus. To install watchfaces on your watch, choose the <code>deploy</code> option.

'''Note:''' to make sure you have the latest versions of everything, you can run <code>./watchface update</code>. This will pull the very latest versions from the web.

== Manual method ==
If you wish to install a watchface that has no installation script or is not provided as a package you may install it manually using the following instructions.

Installing a watchface requires pushing the .qml file and the required assets (e.g. fonts, images, etc.) into the <code>/usr/share/asteroid-launcher/watchfaces/</code> directory on your watch.
<code>
scp watchface-name.qml root@19#16##15:/usr/share/asteroid-launcher/watchfaces/
</code>
If the watchface has additional dependencies on assets you can push them the same way.
<code>
scp image.png root@19#16##15:/usr/share/asteroid-launcher/watchfaces-img/
</code>
Some watchfaces include their own font.
<code>
scp fontname.ttf root@19#16##15:/usr/share/fonts/
</code>

= Wallpaper Installation =

== Scripted method ==
The scripts provided in the [https://github.com/AsteroidOS/asteroid-wallpapers asteroid-wallpapers] repo aim to make adding custom wallpapers easy.

To use the script you will need to clone the [https://github.com/AsteroidOS/asteroid-wallpapers asteroid-wallpapers] repo.
<code>
git clone https://github.com/AsteroidOS/asteroid-wallpapers
</code>
Change into the new directory.
<code>
cd asteroid-wallpapers
</code>

Place jpg, jpeg, png, svg, bmp or webp wallpaper images of at least 480x480px resolution here. Then generate preview images and copy scaled versions of your wallpapers to the correct folders.
<code>
./generate-scaled-images.sh
</code>
Copy all wallpapers and preview images to a watch connected via USB/SDK Mode:
<code>
./copy-to-watch.sh
</code>
For advanced copy options execute:
<code>
./copy-to-watch.sh -h
</code>

== Manual method ==
In case you wish to quickly install a wallpaper that is not provided as a package, you can install it manually using the following command. Mind that copying a large image file might impact overall performance. Usage of the above described scripted method is highly advised.

<code>
scp wallpapername.jpg root@19#16##15:/usr/share/asteroid-launcher/wallpapers/full/
</code>

Alternatively, you may also use the <code>watchface</code> script from the [unofficial-watchface collection](https://github.com/AsteroidOS/unofficial-watchfaces). It has a command line option <code>-w</code> or <code>--wall</code> which can install a picture as wallpaper to the watch while you are installing a watchface.

<code>
./watchface --wall MyPicture.jpg deploy sporty-round-v2
</code>

= Package Installation=

While AsteroidOS has a package manager, there is currently no graphical app store.

== Installation of prebuilt packages ==
There is a [https://release.asteroidos.org/nightlies/ server] that contains the latest prebuilt image files and packages. AsteroidOS uses a version of the [https://openwrt.org/docs/guide-user/additional-software/opkg <code>opkg</code>] package manager. It's a lightweight package manager that allows the user to find, install and upgrade software that's installed on an AsteroidOS watch.

To use it to upgrade all software packages on the watch, see the instructions for how to [[Updating AsteroidOS#Upgrade using OPKG | update using opkg]].

There are also some packages that are not installed by default that might be useful to some users. For example, for developers, there is [https://github.com/MagneFire/asteroid-qmltester <code>asteroid-qmltester</code>] that provides a very handy way to test out QML code on the watch or in the emulator. Installing it is simple from the command line as root on the watch.

<code>
opkg install asteroid-qmltester
</code>

'''Note:''' as of 10 February 2023, the nightly builds aren't quite working correctly for these extra packages. See [https://github.com/AsteroidOS/asteroid/issues/235 this open issue] for details.

== Installation of local packages ==
Before you can install the package you need to push it to the watch.
<code>
scp packagename.ipk root@192.168.2.15:/home/root
</code>
After that you can use [[SSH]] to login and install the package
<code>
ssh root@192.168.2.15
opkg install packagename.ipk
</code>

When the package is installed you can remove the installation package from your root users home-directory and close the SSH connection to your watch.
<code>
rm /home/root/packagename.ipk
exit
</code>

== Reinstallation of local packages ==
If you need to reinstall a package you can add the <code>--force-reinstall</code> flag to the opkg command.
<code>
opkg install --force-reinstall packagename.ipk
</code>

== Troubleshooting==

=== Missing dependencies detected during package install ===

The package you are trying to install may depend on other packages and their versions. You can install the dependencies first, add the <code>--force-depends</code> flag to your install command to ignore dependencies or decide to not install the package. Ignoring the dependencies can lead to broken or unstable packages.
<code>
opkg install --force-depends packagename.ipk
</code>