summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2019-07-31docs/library/framebuf: Add missing module reference in example code.Arsenijs
2019-07-19esp32: Add support for hardware I2C.Damien George
2019-07-17py/scheduler: Rename sched_stack to sched_queue.Jim Mussared
Behaviour was changed from stack to queue in 8977c7eb581f5d06500edb1ea29aea5cbda04f28, and this updates variable names to match. Also updates other references (docs, error messages).
2019-06-17esp32/machine_sdcard: Fix bug in SPI slot number selection.Nicko van Someren
And fix minor typo in docs when referring to SDCard class.
2019-06-03docs/machine: Add initial docs for new machine.SDCard class.Nicko van Someren
2019-05-29all: Bump version to 1.11.v1.11Damien George
2019-05-20docs/pyboard/quickref: Refer to new machine.I2C instead of old pyb.I2C.Damien George
On stm32 boards, machine.I2C is now preferred over pyb.I2C.
2019-05-20docs/machine.I2C: Add writevto method to write a vector of byte bufs.Damien George
This allows to efficiently send to an I2C slave data that is made up of more than one buffer. Instead of needing to allocate temporary memory to combine buffers together this new method allows to pass in a tuple or list of buffers. The name is based on the POSIX function writev() which has similar intentions and signature. The reasons for taking this approach (compared to having an interface with separate start/write/stop methods) are: - It's a backwards compatible extension. - It's convenient for the user. - It's efficient because there is only one Python call, then the C code can do everything in one go. - It's efficient on the I2C bus because the implementation can do everything in one go without pauses between blocks of bytes. - It should be possible to implement this extension in all ports, for hardware and software I2C. Further discussion is found in issue #3482, PR #4020 and PR #4763.
2019-05-10docs/esp32: Correct quickref for ESP32 hardware SPI with non-default IO.Nicko van Someren
2019-05-07stm32/machine_uart: Change default UART timeout to 0, for non blocking.Damien George
It's more common to need non-blocking behaviour when reading from a UART, rather than having a large timeout like 1000ms (the original behaviour). With a large timeout it's 1) likely that the function will read forever if characters keep trickling it; or 2) the function will unnecessarily wait when characters come sporadically, eg at a REPL prompt.
2019-05-07docs/esp8266: Add tutorial for APA102 LEDs.Mike Causer
2019-05-06extmod/moducryptolib: Add AES-CTR support.Yonatan Goldschmidt
Selectable at compile time via MICROPY_PY_UCRYPTOLIB_CTR. Disabled by default.
2019-04-18docs/cmodules: Note the various ways MODULE_EXAMPLE_ENABLED can be set.Daniel O'Connor
2019-04-15docs/cmodules: Fix example to globally define MODULE_EXAMPLE_ENABLED.Daniel O'Connor
MODULE_EXAMPLE_ENABLED must be globally defined for the module to be seen and referenced by all parts of the code.
2019-03-29docs/develop: Remove paragraph that was copied in error from other doc.Damien George
2019-03-28docs/esp32: Add example for pin isolation in combination with deepsleep.spacemanspiff2007
2019-03-14docs/esp32: Add a note to quickref about use of Pin.PULL_HOLD.Damien George
2019-03-14docs/library/machine.Pin: Add PULL_HOLD constant to possible pin pulls.Damien George
As already mentioned in the docs, not all constants may be available on all ports, so this is optional to implement.
2019-03-13docs/develop: Fix typos in C-module example for example_add_ints.Martin Fischer
2019-03-13docs/pyboard: Make pyboard v1.1 pinout the default shown in quickref.johnthagen
2019-03-13docs/pyboard: Add link to pyboard v1.1 schematic and layout PDF.johnthagen
2019-03-08py: Update and rework build system for including external C modules.Andrew Leech
How to use this feature is documented in docs/develop/cmodules.rst.
2019-03-08py: Implement a module system for external, user C modules.Ayke van Laethem
This system makes it a lot easier to include external libraries as static, native modules in MicroPython. Simply pass USER_C_MODULES (like FROZEN_MPY_DIR) as a make parameter.
2019-02-26docs/uos: Document extra requirements on stream objs passed to dupterm.Yonatan Goldschmidt
This is only correct for the extmod/uos_dupterm.c implementation however, as e.g cc3200 implementation does the mp_load_method() itself, and anyway requires `read` instead of `readinto`.
2019-02-12all: Change PYB message prefix to MPY.Mike Causer
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".
2019-02-08docs/ure: Fix match.group signature to indicate index param is required.Yonatan Goldschmidt
2019-01-30docs: Convert all cases of machine.sleep to machine.lightsleep.Damien George
2019-01-27docs/machine: Change sleep to lightsleep and add timeout arguments.Damien George
The machine.sleep() function can be misleading because it clashes with time.sleep() which has quite different semantics. So change it to machine.lightsleep() which shows that it is closer in behaviour to machine.deepsleep(). Also, add an optional argument to these two sleep functions to specify a maximum time to sleep for. This is a common operation and underlying hardware usually has a special way of performing this operation. The existing machine.sleep() function will remain for backwards compatibility purposes, and it can simply be an alias for machine.lightsleep() without arguments. The behaviour will be the same.
2019-01-26all: Bump version to 1.10.v1.10Damien George
2019-01-25docs/library: Add documentation for esp32 module.Damien George
2019-01-25docs: Add initial docs for esp32 port, including quick-ref and general.Matt Trentini
With contributions from Oliver Robson (@HowManyOliversAreThere), Sean Lanigan (@seanlano) and @rprr.
2019-01-11docs/differences: Clarify the differences are against Python 3.4.stijn
2018-12-13docs/ure: Fully describe supported syntax subset, add example.Paul Sokolovsky
2018-12-11docs/README: Remove references to MICROPY_PORT when building docs.Damien George
The docs are now built as one for all ports.
2018-10-23docs/conf.py: Use https for intersphinx link to docs.python.org.Paul Sokolovsky
To get rid of warning when building the docs saying there's a redirect from http: to https:.
2018-10-23docs/library/uctypes: Add examples and make general updates.Paul Sokolovsky
Examples are added to the beginning of the module docs, similarly to docs for many other modules. Improvements to grammar, style, and clarity. Some paragraphs are updated with better suggestions. A warning added of the effect incorrect usage of the module may have. Describe the fact that offset range used in one defined structure is limited.
2018-10-19docs/pyb.Pin: Minor typo fix to specify Pin in pyb.Pin.cpu.Dave Hylands
2018-10-18docs/uio: Document StringIO/BytesIO(alloc_size) constructors.Paul Sokolovsky
2018-10-15docs/machine.Pin: Document "hard" argument of Pin.irq method.Peter Hinch
2018-10-13docs/machine.Pin: Add note regarding irq handler argument.Peter Hinch
2018-10-13lib/utils/pyexec: Forcefully unlock the heap if locked and REPL active.Damien George
Otherwise there is really nothing that can be done, it can't be unlocked by the user because there is no way to allocate memory to execute the unlock. See issue #4205 and #4209.
2018-10-05docs/uselect: Describe more aspects of poll.register/modify behavior.Paul Sokolovsky
E.g., register() can be called again for the same object, while modify() will raise exception if object was not register()ed before.
2018-10-01docs/wipy: Fix links to network.Server, and markup for boot.py.Damien George
2018-10-01docs: Remove sphinx_selective_exclude, it's no longer used.Damien George
2018-10-01docs: Unify all the ports into one set of documentation.Damien George
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-09-27docs/library/network: Make AbstractNIC methods layout correctly.Damien George
2018-09-27docs/library/network: Move specific network classes to their own file.Damien George
All concrete network classes are now moved to their own file (eg network.WLAN.rst) and deconditionalised (remove ..only:: directives). This makes the network documentation the same for all ports. After this change there are no more "..only::" directives for different ports, and the only difference among ports is the very front page of the docs.
2018-09-26docs/library/machine.SPI: Add note about baudrate imprecision.Peter Hinch
2018-09-20docs/pyboard: Fix to use Sphinx style for internal/external links.Damien George
2018-09-20docs/library/pyb: Add deprecation warning for mount and old block proto.Peter Hinch
pyb.mount(None, mountpoint) functionality is also removed and replaced by uos.umount.