summaryrefslogtreecommitdiff
path: root/wasp
diff options
context:
space:
mode:
authorDaniel Thompson <daniel@redfelineninja.org.uk>2021-06-20 09:43:25 (GMT)
committerDaniel Thompson <daniel@redfelineninja.org.uk>2021-06-20 09:43:25 (GMT)
commitb6709997ccc3ff66cc73e01503edda128e130143 (patch)
treeca55d6c449386e32b139ba2bd699f3d4a573e683 /wasp
parent1a4b678b2b815884cb712244d8a1b5e50a5cbd86 (diff)
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>
Diffstat (limited to 'wasp')
-rw-r--r--wasp/apps/demo.py13
-rw-r--r--wasp/boards/simulator/test_qa.py2
2 files changed, 14 insertions, 1 deletions
diff --git a/wasp/apps/demo.py b/wasp/apps/demo.py
index 17b31c6..b49655c 100644
--- a/wasp/apps/demo.py
+++ b/wasp/apps/demo.py
@@ -8,6 +8,19 @@ This demo is simply an alternating sweep of the Pine64 and
MicroPython logos. It cycles through a variety of colours
and swaps between the logos every 5 images (so if you change
anything make sure len(colors) is not a multiple of 5).
+
+.. figure:: res/DemoApp.png
+ :width: 179
+
+The demo also includes code to keep the devie awake making it
+suitable to run as an always-on application to demonstrate wasp-os at
+conferences and shows.
+
+.. note::
+
+ Due to it's niche purpose and relatively large size this app is not
+ included by default in the flash images. It must be separately installed
+ and enabled.
"""
import wasp
diff --git a/wasp/boards/simulator/test_qa.py b/wasp/boards/simulator/test_qa.py
index 7f38995..04dab15 100644
--- a/wasp/boards/simulator/test_qa.py
+++ b/wasp/boards/simulator/test_qa.py
@@ -3,7 +3,7 @@ import wasp
import importlib
import os
-EXCLUDE = ('Notifications', 'Template', 'Demo', 'Faces')
+EXCLUDE = ('Notifications', 'Template', 'Faces')
def test_README(constructor):
if constructor.NAME in EXCLUDE: