summaryrefslogtreecommitdiff
path: root/docs/library
AgeCommit message (Collapse)Author
2020-04-04docs,tests: Add docs and test for uasyncio custom exc handler methods.Damien George
2020-04-02extmod/uasyncio: Add StreamReader/StreamWriter as aliases of Stream cls.Damien George
To be compatible with CPython. Fixes issue #5847.
2020-04-02extmod/uasyncio: Implement Loop.stop() to stop the event loop.Damien George
2020-03-26docs/library: Add initial docs for uasyncio module.Damien George
2020-03-11py/modmicropython: Add heap_locked function to test state of heap.Andrew Leech
This commit adds micropython.heap_locked() which returns the current lock-depth of the heap, and can be used by Python code to check if the heap is locked or not. This new function is configured via MICROPY_PY_MICROPYTHON_HEAP_LOCKED and is disabled by default. This commit also changes the return value of micropython.heap_unlock() so it returns the current lock-depth as well.
2020-03-11extmod/modbluetooth: Change scan result's "connectable" to "adv_type".Damien George
This commit changes the BLE _IRQ_SCAN_RESULT data from: addr_type, addr, connectable, rssi, adv_data to: addr_type, addr, adv_type, rssi, adv_data This allows _IRQ_SCAN_RESULT to handle all scan result types (not just connectable and non-connectable passive scans), and to distinguish between them using adv_type which is an integer taking values 0x00-0x04 per the BT specification. This is a breaking change to the API, albeit a very minor one: the existing connectable value was a boolean and True now becomes 0x00, False becomes 0x02. Documentation is updated and a test added. Fixes #5738.
2020-02-18extmod/modbluetooth: Implement config getter for BLE rxbuf size.Thomas Friebel
Knowing the buffer size can be important, to ensure that valid data will be received.
2020-02-10docs/library: Fix framebuf monochrome 1-bit modes, swapping HLSB/HMSB.Peter Hinch
This fix can be demonstrated by the following: b = bytearray(32) f = framebuf.FrameBuffer(b, 32, 8, framebuf.MONO_HLSB) f.pixel(0, 0, 1) print('MONO_HLSB', hex(b[0])) b = bytearray(32) f = framebuf.FrameBuffer(b, 32, 8, framebuf.MONO_HMSB) f.pixel(0, 0, 1) print('MONO_HMSB', hex(b[0])) Outcome: MONO_HLSB 0x80 MONO_HMSB 0x1
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-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-20docs/esp32: Add quickref and full docs for esp32.RMT class.Matt Trentini
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-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: 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-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: 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.