6e868d47dc
docs: Update to use new WLAN argument names for ssid/security/key.
...
Addresses issue #8083 .
2022-06-17 21:43:44 +10:00
326b2c79df
docs: Remove reference to obsolete neopixel_write function.
...
It has been replaced by machine.bitstream.
Signed-off-by: Damien George <damien@micropython.org>
2022-02-02 16:27:10 +11:00
c737cde947
docs: Replace ufoo with foo in all docs.
...
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-08-13 22:53:29 +10:00
fdd5b18133
docs: Replace master/slave with controller/peripheral in I2C and SPI.
...
See https://www.oshwa.org/a-resolution-to-redefine-spi-signal-names
2021-07-18 11:19:44 +10:00
97fee47716
docs/esp8266: Add SSD1306 to quickref and tutorial.
2021-05-14 12:04:21 +10:00
d43ed087ae
docs/esp8266: Mention Signal in GPIO section of quickref.
2021-05-14 12:02:01 +10:00
64aebed70e
docs/esp8266: Add WDT to quickref.
2021-05-06 15:50:42 +10:00
31ac410a4f
docs: Fix some spelling mistakes.
2021-05-04 22:58:00 +10:00
ddb53c9458
docs/esp8266/quickref: Add warning block about NeoPixel timing.
2021-01-30 14:36:30 +11:00
98182a97c5
docs: Update I2C and SPI docs to add reference to SoftI2C and SoftSPI.
...
Signed-off-by: Damien George <damien@micropython.org>
2020-10-01 12:57:10 +10:00
2934e41df0
docs/esp8266: Add quickref documentation for UART on esp8266.
...
This patch adds quickref documentation for the change in commit
afd0701bf7
2020-06-10 22:46:09 +10:00
04e7aa0563
docs/esp8266/quickref: Add note that machine.RTC is not fully supported.
...
See issues #3220 and #3710 .
2019-12-17 12:19:27 +11:00
a2c4cb484d
docs: Fix spelling in various parts of the docs.
2019-10-16 14:08:28 +11:00
5a8f392f09
docs/esp8266: Add ntptime usage to esp8266 quickref.
2019-10-16 14:08:13 +11: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
f599a38059
docs/esp8266/quickref: Add quickref info for RTC class.
2017-10-10 15:22:23 +11: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
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
f84dda7111
docs/esp8266/quickref: Link to installation instructions.
2016-08-07 17:46:27 +03:00
b4564841b6
docs: Add DHT to ESP8266 Quick Ref and Tutorial
2016-08-01 14:39:57 +03: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
fdf45a718b
esp8266/quickref: Use local image of Adafruit Huzzah board.
...
Using remote image causes problems with tools (partly because the image
is semi-firewalled and can't be accessed by arbitrary tools).
2016-06-01 23:11:49 +03:00
a0a08b4be1
esp8266: Add APA102 serial individually controllable LEDs support.
...
APA102 is a new "smart LED", similar to WS2812 aka "Neopixel".
2016-05-19 22:29:11 +03:00
ccb00b7724
docs/esp8266/quickstart: remove i2c examples with stop=False
...
Since the ``stop`` parameter has been dropped.
2016-05-14 00:02:02 +02:00
e89413e9b0
docs/esp8266/quickref: New way to get MAC address
2016-05-10 00:31:57 +02:00
d46cd02d95
docs/esp8266/quickref: Add info about WebREPL.
2016-05-01 11:41:46 +03:00
348edad888
docs/esp8266: Update quickref to reflect changes to 1-wire and NeoPixel.
2016-04-28 14:31:37 +01:00
fcc9d43c6d
docs/esp8266: Add info about using deep-sleep mode to quickref.
2016-04-21 12:01:50 +01:00
e4cb7c6158
docs/esp8266/quickref: Add note about physical vs logical pin numbers.
2016-04-05 16:30:51 +03:00
0cb10b5220
docs/esp8266/quickref: Add note about GPIO16.
2016-03-25 16:48:15 +02:00
159f1aaca8
docs/esp8266/quickref: Note that timers supported are virtual ones.
2016-03-25 16:44:13 +02:00
2466cb67f8
docs/esp8266: Update quick reference: i2c.readfrom and neopixel example.
2016-03-16 13:37:39 +00:00
6b80ebe32e
docs/esp8266: Fix indent errors, typos, and add info about REPL UART.
2016-03-09 13:01:32 +00:00
4b6077b3fe
docs/esp8266: Minor tweaks to quickref, Timer and I2C classes.
2016-03-09 11:02:38 +00:00
809fbeefb7
docs: Add esp8266 quick reference page, with basic info.
2016-03-08 23:06:15 +00:00
iabdalkader
Damien George
Jim Mussared
David P
Mike Causer
Christopher Tse
Nick Crabtree
ketograph
Damien George
Paul Sokolovsky
puuu
Radomir Dopieralski
misterdanb