summaryrefslogtreecommitdiff
path: root/docs/esp8266
AgeCommit message (Collapse)Author
2025-02-25docs: Fix double 'the' in documentation.Ronald Weber
Signed-off-by: Ronald Weber <ronaldxweber@gmail.com>
2024-12-19docs: Fix the quickref documentation of rtc.datetime().robert-hh
Such that it matches the implementation and the documentation of the `machine.RTC` class. Signed-off-by: robert-hh <robert@hammelrath.com>
2024-11-19docs: Add a "Reset and Boot Sequence" reference page.Angus Gratton
Previously individual ports documented these aspects to varying degrees, but most of the information is common to all ports. In particular, this adds a canonical explanation of `boot.py` and `main.py`. This work was funded through GitHub Sponsors. Signed-off-by: Angus Gratton <angus@redyak.com.au>
2024-11-08docs: Specify the recommended network.WLAN.IF_[AP|STA] constants.Angus Gratton
Removes the deprecated network.[AP|STA]_IF form from the docs. This work was funded through GitHub Sponsors. Signed-off-by: Angus Gratton <angus@redyak.com.au>
2024-07-05docs: Update docs to replace ifconfig with ipconfig.Felix Dörre
Follow up to 1c6012b0b5c62f18130217f30e73ad3ce4c8c9e6 Signed-off-by: Felix Dörre <felix@dogcraft.de>
2023-04-27all: Fix spelling mistakes based on codespell check.Damien George
Signed-off-by: Damien George <damien@micropython.org>
2022-09-30top: Replace upip with mip everywhere.Jim Mussared
Updates all README.md and docs, and manifests to `require("mip")`. Also extend and improve the documentation on freezing and packaging. This work was funded through GitHub Sponsors. Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
2022-06-17docs: Update to use new WLAN argument names for ssid/security/key.iabdalkader
Addresses issue #8083.
2022-02-02docs: Remove reference to obsolete neopixel_write function.Damien George
It has been replaced by machine.bitstream. Signed-off-by: Damien George <damien@micropython.org>
2021-12-15docs: Remove trailing spaces and convert tabs to spaces.Damien George
Signed-off-by: Damien George <damien@micropython.org>
2021-11-25docs/esp8266/tutorial: Fix comments of FrameBuffer examples.gibbonsc
The third and fourth parameters in display.rect() and display.fill_rect() are not x,y coordinates, but are instead width,height values. Update the comment after the example to show the correct x,y coordinates of the bottom right corner of each rectangle, respectively.
2021-08-30docs/esp8266: Use monospace for software tools.Fernando
Signed-off-by: Fernando <fepegar@gmail.com>
2021-08-13docs: Replace ufoo with foo in all docs.Jim Mussared
Anywhere a module is mentioned, use its "non-u" name for consistency. The "import module" vs "import umodule" is something of a FAQ, and this commit intends to help clear that up. As a first approximation MicroPython is Python, and so imports should work the same as Python and use the same name, to a first approximation. The u-version of a module is a detail that can be learned later on, when the user wants to understand more and have finer control over importing. Existing Python code should just work, as much as it is possible to do that within the constraints of embedded systems, and the MicroPython documentation should match the idiomatic way to write Python code. With universal weak links for modules (via MICROPY_MODULE_WEAK_LINKS) users can consistently use "import foo" across all ports (with the exception of the minimal ports). And the ability to override/extend via "foo.py" continues to work well. Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
2021-07-18docs: Replace master/slave with controller/peripheral in I2C and SPI.David P
See https://www.oshwa.org/a-resolution-to-redefine-spi-signal-names
2021-07-07docs/esp8266/tutorial: Change flash mode from dio to dout.finefoot
For some boards, even -fm dio is too fast and they require -fm dout. This commit links to the esptool wiki about available flash modes and changes dio to dout.
2021-05-14docs/esp8266: Add SSD1306 to quickref and tutorial.Mike Causer
2021-05-14docs/esp8266: Mention Signal in GPIO section of quickref.Mike Causer
2021-05-06docs/esp8266: Add WDT to quickref.Mike Causer
2021-05-04docs: Fix some spelling mistakes.Mike Causer
2021-05-04docs/esp8266: Clarify limitations of SSL in esp8266 and fix typos.Mordy Ovits
2021-05-04docs/esp8266: Add instructions on entering programming mode manually.Damien George
This adds to the ESP8266 tutorial instructions explaining which pins to pull low to enter programming mode. Commit made originally by @ARF1 in #2910. Signed-off-by: Damien George <damien@micropython.org>
2021-05-04docs/esp8266: Add note about simultaneous use of STA_IF and AP_IF.Chris Liechti
See also https://github.com/esp8266/Arduino/issues/1624
2021-01-30docs/esp8266/quickref: Add warning block about NeoPixel timing.Christopher Tse
2020-10-01docs: Update I2C and SPI docs to add reference to SoftI2C and SoftSPI.Damien George
Signed-off-by: Damien George <damien@micropython.org>
2020-06-10docs/esp8266: Add quickref documentation for UART on esp8266.Nick Crabtree
This patch adds quickref documentation for the change in commit afd0701bf7a9dcb50c5ab46b0ae88b303fec6ed3. This commit added the ability to disable the REPL and hence use UART0 for serial communication on the esp8266, but was not previously documented anywhere. The text is largely taken from the commit message, with generic information on using the UART duplicated from the Wipy quickref document.
2020-02-03docs/esp8266: In TCP tutorial, add HTTP response code and content-type.Jesse Andrews
Show how to send an HTTP response code and content-type. Without the response code Safari/iOS will fail. Without the content-type Lynx/Links will fail.
2019-12-17docs/esp8266/quickref: Add note that machine.RTC is not fully supported.ketograph
See issues #3220 and #3710.
2019-12-04docs: Remove spaces on lines that are empty.Damien George
2019-10-16docs: Fix spelling in various parts of the docs.Mike Causer
2019-10-16docs/esp8266: Add ntptime usage to esp8266 quickref.Mike Causer
2019-10-16docs/esp8266/tutorial: Make http_get sample function self contained.Thiago Paes
2019-05-07docs/esp8266: Add tutorial for APA102 LEDs.Mike Causer
2018-10-01docs: Unify all the ports into one set of documentation.Damien George
With this commit there is now only one entry point into the whole documentation, which describes the general MicroPython language, and then from there there are links to information about specific platforms/ports. This commit doesn't change content (almost, it does fix a few internal links), it just reorganises things.
2018-06-25docs/esp8266: Fix minor typo in "certificates".jcea
2018-02-15docs/esp8266: Add a note concerning GPIO16 pull capabilities.Olivier Ortigues
2018-02-15docs/esp8266: Update PWM doc regarding clipping of min/max values.Olivier Ortigues
2017-12-13docs/esp8266/tutorial: Fix typo, change -> changed.Ryan Finnie
2017-11-02docs/esp8266/general: Minor grammar fixes.Paul Sokolovsky
2017-11-01docs/esp8266/general: TLS limitations: Mention also "ussl" module limitations.Paul Sokolovsky
2017-10-30docs/esp8266/general: Add section on TLS limitations.Paul Sokolovsky
2017-10-10docs/esp8266/quickref: Add quickref info for RTC class.Mike Causer
2017-10-04docs/esp8266/tutorial: Update neopixel with example of using 4 bbp.Gabe
2017-07-24docs/esp8266/tutorial: Fix typo, "its" to "it's" in powerctrl.rst.Matthew Brener
2017-07-21eps8266/general: Fix typo in recent example.Paul Sokolovsky
2017-07-21eps8266/general: Add known issue of WiFi RX buffers overflow.Peter Hinch
2017-07-02docs/esp8266/general.rst: Fix name of NTP module.Patrick O'Leary
The simple NTP client module is named "ntptime.py".
2017-06-26docs/esp8266/tutorial/intro: Fix some grammatical typos.Damien George
2017-06-23docs/esp8266/tutorial/intro: Sphinx requires blank lines around literal blocks.Paul Sokolovsky
At least, Sphinx 1.3.6.
2017-06-23docs/esp8266/tutorial/intro: Discourage use of 512kb firmwares.Paul Sokolovsky
This follows similar warnings in other parts of docs.
2017-06-02docs/esp8266/quickref: Polish Pin.on()/off() examples.Paul Sokolovsky