Skip to content

Commit 425b056

Browse files
thomasjballthomasjball
committed
ui description
1 parent 5c5f070 commit 425b056

9 files changed

Lines changed: 51 additions & 20 deletions

File tree

‎.astro/content-modules.mjs‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11

22
export default new Map([
3+
["src/content/docs/index.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Findex.mdx&astroContentModuleFlag=true")],
4+
["src/content/docs/apps/display-shield-ui.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fapps%2Fdisplay-shield-ui.mdx&astroContentModuleFlag=true")],
35
["src/content/docs/apps/microcode.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fapps%2Fmicrocode.mdx&astroContentModuleFlag=true")],
46
["src/content/docs/apps/microdata.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fapps%2Fmicrodata.mdx&astroContentModuleFlag=true")],
5-
["src/content/docs/extensions/display-shield-ext.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fextensions%2Fdisplay-shield-ext.mdx&astroContentModuleFlag=true")],
6-
["src/content/docs/index.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Findex.mdx&astroContentModuleFlag=true")],
77
["src/content/docs/getting-started/display-shields.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fgetting-started%2Fdisplay-shields.mdx&astroContentModuleFlag=true")],
88
["src/content/docs/getting-started/intro.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fgetting-started%2Fintro.mdx&astroContentModuleFlag=true")],
9+
["src/content/docs/extensions/display-shield-ext.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fextensions%2Fdisplay-shield-ext.mdx&astroContentModuleFlag=true")],
910
["src/content/docs/resources/faq.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fresources%2Ffaq.mdx&astroContentModuleFlag=true")],
1011
["src/content/docs/resources/troubleshooting.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fresources%2Ftroubleshooting.mdx&astroContentModuleFlag=true")]]);
1112

‎.astro/data-store.json‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎README.md‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,12 @@ Home page for micro:bit apps
44
This repo contains the astro starlight for the micro:bit app home page.
55
It provides basic information about the first two micro:bit apps: MicroCode and
66
MicroData, which are described more fully in the sibling directories
7-
`../microcode-v2` and `../microdata`.
7+
`../microcode-v2` and `../microdata`.
8+
9+
# TODO
10+
11+
- user interface and input mechanisms
12+
- in web app
13+
- on hardware
14+
15+

‎astro.config.mjs‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ export default defineConfig({
4545
items: [
4646
{ label: "MicroCode", link: "/apps/microcode/" },
4747
{ label: "MicroData", link: "/apps/microdata/" },
48+
{ label: "Display shield UI", link: "/apps/display-shield-ui"}
4849
],
4950
},
5051
{

‎src/assets/ui-shield.png‎

1.16 MB
Loading

‎src/content/docs/apps/display-shield-ui.mdx‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: Display shield UI
3+
description: How to work with the display shield
4+
---
5+
6+
## Working with the display shield
7+
8+
Once you have downloaded the app to your micro:bit, plug it into the display shield.
9+
See the [display shield overview](/getting-started/display-shields/) to see how
10+
the micro:bit fits into the shield.
11+
12+
Most display shields have a built-in battery. Turn on the power switch on the display
13+
shield to power both the shield and the micro:bit.
14+
15+
You can also power the micro:bit and shield directly via USB plugged into the micro:bit
16+
or the display shield.
17+
18+
## User interface
19+
20+
The display shields have a 4-way directional pad (d-pad) or 4 buttons
21+
arrange in a diamond, to the left of the screen. To the right of
22+
the screen are the A and B buttons. The d-pad is used to move
23+
the cursor in the UI up/down/left/right. The A button is used to
24+
select the current element the cursor is on. The B button is used
25+
to back out of a screen or dialog.
26+
27+
![shield UI](../../../assets/ui-shield.png)

‎src/content/docs/apps/microcode.mdx‎

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -24,21 +24,12 @@ MicroCode provides an intuitive interface for programming your micro:bit with:
2424
- [Open MicroCode](https://makecode.microbit.org/beta/#pub:67966-39882-94798-31344) in
2525
a web browser.
2626
- Explore MicroCode via the simulator. Click on the full-screen icon in the simulator to
27-
get the best experience.
27+
get the best experience.
28+
- After bringing focus to the display shield simulator, use the arrow
29+
keys to navigate, the A key to select and the B key to back up.
2830
- Download the code to your micro:bit by clicking the "Download" button in the MakeCode editor
29-
and following instructions on how to copy MicroCode onto your micro:bit.
30-
31-
## Working with the display shield
32-
33-
Once you have downloaded the app to your micro:bit, plug it into the display shield.
34-
See the [display shield overview](/getting-started/display-shields/) to see how
35-
the micro:bit fits into the shield.
36-
37-
Most display shields have a built-in battery. Turn on the power switch on the display
38-
shield to power both the shield and the micro:bit.
39-
40-
You can also power the micro:bit and shield directly via USB plugged into the micro:bit
41-
or the display shield.
31+
and follow the instructions on how to copy MicroCode onto your micro:bit.
32+
- [See the display shield instructions](../display-shield-ui)
4233

4334
## Learn More
4435

‎src/content/docs/apps/microdata.mdx‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,11 @@ MicroData provides tools for collecting, visualizing, and analyzing sensor data
2828
a web browser.
2929
- Explore MicroData via the simulator. Click on the full-screen icon in the simulator to
3030
get the best experience.
31+
- After bringing focus to the display shield simulator, use the arrow
32+
keys to navigate, the A key to select and the B key to back up.
3133
- Download the code to your micro:bit by clicking the "Download" button in the MakeCode editor
3234
and following instructions on how to copy MicroData onto your micro:bit.
35+
- [See the display shield instructions](../display-shield-ui)
3336

3437
## Working with the display shield
3538

‎src/content/docs/index.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Welcome to Micro:bit Apps
3-
description: Discover a collection of innovative applications and educational resources for the BBC micro:bit
2+
title: Micro:bit Apps
3+
description: Discover a collection of innovative applications for the BBC micro:bit
44
---
55

66
Explore engaging micro:bit apps designed to enhance learning and creativity.

0 commit comments

Comments
 (0)