djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
6cea369b89
circuitpython/docs/library
History
Damien George dd0bc26e65 extmod/modbluetooth: Change scan result's "connectable" to "adv_type". 
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-03-11 14:00:44 +11:00
..
_thread.rst docs/_thread: Add a placeholder docs for _thread module. 2017-11-10 00:09:43 +02:00
btree.rst docs/library: Add / to indicate positional-only args in library docs. 2020-01-12 13:44:59 +11:00
builtins.rst docs/library: Add CPython docs xref to each pertinent module. 2017-07-02 15:37:31 +03:00
cmath.rst docs/library: Add CPython docs xref to each pertinent module. 2017-07-02 15:37:31 +03:00
esp32.rst docs: More consistent capitalization and use of articles in headings. 2020-01-06 22:17:29 +11:00
esp.rst docs/library: Add / to indicate positional-only args in library docs. 2020-01-12 13:44:59 +11:00
framebuf.rst docs/library: Fix framebuf monochrome 1-bit modes, swapping HLSB/HMSB. 2020-02-10 23:04:15 +11:00
gc.rst docs/library: Add CPython docs xref to each pertinent module. 2017-07-02 15:37:31 +03:00
index.rst docs: Move ubluetooth under "MicroPython-specific libraries". 2019-10-23 11:43:01 -05:00
lcd160cr.rst docs: Remove spaces on lines that are empty. 2019-12-04 15:02:54 +11:00
machine.ADC.rst docs/library: Specify new machine.ADC class. 2019-09-04 15:35:09 +10:00
machine.ADCWiPy.rst docs: Rename machine.ADC docs to machine.ADCWiPy. 2019-09-04 15:05:03 +10:00
machine.I2C.rst docs/library/machine.I2C.rst: Use positional-only arguments syntax. 2020-01-06 22:25:35 +11:00
machine.Pin.rst docs/library/machine.Pin: Add PULL_HOLD constant to possible pin pulls. 2019-03-14 07:29:04 +11:00
machine.rst docs/library: Add / to indicate positional-only args in library docs. 2020-01-12 13:44:59 +11:00
machine.RTC.rst docs: Remove spaces on lines that are empty. 2019-12-04 15:02:54 +11:00
machine.SD.rst docs/machine: Add initial docs for new machine.SDCard class. 2019-06-03 00:42:24 +10:00
machine.SDCard.rst docs/library/machine.SDCard.rst: Fix various typos. 2019-11-07 14:47:11 +11:00
machine.Signal.rst docs/machine.Signal: Improve style/grammar and add usage example. 2017-08-29 00:08:40 +03:00
machine.SPI.rst docs/library/machine.SPI: Add note about baudrate imprecision. 2018-09-26 15:21:10 +10:00
machine.Timer.rst docs: Move WiPy specific Timer class to separate doc file. 2018-07-31 23:40:06 +10:00
machine.TimerWiPy.rst docs: Remove spaces on lines that are empty. 2019-12-04 15:02:54 +11:00
machine.UART.rst docs/library/machine.UART.rst: Detail timeout behaviour of read methods. 2020-01-06 22:50:58 +11:00
machine.WDT.rst docs/library/machine.*: Add cross-reference label to individual classes. 2017-04-18 15:27:37 +10:00
math.rst docs/library: Add CPython docs xref to each pertinent module. 2017-07-02 15:37:31 +03:00
micropython.rst py/scheduler: Rename sched_stack to sched_queue. 2019-07-17 16:09:32 +10:00
network.CC3K.rst docs/library/network: Move specific network classes to their own file. 2018-09-27 17:23:42 +10:00
network.rst docs: Fix spelling in various parts of the docs. 2019-10-16 14:08:28 +11:00
network.WIZNET5K.rst docs/library/network: Move specific network classes to their own file. 2018-09-27 17:23:42 +10:00
network.WLAN.rst docs/library/network: Move specific network classes to their own file. 2018-09-27 17:23:42 +10:00
network.WLANWiPy.rst docs/library/network: Move specific network classes to their own file. 2018-09-27 17:23:42 +10:00
pyb.Accel.rst docs: Remove spaces on lines that are empty. 2019-12-04 15:02:54 +11:00
pyb.ADC.rst docs: Remove spaces on lines that are empty. 2019-12-04 15:02:54 +11:00
pyb.CAN.rst docs: Remove spaces on lines that are empty. 2019-12-04 15:02:54 +11:00
pyb.DAC.rst docs/library/pyb.DAC.rst: Correct frequency for triangle mode output. 2019-09-03 23:25:45 +10:00
pyb.ExtInt.rst docs: Remove spaces on lines that are empty. 2019-12-04 15:02:54 +11:00
pyb.Flash.rst docs/library: Add docs for pyb.Flash class. 2019-12-04 23:18:17 +11:00
pyb.I2C.rst docs/library: Remove "only" directive from all pyb module docs. 2018-07-18 15:47:44 +10:00
pyb.LCD.rst docs: Remove spaces on lines that are empty. 2019-12-04 15:02:54 +11:00
pyb.LED.rst docs: Remove spaces on lines that are empty. 2019-12-04 15:02:54 +11:00
pyb.Pin.rst docs/pyb.Pin: Minor typo fix to specify Pin in pyb.Pin.cpu. 2018-10-19 17:31:59 +11:00
pyb.rst docs/library: Add docs for pyb.Flash class. 2019-12-04 23:18:17 +11:00
pyb.RTC.rst docs: Remove spaces on lines that are empty. 2019-12-04 15:02:54 +11:00
pyb.Servo.rst docs/pyb.*: Use proper class case in method headers. 2016-06-08 16:21:28 +03:00
pyb.SPI.rst docs/library: Remove "only" directive from all pyb module docs. 2018-07-18 15:47:44 +10:00
pyb.Switch.rst docs: Fix some references and RST markup to eliminate Sphinx warnings. 2018-03-15 15:50:51 +11:00
pyb.Timer.rst docs: Remove spaces on lines that are empty. 2019-12-04 15:02:54 +11:00
pyb.UART.rst stm32/machine_uart: Change default UART timeout to 0, for non blocking. 2019-05-07 13:56:42 +10:00
pyb.USB_HID.rst docs: Remove spaces on lines that are empty. 2019-12-04 15:02:54 +11:00
pyb.USB_VCP.rst docs: Remove spaces on lines that are empty. 2019-12-04 15:02:54 +11:00
sys.rst docs/library: Add / to indicate positional-only args in library docs. 2020-01-12 13:44:59 +11:00
uarray.rst docs/library: Rename "array" module to "uarray". 2019-10-22 16:40:58 +11:00
ubinascii.rst docs/library/ubinascii: Update base64 docs. 2017-08-17 09:25:51 +03:00
ubluetooth.rst extmod/modbluetooth: Change scan result's "connectable" to "adv_type". 2020-03-11 14:00:44 +11:00
ucollections.rst docs/library: Add documentation for ucollections.deque. 2018-06-26 14:29:22 +10:00
ucryptolib.rst extmod/moducryptolib: Add AES-CTR support. 2019-05-06 18:09:48 +10:00
uctypes.rst docs/library: Add / to indicate positional-only args in library docs. 2020-01-12 13:44:59 +11:00
uerrno.rst docs/uerrno: Fix xref-vs-code markup. 2017-12-03 15:50:37 +02:00
uhashlib.rst docs: Fix spelling in various parts of the docs. 2019-10-16 14:08:28 +11:00
uheapq.rst docs/library: Add CPython docs xref to each pertinent module. 2017-07-02 15:37:31 +03:00
uio.rst docs/uio: Document StringIO/BytesIO(alloc_size) constructors. 2018-10-18 12:39:25 +11:00
ujson.rst docs/library/ujson: Document dump() and load() functions. 2018-02-15 11:37:48 +11:00
uos.rst docs/library/uos.rst: Improve block devices section, and ioctl ret vals. 2020-01-22 16:37:31 +11:00
ure.rst docs/library: Add / to indicate positional-only args in library docs. 2020-01-12 13:44:59 +11:00
uselect.rst docs/library: Add / to indicate positional-only args in library docs. 2020-01-12 13:44:59 +11:00
usocket.rst docs/library: Add / to indicate positional-only args in library docs. 2020-01-12 13:44:59 +11:00
ussl.rst docs: Fix some references and RST markup to eliminate Sphinx warnings. 2018-03-15 15:50:51 +11:00
ustruct.rst docs/library: Add / to indicate positional-only args in library docs. 2020-01-12 13:44:59 +11:00
utime.rst docs/library/utime: Fix incorrect example with ticks_diff args order. 2017-11-30 14:56:08 +11:00
uzlib.rst docs/library: Add / to indicate positional-only args in library docs. 2020-01-12 13:44:59 +11:00
wipy.rst docs: Add usocket and ussl modules' documentation. 2015-10-21 15:30:56 +02:00