From e570d46755283168dc4bd5ce28d04fed832c9c8b Mon Sep 17 00:00:00 2001 From: Thomas Denney Date: Tue, 6 Sep 2016 09:49:08 +0100 Subject: [PATCH] Rewrite instructions on downloading files to make them more clear --- docs/device/usb.md | 118 ++++++++++-------- .../{usb-0.jpg => usb-windows-device.jpg} | Bin 2 files changed, 66 insertions(+), 52 deletions(-) rename docs/static/mb/device/{usb-0.jpg => usb-windows-device.jpg} (100%) diff --git a/docs/device/usb.md b/docs/device/usb.md index 95debf95..f5f2cae0 100644 --- a/docs/device/usb.md +++ b/docs/device/usb.md @@ -1,19 +1,24 @@ -# Run Scripts on your micro:bit +# Running programs on your micro:bit -How to compile, transfer, and run a script on your micro:bit. +How to compile, transfer, and run a program on your micro:bit. -While you're writing and testing your scripts, you'll mostly be running scripts in your browser by clicking the `PLay` button -(see [run code in your browser](/device/simulator) for info about this). +While you're writing and testing your programs, you'll mostly be [running them +in the simulator](/device/simulator), but once you've finished your program you +can **compile** it and run it on your micro:bit. -Once your masterpiece is complete, you can compile your script and run it on your micro:bit. +The basic steps are: + +1. Connect your micro:bit to your computer via USB +2. Click **Download** and download the `.hex` file +3. Copy the `.hex` file from your computer onto the micro:bit drive ## Requirements You need the following things to transfer and run a script on your micro:bit: -* A-Male to Micro USB cable to connect your computer to your micro:bit. This is the same cable that is commonly used to connect a smart phone to a computer. -* a PC running Windows 7 of later, or a Mac running OS X 10.6 or later -* access to the Internet +* A-Male to Micro USB cable to connect your computer to your micro:bit. This is + the same cable that is commonly used to connect a smart phone to a computer. +* A PC running Windows 7 or later, or a Mac running OS X 10.6 or later ## Step 1: Connect your micro:bit to your computer @@ -23,53 +28,52 @@ First, connect the micro:bit: 2. Connect the other end of the USB cable to a USB port on your computer. -Your computer should recognise your micro:bit as a new drive. On computers running Windows, MICROBIT appears as a drive under Devices and drives. On a Mac it appears as a new drive under Devices. +Your computer should recognise your micro:bit as a new drive. On computers +running Windows, `MICROBIT` appears as a drive under Devices and drives. On a Mac +it appears as a new drive under Devices. -Windows +**Windows** -![](/static/mb/device/usb-0.jpg) +![](/static/mb/device/usb-windows-device.jpg) -Mac +**Mac** ![](/static/mb/device/usb-osx-device.png) -## Step 2: Compile your script +## Step 2: Download your program -Next, compile your script: - -1. Sign in to Touch Develop on your computer. - -2. Open your script (find the script in **My Scripts** and click `Edit`). - -3. Click **Download**. Your script is converted into a hex file that you can transfer and run on your micro:bit. - -4. When prompted, choose to save the compiled file on your computer (or anywhere other than the micro:bit). Depending on which browser you are using, the download will adopt the download behaviour of that particular browser. +1. Open your project on [codethemicrobit.com](https://codethemicrobit.com) +2. Click **Download** +3. When prompted, choose to **save** the compiled file onto your computer. The + prompt will be different depending on which browser you are using, or + whether you are using a Windows computer or a Mac ### Windows -**Chrome** +#### Chrome Your `.hex` file appears as a download at the bottom of the browser. Click on the arrow next to the name of the file and then click **Show in folder**. ![](/static/mb/device/usb-windows-chrome.png) -Drag and drop the hex file from the download folder onto the MICROBIT drive. +Drag and drop the `.hex` file from the download folder onto the `MICROBIT` drive. -**Firefox** +#### Firefox A window will appear asking whether you want to save or open the `.hex` file. Select **Save File** and then select **OK**. -![](/static/mb/device/usb-windows-firefox-2.png) +![](/static/mb/device/usb-windows-firefox-1.png) The file will then appear in your downloads in the top right of your browser. -Click the **folder icon** next to the filename to download it and open it in -Windows Explorer. +Click the **folder icon** next to the filename to open it in Windows Explorer. ![](/static/mb/device/usb-windows-firefox-2.png) -**Microsoft Edge** +Drag and drop the `.hex` file from the download folder onto the `MICROBIT` drive. + +#### Microsoft Edge A message will appear at the bottom of the browser asking what you want to do with the file. Click **Save**: @@ -81,7 +85,7 @@ your `MICROBIT` drive. ![](/static/mb/device/usb-windows-edge-2.png) -**Internet Explorer** +#### Internet Explorer A message will appear at the bottom of the browser asking what you want to do with the file. Click **Save**: @@ -95,7 +99,7 @@ your `MICROBIT` drive. ### Mac -**Safari** +#### Safari When you select **Download** in Safari a file called `Unknown` will be downloaded into your Downloads folder. Open your Downloads folder and drag and @@ -103,36 +107,37 @@ drop the file onto your `MICROBIT` drive, under Devices: ![](/static/mb/device/usb-4.png) -**Firefox** +#### Firefox A dialogue box will appear, asking whether you would like to open or save your -hex file. Select **Save** and **OK** and the file will then appear in your -downloads in the top right of your browser. Right click on the file and click on -**Show in Finder** and the file will appear in your downloads folder. Select the -file and drag and drop it onto your MICROBIT drive. +hex file. Select **Save file** and click **OK** and the file will then appear in +your downloads in the top right of your browser. Right click on the file and +click on **Show in Finder** and the file will appear in your downloads folder. +Select the file and drag and drop it onto your `MICROBIT` drive. ![](/static/mb/device/usb-osx-firefox-1.png) ![](/static/mb/device/usb-osx-firefox-2.png) -**Chrome** +#### Chrome -When you select **Download** in Chrome, the file will be downloaded to the -bottom of the browser in .hex format. Click on the small arrow and select **Show -in Finder**. This will show the file in your download folder. Drag and drop the -file onto your `MICROBIT` drive. +When you select **Download** in Chrome, the file will appear at the bottom of +the browser. Click on the small arrow and select **Show in Finder**. This will +show the file in your download folder. Drag and drop the file onto your +`MICROBIT` drive. ![](/static/mb/device/usb-osx-chrome.png) ## Step 3: Transfer the file to your micro:bit -1. The file will transfer onto your micro:bit. - -2. If you're using Windows, you can use **Send to** as described below. - -3. The LED on the back of your micro:bit flashes during the transfer (which should only take a few seconds). - -4. Once transferred, the code will run automatically on your micro:bit. To rerun your program, press the reset button on the back of your micro:bit. The reset button automatically runs the newest file on the micro:bit. +* Once you've found the folder containing your `.hex` file, drag and drop it + onto your `MICROBIT` drive +* If you're using Windows, you can use **Send to** as described below +* The LED on the back of your micro:bit flashes during the transfer (which + should only take a few seconds). +* Once transferred, the code will run automatically on your micro:bit. To rerun + your program, press the reset button on the back of your micro:bit. The reset + button automatically runs the newest file on the micro:bit. **Send to**: If you're using Windows you use *Send to* in File Explorer: @@ -140,13 +145,19 @@ file onto your `MICROBIT` drive. ![](/static/mb/device/usb-8.jpg) -By copying the script onto the 'MICROBIT' drive, you have programmed it into the flash memory on the micro:bit, which means even after you unplug the micro:bit, your script will still run if the micro:bit is powered by battery. +By copying the script onto the `MICROBIT` drive, you have programmed it into the +flash memory on the micro:bit, which means even after you unplug the micro:bit, +your program will still run if the micro:bit is powered by battery. ## Troubleshooting -You can’t drag and drop more than one hex file at once onto your micro:bit. If you try to drag and drop a second hex file onto your micro:bit before the first file has finished downloading, then the second file may fail in different ways. +You can’t drag and drop more than one hex file at once onto your micro:bit. If +you try to drag and drop a second hex file onto your micro:bit before the first +file has finished downloading, then the second file may fail in different ways. -When the first program has been written to the micro:bit, the drive will disengage. If you drag and drop a second file at this point it may not find the drive and the second write will fail. +When the first program has been written to the micro:bit, the drive will +disengage. If you drag and drop a second file at this point it may not find the +drive and the second write will fail. The errors may look like this: @@ -158,7 +169,10 @@ The errors may look like this: ![](/static/mb/device/usb-10.png) -Or it may appear that there are two hex files on your micro:bit so the micro:bit won’t be able to run multiple files. To rectify this, unplug your micro:bit and plug it in again. Make sure that your micro:bit appears as MICROBIT and not MAINTENANCE. +Or it may appear that there are two hex files on your micro:bit so the micro:bit +won’t be able to run multiple files. To rectify this, unplug your micro:bit and +plug it in again. Make sure that your micro:bit appears as `MICROBIT` and not +`MAINTENANCE`. ### See also diff --git a/docs/static/mb/device/usb-0.jpg b/docs/static/mb/device/usb-windows-device.jpg similarity index 100% rename from docs/static/mb/device/usb-0.jpg rename to docs/static/mb/device/usb-windows-device.jpg