From 89406330cff1989b3500584c4d7ee6b9b2987ef4 Mon Sep 17 00:00:00 2001 From: Peli de Halleux Date: Tue, 1 Nov 2016 17:44:37 -0700 Subject: [PATCH] rename micro:bit to @boardname@ --- docs/_locales/pl/_theme.json | 22 ----- docs/_locales/pl/docs.md | 7 -- docs/docs.md | 2 +- docs/getting-started.md | 2 +- docs/getting-started/buttons.md | 6 +- docs/getting-started/coin-flipper.md | 2 +- docs/getting-started/rock-paper-scissors.md | 16 ++-- docs/getting-started/screen.md | 4 +- docs/getting-started/shake.md | 4 +- docs/javascript.md | 3 +- docs/js/call.md | 6 +- docs/js/classes.md | 2 +- docs/js/faq.md | 4 +- docs/js/functions.md | 2 +- docs/js/operators.md | 4 +- docs/js/sequence.md | 2 +- docs/js/statements.md | 2 +- docs/js/types.md | 6 +- docs/lessons/answering-machine/activity.md | 2 +- docs/lessons/answering-machine/challenges.md | 4 +- .../lessons/answering-machine/quiz-answers.md | 4 +- docs/lessons/answering-machine/quiz.md | 4 +- docs/lessons/beautiful-image.md | 2 +- docs/lessons/beautiful-image/challenges.md | 2 +- docs/lessons/charting.md | 4 +- docs/lessons/charting/activity.md | 16 ++-- docs/lessons/charting/challenge.md | 20 ++--- docs/lessons/charting/quiz-answers.md | 4 +- docs/lessons/charting/quiz.md | 4 +- docs/lessons/compass/activity.md | 14 +-- docs/lessons/compass/challenges.md | 2 +- docs/lessons/compass/quiz-answers.md | 8 +- docs/lessons/compass/quiz.md | 6 +- docs/lessons/counter/challenges.md | 2 +- docs/lessons/counter/quiz-answers.md | 2 +- docs/lessons/dice-roll/activity.md | 4 +- docs/lessons/dice-roll/challenges.md | 2 +- docs/lessons/digi-yoyo/challenges.md | 2 +- docs/lessons/flashing-heart/activity.md | 2 +- docs/lessons/game-counter/challenges.md | 2 +- docs/lessons/game-of-chance/activity.md | 2 +- docs/lessons/game-of-chance/challenges.md | 2 +- docs/lessons/glowing-pendulum/activity.md | 6 +- docs/lessons/glowing-pendulum/challenges.md | 4 +- docs/lessons/guess-the-number/quiz-answers.md | 4 +- docs/lessons/guess-the-number/quiz.md | 2 +- docs/lessons/happy-birthday/activity.md | 4 +- docs/lessons/happy-birthday/challenges.md | 2 +- docs/lessons/hero/activity.md | 4 +- docs/lessons/love-meter/activity.md | 6 +- docs/lessons/love-meter/challenges.md | 2 +- docs/lessons/love-meter/quiz-answers.md | 2 +- docs/lessons/love-meter/quiz.md | 2 +- docs/lessons/lucky-7/quiz-answers.md | 4 +- docs/lessons/lucky-7/quiz.md | 4 +- docs/lessons/magic-8/activity.md | 4 +- docs/lessons/magic-8/tutorial.md | 2 +- docs/lessons/magic-logo.md | 8 +- docs/lessons/magic-logo/activity.md | 6 +- docs/lessons/night-light/activity.md | 4 +- docs/lessons/pogo/activity.md | 14 +-- docs/lessons/rotation-animation/quiz.md | 2 +- docs/lessons/screen-wipe/activity.md | 6 +- docs/lessons/screen-wipe/quiz-answers.md | 2 +- docs/lessons/seismograph/activity.md | 36 ++++---- docs/lessons/seismograph/challenge.md | 34 +++---- docs/lessons/smiley/quiz-answers.md | 2 +- docs/lessons/spinner/activity.md | 2 +- docs/lessons/strobe-light/activity.md | 4 +- docs/lessons/temperature.md | 4 +- docs/lessons/temperature/activity.md | 6 +- docs/lessons/truth-or-dare/activity.md | 4 +- docs/lessons/truth-or-dare/challenges.md | 4 +- docs/lessons/truth-or-dare/tutorial.md | 4 +- docs/lessons/zoomer.md | 2 +- docs/lessons/zoomer/activity.md | 4 +- docs/lessons/zoomer/quiz-answers.md | 2 +- docs/lessons/zoomer/quiz.md | 2 +- docs/packages.md | 2 +- docs/projects.md | 6 +- docs/projects/banana-keyboard.md | 4 +- docs/projects/banana-keyboard/making.md | 10 +-- docs/projects/compass.md | 14 +-- docs/projects/guitar.md | 8 +- docs/projects/guitar/accelerometer.md | 20 ++--- docs/projects/guitar/displaybuttons.md | 22 ++--- docs/projects/guitar/lightsensor.md | 10 +-- docs/projects/guitar/making.md | 4 +- docs/projects/guitar/pinpress.md | 12 +-- docs/projects/hack-your-headphones.md | 4 +- docs/projects/hack-your-headphones/making.md | 10 +-- .../hack-your-headphones/music-of-light.md | 2 +- docs/projects/magic-button-trick.md | 18 ++-- docs/projects/radio-challenges.md | 20 ++--- docs/projects/radio.md | 16 ++-- docs/projects/rock-paper-scissors.md | 16 ++-- docs/projects/telegraph.md | 4 +- docs/projects/telegraph/making.md | 20 ++--- docs/projects/telegraph/manual-telegraph.md | 4 +- docs/projects/the-watch.md | 14 +-- docs/projects/timing-gates.md | 22 ++--- docs/reference/basic.md | 2 +- docs/reference/basic/forever.md | 2 +- docs/reference/bluetooth.md | 4 +- docs/reference/bluetooth/about-bluetooth.md | 22 ++--- docs/reference/bluetooth/bluetooth-pairing.md | 90 +++++++++---------- .../bluetooth/on-bluetooth-connected.md | 8 +- .../bluetooth/on-bluetooth-disconnected.md | 10 +-- .../bluetooth/start-accelerometer-service.md | 12 +-- .../bluetooth/start-button-service.md | 12 +-- .../bluetooth/start-io-pin-service.md | 10 +-- docs/reference/bluetooth/start-led-service.md | 12 +-- .../bluetooth/start-magnetometer-service.md | 10 +-- .../bluetooth/start-temperature-service.md | 12 +-- .../reference/bluetooth/start-uart-service.md | 14 +-- docs/reference/bluetooth/uart-read-until.md | 10 +-- docs/reference/bluetooth/uart-write-number.md | 10 +-- docs/reference/bluetooth/uart-write-string.md | 10 +-- docs/reference/bluetooth/uart-write-value.md | 10 +-- docs/reference/control/device-name.md | 2 +- .../reference/control/device-serial-number.md | 2 +- docs/reference/control/event-source-id.md | 2 +- docs/reference/control/event-timestamp.md | 2 +- docs/reference/control/event-value-id.md | 2 +- docs/reference/control/event-value.md | 2 +- docs/reference/control/in-background.md | 2 +- docs/reference/control/on-event.md | 2 +- docs/reference/control/raise-event.md | 2 +- docs/reference/control/reset.md | 6 +- docs/reference/devices/on-gamepad-button.md | 4 +- docs/reference/images/create-big-image.md | 2 +- docs/reference/images/create-image.md | 2 +- docs/reference/images/image.md | 2 +- docs/reference/images/show-image.md | 4 +- docs/reference/input/acceleration.md | 6 +- docs/reference/input/button-is-pressed.md | 2 +- docs/reference/input/compass-heading.md | 12 +-- docs/reference/input/light-level.md | 4 +- docs/reference/input/magnetic-force.md | 6 +- docs/reference/input/on-gesture.md | 6 +- docs/reference/input/on-pin-pressed.md | 6 +- docs/reference/input/on-pin-released.md | 6 +- docs/reference/input/pin-is-pressed.md | 2 +- docs/reference/input/rotation.md | 10 +-- .../input/set-accelerometer-range.md | 8 +- docs/reference/input/temperature.md | 14 +-- docs/reference/led/plot-bar-graph.md | 6 +- docs/reference/music/beat.md | 2 +- docs/reference/music/change-tempo-by.md | 4 +- docs/reference/music/play-tone.md | 4 +- docs/reference/music/rest.md | 4 +- docs/reference/music/ring-tone.md | 8 +- docs/reference/music/set-tempo.md | 4 +- docs/reference/music/tempo.md | 2 +- docs/reference/pins/analog-pitch.md | 2 +- docs/reference/pins/analog-read-pin.md | 4 +- docs/reference/pins/analog-set-period.md | 2 +- docs/reference/pins/analog-set-pitch-pin.md | 2 +- docs/reference/pins/analog-write-pin.md | 2 +- docs/reference/pins/digital-read-pin.md | 12 +-- docs/reference/pins/digital-write-pin.md | 10 +-- docs/reference/pins/on-pulsed.md | 2 +- docs/reference/pins/pulse-in.md | 2 +- docs/reference/pins/set-pull.md | 6 +- .../radio/on-data-packet-received.md | 10 +-- docs/reference/radio/on-data-received.md | 6 +- docs/reference/radio/packet.md | 4 +- docs/reference/radio/receive-number.md | 6 +- docs/reference/radio/receive-string.md | 8 +- .../radio/received-signal-strength.md | 4 +- docs/reference/radio/send-number.md | 6 +- docs/reference/radio/send-string.md | 6 +- docs/reference/radio/send-value.md | 6 +- docs/reference/radio/set-group.md | 6 +- docs/reference/radio/set-transmit-power.md | 8 +- .../radio/write-received-packet-to-serial.md | 2 +- docs/reference/radio/write-value-to-serial.md | 2 +- docs/reference/serial/write-value.md | 2 +- docs/reference/types.md | 2 +- docs/reference/types/string.md | 2 +- docs/release-notes.md | 25 ------ docs/streaming.md | 8 +- docs/uploader.md | 8 +- olddocs/js/compiler.md | 2 +- olddocs/js/contents.md | 6 +- olddocs/js/guides/basic-led-show.md | 2 +- olddocs/js/guides/blink-symbols.md | 2 +- olddocs/js/guides/scroll-image-docs.md | 2 +- olddocs/js/guides/touchdevelop-lessons.md | 6 +- olddocs/js/image.md | 2 +- .../js/lessons/accelerometer/challenges.md | 4 +- olddocs/js/lessons/boxer-mania/challenges.md | 2 +- .../js/lessons/compare-machine/challenges.md | 6 +- olddocs/js/lessons/digital-pet.md | 8 +- olddocs/js/lessons/landslide.md | 2 +- olddocs/js/lessons/landslide/challenges.md | 2 +- olddocs/js/lessons/line-of-fire.md | 2 +- olddocs/js/lessons/logo-pointer/challenges.md | 2 +- olddocs/js/lessons/meteorite.md | 4 +- .../js/lessons/number-psych/quiz-answers.md | 4 +- olddocs/js/lessons/number-psych/quiz.md | 4 +- olddocs/js/lessons/on-fall/challenges.md | 4 +- olddocs/js/lessons/on-shake/challenges.md | 2 +- olddocs/js/lessons/pong.md | 4 +- .../challenges.md | 20 ++--- .../challenges.md | 20 ++--- olddocs/js/lessons/running-time/challenges.md | 2 +- .../lessons/screen-up-and-down/challenges.md | 4 +- .../js/lessons/set-brightness/challenges.md | 4 +- olddocs/js/lessons/show-string/challenges.md | 2 +- olddocs/js/lessons/typing-game/challenges.md | 2 +- .../js/lessons/while-counting/challenges.md | 2 +- olddocs/js/lessons/yes-no/challenges.md | 2 +- olddocs/js/libraries.md | 2 +- olddocs/js/micro-bit-api.md | 4 +- olddocs/js/object-disclaimer.md | 2 +- olddocs/js/object-types.md | 2 +- olddocs/js/orientation.md | 2 +- olddocs/js/quick-start.md | 2 +- olddocs/js/reactive.md | 6 +- olddocs/js/senses.md | 2 +- olddocs/js/serial-library.md | 24 ++--- olddocs/js/simulator.md | 8 +- olddocs/js/statements.md | 2 +- olddocs/js/string.md | 2 +- olddocs/js/types.md | 2 +- 226 files changed, 697 insertions(+), 750 deletions(-) delete mode 100644 docs/_locales/pl/_theme.json delete mode 100644 docs/_locales/pl/docs.md delete mode 100644 docs/release-notes.md diff --git a/docs/_locales/pl/_theme.json b/docs/_locales/pl/_theme.json deleted file mode 100644 index c1e141f8..00000000 --- a/docs/_locales/pl/_theme.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "name": "koduj z micro:bit", - "title": "koduj z micro:bit", - "docMenu": [ - { - "name": "O nas", - "path": "/about" - }, - { - "name": "Lekcje", - "path": "/lessons" - }, - { - "name": "Instrukcja obsługi", - "path": "/reference" - }, - { - "name": "Urządzenie", - "path": "/device" - } - ] -} \ No newline at end of file diff --git a/docs/_locales/pl/docs.md b/docs/_locales/pl/docs.md deleted file mode 100644 index 4baddf36..00000000 --- a/docs/_locales/pl/docs.md +++ /dev/null @@ -1,7 +0,0 @@ -# Dokumentacja - -Witamy na stronach dokumentacji! - -* Przeglądnij [instrukcje obsługi](/reference) -* Dowiedz się więcej o [urządzeniu](/device) -* Wystartuj z [lekcjami](/lessons) diff --git a/docs/docs.md b/docs/docs.md index 5e50a8c5..8b7d90a1 100644 --- a/docs/docs.md +++ b/docs/docs.md @@ -28,4 +28,4 @@ * [Command Line Interface](/cli) * Learn about [packages](/packages) -* [Release notes](/release-notes) + diff --git a/docs/getting-started.md b/docs/getting-started.md index 96e7a110..475366f8 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -1,6 +1,6 @@ # Getting started -### @description An activity for beginners to get started with the micro:bit +### @description An activity for beginners to get started with the @boardname@ ## ~avatar diff --git a/docs/getting-started/buttons.md b/docs/getting-started/buttons.md index 2f8debe0..120352f7 100644 --- a/docs/getting-started/buttons.md +++ b/docs/getting-started/buttons.md @@ -37,7 +37,7 @@ You can find the letter `B` by clicking the letter `A` on the #### ~ -Click **Download** to move your program to the BBC @boardname@! +Click **Download** to move your program to the @boardname@! #### Your turn! @@ -48,9 +48,9 @@ name_ instead of **BANANA** when you press `B`? ### Pins You can also use the pins as buttons. (The pins are the holes in the -metal stripe at the bottom of the micro:bit board.) For example, hold +metal stripe at the bottom of the @boardname@ board.) For example, hold the ``GND`` button with one hand and touch the ``0`` pin (called -``P0``) with your other hand to tell the micro:bit you're pressing it. +``P0``) with your other hand to tell the @boardname@ you're pressing it. Unscramble the blocks in the editor to show a heart when you touch pin ``P0``. diff --git a/docs/getting-started/coin-flipper.md b/docs/getting-started/coin-flipper.md index d9b5425f..fd5d13ae 100644 --- a/docs/getting-started/coin-flipper.md +++ b/docs/getting-started/coin-flipper.md @@ -50,7 +50,7 @@ input.onButtonPressed(Button.AB, () => { ``` These blocks mean that if you press button `A`, you will add `1` to -your score, and if you press `A` and `B` together, the micro:bit will +your score, and if you press `A` and `B` together, the @boardname@ will show your score. When you're done, your coin flipping program should look like this: diff --git a/docs/getting-started/rock-paper-scissors.md b/docs/getting-started/rock-paper-scissors.md index 72216c93..11561cd8 100644 --- a/docs/getting-started/rock-paper-scissors.md +++ b/docs/getting-started/rock-paper-scissors.md @@ -3,7 +3,7 @@ ### ~avatar avatar Build a Rock Paper Scissors game with the @boardname@! You can play -the game with a friend who has it on a micro:bit. You can also play +the game with a friend who has it on a @boardname@. You can also play it with friends who are just using their hands. (The game is built like a coin flipper, but with three choices instead of two.) @@ -11,9 +11,9 @@ like a coin flipper, but with three choices instead of two.) ## Step 1: Getting started -We want the micro:bit to choose rock, paper, or scissors when you +We want the @boardname@ to choose rock, paper, or scissors when you shake it. Try creating an ``on shake`` block so when you shake the -micro:bit, it will run part of a program. +@boardname@, it will run part of a program. Clear up the blocks and add the blocks below. @@ -23,7 +23,7 @@ input.onGesture(Gesture.Shake, () => { }) ``` -Next, when you shake the micro:bit, it should pick a random number from `0` to `2` +Next, when you shake the @boardname@, it should pick a random number from `0` to `2` and store it in the variable `item`. Add a ``set`` block with a variable. Then add a ``pick random`` block, @@ -75,7 +75,7 @@ input.onGesture(Gesture.Shake, () => { ## Step 3: A random rock -Now we are going to add a new picture for the micro:bit to show +Now we are going to add a new picture for the @boardname@ to show when another random number comes up. Make the ``else if`` part check if the variable `item` is `1`. @@ -160,7 +160,7 @@ Have fun! Here is a way you can make your Rock Paper Scissors game better. When button ``A`` is pressed, -the micro:bit will add `1` to your score. +the @boardname@ will add `1` to your score. Open the ``Game`` drawer, and then add the block ``change score by 1`` to your program, like this: @@ -174,7 +174,7 @@ input.onButtonPressed(Button.A, () => { ## Step 6: Prove you're the greatest! -After your micro:bit can add `1` to the score, show how many wins you have. +After your @boardname@ can add `1` to the score, show how many wins you have. ```blocks input.onButtonPressed(Button.A, () => { @@ -185,7 +185,7 @@ input.onButtonPressed(Button.A, () => { ``` ## Step 7: Staying honest -Success! Your micro:bit can track wins! +Success! Your @boardname@ can track wins! But what about losses? Use the ``Game`` drawer to subtract `1` from your score when you press button `B`. diff --git a/docs/getting-started/screen.md b/docs/getting-started/screen.md index ecf48b29..fd700b41 100644 --- a/docs/getting-started/screen.md +++ b/docs/getting-started/screen.md @@ -2,7 +2,7 @@ ### ~avatar avatar -There are 25 bright LEDs on the micro:bit screen. Let's use them to create some cool animations! +There are 25 bright LEDs on the @boardname@ screen. Let's use them to create some cool animations! ### ~ @@ -12,7 +12,7 @@ Draw an unhappy face instead of the blank screen. Click on the dots in the second ``show leds`` block until it matches the blocks below. Now you have an **animation** (cartoon) that shows a happy face, then an unhappy one, then a happy one again, forever (or until -you turn off your micro:bit)! +you turn off your @boardname@)! ```blocks basic.forever(() => { diff --git a/docs/getting-started/shake.md b/docs/getting-started/shake.md index f24ca9e1..37ba5731 100644 --- a/docs/getting-started/shake.md +++ b/docs/getting-started/shake.md @@ -1,11 +1,11 @@ # Shake You can find when someone is shaking the @boardname@ by checking its -**accelerometer** (it finds whether the micro:bit is speeding up or +**accelerometer** (it finds whether the @boardname@ is speeding up or slowing down). Unscramble these blocks in the editor to show a frownie when someone -shakes the micro:bit. (Ouch!) +shakes the @boardname@. (Ouch!) ```shuffle input.onGesture(Gesture.Shake, () => { diff --git a/docs/javascript.md b/docs/javascript.md index 3a207dc4..7bd81a92 100644 --- a/docs/javascript.md +++ b/docs/javascript.md @@ -1,6 +1,7 @@ # JavaScript -Visit the cards below to starting programming JavaScript and TypeScript with the micro:bit: +Visit the cards below to starting programming JavaScript +with the @boardname@: ```codecard [{ diff --git a/docs/js/call.md b/docs/js/call.md index ebe3ecd7..d93d23e8 100644 --- a/docs/js/call.md +++ b/docs/js/call.md @@ -1,8 +1,8 @@ # Call a function -The simplest way to get started in JavaScript with your micro:bit is to -call one of the micro:bit's built-in JavaScript functions. Just like Blocks -are organized into categories/drawers, the micro:bit functions are organized by +The simplest way to get started in JavaScript with your @boardname@ is to +call one of the @boardname@'s built-in JavaScript functions. Just like Blocks +are organized into categories/drawers, the @boardname@ functions are organized by namespaces, with names corresponding to the drawer names. The `basic` namespace contains a number of helpful functions, such as: diff --git a/docs/js/classes.md b/docs/js/classes.md index 1cfd47e7..ac5bda15 100644 --- a/docs/js/classes.md +++ b/docs/js/classes.md @@ -35,7 +35,7 @@ This calls into the constructor we defined earlier, creating a new object with t # Inheritance ### ~hint -### Inheritance is not supported yet for the micro:bit. Coming soon... +### Inheritance is not supported yet for the @boardname@. Coming soon... ### ~ In TypeScript, we can use common object-oriented patterns. diff --git a/docs/js/faq.md b/docs/js/faq.md index 5c4a7063..fded50a4 100644 --- a/docs/js/faq.md +++ b/docs/js/faq.md @@ -1,8 +1,8 @@ # Frequently asked questions -# What is the language supported for the micro:bit? +# What is the language supported for the @boardname@? -For the micro:bit, we support a "static" subset of TypeScript (itself a superset of JavaScript): +For the @boardname@, we support a "static" subset of TypeScript (itself a superset of JavaScript): ## Supported language features diff --git a/docs/js/functions.md b/docs/js/functions.md index 4c5b26a9..efa30457 100644 --- a/docs/js/functions.md +++ b/docs/js/functions.md @@ -13,7 +13,7 @@ basic.showNumber(add(1, 2)) ``` ### ~ hint -For the micro:bit, you must specify a [type](/js/types) for each function parameter. +For the @boardname@, you must specify a [type](/js/types) for each function parameter. ### ~ Functions can refer to variables outside of the function body. diff --git a/docs/js/operators.md b/docs/js/operators.md index c2538865..52994051 100644 --- a/docs/js/operators.md +++ b/docs/js/operators.md @@ -1,9 +1,9 @@ ## Operators -The following JavaScript operators are supported for the micro:bit. +The following JavaScript operators are supported for the @boardname@. ### ~hint -Note that for the micro:bit all arithmetic is performed on integers, rather than floating point. +Note that for the @boardname@ all arithmetic is performed on integers, rather than floating point. This also is true when simulating in the browser. ### ~ diff --git a/docs/js/sequence.md b/docs/js/sequence.md index acfd93b3..f26abb74 100644 --- a/docs/js/sequence.md +++ b/docs/js/sequence.md @@ -48,7 +48,7 @@ basic.showNumber(1); ### ~hint -For the micro:bit, we don't allow a program to contain an empty statement, such as shown above. +For the @boardname@, we don't allow a program to contain an empty statement, such as shown above. If you really want an empty statement, you need to use curly braces to delimit an empty statement block: ```typescript while(true) { } diff --git a/docs/js/statements.md b/docs/js/statements.md index ab9f0332..e2e22cb7 100644 --- a/docs/js/statements.md +++ b/docs/js/statements.md @@ -1,6 +1,6 @@ # Statements -The following JavaScript statements are supported for the micro:bit: +The following JavaScript statements are supported for the @boardname@: ## Variable declarations * `const` statement - [read more](http://devdocs.io/javascript/statements/const) diff --git a/docs/js/types.md b/docs/js/types.md index 81cf1c65..32918d0d 100644 --- a/docs/js/types.md +++ b/docs/js/types.md @@ -15,7 +15,7 @@ let isDone: boolean = false; ### ~ hint In JavaScript, `numbers` are floating point values. -However, for the micro:bit, `numbers` are integer values. +However, for the @boardname@, `numbers` are integer values. ### ~ Integer values can be specified via decimal, hexadecimal and octal notation: @@ -74,7 +74,7 @@ let list: Array = [1, 2, 3]; ``` ### ~hint -For the micro:bit, all elements of an array must have the same type. +For the @boardname@, all elements of an array must have the same type. ### ~ @@ -106,7 +106,7 @@ let c: Color = Color.Green; # Any -The TypeScript type `any` is not supported in the micro:bit. +The TypeScript type `any` is not supported in the @boardname@. # Void diff --git a/docs/lessons/answering-machine/activity.md b/docs/lessons/answering-machine/activity.md index b41ea8c0..37b93a06 100644 --- a/docs/lessons/answering-machine/activity.md +++ b/docs/lessons/answering-machine/activity.md @@ -1,6 +1,6 @@ # answering machine blocks activity -Learn to create an answering machine on the micro:bit +Learn to create an answering machine on the @boardname@ ### ~avatar avatar diff --git a/docs/lessons/answering-machine/challenges.md b/docs/lessons/answering-machine/challenges.md index 0a03be08..0befc10d 100644 --- a/docs/lessons/answering-machine/challenges.md +++ b/docs/lessons/answering-machine/challenges.md @@ -12,7 +12,7 @@ basic.showString("ASK ME A QUESTION") ### Challenge 1 -Now we need to reply after someone asks micro:bit a yes or no question. We want to respond `YES` when button `A` is pressed. Add a condition for button `A` and inside it show the string `YES`. +Now we need to reply after someone asks @boardname@ a yes or no question. We want to respond `YES` when button `A` is pressed. Add a condition for button `A` and inside it show the string `YES`. ```blocks basic.showString("ASK ME A QUESTION") @@ -25,7 +25,7 @@ input.onButtonPressed(Button.A, () => { ### Challenge 2 -What if micro:bit's answer to the question is no? Let's have `NO` be displayed when button `B` is pressed. Add a condition for button `B` and inside it show the string `NO`. +What if @boardname@'s answer to the question is no? Let's have `NO` be displayed when button `B` is pressed. Add a condition for button `B` and inside it show the string `NO`. ```blocks basic.showString("ASK ME A QUESTION") diff --git a/docs/lessons/answering-machine/quiz-answers.md b/docs/lessons/answering-machine/quiz-answers.md index eb89f62f..1cbc2cbe 100644 --- a/docs/lessons/answering-machine/quiz-answers.md +++ b/docs/lessons/answering-machine/quiz-answers.md @@ -1,6 +1,6 @@ # answering machine blocks quiz answers -Create an answering machine on the micro:bit. +Create an answering machine on the @boardname@. This is the answer key for the [answering machine quiz](/lessons/answering-machine/quiz). @@ -26,7 +26,7 @@ basic.showString("Hi") ![](/static/mb/lessons/answering-machine-1.png) -## 4. If the rectangle below represents the micro:bit, write the code to display the letter "Z". +## 4. If the rectangle below represents the @boardname@, write the code to display the letter "Z". ![](/static/mb/lessons/answering-machine-2.png) diff --git a/docs/lessons/answering-machine/quiz.md b/docs/lessons/answering-machine/quiz.md index e44e1cb4..9a6450e6 100644 --- a/docs/lessons/answering-machine/quiz.md +++ b/docs/lessons/answering-machine/quiz.md @@ -1,6 +1,6 @@ # answering machine blocks quiz -Create an answering machine on the micro:bit. +Create an answering machine on the @boardname@. ## Name @@ -36,7 +36,7 @@ basic.showString("Hi") ![](/static/mb/lessons/answering-machine-4.png) -## 4. If the rectangle below represents the micro:bit, write the code to display the letter "Z". +## 4. If the rectangle below represents the @boardname@, write the code to display the letter "Z". ```blocks basic.showString("Z") diff --git a/docs/lessons/beautiful-image.md b/docs/lessons/beautiful-image.md index f59fbfd5..a10563bc 100644 --- a/docs/lessons/beautiful-image.md +++ b/docs/lessons/beautiful-image.md @@ -31,6 +31,6 @@ basic.pause(100) ## Objectives -* learn how to display an image on the micro:bit's LED screen +* learn how to display an image on the @boardname@'s LED screen * learn how to pause your code for the specified number of milliseconds diff --git a/docs/lessons/beautiful-image/challenges.md b/docs/lessons/beautiful-image/challenges.md index 4a4a54b2..26738602 100644 --- a/docs/lessons/beautiful-image/challenges.md +++ b/docs/lessons/beautiful-image/challenges.md @@ -18,7 +18,7 @@ basic.showLeds(` ### Challenge 1 -Now show an new image that will display on the micro:bit. +Now show an new image that will display on the @boardname@. ```blocks basic.showLeds(` diff --git a/docs/lessons/charting.md b/docs/lessons/charting.md index 8ffef63f..ce848926 100644 --- a/docs/lessons/charting.md +++ b/docs/lessons/charting.md @@ -1,6 +1,6 @@ # charting lesson -Create a charting app for simulating and measuring the acceleration applied to the micro:bit +Create a charting app for simulating and measuring the acceleration applied to the @boardname@ ## Topic @@ -32,5 +32,5 @@ radio.sendNumber(0) * learn how to get the acceleration value (g-force), in one of three specified dimensions * learn how to display a vertical bar graph based on the value and high value. * learn how to register code to run when a packet is received over radio -* learn how to broadcast a number data packet to other micro:bits connected via radio +* learn how to broadcast a number data packet to other @boardname@s connected via radio * learn how to read the next radio packet as a number data packet diff --git a/docs/lessons/charting/activity.md b/docs/lessons/charting/activity.md index b64d1e13..d13341e0 100644 --- a/docs/lessons/charting/activity.md +++ b/docs/lessons/charting/activity.md @@ -1,10 +1,10 @@ # Activity -Measure the acceleration on the micro:bit in the "x" direction. +Measure the acceleration on the @boardname@ in the "x" direction. ### ~avatar avatar -Welcome! This activity will teach how to use the micro:bit to chart the acceleration in the "x" direction. Let's get started! +Welcome! This activity will teach how to use the @boardname@ to chart the acceleration in the "x" direction. Let's get started! ### ~ @@ -16,7 +16,7 @@ input.acceleration(Dimension.X) ``` ### ~ -Use the plot bar chart to visualize the acceleration on the LED screen of the micro:bit in the specified range. You implement plot Bar Graph to display a vertical bar graph based on the "value" and "high" value. Then you must insert acceleration in the X dimension to measure the acceleration. +Use the plot bar chart to visualize the acceleration on the LED screen of the @boardname@ in the specified range. You implement plot Bar Graph to display a vertical bar graph based on the "value" and "high" value. Then you must insert acceleration in the X dimension to measure the acceleration. ```blocks basic.forever(() => { @@ -26,27 +26,27 @@ basic.forever(() => { ``` ### ~ -Notice that moving the micro:bit in the simulator from left to right (x direction) changes the values beneath the micro:bit in a range from 1023 to -1023 as measured in milli-gravities. By hovering over the micro:bit from left to right, you can observe changing values beneath the micro:bit simulator. Also, the LEDs shown on the Bar Graph fluctates based on the movement of the micro:bit simulator in the x direction. The line underneath the micro:bit simulator reflect the acceleration in the x direction. +Notice that moving the @boardname@ in the simulator from left to right (x direction) changes the values beneath the @boardname@ in a range from 1023 to -1023 as measured in milli-gravities. By hovering over the @boardname@ from left to right, you can observe changing values beneath the @boardname@ simulator. Also, the LEDs shown on the Bar Graph fluctates based on the movement of the @boardname@ simulator in the x direction. The line underneath the @boardname@ simulator reflect the acceleration in the x direction. -NOTE: The colors of the charts reflect the color of the micro:bit simulator. In this instance, the micro:bit is yellow. So the color of the data line reflects the color of the micro:bit +NOTE: The colors of the charts reflect the color of the @boardname@ simulator. In this instance, the @boardname@ is yellow. So the color of the data line reflects the color of the @boardname@ ![](/static/mb/data4.png) ### ~ -Vigorously move the micro:bit in the micro:bit simulatator by moving the micro:bit image from side to side. Every time the micro:bit moves in the x direction in the simulator, you are generating data points that can be reviewed in Excel. The more attempts to move the micro:bit from side to side, the more data being saved in Excel. After you have vigarously moved the micro:bit simulator from side to side for a sufficient amount of time, you are ready to graph or chart the accceleration of the micro:bit. We want a printout of our acceleration on Excel that can be graphed in Excel. +Vigorously move the @boardname@ in the @boardname@ simulatator by moving the @boardname@ image from side to side. Every time the @boardname@ moves in the x direction in the simulator, you are generating data points that can be reviewed in Excel. The more attempts to move the @boardname@ from side to side, the more data being saved in Excel. After you have vigarously moved the @boardname@ simulator from side to side for a sufficient amount of time, you are ready to graph or chart the accceleration of the @boardname@. We want a printout of our acceleration on Excel that can be graphed in Excel. ### ~ We want to chart the data collected by using a tool in Excel. -The final part of this experiment is opening and reviewing the data in the Excel CSV file. Simply click on the line beneath the simulator. A CSV file will be generated to display the data points collected by moving the micro:bit in the X direction. Then click or tap on the data Excel file that was downloaded to your local ``Downloads`` Folder. +The final part of this experiment is opening and reviewing the data in the Excel CSV file. Simply click on the line beneath the simulator. A CSV file will be generated to display the data points collected by moving the @boardname@ in the X direction. Then click or tap on the data Excel file that was downloaded to your local ``Downloads`` Folder. ### ~ -First, click or tap on the first two columns (A, B) to include the time of the data being collected; b) the results of acceleration data on the micro:bit +First, click or tap on the first two columns (A, B) to include the time of the data being collected; b) the results of acceleration data on the @boardname@ ![](/static/mb/data7.png) diff --git a/docs/lessons/charting/challenge.md b/docs/lessons/charting/challenge.md index 5067fd67..1afe7e05 100644 --- a/docs/lessons/charting/challenge.md +++ b/docs/lessons/charting/challenge.md @@ -2,11 +2,11 @@ ### ~avatar avatar -Welcome! The activity will teach you how to use the acceleration of the 1st micro:bit and to visualize the acceleration on the 2nd micro:bit. +Welcome! The activity will teach you how to use the acceleration of the 1st @boardname@ and to visualize the acceleration on the 2nd @boardname@. Let's get started! ### ~ -Let's measure `acceleration (mg)` and then `send number`. `Acceleration` is measured in **milli-gravities**, so a value of -1000 is equivalent to -1g or -9.81m/s^2. We will be able to get the acceleration value (g-force), in the specified "x" dimension. `Send number` will broadcast a number data packet to other micro:bits connected via radio. +Let's measure `acceleration (mg)` and then `send number`. `Acceleration` is measured in **milli-gravities**, so a value of -1000 is equivalent to -1g or -9.81m/s^2. We will be able to get the acceleration value (g-force), in the specified "x" dimension. `Send number` will broadcast a number data packet to other @boardname@s connected via radio. ```blocks radio.sendNumber(input.acceleration(Dimension.X)); @@ -33,7 +33,7 @@ radio.onDataPacketReceived(() => { }) ``` ### ~ -Finally, we want to chart the acceleration. So we must first implement `plot bar graph`. `Plot Bar Graph` will display a vertical bar graph based on the value and high value. In order to transfer the receive the number from the 1st micro:bit, we must implement `receive number` to constantly display a vertical bar graph based on the value. Remember, the value will equal to the micro:bit's acceleration in the "x" direction. +Finally, we want to chart the acceleration. So we must first implement `plot bar graph`. `Plot Bar Graph` will display a vertical bar graph based on the value and high value. In order to transfer the receive the number from the 1st @boardname@, we must implement `receive number` to constantly display a vertical bar graph based on the value. Remember, the value will equal to the @boardname@'s acceleration in the "x" direction. ```blocks basic.forever(() => { @@ -45,15 +45,15 @@ radio.onDataPacketReceived(({ receivedNumber }) => { ``` ### ~ -Notice that moving the micro:bit the farthest direction in the x direction will be -1023 on the charting beneath the simulator. The second observation will be that the LEDs will be full brightness on the 2nd micro:bit. There is a single LED turned on with the 1st micro:bit. Additionally, the graphs will reflect 0 acceleation for the 1st micro:bit. In this scenario, if you are adjusting the acceleration in the simualator, you are also changing your chart that will be produced. +Notice that moving the @boardname@ the farthest direction in the x direction will be -1023 on the charting beneath the simulator. The second observation will be that the LEDs will be full brightness on the 2nd @boardname@. There is a single LED turned on with the 1st @boardname@. Additionally, the graphs will reflect 0 acceleation for the 1st @boardname@. In this scenario, if you are adjusting the acceleration in the simualator, you are also changing your chart that will be produced. ![](/static/mb/acc.png) ### ~ -NOTE: The colors of the charts reflect the color of the micro:bit simulator. In this instance, the micro:bits are blue and green. So the colors of the line graphs reflect the colors of the micro:bit +NOTE: The colors of the charts reflect the color of the @boardname@ simulator. In this instance, the @boardname@s are blue and green. So the colors of the line graphs reflect the colors of the @boardname@ ### ~ -After running this simulation several seconds by moving the micro:bit side to side in the x direction, you are ready to graph or chart the accceleration of the micro:bit. We want a printout of our acceleration on Excel. We will graph the fluctuating acceleration of the simulation experiment. +After running this simulation several seconds by moving the @boardname@ side to side in the x direction, you are ready to graph or chart the accceleration of the @boardname@. We want a printout of our acceleration on Excel. We will graph the fluctuating acceleration of the simulation experiment. ![](/static/mb/acc2.png) @@ -81,10 +81,10 @@ Use the Recommended Charts command on the Insert tab to quickly create a chart t ### ~ Have fun reviewing your simulation and analyze the acceleration by chart the Excel data using Excel. -* Connect the first micro:bit to your computer using your USB cable and run the charting script on it. -* Connect the second micro:bit to your computer using your USB cable and run the charting script on it. -* The first person and second person take turns tilting the micro:bit in the "x" direction while the other player charts the data on the micro:bit! -* Review and analyze the actual micro:bit device acceleration data on Excel +* Connect the first @boardname@ to your computer using your USB cable and run the charting script on it. +* Connect the second @boardname@ to your computer using your USB cable and run the charting script on it. +* The first person and second person take turns tilting the @boardname@ in the "x" direction while the other player charts the data on the @boardname@! +* Review and analyze the actual @boardname@ device acceleration data on Excel * Display acceleration with y or z using plot bar graph by changing acceleration from "x" to "y" or "z" ```package diff --git a/docs/lessons/charting/quiz-answers.md b/docs/lessons/charting/quiz-answers.md index b58dd788..e81d7405 100644 --- a/docs/lessons/charting/quiz-answers.md +++ b/docs/lessons/charting/quiz-answers.md @@ -1,6 +1,6 @@ # charting quiz answers -Measure the acceleration on the micro:bit in the "x" direction. +Measure the acceleration on the @boardname@ in the "x" direction. ## Name @@ -25,7 +25,7 @@ We are creating a forever loop to constantly display the appropriate brightness led.plotBarGraph(input.acceleration(Dimension.X), 0) ``` -## 3. After vigarously moving the micro:bit from side to side along the "x" axis for a sufficient amount of time,insert the Excel graph for displaying a line chart used to display trends over time. +## 3. After vigarously moving the @boardname@ from side to side along the "x" axis for a sufficient amount of time,insert the Excel graph for displaying a line chart used to display trends over time.
diff --git a/docs/lessons/charting/quiz.md b/docs/lessons/charting/quiz.md index e9afb4dc..04498e2e 100644 --- a/docs/lessons/charting/quiz.md +++ b/docs/lessons/charting/quiz.md @@ -1,6 +1,6 @@ # charting quiz -Measure the acceleration on the micro:bit in the "x" direction. +Measure the acceleration on the @boardname@ in the "x" direction. ## Name @@ -18,6 +18,6 @@ Answer the questions while completing the tutorial. Pay attention to the dialogu
-## 3. After vigarously moving the micro:bit from side to side along the "x" axis for a sufficient amount of time,insert the Excel graph for displaying a line chart used to display trends over time. +## 3. After vigarously moving the @boardname@ from side to side along the "x" axis for a sufficient amount of time,insert the Excel graph for displaying a line chart used to display trends over time. diff --git a/docs/lessons/compass/activity.md b/docs/lessons/compass/activity.md index f06a5770..d25a1473 100644 --- a/docs/lessons/compass/activity.md +++ b/docs/lessons/compass/activity.md @@ -1,10 +1,10 @@ # compass activity -Display the direction that the micro:bit is facing using the compass +Display the direction that the @boardname@ is facing using the compass ### ~avatar avatar -Welcome! This guided tutorial will show you how to program a script that displays the direction the micro:bit is pointing. Let's get started! +Welcome! This guided tutorial will show you how to program a script that displays the direction the @boardname@ is pointing. Let's get started! ### ~ @@ -17,7 +17,7 @@ basic.forever(() => { }) ``` -Store the reading of the micro:bit in a variable called `degrees`. +Store the reading of the @boardname@ in a variable called `degrees`. ```blocks basic.forever(() => { @@ -25,7 +25,7 @@ basic.forever(() => { }) ``` -If `degrees` is less than `45`, then the compass heading is mostly pointing toward North. Display `N` on the micro:bit. +If `degrees` is less than `45`, then the compass heading is mostly pointing toward North. Display `N` on the @boardname@. ```blocks basic.forever(() => { @@ -36,7 +36,7 @@ basic.forever(() => { }); ``` -If `degrees` is less than 135, the micro:bit is mostly pointing East. Display `E` on the micro:bit. +If `degrees` is less than 135, the @boardname@ is mostly pointing East. Display `E` on the @boardname@. ```blocks @@ -51,7 +51,7 @@ basic.forever(() => { }); ``` -If `degrees` is less than 225, the micro:bit is mostly pointing South. Display `S` on the micro:bit. +If `degrees` is less than 225, the @boardname@ is mostly pointing South. Display `S` on the @boardname@. ```blocks @@ -70,7 +70,7 @@ basic.forever(() => { ``` -If none of these conditions returned true, then the micro:bit must be pointing West. Display `W` on the micro:bit. +If none of these conditions returned true, then the @boardname@ must be pointing West. Display `W` on the @boardname@. ```blocks basic.forever(() => { diff --git a/docs/lessons/compass/challenges.md b/docs/lessons/compass/challenges.md index ac3a6055..8a5e1fa6 100644 --- a/docs/lessons/compass/challenges.md +++ b/docs/lessons/compass/challenges.md @@ -1,6 +1,6 @@ # compass challenges -Display the direction that the micro:bit is facing using the compass +Display the direction that the @boardname@ is facing using the compass ## Before we get started diff --git a/docs/lessons/compass/quiz-answers.md b/docs/lessons/compass/quiz-answers.md index ca1f9067..c709b313 100644 --- a/docs/lessons/compass/quiz-answers.md +++ b/docs/lessons/compass/quiz-answers.md @@ -12,7 +12,7 @@ Answer the questions while completing the tutorial. Pay attention to the dialogu ## 1. What is the purpose of the 'compass heading' block? -Gets the compass heading of the micro:bit in degrees +Gets the compass heading of the @boardname@ in degrees ## 2. Write the code that stores the compass heading into a local variable called 'degrees'. @@ -22,7 +22,7 @@ Gets the compass heading of the micro:bit in degrees let degrees = input.compassHeading() ``` -## 3. Write the 'If statement' that will check if the device is mostly pointing North. Display 'N' on the micro:bit +## 3. Write the 'If statement' that will check if the device is mostly pointing North. Display 'N' on the @boardname@ ```blocks @@ -32,7 +32,7 @@ if (degrees < 45) { } ``` -## 4. Write the 'If statement' that will check if the device is mostly pointing East. Display 'E' on the micro:bit +## 4. Write the 'If statement' that will check if the device is mostly pointing East. Display 'E' on the @boardname@ ```blocks @@ -42,7 +42,7 @@ if (degrees < 135) { } ``` -## 5. Write the 'If statement' that will check if the device is mostly pointing South. Display 'S' on the micro:bit +## 5. Write the 'If statement' that will check if the device is mostly pointing South. Display 'S' on the @boardname@ ```blocks diff --git a/docs/lessons/compass/quiz.md b/docs/lessons/compass/quiz.md index 180e9b81..31dd3da1 100644 --- a/docs/lessons/compass/quiz.md +++ b/docs/lessons/compass/quiz.md @@ -15,12 +15,12 @@ Answer the questions while completing the tutorial. Pay attention to the dialogu ## 2. Write the code that stores the compass heading into a local variable called 'degrees'. -## 3. Write the 'If statement' that will check if the device is mostly pointing North. Display 'N' on the micro:bit +## 3. Write the 'If statement' that will check if the device is mostly pointing North. Display 'N' on the @boardname@ -## 4. Write the 'If statement' that will check if the device is mostly pointing East. Display 'E' on the micro:bit +## 4. Write the 'If statement' that will check if the device is mostly pointing East. Display 'E' on the @boardname@ -## 5. Write the 'If statement' that will check if the device is mostly pointing South. Display 'S' on the micro:bit +## 5. Write the 'If statement' that will check if the device is mostly pointing South. Display 'S' on the @boardname@ diff --git a/docs/lessons/counter/challenges.md b/docs/lessons/counter/challenges.md index 8d478cb3..7610102c 100644 --- a/docs/lessons/counter/challenges.md +++ b/docs/lessons/counter/challenges.md @@ -33,5 +33,5 @@ input.onButtonPressed(Button.B, () => { ### Challenge 3 -Now let's try to reset the counter when the micro:bit is shaken. You will need to register an event handler with `on shake`. +Now let's try to reset the counter when the @boardname@ is shaken. You will need to register an event handler with `on shake`. diff --git a/docs/lessons/counter/quiz-answers.md b/docs/lessons/counter/quiz-answers.md index 0ab491d7..9a7adc2d 100644 --- a/docs/lessons/counter/quiz-answers.md +++ b/docs/lessons/counter/quiz-answers.md @@ -32,7 +32,7 @@ input.onButtonPressed(Button.A, () => { ![](/static/mb/lessons/counter-1.png) -We are only pressing on button pressed once. So the number to display on the micro:bit is also one. +We are only pressing on button pressed once. So the number to display on the @boardname@ is also one.
diff --git a/docs/lessons/dice-roll/activity.md b/docs/lessons/dice-roll/activity.md index 51d530fa..487dbc34 100644 --- a/docs/lessons/dice-roll/activity.md +++ b/docs/lessons/dice-roll/activity.md @@ -1,6 +1,6 @@ # dice roll activity -Create a dice on the micro:bit +Create a dice on the @boardname@ ### ~avatar avatar @@ -8,7 +8,7 @@ Welcome! This tutorial will help you create a dice. Let's get started! ### ~ -Let's create a condition for when the micro:bit is shaken. +Let's create a condition for when the @boardname@ is shaken. ```blocks diff --git a/docs/lessons/dice-roll/challenges.md b/docs/lessons/dice-roll/challenges.md index 10672e74..a1b80b39 100644 --- a/docs/lessons/dice-roll/challenges.md +++ b/docs/lessons/dice-roll/challenges.md @@ -1,6 +1,6 @@ # dice roll challenges -Create a dice on the micro:bit. +Create a dice on the @boardname@. ## Before we get started diff --git a/docs/lessons/digi-yoyo/challenges.md b/docs/lessons/digi-yoyo/challenges.md index 78fc8674..ddb5c836 100644 --- a/docs/lessons/digi-yoyo/challenges.md +++ b/docs/lessons/digi-yoyo/challenges.md @@ -62,7 +62,7 @@ while (count > 0) { ### Challenge 3 -Now, we need `count` to decrease by one after the micro:bit has displayed the value of `count`. +Now, we need `count` to decrease by one after the @boardname@ has displayed the value of `count`. We can do this by adding this line: diff --git a/docs/lessons/flashing-heart/activity.md b/docs/lessons/flashing-heart/activity.md index c1481c8b..ef0da311 100644 --- a/docs/lessons/flashing-heart/activity.md +++ b/docs/lessons/flashing-heart/activity.md @@ -8,7 +8,7 @@ In this activity, you will learn how to blink an image on the LED screen. ### ~ -Let's start by adding code that plots a heart image on the screen using `show LEDs`. Once you are done coding, don't forget to run your code in the simulator or the micro:bit. +Let's start by adding code that plots a heart image on the screen using `show LEDs`. Once you are done coding, don't forget to run your code in the simulator or the @boardname@. ```blocks diff --git a/docs/lessons/game-counter/challenges.md b/docs/lessons/game-counter/challenges.md index 25786cf4..4a47fb37 100644 --- a/docs/lessons/game-counter/challenges.md +++ b/docs/lessons/game-counter/challenges.md @@ -33,5 +33,5 @@ input.onButtonPressed(Button.B, () => { ### Challenge 3 -Now let's try to reset the counter when the micro:bit is shaken. You will need to register an event handler with `on shake`. +Now let's try to reset the counter when the @boardname@ is shaken. You will need to register an event handler with `on shake`. diff --git a/docs/lessons/game-of-chance/activity.md b/docs/lessons/game-of-chance/activity.md index 0f4d12ed..a00a4644 100644 --- a/docs/lessons/game-of-chance/activity.md +++ b/docs/lessons/game-of-chance/activity.md @@ -1,6 +1,6 @@ # game of chance blocks activity -Learn to create an answering machine on the micro:bit +Learn to create an answering machine on the @boardname@ We will use `show string` to show text on the LED screen. *String* is a common name for *text* in programming languages. The function `show string` scrolls the text column by column at a *150* milliseconds interval. If you want to speed up or down the scrolling, simply change the *150*. diff --git a/docs/lessons/game-of-chance/challenges.md b/docs/lessons/game-of-chance/challenges.md index 891301e1..b70c4c03 100644 --- a/docs/lessons/game-of-chance/challenges.md +++ b/docs/lessons/game-of-chance/challenges.md @@ -28,7 +28,7 @@ input.onButtonPressed(Button.A, () => { ### Challenge 2 -What if micro:bit's answer to the question is GAME OVER? Let's have `GAME OVER` be displayed when button `B` is pressed. Add a condition for button `B` and inside it show the `GAME OVER`. +What if @boardname@'s answer to the question is GAME OVER? Let's have `GAME OVER` be displayed when button `B` is pressed. Add a condition for button `B` and inside it show the `GAME OVER`. ```blocks basic.showString("SELECT A BUTTON") diff --git a/docs/lessons/glowing-pendulum/activity.md b/docs/lessons/glowing-pendulum/activity.md index 209a1a57..73d529e2 100644 --- a/docs/lessons/glowing-pendulum/activity.md +++ b/docs/lessons/glowing-pendulum/activity.md @@ -47,7 +47,7 @@ basic.forever(() => { }); ``` -Since the micro:bit will be swinging back and forth, the acceleration will only be positive half of the time. Thus, to always get a positive value, we want to take the absolute value of the acceleration. +Since the @boardname@ will be swinging back and forth, the acceleration will only be positive half of the time. Thus, to always get a positive value, we want to take the absolute value of the acceleration. ```blocks @@ -64,7 +64,7 @@ basic.forever(() => { }); ``` -The function `acceleration(y)` returns a number between 0 and 1024. We want to use this value for the brightness of the micro:bit, but the `set brightness()` only accepts a value between 0 and 256. Thus, we need to divide the acceleration by 4 to ensure we will be in the appropriate range. +The function `acceleration(y)` returns a number between 0 and 1024. We want to use this value for the brightness of the @boardname@, but the `set brightness()` only accepts a value between 0 and 256. Thus, we need to divide the acceleration by 4 to ensure we will be in the appropriate range. ```blocks basic.showLeds(` @@ -82,7 +82,7 @@ basic.forever(() => { ``` -Now let's use our acceleration value to set the brightness on the micro:bit. +Now let's use our acceleration value to set the brightness on the @boardname@. ```blocks basic.showLeds(` diff --git a/docs/lessons/glowing-pendulum/challenges.md b/docs/lessons/glowing-pendulum/challenges.md index 420e36cb..c3a10a31 100644 --- a/docs/lessons/glowing-pendulum/challenges.md +++ b/docs/lessons/glowing-pendulum/challenges.md @@ -28,9 +28,9 @@ basic.forever(() => { ![](/static/mb/lessons/glowing-pendulum-0.jpg) -Hold the micro:bit in your hand in a dark room. Move the micro:bit like a pendulum and produce a slow image that captures the pattern of the micro:bit LEDs. +Hold the @boardname@ in your hand in a dark room. Move the @boardname@ like a pendulum and produce a slow image that captures the pattern of the @boardname@ LEDs. ### Challenge 2 -Replace "y" in `acceleration(y)` with "x" or "z". Changing the axis will cause the micro:bit to measure the force in a different direction. What differences in the resulting pattern does this replacement make? +Replace "y" in `acceleration(y)` with "x" or "z". Changing the axis will cause the @boardname@ to measure the force in a different direction. What differences in the resulting pattern does this replacement make? diff --git a/docs/lessons/guess-the-number/quiz-answers.md b/docs/lessons/guess-the-number/quiz-answers.md index 7c2b019a..2371da96 100644 --- a/docs/lessons/guess-the-number/quiz-answers.md +++ b/docs/lessons/guess-the-number/quiz-answers.md @@ -1,12 +1,12 @@ # guess the number quiz answers -Learn how to generate a random number on the micro:bit. +Learn how to generate a random number on the @boardname@. This is the answer key for the [guess the number quiz](/lessons/guess-the-number/quiz). ## 1. What is on button pressed? -Answers may vary. Generally, on button pressed run code when an input button is pressed. The micro:bit has two input buttons: A and B. +Answers may vary. Generally, on button pressed run code when an input button is pressed. The @boardname@ has two input buttons: A and B. ## 2. Consider the following directions diff --git a/docs/lessons/guess-the-number/quiz.md b/docs/lessons/guess-the-number/quiz.md index 81184c2a..40c5953d 100644 --- a/docs/lessons/guess-the-number/quiz.md +++ b/docs/lessons/guess-the-number/quiz.md @@ -1,6 +1,6 @@ # guess the number quiz -Learn how to generate a random number on the micro:bit. +Learn how to generate a random number on the @boardname@. ## Name diff --git a/docs/lessons/happy-birthday/activity.md b/docs/lessons/happy-birthday/activity.md index cfa3b218..d2455114 100644 --- a/docs/lessons/happy-birthday/activity.md +++ b/docs/lessons/happy-birthday/activity.md @@ -2,9 +2,9 @@ Play sounds with music blocks. -Have you ever tried to play a song on an instrument? Let's try coding the song "Happy Birthday" on the micro:bit ! +Have you ever tried to play a song on an instrument? Let's try coding the song "Happy Birthday" on the @boardname@ ! -Let's start by adding the code in the music drawer that includes a single musical chord (or pitched sound) with the `play` block. Then insert the chord "C". Once you are done coding, don't forget to run your code in the simulator or the micro:bit. +Let's start by adding the code in the music drawer that includes a single musical chord (or pitched sound) with the `play` block. Then insert the chord "C". Once you are done coding, don't forget to run your code in the simulator or the @boardname@. ```blocks music.playTone(music.noteFrequency(Note.C), music.beat(BeatFraction.Quarter)); diff --git a/docs/lessons/happy-birthday/challenges.md b/docs/lessons/happy-birthday/challenges.md index 4a32045d..514b9ce2 100644 --- a/docs/lessons/happy-birthday/challenges.md +++ b/docs/lessons/happy-birthday/challenges.md @@ -100,5 +100,5 @@ music.playTone(music.noteFrequency(Note.F), music.beat(BeatFraction.Quarter)); ### Challenge 3 -You now have a the ability to create music on the micro:bit. Try to code another favourite song. +You now have a the ability to create music on the @boardname@. Try to code another favourite song. diff --git a/docs/lessons/hero/activity.md b/docs/lessons/hero/activity.md index 997d9c81..e2896aa6 100644 --- a/docs/lessons/hero/activity.md +++ b/docs/lessons/hero/activity.md @@ -8,7 +8,7 @@ This tutorial will teach you how to create a hero game to capture food while dod ### ~ -First we need to create a function create sprite at the x, y coordinates and that set the variable called hero on the micro:bit the first time we play. +First we need to create a function create sprite at the x, y coordinates and that set the variable called hero on the @boardname@ the first time we play. ```blocks @@ -17,7 +17,7 @@ let hero = game.createSprite(2, 2) ``` -Let's set up where we want our ghost will be. Create starting positions of the hero, ghost, and food in each individual quadrant. We will ensure that the ghost, food, and hero is set apart. Divide the micro:bit into 4 quadrants. We don't want hero to be too close to the ghost so let's make the ghost starting positions in the 3 other quadrants. Hero is in the one quadrant. To do this, we need to keep track of the middle point in each quadrant. Create sprite at the x, y coordinates for the hero, food, and ghost. +Let's set up where we want our ghost will be. Create starting positions of the hero, ghost, and food in each individual quadrant. We will ensure that the ghost, food, and hero is set apart. Divide the @boardname@ into 4 quadrants. We don't want hero to be too close to the ghost so let's make the ghost starting positions in the 3 other quadrants. Hero is in the one quadrant. To do this, we need to keep track of the middle point in each quadrant. Create sprite at the x, y coordinates for the hero, food, and ghost. ```blocks let hero = game.createSprite(2, 2) diff --git a/docs/lessons/love-meter/activity.md b/docs/lessons/love-meter/activity.md index b19f59e7..b683a781 100644 --- a/docs/lessons/love-meter/activity.md +++ b/docs/lessons/love-meter/activity.md @@ -1,10 +1,10 @@ # love meter blocks activity -Create a love meter with the micro:bit +Create a love meter with the @boardname@ ### ~avatar avatar -Welcome! This activity will help you create a love meter with the micro:bit. Let's get started! +Welcome! This activity will help you create a love meter with the @boardname@. Let's get started! ### ~ @@ -28,7 +28,7 @@ input.onPinPressed(TouchPin.P0, () => { ``` -Finally, let's show that number on the micro:bit. You are registering an event handler that will execute on the @boardname@ whenever the user holds the GND pin with one hand, and presses pin 0 with the other hand, thus completing a circuit +Finally, let's show that number on the @boardname@. You are registering an event handler that will execute on the @boardname@ whenever the user holds the GND pin with one hand, and presses pin 0 with the other hand, thus completing a circuit ```blocks diff --git a/docs/lessons/love-meter/challenges.md b/docs/lessons/love-meter/challenges.md index ed3b3b73..9fc63d73 100644 --- a/docs/lessons/love-meter/challenges.md +++ b/docs/lessons/love-meter/challenges.md @@ -1,6 +1,6 @@ # love meter blocks challenges -Create a love meter with the micro:bit +Create a love meter with the @boardname@ ## Before we get started diff --git a/docs/lessons/love-meter/quiz-answers.md b/docs/lessons/love-meter/quiz-answers.md index c0cd572f..584d68fb 100644 --- a/docs/lessons/love-meter/quiz-answers.md +++ b/docs/lessons/love-meter/quiz-answers.md @@ -39,7 +39,7 @@ basic.showNumber(item + 1); You have to add 1 if you want to generate a random number between 1 and 10 . -## 5. Why do you have to hold ground (GND) to make this work on the micro:bit? +## 5. Why do you have to hold ground (GND) to make this work on the @boardname@? You have told GND to complete the circuit. diff --git a/docs/lessons/love-meter/quiz.md b/docs/lessons/love-meter/quiz.md index 92460062..b7dbca74 100644 --- a/docs/lessons/love-meter/quiz.md +++ b/docs/lessons/love-meter/quiz.md @@ -34,6 +34,6 @@ basic.showNumber(item + 1); -## 5. Describe why you must hold ground (GND) before pressing (P0) to run a program using `on pin pressed(P0)` on the micro:bit +## 5. Describe why you must hold ground (GND) before pressing (P0) to run a program using `on pin pressed(P0)` on the @boardname@ diff --git a/docs/lessons/lucky-7/quiz-answers.md b/docs/lessons/lucky-7/quiz-answers.md index dcc3be0b..faec755a 100644 --- a/docs/lessons/lucky-7/quiz-answers.md +++ b/docs/lessons/lucky-7/quiz-answers.md @@ -1,6 +1,6 @@ # lucky 7 blocks quiz answers -Show a number on the micro:bit. +Show a number on the @boardname@. This is the answer key for the [lucky 7 quiz](/lessons/lucky-7/quiz). @@ -26,7 +26,7 @@ basic.showNumber(21) ![](/static/mb/lessons/lucky-7-1.png) -## 4. Write the code that will be used to display the number 3 on the micro:bit. +## 4. Write the code that will be used to display the number 3 on the @boardname@. ![](/static/mb/lessons/lucky-7-2.png) diff --git a/docs/lessons/lucky-7/quiz.md b/docs/lessons/lucky-7/quiz.md index c1658da8..03cb3fc8 100644 --- a/docs/lessons/lucky-7/quiz.md +++ b/docs/lessons/lucky-7/quiz.md @@ -1,6 +1,6 @@ # lucky 7 blocks quiz -Show a number on the micro:bit +Show a number on the @boardname@ ## Name @@ -33,7 +33,7 @@ basic.showNumber(21) -## 4. Write the code that will be used to display the number 3 on the micro:bit. +## 4. Write the code that will be used to display the number 3 on the @boardname@. ![](/static/mb/lessons/lucky-7-3.png) diff --git a/docs/lessons/magic-8/activity.md b/docs/lessons/magic-8/activity.md index 00921bf2..4d0bb353 100644 --- a/docs/lessons/magic-8/activity.md +++ b/docs/lessons/magic-8/activity.md @@ -1,6 +1,6 @@ # magic 8 activity -Welcome! This activity will help you create a magic 8 ball on the micro:bit. Let's get started! +Welcome! This activity will help you create a magic 8 ball on the @boardname@. Let's get started! Show a string to instruct the user how to play Magic 8! The magic 8 ball can only answer true or false questions. @@ -17,7 +17,7 @@ basic.showString("ASK A QUESTION") basic.showNumber(8) ``` -Create a condition for when the micro:bit is shaken. Then use the block `clear screen` to clear the 8 from the display. +Create a condition for when the @boardname@ is shaken. Then use the block `clear screen` to clear the 8 from the display. ```blocks basic.showString("ASK A QUESTION") diff --git a/docs/lessons/magic-8/tutorial.md b/docs/lessons/magic-8/tutorial.md index 2e4b8291..f5596e5e 100644 --- a/docs/lessons/magic-8/tutorial.md +++ b/docs/lessons/magic-8/tutorial.md @@ -6,7 +6,7 @@ Show a string to instruct the user how to play Magic 8! The magic 8 ball can onl The blocks have been shuffled! Put them back together so that... * show "ASK A QUESTION" on the screen -* when the micro:bit is shaken, +* when the @boardname@ is shaken, * generate a random number between 0 and 2. * if the number is `2`, show "YES" * if the number is `1`, show "NO" diff --git a/docs/lessons/magic-logo.md b/docs/lessons/magic-logo.md index 999bd90a..ce1c14fa 100644 --- a/docs/lessons/magic-logo.md +++ b/docs/lessons/magic-logo.md @@ -17,7 +17,7 @@ On Logo Up ## Prior learning/place of lesson in scheme of work -Learn how to plot image **on logo up**, `on logo up` to run code when the micro:bit screen is facing up and vertically orientated. We will be learning how to plot an image with the logo up, basic show LEDs, and logo down. +Learn how to plot image **on logo up**, `on logo up` to run code when the @boardname@ screen is facing up and vertically orientated. We will be learning how to plot an image with the logo up, basic show LEDs, and logo down. ## Documentation ```cards @@ -34,7 +34,7 @@ basic.showLeds(` ## Objectives -* learn how to display an image on the micro:bit's LED screen -* learn how to run code when the micro:bit screen is facing down and vertically orientated -* learn how to run code when the micro:bit screen is facing up and vertically orientated +* learn how to display an image on the @boardname@'s LED screen +* learn how to run code when the @boardname@ screen is facing down and vertically orientated +* learn how to run code when the @boardname@ screen is facing up and vertically orientated diff --git a/docs/lessons/magic-logo/activity.md b/docs/lessons/magic-logo/activity.md index 6a0da659..088a82f1 100644 --- a/docs/lessons/magic-logo/activity.md +++ b/docs/lessons/magic-logo/activity.md @@ -8,7 +8,7 @@ Welcome! This tutorial will help you display an arrow pointing toward the logo! ### ~ -Using the **accelerometer** sensor, the micro:bit can detect when the **logo** is oriented **up**. We call that the **logo up** event. We will use `on logo up` to register an event handler that will run when the **logo up** event happens. +Using the **accelerometer** sensor, the @boardname@ can detect when the **logo** is oriented **up**. We call that the **logo up** event. We will use `on logo up` to register an event handler that will run when the **logo up** event happens. ```blocks input.onGesture(Gesture.LogoUp, () => { @@ -16,7 +16,7 @@ input.onGesture(Gesture.LogoUp, () => { }) ``` -When the micro:bit goes logo up, the code nested under the `on logo up` function will run. Let's add a line of code to show LEDs in there. +When the @boardname@ goes logo up, the code nested under the `on logo up` function will run. Let's add a line of code to show LEDs in there. ```blocks input.onGesture(Gesture.LogoUp, () => { @@ -30,7 +30,7 @@ input.onGesture(Gesture.LogoUp, () => { }) ``` -Run your code and try to turn around the micro:bit to see the **logo up** event in action! +Run your code and try to turn around the @boardname@ to see the **logo up** event in action! ### ~avatar boothing diff --git a/docs/lessons/night-light/activity.md b/docs/lessons/night-light/activity.md index 96422b32..ad60e38c 100644 --- a/docs/lessons/night-light/activity.md +++ b/docs/lessons/night-light/activity.md @@ -1,10 +1,10 @@ # night light activity -Change the brightness of the micro:bit. +Change the brightness of the @boardname@. ### ~avatar avatar -Welcome! This tutorial will teach you how to change the brightness of the micro:bit. Let's get started! +Welcome! This tutorial will teach you how to change the brightness of the @boardname@. Let's get started! ### ~ diff --git a/docs/lessons/pogo/activity.md b/docs/lessons/pogo/activity.md index 4861c849..92a951dd 100644 --- a/docs/lessons/pogo/activity.md +++ b/docs/lessons/pogo/activity.md @@ -12,7 +12,7 @@ basic.forever(() => { }) ``` -Since the micro:bit will be swinging up and down, we need to store the variable called jumps. We will set the variable called jumps to 0 to store the number 0. +Since the @boardname@ will be swinging up and down, we need to store the variable called jumps. We will set the variable called jumps to 0 to store the number 0. ```blocks let jumps = 0 @@ -65,7 +65,7 @@ input.onButtonPressed(Button.A, () => { }) ``` -If you press button A+B together, then reset the jump counter to 0 on the @boardname@. Finally, we will show the show the jump counter on the micro:bit +If you press button A+B together, then reset the jump counter to 0 on the @boardname@. Finally, we will show the show the jump counter on the @boardname@ ```blocks @@ -94,7 +94,7 @@ input.onButtonPressed(Button.AB, () => { ``` -We want to setup the radio communication between an additional micro:bit. We first must send number for jumps. The additional micro:bit will receive the number and show number on data received. We are now displaying the current jump count on the second micro:bit +We want to setup the radio communication between an additional @boardname@. We first must send number for jumps. The additional @boardname@ will receive the number and show number on data received. We are now displaying the current jump count on the second @boardname@ ```blocks let jumps = 0 @@ -125,7 +125,7 @@ radio.onDataPacketReceived(({ receivedNumber }) => { }) ``` -We want to stop animation so every time the number of jumps increase by 1 the second micro:bit will not also display smiley from show leds. So we add the code stop animation +We want to stop animation so every time the number of jumps increase by 1 the second @boardname@ will not also display smiley from show leds. So we add the code stop animation ```blocks let jumps = 0 @@ -159,9 +159,9 @@ radio.onDataPacketReceived(({ receivedNumber }) => { ``` -Connect the first micro:bit to your computer using your USB cable and run the pogo script on it. -Connect the second micro:bit to your computer using your USB cable and run the pogo script on it. -The first person and second person take turns jumping in the “y” direction while the other player uses the micro:bit to track the results on the micro:bit! +Connect the first @boardname@ to your computer using your USB cable and run the pogo script on it. +Connect the second @boardname@ to your computer using your USB cable and run the pogo script on it. +The first person and second person take turns jumping in the “y” direction while the other player uses the @boardname@ to track the results on the @boardname@! ```package radio diff --git a/docs/lessons/rotation-animation/quiz.md b/docs/lessons/rotation-animation/quiz.md index 9ad7bd46..ca6ca923 100644 --- a/docs/lessons/rotation-animation/quiz.md +++ b/docs/lessons/rotation-animation/quiz.md @@ -43,7 +43,7 @@ while (rotating) {
-## 4. Draw the areas on the micro:bits to illustrate the code below. Explain why you chose to draw in those areas. +## 4. Draw the areas on the @boardname@s to illustrate the code below. Explain why you chose to draw in those areas. ```blocks basic.showLeds(` diff --git a/docs/lessons/screen-wipe/activity.md b/docs/lessons/screen-wipe/activity.md index 28a53a73..30810d6e 100644 --- a/docs/lessons/screen-wipe/activity.md +++ b/docs/lessons/screen-wipe/activity.md @@ -1,12 +1,12 @@ # screen wipe blocks activity -Clear the screen by pressing buttons on the micro:bit +Clear the screen by pressing buttons on the @boardname@ ### ~avatar avatar -This activity will teach how to clear the screen by pressing button A on the micro:bit. +This activity will teach how to clear the screen by pressing button A on the @boardname@. ### ~ @@ -80,7 +80,7 @@ input.onButtonPressed(Button.A, () => { ``` -*Run* the script in the simulator or on the micro:bit to see how this works! +*Run* the script in the simulator or on the @boardname@ to see how this works! ### ~avatar boothing diff --git a/docs/lessons/screen-wipe/quiz-answers.md b/docs/lessons/screen-wipe/quiz-answers.md index 23753624..2b3e113a 100644 --- a/docs/lessons/screen-wipe/quiz-answers.md +++ b/docs/lessons/screen-wipe/quiz-answers.md @@ -4,7 +4,7 @@ Clear the screen by pressing the "A" button after an animation has been played This is the answer key for the [screen wipe quiz](/lessons/screen-wipe/quiz). -## 1. What does the function "clear screen" do on the micro:bit? +## 1. What does the function "clear screen" do on the @boardname@? This function turns off all the LED lights on the LED screen. diff --git a/docs/lessons/seismograph/activity.md b/docs/lessons/seismograph/activity.md index 06ffbc05..09f99f97 100644 --- a/docs/lessons/seismograph/activity.md +++ b/docs/lessons/seismograph/activity.md @@ -1,10 +1,10 @@ # Seismograph Activity -Welcome! In this project, you will build your own seismograph. This activity will teach how to use the micro:bit to chart the strength of the acceleration. Let's get started! Project duration: 25 minutes. +Welcome! In this project, you will build your own seismograph. This activity will teach how to use the @boardname@ to chart the strength of the acceleration. Let's get started! Project duration: 25 minutes. ### ~avatar avatar -Engineering: In this project, you will build your own seismograph micro:bit from tape and a household plate. +Engineering: In this project, you will build your own seismograph @boardname@ from tape and a household plate. ### ~ @@ -28,13 +28,13 @@ Prepare Tape: Measure and cut approximately 10mm of tape. The tape will be faste ## 2. -Fasten Tape: Fasten tape to the micro USB cable and to the plate. Attach the micro:bit to the micro:bit USB cable. +Fasten Tape: Fasten tape to the micro USB cable and to the plate. Attach the @boardname@ to the @boardname@ USB cable. ![](/static/mb/lessons/seismograph0.png) ### ~avatar avatar -Computer Science: The seismograph has been built. We are ready to program the micro:bit to be a seismograph! +Computer Science: The seismograph has been built. We are ready to program the @boardname@ to be a seismograph! ### ~ @@ -61,7 +61,7 @@ basic.forever(() => { ## 6. -At rest, the micro:bit is always subject to Earth gravity, whose magnitude is measured around ``1023``. Substract ``1023`` to measure a data close to ``0``. +At rest, the @boardname@ is always subject to Earth gravity, whose magnitude is measured around ``1023``. Substract ``1023`` to measure a data close to ``0``. ```blocks basic.forever(() => { @@ -74,7 +74,7 @@ basic.forever(() => { ### ~avatar avatar -Data Analysis: We now need to use the micro:bit to Analyze Data and chart for the strength of the acceleration. +Data Analysis: We now need to use the @boardname@ to Analyze Data and chart for the strength of the acceleration. ### ~ @@ -82,25 +82,25 @@ Data Analysis: We now need to use the micro:bit to Analyze Data and chart for th ## 7. -First, notice that moving the micro:bit in the simulator in any direction, you will change the acceleration value, which is being displayed as the same color as the micro:bit simulator. Also, notice that by moving the micro:bit simulator, there is a changing acceleration value. Second, the flat colored horizontal line will start a waving line to display the value of the strength as measured in milli-gravities. Finally, notice that the LED display will fluctate based on the movement of the micro:bit simulator. +First, notice that moving the @boardname@ in the simulator in any direction, you will change the acceleration value, which is being displayed as the same color as the @boardname@ simulator. Also, notice that by moving the @boardname@ simulator, there is a changing acceleration value. Second, the flat colored horizontal line will start a waving line to display the value of the strength as measured in milli-gravities. Finally, notice that the LED display will fluctate based on the movement of the @boardname@ simulator. ![](/static/mb/lessons/analyze20.png) ## 8. -Connect a micro:bit to your computer using your USB cable +Connect a @boardname@ to your computer using your USB cable ![](/static/mb/lessons/seismograph33.png) -Click or tap the **Download** button for the seismograph program to run the program on the micro:bit. +Click or tap the **Download** button for the seismograph program to run the program on the @boardname@. ## 9. -A black line should appear directly beneath the colored line. The black line measures the micro:bit acceleration. And the colored line measures micro:bit simulator acceleration. +A black line should appear directly beneath the colored line. The black line measures the @boardname@ acceleration. And the colored line measures @boardname@ simulator acceleration. -Run the acceleration experiment by vigarously moving the plate in any direction or move the object below the micro:bit (such as a table). +Run the acceleration experiment by vigarously moving the plate in any direction or move the object below the @boardname@ (such as a table). -Every time the micro:bit moves in any direction, you generate data points that can be reviewed in Excel later. The more attempts to move the micro:bit, the more data to be reviewed in Excel. +Every time the @boardname@ moves in any direction, you generate data points that can be reviewed in Excel later. The more attempts to move the @boardname@, the more data to be reviewed in Excel. ![](/static/mb/lessons/seismograph5.png) @@ -108,19 +108,19 @@ Every time the micro:bit moves in any direction, you generate data points that Please find seismogrph experiment obervations: -First, notice that moving the micro:bit in any direction, you will change the acceleration value, which is being displayed as a milli-gravities value. By moving the micro:bit, there will be a changing acceleration value. +First, notice that moving the @boardname@ in any direction, you will change the acceleration value, which is being displayed as a milli-gravities value. By moving the @boardname@, there will be a changing acceleration value. ![](/static/mb/lessons/seismograph7.png) -Second, the horizontal line will move to plot the value of the strength as measured in milli-gravities. The horizontal line's movement is based on the micro:bit acceleration in Magnitude or Strength. +Second, the horizontal line will move to plot the value of the strength as measured in milli-gravities. The horizontal line's movement is based on the @boardname@ acceleration in Magnitude or Strength. ![](/static/mb/lessons/seismograph6.png) -Third, notice that the LED display fluctates based on the movement of the micro:bit. +Third, notice that the LED display fluctates based on the movement of the @boardname@. ![](/static/mb/lessons/seismograph8.png) -Now we are ready to graph or chart the accceleration of the micro:bit. We want a printout of the micro:bit acceleration graphed in Excel. +Now we are ready to graph or chart the accceleration of the @boardname@. We want a printout of the @boardname@ acceleration graphed in Excel. ## 11. @@ -141,7 +141,7 @@ Click or tap Download data ## 13. -A CSV file will be generated to display the data points collected by the micro:bit. Click or tap on the data Excel file that was downloaded to your local Downloads Folder. +A CSV file will be generated to display the data points collected by the @boardname@. Click or tap on the data Excel file that was downloaded to your local Downloads Folder. ![](/static/mb/lessons/analyze9.png) @@ -149,7 +149,7 @@ A CSV file will be generated to display the data points collected by the micro:b Select the data that you want to include in your chart. The chart should include the first two columns: time and acceleration. -Click or tap on the first two columns (A, B) to include time and acceleration data from the micro:bit +Click or tap on the first two columns (A, B) to include time and acceleration data from the @boardname@ ## 15. diff --git a/docs/lessons/seismograph/challenge.md b/docs/lessons/seismograph/challenge.md index 71c5a04c..52c59426 100644 --- a/docs/lessons/seismograph/challenge.md +++ b/docs/lessons/seismograph/challenge.md @@ -5,7 +5,7 @@ Coding challenges for the seismograph. ### ~avatar avatar -Engineering: In this project, you will build a remote control based on the seismograph micro:bit activity using a second micro:bit and micro USB cable. +Engineering: In this project, you will build a remote control based on the seismograph @boardname@ activity using a second @boardname@ and micro USB cable. ### ~ @@ -31,13 +31,13 @@ basic.forever(() => { ``` ### ~avatar avatar -Computer Science: Welcome! The activity will teach you how to code the acceleration of the 1st micro:bit and to visualize the acceleration on the 2nd micro:bit. Let's get started! +Computer Science: Welcome! The activity will teach you how to code the acceleration of the 1st @boardname@ and to visualize the acceleration on the 2nd @boardname@. Let's get started! ### ~ # Computer Science Steps ## 1. -We want to simply detach the blocks from the recent activity. We will use blocks from the activity to create a brand new program to show the way micro:bit devices communicate through the BLE (Bluetooth low energy) radio. +We want to simply detach the blocks from the recent activity. We will use blocks from the activity to create a brand new program to show the way @boardname@ devices communicate through the BLE (Bluetooth low energy) radio. ```shuffle basic.forever(() => { @@ -47,7 +47,7 @@ basic.forever(() => { ``` ## 2. -Let's measure `acceleration (mg)` and then `send number`. `Acceleration` is measured in **milli-gravities**, so a value of -1000 is equivalent to -1g or -9.81m/s^2. We will be able to get the acceleration value (g-force), in the specified "x" dimension. `Send number` will broadcast a number data packet to other micro:bits connected via radio. +Let's measure `acceleration (mg)` and then `send number`. `Acceleration` is measured in **milli-gravities**, so a value of -1000 is equivalent to -1g or -9.81m/s^2. We will be able to get the acceleration value (g-force), in the specified "x" dimension. `Send number` will broadcast a number data packet to other @boardname@s connected via radio. We need add send number block found in the Radio drawer. We will attach send number to acceleration and subtract the gravity from acceleration strength. @@ -84,7 +84,7 @@ radio.onDataPacketReceived(() => { ``` ## 5. -Finally, we want to chart the acceleration. So we must first implement `plot bar graph`. `Plot Bar Graph` will display a vertical bar graph based on the value and high value. In order to transfer the receive the number from the 1st micro:bit, we must implement `receive number` to constantly display a vertical bar graph based on the value. Remember, the value will equal to the micro:bit's acceleration in the "x" direction. +Finally, we want to chart the acceleration. So we must first implement `plot bar graph`. `Plot Bar Graph` will display a vertical bar graph based on the value and high value. In order to transfer the receive the number from the 1st @boardname@, we must implement `receive number` to constantly display a vertical bar graph based on the value. Remember, the value will equal to the @boardname@'s acceleration in the "x" direction. Your finished code will look like this: @@ -98,41 +98,41 @@ radio.onDataPacketReceived(({ receivedNumber }) => { ``` ### ~avatar avatar -Science: Welcome! The activity will teach you how to chart the acceleration of the 1st micro:bit and to visualize the acceleration on the 2nd micro:bit. Let's get started! +Science: Welcome! The activity will teach you how to chart the acceleration of the 1st @boardname@ and to visualize the acceleration on the 2nd @boardname@. Let's get started! ### ~ # Science Steps ## 6. -First, notice that moving the 1st micro:bit in the simulator in any direction, you will change the acceleration value of the 2nd micro:bit. Also, notice that by moving the micro:bit simulator, there is a changing acceleration value of the second micro:bit. Second, the flat colored horizontal line will start a waving line on the 2nd micro:bit to display the value of the strength as measured in milli-gravities. Finally, notice that the LED display will fluctate based on the movement of the 2nd micro:bit simulator. +First, notice that moving the 1st @boardname@ in the simulator in any direction, you will change the acceleration value of the 2nd @boardname@. Also, notice that by moving the @boardname@ simulator, there is a changing acceleration value of the second @boardname@. Second, the flat colored horizontal line will start a waving line on the 2nd @boardname@ to display the value of the strength as measured in milli-gravities. Finally, notice that the LED display will fluctate based on the movement of the 2nd @boardname@ simulator. ![](/static/mb/lessons/seis_challenge02.png) ## 7. -Connect the 2nd micro:bit to your computer using your USB cable. We should have two micro:bit devices attached to the computer. +Connect the 2nd @boardname@ to your computer using your USB cable. We should have two @boardname@ devices attached to the computer. ![](/static/mb/lessons/seismograph33.png) ## 8. -Click or tap the **Download** button for the seismograph program to run the program on the 1st micro:bit and 2nd micro:bit. +Click or tap the **Download** button for the seismograph program to run the program on the 1st @boardname@ and 2nd @boardname@. ## 9. -The black lines should appear directly beneath the colored lines. The black lines measure the micro:bit acceleration. And the colored lines measures micro:bit simulator acceleration. +The black lines should appear directly beneath the colored lines. The black lines measure the @boardname@ acceleration. And the colored lines measures @boardname@ simulator acceleration. ![](/static/mb/lessons/seis_challenge05.png) -Run the acceleration experiment by vigarously moving the plate in any direction or move the object below the micro:bit (such as a table). +Run the acceleration experiment by vigarously moving the plate in any direction or move the object below the @boardname@ (such as a table). ![](/static/mb/lessons/seis_challenge06.png) -Every time the micro:bit moves in any direction, you generate data points that can be reviewed in Excel later. The more attempts to move the micro:bit, the more data to be reviewed in Excel. Notice that the LED on the 2nd micro:bit changes to communicate the movement of the 1st micro:bit. +Every time the @boardname@ moves in any direction, you generate data points that can be reviewed in Excel later. The more attempts to move the @boardname@, the more data to be reviewed in Excel. Notice that the LED on the 2nd @boardname@ changes to communicate the movement of the 1st @boardname@. ![](/static/mb/lessons/seis_challenge04.png) -Now we are ready to graph or chart the accceleration of the micro:bit. We want a printout of the micro:bit acceleration graphed in Excel. +Now we are ready to graph or chart the accceleration of the @boardname@. We want a printout of the @boardname@ acceleration graphed in Excel. ## 10. @@ -153,7 +153,7 @@ Click or tap Download data ## 12. -A CSV file will be generated to display the data points collected by the micro:bit. Click or tap on the data Excel file that was downloaded to your local Downloads Folder. +A CSV file will be generated to display the data points collected by the @boardname@. Click or tap on the data Excel file that was downloaded to your local Downloads Folder. ![](/static/mb/lessons/analyze9.png) @@ -161,7 +161,7 @@ A CSV file will be generated to display the data points collected by the micro:b Select the data that you want to include in your chart. The chart should include the first two columns: time and acceleration. -Click or tap on the first two columns (A, B) to include time and acceleration data from the micro:bit. We only need the first two columns (A, B) because the 2nd micro:bit changes have been communicated by the 1st micro:bit. So the data points of the seismograph are being recorded on the 1st micro:bit. +Click or tap on the first two columns (A, B) to include time and acceleration data from the @boardname@. We only need the first two columns (A, B) because the 2nd @boardname@ changes have been communicated by the 1st @boardname@. So the data points of the seismograph are being recorded on the 1st @boardname@. ## 14. @@ -192,8 +192,8 @@ Let's select Style 10 as an example. ### ~ * Have fun reviewing your seismograph data and analyzing the acceleration with Excel. -* The first person and second person take shaking or moving the micor:bit in any direction while the other player charts the data on the micro:bit! -* Review and analyze the actual micro:bit device acceleration data on Excel +* The first person and second person take shaking or moving the micor:bit in any direction while the other player charts the data on the @boardname@! +* Review and analyze the actual @boardname@ device acceleration data on Excel ```package radio diff --git a/docs/lessons/smiley/quiz-answers.md b/docs/lessons/smiley/quiz-answers.md index 878edca5..167e9954 100644 --- a/docs/lessons/smiley/quiz-answers.md +++ b/docs/lessons/smiley/quiz-answers.md @@ -12,7 +12,7 @@ A function that will display an image on the LED screen
-The extra empty image with show LED creates a blinking smiley, allowing the micro:bit to alternate between showing the smiley and the empty screen. +The extra empty image with show LED creates a blinking smiley, allowing the @boardname@ to alternate between showing the smiley and the empty screen. ## 3. Draw the image created with this code diff --git a/docs/lessons/spinner/activity.md b/docs/lessons/spinner/activity.md index 425612e4..7fbce5d0 100644 --- a/docs/lessons/spinner/activity.md +++ b/docs/lessons/spinner/activity.md @@ -10,7 +10,7 @@ Create an arrow that randomly points to a player. Welcome! This guided tutorial will teach how to program a script that randomly points to a player. Let's get started! -Let's begin by adding an `on shake` condition to know when the micro:bit is shaken. +Let's begin by adding an `on shake` condition to know when the @boardname@ is shaken. ```blocks input.onGesture(Gesture.Shake, () => { diff --git a/docs/lessons/strobe-light/activity.md b/docs/lessons/strobe-light/activity.md index 2d70ba92..6364705f 100644 --- a/docs/lessons/strobe-light/activity.md +++ b/docs/lessons/strobe-light/activity.md @@ -10,7 +10,7 @@ Welcome! This guided tutorial will teach how to develop shapes with a for loop. ### ~ -Create a `for loop` that will loop from 0 to 4 to indicate the x-coordinates of the micro:bit display. +Create a `for loop` that will loop from 0 to 4 to indicate the x-coordinates of the @boardname@ display. ```blocks for (let i = 0; i < 5; i++) { @@ -19,7 +19,7 @@ for (let i = 0; i < 5; i++) { ``` -Create another for loop that will loop from 0 to 4, indicating the y-coordinates of the micro:bit instead. This for loop will light each LED by column. +Create another for loop that will loop from 0 to 4, indicating the y-coordinates of the @boardname@ instead. This for loop will light each LED by column. ```blocks diff --git a/docs/lessons/temperature.md b/docs/lessons/temperature.md index a2442fbb..d906b2e7 100644 --- a/docs/lessons/temperature.md +++ b/docs/lessons/temperature.md @@ -13,7 +13,7 @@ Temperature ## Prior learning/place of lesson in scheme of work -Learn how to get the ambient temperature (degree Celsius °C). The temperature is inferred from the the surface temperature of the various chips on the micro:bit. We will be learning how to get the temperature using on shake, local variables, as well as simple commands such as show number. +Learn how to get the ambient temperature (degree Celsius °C). The temperature is inferred from the the surface temperature of the various chips on the @boardname@. We will be learning how to get the temperature using on shake, local variables, as well as simple commands such as show number. ## Documentation @@ -28,5 +28,5 @@ input.onGesture(Gesture.Shake, () => {}) ## Objectives * learn how to create a variable to store data -* learn how to get the ambient temperature (degree Celsius °C). The temperature is inferred from the the surface temperature of the various chips on the micro:bit. +* learn how to get the ambient temperature (degree Celsius °C). The temperature is inferred from the the surface temperature of the various chips on the @boardname@. * learn how to show a number on the LED screen diff --git a/docs/lessons/temperature/activity.md b/docs/lessons/temperature/activity.md index 4cea83ab..cb0e6a96 100644 --- a/docs/lessons/temperature/activity.md +++ b/docs/lessons/temperature/activity.md @@ -1,10 +1,10 @@ # temperature activity -Measure the temperature on the micro:bit +Measure the temperature on the @boardname@ -Welcome! This activity will teach how to measure the temperature on the micro:bit. Let's get started! +Welcome! This activity will teach how to measure the temperature on the @boardname@. Let's get started! -We want to display the temperature on shake. In order to do so, we need to register the event `on shake` that will execute whenever the user shakes the micro:bit; in the web browser, click the button labelled "SHAKE" under the simulator to generate a shake event +We want to display the temperature on shake. In order to do so, we need to register the event `on shake` that will execute whenever the user shakes the @boardname@; in the web browser, click the button labelled "SHAKE" under the simulator to generate a shake event ```blocks input.onGesture(Gesture.Shake, () => { diff --git a/docs/lessons/truth-or-dare/activity.md b/docs/lessons/truth-or-dare/activity.md index 0d15c81a..84dcda48 100644 --- a/docs/lessons/truth-or-dare/activity.md +++ b/docs/lessons/truth-or-dare/activity.md @@ -6,7 +6,7 @@ A multi-player game that forces each player to reveal a secret or something funn -Welcome! This tutorial will teach how to program a game of truth or dare on the micro:bit. Let's get started! +Welcome! This tutorial will teach how to program a game of truth or dare on the @boardname@. Let's get started! ### ~ @@ -23,7 +23,7 @@ basic.showLeds(` ``` -Now let's create a condition to know when button `A` is pressed so that we can display "truth" or "dare" on the micro:bit. We want the @boardname@ to randomly choose whether to display "truth" or display "dare". We can use accomplish this by using `pick random (1)`. +Now let's create a condition to know when button `A` is pressed so that we can display "truth" or "dare" on the @boardname@. We want the @boardname@ to randomly choose whether to display "truth" or display "dare". We can use accomplish this by using `pick random (1)`. ```blocks basic.showLeds(` diff --git a/docs/lessons/truth-or-dare/challenges.md b/docs/lessons/truth-or-dare/challenges.md index 20f36ff0..88c7df29 100644 --- a/docs/lessons/truth-or-dare/challenges.md +++ b/docs/lessons/truth-or-dare/challenges.md @@ -64,7 +64,7 @@ input.onButtonPressed(Button.A, () => { ### Challenge 2 -Instead of just saying "TRUTH" or "DARE", let's sometimes say "SKIP". This would allow the skipped person to spin the micro:bit without completing a truth or dare. Modify the if statement as shown. +Instead of just saying "TRUTH" or "DARE", let's sometimes say "SKIP". This would allow the skipped person to spin the @boardname@ without completing a truth or dare. Modify the if statement as shown. ``` blocks basic.showLeds(` @@ -100,5 +100,5 @@ input.onButtonPressed(Button.A, () => { ### Challenge 3 -Add some other messages, such as "TWO DARES" for the micro:bit to show. You will need to modify the parameter inside `pick random (3)` as well as adding another `if` condition. +Add some other messages, such as "TWO DARES" for the @boardname@ to show. You will need to modify the parameter inside `pick random (3)` as well as adding another `if` condition. diff --git a/docs/lessons/truth-or-dare/tutorial.md b/docs/lessons/truth-or-dare/tutorial.md index f35ddf74..7294f200 100644 --- a/docs/lessons/truth-or-dare/tutorial.md +++ b/docs/lessons/truth-or-dare/tutorial.md @@ -5,7 +5,7 @@ The *Truth or dare!* game works as follows: a player spins the @boardname@ on the table. -When the micro:bit stops spinning, the player pointed by the arrow (displayed on screen) must press the button "A" +When the @boardname@ stops spinning, the player pointed by the arrow (displayed on screen) must press the button "A" to see if she has to provide a *truth* or a *dare*. ### ~ @@ -13,7 +13,7 @@ to see if she has to provide a *truth* or a *dare*. ### Rebuild the game! The blocks have been shuffled! Put them back together so that... -* an up arrow is displayed when the micro:bit is powered on. +* an up arrow is displayed when the @boardname@ is powered on. * on button `A` is pressed, * randomly display "TRUTH" or "DARE" on the screen * show the up arrow again. diff --git a/docs/lessons/zoomer.md b/docs/lessons/zoomer.md index a839b6a6..1c842362 100644 --- a/docs/lessons/zoomer.md +++ b/docs/lessons/zoomer.md @@ -1,6 +1,6 @@ # zoomer blocks lesson -measure the acceleration on the micro:bit in the "z" direction. +measure the acceleration on the @boardname@ in the "z" direction. diff --git a/docs/lessons/zoomer/activity.md b/docs/lessons/zoomer/activity.md index ad595a38..cdc69dff 100644 --- a/docs/lessons/zoomer/activity.md +++ b/docs/lessons/zoomer/activity.md @@ -1,6 +1,6 @@ # zoomer block activity -Measure the acceleration on the micro:bit in the "z" direction. +Measure the acceleration on the @boardname@ in the "z" direction. ### ~avatar avatar @@ -8,7 +8,7 @@ Measure the acceleration on the micro:bit in the "z" direction. ### ~ -Welcome! This activity will teach how to measure the acceleration on the micro:bit in the "z" direction. Let's get started! +Welcome! This activity will teach how to measure the acceleration on the @boardname@ in the "z" direction. Let's get started! We want to display the acceleration forever. In order to do so, we need a `forever` loop. diff --git a/docs/lessons/zoomer/quiz-answers.md b/docs/lessons/zoomer/quiz-answers.md index a58e7078..4b240242 100644 --- a/docs/lessons/zoomer/quiz-answers.md +++ b/docs/lessons/zoomer/quiz-answers.md @@ -1,6 +1,6 @@ # zoomer quiz answers -Measure the acceleration on the micro:bit in the "z" direction. +Measure the acceleration on the @boardname@ in the "z" direction. This is the answer key for the [zoomer quiz](/lessons/zoomer/quiz). diff --git a/docs/lessons/zoomer/quiz.md b/docs/lessons/zoomer/quiz.md index e9524f01..6a72bdda 100644 --- a/docs/lessons/zoomer/quiz.md +++ b/docs/lessons/zoomer/quiz.md @@ -1,6 +1,6 @@ # zoomer quiz -Measure the acceleration on the micro:bit in the "z" direction. +Measure the acceleration on the @boardname@ in the "z" direction. ## Name diff --git a/docs/packages.md b/docs/packages.md index 06036854..e2e758b3 100644 --- a/docs/packages.md +++ b/docs/packages.md @@ -35,7 +35,7 @@ This file contains a map from the symbol name to the en ``` { ... - "basic": "Provides access to basic micro:bit functionality.", + "basic": "Provides access to common functionality.", ... } ``` diff --git a/docs/projects.md b/docs/projects.md index 3d98e3b9..683f7214 100644 --- a/docs/projects.md +++ b/docs/projects.md @@ -1,10 +1,10 @@ # Projects -Here are some cool projects that you can build with your micro:bit! +Here are some cool projects that you can build with your @boardname@! ## Games -Fun games to build with your micro:bit. +Fun games to build with your @boardname@. ```codecard [{ @@ -72,7 +72,7 @@ Fun games to build with your micro:bit. ## From the community -Projects contributed by the micro:bit community +Projects contributed by the @boardname@ community ```codecard [{ diff --git a/docs/projects/banana-keyboard.md b/docs/projects/banana-keyboard.md index 475243b2..d4f519f9 100644 --- a/docs/projects/banana-keyboard.md +++ b/docs/projects/banana-keyboard.md @@ -4,7 +4,7 @@ ### ~avatar -Build your own micro:bit piano using bananas! +Build your own @boardname@ piano using bananas! ### ~ @@ -14,7 +14,7 @@ Build your own micro:bit piano using bananas! ## Materials -* micro:bit, battery holder and 2 AAA batteries +* @boardname@, battery holder and 2 AAA batteries * Bananas * Orange * Crocodile clips diff --git a/docs/projects/banana-keyboard/making.md b/docs/projects/banana-keyboard/making.md index a591f992..d9e5cbec 100644 --- a/docs/projects/banana-keyboard/making.md +++ b/docs/projects/banana-keyboard/making.md @@ -2,7 +2,7 @@ ## Materials -* micro:bit, battery holder and 2 AAA batteries +* @boardname@, battery holder and 2 AAA batteries * Bananas * Orange * Crocodile clips @@ -13,7 +13,7 @@ ![](/static/mb/lessons/banana-keyboard-1.png) -Using the 1st crocodile clip, connect the end of the crocodile clip onto GND pin on the micro:bit. +Using the 1st crocodile clip, connect the end of the crocodile clip onto GND pin on the @boardname@. ### Step 2 @@ -21,7 +21,7 @@ Using the 1st crocodile clip, connect the end of the crocodile clip onto GND pin ![](/static/mb/lessons/banana-keyboard-3.png) -Using the 2nd crocodile clip, connect the end of the crocodile clip onto the 0 pin on the micro:bit. +Using the 2nd crocodile clip, connect the end of the crocodile clip onto the 0 pin on the @boardname@. ### Step 3 @@ -55,7 +55,7 @@ Using the 3rd crocodile clip, connect the unattached end of the crocodile clip o ![](/static/mb/lessons/banana-keyboard-10.png) -Using the 4th crocodile clip, connect the end of the crocodile clip onto pin 1 on the micro:bit. +Using the 4th crocodile clip, connect the end of the crocodile clip onto pin 1 on the @boardname@. ### Step 8 @@ -71,7 +71,7 @@ Your banana keyboard is ready! ### Step 10 -Connect your micro:bit to your computer using your USB cable and run this script: +Connect your @boardname@ to your computer using your USB cable and run this script: ```blocks input.onPinPressed(TouchPin.P1, () => { music.playTone(music.noteFrequency(Note.C), music.beat(BeatFraction.Quarter)); diff --git a/docs/projects/compass.md b/docs/projects/compass.md index 13dda5c6..f22ffe04 100644 --- a/docs/projects/compass.md +++ b/docs/projects/compass.md @@ -2,11 +2,11 @@ ![](/static/mb/projects/a5-compass.png) -Display the direction that the micro:bit is facing using the compass +Display the direction that the @boardname@ is facing using the compass ### ~avatar avatar -Welcome! This guided tutorial will show you how to program a script that displays the direction the micro:bit is pointing. Let's get started! +Welcome! This guided tutorial will show you how to program a script that displays the direction the @boardname@ is pointing. Let's get started! ### ~ @@ -24,7 +24,7 @@ basic.forever(() => { ## Step 2 -Store the reading of the micro:bit in a variable called `degrees`. +Store the reading of the @boardname@ in a variable called `degrees`. ```blocks basic.forever(() => { @@ -34,7 +34,7 @@ basic.forever(() => { ## Step 3 -If `degrees` is less than `45`, then the compass heading is mostly pointing toward North. Display `N` on the micro:bit. +If `degrees` is less than `45`, then the compass heading is mostly pointing toward North. Display `N` on the @boardname@. ```blocks basic.forever(() => { @@ -47,7 +47,7 @@ basic.forever(() => { ## Step 4 -If `degrees` is less than 135, the micro:bit is mostly pointing East. Display `E` on the micro:bit. +If `degrees` is less than 135, the @boardname@ is mostly pointing East. Display `E` on the @boardname@. ```blocks @@ -64,7 +64,7 @@ basic.forever(() => { ## Step 5 -If `degrees` is less than 225, the micro:bit is mostly pointing South. Display `S` on the micro:bit. +If `degrees` is less than 225, the @boardname@ is mostly pointing South. Display `S` on the @boardname@. ```blocks @@ -84,7 +84,7 @@ basic.forever(() => { ## Step 6 -If none of these conditions returned true, then the micro:bit must be pointing West. Display `W` on the micro:bit. +If none of these conditions returned true, then the @boardname@ must be pointing West. Display `W` on the @boardname@. ```blocks basic.forever(() => { diff --git a/docs/projects/guitar.md b/docs/projects/guitar.md index 3a1dcbc1..b7520c1e 100644 --- a/docs/projects/guitar.md +++ b/docs/projects/guitar.md @@ -2,14 +2,14 @@ ![guitar icon](/static/mb/projects/guitar.png) -### @description A beginner-intermediate maker activity, building a guitar with the micro:bit +### @description A beginner-intermediate maker activity, building a guitar with the @boardname@ ### ~avatar avatar -Make a micro:bit guitar with this guided tutorial! +Make a @boardname@ guitar with this guided tutorial! ### ~ -*playing micro:bit guitar* +*playing @boardname@ guitar* https://youtu.be/GYmdTFvxz80 ## Duration @@ -23,7 +23,7 @@ https://youtu.be/GYmdTFvxz80 * Markers and/or paint * Aluminum Foil * Scissors that can cut cardboard -* 1 micro:bit, battery holder and 2 AAA batteries +* 1 @boardname@, battery holder and 2 AAA batteries * 4-5 Crocodile clips * Headphones diff --git a/docs/projects/guitar/accelerometer.md b/docs/projects/guitar/accelerometer.md index b5fd2bb6..925fb549 100644 --- a/docs/projects/guitar/accelerometer.md +++ b/docs/projects/guitar/accelerometer.md @@ -1,6 +1,6 @@ # Accelerometer Beat control -### @description micro:bit guitar: using accelerometer to control tempo +### @description @boardname@ guitar: using accelerometer to control tempo ### ~avatar avatar @@ -33,18 +33,18 @@ Math.abs(1) ## Accelerometer, gravity and tilting! -The micro:bit contains an **accelerometer** sensor that is able to measure forces applied to the board. +The @boardname@ contains an **accelerometer** sensor that is able to measure forces applied to the board. On earth, we are subject to the **gravity force** which pulls us to the ground! https://youtu.be/0SULoTKmkhI -When the micro:bit is flat on a table, with the screen pointing up, the gravity force is aligned -with the **Z** axis of the micro:bit. +When the @boardname@ is flat on a table, with the screen pointing up, the gravity force is aligned +with the **Z** axis of the @boardname@. -![micro:bit x, y, z axis image](/static/mb/projects/guitar/accelleration_axis.png) +![@boardname@ x, y, z axis image](/static/mb/projects/guitar/accelleration_axis.png) If you tilt it up and down, the force will align with the **Y** axis -- this is how we can detect tilting!!! -If the force along **Y** grows, the micro:bit is tilting more and more vertically! +If the force along **Y** grows, the @boardname@ is tilting more and more vertically! ## Measuring Acceleration along different coordinates (X, Y, Z axis) @@ -59,7 +59,7 @@ basic.forever(() => { ``` **Create the code** that measures the change in the Y axis acceleration as a graph on the LEDs -**Dowload the code** to the micro:bit +**Dowload the code** to the @boardname@ **Test the movements that move the graph from 1 to 5 bars on the LEDs** @@ -74,7 +74,7 @@ Try graphing the acceleration along the **X** and **Z** axis. Can you explain th ### ~ ### Step 2: Mapping acceleration to Beat -**micro:bit sensors produce signal values between 0 to 1023. The *[map block](/reference/pins/map)* converts the signal to a desired range.** +**@boardname@ sensors produce signal values between 0 to 1023. The *[map block](/reference/pins/map)* converts the signal to a desired range.** ```blocks basic.forever(() => { music.setTempo(pins.map(Math.abs(input.acceleration(Dimension.Y)), @@ -86,7 +86,7 @@ basic.forever(() => { **Create the code** that *Maps* Y axis acceleration as *tempo* -**Download the code** to the micro:bit on the guitar +**Download the code** to the @boardname@ on the guitar **Test the movements that speed and slow the tempo** @@ -106,7 +106,7 @@ basic.forever(() => { ``` **Combine the code above with the light sensor tone control code from the previous activity** -**Download the code** to the micro:bit on the guitar +**Download the code** to the @boardname@ on the guitar ### Now play the guitar adjusting tone and tempo using the light sensor and accelerometer! diff --git a/docs/projects/guitar/displaybuttons.md b/docs/projects/guitar/displaybuttons.md index 1021af19..8b003ade 100644 --- a/docs/projects/guitar/displaybuttons.md +++ b/docs/projects/guitar/displaybuttons.md @@ -1,5 +1,5 @@ # Buttons, Display & Sound -### @description micro:bit guitar: using buttons with display and sound +### @description @boardname@ guitar: using buttons with display and sound ### ~avatar avatar Use Button Events to control LED Display and play Sound @@ -14,9 +14,9 @@ Use Button Events to control LED Display and play Sound ## Materials -A micro:bit, battery pack and 2 x AAA batteries +A @boardname@, battery pack and 2 x AAA batteries -![battery pack and micro:bit](/static/mb/projects/guitar/microbit.jpg) +![battery pack and @boardname@](/static/mb/projects/guitar/microbit.jpg) 2 to 4 crocodile clips @@ -56,9 +56,9 @@ Open [pxt.microbit.org](https://pxt.microbit.org) in your web browser From **Basics**, drag a **show LEDs** block into the coding area * Create a face with LEDs -![micro:bit USB connection](/static/mb/projects/guitar/connectmicrobit.jpg) -Connect your micro:bit to your computer via USB and click **`Download`**. -Follow the instructions to move the code to your micro:bit. +![@boardname@ USB connection](/static/mb/projects/guitar/connectmicrobit.jpg) +Connect your @boardname@ to your computer via USB and click **`Download`**. +Follow the instructions to move the code to your @boardname@. ## Step 2: Add Smiley LED Button Events ```blocks @@ -88,7 +88,7 @@ From **Input**, drag an **on button 'A' pressed** block into the coding area * Create a 'B' button block with a different LED face -* Download the code to your micro:bit and try the A & B buttons +* Download the code to your @boardname@ and try the A & B buttons ## Step 3: Add Headphone Speakers using Crocodile clips @@ -100,16 +100,16 @@ Connect **GND** to the **base of the headphone jack** using a second crocodile c Connect **pin 0** to the **tip of the headphone jack** with a crocodile clip -*attaching batteries and micro:bit* +*attaching batteries and @boardname@* https://youtu.be/zwRTmpKIaVU -Attach the micro:bit & battery-pack to the guitar body +Attach the @boardname@ & battery-pack to the guitar body *connecting headphone speaker* https://youtu.be/ewyEW_U5G9M Connect the headphones with crocodile clips ### ~hint -## The micro:bit can play music +## The @boardname@ can play music The **play tone** block allows a range letter note tones from **C** to **B5**. Songs are played using sequences notes. Like the beginning of a birthday song (C, C, D, C, F, E). @@ -160,7 +160,7 @@ From **Music**, drag **play tone *C* for *1* beat** block under the **show leds* **Repeat** for **Button B** event -**Download the code** to the micro:bit +**Download the code** to the @boardname@ **Try the A & B buttons** with headphones and power connected diff --git a/docs/projects/guitar/lightsensor.md b/docs/projects/guitar/lightsensor.md index 18572da6..020d240a 100644 --- a/docs/projects/guitar/lightsensor.md +++ b/docs/projects/guitar/lightsensor.md @@ -1,6 +1,6 @@ # Light Sensor Tone control -### @description micro:bit guitar: using light sensor to control tone +### @description @boardname@ guitar: using light sensor to control tone ### ~avatar avatar @@ -20,9 +20,9 @@ Use the Light Sensor to the control tone for this [Theremin](https://en.wikipedi *playing tones with light sensor* https://youtu.be/2cKg9pokVC4 -## The micro:bit LEDs Light Sensors +## The @boardname@ LEDs Light Sensors -- the micro:bit can detect external light level intensity reaching the LEDs +- the @boardname@ can detect external light level intensity reaching the LEDs - the light level block reports a reading of values 0 (*dark*) to 255 (*bright*) - a **Forever Loop** is required to continually measure the current light level and control the tone @@ -65,7 +65,7 @@ Experiment to see the effect on graph height when the **plot bar graph** value * ### Frequency **Frequency** measured in Hz which are cycles per second or vibrations per second * A healthy human ear can detect frequencies in the range of 20Hz to 20,000Hz. - * The micro:bit + headphones reliably produce detectable output ~50Hz - 6,000Hz. + * The @boardname@ + headphones reliably produce detectable output ~50Hz - 6,000Hz. **261Hz** represents a C note ```blocks @@ -89,7 +89,7 @@ Create a **play tone** block using a **Math** section, **multiplication** block ### Next **Add** a **B** button block that multiplies the **261** tone by a number other than 2 to set tone -**Download the code to the micro:bit** +**Download the code to the @boardname@** **Test the sound for multiples of the 261Hz *C* frequency** diff --git a/docs/projects/guitar/making.md b/docs/projects/guitar/making.md index caef815b..b09c0a47 100644 --- a/docs/projects/guitar/making.md +++ b/docs/projects/guitar/making.md @@ -1,9 +1,9 @@ # Making the Guitar Body -### @description Maker Project for Guitar Body for micro:bit +### @description Maker Project for Guitar Body for @boardname@ ### ~avatar avatar -Make the Guitar Body for your micro:bit Guitar +Make the Guitar Body for your @boardname@ Guitar ### ~ diff --git a/docs/projects/guitar/pinpress.md b/docs/projects/guitar/pinpress.md index 65ed21b7..a0d3ad66 100644 --- a/docs/projects/guitar/pinpress.md +++ b/docs/projects/guitar/pinpress.md @@ -1,6 +1,6 @@ # Pin Press Switch -### @description micro:bit guitar: use pin press to toggle guitar play on/off +### @description @boardname@ guitar: use pin press to toggle guitar play on/off ### ~avatar avatar Use pin press to switch guitar play on/off @@ -55,15 +55,15 @@ input.onPinPressed(TouchPin.P2, () => { ``` **Create the pin-press code** -**Download the code** on the micro:bit +**Download the code** on the @boardname@ https://youtu.be/PAIU-vHqyGU -**Hold the micro:bit touching The GND pin with one hand** +**Hold the @boardname@ touching The GND pin with one hand** **with the other hand alternately touch the 0, 1 and 2 pins** ### ~hint -**The electric signal traveled from pins, between your hands to `GND` and the micro:bit detected the electric signal!** +**The electric signal traveled from pins, between your hands to `GND` and the @boardname@ detected the electric signal!** ### ~ ## Step 2: Installing conductive foil on the guitar @@ -78,7 +78,7 @@ https://youtu.be/YkymZGNmkrE **Connect the foil to `pin 1` using a crocodile clip** ## Step 3: Add a switch to turn the guitar ON and OFF -**Using the `on` global variable we can switch the message on the micro:bit** +**Using the `on` global variable we can switch the message on the @boardname@** **between ON and OFF** ```blocks let on = false @@ -99,7 +99,7 @@ input.onPinPressed(TouchPin.P1, () => { ``` **Create the ON/OFF switch code** -**Download the code on the micro:bit** +**Download the code on the @boardname@** **Test by touching `P1` to toggle the LED message between ON and OFF** diff --git a/docs/projects/hack-your-headphones.md b/docs/projects/hack-your-headphones.md index a57329d3..61799182 100644 --- a/docs/projects/hack-your-headphones.md +++ b/docs/projects/hack-your-headphones.md @@ -4,7 +4,7 @@ ### ~avatar -Build your own music player micro:bit from headphones. +Build your own music player @boardname@ from headphones. ### ~ @@ -15,7 +15,7 @@ Build your own music player micro:bit from headphones. ## Materials -* micro:bit, battery holder and 2 AAA batteries +* @boardname@, battery holder and 2 AAA batteries * Headphones * Crocodile clips diff --git a/docs/projects/hack-your-headphones/making.md b/docs/projects/hack-your-headphones/making.md index 8148e0d8..680e3ec6 100644 --- a/docs/projects/hack-your-headphones/making.md +++ b/docs/projects/hack-your-headphones/making.md @@ -2,7 +2,7 @@ ### ~avatar avatar -Did you know you could attach your headhpones to the micro:bit to generate sounds? +Did you know you could attach your headhpones to the @boardname@ to generate sounds? ### ~ @@ -16,7 +16,7 @@ Did you know you could attach your headhpones to the micro:bit to generate sound ![](/static/mb/lessons/banana-keyboard-1.png) -Using the 1st crocodile clip, connect the end of the crocodile clip onto GND pin on the micro:bit. +Using the 1st crocodile clip, connect the end of the crocodile clip onto GND pin on the @boardname@. ### Step 2 @@ -24,13 +24,13 @@ Using the 1st crocodile clip, connect the end of the crocodile clip onto GND pin ![](/static/mb/lessons/banana-keyboard-3.png) -Using the 2nd crocodile clip, connect the end of the crocodile clip onto the 0 pin on the micro:bit. +Using the 2nd crocodile clip, connect the end of the crocodile clip onto the 0 pin on the @boardname@. ### Step 3 ![](/static/mb/lessons/banana-keyboard-4.png) -Using the 1st crocodile clip, connect the second end of the crocodile clip onto based of the headphone jack. The base of your headphone jack is considered the ground so it is connected to the GND of the micro:bit. +Using the 1st crocodile clip, connect the second end of the crocodile clip onto based of the headphone jack. The base of your headphone jack is considered the ground so it is connected to the GND of the @boardname@. ### Step 4 @@ -38,7 +38,7 @@ Using the 1st crocodile clip, connect the second end of the crocodile clip onto ![](/static/mb/lessons/hack-your-headphones-1.png) -Using the 2nd crocodile clip, connect the second end of the crocodile clip onto the tip of the headphone jack. The tip of your headphone jack feeds into the right speaker on the headphone. You connect from the micro:bit pin 0 to the tip of the right side of your headphone. Use the tip of the headphone jack to play sounds. +Using the 2nd crocodile clip, connect the second end of the crocodile clip onto the tip of the headphone jack. The tip of your headphone jack feeds into the right speaker on the headphone. You connect from the @boardname@ pin 0 to the tip of the right side of your headphone. Use the tip of the headphone jack to play sounds. ### Step 5 diff --git a/docs/projects/hack-your-headphones/music-of-light.md b/docs/projects/hack-your-headphones/music-of-light.md index 533a59e9..e74d619e 100644 --- a/docs/projects/hack-your-headphones/music-of-light.md +++ b/docs/projects/hack-your-headphones/music-of-light.md @@ -67,4 +67,4 @@ input.onButtonPressed(Button.A, () => { }); ``` -* click **Download** and run your code on the micro:bit. +* click **Download** and run your code on the @boardname@. diff --git a/docs/projects/magic-button-trick.md b/docs/projects/magic-button-trick.md index ce032966..8963c3ba 100644 --- a/docs/projects/magic-button-trick.md +++ b/docs/projects/magic-button-trick.md @@ -1,23 +1,23 @@ # magic button trick -Perform a magic trick where you appear to make the **A** and **B** button of your micro:bit swap over just by moving a sticky label. +Perform a magic trick where you appear to make the **A** and **B** button of your @boardname@ swap over just by moving a sticky label. ### ~avatar avatar -Welcome! This activity will teach you how to use the micro:bit's compass to detect a nearby magnet +Welcome! This activity will teach you how to use the @boardname@'s compass to detect a nearby magnet ### ~ -This is a simple magic trick you can perform to amaze your friends, where by moving the sticky labels on your micro:bit's **A** and **B** button you appear to make the buttons really switch over. To see the trick performed watch the video below. +This is a simple magic trick you can perform to amaze your friends, where by moving the sticky labels on your @boardname@'s **A** and **B** button you appear to make the buttons really switch over. To see the trick performed watch the video below. https://youtu.be/-9KvmPopov8 ## How the trick works -Unfortunately, the only magic here is in the code. This trick uses a magnet, hidden in your hand, to tell the micro:bit to swap over the buttons so that when the magnet is near the microbit the **A** button starts working like the **B** button and the **B** button starts working like the **A** button. +Unfortunately, the only magic here is in the code. This trick uses a magnet, hidden in your hand, to tell the @boardname@ to swap over the buttons so that when the magnet is near the microbit the **A** button starts working like the **B** button and the **B** button starts working like the **A** button. ## What you need -The only things you need for this trick are your micro:bit and any magnet that is small enough to fit in your hand, even a fridge magnet will work. +The only things you need for this trick are your @boardname@ and any magnet that is small enough to fit in your hand, even a fridge magnet will work. ![](/static/mb/projects/magic-button-trick/magnets.jpg "Magnets") @@ -37,7 +37,7 @@ input.onButtonPressed(Button.B, () => { ## Step 2: measuring magnetic force -We will use the micro:bit's compass to detect the magnet. Compass's tell us what direction we are pointing by detecting the Earth's magnetic field but they can also detect any other magnet nearby. We will use that to check if our magnet is next to the micro:bit by using the [magnetic force](/reference/input/magnetic-force) block found in the input menu's 'more' section. As we only want to measure the strength we change the drop down to select 'strength': +We will use the @boardname@'s compass to detect the magnet. Compass's tell us what direction we are pointing by detecting the Earth's magnetic field but they can also detect any other magnet nearby. We will use that to check if our magnet is next to the @boardname@ by using the [magnetic force](/reference/input/magnetic-force) block found in the input menu's 'more' section. As we only want to measure the strength we change the drop down to select 'strength': ```blocks input.magneticForce(Dimension.Strength) @@ -56,7 +56,7 @@ let isSwitched = Math.abs(input.magneticForce(Dimension.Strength)) > 100 ``` ## Step 4: running our 'magnet nearby' check all the time -At the moment our code to detect the magnet being nearby will only run once so we need to put it into a [forever](/reference/basic/forever) block so that it keeps getting run again and again checking for the magnet to come near to the micro:bit. We should also make sure 'isSwitched' is false when our program starts. +At the moment our code to detect the magnet being nearby will only run once so we need to put it into a [forever](/reference/basic/forever) block so that it keeps getting run again and again checking for the magnet to come near to the @boardname@. We should also make sure 'isSwitched' is false when our program starts. ```blocks let isSwitched = false; @@ -94,8 +94,8 @@ input.onButtonPressed(Button.B, () => { ``` ## step 5: practice your performance -Now you just need to program your own micro:bit and practice the trick a few times before performing to friends. Try asking your friends to click the buttons after you have switched the labels and the trick won't work for them as they don't have a hidden magnet in their hand. +Now you just need to program your own @boardname@ and practice the trick a few times before performing to friends. Try asking your friends to click the buttons after you have switched the labels and the trick won't work for them as they don't have a hidden magnet in their hand. ## about the authors -This project was contributed by Brian and Jasmine Norman, aka [@MicroMonstersUK](https://twitter.com/MicroMonstersUK). You can chekout their [micro:bit tutorials chanel on youtube](https://www.youtube.com/channel/UCK2DviDexh_Er2QYZerZyZQ) for more projects. \ No newline at end of file +This project was contributed by Brian and Jasmine Norman, aka [@MicroMonstersUK](https://twitter.com/MicroMonstersUK). You can chekout their [@boardname@ tutorials chanel on youtube](https://www.youtube.com/channel/UCK2DviDexh_Er2QYZerZyZQ) for more projects. \ No newline at end of file diff --git a/docs/projects/radio-challenges.md b/docs/projects/radio-challenges.md index fcde436b..9e6e3655 100644 --- a/docs/projects/radio-challenges.md +++ b/docs/projects/radio-challenges.md @@ -2,11 +2,11 @@ ### ~avatar avatar -Welcome! The activity will teach you how to use the acceleration of the 1st micro:bit and to visualize the acceleration on the 2nd micro:bit. +Welcome! The activity will teach you how to use the acceleration of the 1st @boardname@ and to visualize the acceleration on the 2nd @boardname@. Let's get started! ### ~ -Let's measure `acceleration (mg)` and then `send number`. `Acceleration` is measured in **milli-gravities**, so a value of -1000 is equivalent to -1g or -9.81m/s^2. We will be able to get the acceleration value (g-force), in the specified "x" dimension. `Send number` will broadcast a number data packet to other micro:bits connected via radio. +Let's measure `acceleration (mg)` and then `send number`. `Acceleration` is measured in **milli-gravities**, so a value of -1000 is equivalent to -1g or -9.81m/s^2. We will be able to get the acceleration value (g-force), in the specified "x" dimension. `Send number` will broadcast a number data packet to other @boardname@s connected via radio. ```blocks radio.sendNumber(input.acceleration(Dimension.X)); @@ -33,7 +33,7 @@ radio.onDataPacketReceived(() => { }) ``` ### ~ -Finally, we want to chart the acceleration. So we must first implement `plot bar graph`. `Plot Bar Graph` will display a vertical bar graph based on the value and high value. In order to transfer the receive the number from the 1st micro:bit, we must implement `receive number` to constantly display a vertical bar graph based on the value. Remember, the value will equal to the micro:bit's acceleration in the "x" direction. +Finally, we want to chart the acceleration. So we must first implement `plot bar graph`. `Plot Bar Graph` will display a vertical bar graph based on the value and high value. In order to transfer the receive the number from the 1st @boardname@, we must implement `receive number` to constantly display a vertical bar graph based on the value. Remember, the value will equal to the @boardname@'s acceleration in the "x" direction. ```blocks basic.forever(() => { @@ -45,15 +45,15 @@ radio.onDataPacketReceived(({ receivedNumber }) => { ``` ### ~ -Notice that moving the micro:bit the farthest direction in the x direction will be -1023 on the charting beneath the simulator. The second observation will be that the LEDs will be full brightness on the 2nd micro:bit. There is a single LED turned on with the 1st micro:bit. Additionally, the graphs will reflect 0 acceleation for the 1st micro:bit. In this scenario, if you are adjusting the acceleration in the simualator, you are also changing your chart that will be produced. +Notice that moving the @boardname@ the farthest direction in the x direction will be -1023 on the charting beneath the simulator. The second observation will be that the LEDs will be full brightness on the 2nd @boardname@. There is a single LED turned on with the 1st @boardname@. Additionally, the graphs will reflect 0 acceleation for the 1st @boardname@. In this scenario, if you are adjusting the acceleration in the simualator, you are also changing your chart that will be produced. ![](/static/mb/acc.png) ### ~ -NOTE: The colors of the charts reflect the color of the micro:bit simulator. In this instance, the micro:bits are blue and green. So the colors of the line graphs reflect the colors of the micro:bit +NOTE: The colors of the charts reflect the color of the @boardname@ simulator. In this instance, the @boardname@s are blue and green. So the colors of the line graphs reflect the colors of the @boardname@ ### ~ -After running this simulation several seconds by moving the micro:bit side to side in the x direction, you are ready to graph or chart the accceleration of the micro:bit. We want a printout of our acceleration on Excel. We will graph the fluctuating acceleration of the simulation experiment. +After running this simulation several seconds by moving the @boardname@ side to side in the x direction, you are ready to graph or chart the accceleration of the @boardname@. We want a printout of our acceleration on Excel. We will graph the fluctuating acceleration of the simulation experiment. ![](/static/mb/acc2.png) @@ -83,10 +83,10 @@ Use the Recommended Charts command on the Insert tab to quickly create a chart t ### ~ Have fun reviewing your simulation and analyze the acceleration by chart the Excel data using Excel. -* Connect the first micro:bit to your computer using your USB cable and run the charting script on it. -* Connect the second micro:bit to your computer using your USB cable and run the charting script on it. -* The first person and second person take turns tilting the micro:bit in the "x" direction while the other player charts the data on the micro:bit! -* Review and analyze the actual micro:bit device acceleration data on Excel +* Connect the first @boardname@ to your computer using your USB cable and run the charting script on it. +* Connect the second @boardname@ to your computer using your USB cable and run the charting script on it. +* The first person and second person take turns tilting the @boardname@ in the "x" direction while the other player charts the data on the @boardname@! +* Review and analyze the actual @boardname@ device acceleration data on Excel * Display acceleration with y or z using plot bar graph by changing acceleration from "x" to "y" or "z" ```package diff --git a/docs/projects/radio.md b/docs/projects/radio.md index d969e0f9..016434c4 100644 --- a/docs/projects/radio.md +++ b/docs/projects/radio.md @@ -1,10 +1,10 @@ # radio -Measure the acceleration on the micro:bit in the "x" direction. +Measure the acceleration on the @boardname@ in the "x" direction. ### ~avatar avatar -Welcome! This activity will teach how to use the micro:bit to chart the acceleration in the "x" direction. Let's get started! +Welcome! This activity will teach how to use the @boardname@ to chart the acceleration in the "x" direction. Let's get started! ### ~ @@ -16,7 +16,7 @@ input.acceleration(Dimension.X) ``` ### ~ -Use the plot bar chart to visualize the acceleration on the LED screen of the micro:bit in the specified range. You implement plot Bar Graph to display a vertical bar graph based on the "value" and "high" value. Then you must insert acceleration in the X dimension to measure the acceleration. +Use the plot bar chart to visualize the acceleration on the LED screen of the @boardname@ in the specified range. You implement plot Bar Graph to display a vertical bar graph based on the "value" and "high" value. Then you must insert acceleration in the X dimension to measure the acceleration. ```blocks basic.forever(() => { @@ -26,27 +26,27 @@ basic.forever(() => { ``` ### ~ -Notice that moving the micro:bit in the simulator from left to right (x direction) changes the values beneath the micro:bit in a range from 1023 to -1023 as measured in milli-gravities. By hovering over the micro:bit from left to right, you can observe changing values beneath the micro:bit simulator. Also, the LEDs shown on the Bar Graph fluctates based on the movement of the micro:bit simulator in the x direction. The line underneath the micro:bit simulator reflect the acceleration in the x direction. +Notice that moving the @boardname@ in the simulator from left to right (x direction) changes the values beneath the @boardname@ in a range from 1023 to -1023 as measured in milli-gravities. By hovering over the @boardname@ from left to right, you can observe changing values beneath the @boardname@ simulator. Also, the LEDs shown on the Bar Graph fluctates based on the movement of the @boardname@ simulator in the x direction. The line underneath the @boardname@ simulator reflect the acceleration in the x direction. -NOTE: The colors of the charts reflect the color of the micro:bit simulator. In this instance, the micro:bit is yellow. So the color of the data line reflects the color of the micro:bit +NOTE: The colors of the charts reflect the color of the @boardname@ simulator. In this instance, the @boardname@ is yellow. So the color of the data line reflects the color of the @boardname@ ![](/static/mb/data4.png) ### ~ -Vigorously move the micro:bit in the micro:bit simulatator by moving the micro:bit image from side to side. Every time the micro:bit moves in the x direction in the simulator, you are generating data points that can be reviewed in Excel. The more attempts to move the micro:bit from side to side, the more data being saved in Excel. After you have vigarously moved the micro:bit simulator from side to side for a sufficient amount of time, you are ready to graph or chart the accceleration of the micro:bit. We want a printout of our acceleration on Excel that can be graphed in Excel. +Vigorously move the @boardname@ in the @boardname@ simulatator by moving the @boardname@ image from side to side. Every time the @boardname@ moves in the x direction in the simulator, you are generating data points that can be reviewed in Excel. The more attempts to move the @boardname@ from side to side, the more data being saved in Excel. After you have vigarously moved the @boardname@ simulator from side to side for a sufficient amount of time, you are ready to graph or chart the accceleration of the @boardname@. We want a printout of our acceleration on Excel that can be graphed in Excel. ### ~ We want to chart the data collected by using a tool in Excel. -The final part of this experiment is opening and reviewing the data in the Excel CSV file. Simply click on the line beneath the simulator. A CSV file will be generated to display the data points collected by moving the micro:bit in the X direction. Then click or tap on the data Excel file that was downloaded to your local ``Downloads`` Folder. +The final part of this experiment is opening and reviewing the data in the Excel CSV file. Simply click on the line beneath the simulator. A CSV file will be generated to display the data points collected by moving the @boardname@ in the X direction. Then click or tap on the data Excel file that was downloaded to your local ``Downloads`` Folder. ### ~ -First, click or tap on the first two columns (A, B) to include the time of the data being collected; b) the results of acceleration data on the micro:bit +First, click or tap on the first two columns (A, B) to include the time of the data being collected; b) the results of acceleration data on the @boardname@ ![](/static/mb/data7.png) diff --git a/docs/projects/rock-paper-scissors.md b/docs/projects/rock-paper-scissors.md index b3bcfc0b..0e8dbcd7 100644 --- a/docs/projects/rock-paper-scissors.md +++ b/docs/projects/rock-paper-scissors.md @@ -36,7 +36,7 @@ input.onGesture(Gesture.Shake, () => { }) ``` In this project, you will build a Rock Paper Scissors game with the @boardname@. -You can play the game with a friend who has it on a micro:bit. +You can play the game with a friend who has it on a @boardname@. You can also play it with friends who are just using their hands. ### ~ @@ -48,8 +48,8 @@ You can also play it with friends who are just using their hands. ## Step 1: Getting started -We want the micro:bit to choose rock, paper, or scissors when you shake it. -Try creating an ``on shake`` block so when you shake the micro:bit, it will run part of a program. +We want the @boardname@ to choose rock, paper, or scissors when you shake it. +Try creating an ``on shake`` block so when you shake the @boardname@, it will run part of a program. ```blocks input.onGesture(Gesture.Shake, () => { @@ -57,7 +57,7 @@ input.onGesture(Gesture.Shake, () => { }) ``` -Next, when you shake the micro:bit, it should pick a random number from `0` to `2` +Next, when you shake the @boardname@, it should pick a random number from `0` to `2` and store it in the variable `weapon`. (This variable is named `weapon` because rock, paper, and scissors are the weapons you use to battle your friends!) @@ -110,7 +110,7 @@ input.onGesture(Gesture.Shake, () => { ## Step 3: A random rock -Now we are going to add a new picture for the micro:bit to show +Now we are going to add a new picture for the @boardname@ to show when another random number comes up. Make the ``else if`` part check if the variable `weapon` is `1`. @@ -192,7 +192,7 @@ Your game is ready! Have fun! Here is a way you can make your Rock Paper Scissors game better. When button ``A`` is pressed, -the micro:bit will add `1` to your score. +the @boardname@ will add `1` to your score. Open the ``Game`` drawer, and then add the block ``change score by 1`` to your program, like this: @@ -206,7 +206,7 @@ input.onButtonPressed(Button.A, () => { ## Step 6: Prove you're the greatest! -After your micro:bit can add `1` to the score, show how many wins you have. +After your @boardname@ can add `1` to the score, show how many wins you have. ```blocks input.onButtonPressed(Button.A, () => { @@ -217,7 +217,7 @@ input.onButtonPressed(Button.A, () => { ``` ## Step 7: Staying honest -Success! Your micro:bit can track wins! +Success! Your @boardname@ can track wins! But what about losses? Use the ``Game`` drawer to subtract `1` from your score when you press button `B`. diff --git a/docs/projects/telegraph.md b/docs/projects/telegraph.md index f8610f7d..ae9eb8ce 100644 --- a/docs/projects/telegraph.md +++ b/docs/projects/telegraph.md @@ -4,7 +4,7 @@ ### ~avatar -Build a telegraph between two micro:bits to communicate with your friends! +Build a telegraph between two @boardname@s to communicate with your friends! ### ~ @@ -12,7 +12,7 @@ Build a telegraph between two micro:bits to communicate with your friends! ## Materials -* micro:bit, battery holder and 2 AAA batteries +* @boardname@, battery holder and 2 AAA batteries * Crocodile clips ## Activities diff --git a/docs/projects/telegraph/making.md b/docs/projects/telegraph/making.md index d3b56ec2..7251ed0d 100644 --- a/docs/projects/telegraph/making.md +++ b/docs/projects/telegraph/making.md @@ -2,7 +2,7 @@ ### ~avatar -Let's build a telegraph between two micro:bits. +Let's build a telegraph between two @boardname@s. ### ~ @@ -10,7 +10,7 @@ Let's build a telegraph between two micro:bits. ## Materials -* micro:bit, battery holder and 2 AAA batteries +* @boardname@, battery holder and 2 AAA batteries * Crocodile clips ## Steps @@ -19,49 +19,49 @@ Let's build a telegraph between two micro:bits. ![](/static/mb/lessons/banana-keyboard-1.png) -Using the 1st crocodile clip, connect the end of the crocodile clip onto GND pin on the micro:bit. +Using the 1st crocodile clip, connect the end of the crocodile clip onto GND pin on the @boardname@. ### Step 2 ![](/static/mb/lessons/ornament-chain-2.png) -Using the 2nd crocodile clip, connect the end of the crocodile clip onto the 3V pin on the micro:bit. +Using the 2nd crocodile clip, connect the end of the crocodile clip onto the 3V pin on the @boardname@. ### Step 3 ![](/static/mb/lessons/ornament-chain-3.png) -Using the 3rd crocodile clip, connect the end of the crocodile clip onto pin 1 of the micro:bit. +Using the 3rd crocodile clip, connect the end of the crocodile clip onto pin 1 of the @boardname@. ### Step 4 ![](/static/mb/lessons/ornament-chain-4.png) -Using the 4th crocodile clip, connect the end of the crocodile clip onto pin 2 of the micro:bit. +Using the 4th crocodile clip, connect the end of the crocodile clip onto pin 2 of the @boardname@. ### Step 5 ![](/static/mb/lessons/ornament-chain-5.png) -Using the 1st crocodile clip, connect the unattached end of the crocodile clip onto the GND on the 2nd micro:bit. +Using the 1st crocodile clip, connect the unattached end of the crocodile clip onto the GND on the 2nd @boardname@. ### Step 6 ![](/static/mb/lessons/ornament-chain-6.png) -Using the 2nd crocodile clip, connect the unattached end of the crocodile clip onto the 3V pin on the 2nd micro:bit. +Using the 2nd crocodile clip, connect the unattached end of the crocodile clip onto the 3V pin on the 2nd @boardname@. ### Step 7 ![](/static/mb/lessons/ornament-chain-7.png) -Using the 3rd crocodile clip, connect the unattached end of the crocodile clip onto pin 2 of the 2nd micro:bit. +Using the 3rd crocodile clip, connect the unattached end of the crocodile clip onto pin 2 of the 2nd @boardname@. ### Step 8 ![](/static/mb/lessons/ornament-chain-8.png) -Using the 4th crocodile clip, connect the unattached end of the crocodile clip onto pin 1 of the 2nd micro:bit +Using the 4th crocodile clip, connect the unattached end of the crocodile clip onto pin 1 of the 2nd @boardname@ ### Step 9 diff --git a/docs/projects/telegraph/manual-telegraph.md b/docs/projects/telegraph/manual-telegraph.md index 7244fb3d..658d5e0b 100644 --- a/docs/projects/telegraph/manual-telegraph.md +++ b/docs/projects/telegraph/manual-telegraph.md @@ -90,6 +90,6 @@ Your telegraph is ready! ### Step 7 -* Connect the first micro:bit to your computer using your USB cable and put the telegraph script on it. -* Connect the second micro:bit to your computer using your USB cable and run the telegraph script on it. +* Connect the first @boardname@ to your computer using your USB cable and put the telegraph script on it. +* Connect the second @boardname@ to your computer using your USB cable and run the telegraph script on it. * The first person and second person take turns pressing button A to play the telegraph game! diff --git a/docs/projects/the-watch.md b/docs/projects/the-watch.md index 8f7f15fc..2cee515e 100644 --- a/docs/projects/the-watch.md +++ b/docs/projects/the-watch.md @@ -4,13 +4,13 @@ ![](/static/mb/lessons/the-watch-0.png) -In this project, you will build your own wearable micro:bit watch from an old pair of jeans and T-shirt. Project duration: 15 minutes. +In this project, you will build your own wearable @boardname@ watch from an old pair of jeans and T-shirt. Project duration: 15 minutes. ![](/static/mb/lessons/the-watch-1.png) ## Materials -* micro:bit, battery holder and 2 AAA batteries +* @boardname@, battery holder and 2 AAA batteries * Old T-shirt * Old Jeans * Velcro with sticky back – 5cm x 5cm @@ -70,25 +70,25 @@ Peal the tape protective layer from the rectangle. ![](/static/mb/lessons/the-watch-11.png) -Place the micro:bit pins on the tape at more or less **7** cm from the left border. Then lower the micro:bit on the tape and press **gently**. +Place the @boardname@ pins on the tape at more or less **7** cm from the left border. Then lower the @boardname@ on the tape and press **gently**. ### Step 9 ![](/static/mb/lessons/the-watch-12.png) -Connect the battery holder and place it on the right of the micro:bit. Tuck the cables away on the tape to protect them. +Connect the battery holder and place it on the right of the @boardname@. Tuck the cables away on the tape to protect them. ### Step 10 ![](/static/mb/lessons/the-watch-13.png) -Stick the T-shirt rectangle from the top of the micro:bit, over the battery cables. +Stick the T-shirt rectangle from the top of the @boardname@, over the battery cables. ### Step 11 ![](/static/mb/lessons/the-watch-14.png) -Use your fingers to push the T-shirt cloth under the micro:bit to give access to the micro-USB plug. +Use your fingers to push the T-shirt cloth under the @boardname@ to give access to the micro-USB plug. ### Step 12 @@ -106,7 +106,7 @@ Turn over the watch and cut the extra T-shirt material. ![](/static/mb/lessons/the-watch-17.png) -Stick the T-shirt cloth on the other side of the watch. Lift the micro:bit pins to slide the cloth under and leave them free from the tape. +Stick the T-shirt cloth on the other side of the watch. Lift the @boardname@ pins to slide the cloth under and leave them free from the tape. ### Step 15 diff --git a/docs/projects/timing-gates.md b/docs/projects/timing-gates.md index cda09f1c..8042435b 100644 --- a/docs/projects/timing-gates.md +++ b/docs/projects/timing-gates.md @@ -8,17 +8,17 @@ This project explains the principles of timing gates using household materials. ## Timing gates -The two gates are connected to the micro:bit and can detect a car passing through. +The two gates are connected to the @boardname@ and can detect a car passing through. ![](/static/mb/projects/timing-gates/sketchgates.jpg "Sketch of the gates") -As the car passes through the gate ``0``, it sends an event to the micro:bit through the [on pin pressed](/reference/input/on-pin-pressed) block. -The micro:bit records the time in a variable ``t0``. +As the car passes through the gate ``0``, it sends an event to the @boardname@ through the [on pin pressed](/reference/input/on-pin-pressed) block. +The @boardname@ records the time in a variable ``t0``. ![](/static/mb/projects/timing-gates/sketchgate1.jpg "Sketch first gate") -As the car passes through the gate ``1``, it sends an event to the micro:bit through the [on pin pressed](/reference/input/on-pin-pressed) block. -The micro:bit records the time in a variable ``t1``. +As the car passes through the gate ``1``, it sends an event to the @boardname@ through the [on pin pressed](/reference/input/on-pin-pressed) block. +The @boardname@ records the time in a variable ``t1``. ![](/static/mb/projects/timing-gates/sketchgate2.jpg "Sketch first gate") @@ -34,7 +34,7 @@ By dividing the distance between the gates by the duration, we get the speed of * Aluminum fail * Double-side tape (carpet tape) * 4 crocodile clips -* A micro:bit board and USB cable +* A @boardname@ board and USB cable ![](/static/mb/projects/timing-gates/materials.jpg "Materials") @@ -76,9 +76,9 @@ Connect a crocodile strip to each foil strip. ![](/static/mb/projects/timing-gates/connectsensor.jpg "Connecting sensor") -Connect the crocodile plugs to the ``GND`` and ``P0`` pins on the micro:bit. +Connect the crocodile plugs to the ``GND`` and ``P0`` pins on the @boardname@. -![](/static/mb/projects/timing-gates/connectcrocs.jpg "Connecting the micro:bit") +![](/static/mb/projects/timing-gates/connectcrocs.jpg "Connecting the @boardname@") The gate is ready to use! Your circuit should look like the picture below: @@ -87,7 +87,7 @@ The gate is ready to use! Your circuit should look like the picture below: ## Detecting the car with code -The micro:bit provides an event [on pin pressed](/reference/input/on-pin-pressed) +The @boardname@ provides an event [on pin pressed](/reference/input/on-pin-pressed) that is raised when a circuit between ``GND`` and a pin is detected. The circuit conductor could be a wire or even your body! We will attach a foil to the bottom of the car. When it passes over the gate, it connect both foil strips, close the circuit and trigger the event. @@ -140,7 +140,7 @@ Repeat the same process with tape and foil to build the first gate. ![](/static/mb/projects/timing-gates/sensor2.jpg "Double foil sensors") -Connect the crocodile plugs to the ``GND`` and ``P1`` pins on the micro:bit. +Connect the crocodile plugs to the ``GND`` and ``P1`` pins on the @boardname@. ![](/static/mb/projects/timing-gates/sensormicrobit2.jpg "Sensor and microbit") @@ -182,7 +182,7 @@ https://youtu.be/N4bWQcu6yWs ## Computing time -The micro:bit has a clock that measures time precisely. It measures how many seconds the micro:bit has been on. +The @boardname@ has a clock that measures time precisely. It measures how many seconds the @boardname@ has been on. We will record the time where each gate is tripped in variables ``t0`` and ``t1``. We take the different between ``t1`` and ``t0`` to compute the duration between the gates. diff --git a/docs/reference/basic.md b/docs/reference/basic.md index 27fe8fba..91383e9f 100644 --- a/docs/reference/basic.md +++ b/docs/reference/basic.md @@ -1,6 +1,6 @@ # Basic -Provides access to basic micro:bit functionality. +Provides access to basic @boardname@ functionality. ```cards basic.showNumber(0); diff --git a/docs/reference/basic/forever.md b/docs/reference/basic/forever.md index 3569eb7d..d06ec3c8 100644 --- a/docs/reference/basic/forever.md +++ b/docs/reference/basic/forever.md @@ -52,7 +52,7 @@ input.onButtonPressed(Button.A, () => { If different parts of a program are each trying to show something on the LED screen at the same time, you may get unexpected results. -Try this on your micro:bit: +Try this on your @boardname@: ```blocks basic.forever(() => { diff --git a/docs/reference/bluetooth.md b/docs/reference/bluetooth.md index f631f4b4..d2fa66b2 100644 --- a/docs/reference/bluetooth.md +++ b/docs/reference/bluetooth.md @@ -5,7 +5,7 @@ Support for additional Bluetooth services. ### ~hint ![](/static/bluetooth/Bluetooth_SIG.png) -For another device like a smartphone to use any of the Bluetooth "services" which the micro:bit has, it must first be [paired with the micro:bit](/reference/bluetooth/bluetooth-pairing). Once paired, the other device may connect to the micro:bit and exchange data relating to many of the micro:bit's features. +For another device like a smartphone to use any of the Bluetooth "services" which the @boardname@ has, it must first be [paired with the @boardname@](/reference/bluetooth/bluetooth-pairing). Once paired, the other device may connect to the @boardname@ and exchange data relating to many of the @boardname@'s features. ### ~ @@ -37,7 +37,7 @@ bluetooth ### Advanced -For more advanced information on the micro:bit Bluetooth UART service including information on using a smartphone, see the [Lancaster University micro:bit runtime technical documentation](http://lancaster-university.github.io/microbit-docs/ble/uart-service/) +For more advanced information on the @boardname@ Bluetooth UART service including information on using a smartphone, see the [Lancaster University @boardname@ runtime technical documentation](http://lancaster-university.github.io/microbit-docs/ble/uart-service/) ### See Also diff --git a/docs/reference/bluetooth/about-bluetooth.md b/docs/reference/bluetooth/about-bluetooth.md index 63d1a8cc..c93e6cf7 100755 --- a/docs/reference/bluetooth/about-bluetooth.md +++ b/docs/reference/bluetooth/about-bluetooth.md @@ -6,7 +6,7 @@ Bluetooth is a wireless communications technology which allows devices to communicate with each other without the need for a central device like a router or access point. -Bluetooth has a special "low energy feature" which means it can be used without requiring much power from the devices using it. It's the Bluetooth low energy feature which the micro:bit uses. +Bluetooth has a special "low energy feature" which means it can be used without requiring much power from the devices using it. It's the Bluetooth low energy feature which the @boardname@ uses. In the world of Bluetooth low energy, a device has something called a "profile" which defines the way other devices are able to communicate over Bluetooth with it. In a way, the Bluetooth profile defines the way a device appears to other devices in terms of its features and the things it can do. @@ -20,7 +20,7 @@ The Attribute Table contains something like a series of records of various types ### Attributes -Services, Characteristics and Descriptors are all types of Attribute. Hence Generic Attribute Profile, Attribute Table and something called the Attribute Protocol. All attributes have a type which is identified by a UUID (Universally Unique Identifer). Some Attributes are defined by the Bluetooth SIG, the technical standards body for Bluetooth and these have UUIDs which are 16 bits in length. Some Attributes are custom designed for a particular device by the product team and these have 128 bit UUIDs. The micro:bit uses a mixture of 16 bit and 128 bit UUIDs. +Services, Characteristics and Descriptors are all types of Attribute. Hence Generic Attribute Profile, Attribute Table and something called the Attribute Protocol. All attributes have a type which is identified by a UUID (Universally Unique Identifer). Some Attributes are defined by the Bluetooth SIG, the technical standards body for Bluetooth and these have UUIDs which are 16 bits in length. Some Attributes are custom designed for a particular device by the product team and these have 128 bit UUIDs. The @boardname@ uses a mixture of 16 bit and 128 bit UUIDs. ### Structure @@ -30,7 +30,7 @@ Services, Characteristics and Descriptors are organised in a hierarchy with Serv ### Services -A Service is a container for logically related Bluetooth data items. Those data items are in fact called Characteristics. A Service can be thought of as the owner of the Characteristics inside it. Often a Service represents a particular feature (e.g. a hardware feature) of a device like the buttons or a particular sensor. An example of a Bluetooth SIG defined Service is the Device Information Service which, as the name suggests, is a container for various items of information about the device such as its manufacturer and serial number. The micro:bit has this service. +A Service is a container for logically related Bluetooth data items. Those data items are in fact called Characteristics. A Service can be thought of as the owner of the Characteristics inside it. Often a Service represents a particular feature (e.g. a hardware feature) of a device like the buttons or a particular sensor. An example of a Bluetooth SIG defined Service is the Device Information Service which, as the name suggests, is a container for various items of information about the device such as its manufacturer and serial number. The @boardname@ has this service. ### Characteristics @@ -40,7 +40,7 @@ Characteristics contain various parts. They have a type, a value, some propertie Type is something already explained above, a UUID value which indicates which particular type of Characteristic an Attribute is. Value is the value of the associated state data item. -Properties define what another device can do with the characteristic over Bluetooth in terms of various defined operations such as READ, WRITE or NOTIFY. Reading a characteristic means transferring its current value from the attribute table to the connected device over Bluetooth. Writing allows the connected device to change that value in the state table. Notifications are a special message type which a device like the micro:bit can send to a connected device whenever the value of the associated characteristic changes or perhaps periodically, controlled by a timer. Not all Characteristics support all operations. The Characteristic's properties tell you which operations are supported. +Properties define what another device can do with the characteristic over Bluetooth in terms of various defined operations such as READ, WRITE or NOTIFY. Reading a characteristic means transferring its current value from the attribute table to the connected device over Bluetooth. Writing allows the connected device to change that value in the state table. Notifications are a special message type which a device like the @boardname@ can send to a connected device whenever the value of the associated characteristic changes or perhaps periodically, controlled by a timer. Not all Characteristics support all operations. The Characteristic's properties tell you which operations are supported. Sometimes the device will have been programmed to respond in a special way when it processes an operation like reading or writing a value from the attribute table so operations can result in more happening than simply transferring data across the connection. Perhaps changing the value of a Characteristic will result in the device changing the frequency with which it samples readings from the device accelerometer for example. @@ -56,7 +56,7 @@ A Bluetooth profile is a specification which pulls together all the required inf ## Client Server Architecture -When a smartphone application interacts with a device like the micro:bit over a Bluetooth connection we have a client/server architecture. The phone application is usually the GATT client and the micro:bit is usually the GATT server. They communicate using a protocol called the Attribute Protocol or just ATT for short. As a smartphone developer you work with APIs and do not have to worry about formulating ATT protocol data units and so on. +When a smartphone application interacts with a device like the @boardname@ over a Bluetooth connection we have a client/server architecture. The phone application is usually the GATT client and the @boardname@ is usually the GATT server. They communicate using a protocol called the Attribute Protocol or just ATT for short. As a smartphone developer you work with APIs and do not have to worry about formulating ATT protocol data units and so on. ![](/static/bluetooth/services_and_GATT.png) @@ -64,19 +64,19 @@ When a smartphone application interacts with a device like the micro:bit over a Everything described above relates to devices which are connected and communicating as GATT client and server. But there's a stage which precedes this where the two devices are not yet connected. How do they find each other and connect? The answer to this question is termed 'Device Discovery' and is the responsibility of another part of the Bluetooth architecture called the Generic Access Profile (GAP). -In GAP, one devices advertises, emitting small packets of data periodically. These packets contain information about the device doing the advertising. Other devices looking for devices to connect to perform something called scanning, receiving and processing advertising packets and filtering out those that come from devices of a type that are not of interest. Usually the user is given information about devices which are discovered and they then select one to be connected to. The device which advertises is called a Bluetooth Peripheral whereas the one doing the scanning is a Bluetooth Central device. micro:bit is a Bluetooth peripheral. +In GAP, one devices advertises, emitting small packets of data periodically. These packets contain information about the device doing the advertising. Other devices looking for devices to connect to perform something called scanning, receiving and processing advertising packets and filtering out those that come from devices of a type that are not of interest. Usually the user is given information about devices which are discovered and they then select one to be connected to. The device which advertises is called a Bluetooth Peripheral whereas the one doing the scanning is a Bluetooth Central device. @boardname@ is a Bluetooth peripheral. Bluetooth on the @boardname@ Full documentation for the @boardname@ Bluetooth profile as used by this application can be found at the [Lancaster University documentation](http://lancaster-university.github.io/microbit-docs/ble/profile/) web site. -The micro:bit's accelerometer (motion detector), magnetometer (digital compass), two buttons on the front, LED Display, IO pins on the edge connector, internal message bus and internal temperature sensor are all exposed as Services so that applications can exploit these features of the device. In addition: +The @boardname@'s accelerometer (motion detector), magnetometer (digital compass), two buttons on the front, LED Display, IO pins on the edge connector, internal message bus and internal temperature sensor are all exposed as Services so that applications can exploit these features of the device. In addition: * the Bluetooth SIG defined Device Information Service is included to allow applications to obtain information such as firmware version details over Bluetooth -* there's a Device Firmware Update (DFU) service which allows new micro:bit code to be flahsed to the device over Bluetooth instead of over USB -* there's a UART service which allows arbitrary data to be exchanged with the micro:bit in a way resembling traditional serial communications. +* there's a Device Firmware Update (DFU) service which allows new @boardname@ code to be flahsed to the device over Bluetooth instead of over USB +* there's a UART service which allows arbitrary data to be exchanged with the @boardname@ in a way resembling traditional serial communications. -Everything you can do with the micro:bit over Bluetooth is achieved through read, write and notify operations. Not all characteristics support all three so check the profile documentation. Often there are Characteristics whose purpose is to allow you to write configuration values which control other behviours. Technically these are called Control Points. For example you can specify the frequency with which accelerometer data is sampled before it is transmitted as a Notification message to your application. +Everything you can do with the @boardname@ over Bluetooth is achieved through read, write and notify operations. Not all characteristics support all three so check the profile documentation. Often there are Characteristics whose purpose is to allow you to write configuration values which control other behviours. Technically these are called Control Points. For example you can specify the frequency with which accelerometer data is sampled before it is transmitted as a Notification message to your application. ## Want to Know More? @@ -92,7 +92,7 @@ https://www.youtube.com/watch?v=aep_GVowKfs ### See also -[About Bluetooth](/reference/bluetooth/about-bluetooth), [micro:bit Bluetooth profile overview ](http://lancaster-university.github.io/microbit-docs/ble/profile/), [micro:bit Bluetooth profile reference](http://lancaster-university.github.io/microbit-docs/resources/bluetooth/microbit-profile-V1.9-Level-2.pdf), [Bluetooth on micro:bit resources](http://bluetooth-mdw.blogspot.co.uk/p/bbc-microbit.html), [Bluetooth SIG](https://www.bluetooth.com) +[About Bluetooth](/reference/bluetooth/about-bluetooth), [@boardname@ Bluetooth profile overview ](http://lancaster-university.github.io/microbit-docs/ble/profile/), [@boardname@ Bluetooth profile reference](http://lancaster-university.github.io/microbit-docs/resources/bluetooth/microbit-profile-V1.9-Level-2.pdf), [Bluetooth on @boardname@ resources](http://bluetooth-mdw.blogspot.co.uk/p/bbc-microbit.html), [Bluetooth SIG](https://www.bluetooth.com) ```package bluetooth diff --git a/docs/reference/bluetooth/bluetooth-pairing.md b/docs/reference/bluetooth/bluetooth-pairing.md index 21164a2a..6c104605 100755 --- a/docs/reference/bluetooth/bluetooth-pairing.md +++ b/docs/reference/bluetooth/bluetooth-pairing.md @@ -3,96 +3,96 @@ ### ~hint ![](/static/bluetooth/Bluetooth_SIG.png) -For another device like a smartphone to use any of the Bluetooth "services" which the micro:bit has, it must first be [paired with the micro:bit](/reference/bluetooth/bluetooth-pairing). Once paired, the other device may connect to the micro:bit and exchange data relating to many of the micro:bit's features. +For another device like a smartphone to use any of the Bluetooth "services" which the @boardname@ has, it must first be [paired with the @boardname@](/reference/bluetooth/bluetooth-pairing). Once paired, the other device may connect to the @boardname@ and exchange data relating to many of the @boardname@'s features. ### ~ ### What is 'pairing'? -'Pairing' is what you have to do to have your micro:bit trust another device like a smartphone and similarly, have your smartphone trust your micro:bit. Why 'trust'? Well, pairing is all about security. You wouldn't usually want just anyone's smartphone connecting to your micro:bit and making it do things so by pairing *your* smartphone with *your* micro:bit you ensure that only your devices can talk to each other. +'Pairing' is what you have to do to have your @boardname@ trust another device like a smartphone and similarly, have your smartphone trust your @boardname@. Why 'trust'? Well, pairing is all about security. You wouldn't usually want just anyone's smartphone connecting to your @boardname@ and making it do things so by pairing *your* smartphone with *your* @boardname@ you ensure that only your devices can talk to each other. -Once you've paired your micro:bit with another device it also means that they are able to exchange information privately, without someone else being able to "see" the data they're exchanging over the air using Bluetooth. This is accomplished by data being [encrypted](https://en.wikipedia.org/wiki/Encryption) and pairing makes it possible for devices who trust each other to encrypt and decrypt data from each other. +Once you've paired your @boardname@ with another device it also means that they are able to exchange information privately, without someone else being able to "see" the data they're exchanging over the air using Bluetooth. This is accomplished by data being [encrypted](https://en.wikipedia.org/wiki/Encryption) and pairing makes it possible for devices who trust each other to encrypt and decrypt data from each other. -# How do you pair your micro:bit with another device? +# How do you pair your @boardname@ with another device? -Making your micro:bit pair requires you to follow some simple steps which will be described shortly. What you do with the device you're pairing it to will vary slightly depending on what that device is. We'll look at how it's done with common smartphones and tablets here too. +Making your @boardname@ pair requires you to follow some simple steps which will be described shortly. What you do with the device you're pairing it to will vary slightly depending on what that device is. We'll look at how it's done with common smartphones and tablets here too. -To get your micro:bit ready for pairing do the following: +To get your @boardname@ ready for pairing do the following: -1. Hold down buttons A and B on the front of your micro:bit together. The front is the side with two buttons and the LED display. Keep the two buttons held down. Don't let go of them yet! -2. While still holding down buttons A and B, press and then release the reset button on the back of the micro:bit. Keep holding down buttons A and B. -3. You should see "PAIRING MODE!" start to scroll across the micro:bit display. When you see this message start to appear you can release buttons A and B. -4. Eventually you'll see a strange pattern on your micro:bit display. This is like your micro:bit's signature. Other people's micro:bits will probably display a different pattern. +1. Hold down buttons A and B on the front of your @boardname@ together. The front is the side with two buttons and the LED display. Keep the two buttons held down. Don't let go of them yet! +2. While still holding down buttons A and B, press and then release the reset button on the back of the @boardname@. Keep holding down buttons A and B. +3. You should see "PAIRING MODE!" start to scroll across the @boardname@ display. When you see this message start to appear you can release buttons A and B. +4. Eventually you'll see a strange pattern on your @boardname@ display. This is like your @boardname@'s signature. Other people's @boardname@s will probably display a different pattern. -Your micro:bit is now ready to be paired with the other device. Read the section below which relates to your 'other' device and watch the video too. +Your @boardname@ is now ready to be paired with the other device. Read the section below which relates to your 'other' device and watch the video too. -### How do you pair your micro:bit with a Windows smartphone or tablet? +### How do you pair your @boardname@ with a Windows smartphone or tablet? 1. Go into Settings 2. Select Bluetooth -3. Switch your micro:bit into 'pairing mode' using the steps above -4. Wait until 'PAIRING MODE!' has finished scrolling across the micro:bit display. You should see your micro:bit listed on your Windows smartphone with a name something like '@boardname@ [zatig]'. Note that the 5 characters in brackets at the end will vary. -5. On the Windows smartphone, tap the micro:bit named in the device list. This will initiate the pairing process. -6. The micro:bit will display a left pointing arrow and the Windows smartphone will pop up a box into which you will be invited to enter a "pin" (Personal Identity Number). -7. Press button A on the micro:bit and watch carefully as the micro:bit displays a sequence of 6 random numbers. You may find it easier to write them down than to remember them. -8. Enter the 6 digits which the micro:bit displayed into your Windows smartphone in the pop-up box provided and then select "done". -9. If you entered the right number the micro:bit will display a tick / check mark. If you made a mistake it will display a cross or X and you should repeat the process to try again. +3. Switch your @boardname@ into 'pairing mode' using the steps above +4. Wait until 'PAIRING MODE!' has finished scrolling across the @boardname@ display. You should see your @boardname@ listed on your Windows smartphone with a name something like '@boardname@ [zatig]'. Note that the 5 characters in brackets at the end will vary. +5. On the Windows smartphone, tap the @boardname@ named in the device list. This will initiate the pairing process. +6. The @boardname@ will display a left pointing arrow and the Windows smartphone will pop up a box into which you will be invited to enter a "pin" (Personal Identity Number). +7. Press button A on the @boardname@ and watch carefully as the @boardname@ displays a sequence of 6 random numbers. You may find it easier to write them down than to remember them. +8. Enter the 6 digits which the @boardname@ displayed into your Windows smartphone in the pop-up box provided and then select "done". +9. If you entered the right number the @boardname@ will display a tick / check mark. If you made a mistake it will display a cross or X and you should repeat the process to try again. #### Video https://www.youtube.com/watch?v=AoW3mit7jIg -### How do you pair your micro:bit with an Android smartphone or tablet? +### How do you pair your @boardname@ with an Android smartphone or tablet? 1. Go into Settings 2. Select Bluetooth -3. Switch your micro:bit into 'pairing mode' using the steps above -4. Wait until 'PAIRING MODE!' has finished scrolling across the micro:bit display. You should see your micro:bit listed on your Android smartphone under the heading "Available devices" with a name something like '@boardname@ [zatig]'. Note that the 5 characters in brackets at the end will vary. -5. On the Android smartphone, tap the micro:bit named in the Available devices list. This will initiate the pairing process. -6. The micro:bit will display a left pointing arrow and the Android smartphone will pop up a box into which you will be invited to enter a "pin" (Personal Identity Number). -7. Press button A on the micro:bit and watch carefully as the micro:bit displays a sequence of 6 random numbers. You may find it easier to write them down than to remember them. -8. Enter the 6 digits which the micro:bit displayed into your Android smartphone in the pop-up box provided and then select "done". -9. If you entered the right number the micro:bit will display a tick / check mark. If you made a mistake it will display a cross or X and you should repeat the process to try again. +3. Switch your @boardname@ into 'pairing mode' using the steps above +4. Wait until 'PAIRING MODE!' has finished scrolling across the @boardname@ display. You should see your @boardname@ listed on your Android smartphone under the heading "Available devices" with a name something like '@boardname@ [zatig]'. Note that the 5 characters in brackets at the end will vary. +5. On the Android smartphone, tap the @boardname@ named in the Available devices list. This will initiate the pairing process. +6. The @boardname@ will display a left pointing arrow and the Android smartphone will pop up a box into which you will be invited to enter a "pin" (Personal Identity Number). +7. Press button A on the @boardname@ and watch carefully as the @boardname@ displays a sequence of 6 random numbers. You may find it easier to write them down than to remember them. +8. Enter the 6 digits which the @boardname@ displayed into your Android smartphone in the pop-up box provided and then select "done". +9. If you entered the right number the @boardname@ will display a tick / check mark. If you made a mistake it will display a cross or X and you should repeat the process to try again. #### Video https://www.youtube.com/watch?v=7hLBfdAGkZI -### How do you pair your micro:bit with an Apple iOS smartphone or tablet? +### How do you pair your @boardname@ with an Apple iOS smartphone or tablet? -The steps to pair with an Apple iOS device are different to those followed for an Android or Windows device. To trigger pairing you need an application which will try to interact with your micro:bit and it's that interaction that triggers the iOS pairing process. There are many you could use but for the purposes of this documentation we'll suggest you install the "nRF Master Control Panel" (nRF MCP) application from Nordic Semiconductor. You'll find it in the Apple app store. It's a really useful Bluetooth application which will help you learn about Bluetooth as well as it having the ability to trigger the pairing process. After installing nRF MCP you should follow these steps to pair with your micro:bit: +The steps to pair with an Apple iOS device are different to those followed for an Android or Windows device. To trigger pairing you need an application which will try to interact with your @boardname@ and it's that interaction that triggers the iOS pairing process. There are many you could use but for the purposes of this documentation we'll suggest you install the "nRF Master Control Panel" (nRF MCP) application from Nordic Semiconductor. You'll find it in the Apple app store. It's a really useful Bluetooth application which will help you learn about Bluetooth as well as it having the ability to trigger the pairing process. After installing nRF MCP you should follow these steps to pair with your @boardname@: -1. Switch your micro:bit into 'pairing mode' using the steps above -2. Wait until 'PAIRING MODE!' has finished scrolling across the micro:bit display. -3. Launch the nRF MCP application. Your micro:bit should be listed and have a "Connect" button next to it. -4. Select "Connect" to connect your Apple device to the micro:bit. This will trigger the pairing process. -5. The micro:bit will display a left pointing arrow and the Apple device will pop up a box into which you will be invited to enter a "pin" (Personal Identity Number). -6. Press button A on the micro:bit and watch carefully as the micro:bit displays a sequence of 6 random numbers. You may find it easier to write them down than to remember them. -7. Enter the 6 digits which the micro:bit displayed into your Apple device in the pop-up box provided and then select "Pair". -8. If you entered the right number the micro:bit will display a tick / check mark. If you made a mistake it will display a cross or X and you should repeat the process to try again. +1. Switch your @boardname@ into 'pairing mode' using the steps above +2. Wait until 'PAIRING MODE!' has finished scrolling across the @boardname@ display. +3. Launch the nRF MCP application. Your @boardname@ should be listed and have a "Connect" button next to it. +4. Select "Connect" to connect your Apple device to the @boardname@. This will trigger the pairing process. +5. The @boardname@ will display a left pointing arrow and the Apple device will pop up a box into which you will be invited to enter a "pin" (Personal Identity Number). +6. Press button A on the @boardname@ and watch carefully as the @boardname@ displays a sequence of 6 random numbers. You may find it easier to write them down than to remember them. +7. Enter the 6 digits which the @boardname@ displayed into your Apple device in the pop-up box provided and then select "Pair". +8. If you entered the right number the @boardname@ will display a tick / check mark. If you made a mistake it will display a cross or X and you should repeat the process to try again. #### Video https://www.youtube.com/watch?v=wslwyAMwMhs -### How often do I need to pair my micro:bit with my phone? +### How often do I need to pair my @boardname@ with my phone? -You do *not* need to pair your micro:bit and smartphone or tablet every time you use them together. Pairing establishes 'trust' which will be retained until it is somehow lost. When another device wants to talk to your micro:bit it must connect to it but connecting and pairing are not the same thing. +You do *not* need to pair your @boardname@ and smartphone or tablet every time you use them together. Pairing establishes 'trust' which will be retained until it is somehow lost. When another device wants to talk to your @boardname@ it must connect to it but connecting and pairing are not the same thing. There are circumstances which will result in pairing data being lost however and when this happens you will need to pair again. -Currently, flashing new code via a USB cable causes the micro:bit's Bluetooth pairing data to be lost. Consequently, if you do flash new code to your micro:bit using a USB cable you will need to pair again. +Currently, flashing new code via a USB cable causes the @boardname@'s Bluetooth pairing data to be lost. Consequently, if you do flash new code to your @boardname@ using a USB cable you will need to pair again. -In contrast if you upload new code to your micro:bit over Bluetooth, using for example the Samsung micro:bit application for Android devices, you will not need to pair again. +In contrast if you upload new code to your @boardname@ over Bluetooth, using for example the Samsung @boardname@ application for Android devices, you will not need to pair again. If you do find yourself needing to pair again you will first need to remove the pairing from your other device (i.e. smartphone or tablet): -* On Android go into Settings/Bluetooth, select the 'cog' next to your micro:bit and then select FORGET -* On iOS go into Settings/Bluetooth, select your micro:bit and then select Forget This Device -* On a Windows device go into Settings/Bluetooth. Press and hold the micro:bit entry on the Windows device. A pop-up will appear with the option "delete". Select "delete" to unpair your micro:bit. +* On Android go into Settings/Bluetooth, select the 'cog' next to your @boardname@ and then select FORGET +* On iOS go into Settings/Bluetooth, select your @boardname@ and then select Forget This Device +* On a Windows device go into Settings/Bluetooth. Press and hold the @boardname@ entry on the Windows device. A pop-up will appear with the option "delete". Select "delete" to unpair your @boardname@. ### See also -[About Bluetooth](/reference/bluetooth/about-bluetooth), [micro:bit Bluetooth profile overview ](http://lancaster-university.github.io/microbit-docs/ble/profile/), [micro:bit Bluetooth profile reference](http://lancaster-university.github.io/microbit-docs/resources/bluetooth/microbit-profile-V1.9-Level-2.pdf), [Bluetooth on micro:bit resources](http://bluetooth-mdw.blogspot.co.uk/p/bbc-microbit.html), [Bluetooth SIG](https://www.bluetooth.com) +[About Bluetooth](/reference/bluetooth/about-bluetooth), [@boardname@ Bluetooth profile overview ](http://lancaster-university.github.io/microbit-docs/ble/profile/), [@boardname@ Bluetooth profile reference](http://lancaster-university.github.io/microbit-docs/resources/bluetooth/microbit-profile-V1.9-Level-2.pdf), [Bluetooth on @boardname@ resources](http://bluetooth-mdw.blogspot.co.uk/p/bbc-microbit.html), [Bluetooth SIG](https://www.bluetooth.com) ```package diff --git a/docs/reference/bluetooth/on-bluetooth-connected.md b/docs/reference/bluetooth/on-bluetooth-connected.md index 963a236c..42f3e4d9 100755 --- a/docs/reference/bluetooth/on-bluetooth-connected.md +++ b/docs/reference/bluetooth/on-bluetooth-connected.md @@ -3,12 +3,12 @@ ### ~hint ![](/static/bluetooth/Bluetooth_SIG.png) -For another device like a smartphone to use any of the Bluetooth "services" which the micro:bit has, it must first be [paired with the micro:bit](/reference/bluetooth/bluetooth-pairing). Once paired, the other device may connect to the micro:bit and exchange data relating to many of the micro:bit's features. +For another device like a smartphone to use any of the Bluetooth "services" which the @boardname@ has, it must first be [paired with the @boardname@](/reference/bluetooth/bluetooth-pairing). Once paired, the other device may connect to the @boardname@ and exchange data relating to many of the @boardname@'s features. ### ~ This block starts an [event handler](/reference/event-handler) which in this case will run -when something connects to your micro:bit using Bluetooth. +when something connects to your @boardname@ using Bluetooth. ```sig bluetooth.onBluetoothConnected(() => {}); @@ -16,7 +16,7 @@ bluetooth.onBluetoothConnected(() => {}); ### Example -You could use this event handler to display a letter "C" on the micro:bit LED grid so you know you have a Bluetooth connection. Or you might want to send some data you've been accumulating to your smartphone as soon as it connects to your micro:bit. Maybe you've been using the accelerometer in your micro:bit to count your steps for example. Using this event handler you could send the accumulated step count to your phone when it establishes a Bluetooth connection. +You could use this event handler to display a letter "C" on the @boardname@ LED grid so you know you have a Bluetooth connection. Or you might want to send some data you've been accumulating to your smartphone as soon as it connects to your @boardname@. Maybe you've been using the accelerometer in your @boardname@ to count your steps for example. Using this event handler you could send the accumulated step count to your phone when it establishes a Bluetooth connection. ```blocks bluetooth.onBluetoothConnected(() => { @@ -30,7 +30,7 @@ http://www.youtube.com/watch?v=HyBcsD9Eh6I ### See also -[About Bluetooth](/reference/bluetooth/about-bluetooth), [micro:bit Bluetooth profile overview ](http://lancaster-university.github.io/microbit-docs/ble/profile/), [micro:bit Bluetooth profile reference](http://lancaster-university.github.io/microbit-docs/resources/bluetooth/microbit-profile-V1.9-Level-2.pdf), [Bluetooth on micro:bit resources](http://bluetooth-mdw.blogspot.co.uk/p/bbc-microbit.html), [Bluetooth SIG](https://www.bluetooth.com) +[About Bluetooth](/reference/bluetooth/about-bluetooth), [@boardname@ Bluetooth profile overview ](http://lancaster-university.github.io/microbit-docs/ble/profile/), [@boardname@ Bluetooth profile reference](http://lancaster-university.github.io/microbit-docs/resources/bluetooth/microbit-profile-V1.9-Level-2.pdf), [Bluetooth on @boardname@ resources](http://bluetooth-mdw.blogspot.co.uk/p/bbc-microbit.html), [Bluetooth SIG](https://www.bluetooth.com) ```package bluetooth diff --git a/docs/reference/bluetooth/on-bluetooth-disconnected.md b/docs/reference/bluetooth/on-bluetooth-disconnected.md index 2406f8df..619f359d 100755 --- a/docs/reference/bluetooth/on-bluetooth-disconnected.md +++ b/docs/reference/bluetooth/on-bluetooth-disconnected.md @@ -3,20 +3,20 @@ ### ~hint ![](/static/bluetooth/Bluetooth_SIG.png) -For another device like a smartphone to use any of the Bluetooth "services" which the micro:bit has, it must first be [paired with the micro:bit](/reference/bluetooth/bluetooth-pairing). Once paired, the other device may connect to the micro:bit and exchange data relating to many of the micro:bit's features. +For another device like a smartphone to use any of the Bluetooth "services" which the @boardname@ has, it must first be [paired with the @boardname@](/reference/bluetooth/bluetooth-pairing). Once paired, the other device may connect to the @boardname@ and exchange data relating to many of the @boardname@'s features. ### ~ -This block starts an [event handler](/reference/event-handler) which in this case will run when a device which is connected to your micro:bit over Bluetooth disconnects. +This block starts an [event handler](/reference/event-handler) which in this case will run when a device which is connected to your @boardname@ over Bluetooth disconnects. -You could use this event handler to display a letter "D" on the micro:bit LED grid so you know that the Bluetooth connection has been closed. +You could use this event handler to display a letter "D" on the @boardname@ LED grid so you know that the Bluetooth connection has been closed. ```sig bluetooth.onBluetoothDisconnected(() => { }); ``` -### Example: Displaying "D" when a Bluetooth connection to the micro:bit is closed +### Example: Displaying "D" when a Bluetooth connection to the @boardname@ is closed ```blocks bluetooth.onBluetoothDisconnected(() => { @@ -30,7 +30,7 @@ http://www.youtube.com/watch?v=HyBcsD9Eh6I ### See also -[About Bluetooth](/reference/bluetooth/about-bluetooth), [micro:bit Bluetooth profile overview ](http://lancaster-university.github.io/microbit-docs/ble/profile/), [micro:bit Bluetooth profile reference](http://lancaster-university.github.io/microbit-docs/resources/bluetooth/microbit-profile-V1.9-Level-2.pdf), [Bluetooth on micro:bit resources](http://bluetooth-mdw.blogspot.co.uk/p/bbc-microbit.html), [Bluetooth SIG](https://www.bluetooth.com) +[About Bluetooth](/reference/bluetooth/about-bluetooth), [@boardname@ Bluetooth profile overview ](http://lancaster-university.github.io/microbit-docs/ble/profile/), [@boardname@ Bluetooth profile reference](http://lancaster-university.github.io/microbit-docs/resources/bluetooth/microbit-profile-V1.9-Level-2.pdf), [Bluetooth on @boardname@ resources](http://bluetooth-mdw.blogspot.co.uk/p/bbc-microbit.html), [Bluetooth SIG](https://www.bluetooth.com) ```package bluetooth diff --git a/docs/reference/bluetooth/start-accelerometer-service.md b/docs/reference/bluetooth/start-accelerometer-service.md index 59305b0e..3254fc66 100755 --- a/docs/reference/bluetooth/start-accelerometer-service.md +++ b/docs/reference/bluetooth/start-accelerometer-service.md @@ -3,15 +3,15 @@ ### ~hint ![](/static/bluetooth/Bluetooth_SIG.png) -For another device like a smartphone to use any of the Bluetooth "services" which the micro:bit has, it must first be [paired with the micro:bit](/reference/bluetooth/bluetooth-pairing). Once paired, the other device may connect to the micro:bit and exchange data relating to many of the micro:bit's features. +For another device like a smartphone to use any of the Bluetooth "services" which the @boardname@ has, it must first be [paired with the @boardname@](/reference/bluetooth/bluetooth-pairing). Once paired, the other device may connect to the @boardname@ and exchange data relating to many of the @boardname@'s features. ### ~ -The Bluetooth accelerometer service allows another device such as a smartphone to wirelessly receive data from the micro:bit's accelerometer. An accelerometer detects motion. More precisely, it measures acceleration in one or more of three directions which we call X, Y and Z. +The Bluetooth accelerometer service allows another device such as a smartphone to wirelessly receive data from the @boardname@'s accelerometer. An accelerometer detects motion. More precisely, it measures acceleration in one or more of three directions which we call X, Y and Z. -Using the Bluetooth accelerometer service you could, for example, create a smartphone application which makes a loud noise whenever your micro:bit (or the important thing you've attached it to) is moved. Or you could use your micro:bit to control the movement of a cartoon character in a game on your smartphone just by tilting the micro:bit in the direction you want the character to move in. +Using the Bluetooth accelerometer service you could, for example, create a smartphone application which makes a loud noise whenever your @boardname@ (or the important thing you've attached it to) is moved. Or you could use your @boardname@ to control the movement of a cartoon character in a game on your smartphone just by tilting the @boardname@ in the direction you want the character to move in. -No additional code is needed on the micro:bit to use the Bluetooth accelerometer service from another device. +No additional code is needed on the @boardname@ to use the Bluetooth accelerometer service from another device. ```sig bluetooth.startAccelerometerService(); @@ -31,11 +31,11 @@ http://www.youtube.com/watch?v=aep_GVowKfs#t=18s ### Advanced -For more advanced information on the micro:bit Bluetooth accelerometer service including information on using a smartphone, see the [Lancaster University micro:bit runtime technical documentation](http://lancaster-university.github.io/microbit-docs/ble/accelerometer-service/) +For more advanced information on the @boardname@ Bluetooth accelerometer service including information on using a smartphone, see the [Lancaster University @boardname@ runtime technical documentation](http://lancaster-university.github.io/microbit-docs/ble/accelerometer-service/) ### See also -[About Bluetooth](/reference/bluetooth/about-bluetooth), [micro:bit Bluetooth profile overview ](http://lancaster-university.github.io/microbit-docs/ble/profile/), [micro:bit Bluetooth profile reference](http://lancaster-university.github.io/microbit-docs/resources/bluetooth/microbit-profile-V1.9-Level-2.pdf), [Bluetooth on micro:bit resources](http://bluetooth-mdw.blogspot.co.uk/p/bbc-microbit.html), [Bluetooth SIG](https://www.bluetooth.com) +[About Bluetooth](/reference/bluetooth/about-bluetooth), [@boardname@ Bluetooth profile overview ](http://lancaster-university.github.io/microbit-docs/ble/profile/), [@boardname@ Bluetooth profile reference](http://lancaster-university.github.io/microbit-docs/resources/bluetooth/microbit-profile-V1.9-Level-2.pdf), [Bluetooth on @boardname@ resources](http://bluetooth-mdw.blogspot.co.uk/p/bbc-microbit.html), [Bluetooth SIG](https://www.bluetooth.com) ```package bluetooth diff --git a/docs/reference/bluetooth/start-button-service.md b/docs/reference/bluetooth/start-button-service.md index a0bc14fe..f4cdaf09 100755 --- a/docs/reference/bluetooth/start-button-service.md +++ b/docs/reference/bluetooth/start-button-service.md @@ -3,19 +3,19 @@ ### ~hint ![](/static/bluetooth/Bluetooth_SIG.png) -For another device like a smartphone to use any of the Bluetooth "services" which the micro:bit has, it must first be [paired with the micro:bit](/reference/bluetooth/bluetooth-pairing). Once paired, the other device may connect to the micro:bit and exchange data relating to many of the micro:bit's features. +For another device like a smartphone to use any of the Bluetooth "services" which the @boardname@ has, it must first be [paired with the @boardname@](/reference/bluetooth/bluetooth-pairing). Once paired, the other device may connect to the @boardname@ and exchange data relating to many of the @boardname@'s features. ### ~ -The Bluetooth button service makes it possible for another device such as a smartphone to be notified wirelessly whenever a button on the front of a micro:bit is pressed. Each of the two micro:bit buttons can be in one of three possible states: +The Bluetooth button service makes it possible for another device such as a smartphone to be notified wirelessly whenever a button on the front of a @boardname@ is pressed. Each of the two @boardname@ buttons can be in one of three possible states: * Not pressed * Pressed * Long press - pressed and held down for at least 2 seconds -The button service allows you to make other things which are connected to your micro:bit using Bluetooth respond in some way when you press either of the buttons. You could, for example, hide your smartphone somewhere in the room and have it make an amusing noise when you press either of the buttons on your micro:bit. We'll leave it to you to decide what would be amusing. +The button service allows you to make other things which are connected to your @boardname@ using Bluetooth respond in some way when you press either of the buttons. You could, for example, hide your smartphone somewhere in the room and have it make an amusing noise when you press either of the buttons on your @boardname@. We'll leave it to you to decide what would be amusing. -No additional code is needed on the micro:bit to use the Bluetooth button service from another device. +No additional code is needed on the @boardname@ to use the Bluetooth button service from another device. ```sig bluetooth.startButtonService(); @@ -35,11 +35,11 @@ http://www.youtube.com/watch?v=aep_GVowKfs ### Advanced -For more advanced information on the micro:bit Bluetooth button service including information on using a smartphone, see the [Lancaster University micro:bit runtime technical documentation](http://lancaster-university.github.io/microbit-docs/ble/button-service/) +For more advanced information on the @boardname@ Bluetooth button service including information on using a smartphone, see the [Lancaster University @boardname@ runtime technical documentation](http://lancaster-university.github.io/microbit-docs/ble/button-service/) ### See also -[About Bluetooth](/reference/bluetooth/about-bluetooth), [micro:bit Bluetooth profile overview ](http://lancaster-university.github.io/microbit-docs/ble/profile/), [micro:bit Bluetooth profile reference](http://lancaster-university.github.io/microbit-docs/resources/bluetooth/microbit-profile-V1.9-Level-2.pdf), [Bluetooth on micro:bit resources](http://bluetooth-mdw.blogspot.co.uk/p/bbc-microbit.html), [Bluetooth SIG](https://www.bluetooth.com) +[About Bluetooth](/reference/bluetooth/about-bluetooth), [@boardname@ Bluetooth profile overview ](http://lancaster-university.github.io/microbit-docs/ble/profile/), [@boardname@ Bluetooth profile reference](http://lancaster-university.github.io/microbit-docs/resources/bluetooth/microbit-profile-V1.9-Level-2.pdf), [Bluetooth on @boardname@ resources](http://bluetooth-mdw.blogspot.co.uk/p/bbc-microbit.html), [Bluetooth SIG](https://www.bluetooth.com) ```package bluetooth diff --git a/docs/reference/bluetooth/start-io-pin-service.md b/docs/reference/bluetooth/start-io-pin-service.md index 5f9cc599..a85e98e2 100755 --- a/docs/reference/bluetooth/start-io-pin-service.md +++ b/docs/reference/bluetooth/start-io-pin-service.md @@ -3,13 +3,13 @@ ### ~hint ![](/static/bluetooth/Bluetooth_SIG.png) -For another device like a smartphone to use any of the Bluetooth "services" which the micro:bit has, it must first be [paired with the micro:bit](/reference/bluetooth/bluetooth-pairing). Once paired, the other device may connect to the micro:bit and exchange data relating to many of the micro:bit's features. +For another device like a smartphone to use any of the Bluetooth "services" which the @boardname@ has, it must first be [paired with the @boardname@](/reference/bluetooth/bluetooth-pairing). Once paired, the other device may connect to the @boardname@ and exchange data relating to many of the @boardname@'s features. ### ~ -The Bluetooth IO pin service makes it possible for another device such as a smartphone to communicate with other electronic 'things' connected to a micro:bit's edge connector. You could for example, use your smartphone to switch on or off a light which is connected to the micro:bit or your smartphone could receive data collected from a sensor connected to the micro:bit. In fact you could do both of these things at the same time since the Bluetooth IO pin service lets you interact with multiple 'pins' on the edge conector in different ways all at the same time. +The Bluetooth IO pin service makes it possible for another device such as a smartphone to communicate with other electronic 'things' connected to a @boardname@'s edge connector. You could for example, use your smartphone to switch on or off a light which is connected to the @boardname@ or your smartphone could receive data collected from a sensor connected to the @boardname@. In fact you could do both of these things at the same time since the Bluetooth IO pin service lets you interact with multiple 'pins' on the edge conector in different ways all at the same time. -No additional code is needed on the micro:bit to use the Bluetooth IO pin service from another device. +No additional code is needed on the @boardname@ to use the Bluetooth IO pin service from another device. ```sig bluetooth.startIOPinService(); @@ -29,11 +29,11 @@ http://www.youtube.com/watch?v=aep_GVowKfs ### Advanced -For more advanced information on the micro:bit Bluetooth IO pin service including information on using a smartphone, see the [Lancaster University micro:bit runtime technical documentation](http://lancaster-university.github.io/microbit-docs/ble/iopin-service/) +For more advanced information on the @boardname@ Bluetooth IO pin service including information on using a smartphone, see the [Lancaster University @boardname@ runtime technical documentation](http://lancaster-university.github.io/microbit-docs/ble/iopin-service/) ### See also -[About Bluetooth](/reference/bluetooth/about-bluetooth), [micro:bit Bluetooth profile overview ](http://lancaster-university.github.io/microbit-docs/ble/profile/), [micro:bit Bluetooth profile reference](http://lancaster-university.github.io/microbit-docs/resources/bluetooth/microbit-profile-V1.9-Level-2.pdf), [Bluetooth on micro:bit resources](http://bluetooth-mdw.blogspot.co.uk/p/bbc-microbit.html), [Bluetooth SIG](https://www.bluetooth.com) +[About Bluetooth](/reference/bluetooth/about-bluetooth), [@boardname@ Bluetooth profile overview ](http://lancaster-university.github.io/microbit-docs/ble/profile/), [@boardname@ Bluetooth profile reference](http://lancaster-university.github.io/microbit-docs/resources/bluetooth/microbit-profile-V1.9-Level-2.pdf), [Bluetooth on @boardname@ resources](http://bluetooth-mdw.blogspot.co.uk/p/bbc-microbit.html), [Bluetooth SIG](https://www.bluetooth.com) ```package bluetooth diff --git a/docs/reference/bluetooth/start-led-service.md b/docs/reference/bluetooth/start-led-service.md index cd7bef1b..1fe344c4 100755 --- a/docs/reference/bluetooth/start-led-service.md +++ b/docs/reference/bluetooth/start-led-service.md @@ -3,15 +3,15 @@ ### ~hint ![](/static/bluetooth/Bluetooth_SIG.png) -For another device like a smartphone to use any of the Bluetooth "services" which the micro:bit has, it must first be [paired with the micro:bit](/reference/bluetooth/bluetooth-pairing). Once paired, the other device may connect to the micro:bit and exchange data relating to many of the micro:bit's features. +For another device like a smartphone to use any of the Bluetooth "services" which the @boardname@ has, it must first be [paired with the @boardname@](/reference/bluetooth/bluetooth-pairing). Once paired, the other device may connect to the @boardname@ and exchange data relating to many of the @boardname@'s features. ### ~ -The Bluetooth LED service allows another device such as a smartphone to send short text strings or patterns over a Bluetooth connection to a micro:bit for display on its LED matrix. Text will scroll across the micro:bit and the speed at which it scrolls can also be controlled using the Bluetooth LED service. Devices using the LED service may also read the current state of the micro:bit's LED matrix. +The Bluetooth LED service allows another device such as a smartphone to send short text strings or patterns over a Bluetooth connection to a @boardname@ for display on its LED matrix. Text will scroll across the @boardname@ and the speed at which it scrolls can also be controlled using the Bluetooth LED service. Devices using the LED service may also read the current state of the @boardname@'s LED matrix. -So you could, for example, draw a smiley face in a smartphone app and at the press of a button, have it magically appear on your micro:bit on the other side of the room. Or you could program your smartphone to send a message to your micro:bit whenever your phone receives an email, SMS or social media message so you could wear your micro:bit like a smart watch and leave your phone in your bag. +So you could, for example, draw a smiley face in a smartphone app and at the press of a button, have it magically appear on your @boardname@ on the other side of the room. Or you could program your smartphone to send a message to your @boardname@ whenever your phone receives an email, SMS or social media message so you could wear your @boardname@ like a smart watch and leave your phone in your bag. -No additional code is needed on the micro:bit to use the Bluetooth LED service from another device. +No additional code is needed on the @boardname@ to use the Bluetooth LED service from another device. ```sig bluetooth.startLEDService(); @@ -31,11 +31,11 @@ http://www.youtube.com/watch?v=aep_GVowKfs ### Advanced -For more advanced information on the micro:bit Bluetooth LED service including information on using a smartphone, see the [Lancaster University micro:bit runtime technical documentation](http://lancaster-university.github.io/microbit-docs/ble/led-service/) +For more advanced information on the @boardname@ Bluetooth LED service including information on using a smartphone, see the [Lancaster University @boardname@ runtime technical documentation](http://lancaster-university.github.io/microbit-docs/ble/led-service/) ### See also -[About Bluetooth](/reference/bluetooth/about-bluetooth), [micro:bit Bluetooth profile overview ](http://lancaster-university.github.io/microbit-docs/ble/profile/), [micro:bit Bluetooth profile reference](http://lancaster-university.github.io/microbit-docs/resources/bluetooth/microbit-profile-V1.9-Level-2.pdf), [Bluetooth on micro:bit resources](http://bluetooth-mdw.blogspot.co.uk/p/bbc-microbit.html), [Bluetooth SIG](https://www.bluetooth.com) +[About Bluetooth](/reference/bluetooth/about-bluetooth), [@boardname@ Bluetooth profile overview ](http://lancaster-university.github.io/microbit-docs/ble/profile/), [@boardname@ Bluetooth profile reference](http://lancaster-university.github.io/microbit-docs/resources/bluetooth/microbit-profile-V1.9-Level-2.pdf), [Bluetooth on @boardname@ resources](http://bluetooth-mdw.blogspot.co.uk/p/bbc-microbit.html), [Bluetooth SIG](https://www.bluetooth.com) ```package bluetooth diff --git a/docs/reference/bluetooth/start-magnetometer-service.md b/docs/reference/bluetooth/start-magnetometer-service.md index c65c094e..64bf2192 100755 --- a/docs/reference/bluetooth/start-magnetometer-service.md +++ b/docs/reference/bluetooth/start-magnetometer-service.md @@ -3,15 +3,15 @@ ### ~hint ![](/static/bluetooth/Bluetooth_SIG.png) -For another device like a smartphone to use any of the Bluetooth "services" which the micro:bit has, it must first be [paired with the micro:bit](/reference/bluetooth/bluetooth-pairing). Once paired, the other device may connect to the micro:bit and exchange data relating to many of the micro:bit's features. +For another device like a smartphone to use any of the Bluetooth "services" which the @boardname@ has, it must first be [paired with the @boardname@](/reference/bluetooth/bluetooth-pairing). Once paired, the other device may connect to the @boardname@ and exchange data relating to many of the @boardname@'s features. ### ~ -The Bluetooth magnetometer service allows another device such as a smartphone to wirelessly receive data from the micro:bit's magnetometer. The magnetometer measures the strength and direction of magnetic fields including the earth's and so it can be used as a digital compass and indicate the way the micro:bit is pointing relative to magnetic north. +The Bluetooth magnetometer service allows another device such as a smartphone to wirelessly receive data from the @boardname@'s magnetometer. The magnetometer measures the strength and direction of magnetic fields including the earth's and so it can be used as a digital compass and indicate the way the @boardname@ is pointing relative to magnetic north. Using the Bluetooth magnetometer service you could, for example, create a smartphone application which displays your direction of travel, updating it in real time. -No additional code is needed on the micro:bit to use the Bluetooth magnetometer service from another device. +No additional code is needed on the @boardname@ to use the Bluetooth magnetometer service from another device. ```sig bluetooth.startMagnetometerService(); @@ -31,11 +31,11 @@ http://www.youtube.com/watch?v=C_0VL4Gp4_U ### Advanced -For more advanced information on the micro:bit Bluetooth magnetometer service including information on using a smartphone, see the [Lancaster University micro:bit runtime technical documentation](http://lancaster-university.github.io/microbit-docs/ble/magnetometer-service/) +For more advanced information on the @boardname@ Bluetooth magnetometer service including information on using a smartphone, see the [Lancaster University @boardname@ runtime technical documentation](http://lancaster-university.github.io/microbit-docs/ble/magnetometer-service/) ### See also -[About Bluetooth](/reference/bluetooth/about-bluetooth), [micro:bit Bluetooth profile overview ](http://lancaster-university.github.io/microbit-docs/ble/profile/), [micro:bit Bluetooth profile reference](http://lancaster-university.github.io/microbit-docs/resources/bluetooth/microbit-profile-V1.9-Level-2.pdf), [Bluetooth on micro:bit resources](http://bluetooth-mdw.blogspot.co.uk/p/bbc-microbit.html), [Bluetooth SIG](https://www.bluetooth.com) +[About Bluetooth](/reference/bluetooth/about-bluetooth), [@boardname@ Bluetooth profile overview ](http://lancaster-university.github.io/microbit-docs/ble/profile/), [@boardname@ Bluetooth profile reference](http://lancaster-university.github.io/microbit-docs/resources/bluetooth/microbit-profile-V1.9-Level-2.pdf), [Bluetooth on @boardname@ resources](http://bluetooth-mdw.blogspot.co.uk/p/bbc-microbit.html), [Bluetooth SIG](https://www.bluetooth.com) ```package diff --git a/docs/reference/bluetooth/start-temperature-service.md b/docs/reference/bluetooth/start-temperature-service.md index 59d95dc3..37a8bf59 100755 --- a/docs/reference/bluetooth/start-temperature-service.md +++ b/docs/reference/bluetooth/start-temperature-service.md @@ -3,15 +3,15 @@ ### ~hint ![](/static/bluetooth/Bluetooth_SIG.png) -For another device like a smartphone to use any of the Bluetooth "services" which the micro:bit has, it must first be [paired with the micro:bit](/reference/bluetooth/bluetooth-pairing). Once paired, the other device may connect to the micro:bit and exchange data relating to many of the micro:bit's features. +For another device like a smartphone to use any of the Bluetooth "services" which the @boardname@ has, it must first be [paired with the @boardname@](/reference/bluetooth/bluetooth-pairing). Once paired, the other device may connect to the @boardname@ and exchange data relating to many of the @boardname@'s features. ### ~ -A micro:bit is able to provide a rough measure of the current environmental temperature. It's an approximation only as in fact the temperature value is inferred from the temperature of its main processor. The Bluetooth temperature service allows another device such as a smartphone to wirelessly find out the micro:bit's current temperature reading or to receive a constant stream of temperature data values. Temperature values are expressed in degrees celsius. +A @boardname@ is able to provide a rough measure of the current environmental temperature. It's an approximation only as in fact the temperature value is inferred from the temperature of its main processor. The Bluetooth temperature service allows another device such as a smartphone to wirelessly find out the @boardname@'s current temperature reading or to receive a constant stream of temperature data values. Temperature values are expressed in degrees celsius. -Using the Bluetooth temperature service you could turn your smartphone or tablet into a graphical thermometer using your micro:bit as the sensor. +Using the Bluetooth temperature service you could turn your smartphone or tablet into a graphical thermometer using your @boardname@ as the sensor. -No additional code is needed on the micro:bit to use the Bluetooth temperature service from another device. +No additional code is needed on the @boardname@ to use the Bluetooth temperature service from another device. ```sig bluetooth.startTemperatureService(); @@ -31,11 +31,11 @@ http://www.youtube.com/watch?v=aep_GVowKfs ### Advanced -For more advanced information on the micro:bit Bluetooth temperature service including information on using a smartphone, see the [Lancaster University micro:bit runtime technical documentation](http://lancaster-university.github.io/microbit-docs/ble/temperature-service/) +For more advanced information on the @boardname@ Bluetooth temperature service including information on using a smartphone, see the [Lancaster University @boardname@ runtime technical documentation](http://lancaster-university.github.io/microbit-docs/ble/temperature-service/) ### See also -[About Bluetooth](/reference/bluetooth/about-bluetooth), [micro:bit Bluetooth profile overview ](http://lancaster-university.github.io/microbit-docs/ble/profile/), [micro:bit Bluetooth profile reference](http://lancaster-university.github.io/microbit-docs/resources/bluetooth/microbit-profile-V1.9-Level-2.pdf), [Bluetooth on micro:bit resources](http://bluetooth-mdw.blogspot.co.uk/p/bbc-microbit.html), [Bluetooth SIG](https://www.bluetooth.com) +[About Bluetooth](/reference/bluetooth/about-bluetooth), [@boardname@ Bluetooth profile overview ](http://lancaster-university.github.io/microbit-docs/ble/profile/), [@boardname@ Bluetooth profile reference](http://lancaster-university.github.io/microbit-docs/resources/bluetooth/microbit-profile-V1.9-Level-2.pdf), [Bluetooth on @boardname@ resources](http://bluetooth-mdw.blogspot.co.uk/p/bbc-microbit.html), [Bluetooth SIG](https://www.bluetooth.com) ```package diff --git a/docs/reference/bluetooth/start-uart-service.md b/docs/reference/bluetooth/start-uart-service.md index dffab6d7..6c98be93 100755 --- a/docs/reference/bluetooth/start-uart-service.md +++ b/docs/reference/bluetooth/start-uart-service.md @@ -3,17 +3,17 @@ ### ~hint ![](/static/bluetooth/Bluetooth_SIG.png) -For another device like a smartphone to use any of the Bluetooth "services" which the micro:bit has, it must first be [paired with the micro:bit](/reference/bluetooth/bluetooth-pairing). Once paired, the other device may connect to the micro:bit and exchange data relating to many of the micro:bit's features. +For another device like a smartphone to use any of the Bluetooth "services" which the @boardname@ has, it must first be [paired with the @boardname@](/reference/bluetooth/bluetooth-pairing). Once paired, the other device may connect to the @boardname@ and exchange data relating to many of the @boardname@'s features. ### ~ -The Bluetooth UART service allows another device such as a smartphone to exchange any data it wants to with the micro:bit, in small chunks which are intended to be joined together. [UART[(https://en.wikipedia.org/wiki/Universal_asynchronous_receiver/transmitter) stands for Universal Asynchronous Receiver Transmitter and is one way in which serial data communications can be performed, usually between two devices connected by a physical, wired connection. The Bluetooth UART service emulates the behaviour of a physical UART system and allows the exchange of a maximum of 20 bytes of data at a time in either direction. +The Bluetooth UART service allows another device such as a smartphone to exchange any data it wants to with the @boardname@, in small chunks which are intended to be joined together. [UART[(https://en.wikipedia.org/wiki/Universal_asynchronous_receiver/transmitter) stands for Universal Asynchronous Receiver Transmitter and is one way in which serial data communications can be performed, usually between two devices connected by a physical, wired connection. The Bluetooth UART service emulates the behaviour of a physical UART system and allows the exchange of a maximum of 20 bytes of data at a time in either direction. -When this service is used, the micro:bit sets up a 60 byte buffer and data it receives will be accumulated in the buffer until it is full. When using the UART service from your micro:bit code, you can indicate a special character which will be used to mean that the entire message in at most three chunks has now been sent by the other, connected device, at which point the micro:bit will release the entire contents of its buffer to any code trying to read it. In other words this special character, known as a 'delimiter' is used by the device connected to the micro:bit to mean "I've sent my whole message, you can now use it". +When this service is used, the @boardname@ sets up a 60 byte buffer and data it receives will be accumulated in the buffer until it is full. When using the UART service from your @boardname@ code, you can indicate a special character which will be used to mean that the entire message in at most three chunks has now been sent by the other, connected device, at which point the @boardname@ will release the entire contents of its buffer to any code trying to read it. In other words this special character, known as a 'delimiter' is used by the device connected to the @boardname@ to mean "I've sent my whole message, you can now use it". -You could use the UART service for many things. It doesn't care what you put in messages which makes it very flexible. You could create a guessing game, with questions and answers passing between micro:bit and a smartphone or you could connect a camera to the micro:bit and transmit image data obtained from the edge connector, in chunks over Bluetooth to a smartphone. There are a great many possibilities. +You could use the UART service for many things. It doesn't care what you put in messages which makes it very flexible. You could create a guessing game, with questions and answers passing between @boardname@ and a smartphone or you could connect a camera to the @boardname@ and transmit image data obtained from the edge connector, in chunks over Bluetooth to a smartphone. There are a great many possibilities. -To use the Bluetooth UART service from another device you'll need additional micro:bit code which reads and uses data from the UART buffer and / or writes data to the buffer for transmission over Bluetooth to another device. +To use the Bluetooth UART service from another device you'll need additional @boardname@ code which reads and uses data from the UART buffer and / or writes data to the buffer for transmission over Bluetooth to another device. ```sig bluetooth.startUartService(); @@ -33,11 +33,11 @@ https://www.youtube.com/watch?v=PgGeWddMAZ0 ### Advanced -For more advanced information on the micro:bit Bluetooth UART service including information on using a smartphone, see the [Lancaster University micro:bit runtime technical documentation](http://lancaster-university.github.io/microbit-docs/ble/uart-service/) +For more advanced information on the @boardname@ Bluetooth UART service including information on using a smartphone, see the [Lancaster University @boardname@ runtime technical documentation](http://lancaster-university.github.io/microbit-docs/ble/uart-service/) ### See also -[About Bluetooth](/reference/bluetooth/about-bluetooth), [micro:bit Bluetooth profile overview ](http://lancaster-university.github.io/microbit-docs/ble/profile/), [micro:bit Bluetooth profile reference](http://lancaster-university.github.io/microbit-docs/resources/bluetooth/microbit-profile-V1.9-Level-2.pdf), [Bluetooth on micro:bit resources](http://bluetooth-mdw.blogspot.co.uk/p/bbc-microbit.html), [Bluetooth SIG](https://www.bluetooth.com) +[About Bluetooth](/reference/bluetooth/about-bluetooth), [@boardname@ Bluetooth profile overview ](http://lancaster-university.github.io/microbit-docs/ble/profile/), [@boardname@ Bluetooth profile reference](http://lancaster-university.github.io/microbit-docs/resources/bluetooth/microbit-profile-V1.9-Level-2.pdf), [Bluetooth on @boardname@ resources](http://bluetooth-mdw.blogspot.co.uk/p/bbc-microbit.html), [Bluetooth SIG](https://www.bluetooth.com) ```package bluetooth diff --git a/docs/reference/bluetooth/uart-read-until.md b/docs/reference/bluetooth/uart-read-until.md index 3f52b4b7..57d27523 100644 --- a/docs/reference/bluetooth/uart-read-until.md +++ b/docs/reference/bluetooth/uart-read-until.md @@ -3,13 +3,13 @@ ### ~hint ![](/static/bluetooth/Bluetooth_SIG.png) -For another device like a smartphone to use any of the Bluetooth "services" which the micro:bit has, it must first be [paired with the micro:bit](/reference/bluetooth/bluetooth-pairing). Once paired, the other device may connect to the micro:bit and exchange data relating to many of the micro:bit's features. +For another device like a smartphone to use any of the Bluetooth "services" which the @boardname@ has, it must first be [paired with the @boardname@](/reference/bluetooth/bluetooth-pairing). Once paired, the other device may connect to the @boardname@ and exchange data relating to many of the @boardname@'s features. ### ~ -The [Bluetooth UART service](/reference/bluetooth/start-uart-service) allows another device such as a smartphone to exchange any data it wants to with the micro:bit, in small chunks. +The [Bluetooth UART service](/reference/bluetooth/start-uart-service) allows another device such as a smartphone to exchange any data it wants to with the @boardname@, in small chunks. -With the Bluetooth UART service running, this block allows a micro:bit to read data which has been received from a Bluetooth connected device, terminating reading and returning the value obtained as soon as a specified delimiter character is encountered. This means that connected devices can send data to the micro:bit and indicate that the complete message has been sent by appending the message with the delimiter character. +With the Bluetooth UART service running, this block allows a @boardname@ to read data which has been received from a Bluetooth connected device, terminating reading and returning the value obtained as soon as a specified delimiter character is encountered. This means that connected devices can send data to the @boardname@ and indicate that the complete message has been sent by appending the message with the delimiter character. ```sig bluetooth.uartReadUntil(""); @@ -41,11 +41,11 @@ https://www.youtube.com/watch?v=PgGeWddMAZ0 ### Advanced -For more advanced information on the micro:bit Bluetooth UART service including information on using a smartphone, see the [Lancaster University micro:bit runtime technical documentation](http://lancaster-university.github.io/microbit-docs/ble/uart-service/) +For more advanced information on the @boardname@ Bluetooth UART service including information on using a smartphone, see the [Lancaster University @boardname@ runtime technical documentation](http://lancaster-university.github.io/microbit-docs/ble/uart-service/) ### See also -[About Bluetooth](/reference/bluetooth/about-bluetooth), [micro:bit Bluetooth profile overview ](http://lancaster-university.github.io/microbit-docs/ble/profile/), [micro:bit Bluetooth profile reference](http://lancaster-university.github.io/microbit-docs/resources/bluetooth/microbit-profile-V1.9-Level-2.pdf), [Bluetooth on micro:bit resources](http://bluetooth-mdw.blogspot.co.uk/p/bbc-microbit.html), [Bluetooth SIG](https://www.bluetooth.com) +[About Bluetooth](/reference/bluetooth/about-bluetooth), [@boardname@ Bluetooth profile overview ](http://lancaster-university.github.io/microbit-docs/ble/profile/), [@boardname@ Bluetooth profile reference](http://lancaster-university.github.io/microbit-docs/resources/bluetooth/microbit-profile-V1.9-Level-2.pdf), [Bluetooth on @boardname@ resources](http://bluetooth-mdw.blogspot.co.uk/p/bbc-microbit.html), [Bluetooth SIG](https://www.bluetooth.com) ```package bluetooth diff --git a/docs/reference/bluetooth/uart-write-number.md b/docs/reference/bluetooth/uart-write-number.md index 4fc12928..34b13099 100644 --- a/docs/reference/bluetooth/uart-write-number.md +++ b/docs/reference/bluetooth/uart-write-number.md @@ -3,13 +3,13 @@ ### ~hint ![](/static/bluetooth/Bluetooth_SIG.png) -For another device like a smartphone to use any of the Bluetooth "services" which the micro:bit has, it must first be [paired with the micro:bit](/reference/bluetooth/bluetooth-pairing). Once paired, the other device may connect to the micro:bit and exchange data relating to many of the micro:bit's features. +For another device like a smartphone to use any of the Bluetooth "services" which the @boardname@ has, it must first be [paired with the @boardname@](/reference/bluetooth/bluetooth-pairing). Once paired, the other device may connect to the @boardname@ and exchange data relating to many of the @boardname@'s features. ### ~ -The [Bluetooth UART service](/reference/bluetooth/start-uart-service) allows another device such as a smartphone to exchange any data it wants to with the micro:bit, in small chunks. +The [Bluetooth UART service](/reference/bluetooth/start-uart-service) allows another device such as a smartphone to exchange any data it wants to with the @boardname@, in small chunks. -With the Bluetooth UART service running, this block allows a micro:bit to send data to a Bluetooth connected device. +With the Bluetooth UART service running, this block allows a @boardname@ to send data to a Bluetooth connected device. ```sig bluetooth.uartWriteNumber(42); @@ -17,11 +17,11 @@ bluetooth.uartWriteNumber(42); ### Advanced -For more advanced information on the micro:bit Bluetooth UART service including information on using a smartphone, see the [Lancaster University micro:bit runtime technical documentation](http://lancaster-university.github.io/microbit-docs/ble/uart-service/) +For more advanced information on the @boardname@ Bluetooth UART service including information on using a smartphone, see the [Lancaster University @boardname@ runtime technical documentation](http://lancaster-university.github.io/microbit-docs/ble/uart-service/) ### See also -[About Bluetooth](/reference/bluetooth/about-bluetooth), [micro:bit Bluetooth profile overview ](http://lancaster-university.github.io/microbit-docs/ble/profile/), [micro:bit Bluetooth profile reference](http://lancaster-university.github.io/microbit-docs/resources/bluetooth/microbit-profile-V1.9-Level-2.pdf), [Bluetooth on micro:bit resources](http://bluetooth-mdw.blogspot.co.uk/p/bbc-microbit.html), [Bluetooth SIG](https://www.bluetooth.com) +[About Bluetooth](/reference/bluetooth/about-bluetooth), [@boardname@ Bluetooth profile overview ](http://lancaster-university.github.io/microbit-docs/ble/profile/), [@boardname@ Bluetooth profile reference](http://lancaster-university.github.io/microbit-docs/resources/bluetooth/microbit-profile-V1.9-Level-2.pdf), [Bluetooth on @boardname@ resources](http://bluetooth-mdw.blogspot.co.uk/p/bbc-microbit.html), [Bluetooth SIG](https://www.bluetooth.com) ```package bluetooth diff --git a/docs/reference/bluetooth/uart-write-string.md b/docs/reference/bluetooth/uart-write-string.md index e4d4ecd9..3581c405 100644 --- a/docs/reference/bluetooth/uart-write-string.md +++ b/docs/reference/bluetooth/uart-write-string.md @@ -3,13 +3,13 @@ ### ~hint ![](/static/bluetooth/Bluetooth_SIG.png) -For another device like a smartphone to use any of the Bluetooth "services" which the micro:bit has, it must first be [paired with the micro:bit](/reference/bluetooth/bluetooth-pairing). Once paired, the other device may connect to the micro:bit and exchange data relating to many of the micro:bit's features. +For another device like a smartphone to use any of the Bluetooth "services" which the @boardname@ has, it must first be [paired with the @boardname@](/reference/bluetooth/bluetooth-pairing). Once paired, the other device may connect to the @boardname@ and exchange data relating to many of the @boardname@'s features. ### ~ -The [Bluetooth UART service](/reference/bluetooth/start-uart-service) allows another device such as a smartphone to exchange any data it wants to with the micro:bit, in small chunks. +The [Bluetooth UART service](/reference/bluetooth/start-uart-service) allows another device such as a smartphone to exchange any data it wants to with the @boardname@, in small chunks. -With the Bluetooth UART service running, this block allows a micro:bit to send data to a Bluetooth connected device. +With the Bluetooth UART service running, this block allows a @boardname@ to send data to a Bluetooth connected device. ```sig bluetooth.uartWriteString(""); @@ -40,11 +40,11 @@ https://www.youtube.com/watch?v=PgGeWddMAZ0 ### Advanced -For more advanced information on the micro:bit Bluetooth UART service including information on using a smartphone, see the [Lancaster University micro:bit runtime technical documentation](http://lancaster-university.github.io/microbit-docs/ble/uart-service/) +For more advanced information on the @boardname@ Bluetooth UART service including information on using a smartphone, see the [Lancaster University @boardname@ runtime technical documentation](http://lancaster-university.github.io/microbit-docs/ble/uart-service/) ### See also -[About Bluetooth](/reference/bluetooth/about-bluetooth), [micro:bit Bluetooth profile overview ](http://lancaster-university.github.io/microbit-docs/ble/profile/), [micro:bit Bluetooth profile reference](http://lancaster-university.github.io/microbit-docs/resources/bluetooth/microbit-profile-V1.9-Level-2.pdf), [Bluetooth on micro:bit resources](http://bluetooth-mdw.blogspot.co.uk/p/bbc-microbit.html), [Bluetooth SIG](https://www.bluetooth.com) +[About Bluetooth](/reference/bluetooth/about-bluetooth), [@boardname@ Bluetooth profile overview ](http://lancaster-university.github.io/microbit-docs/ble/profile/), [@boardname@ Bluetooth profile reference](http://lancaster-university.github.io/microbit-docs/resources/bluetooth/microbit-profile-V1.9-Level-2.pdf), [Bluetooth on @boardname@ resources](http://bluetooth-mdw.blogspot.co.uk/p/bbc-microbit.html), [Bluetooth SIG](https://www.bluetooth.com) ```package bluetooth diff --git a/docs/reference/bluetooth/uart-write-value.md b/docs/reference/bluetooth/uart-write-value.md index a47398b1..1f684246 100644 --- a/docs/reference/bluetooth/uart-write-value.md +++ b/docs/reference/bluetooth/uart-write-value.md @@ -3,13 +3,13 @@ ### ~hint ![](/static/bluetooth/Bluetooth_SIG.png) -For another device like a smartphone to use any of the Bluetooth "services" which the micro:bit has, it must first be [paired with the micro:bit](/reference/bluetooth/bluetooth-pairing). Once paired, the other device may connect to the micro:bit and exchange data relating to many of the micro:bit's features. +For another device like a smartphone to use any of the Bluetooth "services" which the @boardname@ has, it must first be [paired with the @boardname@](/reference/bluetooth/bluetooth-pairing). Once paired, the other device may connect to the @boardname@ and exchange data relating to many of the @boardname@'s features. ### ~ -The [Bluetooth UART service](/reference/bluetooth/start-uart-service) allows another device such as a smartphone to exchange any data it wants to with the micro:bit, in small chunks. +The [Bluetooth UART service](/reference/bluetooth/start-uart-service) allows another device such as a smartphone to exchange any data it wants to with the @boardname@, in small chunks. -With the Bluetooth UART service running, this block allows a micro:bit to send data to a Bluetooth connected device. +With the Bluetooth UART service running, this block allows a @boardname@ to send data to a Bluetooth connected device. ```sig bluetooth.uartWriteValue("x", 42); @@ -17,11 +17,11 @@ bluetooth.uartWriteValue("x", 42); ### Advanced -For more advanced information on the micro:bit Bluetooth UART service including information on using a smartphone, see the [Lancaster University micro:bit runtime technical documentation](http://lancaster-university.github.io/microbit-docs/ble/uart-service/) +For more advanced information on the @boardname@ Bluetooth UART service including information on using a smartphone, see the [Lancaster University @boardname@ runtime technical documentation](http://lancaster-university.github.io/microbit-docs/ble/uart-service/) ### See also -[About Bluetooth](/reference/bluetooth/about-bluetooth), [micro:bit Bluetooth profile overview ](http://lancaster-university.github.io/microbit-docs/ble/profile/), [micro:bit Bluetooth profile reference](http://lancaster-university.github.io/microbit-docs/resources/bluetooth/microbit-profile-V1.9-Level-2.pdf), [Bluetooth on micro:bit resources](http://bluetooth-mdw.blogspot.co.uk/p/bbc-microbit.html), [Bluetooth SIG](https://www.bluetooth.com) +[About Bluetooth](/reference/bluetooth/about-bluetooth), [@boardname@ Bluetooth profile overview ](http://lancaster-university.github.io/microbit-docs/ble/profile/), [@boardname@ Bluetooth profile reference](http://lancaster-university.github.io/microbit-docs/resources/bluetooth/microbit-profile-V1.9-Level-2.pdf), [Bluetooth on @boardname@ resources](http://bluetooth-mdw.blogspot.co.uk/p/bbc-microbit.html), [Bluetooth SIG](https://www.bluetooth.com) ```package bluetooth diff --git a/docs/reference/control/device-name.md b/docs/reference/control/device-name.md index 566b0e07..f7ef5f4f 100644 --- a/docs/reference/control/device-name.md +++ b/docs/reference/control/device-name.md @@ -7,5 +7,5 @@ control.deviceName(); ``` **This is an advanced API.** For more information, see the -[micro:bit runtime messageBus documentation](https://lancaster-university.github.io/microbit-docs/ubit/messageBus/). +[@boardname@ runtime messageBus documentation](https://lancaster-university.github.io/microbit-docs/ubit/messageBus/). diff --git a/docs/reference/control/device-serial-number.md b/docs/reference/control/device-serial-number.md index abb4dd20..4302dbe5 100644 --- a/docs/reference/control/device-serial-number.md +++ b/docs/reference/control/device-serial-number.md @@ -7,4 +7,4 @@ control.deviceSerialNumber(); ``` **This is an advanced API.** For more information, see the -[micro:bit runtime messageBus documentation](https://lancaster-university.github.io/microbit-docs/ubit/messageBus/). +[@boardname@ runtime messageBus documentation](https://lancaster-university.github.io/microbit-docs/ubit/messageBus/). diff --git a/docs/reference/control/event-source-id.md b/docs/reference/control/event-source-id.md index af44ba9d..118a04eb 100644 --- a/docs/reference/control/event-source-id.md +++ b/docs/reference/control/event-source-id.md @@ -7,4 +7,4 @@ control.eventSourceId(EventBusSource.MICROBIT_ID_BUTTON_A); ``` **This is an advanced API.** For more information, see the -[micro:bit runtime messageBus documentation](https://lancaster-university.github.io/microbit-docs/ubit/messageBus/) +[@boardname@ runtime messageBus documentation](https://lancaster-university.github.io/microbit-docs/ubit/messageBus/) diff --git a/docs/reference/control/event-timestamp.md b/docs/reference/control/event-timestamp.md index 5129b9ad..add81e12 100644 --- a/docs/reference/control/event-timestamp.md +++ b/docs/reference/control/event-timestamp.md @@ -7,4 +7,4 @@ control.eventTimestamp(); ``` **This is an advanced API.** For more information, see the -[micro:bit runtime messageBus documentation](https://lancaster-university.github.io/microbit-docs/ubit/messageBus/). +[@boardname@ runtime messageBus documentation](https://lancaster-university.github.io/microbit-docs/ubit/messageBus/). diff --git a/docs/reference/control/event-value-id.md b/docs/reference/control/event-value-id.md index 8153a7f0..a0df1b03 100644 --- a/docs/reference/control/event-value-id.md +++ b/docs/reference/control/event-value-id.md @@ -8,5 +8,5 @@ control.eventValueId(EventBusValue.MICROBIT_EVT_ANY); **This is an advanced API.** For more information, see the -[micro:bit runtime messageBus documentation](https://lancaster-university.github.io/microbit-docs/ubit/messageBus/). +[@boardname@ runtime messageBus documentation](https://lancaster-university.github.io/microbit-docs/ubit/messageBus/). diff --git a/docs/reference/control/event-value.md b/docs/reference/control/event-value.md index 46b60081..823ccf2e 100644 --- a/docs/reference/control/event-value.md +++ b/docs/reference/control/event-value.md @@ -8,5 +8,5 @@ control.eventValue(); **This is an advanced API.** For more information, see the -[micro:bit runtime messageBus documentation](https://lancaster-university.github.io/microbit-docs/ubit/messageBus/). +[@boardname@ runtime messageBus documentation](https://lancaster-university.github.io/microbit-docs/ubit/messageBus/). diff --git a/docs/reference/control/in-background.md b/docs/reference/control/in-background.md index 0e0de180..93849411 100644 --- a/docs/reference/control/in-background.md +++ b/docs/reference/control/in-background.md @@ -10,7 +10,7 @@ control.inBackground(() => { ### ~hint For more information, read -[The micro:bit - a reactive system](/device/reactive). +[The @boardname@ - a reactive system](/device/reactive). It is pretty advanced! ### ~ diff --git a/docs/reference/control/on-event.md b/docs/reference/control/on-event.md index a95dd5d8..d48cc816 100644 --- a/docs/reference/control/on-event.md +++ b/docs/reference/control/on-event.md @@ -7,5 +7,5 @@ control.onEvent(control.eventSourceId(EventBusSource.MICROBIT_ID_BUTTON_A), cont ``` **This is an advanced API.** For more information, see the -[micro:bit runtime messageBus documentation](https://lancaster-university.github.io/microbit-docs/ubit/messageBus/). +[@boardname@ runtime messageBus documentation](https://lancaster-university.github.io/microbit-docs/ubit/messageBus/). diff --git a/docs/reference/control/raise-event.md b/docs/reference/control/raise-event.md index f9a8a50c..8a5c8741 100644 --- a/docs/reference/control/raise-event.md +++ b/docs/reference/control/raise-event.md @@ -7,4 +7,4 @@ control.raiseEvent(control.eventSourceId(EventBusSource.MICROBIT_ID_BUTTON_A), c ``` **This is an advanced API.** For more information, see the -[micro:bit runtime messageBus documentation](https://lancaster-university.github.io/microbit-docs/ubit/messageBus/) +[@boardname@ runtime messageBus documentation](https://lancaster-university.github.io/microbit-docs/ubit/messageBus/) diff --git a/docs/reference/control/reset.md b/docs/reference/control/reset.md index 706d3cfd..adf1b116 100644 --- a/docs/reference/control/reset.md +++ b/docs/reference/control/reset.md @@ -2,7 +2,7 @@ Reset the @boardname@ and start the program again. -This function is like pressing the reset button on the back of the micro:bit. +This function is like pressing the reset button on the back of the @boardname@. ```sig control.reset() @@ -12,7 +12,7 @@ control.reset() This program will count as high as you like when you press button `A`. When you get tired of counting, press button `B` to reset the -micro:bit and start the program over. +@boardname@ and start the program over. ```blocks let item = 0; @@ -28,7 +28,7 @@ input.onButtonPressed(Button.B, () => { #### ~hint -This program works better on a real micro:bit than in the simulator. +This program works better on a real @boardname@ than in the simulator. #### ~ diff --git a/docs/reference/devices/on-gamepad-button.md b/docs/reference/devices/on-gamepad-button.md index 3754d942..6eede4cc 100644 --- a/docs/reference/devices/on-gamepad-button.md +++ b/docs/reference/devices/on-gamepad-button.md @@ -1,6 +1,6 @@ # On Gamepad Button -Register code to run when the micro:bit receives a command from the paired gamepad. +Register code to run when the @boardname@ receives a command from the paired gamepad. ### ~hint @@ -16,7 +16,7 @@ devices.onGamepadButton(MesDpadButtonInfo.ADown, () => {}) ### Parameters -* ``body``: Action code to run when the the micro:bit receives a command from the paired gamepad. +* ``body``: Action code to run when the the @boardname@ receives a command from the paired gamepad. ### See Also diff --git a/docs/reference/images/create-big-image.md b/docs/reference/images/create-big-image.md index cb3562a6..1a5395c3 100644 --- a/docs/reference/images/create-big-image.md +++ b/docs/reference/images/create-big-image.md @@ -1,6 +1,6 @@ # Create Big Image -Make a big [image](/reference/images/image) (picture) for the micro:bit +Make a big [image](/reference/images/image) (picture) for the @boardname@ [LED screen](/device/screen). The big image made of two squares. Each of the squares is five LEDs on a side, like a regular image. diff --git a/docs/reference/images/create-image.md b/docs/reference/images/create-image.md index 1ef990ae..935c6b66 100644 --- a/docs/reference/images/create-image.md +++ b/docs/reference/images/create-image.md @@ -1,6 +1,6 @@ # Create Image -Make an [image](/reference/images/image) (picture) for the micro:bit +Make an [image](/reference/images/image) (picture) for the @boardname@ [LED screen](/device/screen). ```sig diff --git a/docs/reference/images/image.md b/docs/reference/images/image.md index 0c2681b6..15770c97 100644 --- a/docs/reference/images/image.md +++ b/docs/reference/images/image.md @@ -1,6 +1,6 @@ # Image -An image for the micro:bit screen. +An image for the @boardname@ screen. ### @parent blocks/language diff --git a/docs/reference/images/show-image.md b/docs/reference/images/show-image.md index f68115ef..fe038d38 100644 --- a/docs/reference/images/show-image.md +++ b/docs/reference/images/show-image.md @@ -1,7 +1,7 @@ # Show Image Show an [image](/reference/images/image) (picture) on the -[LED screen](/device/screen). After the micro:bit shows an image, it +[LED screen](/device/screen). After the @boardname@ shows an image, it will pause for 400 milliseconds (1000 milliseconds is one second). ```sig @@ -12,7 +12,7 @@ item.showImage(0); ### Parameters * an [image](/reference/images/image) (picture). It is usually a square with five LEDs on a side, but it might be wider. -* a [number](/reference/types/number) that says how many LEDs from the left of the picture the micro:bit should start. `0` means start at the first **frame** of the picture, `5` means start at the second frame, `10` means start at the third, and so on. +* a [number](/reference/types/number) that says how many LEDs from the left of the picture the @boardname@ should start. `0` means start at the first **frame** of the picture, `5` means start at the second frame, `10` means start at the third, and so on. ### Example: Flip-flopping arrow diff --git a/docs/reference/input/acceleration.md b/docs/reference/input/acceleration.md index a6aeea25..67e55c83 100644 --- a/docs/reference/input/acceleration.md +++ b/docs/reference/input/acceleration.md @@ -2,7 +2,7 @@ Get the acceleration value (milli g-force), in one of three specified dimensions. -Find the acceleration of the micro:bit (how fast it is speeding up or slowing down). +Find the acceleration of the @boardname@ (how fast it is speeding up or slowing down). ```sig input.acceleration(Dimension.X); @@ -23,11 +23,11 @@ A **g** is as much acceleration as you get from Earth's gravity. ### Returns -* a [number](/reference/types/number) that means the amount of acceleration. When the micro:bit is lying flat on a surface with the screen pointing up, `x` is `0`, `y` is `0`, and `z` is `-1023`. +* a [number](/reference/types/number) that means the amount of acceleration. When the @boardname@ is lying flat on a surface with the screen pointing up, `x` is `0`, `y` is `0`, and `z` is `-1023`. ### Example: bar chart -This example shows the acceleration of the micro:bit with a bar graph. +This example shows the acceleration of the @boardname@ with a bar graph. ```blocks basic.forever(() => { diff --git a/docs/reference/input/button-is-pressed.md b/docs/reference/input/button-is-pressed.md index 901c58de..7cc7235e 100644 --- a/docs/reference/input/button-is-pressed.md +++ b/docs/reference/input/button-is-pressed.md @@ -1,6 +1,6 @@ # Button Is Pressed -Check whether a button is pressed right now. The micro:bit has two buttons: button `A` and button `B`. +Check whether a button is pressed right now. The @boardname@ has two buttons: button `A` and button `B`. ```sig input.buttonIsPressed(Button.A); diff --git a/docs/reference/input/compass-heading.md b/docs/reference/input/compass-heading.md index 100bb5ce..58fd4556 100644 --- a/docs/reference/input/compass-heading.md +++ b/docs/reference/input/compass-heading.md @@ -1,8 +1,8 @@ # Compass Heading -Find which direction on a compass the micro:bit is facing. +Find which direction on a compass the @boardname@ is facing. -The micro:bit measures the **compass heading** from `0` to `360` +The @boardname@ measures the **compass heading** from `0` to `360` degrees with its **magnetometer** chip. Different numbers mean north, east, south, and west. @@ -33,7 +33,7 @@ the compass needle on the screen to change the compass heading. ### Example: compass This program finds the compass heading and then shows a letter -that means whether the micro:bit is facing north (N), south (S), +that means whether the @boardname@ is facing north (N), south (S), east (E), or west (W). ```blocks @@ -52,12 +52,12 @@ basic.forever(() => { ### Calibration Every time you start to use the compass (for example, if you have just -turned the micro:bit on), the micro:bit will start to **calibrate** +turned the @boardname@ on), the @boardname@ will start to **calibrate** (adjust itself). It will ask you to draw a circle by tilting the -micro:bit. +@boardname@. If you are calibrating or using the compass near metal, it might -confuse the micro:bit. +confuse the @boardname@. ### See also diff --git a/docs/reference/input/light-level.md b/docs/reference/input/light-level.md index b9270b0c..66d3f2a8 100644 --- a/docs/reference/input/light-level.md +++ b/docs/reference/input/light-level.md @@ -33,8 +33,8 @@ input.onButtonPressed(Button.B, () => { ### Example: chart light level -This program shows the light level with a [bar chart](/reference/led/plot-bar-graph) on the micro:bit screen. -If you carry the micro:bit around to different places with different light levels, +This program shows the light level with a [bar chart](/reference/led/plot-bar-graph) on the @boardname@ screen. +If you carry the @boardname@ around to different places with different light levels, the bar chart will change. ```blocks diff --git a/docs/reference/input/magnetic-force.md b/docs/reference/input/magnetic-force.md index 75b111bb..9b83c835 100644 --- a/docs/reference/input/magnetic-force.md +++ b/docs/reference/input/magnetic-force.md @@ -8,14 +8,14 @@ input.magneticForce(Dimension.X); ## ~hint -The micro:bit measures magnetic force with **microteslas**. +The @boardname@ measures magnetic force with **microteslas**. ## ~ ### Parameters -* ``dimension`` means which direction the micro:bit should measure +* ``dimension`` means which direction the @boardname@ should measure magnetic force in: either `Dimension.X` (the left-right direction), `Dimension.Y` (the forward/backward direction), or `Dimension.Z` (the up/down direction) @@ -26,7 +26,7 @@ The micro:bit measures magnetic force with **microteslas**. ### Example: metal detector -This program makes the center LED of the micro:bit get brighter when +This program makes the center LED of the @boardname@ get brighter when the magnetic force is stronger, and dimmer when it is weaker. ```blocks diff --git a/docs/reference/input/on-gesture.md b/docs/reference/input/on-gesture.md index 58b4590f..eaa2d4b2 100644 --- a/docs/reference/input/on-gesture.md +++ b/docs/reference/input/on-gesture.md @@ -2,7 +2,7 @@ Start an [event handler](/reference/event-handler) (part of the program that will run when something happens) This handler works when -you do a **gesture** (like shaking the micro:bit). +you do a **gesture** (like shaking the @boardname@). ```sig input.onGesture(Gesture.Shake,() => { @@ -11,11 +11,11 @@ input.onGesture(Gesture.Shake,() => { ### Parameters -* ``gesture`` means the way you hold or move the micro:bit. This can be `shake`, `logo up`, `logo down`, `screen up`, `screen down`, `tilt left`, `tilt right`, `free fall`, `3g`, or `6g`. +* ``gesture`` means the way you hold or move the @boardname@. This can be `shake`, `logo up`, `logo down`, `screen up`, `screen down`, `tilt left`, `tilt right`, `free fall`, `3g`, or `6g`. ### Example: random number -This program shows a number from `0` to `9` when you shake the micro:bit. +This program shows a number from `0` to `9` when you shake the @boardname@. ```blocks input.onGesture(Gesture.Shake,() => { diff --git a/docs/reference/input/on-pin-pressed.md b/docs/reference/input/on-pin-pressed.md index f1b53bd7..b5ac4f98 100644 --- a/docs/reference/input/on-pin-pressed.md +++ b/docs/reference/input/on-pin-pressed.md @@ -4,12 +4,12 @@ Start an [event handler](/reference/event-handler) (part of the program that will run when something happens, like when a button is pressed). This handler works when you press pin `0`, `1`, or `2` together with `GND`. When you are using this function in a web -browser, click the pins on the screen instead of the ones on the BBC -micro:bit. +browser, click the pins on the screen instead of the ones on the +@boardname@. If you hold the `GND` pin with one hand and touch pin `0`, `1`, or `2` with the other, a very small (safe) amount of electricity will flow -through your body and back into the micro:bit. This is called +through your body and back into the @boardname@. This is called **completing a circuit**. It's like you're a big wire! ```sig diff --git a/docs/reference/input/on-pin-released.md b/docs/reference/input/on-pin-released.md index e06610c4..82bbd53b 100644 --- a/docs/reference/input/on-pin-released.md +++ b/docs/reference/input/on-pin-released.md @@ -4,12 +4,12 @@ Start an [event handler](/reference/event-handler) (part of the program that will run when something happens, like when a button is pressed). This handler works when you release pin `0`, `1`, or `2` together with `GND`. When you are using this function in a web -browser, click and release the pins on the screen instead of the ones on the BBC -micro:bit. +browser, click and release the pins on the screen instead of the ones on the +@boardname@. If you hold the `GND` pin with one hand and touch pin `0`, `1`, or `2` with the other, a very small (safe) amount of electricity will flow -through your body and back into the micro:bit. This is called +through your body and back into the @boardname@. This is called **completing a circuit**. It's like you're a big wire! ```sig diff --git a/docs/reference/input/pin-is-pressed.md b/docs/reference/input/pin-is-pressed.md index b659c9a5..f10e4537 100644 --- a/docs/reference/input/pin-is-pressed.md +++ b/docs/reference/input/pin-is-pressed.md @@ -4,7 +4,7 @@ Find whether the pin you say is pressed or not pressed. If you hold the `GND` pin with one hand and touch pin `0`, `1`, or `2` with the other, a very small (safe) amount of electricity will flow through your body and back into -the micro:bit. This is called **completing a circuit**. It's like you're a big wire! +the @boardname@. This is called **completing a circuit**. It's like you're a big wire! ```sig input.pinIsPressed(TouchPin.P0); diff --git a/docs/reference/input/rotation.md b/docs/reference/input/rotation.md index 2d98efbd..86d49c65 100644 --- a/docs/reference/input/rotation.md +++ b/docs/reference/input/rotation.md @@ -1,6 +1,6 @@ # Rotation -Find how much the micro:bit is tilted in different directions. +Find how much the @boardname@ is tilted in different directions. ```sig input.rotation(Rotation.Roll); @@ -9,7 +9,7 @@ input.rotation(Rotation.Roll); ## ~hint The @boardname@ has a part called the **accelerometer** that can -check how the micro:bit is moving. +check how the @boardname@ is moving. ## ~ @@ -21,13 +21,13 @@ check how the micro:bit is moving. * a [number](/reference/types/number) that means how much the microbit is tilted in the direction you say, from `0` to `360` degrees -### Example: micro:bit leveler +### Example: @boardname@ leveler This program helps you move the @boardname@ until it is level. When -it is level, the micro:bit shows a smiley. +it is level, the @boardname@ shows a smiley. If you are running this program in a browser, you can tilt the -micro:bit with your mouse. +@boardname@ with your mouse. ```blocks diff --git a/docs/reference/input/set-accelerometer-range.md b/docs/reference/input/set-accelerometer-range.md index b2c14748..f6310982 100644 --- a/docs/reference/input/set-accelerometer-range.md +++ b/docs/reference/input/set-accelerometer-range.md @@ -1,6 +1,6 @@ # Set Accelerometer Range -Set up the part of the micro:bit that measures +Set up the part of the @boardname@ that measures [acceleration](/reference/input/acceleration) (how much the microbit is speeding up or slowing down), in case you need to measure high or low acceleration. @@ -13,12 +13,12 @@ input.setAccelerometerRange(AcceleratorRange.OneG); * ``range`` means the biggest number of gravities of acceleration you will be measuring (either `1g`, `2g`, `4g`, or `8g`). Any bigger numbers - will be ignored by your micro:bit, both when you are picking a + will be ignored by your @boardname@, both when you are picking a number of gravities, and when you are measuring acceleration. ### Example -This program says the highest acceleration that your micro:bit +This program says the highest acceleration that your @boardname@ will measure is 4G. Then it measures acceleration from side to side until you stop the program. @@ -31,7 +31,7 @@ basic.forever(() => { #### ~hint -This program does not work in the simulator, only in a micro:bit. +This program does not work in the simulator, only in a @boardname@. #### ~ diff --git a/docs/reference/input/temperature.md b/docs/reference/input/temperature.md index d83ca741..75d7b2ec 100644 --- a/docs/reference/input/temperature.md +++ b/docs/reference/input/temperature.md @@ -1,7 +1,7 @@ # Temperature Find the temperature where you are. The temperature is measured in Celsius (metric). -The micro:bit can find the temperature nearby by checking how hot its computer chips are. +The @boardname@ can find the temperature nearby by checking how hot its computer chips are. ```sig input.temperature(); @@ -14,11 +14,11 @@ input.temperature(); ### How does it work? The @boardname@ checks how hot its CPU (main computer chip) is. -Because the micro:bit does not usually get very hot, the temperature of the CPU +Because the @boardname@ does not usually get very hot, the temperature of the CPU is usually close to the temperature of wherever you are. -The micro:bit might warm up a little if you make it work hard, though! +The @boardname@ might warm up a little if you make it work hard, though! -### Example: micro:bit thermometer +### Example: @boardname@ thermometer The following example uses `temperature` and `show number` to show the temperature of the room. @@ -45,9 +45,9 @@ basic.forever(() => { ### ~hint -Try comparing the temperature your micro:bit shows to a real thermometer in the same place. -You might be able to figure out how much to subtract from the number the micro:bit -shows to get the real temperature. Then you can change your program so the micro:bit is a +Try comparing the temperature your @boardname@ shows to a real thermometer in the same place. +You might be able to figure out how much to subtract from the number the @boardname@ +shows to get the real temperature. Then you can change your program so the @boardname@ is a better thermometer. ### ~ diff --git a/docs/reference/led/plot-bar-graph.md b/docs/reference/led/plot-bar-graph.md index 851f2fc8..934394ef 100644 --- a/docs/reference/led/plot-bar-graph.md +++ b/docs/reference/led/plot-bar-graph.md @@ -20,9 +20,9 @@ led.plotBarGraph(2, 20); ### Example: chart acceleration This program shows a bar graph of the [acceleration](/reference/input/acceleration) -in the `x` direction of the micro:bit. -The micro:bit's `x` direction is from left to right (or right to left). -The more you speed up moving the micro:bit in this direction, +in the `x` direction of the @boardname@. +The @boardname@'s `x` direction is from left to right (or right to left). +The more you speed up moving the @boardname@ in this direction, the taller the lines in the bar graph will be, until they are as tall as the parameter `high` says they can be. diff --git a/docs/reference/music/beat.md b/docs/reference/music/beat.md index 993fa7dd..5c62f689 100644 --- a/docs/reference/music/beat.md +++ b/docs/reference/music/beat.md @@ -4,7 +4,7 @@ Returns the duration of a beat in milli-seconds ## Simulator -This function only works on the micro:bit and in some browsers. +This function only works on the @boardname@ and in some browsers. ```sig music.beat(BeatFraction.Whole) diff --git a/docs/reference/music/change-tempo-by.md b/docs/reference/music/change-tempo-by.md index da6fecf7..8f66b4c7 100644 --- a/docs/reference/music/change-tempo-by.md +++ b/docs/reference/music/change-tempo-by.md @@ -5,7 +5,7 @@ faster or slower by the amount you say. ## Simulator -This function only works on the micro:bit and in some browsers. +This function only works on the @boardname@ and in some browsers. ```sig music.changeTempoBy(20) @@ -15,7 +15,7 @@ music.changeTempoBy(20) * ``bpm`` is a [number](/reference/types/number) that says how much to change the bpm (beats per minute, or number of beats in a minute of - the music that the micro:bit is playing). + the music that the @boardname@ is playing). ### Examples diff --git a/docs/reference/music/play-tone.md b/docs/reference/music/play-tone.md index 44d7fb37..39276e0b 100644 --- a/docs/reference/music/play-tone.md +++ b/docs/reference/music/play-tone.md @@ -1,10 +1,10 @@ # Play Tone -Play a musical tone through pin ``P0`` of the micro:bit for as long as you say. +Play a musical tone through pin ``P0`` of the @boardname@ for as long as you say. ## Simulator -This function only works on the micro:bit and in some browsers. +This function only works on the @boardname@ and in some browsers. ```sig music.playTone(440, 120) diff --git a/docs/reference/music/rest.md b/docs/reference/music/rest.md index 87db203a..10909ad4 100644 --- a/docs/reference/music/rest.md +++ b/docs/reference/music/rest.md @@ -4,7 +4,7 @@ Rest (play no sound) through pin `PO` for the amount of time you say. ## Simulator -This function only works on the micro:bit and in some browsers. +This function only works on the @boardname@ and in some browsers. ```sig music.rest(400) @@ -13,7 +13,7 @@ music.rest(400) ### Parameters * ``ms`` is a [number](/reference/types/number) saying how many - milliseconds the micro:bit should rest. One second is 1000 + milliseconds the @boardname@ should rest. One second is 1000 milliseconds. ## Example diff --git a/docs/reference/music/ring-tone.md b/docs/reference/music/ring-tone.md index a5cbbd0e..2da40aeb 100644 --- a/docs/reference/music/ring-tone.md +++ b/docs/reference/music/ring-tone.md @@ -5,7 +5,7 @@ The tone will keep playing until you tell it not to. ## Simulator -This function only works on the micro:bit and in some browsers. +This function only works on the @boardname@ and in some browsers. ```sig music.ringTone(440) @@ -20,9 +20,9 @@ or pitch. ### Example -This program checks the **accelerometer** for the micro:bit's -**acceleration** (how much the micro:bit is speeding up or slowing -down). Then it uses that acceleration to make a tone. If the micro:bit +This program checks the **accelerometer** for the @boardname@'s +**acceleration** (how much the @boardname@ is speeding up or slowing +down). Then it uses that acceleration to make a tone. If the @boardname@ speeds up, the tone's pitch gets higher, and if it slows down, the tone's pitch gets lower. It's fun -- try it! diff --git a/docs/reference/music/set-tempo.md b/docs/reference/music/set-tempo.md index 81dedd67..83f5c477 100644 --- a/docs/reference/music/set-tempo.md +++ b/docs/reference/music/set-tempo.md @@ -7,11 +7,11 @@ music.setTempo(60) ``` ## Simulator -This function only works on the micro:bit and in some browsers. +This function only works on the @boardname@ and in some browsers. ### Parameters -* ``bpm`` is a [number](/reference/types/number) that means the beats per minute you want (the number of beats in a minute of the music that the micro:bit is playing). +* ``bpm`` is a [number](/reference/types/number) that means the beats per minute you want (the number of beats in a minute of the music that the @boardname@ is playing). ### See also diff --git a/docs/reference/music/tempo.md b/docs/reference/music/tempo.md index eb5ac5f9..9fe81623 100644 --- a/docs/reference/music/tempo.md +++ b/docs/reference/music/tempo.md @@ -9,7 +9,7 @@ music.tempo() ### Returns * a [number](/reference/types/number) that means the beats per minute (number of - beats in a minute of the music that the micro:bit is playing). + beats in a minute of the music that the @boardname@ is playing). ### See also diff --git a/docs/reference/pins/analog-pitch.md b/docs/reference/pins/analog-pitch.md index ede05f69..603d5c29 100644 --- a/docs/reference/pins/analog-pitch.md +++ b/docs/reference/pins/analog-pitch.md @@ -27,5 +27,5 @@ pins.analogPitch(frequency1, duration) ### See also -[micro:bit pins](/device/pins), [analog set period](/reference/pins/analog-set-period), [analog set pitch pin](/reference/pins/analog-set-pitch-pin) +[@boardname@ pins](/device/pins), [analog set period](/reference/pins/analog-set-period), [analog set pitch pin](/reference/pins/analog-set-pitch-pin) diff --git a/docs/reference/pins/analog-read-pin.md b/docs/reference/pins/analog-read-pin.md index 35ded767..f8e1211f 100644 --- a/docs/reference/pins/analog-read-pin.md +++ b/docs/reference/pins/analog-read-pin.md @@ -28,13 +28,13 @@ basic.forever(() => { #### ~hint -If you are using **analog read pin** with another micro:bit running **analog write pin**, then things can get tricky. Remember that the micro:bit that runs **analog set pin** writes 0's and 1's at a very high frequency to achieve an average of the desired value. Sadly, if you try to read that average from another micro:bit, then the micro:bit will either read 0 or 1023. You could try to read a higher number of values (e.g. a million) in a loop, then computer then average. Alternatively, you can plug in a capacitor in-between the two micro:bits. +If you are using **analog read pin** with another @boardname@ running **analog write pin**, then things can get tricky. Remember that the @boardname@ that runs **analog set pin** writes 0's and 1's at a very high frequency to achieve an average of the desired value. Sadly, if you try to read that average from another @boardname@, then the @boardname@ will either read 0 or 1023. You could try to read a higher number of values (e.g. a million) in a loop, then computer then average. Alternatively, you can plug in a capacitor in-between the two @boardname@s. #### ~ ### See also -[micro:bit pins](/device/pins), +[@boardname@ pins](/device/pins), [on pin pressed](/reference/input/on-pin-pressed), [analog write pin](/reference/pins/analog-write-pin), [digital read pin](/reference/pins/digital-read-pin), diff --git a/docs/reference/pins/analog-set-period.md b/docs/reference/pins/analog-set-period.md index d4c7163e..0624c7a2 100644 --- a/docs/reference/pins/analog-set-period.md +++ b/docs/reference/pins/analog-set-period.md @@ -23,7 +23,7 @@ pins.analogSetPeriod(AnalogPin.P0, 20000) ### See also -[micro:bit pins](/device/pins), +[@boardname@ pins](/device/pins), [on pin pressed](/reference/input/on-pin-pressed), [analog read pin](/reference/pins/analog-read-pin), [analog write pin](/reference/pins/analog-write-pin), diff --git a/docs/reference/pins/analog-set-pitch-pin.md b/docs/reference/pins/analog-set-pitch-pin.md index 1e11e35e..0aeac3f9 100644 --- a/docs/reference/pins/analog-set-pitch-pin.md +++ b/docs/reference/pins/analog-set-pitch-pin.md @@ -26,5 +26,5 @@ pins.analogPitch(frequency, duration) ### See also -[micro:bit pins](/device/pins), [analog set period](/reference/pins/analog-set-period), [analog pitch](/reference/pins/analog-pitch) +[@boardname@ pins](/device/pins), [analog set period](/reference/pins/analog-set-period), [analog pitch](/reference/pins/analog-pitch) diff --git a/docs/reference/pins/analog-write-pin.md b/docs/reference/pins/analog-write-pin.md index c3b1245e..c7fdca9a 100644 --- a/docs/reference/pins/analog-write-pin.md +++ b/docs/reference/pins/analog-write-pin.md @@ -30,5 +30,5 @@ and their average is `256`. ### See also -[micro:bit pins](/device/pins), [on pin pressed](/reference/input/on-pin-pressed), [analog read pin](/reference/pins/analog-read-pin), [digital read pin](/reference/pins/digital-read-pin), [digital write pin](/reference/pins/digital-write-pin) +[@boardname@ pins](/device/pins), [on pin pressed](/reference/input/on-pin-pressed), [analog read pin](/reference/pins/analog-read-pin), [digital read pin](/reference/pins/digital-read-pin), [digital write pin](/reference/pins/digital-write-pin) diff --git a/docs/reference/pins/digital-read-pin.md b/docs/reference/pins/digital-read-pin.md index 21e7f33f..78acaad3 100644 --- a/docs/reference/pins/digital-read-pin.md +++ b/docs/reference/pins/digital-read-pin.md @@ -1,7 +1,7 @@ # Digital Read Pin Read a **digital** (`0` or `1`) signal from a [pin](/device/pins) on -the micro:bit board. +the @boardname@ board. ```sig pins.digitalReadPin(DigitalPin.P3) @@ -43,9 +43,9 @@ basic.forever(() => { ``` This program is a remote control for the score keeper program. If you -connect `P1` on the remote control micro:bit to `P0` on the score -keeper micro:bit, you can press button `B` on the remote to buzz and -make the score bigger on the other micro:bit. +connect `P1` on the remote control @boardname@ to `P0` on the score +keeper @boardname@, you can press button `B` on the remote to buzz and +make the score bigger on the other @boardname@. ```blocks input.onButtonPressed(Button.B, () => { @@ -56,13 +56,13 @@ input.onButtonPressed(Button.B, () => { ``` #### ~hint -Remember to connect `GND` on both micro:bits together! +Remember to connect `GND` on both @boardname@s together! #### ~ ### See also -[micro:bit pins](/device/pins), +[@boardname@ pins](/device/pins), [digital write pin](/reference/pins/digital-write-pin), [analog read pin](/reference/pins/analog-read-pin), [analog write pin](/reference/pins/analog-write-pin), diff --git a/docs/reference/pins/digital-write-pin.md b/docs/reference/pins/digital-write-pin.md index 4c521ade..5abe4a0b 100644 --- a/docs/reference/pins/digital-write-pin.md +++ b/docs/reference/pins/digital-write-pin.md @@ -1,7 +1,7 @@ # Digital Write Pin Write a **digital** (`0` or `1`) signal to a [pin](/device/pins) on -the micro:bit board. +the @boardname@ board. ```sig pins.digitalWritePin(DigitalPin.P1, 1) @@ -40,9 +40,9 @@ basic.forever(() => { ``` This program is a remote control for the score keeper program. If you -connect `P1` on the remote control micro:bit to `P0` on the score -keeper micro:bit, you can press button `B` on the remote. This program -will use ``digital write pin`` to make the other micro:bit buzz and +connect `P1` on the remote control @boardname@ to `P0` on the score +keeper @boardname@, you can press button `B` on the remote. This program +will use ``digital write pin`` to make the other @boardname@ buzz and make the score bigger. ```blocks @@ -55,7 +55,7 @@ input.onButtonPressed(Button.B, () => { ### See also -[micro:bit pins](/device/pins), +[@boardname@ pins](/device/pins), [digital read pin](/reference/pins/digital-read-pin), [analog read pin](/reference/pins/analog-read-pin), [analog write pin](/reference/pins/analog-write-pin), diff --git a/docs/reference/pins/on-pulsed.md b/docs/reference/pins/on-pulsed.md index 6e064eeb..42bdc52a 100644 --- a/docs/reference/pins/on-pulsed.md +++ b/docs/reference/pins/on-pulsed.md @@ -10,7 +10,7 @@ pins.onPulsed(DigitalPin.P0, PulseValue.High, () => { }); ### Parameters -* ``name``: The micro:bit hardware pin to configure (``P0`` through ``P20``) +* ``name``: The @boardname@ hardware pin to configure (``P0`` through ``P20``) * ``pulse``: Which state will cause the associated block to execute (**High** or **Low**) ### Example diff --git a/docs/reference/pins/pulse-in.md b/docs/reference/pins/pulse-in.md index 9d78dc78..3aa09fd2 100644 --- a/docs/reference/pins/pulse-in.md +++ b/docs/reference/pins/pulse-in.md @@ -1,7 +1,7 @@ # Pulse In Returns the duration of a pulse (high or low) from a [pin](/device/pins) on -the micro:bit board in microseconds. +the @boardname@ board in microseconds. ```sig pins.pulseIn(DigitalPin.P0, PulseValue.High) diff --git a/docs/reference/pins/set-pull.md b/docs/reference/pins/set-pull.md index 2b62c5e3..e8e22fc5 100644 --- a/docs/reference/pins/set-pull.md +++ b/docs/reference/pins/set-pull.md @@ -2,12 +2,12 @@ Configure the electrical pull of the specified pin. -Many micro:bit pins can be configured as _pull-ups_. For example, a +Many @boardname@ pins can be configured as _pull-ups_. For example, a pull-up can set a pin's voltage to high (3.3 volts, or `1` when calling [digital read pin](/reference/pins/digital-read-pin)). If one end of a button is connected to ``P0`` (set to high) and the other end is connected to ``GND`` (0 volts), then when you press the button, -``P0`` is driven to 0 volts, and the micro:bit software can detect a +``P0`` is driven to 0 volts, and the @boardname@ software can detect a button press. ```sig @@ -16,7 +16,7 @@ pins.setPull(DigitalPin.P9, PinPullMode.PullDown); ### Parameters -* ``name``: The micro:bit hardware pin to configure (``P0``-``P20``) +* ``name``: The @boardname@ hardware pin to configure (``P0``-``P20``) * ``pull``: The pull to which to set the pin (**down**, **up**, or **none**) ### Example diff --git a/docs/reference/radio/on-data-packet-received.md b/docs/reference/radio/on-data-packet-received.md index 52a90ca0..176e5591 100644 --- a/docs/reference/radio/on-data-packet-received.md +++ b/docs/reference/radio/on-data-packet-received.md @@ -1,6 +1,6 @@ # On Data Packet Received -Run part of a program when the micro:bit receives a +Run part of a program when the @boardname@ receives a [number](/reference/types/number) or [string](/reference/types/string) over ``radio``. @@ -19,15 +19,15 @@ To add or remove the parts of the packet from the block, try clicking the blue g * ``packet`` - the [packet](/reference/radio/packet) that was received by the radio. The packet has the following properties: * `receivedNumber` - The [number](/reference/types/number) that was sent in this packet or `0` if this packet did not contain a number. See [send number](/reference/radio/send-number) and [send value](/reference/radio/send-value) * `receivedString` - The [string](/reference/types/string) that was sent in this packet or the empty string if this packet did not contain a string. See [send string](/reference/radio/send-string) and [send value](/reference/radio/send-value) - * `time` - The system time of the micro:bit that sent this packet at the time the packet was sent. - * `serial` - The serial number of the micro:bit that sent this packet or `0` if the micro:bit did not include its serial number. + * `time` - The system time of the @boardname@ that sent this packet at the time the packet was sent. + * `serial` - The serial number of the @boardname@ that sent this packet or `0` if the @boardname@ did not include its serial number. * `signal` - How strong the radio signal is from `255` (weak) to `0` (strong). ### Example -This program keeps sending numbers that says how fast the micro:bit is +This program keeps sending numbers that says how fast the @boardname@ is slowing down or speeding up. It also receives numbers for the same -thing from nearby micro:bits. It shows these numbers as a +thing from nearby @boardname@s. It shows these numbers as a [bar graph](/reference/led/plot-bar-graph). ```blocks diff --git a/docs/reference/radio/on-data-received.md b/docs/reference/radio/on-data-received.md index 9d51b4c3..19a2fa4f 100644 --- a/docs/reference/radio/on-data-received.md +++ b/docs/reference/radio/on-data-received.md @@ -2,7 +2,7 @@ > Note: This API has been deprecated! Use [on data packet received](/reference/radio/on-data-packet-received) instead. -Run part of a program when the micro:bit receives a +Run part of a program when the @boardname@ receives a [number](/reference/types/number) or [string](/reference/types/string) over ``radio``. @@ -12,9 +12,9 @@ radio.onDataReceived(() => { }); ### Example -This program keeps sending numbers that says how fast the micro:bit is +This program keeps sending numbers that says how fast the @boardname@ is slowing down or speeding up. It also receives numbers for the same -thing from nearby micro:bits. It shows these numbers as a +thing from nearby @boardname@s. It shows these numbers as a [bar graph](/reference/led/plot-bar-graph). ```blocks diff --git a/docs/reference/radio/packet.md b/docs/reference/radio/packet.md index 02e298a7..d8dfc990 100644 --- a/docs/reference/radio/packet.md +++ b/docs/reference/radio/packet.md @@ -6,8 +6,8 @@ A packet that was received by the radio. * `receivedNumber` - The [number](/reference/types/number) that was sent in this packet or `0` if this packet did not contain a number. See [send number](/reference/radio/send-number) and [send value](/reference/radio/send-value) * `receivedString` - The [string](/reference/types/string) that was sent in this packet or the empty string if this packet did not contain a string. See [send string](/reference/radio/send-string) and [send value](/reference/radio/send-value) -* `time` - The system time of the micro:bit that sent this packet at the time the packet was sent. -* `serial` - The serial number of the micro:bit that sent this packet or `0` if the micro:bit did not include its serial number. +* `time` - The system time of the @boardname@ that sent this packet at the time the packet was sent. +* `serial` - The serial number of the @boardname@ that sent this packet or `0` if the @boardname@ did not include its serial number. * `signal` - How strong the radio signal is from `255` (weak) to `0` (strong). ### See also diff --git a/docs/reference/radio/receive-number.md b/docs/reference/radio/receive-number.md index 272c3849..d8ce45d3 100644 --- a/docs/reference/radio/receive-number.md +++ b/docs/reference/radio/receive-number.md @@ -2,7 +2,7 @@ > Note: This API has been deprecated! Use [on data packet received](/reference/radio/on-data-packet-received) instead. -Receives the next number sent by a micro:bit in the same ``radio`` group. +Receives the next number sent by a @boardname@ in the same ``radio`` group. ```sig radio.receiveNumber(); @@ -10,11 +10,11 @@ radio.receiveNumber(); ### Returns -* the first [number](/reference/types/number) that the micro:bit received. If it did not receive any numbers, this function will return `0`. +* the first [number](/reference/types/number) that the @boardname@ received. If it did not receive any numbers, this function will return `0`. ### Example: Simple number receiver -This example receives the number broadcasted another micro:bit and shows it +This example receives the number broadcasted another @boardname@ and shows it as a bar graph. ```blocks diff --git a/docs/reference/radio/receive-string.md b/docs/reference/radio/receive-string.md index 5338c239..e5bcf8f5 100644 --- a/docs/reference/radio/receive-string.md +++ b/docs/reference/radio/receive-string.md @@ -2,7 +2,7 @@ > Note: This API has been deprecated! Use [on data packet received](/reference/radio/on-data-packet-received) instead. -Find the next string sent by `radio` from another micro:bit. +Find the next string sent by `radio` from another @boardname@. ```sig radio.receiveString() @@ -15,7 +15,7 @@ radio.receiveString() ### Example: Simple receiver -Show the string sent by another micro:bit. +Show the string sent by another @boardname@. ```blocks radio.onDataReceived(() => { @@ -25,8 +25,8 @@ radio.onDataReceived(() => { ### Example: Two-way radio -If you load this program onto two or more micro:bits, you can send a code word from one of them to the others by pressing button `A`. -The other micro:bits will receive the code word and then show it. +If you load this program onto two or more @boardname@s, you can send a code word from one of them to the others by pressing button `A`. +The other @boardname@s will receive the code word and then show it. ```blocks input.onButtonPressed(Button.A, () => { diff --git a/docs/reference/radio/received-signal-strength.md b/docs/reference/radio/received-signal-strength.md index 07802c16..8475282c 100644 --- a/docs/reference/radio/received-signal-strength.md +++ b/docs/reference/radio/received-signal-strength.md @@ -5,7 +5,7 @@ Find how strong the ``radio`` signal is, from `255` to `0`. (`255` means a weak signal and `0` means a strong one.) -The micro:bit finds the signal strength by checking how strong it was +The @boardname@ finds the signal strength by checking how strong it was the last time it ran the [on data packet received](/reference/radio/on-data-packet-received) function. That means it needs to run **receive number** first. @@ -21,7 +21,7 @@ how strong the signal is. ### Simulator -This function only works on the micro:bit, not in browsers. +This function only works on the @boardname@, not in browsers. ### Example diff --git a/docs/reference/radio/send-number.md b/docs/reference/radio/send-number.md index 20538a66..5c655cf4 100644 --- a/docs/reference/radio/send-number.md +++ b/docs/reference/radio/send-number.md @@ -1,6 +1,6 @@ # Send Number -Broadcast a [number](/reference/types/number) to other micro:bits connected via ``radio``. +Broadcast a [number](/reference/types/number) to other @boardname@s connected via ``radio``. ```sig radio.sendNumber(0); @@ -13,8 +13,8 @@ radio.sendNumber(0); ### Example: Broadcasting acceleration -This example broadcasts the value of your micro:bit's ``acceleration`` -in the `x` direction (left and right) to other micro:bits. This kind +This example broadcasts the value of your @boardname@'s ``acceleration`` +in the `x` direction (left and right) to other @boardname@s. This kind of program might be useful in a model car or model rocket. ```blocks diff --git a/docs/reference/radio/send-string.md b/docs/reference/radio/send-string.md index c5ed3ffc..53aa08a4 100644 --- a/docs/reference/radio/send-string.md +++ b/docs/reference/radio/send-string.md @@ -1,6 +1,6 @@ # Send String -Sends a string to other micro:bits in the area connected by radio. The +Sends a string to other @boardname@s in the area connected by radio. The maximum string length is 19 characters. ```sig @@ -14,9 +14,9 @@ radio.sendString("Hello!") ### Example: Two-way radio -If you load this program onto two or more micro:bits, you can send a +If you load this program onto two or more @boardname@s, you can send a code word from one of them to the others by pressing button `A`. The -other micro:bits will receive the code word and then show it. +other @boardname@s will receive the code word and then show it. ```blocks input.onButtonPressed(Button.A, () => { diff --git a/docs/reference/radio/send-value.md b/docs/reference/radio/send-value.md index a239a267..5d991c93 100644 --- a/docs/reference/radio/send-value.md +++ b/docs/reference/radio/send-value.md @@ -1,6 +1,6 @@ # Send Value -Send a [string]() and [number]() together by ``radio`` to other micro:bits. +Send a [string]() and [number]() together by ``radio`` to other @boardname@s. The maximum [string]() length is 12 characters. ```sig @@ -14,9 +14,9 @@ radio.sendValue("name", 0); ### Example: Broadcasting acceleration -This program sends your micro:bit's **acceleration** (amount it is +This program sends your @boardname@'s **acceleration** (amount it is speeding up or slowing down) in the `x` direction (left and right) to -other micro:bits. This kind of program might be useful in a model car +other @boardname@s. This kind of program might be useful in a model car or model rocket. ```blocks diff --git a/docs/reference/radio/set-group.md b/docs/reference/radio/set-group.md index 77b9780a..02fd8c68 100644 --- a/docs/reference/radio/set-group.md +++ b/docs/reference/radio/set-group.md @@ -1,13 +1,13 @@ # Set Group Make a program have the group ID you tell it for sending and receiving -with ``radio``. A group is like a cable channel (a micro:bit can only +with ``radio``. A group is like a cable channel (a @boardname@ can only send or receive in one group at a time). A group ID is like the cable channel number. If you do not tell your program which group ID to use with this function, it will figure out its own group ID by itself. If you load -the very same program onto two different micro:bits, they will be able +the very same program onto two different @boardname@s, they will be able to talk to each other because they will have the same group ID. ```sig @@ -20,7 +20,7 @@ radio.setGroup(0); ### Simulator -This function only works on the micro:bit, not in browsers. +This function only works on the @boardname@, not in browsers. ### Example diff --git a/docs/reference/radio/set-transmit-power.md b/docs/reference/radio/set-transmit-power.md index c6abc20d..6f68a528 100644 --- a/docs/reference/radio/set-transmit-power.md +++ b/docs/reference/radio/set-transmit-power.md @@ -1,6 +1,6 @@ # Set Transmit Power -Make the ``radio`` signal of the micro:bit stronger or weaker. +Make the ``radio`` signal of the @boardname@ stronger or weaker. It can be as weak as `0` and as strong as `7`. The scientific name for the strength of the ``radio`` signal is @@ -14,8 +14,8 @@ radio.setTransmitPower(7); ### Range -If your micro:bit is sending with a strength of `7`, and you are in -an open area without many other computers around, the micro:bit signal +If your @boardname@ is sending with a strength of `7`, and you are in +an open area without many other computers around, the @boardname@ signal can reach as far as 70 meters (about 230 feet). ### Parameters @@ -25,7 +25,7 @@ means how strong the signal is. ### Simulator -This function only works on the micro:bit, not in browsers. +This function only works on the @boardname@, not in browsers. ### Example diff --git a/docs/reference/radio/write-received-packet-to-serial.md b/docs/reference/radio/write-received-packet-to-serial.md index 48a188dd..1290d1c9 100644 --- a/docs/reference/radio/write-received-packet-to-serial.md +++ b/docs/reference/radio/write-received-packet-to-serial.md @@ -19,7 +19,7 @@ The format for received data printed to serial is as follows: ### Examples When ```radio``` data is received (after pressing the ``A`` button on -the second micro:bit), this program sends temperature data to +the second @boardname@), this program sends temperature data to serial. ```blocks diff --git a/docs/reference/radio/write-value-to-serial.md b/docs/reference/radio/write-value-to-serial.md index 0d7c899a..051eb804 100644 --- a/docs/reference/radio/write-value-to-serial.md +++ b/docs/reference/radio/write-value-to-serial.md @@ -19,7 +19,7 @@ The format for received data printed to serial is as follows: ### Examples When ```radio``` data is received (after pressing the ``A`` button on -the second micro:bit), this program sends temperature data to +the second @boardname@), this program sends temperature data to serial. ```blocks diff --git a/docs/reference/serial/write-value.md b/docs/reference/serial/write-value.md index bdc60607..f19b706a 100644 --- a/docs/reference/serial/write-value.md +++ b/docs/reference/serial/write-value.md @@ -30,7 +30,7 @@ basic.forever(() => { #### ~hint The [send value](/reference/radio/send-value) function broadcasts -string/number pairs. You can use a second micro:bit to receive them, +string/number pairs. You can use a second @boardname@ to receive them, and then send them directly to the serial port with ``write value``. #### ~ diff --git a/docs/reference/types.md b/docs/reference/types.md index 44f83fc8..ab6fbcbf 100644 --- a/docs/reference/types.md +++ b/docs/reference/types.md @@ -6,6 +6,6 @@ The following built-in types are supported for the @boardname@: * **[String](/reference/types/string)**: a sequence of characters * **[Number](/reference/types/number)**: an integer number (32-bit signed) * **[Boolean](/blocks/logic/boolean)**: true or false -* **[Image](/reference/images/image)**: a collection of [micro:bit LED states](/device/screen) (on/off) +* **[Image](/reference/images/image)**: a collection of [@boardname@ LED states](/device/screen) (on/off) TypeScript allows you to create user-defined classes of data. diff --git a/docs/reference/types/string.md b/docs/reference/types/string.md index f2204d3c..a9d7ca9a 100644 --- a/docs/reference/types/string.md +++ b/docs/reference/types/string.md @@ -31,7 +31,7 @@ let salutation = "Hello"; ### The function `show string` Use [show string](/reference/basic/show-string) to display a string on the [LED screen](/device/screen). -If the string is multiple characters, the string scrolls right to left. The following example displays `Hello world!` on the micro:bit screen: +If the string is multiple characters, the string scrolls right to left. The following example displays `Hello world!` on the @boardname@ screen: ```block basic.showString("Hello world!"); diff --git a/docs/release-notes.md b/docs/release-notes.md deleted file mode 100644 index 45b74f07..00000000 --- a/docs/release-notes.md +++ /dev/null @@ -1,25 +0,0 @@ -# Release notes - -### @description Editor release notes - -```sim -basic.forever(() => { basic.showString("RELEASE NOTES"); }); -``` - -## August 2016 - -* The JavaScript editor is using Monaco -* New [package system](/packages) based on GitHub - -## June 2016 - -* It is now possible to stream data into the cloud (Azure) from the PXT editor. Simply click on the log view to get started. -* Documentation column pops up for large screen to avoid switching between docs and editor. - -## May 2016 - -We're happy to announce [m.pxt.io](https://m.pxt.io), an Blocks/JavaScript editor for the [BBC micro:bit](https://www.microbit.co.uk). -The editor is [open source](/open-source) on GitHub. Send us your PR! - -This release contains a Block/JavaScript editor, new simulator that supports multiple micro:bit instances, new documentation engine, -all the blocks from the Microsoft Block Editor in the BBC micro:bit web site. \ No newline at end of file diff --git a/docs/streaming.md b/docs/streaming.md index f2ce8334..208f25ea 100644 --- a/docs/streaming.md +++ b/docs/streaming.md @@ -1,15 +1,15 @@ # Streaming -This page describes how to stream data from the micro:bit to the editor or even to the cloud. +This page describes how to stream data from the @boardname@ to the editor or even to the cloud. ## Before starting... -Make sure you follow the instructions on [how to setup a serial connection](/device/serial) with the micro:bit. +Make sure you follow the instructions on [how to setup a serial connection](/device/serial) with the @boardname@. ## A typical scenario A common scenario is to chart some sensor data, such as the acceleration, and analyse it in the editor. -For example, run this code on your micro:bit. +For example, run this code on your @boardname@. ```blocks basic.forever(() => { @@ -17,7 +17,7 @@ basic.forever(() => { }); ``` -If your serial connection is working, you will start to see a chart representing that acceleration ``x`` value read from the micro:bit. +If your serial connection is working, you will start to see a chart representing that acceleration ``x`` value read from the @boardname@. Each time ``led.plotBarGraph`` is called, the value is also written to the serial output. The log view automatically detects that there is a data stream and displays a graph. diff --git a/docs/uploader.md b/docs/uploader.md index 7bf8d602..165ccb56 100644 --- a/docs/uploader.md +++ b/docs/uploader.md @@ -1,10 +1,10 @@ # Uploader -### @description A Windows application that automatically deploys .hex files to connected micro:bit boards +### @description A Windows application that automatically deploys .hex files to connected @boardname@ boards ### ~avatar avatar -The Uploader **automatically** deploys .hex files to all micro:bits connected to your computer. +The Uploader **automatically** deploys .hex files to all @boardname@s connected to your computer. ## [DOWNLOAD](https://www.pxt.io/microbit-uploader.zip) @@ -28,7 +28,7 @@ That's it! * Windows XP or later * .NET runtime 2.0 or higher -* Browser: this application will work for any web browser that is supported by the BBC micro:bit +* Browser: this application will work for any web browser that is supported by the @boardname@ ![](/static/uploader/screenshot.png) @@ -40,6 +40,6 @@ That's it! * Download the [Microsoft.Uploader.Microbit.zip](https://pxt.microbit.org/microbit-uploader.zip) file to your local computer. * Unzip the .zip file to your desktop. -* Launch the Microsoft.Uploader.exe file before working on your BBC micro:bit. +* Launch the Microsoft.Uploader.exe file before working on your @boardname@. ### ~ diff --git a/olddocs/js/compiler.md b/olddocs/js/compiler.md index 88c0e519..1df3cb3a 100644 --- a/olddocs/js/compiler.md +++ b/olddocs/js/compiler.md @@ -16,7 +16,7 @@ The compilation from a script to ARM machine code is now done entirely in the br ![](/static/mb/offline-2.png) -The C++ compiler now only is used to compile the micro:bit runtime - this is done offline by the micro:bit team and the precompiled runtime linked with your compiled script in the browser. +The C++ compiler now only is used to compile the @boardname@ runtime - this is done offline by the @boardname@ team and the precompiled runtime linked with your compiled script in the browser. ## Save and load code using files diff --git a/olddocs/js/contents.md b/olddocs/js/contents.md index e1137e08..f26cd013 100644 --- a/olddocs/js/contents.md +++ b/olddocs/js/contents.md @@ -1,6 +1,6 @@ -# micro:bit/JavaScript Documentation +# @boardname@/JavaScript Documentation -JavaScript docs for the micro:bit +JavaScript docs for the @boardname@ ### @section full @@ -194,7 +194,7 @@ Functions in this category require to be connected to a remote device. ## Debugging -* use the [serial library](/js/serial-library) to print data from your micro:bit on your computer +* use the [serial library](/js/serial-library) to print data from your @boardname@ on your computer * learn about the [device error codes](/device/errors) that are displayed when sad faces occur ## Edit/Publish diff --git a/olddocs/js/guides/basic-led-show.md b/olddocs/js/guides/basic-led-show.md index 9bc0df68..e6267462 100644 --- a/olddocs/js/guides/basic-led-show.md +++ b/olddocs/js/guides/basic-led-show.md @@ -2,7 +2,7 @@ ### Challenge 0 -You have successfully following the [guided tutorial] (https://live.microbit.co.uk/td/tutorials/blink). If not, we should make sure the micro:bit script displays a blinking script on screen. We want to plot the x and y coordinates to 2, 2. Additionally, you will pause by 100 milliseconds then you will clear the screen of the micro:bit. Let's give it a go! +You have successfully following the [guided tutorial] (https://live.microbit.co.uk/td/tutorials/blink). If not, we should make sure the @boardname@ script displays a blinking script on screen. We want to plot the x and y coordinates to 2, 2. Additionally, you will pause by 100 milliseconds then you will clear the screen of the @boardname@. Let's give it a go! ``` while (true) { diff --git a/olddocs/js/guides/blink-symbols.md b/olddocs/js/guides/blink-symbols.md index fe10db26..8d3b3bd1 100644 --- a/olddocs/js/guides/blink-symbols.md +++ b/olddocs/js/guides/blink-symbols.md @@ -2,7 +2,7 @@ ### Challenge 0 -You have successfully following the [blink tutorial](/hcwxud). If not, then let's start the tutorial now. Your micro:bit script should start by displaying a blinking script on screen. We want to plot the x and y coordinates to 2, 2. Additionally, you will pause by 100 milliseconds then clear the screen of the micro:bit. +You have successfully following the [blink tutorial](/hcwxud). If not, then let's start the tutorial now. Your @boardname@ script should start by displaying a blinking script on screen. We want to plot the x and y coordinates to 2, 2. Additionally, you will pause by 100 milliseconds then clear the screen of the @boardname@. Let's give it a go! diff --git a/olddocs/js/guides/scroll-image-docs.md b/olddocs/js/guides/scroll-image-docs.md index 025211cc..a5fd3616 100644 --- a/olddocs/js/guides/scroll-image-docs.md +++ b/olddocs/js/guides/scroll-image-docs.md @@ -4,7 +4,7 @@ My script. #docs **Challenge 0** -This [guided tutorial](/xuhkviyyxa) introduces how to make an image look like it's scrolling across the micro:bit! +This [guided tutorial](/xuhkviyyxa) introduces how to make an image look like it's scrolling across the @boardname@! We can use an animation to make an image look like its moving! diff --git a/olddocs/js/guides/touchdevelop-lessons.md b/olddocs/js/guides/touchdevelop-lessons.md index 1791e350..e3bba877 100644 --- a/olddocs/js/guides/touchdevelop-lessons.md +++ b/olddocs/js/guides/touchdevelop-lessons.md @@ -1,6 +1,6 @@ # TouchDevelop Lessons -Overview of TouchDevelop lessons for the micro:bit. +Overview of TouchDevelop lessons for the @boardname@. ### @section full @@ -15,7 +15,7 @@ Overview of TouchDevelop lessons for the micro:bit. * [point](/reference/led/point) * [set brightness](/tfrmcgdtxk) -## micro:bit +## @boardname@ ## functions @@ -88,7 +88,7 @@ Overview of TouchDevelop lessons for the micro:bit. * [markdown](/js/markdown) * [creating interactive tutorials](/js/creatinginteractivetutorials) * [run scripts in a web browser](/js/simulator) -* [run scripts on your micro:bit](/usb) +* [run scripts on your @boardname@](/usb) * [libraries](/js/libraries) ### Functions and libraries diff --git a/olddocs/js/image.md b/olddocs/js/image.md index 13d5d2b7..4d877104 100644 --- a/olddocs/js/image.md +++ b/olddocs/js/image.md @@ -1,6 +1,6 @@ # Image -An image for the micro:bit screen. +An image for the @boardname@ screen. ### @parent js/language diff --git a/olddocs/js/lessons/accelerometer/challenges.md b/olddocs/js/lessons/accelerometer/challenges.md index a086f18f..bb231f60 100644 --- a/olddocs/js/lessons/accelerometer/challenges.md +++ b/olddocs/js/lessons/accelerometer/challenges.md @@ -4,7 +4,7 @@ The acceleration function. **Challenge 0** -Great job! You have successfully completed the [zoomer tutorial](https://test.microbit.co.uk/td/lessons/zoomer/challenges) . You have created a script that measures the acceleration on the micro:bit in the "z" direction of a 3D world. +Great job! You have successfully completed the [zoomer tutorial](https://test.microbit.co.uk/td/lessons/zoomer/challenges) . You have created a script that measures the acceleration on the @boardname@ in the "z" direction of a 3D world. ``` basic.forever(() => { @@ -49,7 +49,7 @@ basic.forever(() => { ### Challenge 3 -If Button `B` is pressed, program the micro:bit to display the acceleration in the "y" direction. +If Button `B` is pressed, program the @boardname@ to display the acceleration in the "y" direction. You can do this by storing the acceleration in a variable: `var milliY := input->acceleration("y")`. diff --git a/olddocs/js/lessons/boxer-mania/challenges.md b/olddocs/js/lessons/boxer-mania/challenges.md index 0ff1748f..c17bf7f1 100644 --- a/olddocs/js/lessons/boxer-mania/challenges.md +++ b/olddocs/js/lessons/boxer-mania/challenges.md @@ -8,7 +8,7 @@ This [guided tutorial](/lessons/boxer-mania/tutorial) will help you create an an Let's create and show a series of frames on the LED screen; this is an animation! -We will use multiple frames to make it look like a square is rotating on the micro:bit screen! +We will use multiple frames to make it look like a square is rotating on the @boardname@ screen! ``` basic.showAnimation(` diff --git a/olddocs/js/lessons/compare-machine/challenges.md b/olddocs/js/lessons/compare-machine/challenges.md index 5de2802a..70155fb0 100644 --- a/olddocs/js/lessons/compare-machine/challenges.md +++ b/olddocs/js/lessons/compare-machine/challenges.md @@ -19,7 +19,7 @@ input.onButtonPressed(Button.A, () => { ### Challenge 1 -Now let's do something special when the micro:bit reaches the number `5`. Instead of just showing the number `5`, let's show the string `HALF WAY!`. Begin by setting an if statement to know when `counter = 5`. +Now let's do something special when the @boardname@ reaches the number `5`. Instead of just showing the number `5`, let's show the string `HALF WAY!`. Begin by setting an if statement to know when `counter = 5`. ``` counter = 0 @@ -56,7 +56,7 @@ input.onButtonPressed(Button.A, () => { ### Challenge 3 -You may notice a problem right now. When `counter = 5`, the micro:bit will show both the message `HALF WAY!` and the number `5`. In order to fix this problem, let's take advantage of the `else` at the end of the if statement. +You may notice a problem right now. When `counter = 5`, the @boardname@ will show both the message `HALF WAY!` and the number `5`. In order to fix this problem, let's take advantage of the `else` at the end of the if statement. ``` counter = 0 @@ -75,5 +75,5 @@ input.onButtonPressed(Button.A, () => { ### Challenge 4 -When `counter = 8`, display the message `ALMOST THERE!` on the micro:bit. You will need to add an `else if` after the if statement of `counter = 5`. +When `counter = 8`, display the message `ALMOST THERE!` on the @boardname@. You will need to add an `else if` after the if statement of `counter = 5`. diff --git a/olddocs/js/lessons/digital-pet.md b/olddocs/js/lessons/digital-pet.md index 81056623..6a618386 100644 --- a/olddocs/js/lessons/digital-pet.md +++ b/olddocs/js/lessons/digital-pet.md @@ -67,10 +67,10 @@ Learn how to create **functions**, `function()` that perform a specific task and * learn how to set or change the value of a global variable * learn how to repeat code in the background forever * learn how to get the state of an input button -* learn how to show a number on the micro:bit's LED screen -* learn how to show a string on the micro:bit's LED screen -* learn how to create an image to show on the micro:bit's LED screen -* learn how to show an image on the micro:bit's LED screen +* learn how to show a number on the @boardname@'s LED screen +* learn how to show a string on the @boardname@'s LED screen +* learn how to create an image to show on the @boardname@'s LED screen +* learn how to show an image on the @boardname@'s LED screen * learn how to pause your code for the specified number of milliseconds ## Links to the National Curriculum Programmes of Study for Computing diff --git a/olddocs/js/lessons/landslide.md b/olddocs/js/lessons/landslide.md index 76fbfc75..bf071d87 100644 --- a/olddocs/js/lessons/landslide.md +++ b/olddocs/js/lessons/landslide.md @@ -2,7 +2,7 @@ Turn a LED on and off. #docs -Detect and show an image when the micro:bit falls. +Detect and show an image when the @boardname@ falls. * [tutorial](/lessons/landslide/tutorial) * [challenges](/lessons/landslide/challenges) diff --git a/olddocs/js/lessons/landslide/challenges.md b/olddocs/js/lessons/landslide/challenges.md index 5fcc1a04..a6faf1b2 100644 --- a/olddocs/js/lessons/landslide/challenges.md +++ b/olddocs/js/lessons/landslide/challenges.md @@ -73,5 +73,5 @@ input.onFall(() => { ### Challenge 3 -Now let's display a third image when the micro:bit falls! First, add `basic->pause(2000)` followed by another image of your choice. Be creative! +Now let's display a third image when the @boardname@ falls! First, add `basic->pause(2000)` followed by another image of your choice. Be creative! diff --git a/olddocs/js/lessons/line-of-fire.md b/olddocs/js/lessons/line-of-fire.md index 2eaa6eaa..374478f8 100644 --- a/olddocs/js/lessons/line-of-fire.md +++ b/olddocs/js/lessons/line-of-fire.md @@ -48,7 +48,7 @@ Learn how to create **functions**, `function()` that perform a specific task and * learn how to repeat code in the background forever * learn how to conditionally run code depending on whether a condition is true or not * learn how to run code when an input button is pressed -* learn how to show a string on the micro:bit's LED screen +* learn how to show a string on the @boardname@'s LED screen * learn how to turn on a LED light on the LED screen. Learn how to specify which LED using x, y coordinates * learn how to turn off a LED light on the LED screen. Learn how to specify which LED using x, y coordinates * learn how to pause your code for the specified number of milliseconds diff --git a/olddocs/js/lessons/logo-pointer/challenges.md b/olddocs/js/lessons/logo-pointer/challenges.md index 2c3040dc..88885494 100644 --- a/olddocs/js/lessons/logo-pointer/challenges.md +++ b/olddocs/js/lessons/logo-pointer/challenges.md @@ -67,5 +67,5 @@ input.onLogoDown(() => { **Challenge 3** -Let's show a spinning arrow when the micro:bit is shaken. We can do this by adding an on shake condition and showing an animation of the arrow spinning! +Let's show a spinning arrow when the @boardname@ is shaken. We can do this by adding an on shake condition and showing an animation of the arrow spinning! diff --git a/olddocs/js/lessons/meteorite.md b/olddocs/js/lessons/meteorite.md index 25afbc7b..41d66616 100644 --- a/olddocs/js/lessons/meteorite.md +++ b/olddocs/js/lessons/meteorite.md @@ -52,8 +52,8 @@ Learn how to create **functions**, `function()` that perform a specific task and * learn how to gradually increase the LED screen brightness until the LED lights are turned on * learn how to conditionally run code depending on whether a condition is true or not * learn how to run code when an input button is pressed -* learn how to show a number on the micro:bit's LED screen -* learn how to show a string on the micro:bit's LED screen +* learn how to show a number on the @boardname@'s LED screen +* learn how to show a string on the @boardname@'s LED screen * learn how to turn on a LED light on the LED screen. Learn how to specify which LED using x, y coordinates * learn how to turn on all the 25 LEDs on the LED screen * learn how to pause your code for the specified number of milliseconds diff --git a/olddocs/js/lessons/number-psych/quiz-answers.md b/olddocs/js/lessons/number-psych/quiz-answers.md index da323bae..eb676a55 100644 --- a/olddocs/js/lessons/number-psych/quiz-answers.md +++ b/olddocs/js/lessons/number-psych/quiz-answers.md @@ -121,7 +121,7 @@ for (let i4 = 0; i4 < 4; i4++) { **Questions 10-14 are concerned with 'number pysch controller tutorial'** -## 10. Write the code that asks for a player number if button 'A' is pressed on the BBC controller micro:bit. +## 10. Write the code that asks for a player number if button 'A' is pressed on the BBC controller @boardname@.
@@ -162,7 +162,7 @@ input.onButtonPressed(Button.B, () => { }) ``` -## 13. Create a while loop that first reads which controller the console micro:bit is requesting data from. Plot a waiting image, and then write an IF statement to check if the request corresponds to the controller. (Don't worry about writing anything inside the if statement). +## 13. Create a while loop that first reads which controller the console @boardname@ is requesting data from. Plot a waiting image, and then write an IF statement to check if the request corresponds to the controller. (Don't worry about writing anything inside the if statement).
diff --git a/olddocs/js/lessons/number-psych/quiz.md b/olddocs/js/lessons/number-psych/quiz.md index 64020c2f..4bf034be 100644 --- a/olddocs/js/lessons/number-psych/quiz.md +++ b/olddocs/js/lessons/number-psych/quiz.md @@ -80,7 +80,7 @@ Answer the questions while completing the tutorial. Pay attention to the dialogu **Questions 10-14 are concerned with 'number pysch controller tutorial'** -## 10. Write the code that asks for a player number if button 'A' is pressed on the BBC controller micro:bit. +## 10. Write the code that asks for a player number if button 'A' is pressed on the BBC controller @boardname@.
@@ -100,7 +100,7 @@ Answer the questions while completing the tutorial. Pay attention to the dialogu
-## 13. Create a while loop that first reads which controller the console micro:bit is requesting data from. Plot a waiting image, and then write an IF statement to check if the request corresponds to the controller. (Don't worry about writing anything inside the if statement). +## 13. Create a while loop that first reads which controller the console @boardname@ is requesting data from. Plot a waiting image, and then write an IF statement to check if the request corresponds to the controller. (Don't worry about writing anything inside the if statement).
diff --git a/olddocs/js/lessons/on-fall/challenges.md b/olddocs/js/lessons/on-fall/challenges.md index 7dc8115b..ea67fb72 100644 --- a/olddocs/js/lessons/on-fall/challenges.md +++ b/olddocs/js/lessons/on-fall/challenges.md @@ -4,7 +4,7 @@ The on fall function. ### Challenge 0 -Welcome! This [guided tutorial](https://live.microbit.co.uk/td/lessons/on-fall/tutorial) will show you how to detect when the micro:bit is falling. Your goal is to write a program that detects when the micro:bit falls! +Welcome! This [guided tutorial](https://live.microbit.co.uk/td/lessons/on-fall/tutorial) will show you how to detect when the @boardname@ is falling. Your goal is to write a program that detects when the @boardname@ falls! ``` input.onFall(() => { @@ -61,7 +61,7 @@ input.onFall(() => { ### Challenge 3 -Create a loop so that the micro:bit alternates between the exclamation point and "X" images when the micro:bit falls. You will need a `forever` loop and a pause at the end of the loop to do this. +Create a loop so that the @boardname@ alternates between the exclamation point and "X" images when the @boardname@ falls. You will need a `forever` loop and a pause at the end of the loop to do this. ## See Also diff --git a/olddocs/js/lessons/on-shake/challenges.md b/olddocs/js/lessons/on-shake/challenges.md index 868f510f..3a31b227 100644 --- a/olddocs/js/lessons/on-shake/challenges.md +++ b/olddocs/js/lessons/on-shake/challenges.md @@ -1,6 +1,6 @@ # flipping bird challenges -These challenges will allow you to create and display a flipping image of a bird when the micro:bit is shaken. #docs +These challenges will allow you to create and display a flipping image of a bird when the @boardname@ is shaken. #docs ### Challenge 0 diff --git a/olddocs/js/lessons/pong.md b/olddocs/js/lessons/pong.md index 95aec4c9..c201d36e 100644 --- a/olddocs/js/lessons/pong.md +++ b/olddocs/js/lessons/pong.md @@ -1,6 +1,6 @@ # pong lesson -code your own game of Pong on the micro:bit. #. +code your own game of Pong on the @boardname@. #. ## Topic @@ -71,7 +71,7 @@ Learn how to create **functions**, `function()` that perform a specific task and * learn how to repeat code in the background forever * learn how to conditionally run code depending on whether a condition is true or not * learn how to run code when an input button is pressed -* learn how to show a string on the micro:bit's LED screen +* learn how to show a string on the @boardname@'s LED screen * learn how to turn on a LED light on the LED screen. Learn how to specify which LED using x, y coordinates * learn how to turn off a LED light on the LED screen. Learn how to specify which LED using x, y coordinates * learn how to pause your code for the specified number of milliseconds diff --git a/olddocs/js/lessons/rock-paper-scissors-book-version/challenges.md b/olddocs/js/lessons/rock-paper-scissors-book-version/challenges.md index ae498951..209bc049 100644 --- a/olddocs/js/lessons/rock-paper-scissors-book-version/challenges.md +++ b/olddocs/js/lessons/rock-paper-scissors-book-version/challenges.md @@ -8,7 +8,7 @@ Welcome! This guide will show you how to complete the challenges for the game of ### Step 16 -Awesome! You have just created your game of rock paper scissors. However, why don't we add a little more to it? We can keep track of your score against the micro:bit using global variables. Create a global variable to keep track of the wins against the micro:bit. To do so, click on `add new`, then `Data`, and then `Number`. +Awesome! You have just created your game of rock paper scissors. However, why don't we add a little more to it? We can keep track of your score against the @boardname@ using global variables. Create a global variable to keep track of the wins against the @boardname@. To do so, click on `add new`, then `Data`, and then `Number`. ``` var wins: number = 0 @@ -16,7 +16,7 @@ var wins: number = 0 ### Step 17 -At the beginning of the game, you don't have any wins against the micro:bit. As a result, let's set the `data->wins` variable to 0 at the top of your main function. +At the beginning of the game, you don't have any wins against the @boardname@. As a result, let's set the `data->wins` variable to 0 at the top of your main function. ``` wins = 0 // *** @@ -78,7 +78,7 @@ input.onButtonPressed(Button.A, () => { ### Step 20 -You have tracked the number of wins you have against the micro:bit. However, how will you ever know how many wins you have? After we increment `data->wins`, let's display the total number of wins you have. +You have tracked the number of wins you have against the @boardname@. However, how will you ever know how many wins you have? After we increment `data->wins`, let's display the total number of wins you have. ``` wins = 0 @@ -100,13 +100,13 @@ input.onButtonPressed(Button.A, () => { }) ``` -* Tap `run` to run the program on the simulator. Notice the number of wins you have against the micro:bit. +* Tap `run` to run the program on the simulator. Notice the number of wins you have against the @boardname@. ## Challenge 2 ### Step 21 -You have managed to keep score of the number of wins you have against the micro:bit. However, what about losses? Let's begin by creating another global variable to keep track of losses. +You have managed to keep score of the number of wins you have against the @boardname@. However, what about losses? Let's begin by creating another global variable to keep track of losses. ``` var losses: number = 0 @@ -114,7 +114,7 @@ var losses: number = 0 ### Step 22 -Add a condition for when button `B` is pressed. When this occurs, we will increment your losses against the micro:bit by 1. Let's hope that this button will not be pressed too often! +Add a condition for when button `B` is pressed. When this occurs, we will increment your losses against the @boardname@ by 1. Let's hope that this button will not be pressed too often! ``` wins = 0 @@ -167,7 +167,7 @@ input.onButtonPressed(Button.B, () => { ### Step 24 -Let's also display the score when button `B` is pressed, just as we have done for button `A`. This will help us keep track of the number of wins and losses you have against the micro:bit. +Let's also display the score when button `B` is pressed, just as we have done for button `A`. This will help us keep track of the number of wins and losses you have against the @boardname@. ``` wins = 0 @@ -198,7 +198,7 @@ input.onButtonPressed(Button.B, () => { ### Step 25 -You have managed to keep track of both the wins and losses you have against the micro:bit! But did you notice that you haven't updated something? Take a look at condition of `input->on button pressed("A")`. +You have managed to keep track of both the wins and losses you have against the @boardname@! But did you notice that you haven't updated something? Take a look at condition of `input->on button pressed("A")`. ``` wins = 0 @@ -229,7 +229,7 @@ input.onButtonPressed(Button.B, () => { }) ``` -* Tap the `run` button to run your game on the simulator. See if you can get more wins than the micro:bit can! +* Tap the `run` button to run your game on the simulator. See if you can get more wins than the @boardname@ can! -Congratulations! You have successfully created a fully functional game of rock, paper, scissors against the micro:bit. Challenge your friends to see who can get a better score against the micro:bit. +Congratulations! You have successfully created a fully functional game of rock, paper, scissors against the @boardname@. Challenge your friends to see who can get a better score against the @boardname@. diff --git a/olddocs/js/lessons/rock-paper-scissors-teacher-guide/challenges.md b/olddocs/js/lessons/rock-paper-scissors-teacher-guide/challenges.md index b50ad920..1b23ef56 100644 --- a/olddocs/js/lessons/rock-paper-scissors-teacher-guide/challenges.md +++ b/olddocs/js/lessons/rock-paper-scissors-teacher-guide/challenges.md @@ -8,7 +8,7 @@ Welcome! This guide will show you how to complete the challenges for the game of ### Step 16 -Awesome! You have just created your game of rock paper scissors. However, why don't we add a little more to it? We can keep track of your score against the micro:bit using global variables. Create a global variable to keep track of the wins against the micro:bit. To do so, click on `add new`, then `Data`, and then `Number`. +Awesome! You have just created your game of rock paper scissors. However, why don't we add a little more to it? We can keep track of your score against the @boardname@ using global variables. Create a global variable to keep track of the wins against the @boardname@. To do so, click on `add new`, then `Data`, and then `Number`. ``` var wins: number = 0 @@ -16,7 +16,7 @@ var wins: number = 0 ### Step 17 -At the beginning of the game, you don't have any wins against the micro:bit. As a result, let's set the `data->wins` variable to 0 at the top of your main function. +At the beginning of the game, you don't have any wins against the @boardname@. As a result, let's set the `data->wins` variable to 0 at the top of your main function. ``` wins = 0 // *** @@ -78,7 +78,7 @@ input.onButtonPressed(Button.A, () => { ### Step 20 -You have tracked the number of wins you have against the micro:bit. However, how will you ever know how many wins you have? After we increment `data->wins`, let's display the total number of wins you have. +You have tracked the number of wins you have against the @boardname@. However, how will you ever know how many wins you have? After we increment `data->wins`, let's display the total number of wins you have. ``` wins = 0 @@ -100,13 +100,13 @@ input.onButtonPressed(Button.A, () => { }) ``` -* Tap `run` to run the program on the simulator. Notice the number of wins you have against the micro:bit. +* Tap `run` to run the program on the simulator. Notice the number of wins you have against the @boardname@. ## Challenge 2 ### Step 21 -You have managed to keep score of the number of wins you have against the micro:bit. However, what about losses? Let's begin by creating another global variable to keep track of losses. +You have managed to keep score of the number of wins you have against the @boardname@. However, what about losses? Let's begin by creating another global variable to keep track of losses. ``` var losses: number = 0 @@ -114,7 +114,7 @@ var losses: number = 0 ### Step 22 -Add a condition for when button `B` is pressed. When this occurs, we will increment your losses against the micro:bit by 1. Let's hope that this button will not be pressed too often! +Add a condition for when button `B` is pressed. When this occurs, we will increment your losses against the @boardname@ by 1. Let's hope that this button will not be pressed too often! ``` wins = 0 @@ -167,7 +167,7 @@ input.onButtonPressed(Button.B, () => { ### Step 24 -Let's also display the score when button `B` is pressed, just as we have done for button `A`. This will help us keep track of the number of wins and losses you have against the micro:bit. +Let's also display the score when button `B` is pressed, just as we have done for button `A`. This will help us keep track of the number of wins and losses you have against the @boardname@. ``` wins = 0 @@ -198,7 +198,7 @@ input.onButtonPressed(Button.B, () => { ### Step 25 -You have managed to keep track of both the wins and losses you have against the micro:bit! But did you notice that you haven't updated something? Take a look at condition of `input->on button pressed("A")`. +You have managed to keep track of both the wins and losses you have against the @boardname@! But did you notice that you haven't updated something? Take a look at condition of `input->on button pressed("A")`. ``` wins = 0 @@ -229,7 +229,7 @@ input.onButtonPressed(Button.B, () => { }) ``` -* Tap the `run` button to run your game on the simulator. See if you can get more wins than the micro:bit can! +* Tap the `run` button to run your game on the simulator. See if you can get more wins than the @boardname@ can! -Congratulations! You have successfully created a fully functional game of rock, paper, scissors against the micro:bit. Challenge your friends to see who can get a better score against the micro:bit. +Congratulations! You have successfully created a fully functional game of rock, paper, scissors against the @boardname@. Challenge your friends to see who can get a better score against the @boardname@. diff --git a/olddocs/js/lessons/running-time/challenges.md b/olddocs/js/lessons/running-time/challenges.md index c02573d2..62fb8280 100644 --- a/olddocs/js/lessons/running-time/challenges.md +++ b/olddocs/js/lessons/running-time/challenges.md @@ -4,7 +4,7 @@ My script. #docs **Challenge 0** -Great job! You have successfully completed the [Running Time tutorial](/lessons/running-time/tutorial) . You have a forever loop that declares a variable in it that holds the running time in milliseconds of the micro:bit and then shows the seconds on the LED screen. +Great job! You have successfully completed the [Running Time tutorial](/lessons/running-time/tutorial) . You have a forever loop that declares a variable in it that holds the running time in milliseconds of the @boardname@ and then shows the seconds on the LED screen. ``` basic.forever(() => { diff --git a/olddocs/js/lessons/screen-up-and-down/challenges.md b/olddocs/js/lessons/screen-up-and-down/challenges.md index c609be63..06ac19bf 100644 --- a/olddocs/js/lessons/screen-up-and-down/challenges.md +++ b/olddocs/js/lessons/screen-up-and-down/challenges.md @@ -20,7 +20,7 @@ input.onScreenUp(() => { **Challenge 1** -Now have the Micro:bit do something when the screen is moved downward. You can do this by calling the on screen down method. Do not do anything when you call the on screen down method. +Now have the @boardname@ do something when the screen is moved downward. You can do this by calling the on screen down method. Do not do anything when you call the on screen down method. ``` input.onScreenUp(() => { @@ -39,7 +39,7 @@ input.onScreenDown(() => { **Challenge 2** -When the Micro:bit is moved downward, create and show an image of an upside down heart. +When the @boardname@ is moved downward, create and show an image of an upside down heart. ``` input.onScreenUp(() => { diff --git a/olddocs/js/lessons/set-brightness/challenges.md b/olddocs/js/lessons/set-brightness/challenges.md index 3f8597a8..ac8af701 100644 --- a/olddocs/js/lessons/set-brightness/challenges.md +++ b/olddocs/js/lessons/set-brightness/challenges.md @@ -1,10 +1,10 @@ # set brightness challenges -These challenges will allow you to change the brightness of the micro:bit. docs +These challenges will allow you to change the brightness of the @boardname@. docs **Challenge 0** -[This tutorial](/lessons/set-brightness/tutorial) will show you how to set the brightness on the micro:bit. +[This tutorial](/lessons/set-brightness/tutorial) will show you how to set the brightness on the @boardname@. ``` led.setBrightness(255) diff --git a/olddocs/js/lessons/show-string/challenges.md b/olddocs/js/lessons/show-string/challenges.md index f278b9b2..3ebb8c80 100644 --- a/olddocs/js/lessons/show-string/challenges.md +++ b/olddocs/js/lessons/show-string/challenges.md @@ -4,7 +4,7 @@ My script. #docs **Challenge 0** -Welcome! This [guided tutorial](/pxjkww) introduces the basic show string method on the micro:bit. +Welcome! This [guided tutorial](/pxjkww) introduces the basic show string method on the @boardname@. Let's show the string 'Hello' on the LED screen. The string will scroll one character at a time from left to right. diff --git a/olddocs/js/lessons/typing-game/challenges.md b/olddocs/js/lessons/typing-game/challenges.md index 1f4417c1..2ac981b5 100644 --- a/olddocs/js/lessons/typing-game/challenges.md +++ b/olddocs/js/lessons/typing-game/challenges.md @@ -76,5 +76,5 @@ input.onGesture(Gesture.Shake, () => { **Challenge 3** -Give Micro a nickname and display it on the micro:bit! +Give Micro a nickname and display it on the @boardname@! diff --git a/olddocs/js/lessons/while-counting/challenges.md b/olddocs/js/lessons/while-counting/challenges.md index 92652f43..95a5eb17 100644 --- a/olddocs/js/lessons/while-counting/challenges.md +++ b/olddocs/js/lessons/while-counting/challenges.md @@ -51,7 +51,7 @@ while (count > 0) { **Challenge 3** -Now, we need `count` to decrease by one after the micro:bit has displayed the value of `count`. +Now, we need `count` to decrease by one after the @boardname@ has displayed the value of `count`. We can do this by adding this line: diff --git a/olddocs/js/lessons/yes-no/challenges.md b/olddocs/js/lessons/yes-no/challenges.md index 9da5dd37..2fdf5c17 100644 --- a/olddocs/js/lessons/yes-no/challenges.md +++ b/olddocs/js/lessons/yes-no/challenges.md @@ -4,7 +4,7 @@ My script. #docs **Challenge 0** -This [guided tutorial](/lessons/yes-no/challenges) will show you how to display text on the micro:bit! +This [guided tutorial](/lessons/yes-no/challenges) will show you how to display text on the @boardname@! ``` basic.showString("ASK ME A QUESTION", 150) diff --git a/olddocs/js/libraries.md b/olddocs/js/libraries.md index ba493214..2e402224 100644 --- a/olddocs/js/libraries.md +++ b/olddocs/js/libraries.md @@ -25,7 +25,7 @@ To add a library to a script: Once you've added a library to your script, you can use any of the library's non-private [functions](/js/function). Here's how: -* on the [Code Keyboard](/js/editor) click the button with the library's name (for example, `micro:bit` and `micro:bit game` are library buttons). The functions in the library have a button on the Code Keyboard. +* on the [Code Keyboard](/js/editor) click the button with the library's name (for example, `@boardname@` and `@boardname@ game` are library buttons). The functions in the library have a button on the Code Keyboard. ### Create a library diff --git a/olddocs/js/micro-bit-api.md b/olddocs/js/micro-bit-api.md index a193f93c..e4cec462 100644 --- a/olddocs/js/micro-bit-api.md +++ b/olddocs/js/micro-bit-api.md @@ -1,6 +1,6 @@ -# micro:bit +# @boardname@ -The micro:bit device api. #microbit +The @boardname@ device api. #microbit Initialize the library. diff --git a/olddocs/js/object-disclaimer.md b/olddocs/js/object-disclaimer.md index 7f7c8b3e..7fa13223 100644 --- a/olddocs/js/object-disclaimer.md +++ b/olddocs/js/object-disclaimer.md @@ -1,6 +1,6 @@ # Objects disclaimer -Touch Develop docs for the micro:bit. +Touch Develop docs for the @boardname@. ### Memory management on the micro-bit diff --git a/olddocs/js/object-types.md b/olddocs/js/object-types.md index 4d39f247..d63ed65b 100644 --- a/olddocs/js/object-types.md +++ b/olddocs/js/object-types.md @@ -1,6 +1,6 @@ # Custom object types -Touch Develop docs for the micro:bit. +Touch Develop docs for the @boardname@. ### What is an object? diff --git a/olddocs/js/orientation.md b/olddocs/js/orientation.md index b7e4760b..24d3f796 100644 --- a/olddocs/js/orientation.md +++ b/olddocs/js/orientation.md @@ -1,4 +1,4 @@ -# micro:bit orientation +# @boardname@ orientation A #microbit library that exposes accelerometer events. diff --git a/olddocs/js/quick-start.md b/olddocs/js/quick-start.md index f0ec5434..34c279cb 100644 --- a/olddocs/js/quick-start.md +++ b/olddocs/js/quick-start.md @@ -28,7 +28,7 @@ The currently available on-line resources from the Quick Start Guide are the ### How does my program get onto the @boardname@? -For your program to work on the @boardname@, first it has to be compiled. Compiling means to translate a program into a more efficient computer language. When you hit the compile button on the Microsoft Touch Develop Editor interface, your program is compiled into a hex file that contains the machine code in the instruction set used by the ARM processor that is on your @boardname@. Compiling to ARM machine code actually happens in the web browser, where the code from script is joined with the machine code of the micro:bit runtime. +For your program to work on the @boardname@, first it has to be compiled. Compiling means to translate a program into a more efficient computer language. When you hit the compile button on the Microsoft Touch Develop Editor interface, your program is compiled into a hex file that contains the machine code in the instruction set used by the ARM processor that is on your @boardname@. Compiling to ARM machine code actually happens in the web browser, where the code from script is joined with the machine code of the @boardname@ runtime. ![](/static/mb/quick-start-0.png) diff --git a/olddocs/js/reactive.md b/olddocs/js/reactive.md index 00fcfdbc..a92f01af 100644 --- a/olddocs/js/reactive.md +++ b/olddocs/js/reactive.md @@ -88,7 +88,7 @@ queues a `forever` loop for later execution by the scheduler; the body of this l The function ends after the execution of these three statements, but this is not the end of program execution! That’s because the function queued the `forever` loop for execution by the scheduler. -The second job of the scheduler is to periodically interrupt execution to read (poll) the various inputs to the micro:bit (the buttons, pins, etc.) and fire off events (such as “button A pressed”). Recall that the firing of an event causes the event handler subprogram associated with that event to be queued for later execution. The scheduler uses a timer built into the micro:bit hardware to interrupt execution every 6 milliseconds and poll the inputs, which is more than fast enough to catch the quickest press of a button. +The second job of the scheduler is to periodically interrupt execution to read (poll) the various inputs to the @boardname@ (the buttons, pins, etc.) and fire off events (such as “button A pressed”). Recall that the firing of an event causes the event handler subprogram associated with that event to be queued for later execution. The scheduler uses a timer built into the @boardname@ hardware to interrupt execution every 6 milliseconds and poll the inputs, which is more than fast enough to catch the quickest press of a button. ### Cooperative passing of control @@ -104,7 +104,7 @@ Let’s take a look at the implementation of the `forever` statement to see an e ![](/static/mb/device/reactive-2.png) -The `forever` loop actually is a function that takes a subprogram (an *Action* in Touch Develop) as a parameter. The function uses the `control -> in background` function of the micro:bit runtime to queue a `while true` loop for execution by the scheduler. The while loop has two statements. The first statement runs the subprogram represented by the `body` parameter. The second statement passes control to the scheduler (requesting to “sleep” for 20 milliseconds). +The `forever` loop actually is a function that takes a subprogram (an *Action* in Touch Develop) as a parameter. The function uses the `control -> in background` function of the @boardname@ runtime to queue a `while true` loop for execution by the scheduler. The while loop has two statements. The first statement runs the subprogram represented by the `body` parameter. The second statement passes control to the scheduler (requesting to “sleep” for 20 milliseconds). Though the `while true` loop will repeatedly execute the body subprogram, between each execution of the body it will permit the scheduler to execute other subprograms. If the while loop did not contain the call to `pause`, then once control passed into the while loop, it would never pass back to the scheduler and no other subprogram would be able to execute (unless the body subprogram contained a call to `pause` itself). @@ -130,7 +130,7 @@ While "Show 0" (the blue sequence) is running, periodic interrupts by the schedu Through this example, we have seen that the @boardname@ scheduler enables you to create a program that is composed of concurrent subprograms. In essence, the programmer needs to only think about the concurrent subprograms cooperatively passing control back to the scheduler, making sure no subprogram hogs control (or “dribbles the ball without passing”) for too long. While a subprogram runs, the scheduler polls the buttons and other IO peripherals at a high frequency in order to fire off events and queue event handlers for later execution, but this is invisible to the programmer. -As a result, you can easily add a new capability to the micro:bit by just adding a new subprogram. For example, if you want to add a reset feature to the counter program, all you need to do is add a new event handler for a press of button B that sets the global variable "count" to zero, as shown below: +As a result, you can easily add a new capability to the @boardname@ by just adding a new subprogram. For example, if you want to add a reset feature to the counter program, all you need to do is add a new event handler for a press of button B that sets the global variable "count" to zero, as shown below: ``` export function countButtonPressesWithReset() { diff --git a/olddocs/js/senses.md b/olddocs/js/senses.md index c266d4ca..b716ef95 100644 --- a/olddocs/js/senses.md +++ b/olddocs/js/senses.md @@ -1,4 +1,4 @@ -# micro:bit senses +# @boardname@ senses A #microbit library that exposes orientation and movement events. diff --git a/olddocs/js/serial-library.md b/olddocs/js/serial-library.md index 7280ab88..9b2789e0 100644 --- a/olddocs/js/serial-library.md +++ b/olddocs/js/serial-library.md @@ -2,7 +2,7 @@ The serial library #docs -The **serial library** supports [serial communication](https://en.wikipedia.org/wiki/Serial_port) between the @boardname@ and another computer. Basically, this allows you to send data from the micro:bit to your own computer. This is very useful for debugging purposes: you can add `write line` statements in your code and see them display on your computer as the program executes. +The **serial library** supports [serial communication](https://en.wikipedia.org/wiki/Serial_port) between the @boardname@ and another computer. Basically, this allows you to send data from the @boardname@ to your own computer. This is very useful for debugging purposes: you can add `write line` statements in your code and see them display on your computer as the program executes. The code below shows a simple script that sends a line when the @boardname@ starts and another line each time the button ``A`` is pressed. @@ -13,18 +13,18 @@ input.onButtonPressed(Button.A, () => { }) ``` -## How to read the micro:bit's serial output from your computer +## How to read the @boardname@'s serial output from your computer Unfortunately, using the serial library requires quite a bit of a setup. ### Windows -You must install a device driver (for the computer to recognize the serial interface of the micro:bit); then, you must also install a terminal emulator (which is going to connect to the micro:bit and read its output). Here's how to do it: +You must install a device driver (for the computer to recognize the serial interface of the @boardname@); then, you must also install a terminal emulator (which is going to connect to the @boardname@ and read its output). Here's how to do it: * Follow instructions at https://developer.mbed.org/handbook/Windows-serial-configuration in order to install the device driver * Install a terminal emulator; we recommend [Tera Term](https://ttssh2.osdn.jp/index.html.en). At the time of this writing, the latest version is 4.88 and can be downloaded [from here](http://en.osdn.jp/frs/redir.php?m=jaist&f=%2Fttssh2%2F63767%2Fteraterm-4.88.exe). Follow the instructions from the installer. -Once both the driver and the terminal emulator are installed, plug in the micro:bit and wait until the device is fully setup. Then, open TeraTerm. +Once both the driver and the terminal emulator are installed, plug in the @boardname@ and wait until the device is fully setup. Then, open TeraTerm. * Hit `File` > `New Connection` * Check "Serial"; in the dropdown menu, pick the COM port that says "mbed Serial Port". Hit `Ok`. @@ -32,7 +32,7 @@ Once both the driver and the terminal emulator are installed, plug in the micro: You should be good. Feel free to hit `Setup` > `Save Setup` in the menus to erase the default configuration file with a new one so that you don't have to type in the settings again. -Please note that Windows will assign you a different COM port if you plug in another micro:bit. If you're juggling between micro:bits, you'll have to change the COM port every time. +Please note that Windows will assign you a different COM port if you plug in another @boardname@. If you're juggling between @boardname@s, you'll have to change the COM port every time. ### Alternative Windows setup with Putty @@ -51,27 +51,27 @@ If you prefer another terminal emulator (such as [PuTTY](http://www.putty.org/)) (Untested). -* Plug in the micro:bit +* Plug in the @boardname@ * Open a terminal -* `dmesg | tail` will show you which `/dev/` node the micro:bit was assigned (e.g. `/dev/ttyUSB0`) +* `dmesg | tail` will show you which `/dev/` node the @boardname@ was assigned (e.g. `/dev/ttyUSB0`) * Then, do: `screen /dev/ttyUSB0 115200` (install the `screen` program if you don't have it). To exit, run `Ctrl-A` `Ctrl-D`. Alternative programs include minicom, etc. ### Mac OS -* Plug in the micro:bit +* Plug in the @boardname@ * Open a terminal * `ls /dev/cu.*` will return to you a list of serial devices; one of them will look like `/dev/cu.usbmodem1422` (the exact number depends on your computer) -* `screen /dev/cu.usbmodem1422 115200` will open up the micro:bit's serial output. To exit, hit `Ctrl-A` `Ctrl-D`. +* `screen /dev/cu.usbmodem1422 115200` will open up the @boardname@'s serial output. To exit, hit `Ctrl-A` `Ctrl-D`. ## Using the serial library in your programs -If the ``serial`` button is not available, you will need first to add the ``micro:bit serial`` library to your script: +If the ``serial`` button is not available, you will need first to add the ``@boardname@ serial`` library to your script: * tap on `add new` * tap on `library` -* select `micro:bit serial` +* select `@boardname@ serial` ### Writing data @@ -95,7 +95,7 @@ serial.writeString("hello") serial.writeLine("this is a line") ``` -Theoretically, you can dump more sophisticated data and then read it back in the event that two micro:bits should be connected to each other over serial. We have not tested this scenario yet as we have yet to expose functionality that allows re-routing the serial ports to the edge connector. +Theoretically, you can dump more sophisticated data and then read it back in the event that two @boardname@s should be connected to each other over serial. We have not tested this scenario yet as we have yet to expose functionality that allows re-routing the serial ports to the edge connector. * write an image diff --git a/olddocs/js/simulator.md b/olddocs/js/simulator.md index d35401fb..995e063c 100644 --- a/olddocs/js/simulator.md +++ b/olddocs/js/simulator.md @@ -23,7 +23,7 @@ The @boardname@ simulator supports the Touch Develop [functions](/js/contents) a * **LED screen**: the [LED screen](/device/screen) that appears on-screen shows you what you'll see on the @boardname@ device * **input buttons**: when running code with [button is pressed](/reference/input/button-is-pressed) or [on button pressed](/reference/input/on-button-pressed) functions, click the on-screen A or B button * **compass**: when running code that includes [compass heading](/reference/input/compass-heading), click and drag the on-screen compass needle to change the heading -* **accelerometer**: move your mouse over the on-screen micro:bit device to simulate [acceleration](/reference/input/acceleration). The x and y axis values are shown on-screen. +* **accelerometer**: move your mouse over the on-screen @boardname@ device to simulate [acceleration](/reference/input/acceleration). The x and y axis values are shown on-screen. * **digital pins**: you can click the on-screen digital pins (0 , 1, or 2) to turn them on or off (see [digital write pin](/reference/pins/digital-write-pin) and [digital read pin](/reference/pins/digital-read-pin) for more info). **Can't see the red LEDs on the simulator?** @@ -32,13 +32,13 @@ If you click on the white THEME button in the top right corner of the simulator, ### All done? -Once you're done writing and testing your code on the simulator, compile and run your script on your @boardname@ device. To find out how to do this, see [run scripts on the micro:bit](/device/usb). +Once you're done writing and testing your code on the simulator, compile and run your script on your @boardname@ device. To find out how to do this, see [run scripts on the @boardname@](/device/usb). -### Simulator vs micro:bit +### Simulator vs @boardname@ Running your scripts in a web browser is a *simulation* of how your code will run on the @boardname@ device. When you run your script on your @boardname@ device, the results may differ slightly. For example, the timing may be subtly different when your script runs on the @boardname@ device (you may need to adjust your [pause](/reference/basic/pause) functions). For this reason, be sure to test your scripts on the @boardname@ device. ### See also -[run scripts on the micro:bit](/device/usb), [Microsoft Block editor](/blocks/editor), [Touch Develop editor](/js/editor) +[run scripts on the @boardname@](/device/usb), [Microsoft Block editor](/blocks/editor), [Touch Develop editor](/js/editor) diff --git a/olddocs/js/statements.md b/olddocs/js/statements.md index dd861544..0c7019c5 100644 --- a/olddocs/js/statements.md +++ b/olddocs/js/statements.md @@ -32,7 +32,7 @@ TouchDevelop operators include: Libraries provide additional functions: -* the [micro:bit library](/js/contents) +* the [@boardname@ library](/js/contents) * the [math](/js/math) and [bits](/js/bits) libraries ### see also diff --git a/olddocs/js/string.md b/olddocs/js/string.md index 1e7230bc..109c077a 100644 --- a/olddocs/js/string.md +++ b/olddocs/js/string.md @@ -34,7 +34,7 @@ let salutation = "Hello" ### The function `show string` -Use [show string](/reference/basic/show-string) to display a string on the [LED screen](/device/screen). If the string is multiple characters, the string scrolls right to left. The following example displays `Hello world!` on the micro:bit screen: +Use [show string](/reference/basic/show-string) to display a string on the [LED screen](/device/screen). If the string is multiple characters, the string scrolls right to left. The following example displays `Hello world!` on the @boardname@ screen: ``` basic.showString("Hello world!", 100) diff --git a/olddocs/js/types.md b/olddocs/js/types.md index e9eee5b8..29adebda 100644 --- a/olddocs/js/types.md +++ b/olddocs/js/types.md @@ -10,7 +10,7 @@ A *type* refers to a class of data and the operations permitted on that data. Th * **[String](/reference/types/string)**: a sequence of characters * **[Number](/reference/types/number)**: an integer number (32-bit signed) * **[Boolean](/reference/types/boolean)**: true or false -* **[Image](/reference/image/image)**: a collection of [micro:bit LED states](/device/screen) (on/off) +* **[Image](/reference/image/image)**: a collection of [@boardname@ LED states](/device/screen) (on/off) * *more types coming!!!* ### see also