summaryrefslogtreecommitdiff
path: root/docs/esp8266/quickref.rst
AgeCommit message (Collapse)Author
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>
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-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-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-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.
2019-12-17docs/esp8266/quickref: Add note that machine.RTC is not fully supported.ketograph
See issues #3220 and #3710.
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
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.
2017-10-10docs/esp8266/quickref: Add quickref info for RTC class.Mike Causer
2017-06-02docs/esp8266/quickref: Polish Pin.on()/off() examples.Paul Sokolovsky
2017-05-30docs/esp8266: Consistently replace Pin.high/low methods with .on/off.Paul Sokolovsky
2017-04-18docs/esp8266/quickref: Add links from quickref page to machine classes.Damien George
2016-11-08docs/*/quickref.rst: Use new semantics of ticks_diff()puuu
2016-11-06docs/esp8266: Update for new WebREPL setup procedure.Paul Sokolovsky
2016-09-04docs/esp8266/quickref: Further improvements for SPI subsections.Paul Sokolovsky
Consistency and formatting.
2016-09-04docs/esp8266/quickref: Update information on SPI classes.Paul Sokolovsky
SPI(1) is not used for hardware SPI. Few more details are provided.
2016-08-29docs/esp8266/quickref: Add internal links to docs for some modules.Damien George
2016-08-29docs/esp8266: Update quickref and tutorial for OneWire/DS18X20 driver.Damien George
2016-08-28docs/esp8266/quickref: Fix and update the SPI docsRadomir Dopieralski
Use the `SPI` factory function in the examples, and use proper baud rate of 80 000 000.
2016-08-19esp8266/modpybhspi: Add a HSPI module for hardware SPI supportRadomir Dopieralski
This module uses ESP8266's SPI hardware, which allows much higher speeds. It uses a library from https://github.com/MetalPhreak/ESP8266_SPI_Driver
2016-08-07docs/esp8266/quickref: Link to installation instructions.Paul Sokolovsky
2016-08-01docs: Add DHT to ESP8266 Quick Ref and TutorialMike Causer
2016-06-02docs/esp8266/quickref: Update WebREPL section for 1.8.1 release.Paul Sokolovsky
WebREPL is much more stable now.
2016-06-01esp8266/quickref: Use local image of Adafruit Huzzah board.Paul Sokolovsky
Using remote image causes problems with tools (partly because the image is semi-firewalled and can't be accessed by arbitrary tools).
2016-05-19esp8266: Add APA102 serial individually controllable LEDs support.misterdanb
APA102 is a new "smart LED", similar to WS2812 aka "Neopixel".
2016-05-14docs/esp8266/quickstart: remove i2c examples with stop=FalseRadomir Dopieralski
Since the ``stop`` parameter has been dropped.
2016-05-10docs/esp8266/quickref: New way to get MAC addressRadomir Dopieralski
2016-05-01docs/esp8266/quickref: Add info about WebREPL.Paul Sokolovsky
2016-04-28docs/esp8266: Update quickref to reflect changes to 1-wire and NeoPixel.Damien George
2016-04-21docs/esp8266: Add info about using deep-sleep mode to quickref.Damien George
2016-04-05docs/esp8266/quickref: Add note about physical vs logical pin numbers.Paul Sokolovsky
2016-03-25docs/esp8266/quickref: Add note about GPIO16.Paul Sokolovsky
2016-03-25docs/esp8266/quickref: Note that timers supported are virtual ones.Paul Sokolovsky
2016-03-16docs/esp8266: Update quick reference: i2c.readfrom and neopixel example.Damien George
2016-03-09docs/esp8266: Fix indent errors, typos, and add info about REPL UART.Damien George
2016-03-09docs/esp8266: Minor tweaks to quickref, Timer and I2C classes.Damien George
2016-03-08docs: Add esp8266 quick reference page, with basic info.Damien George