diff --git a/docs/reference.md b/docs/reference.md index a0e54c43..f8008e57 100644 --- a/docs/reference.md +++ b/docs/reference.md @@ -1,113 +1,25 @@ # Reference +## micro:bit + +```namespaces +basic.showString("Hello!"); +input.onButtonPressed(Button.A, () => {}); +led.plot(0,0); +radio.sendNumber(0); +music.playTone(music.noteFrequency(Note.C), music.beat(BeatFraction.Whole)); +game.createSprite(); +pins.digitalReadPin(DigitalPin.P0); +serial.WriteLine("Hello!") +control.inBackground(() => {}); +``` + +## Language + ### @section full ### ~column -### Basic - -[show number](/microbit/reference/basic/show-number) - -~~~~block -basic.showNumber(2) -~~~~ - -[show string](/microbit/reference/basic/show-string) - -~~~~block -basic.showString('Hello!') -~~~~ - -[show LEDs](/microbit/reference/basic/show-leds) - -~~~~block -basic.showLeds(`. . . . . -. # . # . -. . . . . -# . . . # -. # # # .`) -~~~~ - -[clear screen](/microbit/reference/basic/clear-screen) - -~~~~block -basic.clearScreen() -~~~~ - -[forever](/microbit/reference/basic/forever) - -~~~~block -basic.forever(() => { }) -~~~~ - -[pause](/microbit/reference/basic/pause) - -```block -basic.pause(200) -``` - -### Input - -[on button pressed](/microbit/reference/input/on-button-pressed) - -```block -input.onButtonPressed(Button.A, () => {}) -``` - -[on pin pressed](/microbit/reference/input/on-pin-pressed) - -```block -input.onPinPressed(TouchPin.P0, () => {}) -``` - -[on shake](/microbit/reference/input/on-shake) - -![](/static/mb/blocks/contents-22.jpg) - -[on logo up](/microbit/reference/on-logo-up) - -![](/static/mb/on-logo-up-0.jpg) - -[on logo down](/microbit/reference/on-logo-down) - -![](/static/mb/on-logo-down-0.jpg) - -[on screen up](/microbit/reference/on-screen-up) - -![](/static/mb/on-screen-up-0.jpg) - -[on screen down](/microbit/reference/on-screen-down) - -![](/static/mb/on-screen-down-0.jpg) - -[button is pressed](/microbit/reference/button-is-pressed) - -![](/static/mb/button-is-pressed-0.png) - -[compass heading](/microbit/reference/compass-heading) - -![](/static/mb/compass-heading-0.png) - -[temperature](/microbit/reference/temperature) - -![](/static/mb/temperature-0.png) - -[acceleration](/microbit/reference/input/acceleration) - -![](/static/mb/acceleration-0.png) - -[rotation](/microbit/reference/rotation) - -![](/static/mb/rotation-0.png) - -[magnetic force](/microbit/reference/magnetic-force) - -![](/static/mb/magnetic-force-0.png) - -[running time](/microbit/reference/running-time) - -![](/static/mb/running-time-0.png) - ### Loops [for](/microbit/reference/loops/for) @@ -132,8 +44,6 @@ while(true) {} basic.forever(() => {}) ``` - - ### ~ ### ~column @@ -199,6 +109,10 @@ x; let x = 0; x+=1; ``` +### ~ + +### ~column + ### Math @@ -237,224 +151,8 @@ Random value ```block Math.random(5); ``` - -### LED - -[plot](/microbit/reference/led/plot) - -```block -led.plot(2,2) -``` - -[unplot](/microbit/reference/led/unplot) - -```block -led.unplot(2,2) -``` - -[point](/microbit/reference/point) - -```block -led.point(2,2) -``` - -[brightness](/microbit/reference/brightness) - -```block -led.brightness() -``` - -[set brightness](/microbit/reference/set-brightness) - -```block -led.setBrightness(255) -``` - -[stop animation](/microbit/reference/stop-animation) - -```block -led.stopAnimation() -``` - -[plot bar graph](/microbit/reference/led/plot-bar-graph) - -```block -led.plotBarGraph(0, 1023) -``` - -### Game - -[create sprite](/microbit/reference/game/create-sprite) - -![](/static/mb/create-sprite-0.png) - -[move](/microbit/reference/game/move) - -![](/static/mb/game-library/move-0.png) - -[turn](/microbit/reference/game/turn) - -![](/static/mb/game-library/turn-0.png) - -[change](/microbit/reference/game/change) - -![](/static/mb/change-0.png) - -[set](/microbit/reference/game/set) - -![](/static/mb/blocks/contents-21.png) - -[reports](/microbit/reference/reports) - -![](/static/mb/game-library/position-0.png) - -[touching](/microbit/reference/touching) - -![](/static/mb/game-library/touching-0.png) - -[touching edge](/microbit/reference/touching-edge) - -![](/static/mb/game-library/touching-edge-0.png) - -[if on edge, bounce](/microbit/reference/logic/if-on-edge-bounce) - -![](/static/mb/game-library/if-on-edge-bounce-0.png) - -[change score by](/microbit/reference/change-score-by) - -![](/static/mb/game-library/pic1.png) - -[score](/microbit/reference/score) - -![](/static/mb/game-library/pic2.png) - -[start countdown](/microbit/reference/start-countdown) - -![](/static/mb/game-library/pic3.png) - -[game over](/microbit/reference/game-over) - -![](/static/mb/game-library/pic0.png) - -### Music - -[play tone](/microbit/reference/play-tone) - -![](/static/mb/play-tone-0.jpg) - -[ring tone](/microbit/reference/ring-tone) - -![](/static/mb/ring-tone-0.jpg) - -[rest](/microbit/reference/rest) - -![](/static/mb/rest-0.jpg) - -[tempo](/microbit/reference/tempo) - -![](/static/mb/tempo-0.jpg) - -[set tempo](/microbit/reference/set-tempo) - -![](/static/mb/change-tempo-0.jpg) - -[change tempo](/microbit/reference/music/set-tempo) - -![](/static/mb/change-tempo-by-0.jpg) - ### Comments [comment](/microbit/reference/comment) -### Images - -[show image](/microbit/reference/show-image) - -![](/static/mb/show-image-0.png) - -[scroll image](/microbit/reference/scroll-image) - -![](/static/mb/scroll-image-0.png) - -[create image](/microbit/reference/create-image) - -![](/static/mb/create-image-0.png) - - ### ~ - -### ~column - -### Pins - -[digital read pin](/microbit/reference/pins/digital-read-pin) - -![](/static/mb/digital-read-pin-0.png) - -[digital write pin](/microbit/reference/pins/digital-write-pin) - -![](/static/mb/digital-write-pin-0.png) - -[analog read pin](/microbit/reference/pins/analog-read-pin) - -![](/static/mb/analog-read-pin-0.png) - -[analog write pin](/microbit/reference/pins/analog-write-pin) - -![](/static/mb/blocks/contents-23.png) - -[analog set period](/microbit/reference/pins/analog-set-period) - -![](/static/mb/analog-set-period-0.png) - -[servo write pin](/microbit/reference/pins/servo-write-pin) - -![](/static/mb/servo-write-pin-0.png) - -[servo set pulse](/microbit/reference/pins/servo-set-pulse) - -![](/static/mb/servo-set-pulse-0.png) - -[map](/microbit/reference/map) - -![](/static/mb/map-0.png) - - -## Devices - -Functions in this category require to be connected to a remote device. - -[tell camera to](/microbit/reference/devices/tell-camera-to) - -![](/static/mb/tell-camera-to-0.png) - -[tell remote control to](/microbit/reference/devices/tell-remote-control-to) - -![](/static/mb/tell-remote-control-to-0.png) - -[raise alert to](/microbit/reference/devices/raise-alert-to) - -![](/static/mb/raise-alert-to-0.png) - -[on notified](/microbit/reference/on-notified) - -![](/static/mb/on-notified-0.png) - -[on gamepad button](/microbit/reference/on-gamepad-button) - -![](/static/mb/on-gamepad-button-0.png) - -[on notified](/microbit/reference/on-notified) - -![](/static/mb/on-notified-0.png) - -[signal strength](/microbit/reference/signal-strength) - -![](/static/mb/blocks/contents-24.png) - -[on signal strength changed](/microbit/reference/on-signal-strength-changed) - -![](/static/mb/blocks/contents-25.png) - -### ~ - diff --git a/docs/reference/basic.md b/docs/reference/basic.md new file mode 100644 index 00000000..461e1a63 --- /dev/null +++ b/docs/reference/basic.md @@ -0,0 +1,35 @@ +# Basic + +Provides access to basic micro:bit functionality. + + +```cards +basic.showNumber(0); +basic.showLeds(` +. . . . . +. . . . . +. . # . . +. . . . . +. . . . . +`); +basic.showString("Hello!"); +basic.clearScreen(); +basic.forever(() => { + +}); +basic.pause(100); +basic.plotLeds(` +. . . . . +. . . . . +. . # . . +. . . . . +. . . . . +`); +basic.showAnimation(` +. . . . . +. . . . . +. . # . . +. . . . . +. . . . . +`); +``` diff --git a/docs/reference/control.md b/docs/reference/control.md new file mode 100644 index 00000000..652d1224 --- /dev/null +++ b/docs/reference/control.md @@ -0,0 +1,11 @@ +# Control + + + + +```cards +control.inBackground(() => { + +}); +control.reset(); +``` diff --git a/docs/reference/game.md b/docs/reference/game.md new file mode 100644 index 00000000..eaf9ddc2 --- /dev/null +++ b/docs/reference/game.md @@ -0,0 +1,12 @@ +# Game + + + + +```cards +game.addScore(1); +game.score(); +game.startCountdown(10000); +game.gameOver(); +game.setScore(0); +``` diff --git a/docs/reference/images.md b/docs/reference/images.md new file mode 100644 index 00000000..d6f91ab2 --- /dev/null +++ b/docs/reference/images.md @@ -0,0 +1,21 @@ +# Images + + + + +```cards +images.createImage(` +. . . . . +. . . . . +. . # . . +. . . . . +. . . . . +`); +images.createBigImage(` +. . . . . +. . . . . +. . # . . +. . . . . +. . . . . +`); +``` diff --git a/docs/reference/input.md b/docs/reference/input.md new file mode 100644 index 00000000..189056d9 --- /dev/null +++ b/docs/reference/input.md @@ -0,0 +1,42 @@ +# Input + + + + +```cards +input.onButtonPressed(.Button, () => { + +}); +input.onGesture(.Gesture, () => { + +}); +input.onPinPressed(.TouchPin, () => { + +}); +input.buttonIsPressed(.Button); +input.compassHeading(); +input.temperature(); +input.acceleration(.Dimension); +input.lightLevel(); +input.rotation(.Rotation); +input.magneticForce(.Dimension); +input.runningTime(); +input.setAccelerometerRange(.AcceleratorRange); +input.pinIsPressed(.TouchPin); +input.calibrate(); +input.onLogoDown(() => { + +}); +input.onLogoUp(() => { + +}); +input.onScreenDown(() => { + +}); +input.onScreenUp(() => { + +}); +input.onShake(() => { + +}); +``` diff --git a/docs/reference/led.md b/docs/reference/led.md new file mode 100644 index 00000000..48ba445a --- /dev/null +++ b/docs/reference/led.md @@ -0,0 +1,21 @@ +# Led + + + + +```cards +led.plot(0, 0); +led.unplot(0, 0); +led.point(0, 0); +led.brightness(); +led.setBrightness(255); +led.stopAnimation(); +led.plotBarGraph(0, 1023); +led.fadeIn(); +led.fadeOut(); +led.plotAll(); +led.screenshot(); +led.toggle(0, 0); +led.toggleAll(); +led.setDisplayMode(.DisplayMode); +``` diff --git a/docs/reference/music.md b/docs/reference/music.md new file mode 100644 index 00000000..37c322c4 --- /dev/null +++ b/docs/reference/music.md @@ -0,0 +1,15 @@ +# Music + + + + +```cards +music.playTone(0, 0); +music.ringTone(0); +music.rest(0); +music.noteFrequency(.Note); +music.beat(); +music.tempo(); +music.changeTempoBy(20); +music.setTempo(120); +``` diff --git a/docs/reference/pins.md b/docs/reference/pins.md new file mode 100644 index 00000000..62e64160 --- /dev/null +++ b/docs/reference/pins.md @@ -0,0 +1,17 @@ +# Pins + + + + +```cards +pins.digitalReadPin(.DigitalPin); +pins.digitalWritePin(.DigitalPin, 0); +pins.analogReadPin(.AnalogPin); +pins.analogWritePin(.AnalogPin, 1023); +pins.analogSetPeriod(.AnalogPin, 20000); +pins.servoWritePin(.AnalogPin, 180); +pins.servoSetPulse(.AnalogPin, 1500); +pins.map(0, 0, 1023, 0, 4); +pins.analogPitch(0, 0); +pins.analogSetPitchPin(.AnalogPin); +```