aboutsummaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
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.
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-28docs/reference/speed_python: Add missing self to var caching example.Paul m. p. P
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-19docs/reference/speed_python: Update that read-only buffers are accepted.Peter Hinch
As allowed by recent cd35dd9d9a29836906acdce60c931f6352b536d0
2019-08-15docs/pyboard: Emphasize the instructions for making a USB mouse.Vicki Lowe
It wasn't clear why that element was `10` instead of `0`. Also bumped the `10` to `100` to make the mouse movement more obvious.
2019-08-15docs/library: Document that sys.version_info returns a 3-tuple only.Tom McDermott
See issue #4970.
2019-08-15docs/pyboard: Clarify initial files on pyboard and fix up formatting.Vicki Lowe
2019-08-15docs/pyboard: Update name of mounted volume to match code.Vicki Lowe
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-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.Damien 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.