aboutsummaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2016-10-07docs/uos: Add uos.statvfs() documentation.Alex March
2016-10-04stmhal/usb: Add support to receive USB HID messages from host.Philip Potter
2016-09-28extmod/machine_i2c: Add support for the addrsize parameter in mem xfers.Radomir Dopieralski
The memory read/write I2C functions now take an optional keyword-only parameter that specifies the number of bits in the memory address. Only mem-addrs that are a multiple of 8-bits are supported (otherwise the behaviour is undefined). Due to the integer type used for the address, for values larger than 32 bits, only 32 bits of address will be sent, and the rest will be padded with 0s. Right now no exception is raised when that happens. For values smaller than 8, no address is sent. Also no exception then. Tested with a VL6180 sensor, which has 16-bit register addresses. Due to code refactoring, this patch reduces stmhal and esp8266 builds by about 50 bytes.
2016-09-23docs/library/machine: Update description of disable/enable IRQ funcs.Damien George
2016-09-18docs/library/pyb.SPI: init(): Describe "bits" argument.Paul Sokolovsky
Based on https://github.com/micropython/micropython/pull/2210 .
2016-09-18Small WiPy doc fixesjuhasch
2016-09-09docs: Bump version to 1.8.4.Damien George
2016-09-08stmhal,cc3200,esp8266: Consistently use PWRON_RESET constant.Damien George
machine.POWER_ON is renamed to machine.PWRON_RESET to match other reset-cause constants that all end in _RESET. The cc3200 port keeps a legacy definition of POWER_ON for backwards compatibility.
2016-09-07docs/reference/isr_rules.rst: Two minor additions to docs for using ISR.Peter Hinch
- Refers to the technique of instantiating an object for use in an ISR by specifying it as a default argument. - Footnote detailing the fact that interrupt handlers continue to be executed at the REPL.
2016-09-06docs/library/machine.WDT: Add that WDT is available on pyboard.Damien George
2016-09-04docs/esp8266/quickref: Further improvements for SPI subsections.Paul Sokolovsky
Consistency and formatting.
2016-09-04docs/esp8266/quickref: Update information on SPI classes.Paul Sokolovsky
SPI(1) is not used for hardware SPI. Few more details are provided.
2016-08-29docs/esp8266/quickref: Add internal links to docs for some modules.Damien George
2016-08-29docs/pyboard/quickref: Add section on "delay and timing" for utime mod.Damien George
And remove reference to deprecated pyb.delay() and pyb.millis().
2016-08-29docs/pyboard/quickref: Add links to pinouts for other pyboard variants.Damien George
2016-08-29docs/library: Add reference for pyb.usb_mode and pyb.USB_HID.Philip Potter
2016-08-29docs/pyboard: Update USB mouse tutorial to use pyb.USB_HID().Philip Potter
2016-08-29docs/pyboard: Update USB mouse tutorial to use VCP instead of CDC.Philip Potter
2016-08-29docs/esp8266: Update quickref and tutorial for OneWire/DS18X20 driver.Damien George
2016-08-28docs/esp8266/quickref: Fix and update the SPI docsRadomir Dopieralski
Use the `SPI` factory function in the examples, and use proper baud rate of 80 000 000.
2016-08-19esp8266/modpybhspi: Add a HSPI module for hardware SPI supportRadomir Dopieralski
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-17docs/library/machine.WDT: Add note that WDT is only available on WiPy.Damien George
2016-08-10docs/esp8266/intro: Add command to install esptool.py 1.0.1 via pip.Paul Sokolovsky
It used a standard BootROM programming algo and may be useful as a fallback.
2016-08-09docs/esp8266/tutorial/pins: Fix typo in commands for pin input mode.Paul Sokolovsky
2016-08-09docs: Bump version to 1.8.3.Damien George
2016-08-09docs/uio: Mention seek()/flush() support for io.BytesIO.Paul Sokolovsky
2016-08-07docs/esp8266/intro: Focus on hazards of unearthed power wrt electronics.Paul Sokolovsky
2016-08-07docs/esp8266/tutorial/intro: Add anchor for link from quickeref.Paul Sokolovsky
2016-08-07docs/esp8266/quickref: Link to installation instructions.Paul Sokolovsky
2016-08-07docs/esp8266/intro: Add troubleshooting section.Paul Sokolovsky
Tries to summarize most of the issues we've seen so far.
2016-08-07docs/esp8266/intro: Rename to "Getting started" from "Introduction".Paul Sokolovsky
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-07esp8266/tutorial/intro: Reword para abou -fm dio switch.Paul Sokolovsky
Not all NodeMCU boards require it.
2016-08-07docs/library/index: Include array module in ToC.Paul Sokolovsky
2016-08-07docs/array: Document array module.Paul Sokolovsky
2016-08-02docs: Spelling mistakesMike Causer
2016-08-01docs: Add DHT to ESP8266 Quick Ref and TutorialMike Causer
2016-07-10docs: Bump version to 1.8.2.Damien George
2016-06-26docs/library: Fix typo in docs for usocket.listen().Martin Müller
2016-06-19docs/conf.py: Exclude cmath from modindex for wipy.Paul Sokolovsky
2016-06-18docs/sys: print_exception: Fixes/clarifications.Paul Sokolovsky
2016-06-18docs/select: Add an article.Paul Sokolovsky
2016-06-14docs: Rebuild docs from scratch, as required for proper only:: handling.Paul Sokolovsky
Docs are now by default rebuilt from scratch, as required to build conditionalized (i.e. using only:: directive) docs across different output types. We have pretty small docset, so that's still rather fast. However, if that's a concern, incremental rebuilds can be used by passing "FORCE=" (nothing after =) as a make parameter. This will work when using the same output type (e.g. only "html").
2016-06-12docs/conf.py: Active sphinx_selective_exclude extensions.Paul Sokolovsky
For modindex_exclude extension, per-port module excludes are also added. With these changes, it's possible to generate docs for a particular port devoid of any superfluous and unrelated content, including in indexes and full-text search - with small caveat: when generating PDF docs after HTML, or vice-versa cached internal doctree representation (build/*/doctrees/) must be removed first.
2016-06-12docs: Add sphinx_selective_exclude extension suite.Paul Sokolovsky
Designed specifically to workaround issues we were facing with generating multiple conditionalized output docsets from a single master doctree. Extensions were factored out into a separate project, based on the fact that many other Sphinx users experience similar or related problems: https://github.com/pfalcon/sphinx_selective_exclude Corresponds to the 182f4a8da57 upstream revision.
2016-06-10docs/sys: Detailed description of print_exception() diff from traceback module.Paul Sokolovsky
2016-06-09docs/uctypes: Improve documentation.Paul Sokolovsky
Seealso and Limitations sectiosn added, better formatting and grammar.
2016-06-09docs/machine*: Remove explicit targets and "machine." prefixes on classes.Paul Sokolovsky
With currentmodule:: set properly, none are needed. Extra "machine." prefix produces wrong indexing data.
2016-06-09docs/machine.Pin: Disambiguate object call method.Paul Sokolovsky
2016-06-09docs/library/index: Add builtins.rst.Paul Sokolovsky
2016-06-09docs/builtins: Enumerate all builtin functions implemented.Paul Sokolovsky
Based on unix version. No descriptions so far.
generated by cgit v1.2.3 (git 2.25.1) at 2026-02-19 11:48:01 +0000