diff --git a/boards/adafruit-grand-central-m4-express/doc.txt b/boards/adafruit-grand-central-m4-express/doc.txt index acc4a65470..06c2a22622 100644 --- a/boards/adafruit-grand-central-m4-express/doc.txt +++ b/boards/adafruit-grand-central-m4-express/doc.txt @@ -5,8 +5,7 @@ ### General information -![Adafruit Grand Central M4 Expressboard] -(https://cdn-learn.adafruit.com/assets/assets/000/068/748/medium800/adafruit_products_grand_central_top_angle.jpg?1546734839) +![Adafruit Grand Central M4 Expressboard](https://cdn-learn.adafruit.com/assets/assets/000/068/748/medium800/adafruit_products_grand_central_top_angle.jpg?1546734839) The main features of the board are: - ATSAMD51 Cortex M4 running at 120 MHz diff --git a/boards/airfy-beacon/doc.txt b/boards/airfy-beacon/doc.txt index 63b95e14b7..74f52bc744 100644 --- a/boards/airfy-beacon/doc.txt +++ b/boards/airfy-beacon/doc.txt @@ -11,13 +11,11 @@ usual micro-controller peripherals with a 2.4GHz radio that supports both Nordics proprietary ShockBurst as well as Bluetooth Low Energy (BLE). The board was available via -[Indiegogo] -(https://www.indiegogo.com/projects/airfy-beacon-make-your-smart-home-even-smarter). +[Indiegogo](https://www.indiegogo.com/projects/airfy-beacon-make-your-smart-home-even-smarter). ## Hardware -![airfy-beacon] -(https://raw.githubusercontent.com/wiki/RIOT-OS/RIOT/images/airfy-beacon.jpg) +![airfy-beacon](https://raw.githubusercontent.com/wiki/RIOT-OS/RIOT/images/airfy-beacon.jpg) | MCU | NRF51822QFAA | |:--------------------- |:--------------------------------- | @@ -114,8 +112,7 @@ SWD data I/O: SWDIO <-----------> SWDIO (CN3, pin4) The following image shows the wiring for an SWD flasher board: -![airfy-beacon-flash-connect] -(https://raw.githubusercontent.com/wiki/RIOT-OS/RIOT/images/airfy-beacon-flash-connect.jpg) +![airfy-beacon-flash-connect](https://raw.githubusercontent.com/wiki/RIOT-OS/RIOT/images/airfy-beacon-flash-connect.jpg) ### Software Debugging and programming this module works well with diff --git a/boards/arduino-mega2560/doc.txt b/boards/arduino-mega2560/doc.txt index 401d8b5660..50c248296c 100644 --- a/boards/arduino-mega2560/doc.txt +++ b/boards/arduino-mega2560/doc.txt @@ -72,8 +72,7 @@ to overwrite the bootloader on the MCU. Because of that it is a necessity to use an ISP (in system programmer) to do the debugging. This isn't an issue because all of the afore mentioned devices have ISP capabilities, but it requires some additional steps to get back normal operation after debugging: - * flash a new arduino bootloader on the device, e.g. [this one] -(https://raw.githubusercontent.com/arduino/Arduino-stk500v2-bootloader/master/goodHexFiles/stk500boot_v2_mega2560.hex) + * flash a new arduino bootloader on the device, e.g. [this one](https://raw.githubusercontent.com/arduino/Arduino-stk500v2-bootloader/master/goodHexFiles/stk500boot_v2_mega2560.hex) * restore the fuses to the default state. diff --git a/boards/cc2538dk/doc.txt b/boards/cc2538dk/doc.txt index ef4210a6e9..8523139bb6 100644 --- a/boards/cc2538dk/doc.txt +++ b/boards/cc2538dk/doc.txt @@ -42,8 +42,7 @@ internal bootloader, then run: Activating this bootloader is NOT enabled if the flash content is in factory default state (e.g. after unboxing). To set the bits in the CCA accordingly you -have to follow the guidelines found [here] -(https://web.archive.org/web/20170610111337/http://processors.wiki.ti.com/index.php/CC2538_Bootloader_Backdoor). +have to follow the guidelines found [here](https://web.archive.org/web/20170610111337/http://processors.wiki.ti.com/index.php/CC2538_Bootloader_Backdoor). To manage this first time access you have to download the ["Uniflash"](http://processors.wiki.ti.com/index.php/Category:CCS_UniFlash) tool at TI's website. @@ -58,8 +57,7 @@ FTDI driver manually: If the path `/sys/bus/usb-serial/drivers/ftdi_sio/` doesn't exist, you also have to load the module `ftdi_sio` by hand. Alternatively, you can install a `udev` rule that configures this on device connection, see [this post on TI's -E2E site] -(https://e2e.ti.com/support/microcontrollers/c2000/f/171/p/359074/1843485#1843485) +E2E site](https://e2e.ti.com/support/microcontrollers/c2000/f/171/p/359074/1843485#1843485) for details. RIOT will use /dev/ttyUSB1 by default, but if the UART is given a different @@ -114,8 +112,8 @@ $ csrutil status System Integrity Protection status: disabled. ``` -Afterwards you'll be able to install this [driver] -(https://cdn.sparkfun.com/assets/learn_tutorials/7/4/FTDIUSBSerialDriver_v2_3.dmg). +Afterwards you'll be able to install this +[driver](https://cdn.sparkfun.com/assets/learn_tutorials/7/4/FTDIUSBSerialDriver_v2_3.dmg). If everything goes OK reboot your Mac and then edit `/System/Library/Extensions/FTDIUSBSerialDriver.kext/Contents/Info.plist` with a diff --git a/boards/cc2650stk/doc.txt b/boards/cc2650stk/doc.txt index e4736d1b14..1f3f50d4b6 100644 --- a/boards/cc2650stk/doc.txt +++ b/boards/cc2650stk/doc.txt @@ -54,8 +54,7 @@ The arm-none-eabi toolchain works fine. You can get it ## Programming and Debugging -You'll need [debugging hardware] -(https://processors.wiki.ti.com/index.php?title=CC13xx_CC26xx_Tools_Overview#Debuggers). +You'll need [debugging hardware](https://processors.wiki.ti.com/index.php?title=CC13xx_CC26xx_Tools_Overview#Debuggers). So far, the [XDS110 debug probe](https://www.ti.com/tool/CC-DEVPACK-DEBUG) has been tested. That bugger requires you to load a firmware onto it each time it powers up. The tool is contained in the Uniflash utility or the `CodeComposer diff --git a/boards/common/slwstk6000b/doc.txt b/boards/common/slwstk6000b/doc.txt index af6ada1fae..44560c44ac 100644 --- a/boards/common/slwstk6000b/doc.txt +++ b/boards/common/slwstk6000b/doc.txt @@ -90,8 +90,8 @@ symbols (`-gdwarf-2` for GCC). ### Clock selection There are several clock sources that are available for the different -peripherals. You are advised to read [AN0004.1] -(https://www.silabs.com/documents/public/application-notes/an0004.1-efm32-cmu.pdf) +peripherals. You are advised to read +[AN0004.1](https://www.silabs.com/documents/public/application-notes/an0004.1-efm32-cmu.pdf) to get familiar with the different clocks. | Source | Internal | Speed | Comments | diff --git a/boards/derfmega128/doc.txt b/boards/derfmega128/doc.txt index 0a9788d4c8..20b7c15443 100644 --- a/boards/derfmega128/doc.txt +++ b/boards/derfmega128/doc.txt @@ -9,32 +9,23 @@ deRFmega128 modules are based on [ATmega128rfa1](http://ww1.microchip.com/downlo MCUs. It include 16MHz main and 32K RTC crystalls and (depending on module type) integrated or not integrated 2.4GHz antenna. These modules are available in different variants: -- [deRFmega128-22M00] - (https://www.dresden-elektronik.de/produkt/24-ghz-avr-derfmega128-22m00.html) +- [deRFmega128-22M00](https://www.dresden-elektronik.de/produkt/24-ghz-avr-derfmega128-22m00.html) with integrated antenna, -- [deRFmega128-22M10] - (https://www.dresden-elektronik.de/produkt/24-ghz-avr-derfmega128-22m10.html) +- [deRFmega128-22M10](https://www.dresden-elektronik.de/produkt/24-ghz-avr-derfmega128-22m10.html) without integrated antenna. -- [deRFmega128-22A00] - (https://www.dresden-elektronik.de/produkt/24-ghz-avr-derfmega128-22a00.html) +- [deRFmega128-22A00](https://www.dresden-elektronik.de/produkt/24-ghz-avr-derfmega128-22a00.html) with connectors and integrated antenna, -- [deRFmega128-22A02] - (https://www.dresden-elektronik.de/produkt/24-ghz-avr-derfmega128-22a02.html) +- [deRFmega128-22A02](https://www.dresden-elektronik.de/produkt/24-ghz-avr-derfmega128-22a02.html) with connectors, but without integrated antenna. -- [deRFmega128-22C00] - (https://www.dresden-elektronik.de/produkt/24-ghz-avr-derfmega128-22c00.html) +- [deRFmega128-22C00](https://www.dresden-elektronik.de/produkt/24-ghz-avr-derfmega128-22c00.html) solderable with integrated antenna, -- [deRFmega128-22C02] - (https://www.dresden-elektronik.de/produkt/24-ghz-avr-derfmega128-22c02.html) +- [deRFmega128-22C02](https://www.dresden-elektronik.de/produkt/24-ghz-avr-derfmega128-22c02.html) solderable without integrated antenna. # Hardware For details see the according data sheets: -- [deRFmega128-22M00 and deRFmega128-22M10] - (https://www.dresden-elektronik.de/files/dresden-elektronik/content/downloads/datenblaetter/_outdated/deRFmega128-22M00-22M10-DBT-de.pdf) -- [deRFmega128-22A00 and deRFmega128-22C00] - (https://www.dresden-elektronik.de/files/dresden-elektronik/content/downloads/datenblaetter/_outdated/deRFmega128-22A00-C00-DBT-de.pdf) -- [deRFmega128-22A02 and deRFmega128-22C02] - (https://www.dresden-elektronik.de/files/dresden-elektronik/content/downloads/datenblaetter/_outdated/deRFmega128-22A02-C02-DBT-de.pdf) +- [deRFmega128-22M00 and deRFmega128-22M10](https://www.dresden-elektronik.de/files/dresden-elektronik/content/downloads/datenblaetter/_outdated/deRFmega128-22M00-22M10-DBT-de.pdf) +- [deRFmega128-22A00 and deRFmega128-22C00](https://www.dresden-elektronik.de/files/dresden-elektronik/content/downloads/datenblaetter/_outdated/deRFmega128-22A00-C00-DBT-de.pdf) +- [deRFmega128-22A02 and deRFmega128-22C02](https://www.dresden-elektronik.de/files/dresden-elektronik/content/downloads/datenblaetter/_outdated/deRFmega128-22A02-C02-DBT-de.pdf) */ diff --git a/boards/esp32-heltec-lora32-v2/doc.txt b/boards/esp32-heltec-lora32-v2/doc.txt index 24556e3e51..b509ae9da2 100644 --- a/boards/esp32-heltec-lora32-v2/doc.txt +++ b/boards/esp32-heltec-lora32-v2/doc.txt @@ -22,8 +22,7 @@ 2. [Board Configuration](#esp32_heltec_lora32_v2_board_configuration) 3. [Board Pinout](#esp32_heltec_lora32_v2_pinout) 4. [Using the OLED Display](#esp32_heltec_lora32_v2_oled_display) - 5. [Optional Hardware Configurations] - (#esp32_heltec_lora32_v2_optional_hardware) + 5. [Optional Hardware Configurations](#esp32_heltec_lora32_v2_optional_hardware) 3. [Flashing the Device](#esp32_heltec_lora32_v2_flashing) ## Overview {#esp32_heltec_lora32_v2_overview} @@ -217,10 +216,8 @@ purpose. However, if optional off-board hardware modules are used, these GPIOs may also be occupied, see section \ref esp32_heltec_lora32_v2_board_configuration for more information. -The corresponding board schematics can be found [here for SX1276 version] -(https://github.com/Heltec-Aaron-Lee/WiFi_Kit_series/blob/master/SchematicDiagram/WiFi_LoRa_32(V2)/WIFI_LoRa_32_V2(868-915).PDF) -and [here for SX1278 version] -(https://github.com/Heltec-Aaron-Lee/WiFi_Kit_series/blob/master/SchematicDiagram/WiFi_LoRa_32(V2)/WiFi_LoRa_32_V2(433%2C470-510).PDF). +The corresponding board schematics can be found [here for SX1276 version](https://github.com/Heltec-Aaron-Lee/WiFi_Kit_series/blob/master/SchematicDiagram/WiFi_LoRa_32(V2)/WIFI_LoRa_32_V2(868-915).PDF) +and [here for SX1278 version](https://github.com/Heltec-Aaron-Lee/WiFi_Kit_series/blob/master/SchematicDiagram/WiFi_LoRa_32(V2)/WiFi_LoRa_32_V2(433%2C470-510).PDF). \anchor esp32_heltec_lora_32_v2_pinout_img @image html "https://gitlab.com/gschorcht/RIOT.wiki-Images/raw/master/esp32/Heltec_WiFi_LoRa_32_V2_pinout.png" "WiFi LoRa 32 V2 Pintout Diagram" diff --git a/boards/esp32-mh-et-live-minikit/doc.txt b/boards/esp32-mh-et-live-minikit/doc.txt index ee2e21051a..8deca0fc66 100644 --- a/boards/esp32-mh-et-live-minikit/doc.txt +++ b/boards/esp32-mh-et-live-minikit/doc.txt @@ -21,17 +21,15 @@ 1. [MCU](#esp32_mh_et_live_minikit_mcu) 2. [Board Configuration](#esp32_mh_et_live_minikit_board_configuration) 3. [Board Pinout](#esp32_mh_et_live_minikit_pinout) - 4. [Optional Hardware Configurations] - (#esp32_mh_et_live_minikit_optional_hardware) + 4. [Optional Hardware Configurations](#esp32_mh_et_live_minikit_optional_hardware) 3. [Flashing the Device](#esp32_mh_et_live_minikit_flashing) ## Overview {#esp32_mh_et_live_minikit_overview} The MH-ET LIVE MiniKit for ESP32 uses the ESP32-WROOM-32 module. It is a very interesting development kit as it uses in the stackable Wemos D1 Mini format. -Thus, all [shields for Wemos D1 mini] -(https://docs.wemos.cc/en/latest/d1_mini_shield/index.html) for ESP8266 -can also be used with ESP32. Examples for such shields are: +Thus, all [shields for Wemos D1 mini](https://docs.wemos.cc/en/latest/d1_mini_shield/index.html) +for ESP8266 can also be used with ESP32. Examples for such shields are: - Micro SD-Card Shield - MRF24J40 IEEE 802.15.4 radio Shield diff --git a/boards/esp32-wemos-lolin-d32-pro/doc.txt b/boards/esp32-wemos-lolin-d32-pro/doc.txt index 409e7cd667..1102c270d7 100644 --- a/boards/esp32-wemos-lolin-d32-pro/doc.txt +++ b/boards/esp32-wemos-lolin-d32-pro/doc.txt @@ -21,8 +21,7 @@ 1. [MCU](#esp32_wemos_lolin_d32_pro_mcu) 2. [Board Configuration](#esp32_wemos_lolin_d32_pro_board_configuration) 3. [Board Pinout](#esp32_wemos_lolin_d32_pro_pinout) - 4. [Optional Hardware Configurations] - (#esp32_wemos_lolin_d32_pro_optional_hardware) + 4. [Optional Hardware Configurations](#esp32_wemos_lolin_d32_pro_optional_hardware) 3. [Flashing the Device](#esp32_wemos_lolin_d32_pro_flashing) ## Overview {#esp32_wemos_lolin_d32_pro_overview} @@ -164,8 +163,8 @@ any purpose. However, if optional off-board hardware modules are used, these GPIOs may also be occupied, see section \ref esp32_wemos_lolin_d32_pro_board_configuration for more information. -The corresponding board schematic can be found [here] -(https://docs.wemos.cc/en/latest/_static/files/sch_d32_pro_v2.0.0.pdf). +The corresponding board schematic can be found +[here](https://docs.wemos.cc/en/latest/_static/files/sch_d32_pro_v2.0.0.pdf). \anchor esp32_wemos_lolin_d32_pro_pinout_img @image html "https://gitlab.com/gschorcht/RIOT.wiki-Images/raw/master/esp32/Wemos_LOLIN_D32_PRO_pinout.png" "Wemos LOLIN D32 PRO pinout" diff --git a/boards/esp32-wroom-32/doc.txt b/boards/esp32-wroom-32/doc.txt index 128d93a437..05ec773210 100644 --- a/boards/esp32-wroom-32/doc.txt +++ b/boards/esp32-wroom-32/doc.txt @@ -170,8 +170,8 @@ and can be used for any purpose. However, if optional off-board hardware modules are used, these GPIOs may also be occupied, see section \ref esp32_wroom_32_board_configuration for more information. -The corresponding board schematics can be found her [here] -(https://dl.espressif.com/dl/schematics/esp32_devkitc_v4-sch-20180607a.pdf) +The corresponding board schematics can be found +[here](https://dl.espressif.com/dl/schematics/esp32_devkitc_v4-sch-20180607a.pdf) @image html "https://gitlab.com/gschorcht/RIOT.wiki-Images/raw/master/esp32/ESP32-WROOM-32_pinouts.png" "EPS32-DevKitC V4 Pinout" diff --git a/boards/esp32-wrover-kit/doc.txt b/boards/esp32-wrover-kit/doc.txt index 09fcceaba6..b74766eb9b 100644 --- a/boards/esp32-wrover-kit/doc.txt +++ b/boards/esp32-wrover-kit/doc.txt @@ -286,8 +286,7 @@ for ESP32 boards, see \ref esp32_riot. Since the USB bridge based on FDI FT2232HL provides a JTAG interface for debugging through an USB interface, using ESP-WROVER-Kit V3 is the easiest and most convenient way for On-Chip debugging. Please refer the -[ESP-IDF Programming Guide] -(https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/jtag-debugging/index.html) +[ESP-IDF Programming Guide](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/jtag-debugging/index.html) for details on how to setup and how to use ESP-WROVER-Kit V3 and OpenOCD. To use the JTAG interface, the `esp_jtag` module has to be enabled for @@ -298,8 +297,8 @@ USEMODULE=esp_jtag make flash BOARD=esp32-wrover-kit ... To flash and debug using OpenOCD, the precompiled version of OpenOCD for ESP32 has to be installed using the install script while being in RIOT's -root directory, see also section [Using Local Toolchain Installation] -(#esp32_local_toolchain_installation). +root directory, see also section +[Using Local Toolchain Installation](#esp32_local_toolchain_installation). ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ dist/tools/esptool/install.sh openocd ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -333,7 +332,6 @@ method for flashing with `esptool.py` can still be used. In that case, the ## Other Documentation Resources {#esp32_wrover_kit_other-resources} There is a comprehensive -[Getting Started Guide] -(https://docs.espressif.com/projects/esp-idf/en/latest/esp32/hw-reference/esp32/get-started-wrover-kit-v3.html) +[Getting Started Guide](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/hw-reference/esp32/get-started-wrover-kit-v3.html) for the ESP-WROVER-KIT with a lot information about hardware configuration. */ diff --git a/boards/esp32c3-wemos-mini/doc.txt b/boards/esp32c3-wemos-mini/doc.txt index 9ff07075da..ada24a86ee 100644 --- a/boards/esp32c3-wemos-mini/doc.txt +++ b/boards/esp32c3-wemos-mini/doc.txt @@ -26,9 +26,9 @@ ## Overview {#esp32c3_wemos_mini_overview} The Wemos ESP32-C3 mini board is an interesting development kit as it uses -in the stackable Wemos LOLIN D1 Mini format. Thus, all [shields for Wemos D1 mini] -(https://docs.wemos.cc/en/latest/d1_mini_shield/index.html) for ESP8266 -can also be used with ESP32-C3. Examples for such shields are: +in the stackable Wemos LOLIN D1 Mini format. Thus, all +[shields for Wemos D1 mini](https://docs.wemos.cc/en/latest/d1_mini_shield/index.html) +for ESP8266 can also be used with ESP32-C3. Examples for such shields are: - Micro SD-Card Shield - MRF24J40 IEEE 802.15.4 radio Shield @@ -45,7 +45,7 @@ the need for a soldering iron or a breadboard. This stackable platform was tested in an RIOT application with: - MRF24J40 IEEE 802.15.4 radio Shield (contact gunar@schorcht.net for more information) -- [BMP180 Pressure Sensor Shield] +- [BMP180 Pressure Sensor Shield](http://www.esp8266learning.com/wemos-mini-bmp180-shield.php) This application is a good example how easy it is with this board to create different hardware applications. diff --git a/boards/esp32s2-lilygo-ttgo-t8/doc.txt b/boards/esp32s2-lilygo-ttgo-t8/doc.txt index 949567711d..bdbd64797b 100644 --- a/boards/esp32s2-lilygo-ttgo-t8/doc.txt +++ b/boards/esp32s2-lilygo-ttgo-t8/doc.txt @@ -125,8 +125,7 @@ definition. @image html https://ae01.alicdn.com/kf/H4a77f8684c144384a165d7a89476c602q.jpg "LILYGO TTGO T8 ESP32-S2 Pinout" width=900px -The corresponding board schematics can be found [here] -(https://github.com/Xinyuan-LilyGO/LilyGo-T-Display-S2/raw/master/schematic/ESP32_S2-Display.pdf) +The corresponding board schematics can be found [here](https://github.com/Xinyuan-LilyGO/LilyGo-T-Display-S2/raw/master/schematic/ESP32_S2-Display.pdf) [Back to table of contents](#esp32s2_lilygo_ttgo_t8_toc) diff --git a/boards/esp32s3-pros3/doc.txt b/boards/esp32s3-pros3/doc.txt index cef30f48a0..4f56d97f7e 100644 --- a/boards/esp32s3-pros3/doc.txt +++ b/boards/esp32s3-pros3/doc.txt @@ -128,8 +128,8 @@ The following figure shows the pinout as configured by board definition. @image html https://esp32s3.com/images/pins_pros3.jpg "ESP32 ProS3C-1 Pinout" width=900px -The corresponding board schematic can be found [here] -(https://github.com/UnexpectedMaker/esp32s3/raw/main/schematics/schematic-pros3.pdf) +The corresponding board schematic can be found +[here](https://github.com/UnexpectedMaker/esp32s3/raw/main/schematics/schematic-pros3.pdf) [Back to table of contents](#esp32s3_pros3_toc) diff --git a/boards/esp32s3-wt32-sc01-plus/doc.txt b/boards/esp32s3-wt32-sc01-plus/doc.txt index 8de39dd0e4..fa61f77929 100644 --- a/boards/esp32s3-wt32-sc01-plus/doc.txt +++ b/boards/esp32s3-wt32-sc01-plus/doc.txt @@ -31,8 +31,8 @@ is a smart panel development platform with the ESP32-S3 SoC. \image html https://raw.githubusercontent.com/sukesh-ak/ESP32-TUX/master/datasheet/WT32-SC01-Plus.png "ESP32-S3 WT32-SC01 Plus" width=400px -It also available on the market as [Smart Panlee SC01 Plus] -(http://en.smartpanle.com/product-item-15.html). +It also available on the market as +[Smart Panlee SC01 Plus](http://en.smartpanle.com/product-item-15.html). The ESP32-S3 WT32-SC01 Plus has following main features: