pinetime/wasp-os
1
0
Fork 0
Code Activity
wasp-os/docs/apps.rst

84 lines
1.1 KiB
ReStructuredText
Raw Normal View History

docs: Add an Application Library chapter Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-08 15:28:38 +01:00
.. _Application Library:
Application Library
===================
.. contents::
:local:
docs: Move all applications out of the reference guide The auto-generated application docs isn't really worthy of the reference guide. There's too many methods described as "draws the screen" and this simply doesn't add anything over the template application includes in the application writer's guide. Move everything over into the Application Library. Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-01-13 23:06:26 +01:00
Watch faces
-----------
apps: FacesApp: Add a watch face chooser This app is enabled by default and allows users to select a watch face based on a fullscreen preview of how the app will draw the screen. Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-06-20 11:28:27 +02:00
.. automodule:: apps.faces
docs: Move all applications out of the reference guide The auto-generated application docs isn't really worthy of the reference guide. There's too many methods described as "draws the screen" and this simply doesn't add anything over the template application includes in the application writer's guide. Move everything over into the Application Library. Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-01-13 23:06:26 +01:00
.. automodule:: apps.clock
.. automodule:: apps.chrono
apps: Add DualClock app. Signed-off-by: Benoît HERVIER <b@rvier.fr> [daniel@redfelineninja.org.uk: Removed unused dual clock fonts from clock_dual.py, fixed up the manifest] Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-03-03 21:41:11 +01:00
.. automodule:: apps.dual_clock
docs: Move all applications out of the reference guide The auto-generated application docs isn't really worthy of the reference guide. There's too many methods described as "draws the screen" and this simply doesn't add anything over the template application includes in the application writer's guide. Move everything over into the Application Library. Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-01-13 23:06:26 +01:00
.. automodule:: apps.fibonacci_clock
Add watchface with weekday * Allow overriding of date string in clock.py * Override it to display the weekday in week_clock.py Signed-off-by: Francesco Gazzetta <fgaz@fgaz.me>
2021-12-31 19:16:12 +01:00
.. automodule:: apps.week_clock
apps: WordClock: Add a new word-based clock app Signed-off-by: Brendan M. Sleight <bms.git@barwap.com> [daniel@redfelineninja.org.uk: Squashed down into a single commit and updated subject] Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk
2021-03-05 20:43:06 +01:00
.. automodule:: apps.word_clock
docs: Add an Application Library chapter Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-08 15:28:38 +01:00
Built-in
--------
docs: Move all applications out of the reference guide The auto-generated application docs isn't really worthy of the reference guide. There's too many methods described as "draws the screen" and this simply doesn't add anything over the template application includes in the application writer's guide. Move everything over into the Application Library. Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-01-13 23:06:26 +01:00
.. automodule:: apps.heart
docs: Add an Application Library chapter Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-08 15:28:38 +01:00
docs: Move all applications out of the reference guide The auto-generated application docs isn't really worthy of the reference guide. There's too many methods described as "draws the screen" and this simply doesn't add anything over the template application includes in the application writer's guide. Move everything over into the Application Library. Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-01-13 23:06:26 +01:00
.. automodule:: apps.stopwatch
docs: Add an Application Library chapter Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-08 15:28:38 +01:00
docs: Move all applications out of the reference guide The auto-generated application docs isn't really worthy of the reference guide. There's too many methods described as "draws the screen" and this simply doesn't add anything over the template application includes in the application writer's guide. Move everything over into the Application Library. Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-01-13 23:06:26 +01:00
.. automodule:: apps.steps
docs: Add an Application Library chapter Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-08 15:28:38 +01:00
docs: Move all applications out of the reference guide The auto-generated application docs isn't really worthy of the reference guide. There's too many methods described as "draws the screen" and this simply doesn't add anything over the template application includes in the application writer's guide. Move everything over into the Application Library. Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-01-13 23:06:26 +01:00
.. automodule:: apps.launcher
apps: chrono: Implement a simple analogue watch face Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-12-27 10:13:49 +01:00
docs: Move all applications out of the reference guide The auto-generated application docs isn't really worthy of the reference guide. There's too many methods described as "draws the screen" and this simply doesn't add anything over the template application includes in the application writer's guide. Move everything over into the Application Library. Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-01-13 23:06:26 +01:00
.. automodule:: apps.settings
.. automodule:: apps.software
.. automodule:: apps.pager
docs: Add an Application Library chapter Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-08 15:28:38 +01:00
simulator: test_qa: Check that apps are includes in the library Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-01-12 23:33:25 +01:00
Applications
------------
docs: Add an Application Library chapter Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-08 15:28:38 +01:00
simulator: test_qa: Check that apps are includes in the library Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-01-12 23:33:25 +01:00
.. automodule:: apps.alarm
apps: play2048: Add the 2048 game application 2048 is a popular sliding block puzzle game in which tiles are combined to make the number 2048. It's one of the few games that are enjoyable to play on such a small form factor. This started as a port of a TkInter implementation of the 2048 game. I implemented all of the TkInter APIs used by the game and it worked on wasp-os without any code change in the game. However, the performance was very poor and it consumed too much RAM. I have since reimplemented the whole game from scratch and managed to achieve acceptable performance, although more improvements could still be made. Because names in Python can't start with numbers, I had some trouble naming things. The module is called "ttfe" (two-thousand-forty-eight), the class name is Play2048App, and the software.py entry is "Play 2048". Signed-off-by: Miguel Rochefort <miguelrochefort@gmail.com> [daniel@redfelineninja.org.uk: Renamed the python filename, normalized the screenshot and included the app in the docs] Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-01-05 04:12:39 +01:00
Add beacon app Signed-off-by: Francesco Gazzetta <fgaz@fgaz.me>
2021-11-20 17:41:34 +01:00
.. automodule:: Beacon
simulator: test_qa: Check that apps are includes in the library Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-01-12 23:33:25 +01:00
.. automodule:: apps.calc
apps: snake: Add a snake game application Signed-off-by: Johannes Wache <jbwa@posteo.de> [daniel@redfelineninja.org.uk: Removed some couple of unwanted merge artifacts] Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-27 11:39:40 +01:00
apps: DemoApp: Fully document the demo app The demo app is of somewhat niche interest and is disabled by default but arguable that makes it more important to document it fully since this app is harder to find the many others. Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-06-20 11:43:25 +02:00
.. automodule:: apps.demo
Add DisaBLE app that disables bluetooth Signed-off-by: Francesco Gazzetta <fgaz@fgaz.me>
2021-11-24 20:06:08 +01:00
.. automodule:: apps.disaBLE
simulator: test_qa: Check that apps are includes in the library Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-01-12 23:33:25 +01:00
.. automodule:: apps.flashlight
apps: music: Add to application index Additionally we rename the screenshot to conform to the naming convention (app.NAME + 'App.png') used for simulator screenshots. Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-22 10:22:50 +01:00
Include the gallery app in micropython.zip ...and move GameOfLife out to make space The gallery app needs too much memory to run from bytecode, and has to be frozen in micropython.zip instead Signed-off-by: Francesco Gazzetta <fgaz@fgaz.me>
2022-03-21 11:54:08 +01:00
.. automodule:: apps.gallery
Add gallery app Signed-off-by: Francesco Gazzetta <fgaz@fgaz.me>
2021-09-20 16:07:16 +02:00
simulator: test_qa: Check that apps are includes in the library Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-01-12 23:33:25 +01:00
.. automodule:: apps.haiku
apps: alarm: Add the alarm app to the library Like the other library applications this is enabled in the simulator and included in the flash image but is disabled by default to conserve RAM (and to give time to new apps to mature and receive improvements). Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-29 13:23:05 +01:00
Add level app Signed-off-by: Francesco Gazzetta <fgaz@fgaz.me>
2021-11-20 14:27:19 +01:00
.. automodule:: Level
Remove morse from default apps Even after optimizing it, it makes the image 224 bytes too big. Signed-off-by: Francesco Gazzetta <fgaz@fgaz.me>
2021-09-20 16:09:47 +02:00
.. automodule:: Morse
Add morse app Signed-off-by: Francesco Gazzetta <fgaz@fgaz.me>
2021-09-09 14:40:09 +02:00
apps: music: Add to application index Additionally we rename the screenshot to conform to the naming convention (app.NAME + 'App.png') used for simulator screenshots. Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-22 10:22:50 +01:00
.. automodule:: apps.musicplayer
apps: timer: Add a countdown timer application Signed-off-by: Wolfgang Ginolas <wolfgang.ginolas@gwif.eu> [daniel@redfelineninja.org.uk: squashed into a single commit, rebase to latest master, integrate with the Software application and rename the screenshots to match the application name] Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-12-31 17:18:13 +01:00
apps: SportsApp: Initial sports app implementation This app is functional... although it lacking in almost every costmetic way, from the icon to the main screen. Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-06-20 18:24:10 +02:00
.. automodule:: apps.sports
simulator: test_qa: Check that apps are includes in the library Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-01-12 23:33:25 +01:00
.. automodule:: apps.testapp
apps: timer: Add a countdown timer application Signed-off-by: Wolfgang Ginolas <wolfgang.ginolas@gwif.eu> [daniel@redfelineninja.org.uk: squashed into a single commit, rebase to latest master, integrate with the Software application and rename the screenshots to match the application name] Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-12-31 17:18:13 +01:00
.. automodule:: apps.timer
simulator: test_qa: Check that apps are includes in the library Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-01-12 23:33:25 +01:00
Added weather application. Signed-off-by: Tait Berlette <54515877+taitberlette@users.noreply.github.com>
2021-03-31 01:10:24 +02:00
.. automodule:: apps.weather
simulator: test_qa: Check that apps are includes in the library Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-01-12 23:33:25 +01:00
Games
-----
Include the gallery app in micropython.zip ...and move GameOfLife out to make space The gallery app needs too much memory to run from bytecode, and has to be frozen in micropython.zip instead Signed-off-by: Francesco Gazzetta <fgaz@fgaz.me>
2022-03-21 11:54:08 +01:00
.. automodule:: GameOfLife
simulator: test_qa: Check that apps are includes in the library Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-01-12 23:33:25 +01:00
.. automodule:: apps.play2048
.. automodule:: apps.snake
Copy permalink