aboutsummaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2017-01-07docs/usocket: Clarify that socket timeout raises OSError exception.Paul Sokolovsky
2017-01-06docs/library/esp: Remove para and add further warning about flash.Damien George
There is no longer space reserved by default for native code.
2017-01-04docs/library/esp: Document esp.set_native_code_location() function.Damien George
2017-01-04esp8266/general: Add "Scarcity of runtime resources" section.Paul Sokolovsky
With warnings of need to close files, sockets, etc.
2017-01-04docs/esp8266/tutorial: Close socket after reading page content.Max
2016-12-30docs/library/machine.I2C: Fix I2C constructor docs to match impl.Damien George
2016-12-30docs/esp8266/tutorial: Update intro to add Getting the firmware section.Andrew Mulholland
Add a "Getting the firmware" section to better describe how to get hold of the MicroPython firmware, especially if you have a 512kb module.
2016-12-15docs/library/pyb.UART: Moved writechar doc to sit with other writes.Lorenz Schmid
2016-12-15docs/library/pyb.UART: Added clarification about timeouts.Lorenz Schmid
2016-12-02docs/library/pyb.Accel: Add hardware note about pins used by accel.Peter Hinch
2016-11-23docs/library/machine.I2C: Refine definitions of I2C methods.Damien George
2016-11-16docs/library/index: Elaborate on u-modules.Paul Sokolovsky
Also, remove an "only" directive in u-modules description.
2016-11-14docs: Remove references to readall() and update stream read() docs.Damien George
2016-11-11stmhal/i2c: Add option to I2C to enable/disable use of DMA transfers.Damien George
New keyword option in constructor and init() method is "dma=<bool>". DMA is now disabled by default for I2C transfers because it currently does not handle I2C bus errors very well (eg if slave device doesn't ACK or NACK correctly during a transfer).
2016-11-10docs: Bump version to 1.8.6.Damien George
2016-11-09docs/library/machine.Pin: Update Pin docs to align with new HW API.Damien George
2016-11-08esp8266: Update docs for esptool 1.2.1/SDK 2.0 (--flash_size=detect).Paul Sokolovsky
2016-11-08docs/*/quickref.rst: Use new semantics of ticks_diff()puuu
2016-11-06docs/esp8266: Update for new WebREPL setup procedure.Paul Sokolovsky
2016-11-01docs/utime: Add docs for ticks_add(), improvements for other ticks_*().Paul Sokolovsky
2016-11-01docs/utime: Remove only:: for ticks_diff().Paul Sokolovsky
It's mandatory function which should be present in every port. Even if it's not, in the stdlib intro we waarn users that a particular port can lack anything of described in the docs.
2016-10-31docs/utime: Describe new semantics of ticks_diff() (signed ring arithmetics).Paul Sokolovsky
2016-10-30docs/utime: Document ticks_cpu() in more detail.Paul Sokolovsky
Also, drop ::only directive.
2016-10-30docs/library/index: Update TOCs so builtins sorted before modules.Paul Sokolovsky
2016-10-28docs/library/network: Typo fixes, consistent acronym capitalization.Paul Sokolovsky
2016-10-28docs/library/network: Reword intro paragraph.Paul Sokolovsky
2016-10-25docs/machine.SPI.rst: Fix typos and formatting, clarify.Paul Sokolovsky
Clarify the class implements master side of the protocol, also put adhoc WiPy paramter after the generic, described in the current Hardware API version.
2016-10-25docs/library/builtins: Add docs for delattr and slice.Damien George
2016-10-24docs/library/machine.SPI: Remove spurious "of".Damien George
2016-10-18docs/machine.SPI: Improve descriptions of xfer methods.Damien George
In particular remove the "*" because not all ports support keyword arguments.
2016-10-17docs/machine.SPI: Bring up to date with Hardware API, make vendor-neutral.Paul Sokolovsky
2016-10-17docs: Bump version to 1.8.5.Damien George
2016-10-11docs/reference: Add constrained.rst doc.Peter Hinch
It contains detailed information about writing scripts to run efficiently on microcontrollers (and other constrained systems).
2016-10-10docs/wipy: Correct deep sleep current figure.daniel
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