c_meyer/pxt-calliope
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

updated webusb docs

Browse Source
This commit is contained in:
Peli de Halleux 2018-09-26 07:59:26 -07:00
parent dc515ec61c
commit 0a1a90c1a1
4 changed files with 68 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/SUMMARY.md
View File

@ -360,5 +360,6 @@
* [Simulator](/device/simulator)
* [USB](/device/usb)
* [WebUSB](/device/usb/webusb)
* [WebUSB Troubleshoot](/device/usb/webusb/troubleshoot)
* [Flashing via HID (CMSIS-DAP)](/hidflash)

10
docs/device/usb/webusb.md
View File

@ -7,15 +7,15 @@ It allows for a **one-click download** without installing any additional app or
* Chrome 65+ for Android, Chrome OS, Linux, macOS and Windows 10.
## Upgrade your Firmware
## Prepare your @boardname@
Make sure that your @boardname@ is running version **0250** or above of the firmware. Upgrading is as easy as dragging a file and it takes a few seconds to get it done.
[Check out the instructions to check and upgrade your @boardname@.](https://support.microbit.org/support/solutions/articles/19000084059-beta-testing-web-usb)
* [Check out the instructions to check and upgrade your @boardname@.](/device/usb/webusb/troubleshoot)
## Pair your device
## Pair your @boardname@
To get started with WebUSB,
When opening the editor, you need to pair your device to use WebUSB.
* connect your @boardname@ to your computer with the microUSB cable
* open a script
@ -28,4 +28,4 @@ Once your @boardname@ is paired, MakeCode will use WebUSB to transfer the code w
## Console output
MakeCode will be able to "listen" to your @boardname@ and display the console output, generated by ``console.log`` for example.
MakeCode will be able to "listen" to your @boardname@ and display the console output.

61
docs/device/usb/webusb/troubleshoot.md Normal file
View File

@ -0,0 +1,61 @@
# Troubleshooting downloads with WebUSB
This is a troubleshooting to use [WebUSB](/usb/webusb).
## Step 1: Check your cable
Make sure that your @boardname@ is connected to your computer with a micro USB cable. You should see a **MICROBIT** drive appear in Windows Explorer when it's connected.
![MICROBIT drive](/static/mb/device/windows-microbit-drive.png)
**If you can see the MICROBIT drive go to step 2**.
If you can't see the drive:
* Make sure that the USB cable is working.
>Does the cable work on another computer? If not, find a different cable to use. Some cables may only provide a power connection and don't actually transfer data.
* Try another USB port on your computer.
Is the cable good but you still can't see the **MICROBIT** drive? Hmm, you might have a problem with your @boardname@. Try the additional steps described in the [fault finding](https://support.microbit.org/support/solutions/articles/19000024000-fault-finding-with-a-micro-bit) page at microbit.org. If this doesn't help, you can create a [support ticket](https://support.microbit.org/support/tickets/new) to notify the Micro:bit Foundation of the problem. **Skip the rest of these steps**.
## Step 2: Check your firmware version
It's possible that the firmware version on the @boardname@ needs an update. Let's check:
1. Go to the **MICROBIT** drive.
2. Open the **DETAILS.TXT** file.<br/>
![](/static/mb/device/mb-drive-contents.jpg)<br/>
3. Look for a line in the file that says the version number. It should say **Version: \.\.\.**
![](/static/mb/device/details-txt.jpg)<br/>
If the version is **0234**, **0241**, **0243** you **NEED** to update the [firmware](/device/firmware) on your @boardname@. Go to **Step 3** and follow the upgrade instructions.
If the version is **0250** or higher, **you have the right firmware**. You can create a [support ticket](https://support.microbit.org/support/tickets/new) to notify the Micro:bit Foundation of the problem. **Skip the rest of these steps**.
## Step 3: Upgrade the firmware
1. Put your @boardname@ into **MAINTENANCE Mode**. To do this, unplug the USB cable from the @boardname@ and then re-connect the USB cable while you hold down the reset button. Once you insert the cable, you can release the reset button. You should now see a **MAINTENANCE** drive instead of the **MICROBIT** drive like before. Also, a yellow LED light will stay on next to the reset button.
![MAINTENANCE gesture](/static/mb/device/maintenance.gif)
2. **[Download the firmware .hex file](https://support.microbit.org/helpdesk/attachments/19008095092)**
3. Drag and drop that file onto the **MAINTENANCE** drive.
4. The yellow LED will flash while the `HEX` file is copying. When the copy finishes, the LED will go off and the @boardname@ resets. The **MAINTENANCE** drive now changes back to **MICROBIT**.
5. The upgrade is complete! You can open the **DETAILS.TXT** file to check and see that the firmware version changed to the match the version of the `HEX` file you copied.
### ~hint
If you want to know more about connecting the board, MAINTENANCE Mode, and upgrading the firmware, read about it in the [Firmware support page](https://support.microbit.org/support/solutions/articles/19000019131-how-to-upgrade-the-firmware-on-the-micro-bit).
### ~
## Step 4: Check your browser version
WebUSB is a fairly new feature and may require you to update your browser. Check that your browser version matches one of these:
* Chrome 65+ for Android, Chrome OS, Linux, macOS and Windows 10.
## Step 5: Pair device
Once you've updated the firmware, open the **Chrome Browser**, go to the editor and click on **Pair Device** in the gearwheel menu.
Enjoy fast downloads!

2
editor/extension.ts
View File

@ -871,7 +871,7 @@ namespace pxt.editor {
<div style="justify-content: center;display: flex;padding: 1rem;">
<img class="ui image" src="./static/download/firmware.png" style="height:100px;" />
</div>
<a href="${docUrl}/webusbfirmware" target="_blank">${lf("Check your firmware version here and update if needed")}</a>
<a href="${docUrl}/webusb/troubleshoot" target="_blank">${lf("Check your firmware version here and update if needed")}</a>
</div>
<div class="column eleven wide">
<div class="ui grid">