Lerking/micropython
1
0
Fork 0
mirror of https://github.com/micropython/micropython.git synced 2026-01-04 11:10:14 +01:00
Code Issues Actions 52 Packages Projects Releases Wiki Activity
17,958 Commits 6 Branches 72 Tags
0b1a6bebae857053a0c6cc865e3ca38a8f5f28df
Commit Graph

114 Commits

Author SHA1 Message Date
Chris Webb
b9523fd58c docs: Document the cross-port Timer hard= option. 
Update the main machine.Timer specification, and any references to
hard/soft interrupts in port-specific documentation. There is a separate
copy of the machine.Timer documentation for the pyboard, so update that
too to keep everything consistent.

Signed-off-by: Chris Webb <chris@arachsys.com>
 2025-09-25 23:59:24 +10:00
Ronald Weber
3f0dd13d93 docs: Fix double 'the' in documentation.
Some checks are pending
JavaScript code lint and formatting with Biome / eslint (push) Waiting to run
Details
Check code formatting / code-formatting (push) Waiting to run
Details
Check spelling with codespell / codespell (push) Waiting to run
Details
Build docs / build (push) Waiting to run
Details
Check examples / embedding (push) Waiting to run
Details
Package mpremote / build (push) Waiting to run
Details
.mpy file format and tools / test (push) Waiting to run
Details
Build ports metadata / build (push) Waiting to run
Details
cc3200 port / build (push) Waiting to run
Details
esp32 port / build_idf (esp32_build_cmod_spiram_s2) (push) Waiting to run
Details
esp32 port / build_idf (esp32_build_s3_c3) (push) Waiting to run
Details
esp8266 port / build (push) Waiting to run
Details
mimxrt port / build (push) Waiting to run
Details
nrf port / build (push) Waiting to run
Details
powerpc port / build (push) Waiting to run
Details
qemu port / build_and_test_arm (push) Waiting to run
Details
qemu port / build_and_test_rv32 (push) Waiting to run
Details
renesas-ra port / build_renesas_ra_board (push) Waiting to run
Details
rp2 port / build (push) Waiting to run
Details
samd port / build (push) Waiting to run
Details
stm32 port / build_stm32 (stm32_misc_build) (push) Waiting to run
Details
stm32 port / build_stm32 (stm32_nucleo_build) (push) Waiting to run
Details
stm32 port / build_stm32 (stm32_pyb_build) (push) Waiting to run
Details
unix port / minimal (push) Waiting to run
Details
unix port / reproducible (push) Waiting to run
Details
unix port / standard (push) Waiting to run
Details
unix port / standard_v2 (push) Waiting to run
Details
unix port / coverage (push) Waiting to run
Details
unix port / coverage_32bit (push) Waiting to run
Details
unix port / nanbox (push) Waiting to run
Details
unix port / float (push) Waiting to run
Details
unix port / stackless_clang (push) Waiting to run
Details
unix port / float_clang (push) Waiting to run
Details
unix port / settrace (push) Waiting to run
Details
unix port / settrace_stackless (push) Waiting to run
Details
unix port / macos (push) Waiting to run
Details
unix port / qemu_mips (push) Waiting to run
Details
unix port / qemu_arm (push) Waiting to run
Details
unix port / qemu_riscv64 (push) Waiting to run
Details
webassembly port / build (push) Waiting to run
Details
windows port / build-vs (Debug, x64, windows-2022, dev, 2022, [17, 18)) (push) Waiting to run
Details
windows port / build-vs (Debug, x64, windows-latest, dev, 2017, [15, 16)) (push) Waiting to run
Details
windows port / build-vs (Debug, x86, windows-2022, dev, 2022, [17, 18)) (push) Waiting to run
Details
windows port / build-vs (Debug, x86, windows-latest, dev, 2017, [15, 16)) (push) Waiting to run
Details
windows port / build-vs (Release, x64, windows-2019, dev, 2019, [16, 17)) (push) Waiting to run
Details
windows port / build-vs (Release, x64, windows-2019, standard, 2019, [16, 17)) (push) Waiting to run
Details
windows port / build-vs (Release, x64, windows-2022, dev, 2022, [17, 18)) (push) Waiting to run
Details
windows port / build-vs (Release, x64, windows-2022, standard, 2022, [17, 18)) (push) Waiting to run
Details
windows port / build-vs (Release, x64, windows-latest, dev, 2017, [15, 16)) (push) Waiting to run
Details
windows port / build-vs (Release, x64, windows-latest, standard, 2017, [15, 16)) (push) Waiting to run
Details
windows port / build-vs (Release, x86, windows-2019, dev, 2019, [16, 17)) (push) Waiting to run
Details
windows port / build-vs (Release, x86, windows-2019, standard, 2019, [16, 17)) (push) Waiting to run
Details
windows port / build-vs (Release, x86, windows-2022, dev, 2022, [17, 18)) (push) Waiting to run
Details
windows port / build-vs (Release, x86, windows-2022, standard, 2022, [17, 18)) (push) Waiting to run
Details
windows port / build-vs (Release, x86, windows-latest, dev, 2017, [15, 16)) (push) Waiting to run
Details
windows port / build-vs (Release, x86, windows-latest, standard, 2017, [15, 16)) (push) Waiting to run
Details
windows port / build-mingw (i686, mingw32, dev) (push) Waiting to run
Details
windows port / build-mingw (i686, mingw32, standard) (push) Waiting to run
Details
windows port / build-mingw (x86_64, mingw64, dev) (push) Waiting to run
Details
windows port / build-mingw (x86_64, mingw64, standard) (push) Waiting to run
Details
windows port / cross-build-on-linux (push) Waiting to run
Details
zephyr port / build (push) Waiting to run
Details
Python code lint and formatting with ruff / ruff (push) Waiting to run
Details 
Signed-off-by: Ronald Weber <ronaldxweber@gmail.com>
 2025-02-25 17:07:16 +11:00
robert-hh
b5de529ffc docs: Fix the quickref documentation of rtc.datetime(). 
Such that it matches the implementation and the documentation of the
`machine.RTC` class.

Signed-off-by: robert-hh <robert@hammelrath.com>
 2024-12-19 16:00:15 +11:00
Angus Gratton
0e7c3901b8 docs: Add a "Reset and Boot Sequence" reference page. 
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-19 10:57:26 +11:00
Angus Gratton
48f96e9660 docs: Specify the recommended network.WLAN.IF_[AP|STA] constants. 
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-11-08 10:11:03 +11:00
Felix Dörre
4d16a9cced docs: Update docs to replace ifconfig with ipconfig. 
Follow up to 1c6012b0b5

Signed-off-by: Felix Dörre <felix@dogcraft.de>
 2024-07-05 16:06:04 +10:00
Damien George
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
Jim Mussared
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
iabdalkader
6e868d47dc docs: Update to use new WLAN argument names for ssid/security/key. 
Addresses issue #8083.
 2022-06-17 21:43:44 +10:00
Damien George
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
Damien George
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
gibbonsc
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
Fernando
4954290e86 docs/esp8266: Use monospace for software tools. 
Signed-off-by: Fernando <fepegar@gmail.com>
 2021-08-30 23:51:27 +10:00
Jim Mussared
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
David P
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
finefoot
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
Mike Causer
97fee47716 docs/esp8266: Add SSD1306 to quickref and tutorial. 2021-05-14 12:04:21 +10:00
Mike Causer
d43ed087ae docs/esp8266: Mention Signal in GPIO section of quickref. 2021-05-14 12:02:01 +10:00
Mike Causer
64aebed70e docs/esp8266: Add WDT to quickref. 2021-05-06 15:50:42 +10:00
Mike Causer
31ac410a4f docs: Fix some spelling mistakes. 2021-05-04 22:58:00 +10:00
Mordy Ovits
d70ab87b2b docs/esp8266: Clarify limitations of SSL in esp8266 and fix typos. 2021-05-04 15:15:34 +10:00
Damien George
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
Chris Liechti
4154ffbcba docs/esp8266: Add note about simultaneous use of STA_IF and AP_IF. 
See also https://github.com/esp8266/Arduino/issues/1624
 2021-05-04 13:48:53 +10:00
Christopher Tse
ddb53c9458 docs/esp8266/quickref: Add warning block about NeoPixel timing. 2021-01-30 14:36:30 +11:00
Damien George
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
Nick Crabtree
2934e41df0 docs/esp8266: Add quickref documentation for UART on esp8266. 
This patch adds quickref documentation for the change in commit
afd0701bf7.  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-06-10 22:46:09 +10:00
Jesse Andrews
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
ketograph
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
Damien George
90c524c114 docs: Remove spaces on lines that are empty. 2019-12-04 15:02:54 +11:00
Mike Causer
a2c4cb484d docs: Fix spelling in various parts of the docs. 2019-10-16 14:08:28 +11:00
Mike Causer
5a8f392f09 docs/esp8266: Add ntptime usage to esp8266 quickref. 2019-10-16 14:08:13 +11:00
Thiago Paes
5463ab6df6 docs/esp8266/tutorial: Make http_get sample function self contained. 2019-10-16 13:52:04 +11:00
Mike Causer
6323cbda4f docs/esp8266: Add tutorial for APA102 LEDs. 2019-05-07 11:45:10 +10:00
Damien George
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
jcea
5731e535dd docs/esp8266: Fix minor typo in "certificates". 2018-06-25 17:36:28 +10:00
Olivier Ortigues
298b325f3e docs/esp8266: Add a note concerning GPIO16 pull capabilities. 2018-02-15 11:15:12 +11:00
Olivier Ortigues
d072573226 docs/esp8266: Update PWM doc regarding clipping of min/max values. 2018-02-15 11:14:34 +11:00
Ryan Finnie
1e2b78111b docs/esp8266/tutorial: Fix typo, change -> changed. 2017-12-13 17:30:02 +11:00
Paul Sokolovsky
1742ab2653 docs/esp8266/general: Minor grammar fixes. 2017-11-02 00:38:58 +02:00
Paul Sokolovsky
58c785632f docs/esp8266/general: TLS limitations: Mention also "ussl" module limitations. 2017-11-01 08:59:42 +02:00
Paul Sokolovsky
4dd523adbb docs/esp8266/general: Add section on TLS limitations. 2017-10-30 19:50:57 +02:00
Mike Causer
f599a38059 docs/esp8266/quickref: Add quickref info for RTC class. 2017-10-10 15:22:23 +11:00
Gabe
9e0cdb22f1 docs/esp8266/tutorial: Update neopixel with example of using 4 bbp. 2017-10-04 10:35:22 +11:00
Matthew Brener
d003daee06 docs/esp8266/tutorial: Fix typo, "its" to "it's" in powerctrl.rst. 2017-07-24 10:33:03 +10:00
Paul Sokolovsky
205c368fa1 eps8266/general: Fix typo in recent example. 2017-07-21 12:08:18 +03:00
Peter Hinch
6ede921731 eps8266/general: Add known issue of WiFi RX buffers overflow. 2017-07-21 10:19:17 +03:00
Patrick O'Leary
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
Damien George
0a54b6dce9 docs/esp8266/tutorial/intro: Fix some grammatical typos. 2017-06-26 15:12:48 +10:00
Paul Sokolovsky
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
Paul Sokolovsky
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