1
0
Fork 0
Commit graph

68 commits

Author SHA1 Message Date
Brendan M. Sleight
cec8d97aeb 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-10 20:55:18 +00:00
Daniel Thompson
8940b7c3ab steplogger: Introduce code to perform data logging
The code is not yet enabled by default but it can be tested by adding
custom code to an interested user's main.py .

Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-02-21 20:27:48 +00:00
Daniel Thompson
2954c3b356 docs: install: Document the binary releases
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-02-20 11:49:27 +00:00
Shuhao Wu
268f8c06e9 Added Docker setup to build wasp-os.
This should make it a bit easier for people to contribute. Also fixed
the documentations on how to setup on Debian, as certain recommended
packages don't exist.

Signed-off-by: Shuhao Wu <shuhao@shuhaowu.com>
2021-02-20 08:44:22 +00:00
Daniel Thompson
a0ee26a412 docs: install: Fix typo in apt-get line for buster
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-02-11 18:53:13 +00:00
Daniel Thompson
a5b2e5ec69 install: Correct the wasptool dependencies
Fixes: a1b1502d92 ("install: Include the wasptool dependencies in the install guide")
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-02-03 18:01:17 +00:00
Daniel Thompson
a1b1502d92 install: Include the wasptool dependencies in the install guide
Fixes: #159
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-01-30 12:55:28 +00:00
Daniel Thompson
5170b97491 docs: appguide: Document how to upload pre-compiled files
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-01-17 14:55:57 +00:00
Daniel Thompson
2805c1f84e docs: install: Clarify watch mode during updates
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-01-16 09:44:43 +00:00
Daniel Thompson
727bc8c685 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 22:06:26 +00:00
Daniel Thompson
39d8783055 simulator: test_qa: Add some basic docstring tests
This one picked up a lot of inconsistancy so the changes here are pretty
big.

Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-01-13 21:51:17 +00:00
Daniel Thompson
f7ef165433 simulator: test_qa: Check that apps are includes in the library
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-01-12 22:33:25 +00:00
Miguel Rochefort
ffff5ae52b 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-10 18:14:36 +00:00
Wolfgang Ginolas
5b74c45e58 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>
2021-01-10 16:02:35 +00:00
Daniel Thompson
4e9a576a2d docs: Add some main.py examples
These still need to be integrated into the generated documentation but
there were included in the most recent wasp-os video so let's get them
into the source code.

Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-01-10 15:19:42 +00:00
Daniel Thompson
3813eb2911 manager: Enable Software by default
Enabling software by default allows us disable several other applications
by default because there is now a GUI based route to enable them.

This does require a few tweaks to the test suite and allows allows us to
remove a lot of boilerplate text from the application library document
since it is no longer relavent.

Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-01-03 14:59:14 +00:00
Daniel Thompson
726d5c8554 apps: chrono: Implement a simple analogue watch face
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-12-27 09:13:49 +00:00
Daniel Thompson
f1f5cc9e0c simulator: Introduce fully automatic testint
Currently the tests do little more than fire up the simulator and
switch into (and out of) the built in applications. However this is
useful and allows us to fully integrate as a CI job.

Unfortunately the numpy warning from pysdl2 mean we have been forced
to disable all warnings to prevent pytest from collecting and reporting
them.

Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-12-04 20:11:41 +00:00
Johannes Wache
e450ccf9f0 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-29 20:08:59 +00:00
Daniel Thompson
bdd3f91b77 github: actions: Ensure warning free docs build
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-29 20:01:21 +00:00
Daniel Thompson
233c136a5c 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 19:14:31 +00:00
Daniel Thompson
02d5d8ca28 docs: Makefile: Turn sphinx warnings into errors
Currently patches that break the documentation build are not triggering
CI failure. Fix this.

Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-29 19:14:03 +00:00
Maarten de Jong
02777d5dff Add wget to build dependencies
Signed-off-by: Maarten de Jong <accounts@arteeh.com>
2020-11-26 19:18:04 +00:00
Daniel Thompson
21245bf918 docs: contributing: Add a simple style guide
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-26 18:56:58 +00:00
Daniel Thompson
2a7df82864 docs: install: Update install requirements
Some of the new reloader features require additonal python modules.

Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-22 12:01:03 +00:00
Daniel Thompson
748e5fe65a docs: Wordsmtithing updates after review
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-22 09:25:24 +00:00
Daniel Thompson
6f0238415f 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 09:22:50 +00:00
Daniel Thompson
aeda73ad90 docs: install: Update for newer PineTime devices
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-14 20:07:42 +00:00
Daniel Thompson
06f1ed36b0 docs: Add an Application Library chapter
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-08 14:28:38 +00:00
Daniel Thompson
7015dc0023 docs: install: Fix error message during documentation generation
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-08 12:42:17 +00:00
Daniel Thompson
7ebc361e58 docs: refman: Add the fibonacci clock to the reference manual
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-08 12:41:58 +00:00
Sergio Schvezov
3423039d35 docs: update building from source apt dependencies
The softdevice make target requires unzip

Signed-off-by: Sergio Schvezov <sergio.schvezov@ubuntu.com>
2020-11-06 22:18:05 +00:00
Daniel Thompson
6890a52502 docs: install: Describe unsupported step counter in P8a
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-09-16 21:59:47 +01:00
Daniel Thompson
fa1515487d docs: install: Add a troubleshooting guide
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-08-30 09:10:08 +01:00
Daniel Thompson
6ae968a017 docs: Update after review (and add K9)
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-08-27 17:11:21 +01:00
Panagiotis Vasilopoulos
5aa07e13a5 docs: install: Add instruction for installing modules with pip
Signed-off-by: Panagiotis Vasilopoulos <hello@alwayslivid.com>
2020-08-19 20:14:26 +01:00
Daniel Thompson
8ceda3451d contributing: Added a git quick fix howto
Suggested-by: Panagiotis Vasilopoulos <hello@alwayslivid.com>
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-08-15 08:34:35 +01:00
Daniel Thompson
7d0fc8100a docs: Add a contributors guide
Mostly this is adopting policies (both DCO and Contributor Covenent)
that are commonly used by other projects...

Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-08-14 20:36:01 +01:00
Daniel Thompson
66e8d3e58a docs: install: Move Building from source into the install guide
Direct links to the install guide mean some people are reading the docs
but never see the main docs index and, as a result, don't find the
instructions on how to build from source. Let's fix that!

Fixes: #49
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-07-31 16:47:08 +01:00
Daniel Thompson
9c9a508580 install: Improve formating, add links and other good stuff
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-07-30 22:41:39 +01:00
Daniel Thompson
c3d9e3a0a2 install: Initial attempt at an install guide
More work needed... but a step up from the current text in the README.

Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-07-29 22:19:52 +01:00
Daniel Thompson
c87bcd8693 docs: Introduce project logo
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-07-09 22:28:43 +01:00
Daniel Thompson
5d2ca4a8ee README: Better document how to meet the dependancies
Fixes: #1
Fixes: #3
2020-05-20 21:55:11 +01:00
Daniel Thompson
56b39d6404 README/TODO: Switch to restructured text 2020-05-15 19:55:18 +01:00
Daniel Thompson
6989eaf6a6
docs: Experimental workaround for readthedocs.org 2020-05-15 12:14:28 +01:00
Daniel Thompson
e391480b50 wasp: watch: docstrings for the watch namespace 2020-05-14 23:22:57 +01:00
Daniel Thompson
d11e6eb4a1 Make wasp-os namig consistant
Rename WASP to wasp-os (or Wasp-os)
2020-05-14 22:41:05 +01:00
Daniel Thompson
b8efcd3053 wasp: Even more docstrings 2020-05-14 22:29:35 +01:00
Daniel Thompson
f07fb6d22a wasp: draw565: docstrings for headings and __init__ 2020-05-14 21:44:05 +01:00
Daniel Thompson
42fe7bf352 drivers: vibrator: Finalize docstrings 2020-05-14 21:42:16 +01:00