b1229efbd1
all: Fix spelling mistakes based on codespell check.
...
Signed-off-by: Damien George <damien@micropython.org>
2023-04-27 18:03:06 +10:00
924a3e03ec
top: Replace upip with mip everywhere.
...
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-09-30 17:34:03 +10:00
6e868d47dc
docs: Update to use new WLAN argument names for ssid/security/key.
...
Addresses issue #8083 .
2022-06-17 21:43:44 +10:00
d9d67adef1
docs: Remove trailing spaces and convert tabs to spaces.
...
Signed-off-by: Damien George <damien@micropython.org>
2021-12-15 11:49:22 +11:00
de8dc4bad2
docs/esp8266/tutorial: Fix comments of FrameBuffer examples.
...
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-11-25 23:34:19 +11:00
4954290e86
docs/esp8266: Use monospace for software tools.
...
Signed-off-by: Fernando <fepegar@gmail.com>
2021-08-30 23:51:27 +10:00
e10a044d7c
docs/esp8266/tutorial: Change flash mode from dio to dout.
...
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-07-07 21:15:58 +10:00
97fee47716
docs/esp8266: Add SSD1306 to quickref and tutorial.
2021-05-14 12:04:21 +10:00
2bf1beef5c
docs/esp8266: Add instructions on entering programming mode manually.
...
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-04 14:24:40 +10:00
c4ea4c1810
docs/esp8266: In TCP tutorial, add HTTP response code and content-type.
...
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.
2020-02-03 23:50:09 +11:00
90c524c114
docs: Remove spaces on lines that are empty.
2019-12-04 15:02:54 +11:00
5463ab6df6
docs/esp8266/tutorial: Make http_get sample function self contained.
2019-10-16 13:52:04 +11:00
6323cbda4f
docs/esp8266: Add tutorial for APA102 LEDs.
2019-05-07 11:45:10 +10:00
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
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
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
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
272a5d95e0
docs/esp8266: Consistently replace Pin.high/low methods with .on/off.
2017-05-30 07:36:25 +03: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
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
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
5c3d75c937
docs/esp8266: Update for new WebREPL setup procedure.
2016-11-06 10:02:33 +03:00
13c5a228c9
docs/esp8266: Update quickref and tutorial for OneWire/DS18X20 driver.
2016-08-29 12:52:50 +10: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
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
9b4502b7e8
docs/esp8266/tutorial: Fix typo in do_connect() network example.
...
Fixes issue #2065 .
2016-05-11 13:40:28 +01:00
c156e89379
Fix ESP8266 Network tutorial
...
The socket should either connect to `addr` or `addr_info[0][-1]`. Not to `addr[0][-1]`.
2016-05-07 23:24:24 -07:00
56fd33a6dd
docs/esp8266/tutorial: Change name of ESP8266 firmware to match actual.
2016-05-03 16:42:52 +01:00
c68c327310
docs/esp8266/tutorial/repl: Reword description of initial WebREPL setup a bit.
2016-05-03 18:40:16 +03:00
1f396c58d9
docs/esp8266/tutorial/repl: Suggest using hosted WebREPL client.
...
At http://micropython.org/webrepl .
2016-05-03 18:35:43 +03:00
5d05993f10
esp8266/tutorial: Mention that esptool is available via pip.
2016-05-03 14:05:50 +01:00
8af64bcf2b
docs/esp8266/tutorial: Update pins tutorial to reflect changes in API.
2016-05-03 13:56:15 +01:00
879bc4197a
docs/esp8266: Add ESP8266 tutorial.
2016-05-03 01:39:04 +01:00
5c8147528e
docs/esp8266/tutorial: Add tutorial placeholder page.
2016-04-22 22:37:02 +03:00
Damien George
Jim Mussared
iabdalkader
gibbonsc
Fernando
finefoot
Mike Causer
Jesse Andrews
Damien George
Thiago Paes
Olivier Ortigues
Ryan Finnie
Gabe
Matthew Brener
Paul Sokolovsky
James Ouyang
Max
Andrew Mulholland
Ben Hagen
Paulus Schoutsen