aboutsummaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2020-01-22esp32/modnetwork: Add max_clients kw-arg to WLAN.config for AP setting.adzierzanowski
This allows the user to configure the maximum number of clients that are connected to the access point. Resolves #5125.
2020-01-22docs/library/uos.rst: Improve block devices section, and ioctl ret vals.Peter Hinch
2020-01-12docs/library: Add / to indicate positional-only args in library docs.Jason Neal
Removes the confusion of positional-only arguments which have defaults that look like keyword arguments.
2020-01-12docs/library/machine: Document machine.soft_reset() function.Thorsten von Eicken
2020-01-12docs/README: Add short paragraph about using readthedocs.Thorsten von Eicken
This adds a short paragraph on how to hook readthedocs.org up. The main goal is to make people aware of the option, to help with contributing to the documentation.
2020-01-06docs/library/machine.UART.rst: Detail timeout behaviour of read methods.Jason Neal
Also document existence of "invert" argument to constructor.
2020-01-06docs/library/machine.I2C.rst: Use positional-only arguments syntax.Jason Neal
Addresses issue #5196.
2020-01-06docs: More consistent capitalization and use of articles in headings.Jason Neal
See issue #3188.
2019-12-20all: Bump version to 1.12.Damien George
2019-12-20docs/esp32: Add quickref and full docs for esp32.RMT class.Matt Trentini
2019-12-19docs/develop: Add documentation on how to build native .mpy modules.Damien George
2019-12-19docs/reference: Add documentation describing use of .mpy files.Damien George
Including information about .mpy versioning and how to debug failed imports of .mpy files.
2019-12-17docs/esp8266/quickref: Add note that machine.RTC is not fully supported.ketograph
See issues #3220 and #3710.
2019-12-16docs/library/uos.rst: Clarify why the extended interface exists.Jim Mussared
2019-12-10docs/library/uos: Add notes and links about littlefs failures.Damien George
2019-12-10docs/library/ubluetooth: Add note about API being under development.Damien George
2019-12-09docs/reference/filesystem: Add note and example about using filesystem.Damien George
2019-12-09docs/reference/filesystem: Fix typo in block device code example.Daniel Mizyrycki
2019-12-05extmod/modbluetooth: Allow setting ringbuf size via BLE.config(rxbuf=).Damien George
The size of the event ringbuf was previously fixed to compile-time config value, but it's necessary to sometimes increase this for applications that have large characteristic buffers to read, or many events at once. With this commit the size can be set via BLE.config(rxbuf=512), for example. This also resizes the internal event data buffer which sets the maximum size of incoming data passed to the event handler.
2019-12-04extmod/modbluetooth: Add optional 4th arg to gattc_write for write mode.Damien George
This allows the user to explicitly select the behaviour of the write to the remote peripheral. This is needed for peripherals that have characteristics with WRITE_NO_RESPONSE set (instead of normal WRITE). The function's signature is now: BLE.gattc_write(conn_handle, value_handle, data, mode=0) mode=0 means write without response, while mode=1 means write with response. The latter was the original behaviour so this commit is a change in behaviour of this method, and one should specify 1 as the 4th argument to get back the old behaviour. In the future there could be more modes supported, such as long writes.
2019-12-04docs: Add littlefs docs and a filesystem tutorial.Jim Mussared
2019-12-04docs/library: Add docs for pyb.Flash class.Jim Mussared
2019-12-04docs/reference: Add docs describing use of pyboard.py.Jim Mussared
2019-12-04docs: Remove spaces on lines that are empty.Damien George
2019-11-25extmod/modbluetooth: Simplify management of pre-allocated event data.Jim Mussared
The address, adv payload and uuid fields of the event are pre-allocated by modbluetooth, and reused in the IRQ handler. Simplify this and move all storage into the `mp_obj_bluetooth_ble_t` instance. This now allows users to hold on to a reference to these instances without crashes, although they may be overwritten by future events. If they want to hold onto the values longer term they need to copy them.
2019-11-12docs/library/ubluetooth: Fix name and link to FLAG_xxx constants.Damien George
2019-11-07docs/library/machine.SDCard.rst: Fix various typos.Jim Mussared
2019-11-07docs/templates/topindex.html: Replace usage of deprecated defindex.html.Jim Mussared
defindex.html (used by topindex.html) is deprecated, but topindex.html was already identical other than setting the title, so just inherit directly from layout.html.
2019-11-07docs/conf.py: Fix path to favicon.ico.Jim Mussared
2019-10-29docs/library/ubluetooth: Add docs for gatts_set_buffer.Jim Mussared
2019-10-29docs/library: Add documentation for extended block device protocol.Damien George
2019-10-23docs: Move ubluetooth under "MicroPython-specific libraries".Mike Wadsten
CPython does not have a bluetooth module, so it is not appropriate to call ubluetooth a Python standard library or micro-library.
2019-10-22docs/library/bluetooth: Rename to "ubluetooth".Jim Mussared
2019-10-22docs/library: Rename "array" module to "uarray".Damien George
2019-10-16docs/wipy/tutorial: Link Blynk examples to the official library.Volodymyr Shymanskyy
2019-10-16docs: Fix spelling in various parts of the docs.Mike Causer
2019-10-16docs/esp8266: Add ntptime usage to esp8266 quickref.Mike Causer
2019-10-16docs/library: Clarify relation between machine and port-specific mods.Peter Hinch
2019-10-16docs/esp8266/tutorial: Make http_get sample function self contained.Thiago Paes
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-15docs/reference/glossary.rst: Add new terms and reduce complexity of old.Jim Mussared
2019-10-11docs/library/bluetooth: Add initial BLE documentation.Jim Mussared
2019-10-04docs/develop/qstr.rst: Add documentation for string interning.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.