From e604b27c4f1ca008423a418d11d18245920ddc06 Mon Sep 17 00:00:00 2001 From: Peli de Halleux Date: Thu, 9 Jun 2016 11:10:01 -0700 Subject: [PATCH] various docs updates --- docs/about.md | 7 ++++++- docs/device/contents.md | 2 -- docs/device/reactive.md | 2 -- docs/device/serial.md | 23 +++++++++++++++++++++-- docs/open-source.md | 2 +- 5 files changed, 28 insertions(+), 8 deletions(-) diff --git a/docs/about.md b/docs/about.md index 7bf880de..eddd53b0 100644 --- a/docs/about.md +++ b/docs/about.md @@ -34,7 +34,7 @@ Just like Arduino, the micro:bit can be connected to and interact with sensors, The student can program the BBC micro:bit using [visual blocks](http://www.github.com/Google/blockly) or JavaScript. ```blocks -basic.showString("BBC micro:bit!"); +basic.showString("Hi!"); ``` ## Compile and Flash @@ -54,5 +54,10 @@ The simulator has support for the LED screen, buttons, as well as compass, accel The [C++ BBC micro:bit runtime](http://lancaster-university.github.io/microbit-docs/), created at [Lancaster University](http://www.lancaster.ac.uk/), provides access to the hardware functions of the micro:bit, as well as a set of helper functions (such as displaying a number/image/string on the LED screen). + The JavaScript micro:bit library mirrors the functions of the C++ library. When code is compiled to ARM machine code, the calls to JavaScript micro:bit functions are replaced with calls to the corresponding C++ functions. + +## Open Source + +The editor for the BBC micro:bit is [open source](/open-source) on GitHub. Contributors are welcome! diff --git a/docs/device/contents.md b/docs/device/contents.md index 2561a694..26e5b35e 100644 --- a/docs/device/contents.md +++ b/docs/device/contents.md @@ -1,7 +1,5 @@ # micro:bit - the device -The micro:bit device - The micro:bit is a very capable device with many components: * [the USB connector](/device/usb) diff --git a/docs/device/reactive.md b/docs/device/reactive.md index 732377a2..2c990415 100644 --- a/docs/device/reactive.md +++ b/docs/device/reactive.md @@ -1,7 +1,5 @@ # The micro:bit - a reactive system -The micro:bit is a reactive system. - ### Computing systems What sort of a *computing system* is the micro:bit? diff --git a/docs/device/serial.md b/docs/device/serial.md index 117cdd73..4d5cd48f 100644 --- a/docs/device/serial.md +++ b/docs/device/serial.md @@ -11,16 +11,35 @@ input.onButtonPressed(Button.A, () => { }) ``` +Data is also automatically streamed to serial by the ** bar graph** block +and picked up by the editor. This data can be streamed to the cloud as well. + +```blocks +basic.forever(() => { + led.plotBarGraph(input.acceleration(Dimension.X), 0); +}); +``` + ## How to read the micro:bit's serial output from your computer Unfortunately, using the serial library requires quite a bit of a setup. +### BBC micro:bit Chrome Extension + +If you are using the Google Chrome browser, you can use our extension to get serial data streaming in the editor. + +* Install the [Extension for BBC micro:bit](https://chrome.google.com/webstore/detail/extension-for-bbc-microbi/cihhkhnngbjlhahcfmhekmbnnjcjdbge?hl=en-US) on the Chrome Web Store. +* Restart Chrome and open the web editor. + ### 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: * 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. + +#### Windows > Tera Term + +* Install the terminal emulator [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. @@ -32,7 +51,7 @@ You should be good. Feel free to hit `Setup` > `Save Setup` in the menus to eras 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. -### Alternative Windows setup with Putty +#### Windows > Putty If you prefer another terminal emulator (such as [PuTTY](http://www.putty.org/)), here are some instructions. diff --git a/docs/open-source.md b/docs/open-source.md index 62868f47..3398a9cc 100644 --- a/docs/open-source.md +++ b/docs/open-source.md @@ -4,6 +4,6 @@ The editor is open source on GitHub under the MIT license. Contributions are wel ### Repos +* [microsoft/pxt-microbit](https://github.com/Microsoft/pxt-microbit), PXT target for BBC micro:bit, also includes the documentation. * [microbit/pxt](https://github.com/Microsoft/pxt), programming experience toolkit (PXT) -* [microsoft/pxt-microbit](https://github.com/Microsoft/pxt-microbit), PXT target for BBC micro:bit * [microsoft/pxt-microbit-core](https://github.com/Microsoft/pxt-microbit-core), Yotta module used to build the BBC micro:bit runtime