b3e013f60e
docs: Unify all the ports into one set of documentation.
...
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-10-01 13:53:53 +10:00
5731e535dd
docs/esp8266: Fix minor typo in "certificates".
2018-06-25 17:36:28 +10:00
298b325f3e
docs/esp8266: Add a note concerning GPIO16 pull capabilities.
2018-02-15 11:15:12 +11:00
d072573226
docs/esp8266: Update PWM doc regarding clipping of min/max values.
2018-02-15 11:14:34 +11:00
1e2b78111b
docs/esp8266/tutorial: Fix typo, change -> changed.
2017-12-13 17:30:02 +11:00
1742ab2653
docs/esp8266/general: Minor grammar fixes.
2017-11-02 00:38:58 +02:00
58c785632f
docs/esp8266/general: TLS limitations: Mention also "ussl" module limitations.
2017-11-01 08:59:42 +02:00
4dd523adbb
docs/esp8266/general: Add section on TLS limitations.
2017-10-30 19:50:57 +02:00
f599a38059
docs/esp8266/quickref: Add quickref info for RTC class.
2017-10-10 15:22:23 +11:00
9e0cdb22f1
docs/esp8266/tutorial: Update neopixel with example of using 4 bbp.
2017-10-04 10:35:22 +11:00
d003daee06
docs/esp8266/tutorial: Fix typo, "its" to "it's" in powerctrl.rst.
2017-07-24 10:33:03 +10:00
205c368fa1
eps8266/general: Fix typo in recent example.
2017-07-21 12:08:18 +03:00
6ede921731
eps8266/general: Add known issue of WiFi RX buffers overflow.
2017-07-21 10:19:17 +03:00
45b127e7ac
docs/esp8266/general.rst: Fix name of NTP module.
...
The simple NTP client module is named "ntptime.py".
2017-07-02 20:02:19 -05:00
0a54b6dce9
docs/esp8266/tutorial/intro: Fix some grammatical typos.
2017-06-26 15:12:48 +10:00
beb94b6efc
docs/esp8266/tutorial/intro: Sphinx requires blank lines around literal blocks.
...
At least, Sphinx 1.3.6.
2017-06-23 22:04:33 +03:00
51668dffaa
docs/esp8266/tutorial/intro: Discourage use of 512kb firmwares.
...
This follows similar warnings in other parts of docs.
2017-06-23 22:00:40 +03:00
22ca5390f7
docs/esp8266/quickref: Polish Pin.on()/off() examples.
2017-06-02 21:08:23 +03:00
272a5d95e0
docs/esp8266: Consistently replace Pin.high/low methods with .on/off.
2017-05-30 07:36:25 +03:00
daa5ba5629
docs/esp8266/quickref: Add links from quickref page to machine classes.
2017-04-18 15:28:18 +10:00
a1c39ffb69
docs/esp8266/tutorial/intro: Reword section on flash size requirement.
...
Give a clearly dissuading tone on end users trying 512KB version
- it has to many end-usery features lacking.
2017-04-14 01:12:04 +03:00
e5278b98fe
docs/esp8266/general: Start explicit "Known Issues", mentioned RTC inaccuracy.
2017-04-07 10:52:50 +03:00
e73a0b944f
docs/esp8266/tutorial: Update since esptool 1.3 added Python 3 support.
...
esptool 1.3 now supports both Python 2.7 and 3.4+.
Updated github link to now-official espressif repo.
2017-03-07 18:23:24 +11:00
3217bbe491
docs/esp8266/tutorial: Specify the baudrate in picocom example command.
2017-02-07 16:58:43 +11:00
52c19875a4
esp8266/general: Add "Scarcity of runtime resources" section.
...
With warnings of need to close files, sockets, etc.
2017-01-04 10:33:48 +03:00
e1f495a4bd
docs/esp8266/tutorial: Close socket after reading page content.
2017-01-04 11:15:02 +11:00
71ff0b549d
docs/esp8266/tutorial: Update intro to add Getting the firmware section.
...
Add a "Getting the firmware" section to better describe how to get hold of
the MicroPython firmware, especially if you have a 512kb module.
2016-12-30 14:27:02 +11:00
5630778f0f
esp8266: Update docs for esptool 1.2.1/SDK 2.0 (--flash_size=detect).
2016-11-08 04:52:07 +03:00
933198c55f
docs/*/quickref.rst: Use new semantics of ticks_diff()
2016-11-08 02:01:05 +03:00
5c3d75c937
docs/esp8266: Update for new WebREPL setup procedure.
2016-11-06 10:02:33 +03:00
b4df3e74e1
docs/esp8266/quickref: Further improvements for SPI subsections.
...
Consistency and formatting.
2016-09-04 23:31:05 +03:00
20da9064d7
docs/esp8266/quickref: Update information on SPI classes.
...
SPI(1) is not used for hardware SPI. Few more details are provided.
2016-09-04 21:13:55 +03:00
76dcaddc0f
docs/esp8266/quickref: Add internal links to docs for some modules.
2016-08-29 17:40:36 +10:00
13c5a228c9
docs/esp8266: Update quickref and tutorial for OneWire/DS18X20 driver.
2016-08-29 12:52:50 +10:00
ed0a06a93f
docs/esp8266/quickref: Fix and update the SPI docs
...
Use the `SPI` factory function in the examples, and use
proper baud rate of 80 000 000.
2016-08-28 23:14:45 +10:00
8e7dfea803
esp8266/modpybhspi: Add a HSPI module for hardware SPI support
...
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-19 21:19:59 +03:00
5e01fb01b3
docs/esp8266/intro: Add command to install esptool.py 1.0.1 via pip.
...
It used a standard BootROM programming algo and may be useful as a
fallback.
2016-08-10 21:40:40 +03:00
2146cdab5e
docs/esp8266/tutorial/pins: Fix typo in commands for pin input mode.
2016-08-09 21:13:27 +03:00
3e5534caf7
docs/esp8266/intro: Focus on hazards of unearthed power wrt electronics.
2016-08-07 22:41:34 +03:00
d2cab0b7be
docs/esp8266/tutorial/intro: Add anchor for link from quickeref.
2016-08-07 22:16:40 +03:00
f84dda7111
docs/esp8266/quickref: Link to installation instructions.
2016-08-07 17:46:27 +03:00
a9923d190e
docs/esp8266/intro: Add troubleshooting section.
...
Tries to summarize most of the issues we've seen so far.
2016-08-07 17:28:33 +03:00
919c54f750
docs/esp8266/intro: Rename to "Getting started" from "Introduction".
...
People tend to skip introductions (everyone knows what esp8266 is, right?),
so try to do A/B testing with a title inviting to read it.
2016-08-07 17:28:23 +03:00
1966745689
esp8266/tutorial/intro: Reword para abou -fm dio switch.
...
Not all NodeMCU boards require it.
2016-08-07 16:31:09 +03:00
ce166e6b68
docs: Spelling mistakes
2016-08-02 11:17:46 +03:00
b4564841b6
docs: Add DHT to ESP8266 Quick Ref and Tutorial
2016-08-01 14:39:57 +03:00
0b913bd09f
docs/esp8266/tutorial/network_basics: Minor typo fix, ap becomes ap_if.
2016-06-06 10:08:30 +01:00
3f6ca4b22c
docs/esp8266/general: Add note about RTC overflow.
2016-06-03 14:37:49 +01:00
d8cc51ea2b
docs/esp8266/quickref: Update WebREPL section for 1.8.1 release.
...
WebREPL is much more stable now.
2016-06-02 20:11:40 +03:00
9a1a49ceec
esp8266/general: Typo/grammar fixes.
2016-06-01 23:16:17 +03:00
Damien George
jcea
Olivier Ortigues
Ryan Finnie
Paul Sokolovsky
Mike Causer
Gabe
Matthew Brener
Peter Hinch
Patrick O'Leary
James Ouyang
Max
Andrew Mulholland
puuu
Radomir Dopieralski
Ben Hagen