summaryrefslogtreecommitdiff
path: root/docs/library
AgeCommit message (Collapse)Author
2019-10-22docs/library: Rename "array" module to "uarray".Damien George
2019-10-16docs: Fix spelling in various parts of the docs.Mike Causer
2019-10-16docs/library: Clarify relation between machine and port-specific mods.Peter Hinch
2019-10-16docs/library/bluetooth.rst: Fix typo in HR/UART services example.Damien George
2019-10-15extmod/modbluetooth: Make gap_disconnect not raise when disconnected.Jim Mussared
Previously it raised OSError(MP_ENOTCONN) if the conn_handle was already disconnected. Now it returns True/False.
2019-10-15docs/library/bluetooth.rst: Explain how to increase char buffer size.Jim Mussared
2019-10-15docs/library/bluetooth.rst: Clarify gap_advertise adv_data behavior.Jim Mussared
Make it clear that the previous adv_data will be reused if it's not set. And some minor other improvements.
2019-10-11docs/library/bluetooth: Add initial BLE documentation.Jim Mussared
2019-09-26docs/library/pyb.USB_VCP.rst: Add info about id and flow params.Damien George
2019-09-11docs/library/pyb.rst: Update pyb.usb_mode() to mention VCP+MSC+HID.Damien George
2019-09-10docs/library/pyb.rst: Update docs for pyb.usb_mode() function.Damien George
2019-09-04docs/library: Specify new machine.ADC class.Damien George
This initial specification is only for the ADC constructor and read_u16() method.
2019-09-04docs: Rename machine.ADC docs to machine.ADCWiPy.Damien George
To signify that this ADC documentation is specific to the WiPy, and to make way for a standardised ADC documentation.
2019-09-03docs/library/pyb.DAC.rst: Correct frequency for triangle mode output.Jim Mussared
Also correct comments in related code.
2019-08-20esp32: Add esp32.Partition class to expose partition and OTA funcs.Damien George
Partitions are exposed as a standard MicroPython block device.
2019-08-15docs/library: Document that sys.version_info returns a 3-tuple only.Tom McDermott
See issue #4970.
2019-08-15docs/library/sys: Add documentation for sys.atexit function.Damien George
2019-07-31docs/library/framebuf: Add missing module reference in example code.Arsenijs
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-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-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-06extmod/moducryptolib: Add AES-CTR support.Yonatan Goldschmidt
Selectable at compile time via MICROPY_PY_UCRYPTOLIB_CTR. Disabled by default.
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-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-08docs/ure: Fix match.group signature to indicate index param is required.Yonatan Goldschmidt
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-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.
2018-12-13docs/ure: Fully describe supported syntax subset, add example.Paul Sokolovsky
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-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/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.
2018-08-14docs/library/machine.UART.rst: Specify optional txbuf and rxbuf args.Damien George
If a port would like to expose the configuration of transmit and/or receive buffers then it can use these arguments.
2018-08-04docs/library/machine.I2C.rst: Clarify availability of primitive I2C ops.Peter Hinch
2018-07-31docs: Move WiPy specific Timer class to separate doc file.Damien George
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.
2018-07-20docs/library/machine: Remove conditionals in machine class index.Damien George
The machine module should be standard across all ports so should have the same set of classes in the docs. A special warning is added to the top of the machine.SD class because it is not standardised and only available on the cc3200 port.
2018-07-20docs/library/index: Add hint about using help('modules') for discovery.Damien George
2018-07-20docs/library/index: Remove all conditionals from library index.Damien George
It's fair to just provide a link to all available modules, regardless of the port. Most of the existing ports (unix, stm32, esp8266, esp32) share most of the same set of modules anyway, so no need to maintain separate lists for them. And there's a big discussion at the start of this index about modules not being available on a given port. For port-specific modules, they can also be listed unconditionally because they have headings that explicitly state they are only available on certain ports.
2018-07-18docs/library/machine: Remove conditional docs for rng function.Damien George
And instead list its availability explicitly.
2018-07-18docs/library/machine: Remove conditional docs for wake_reason function.Damien George
And instead list its availability explicitly.
generated by cgit v1.2.3 (git 2.46.0) at 2025-08-29 10:29:34 +0000