diff --git a/README.md b/README.md index 22a20bdf19dd2f1ec37f0baf8a7631a11d885de4..e437f66d4b7b759fffef35ff2e47f35bb6c9b2ec 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ## Installing -To install the Arduino Core, add the following URL to "Additional Boards Manager URLs": +To install the Arduino Core, add the following URL to `Additional Boards Manager URLs`: ``` https://raw.githubusercontent.com/qbolsee/ArduinoCore-fab-sam/master/json/package_Fab_SAM_index.json @@ -12,11 +12,11 @@ You can then install the package by opening up the Boards Manager: <img src=img/board_manager.png width=80%> -And looking for a package called "Fab SAM core for Arduino". Simply install the latest version: +And looking for a package called `Fab SAM core for Arduino`. Simply install the latest version: <img src=img/install_board.png width=80%> -A new menu appears under "board", letting you select a variety of chips. Some generic names contain an "x", for instance for a SAMD21E17, you would select "Generic x21E": +A new menu appears under `board`, letting you select a variety of chips. Some generic names contain an `x`, for instance for a SAMD21E17, you would select `Generic x21E`: <img src=img/board_list.png width=80%> @@ -34,26 +34,43 @@ This can be achieved with a bootloader, that first needs to be installed on the ### Burn bootloader +Connect a CMSIS-DAP adapter (Atmel ICE is also fine) to your board and make sure both are powered. + <img src=img/programming_d11.jpg width=50%><img src=img/programming_d21.jpg width=50%><br> +Select the right board and microcontroller, then `CMSIS-DAP` as the programmer, then click on "Burn bootloader". + <img src=img/burn_bootloader.png width=80%> +If all goes well, your board will now be detected as a serial port and you can start uploading to it through the bootloader + ### Upload +To upload a sketch, simply use the `upload` command or the arrow icon. Make sure the bootloader size is not set to `NO_BOOTLOADER`, otherwise the bootloader won't be used. + <img src=img/upload.png width=50%><img src=img/upload_alt.png width=50%> ### Upload with programmer +This is a special scenario where you have a bootloader but still want to upload using a programmer. Reasons might be: + +- Upload is slow through the bootloader +- You disabled USB support and the board cannot be found + +In those cases, connect a programmer and explicitly pick `Upload Using Programmer`: + <img src=img/upload_programmer.png width=80%> ## Without bootloader -As expained previously, bootloaders use some of the flash. With the SAMD11, we only have 16kb of total flash, and the bootloader would use 4kb of that. +As expained previously, bootloaders use some of the flash. With the SAMD11, we only have 16kb of total flash, and the bootloader would use 4kb of that. If you want to recover this extra space, you can use your chip without a bootloader altogether. You'll need a programmer connected every time you upload a sketch. -In some applications, you want to recover those 4kb +To enable this behavior, simply select `NO_BOOTLOADER` in bootloader size: <img src=img/without_bootloader.png width=80%> ### Upload +To upload without a bootloader, connect a programmer and either pick `Upload` or `Upload Using Programmer`: + <img src=img/upload.png width=50%><img src=img/upload_programmer.png width=50%><br>