summaryrefslogtreecommitdiffstatshomepage
path: root/docs/wipy
Commit message (Collapse)AuthorAge
* docs: Add a "Reset and Boot Sequence" reference page.Angus Gratton2024-11-19
| | | | | | | | | | | | 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>
* docs: Update docs to replace ifconfig with ipconfig.Felix Dörre2024-07-05
| | | | | | Follow up to 1c6012b0b5c62f18130217f30e73ad3ce4c8c9e6 Signed-off-by: Felix Dörre <felix@dogcraft.de>
* docs: Use vfs module instead of os.Damien George2024-02-07
| | | | Signed-off-by: Damien George <damien@micropython.org>
* docs: Use the correct * keyword-only notation.Jos Verlinde2022-02-09
|
* docs: Remove trailing spaces and convert tabs to spaces.Damien George2021-12-15
| | | | Signed-off-by: Damien George <damien@micropython.org>
* docs: Replace ufoo with foo in all docs.Jim Mussared2021-08-13
| | | | | | | | | | | | | | | | | | | | | | 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>
* docs: Replace master/slave with controller/peripheral in I2C and SPI.David P2021-07-18
| | | | See https://www.oshwa.org/a-resolution-to-redefine-spi-signal-names
* docs: Remove spaces on lines that are empty.Damien George2019-12-04
|
* docs/wipy/tutorial: Link Blynk examples to the official library.Volodymyr Shymanskyy2019-10-16
|
* docs: Rename machine.ADC docs to machine.ADCWiPy.Damien George2019-09-04
| | | | | To signify that this ADC documentation is specific to the WiPy, and to make way for a standardised ADC documentation.
* all: Change PYB message prefix to MPY.Mike Causer2019-02-12
| | | | | | | | Replaces "PYB: soft reboot" with "MPY: soft reboot", etc. Having a consistent prefix across ports reduces the difference between ports, which is a general goal. And this change won't break pyboard.py because that tool only looks for "soft reboot".
* docs: Convert all cases of machine.sleep to machine.lightsleep.Damien George2019-01-30
|
* docs/wipy: Fix links to network.Server, and markup for boot.py.Damien George2018-10-01
|
* docs: Unify all the ports into one set of documentation.Damien George2018-10-01
| | | | | | | | | 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.
* docs: Move WiPy specific Timer class to separate doc file.Damien George2018-07-31
| | | | | | | | | | | | | | | The WiPy machine.Timer class is very different to the esp8266 and esp32 implementations which are better candidates for a general Timer class. By moving the WiPy Timer docs to a completely separate file, under a new name machine.TimerWiPy, it gives a clean slate to define and write the docs for a better, general machine.Timer class. This is with the aim of eventually providing documentation that does not have conditional parts to it, conditional on the port. While the new docs are being defined it makes sense to keep the WiPy docs, since they describe its behaviour. Once the new Timer behaviour is defined the WiPy code can be changed to match it, and then the TimerWiPy docs would be removed.
* docs/uos: Move cc3200 port legacy VFS mounting functions to its ref doc.Paul Sokolovsky2017-06-03
| | | | | This patch also unconditionalizes uos.dupterm(), though exact interface and semantics is yet to be defined.
* docs/uos: Deconditionalize, remove minor port-specific details.Paul Sokolovsky2017-06-03
| | | | | | | | | For a couple of ports, there was information which directory is set as current after boot. This information doesn't belong to "uos" module, and is moved to boards' references (which actually already contained information on which directory is chosen for boot, even if without explicit mentioning that it becomes current directory, which is now done).
* docs/network: Move confusingly-named cc3200 Server class to its reference.Paul Sokolovsky2017-06-03
| | | | | cc3200 port has network.Server class to control behavior of builtin Telnet/FTP server of that port.
* docs/wipy/general: Add section about specifics of I2C implementation.Damien George2017-04-18
|
* docs/wipy/quickref: Update reference for change to I2C API.Damien George2017-04-18
|
* docs/machine: Move machine.main() misnomer to wipy's known issues.Paul Sokolovsky2017-04-16
|
* docs/library/ussl: Deconditionalize, wipy notes moved to its documentation.Paul Sokolovsky2017-04-16
|
* docs/uhashlib: Deconditionalize.Paul Sokolovsky2017-04-09
| | | | | Notes on WiPy incompatibilities with the standard module API are moved under "Known issues" to its documentation.
* docs/usocket: Deconditionalize.Paul Sokolovsky2017-04-09
| | | | | Notes on WiPy incompatibilities with the standard socket module API are moved under "Known issues" to its documentation.
* docs/machine.Pin: Move wipy-specific methods to its docs.Paul Sokolovsky2017-04-05
|
* docs/machine.Pin: Move wipy-specific details to its own docs.Paul Sokolovsky2017-04-05
|
* docs/machine.Timer: Move WiPy adhoc parts to its documentation.Paul Sokolovsky2017-01-28
|
* docs: Fix some minor spelling mistakes.Mike Causer2017-01-18
| | | | | | | | paramter -> parameter send a receive -> send and receive repsonse -> response particualr -> particular constructore -> constructor
* docs/wipy: Correct deep sleep current figure.daniel2016-10-10
|
* Small WiPy doc fixesjuhasch2016-09-18
|
* docs: Spelling mistakesMike Causer2016-08-02
|
* docs/wipy/tutorial: Add note about screen key bindings on OS X.Marcel Stör2016-06-02
|
* docs/machine: idle() description generalization.Paul Sokolovsky2016-05-03
|
* docs/machine: More generic description of sleep's, WiPy details to its genref.Paul Sokolovsky2016-05-03
|
* docs/machine: Move WiPy-specific hardware details to its general reference.Paul Sokolovsky2016-05-03
|
* docs: Correct machine.Timer code examples related to duty cycle.danicampora2016-02-23
|
* cc3200: Rename 'server' class to 'Server' for consistency.danicampora2016-02-22
|
* cc3200: Simplify the Timer API and correct the documents.danicampora2016-02-21
| | | | | | Make the PWM duty cycle configurable from 0.00 to 100.00 by accepting values from 0 to 10000. Add automatic Pin assignment when operating in PWM mode.
* docs/wipy: Make wifi/wlan naming consistent with tutorial.rst.Chris Liechti2015-11-18
|
* docs/wipy: Add warning about losing wlan connection when changing mode.Jason Hildebrand2015-11-18
| | | | | Also provide workarounds, link to other revelant sections, and fix some typos.
* docs/wipy: Fixed some typos in the WiPy's tutorials.Dave Hylands2015-11-18
|
* docs/wipy: Fix bug in example code and add note regarding OTA.danicampora2015-10-26
|
* docs/wipy: Fix several typos and change some pyboard to WiPy.Martijn Koster2015-10-26
|
* docs/wipy: Fix several typos.Martijn Koster2015-10-25
|
* docs/wipy: Fix error in WLAN quickref.danicampora2015-10-25
|
* docs: Fix typos on wipy docs.danicampora2015-10-22
|
* docs/wipy: Correct typo in safe boot description.danicampora2015-10-22
|
* docs/wipy: Remove windows instructions that refer to the pyboard.danicampora2015-10-21
|
* docs/wipy: Fix formatting indentation.danicampora2015-10-21
|
* docs/wipy: Remove incorrect references to usb configuration.danicampora2015-10-21
|
generated by cgit v1.2.3 (git 2.39.1) at 2025-04-30 21:48:27 +0000