arduino/esp8266
1
0
Fork 0
mirror of https://github.com/esp8266/Arduino.git synced 2025-08-01 03:47:23 +03:00
Code Activity

Sphinx syntax fixes (#9180)

Browse Source 
get rid of warnings when converting python -> rst, force quit when they happen
fix code-blocks, always need extra line
fix invalid headers refs so they actually work
This commit is contained in:
Max Prokhorov
2024-07-31 01:28:46 +03:00
committed by GitHub
parent c2f136515a
commit 1b6f815463
11 changed files with 81 additions and 71 deletions
Download Patch File Download Diff File Expand all files Collapse all files

67
tools/boards.txt.py
View File

@ -112,25 +112,30 @@ boards = collections.OrderedDict([
'+-----------------+------------+------------------+',
'| GND | | GND |',
'+-----------------+------------+------------------+',
'| TX or GPIO2\* | | RX |',
'| TX or GPIO2 | | |',
'| [#tx_or_gpio2]_ | RX | |',
'+-----------------+------------+------------------+',
'| RX | | TX |',
'+-----------------+------------+------------------+',
'| GPIO0 | PullUp | DTR |',
'+-----------------+------------+------------------+',
'| Reset\* | PullUp | RTS |',
'| Reset | | |',
'| [#reset]_ | PullUp | RTS |',
'+-----------------+------------+------------------+',
'| GPIO15\* | PullDown | |',
'| GPIO15 | | |',
'| [#gpio15]_ | PullDown | |',
'+-----------------+------------+------------------+',
'| CH\_PD | PullUp | |',
'| CH\\_PD | | |',
'| [#ch_pd]_ | PullUp | |',
'+-----------------+------------+------------------+',
'',
'- Note',
'- GPIO15 is also named MTDO',
'- Reset is also named RSBT or REST (adding PullUp improves the',
'.. rubric:: Notes',
'',
'.. [#tx_or_gpio2] GPIO15 is also named MTDO',
'.. [#reset] Reset is also named RSBT or REST (adding PullUp improves the',
' stability of the module)',
'- GPIO2 is alternative TX for the boot loader mode',
'- **Directly connecting a pin to VCC or GND is not a substitute for a',
'.. [#gpio15] GPIO2 is alternative TX for the boot loader mode',
'.. [#ch_pd] **Directly connecting a pin to VCC or GND is not a substitute for a',
' PullUp or PullDown resistor, doing this can break upload management',
' and the serial console, instability has also been noted in some',
' cases.**',
@ -161,15 +166,16 @@ boards = collections.OrderedDict([
'+---------------+------------+------------------+',
'| GPIO0 | | GND |',
'+---------------+------------+------------------+',
'| Reset | | RTS\* |',
'| Reset | | RTS [#rts]_ |',
'+---------------+------------+------------------+',
'| GPIO15 | PullDown | |',
'+---------------+------------+------------------+',
'| CH\_PD | PullUp | |',
'| CH\\_PD | PullUp | |',
'+---------------+------------+------------------+',
'',
'- Note',
'- if no RTS is used a manual power toggle is needed',
'.. rubric:: Notes',
'',
'.. [#rts] if no RTS is used a manual power toggle is needed',
'',
'Minimal Hardware Setup for Running only',
'~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~',
@ -187,7 +193,7 @@ boards = collections.OrderedDict([
'+----------+------------+----------------+',
'| GPIO15 | PullDown | |',
'+----------+------------+----------------+',
'| CH\_PD | PullUp | |',
'| CH\\_PD | PullUp | |',
'+----------+------------+----------------+',
'',
'Minimal',
@ -249,7 +255,11 @@ boards = collections.OrderedDict([
'boot mode',
'~~~~~~~~~',
'',
'the first value respects the pin setup of the Pins 0, 2 and 15.',
'the first value respects the pin setup of the Pins 0, 2 and 15',
'',
'.. code-block::',
'',
' Number = (GPIO15 << 2) | (GPIO0 << 1) | GPIO2',
'',
'+----------+----------+---------+---------+-------------+',
'| Number | GPIO15 | GPIO0 | GPIO2 | Mode |',
@ -271,7 +281,6 @@ boards = collections.OrderedDict([
'| 7 | 3.3V | 3.3V | 3.3V | SDIO |',
'+----------+----------+---------+---------+-------------+',
'',
'note: - number = ((GPIO15 << 2) \| (GPIO0 << 1) \| GPIO2);',
],
}),
( 'esp8285', {
@ -756,14 +765,10 @@ boards = collections.OrderedDict([
],
'desc': [ 'ESPino by ThaiEasyElec using WROOM-02 module from Espressif Systems with 4 MB Flash.',
'',
'We will update an English description soon. - Product page:',
'http://thaieasyelec.com/products/wireless-modules/wifi-modules/espino-wifi-development-board-detail.html',
'- Schematics:',
'www.thaieasyelec.com/downloads/ETEE052/ETEE052\_ESPino\_Schematic.pdf -',
'Dimensions:',
'http://thaieasyelec.com/downloads/ETEE052/ETEE052\_ESPino\_Dimension.pdf',
'- Pinouts:',
'http://thaieasyelec.com/downloads/ETEE052/ETEE052\_ESPino\_User\_Manual\_TH\_v1\_0\_20160204.pdf (Please see pg. 8)',
'* Product page (retired product): https://www.thaieasyelec.com/product/%E0%B8%A2%E0%B8%81%E0%B9%80%E0%B8%A5%E0%B8%B4%E0%B8%81%E0%B8%88%E0%B8%B3%E0%B8%AB%E0%B8%99%E0%B9%88%E0%B8%B2%E0%B8%A2-retired-espino-wifi-development-board/11000833173001086',
'* Schematics: https://downloads.thaieasyelec.com/ETEE052/ETEE052\\_ESPino\\_Schematic.pdf',
'* Dimensions: https://downloads.thaieasyelec.com/ETEE052/ETEE052\\_ESPino\\_Dimension.pdf',
'* Pinouts (Please see pg.8): https://downloads.thaieasyelec.com/ETEE052/ETEE052\\_ESPino\\_User\\_Manual\\_TH\\_v1\\_0\\_20160204.pdf',
],
}),
( 'wifinfo', {
@ -1626,13 +1631,13 @@ def all_flash_map ():
print("generated: flash map config file (in cores/esp8266/FlashMap.h)")
return {
'autoflash': {
'.menu.eesz.autoflash': 'Mapping defined by Hardware and Sketch',
'.menu.eesz.autoflash.build.flash_size': '16M',
'.menu.eesz.autoflash.build.flash_ld': 'eagle.flash.auto.ld',
'.menu.eesz.autoflash.build.extra_flags': '-DFLASH_MAP_SUPPORT=1',
'.menu.eesz.autoflash.upload.maximum_size': '1044464',
},
'autoflash': collections.OrderedDict([
('.menu.eesz.autoflash', 'Mapping defined by Hardware and Sketch'),
('.menu.eesz.autoflash.build.flash_size', '16M'),
('.menu.eesz.autoflash.build.flash_ld', 'eagle.flash.auto.ld'),
('.menu.eesz.autoflash.build.extra_flags', '-DFLASH_MAP_SUPPORT=1'),
('.menu.eesz.autoflash.upload.maximum_size', '1044464')
]),
'512K': f512,
'1M': f1m,
'2M': f2m,