summaryrefslogtreecommitdiff
path: root/docs/library
AgeCommit message (Collapse)Author
2018-02-20Delete a bunch of docs, drivers and examples not relevant to CircuitPython.Scott Shawcroft
This fixes #345 and fixes #215.
2017-08-25Initial merge of micropython v1.9.2 into circuitpython 2.0.0 (in ↵Dan Halbert
development) master. cpx build compiles and loads and works in repl; test suite not run yet esp8266 not tested yet
2017-08-22docs: Consistently link to micropython-lib in glossary.Paul Sokolovsky
2017-08-20docs/library/usocket: Describe complete information on address formats.Paul Sokolovsky
Describe that the only portable way to deal with addresses is by using getaddrinfo(). Describe that some ports may support tuple addresses using "socket" module (vs "usocket" of native MicroPython).
2017-08-20docs/library/usocket: Move socket.error to its own section.Paul Sokolovsky
It's too minor a point to start the module description with it.
2017-08-17docs/library/ubinascii: Update base64 docs.Alex Robbins
This clarifies return values and the handling of invalid (e.g. newline) characters. Encoding conforms to RFC 3548, but decoding does not, as it ignores invalid characters in base64 input. Instead, it conforms to MIME handling of base64 (RFC 2045). Note that CPython doesn't document handling of invalid characters in a2b_base64() docs: https://docs.python.org/3/library/binascii.html#binascii.a2b_base64 , so we specify it more explicitly than it, based on CPython's actual behavior (with which MicroPython now compliant).
2017-08-14docs/library/machine.RTC.rst: Fix typo.Javier Candeira
2017-07-15docs,teensy: Use the name MicroPython consistently in documentationAlexander Steffen
2017-07-04docs/uzlib: Update description of decompress() and mention DecompIO.Paul Sokolovsky
2017-07-03docs/uerrno: Document "uerrno" module.Paul Sokolovsky
2017-07-02docs/library: Add CPython docs xref to each pertinent module.Paul Sokolovsky
Cross-reference text/link is implemented as RST substitution, so easy to consistently.
2017-07-02docs/ure: Elaborate doc, update markup to the latest conventions.Paul Sokolovsky
2017-07-01docs/builtins: Add AssertionError, SyntaxError, ZeroDivisionError.Paul Sokolovsky
Also, update heading of 1st sections to "Functions and types".
2017-07-01reference/index: Rewrite introduction paragraph to avoid confusion.Paul Sokolovsky
The old intro talked about "differences", but there were hardly any sections describing differences, mostly MicroPython specific features. On the other hand, we now have real "differences" chapter, though it's mostly concerned with stdlib differences. So, try to avoid confusion by changing wording and linking to the other chapters and contrasting them with what is described in "MicroPython language".
2017-06-30docs/{uselect,ussl,ustruct}: Use markup adhering to latest docs conventions.Paul Sokolovsky
2017-06-29docs/{framebuf,usocket}: Use markup adhering to the latest docs conventions.Paul Sokolovsky
2017-06-28docs/{micropython,sys,uos}: Use markup adhering to the latest docs conventions.Paul Sokolovsky
2017-06-27docs/{esp,pyb,ubinascii}: Use markup adhering to the latest docs conventions.Paul Sokolovsky
2017-06-26docs/library/gc: Fix grammar and improve readability of gc.threshold().Damien George
2017-06-26docs/network: Use markup adhering to the latest docs conventions.Paul Sokolovsky
2017-06-25docs/machine*: Use markup adhering to the latest docs conventions.Paul Sokolovsky
2017-06-25docs/lcd160cr: Group related constants together. Use full sentences.Paul Sokolovsky
Per the latest docs conventions.
2017-06-25docs/utime: Use markup adhering to the latest conventions.Paul Sokolovsky
2017-06-25docs/lcd160cr: Use markup adhering to the latest conventions.Paul Sokolovsky
2017-06-25docs/btree: Use markup adhering to the latest conventions.Paul Sokolovsky
2017-06-24docs/builtins: List builtin exceptions.Paul Sokolovsky
If for nothing else, then at least to cross-reference them.
2017-06-24docs/gc: Document gc.threshold() function.Paul Sokolovsky
2017-06-24docs/gc: Mark mem_alloc()/mem_free() as uPy-specific.Paul Sokolovsky
2017-06-20Merge tag 'v1.9.1'2.0.0-alpha.0Scott Shawcroft
Fixes for stmhal USB mass storage, lwIP bindings and VFS regressions This release provides an important fix for the USB mass storage device in the stmhal port by implementing the SCSI SYNCHRONIZE_CACHE command, which is now require by some Operating Systems. There are also fixes for the lwIP bindings to improve non-blocking sockets and error codes. The VFS has some regressions fixed including the ability to statvfs the root. All changes are listed below. py core: - modbuiltins: add core-provided version of input() function - objstr: catch case of negative "maxsplit" arg to str.rsplit() - persistentcode: allow to compile with complex numbers disabled - objstr: allow to compile with obj-repr D, and unicode disabled - modsys: allow to compile with obj-repr D and PY_ATTRTUPLE disabled - provide mp_decode_uint_skip() to help reduce stack usage - makeqstrdefs.py: make script run correctly with Python 2.6 - objstringio: if created from immutable object, follow copy on write policy extmod: - modlwip: connect: for non-blocking mode, return EINPROGRESS - modlwip: fix error codes for duplicate calls to connect() - modlwip: accept: fix error code for non-blocking mode - vfs: allow to statvfs the root directory - vfs: allow "buffering" and "encoding" args to VFS's open() - modframebuf: fix signed/unsigned comparison pendantic warning lib: - libm: use isfinite instead of finitef, for C99 compatibility - utils/interrupt_char: remove support for KBD_EXCEPTION disabled tests: - basics/string_rsplit: add tests for negative "maxsplit" argument - float: convert "sys.exit()" to "raise SystemExit" - float/builtin_float_minmax: PEP8 fixes - basics: convert "sys.exit()" to "raise SystemExit" - convert remaining "sys.exit()" to "raise SystemExit" unix port: - convert to use core-provided version of built-in import() - Makefile: replace references to make with $(MAKE) windows port: - convert to use core-provided version of built-in import() qemu-arm port: - Makefile: adjust object-file lists to get correct dependencies - enable micropython.mem_*() functions to allow more tests stmhal port: - boards: enable DAC for NUCLEO_F767ZI board - add support for NUCLEO_F446RE board - pass USB handler as parameter to allow more than one USB handler - usb: use local USB handler variable in Start-of-Frame handler - usb: make state for USB device private to top-level USB driver - usbdev: for MSC implement SCSI SYNCHRONIZE_CACHE command - convert from using stmhal's input() to core provided version cc3200 port: - convert from using stmhal's input() to core provided version teensy port: - convert from using stmhal's input() to core provided version esp8266 port: - Makefile: replace references to make with $(MAKE) - Makefile: add clean-modules target - convert from using stmhal's input() to core provided version zephyr port: - modusocket: getaddrinfo: Fix mp_obj_len() usage - define MICROPY_PY_SYS_PLATFORM (to "zephyr") - machine_pin: use native Zephyr types for Zephyr API calls docs: - machine.Pin: remove out_value() method - machine.Pin: add on() and off() methods - esp8266: consistently replace Pin.high/low methods with .on/off - esp8266/quickref: polish Pin.on()/off() examples - network: move confusingly-named cc3200 Server class to its reference - uos: deconditionalize, remove minor port-specific details - uos: move cc3200 port legacy VFS mounting functions to its ref doc - machine: sort machine classes in logical order, not alphabetically - network: first step to describe standard network class interface examples: - embedding: use core-provided KeyboardInterrupt object
2017-06-16docs/select: Rename to uselect, to match the actual module name.Paul Sokolovsky
Also, add ipoll() documentation and markup changes to comply with CPython usage.
2017-06-15stmhal: Add .value() method to Switch object, to mirror Pin and Signal.Damien George
2017-06-11docs/btree: Typo/wording fixes.Paul Sokolovsky
2017-06-11docs/btree: Add hints about opening db file and need to flush db.Paul Sokolovsky
2017-06-04docs/network: First step to describe standard network class interface.Paul Sokolovsky
This adds description of implied AbstractNIC base class, which should be "subclasses" and implemented by a particular network device class. This is just an initial step in that direction, the API and description will be elabotated further.
2017-06-03docs/machine: Sort machine classes in logical order, not alphabetically.Paul Sokolovsky
The list starts with the simplest functionality - GPIO, proceeds to communication interfaces (UART, SPI, I2C), the to time(r) related things, then everything else.
2017-06-03docs/uos: Move cc3200 port legacy VFS mounting functions to its ref doc.Paul Sokolovsky
This patch also unconditionalizes uos.dupterm(), though exact interface and semantics is yet to be defined.
2017-06-03docs/uos: Deconditionalize, remove minor port-specific details.Paul Sokolovsky
For a couple of ports, there was information which directory is set as current after boot. This information doesn't belong to "uos" module, and is moved to boards' references (which actually already contained information on which directory is chosen for boot, even if without explicit mentioning that it becomes current directory, which is now done).
2017-06-03docs/network: Move confusingly-named cc3200 Server class to its reference.Paul Sokolovsky
cc3200 port has network.Server class to control behavior of builtin Telnet/FTP server of that port.
2017-05-29docs/machine.Pin: Add on() and off() methods.Paul Sokolovsky
2017-05-29docs/machine.Pin: Remove out_value() method.Paul Sokolovsky
This method isn't implemented in any port. It seemed to have originated in cc3200 port, but actually never was implemented there either. In general case, it's impossible to implement this method (for example, for a perfect GPO, which has only output latch without any feedback look into a CPU).
2017-05-29various: Spelling fixesVille Skyttä
2017-05-21library/machine.Pin: Remove .id() method and .board class attr.Paul Sokolovsky
Both aren't part of generic Hardware API: It's impossible to implement .id() method in a generic case (e.g., when Pin is instantiated by the underlying OS/RTOS). .board attribute is an obvious space hog which instead can be implemented on Python level if needed.
2017-05-19docs/library/machine.UART: Update and improve uart.any() docs.Damien George
2017-05-18docs/library/micropython: Document the newer micropython functions.Damien George
2017-05-17drivers/display/lcd160cr: Fix get_line method and enhance screen_dump.Damien George
The docs are updated and describe the new behaviour of these methods.
2017-05-15docs/library/index: Add important summary of the intro section as warning.Paul Sokolovsky
To make them harder to miss.
2017-05-14docs/machine.Signal: Add initial draft description of Signal class.Paul Sokolovsky
2017-05-14docs/machine.Pin: There's no toggle() method in MicroPython hardware API.Paul Sokolovsky
May be a port-specific method, not portable, not part of the official specification.
2017-05-10docs/library/uos: Add description of uos.ilistdir() function.Damien George
2017-04-18docs/library/machine.SPI: Fix formatting of bullet list to stop warning.Damien George
generated by cgit v1.2.3 (git 2.39.1) at 2026-08-07 16:58:36 +0000