summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2018-02-27Merge remote-tracking branch 'adafruit/2.x' into merge_2xScott Shawcroft
2018-02-26esp8266/modnetwork: Implement WLAN.status('rssi') for STA interface.Damien George
This will return the RSSI of the AP that the STA is connected to.
2018-02-20Delete a bunch of docs, drivers and examples not relevant to CircuitPython.Scott Shawcroft
This fixes #345 and fixes #215.
2018-02-15docs/library/ujson: Document dump() and load() functions.Damien George
2018-02-15docs/library/ujson: Update to conform with docs conventions.Damien George
The formatting of exception objects is done as per CPython conventions, eg: :exc:`TypeError`
2018-02-15docs/esp8266: Add a note concerning GPIO16 pull capabilities.Olivier Ortigues
2018-02-15docs/esp8266: Update PWM doc regarding clipping of min/max values.Olivier Ortigues
2018-02-11Magnetometer values are also 3d vector of uTMika Tuupola
Unless I have misunderstood something design guide should have matching the definition with [Unified Sensor Driver](https://github.com/adafruit/Adafruit_Sensor/blob/master/Adafruit_Sensor.h#L111).
2018-02-08More formalScott Shawcroft
2018-02-08Changes based on feedback in #600.Scott Shawcroft
2018-02-07Clarify style of attribute comments in the Design Guide.Scott Shawcroft
And update the core attributes to match the style.
2018-02-01docs/library/pyb.rst: Add note about availability of USB MSC-only mode.Damien George
2018-01-08Fix sensor table. (#517)Scott Shawcroft
RST is very picky about spacing.
2018-01-04Merge pull request #510 from dhalbert/3.0_merge_2.2.0Dan Halbert
merge from 2.2.0 + fix up board defs
2018-01-02Changing magnetic attribute in design guide (#502)Dan Conley
2018-01-02merge from 2.2.0 + fix up board defsDan Halbert
2017-12-23docs/library/index: Elaborate uPy libraries intro.Paul Sokolovsky
2017-12-16docs/packages: Explicitly recommend usage of setuptools instead of distutils.Paul Sokolovsky
2017-12-16docs/packages: Use "install_dir/" in examples.Paul Sokolovsky
2017-12-16docs/conf: Reference CPython 3.5 docs.Paul Sokolovsky
CPython 3.6 contains some backward incompatible changes, and further version(s) are expected to have more. As we anyway implemente 3.4 with some features of 3.5, refer to 3.5 docs to avoid confusion. Examples of 3.6 backward incompatibilities: https://docs.python.org/3.6/library/json.html#json.dump https://docs.python.org/3.6/library/json.html#json.load > Changed in version 3.6: All optional parameters are now keyword-only. https://docs.python.org/3.6/library/functions.html#type > Changed in version 3.6: Subclasses of type which don’t override > type.__new__ may no longer use the one-argument form to get the > type of an object. https://docs.python.org/3.6/library/collections.html#collections.namedtuple > Changed in version 3.6: The verbose and rename parameters became > keyword-only arguments.
2017-12-15docs/glossary: micropython-lib: Clarify wording.Paul Sokolovsky
2017-12-14Documentation Updates (mcu.delay() and Design Guide) (#481)sommersoft
/docs/design_guide: added links to firmware build learning guides for SAMD21 & ESP8266. Changes were placed in the "Adding native modules" section, since that seemed to me the best place based on target audience. Updated documentation for `delay()` which fixes #243.
2017-12-14docs/packages: mpy_bin2res no longer required to create resources.Paul Sokolovsky
Everything happens automagically with overridden "sdist" from sdist_upip.py.
2017-12-14extmod/modframebuf: Add 8-bit greyscale format (GS8).Damien George
2017-12-14extmod/modframebuf: Add 2-bit color format (GS2_HMSB).Petr Viktorin
This format is used in 2-color LED matrices and in e-ink displays like SSD1606.
2017-12-13docs/esp8266/tutorial: Fix typo, change -> changed.Ryan Finnie
2017-12-13docs/packages: Add quick "Creating distribution packages" section.Paul Sokolovsky
Needs more details.
2017-12-11docs/reference/packages: Add chapter on distribution packages and deployment.Paul Sokolovsky
A long overdue overview of preparing packages, installing them with upip, freezing, dealing with resources. Initial version, more iterations required.
2017-12-06docs/glossary: Clarify wording for "baremetal".Paul Sokolovsky
2017-12-04docs/library: Add xrefs to "stream" dictionary entry for many modules.Paul Sokolovsky
2017-12-04docs/glossary: Describe string interning.Paul Sokolovsky
2017-12-03docs/glossary: Describe "stream" term.Paul Sokolovsky
2017-12-03docs/uerrno: Fix xref-vs-code markup.Paul Sokolovsky
2017-12-03docs/glossary: Describe the callee-owned tuple concept.Paul Sokolovsky
2017-12-02fix markdown-styled link in design_guide.rstChristopher Hiller
2017-11-30docs/uselect: ipoll: Fix grammar/wording of one-shot flag description.Paul Sokolovsky
2017-11-30docs/library/utime: Fix incorrect example with ticks_diff args order.Paul Carver
The parameter order in the example for ticks_diff was incorrect. If it's "too early" that means that scheduled time is greater than current time and if it's "running late" then scheduled time would be less than current time.
2017-11-26docs/uselect: Describe POLLHUP/POLLERR semantics in more details.Paul Sokolovsky
Per POSIX, http://pubs.opengroup.org/onlinepubs/9699919799/functions/poll.html these flags aren't valid in the input eventmask. Instead, they can be returned in unsolicited manner in the output eventmask at any time.
2017-11-25docs/uctypes: Tweak descriptor reference to hopefully be easier to follow.Paul Sokolovsky
Put offset first in OR expressions, and use "offset" var instead of hardcoded numbers. Hopefully, this will make it more self-describing and show patterns better.
2017-11-25docs/uctypes: Typo/article fixes.Paul Sokolovsky
2017-11-23docs/uselect: poll: Explicitly specify that no-timeout value is -1.Paul Sokolovsky
2017-11-23docs: Add notes on heap allocation caused by bound method refs.Peter Hinch
2017-11-16docs/library/network: Enhance AbstractNIC.status to take an argument.Damien George
The argument is optional and if given should be a string naming the status variable to query.
2017-11-14Update info about erasing CIRCUITPY to include flash erasers for non-… (#427)Dan Halbert
Update info about erasing CIRCUITPY to include flash erasers for non-Express boards.
2017-11-10docs/_thread: Add a placeholder docs for _thread module.Paul Sokolovsky
Doesn't list specific API calls yet, the purpose is to let user know that the module exists.
2017-11-08docs/ure: Emphasize not supported features more.Paul Sokolovsky
Plus, additional descriptions/formatting.
2017-11-04docs/ure: Add flags arg to ure.compile(), mention that ure.DEBUG is optional.Paul Sokolovsky
2017-11-02Merge tag 'v1.9.3'Scott Shawcroft
Introduction of ports subdirectory where all ports are moved to The main change in this release is the introduction of a "ports/" subdirectory at the top-level of the repository, and all of the ports are moved here. In the process the "stmhal" port is renamed to "stm32" to better reflect the MCU that it targets. In addition, the STM32 CMSIS and HAL sources are moved to a new submodule called "stm32lib". The bytecode has changed in this release, compared to the previous release, and as a consequence the .mpy version number has increased to version 3. This means that scripts compiled with the previous mpy-cross must be recompiled to work with this new version. There have also been various enhancements and optimisations, such as: check for valid UTF-8 when creating str objects, support for reverse special binary operations like __radd__, full domain checking in the math module, support for floor-division and modulo in the viper emitter, and addition of stack overflow checking when executing a regex. The stm32 port sees improved support for F7 MCUs, addition of a new board B_L475E_IOT01A based on the STM32L475, and support for the Wiznet W5500 chipset along with improved socket behaviour. A detailed list of changes follows. py core: - objstr: startswith, endswith: check arg to be a string - nlrx86,x64: replace #define of defined() with portable macro usage - objtype: handle NotImplemented return from binary special methods - objtype: mp_obj_class_lookup: improve debug logging - map: remove unused new/free functions - make m_malloc_fail() have void return type, since it doesn't return - modstruct: in struct.pack, stop converting if there are no args left - modstruct: check and prevent buffer-read overflow in struct unpacking - modstruct: check and prevent buffer-write overflow in struct packing - nlrthumb: get working again on standard Thumb arch (ie not Thumb2) - objfloat: fix binary ops with incompatible objects - obj: fix comparison of float/complex NaN with itself - objtype: implement fallback for instance inplace special methods - objtuple: properly implement comparison with incompatible types - objstr: add check for valid UTF-8 when making a str from bytes - objlist: properly implement comparison with incompatible types - runtime0.h: move relational ops to the beginning of mp_binary_op_t - runtime0.h: move MP_BINARY_OP_DIVMOD to the end of mp_binary_op_t - objtype: make sure mp_binary_op_method_name has full size again - runtime0.h: put inplace arith ops in front of normal operations - builtinhelp: simplify code slightly by extracting object type - runtime: implement dispatch for "reverse op" special methods - nlrx86: fix building for Android/x86 - builtinhelp: change signature of help text var from pointer to array - runtime.h: change empty mp_warning macro so var-args are non empty - modbuiltins: implement abs() by dispatching to MP_UNARY_OP_ABS - {objfloat,objcomplex}: optimise MP_UNARY_OP_ABS by reusing variables - mpconfig.h: add note that using computed gotos in VM is not C99 - objstr: strip: don't strip "\0" by default - objexcept: prevent infinite recursion when allocating exceptions - stream: remove unnecessary checks for NULL return from vstr_add_len - vstr: raise a RuntimeError if fixed vstr buffer overflows - vm: use lowercase letter at start of exception message - persistentcode: define mp_raw_code_save_file() for any unix target - add config option to print warnings/errors to stderr - objfloat: support raising a negative number to a fractional power - objset: simplify set and frozenset by separating their locals dicts - objset: check that RHS of a binary op is a set/frozenset - objset: include the failed key in a KeyError raised from set.remove - objtype: change type of enum-to-qstr table to uint16_t to save space - objstr: make empty bytes object have a null-terminating byte - mpprint: only check for null string printing when NDEBUG not defined - objtype: clean up unary- and binary-op enum-to-qstr mapping tables - persistentcode: bump .mpy version number to version 3 - bc: update opcode_format_table to match the bytecode - modmath: add full checks for math domain errors - modmath: convert log2 macro into a function - formatfloat: don't print the negative sign of a NaN value - formatfloat: use standard isinf, isnan funcs instead of custom ones - modbuiltins: use existing utf8_get_char helper in builtin ord func - emitnative: implement floor-division and modulo for viper emitter - objtype: use CPython compatible method name for sizeof - objtype: fit qstrs for special methods in byte type - objtype: define all special methods if requested - objtype: introduce MICROPY_PY_ALL_INPLACE_SPECIAL_METHODS extmod: - modubinascii: only include uzlib/tinf.h when it's really needed - modussl_mbedtls: allow to compile with MBEDTLS_DEBUG_C disabled - machine_pinbase: put PinBase singleton in ROM - re1.5: upgrade to v0.8.2, adds hook for stack overflow checking - modure: add stack overflow checking when executing a regex - uos_dupterm: update uos.dupterm() and helper funcs to have index - uos_dupterm: swallow any errors from dupterm closing the stream - vfs: replace VLA in proxy func with small, static sized array - modussl: add finaliser support for ussl objects - modussl_mbedtls: allow to compile with unix coverage build lib: - add new submodule, stm32lib containing STM32 CMSIS and HAL source - embed/abort_: use mp_raise_msg helper function - libm: fix tanhf so that it correctly handles +/- infinity args - libm: remove implementation of log2f, use MP_NEED_LOG2 instead - axtls: update, support for SSL_EAGAIN return code - berkeley-db-1.xx: update, allow to override MINCACHE, DEFPSIZE drivers: - memory/spiflash: change from hard-coded soft SPI to generic SPI - display/ssd1306.py: improve performance of graphics methods - nrf24l01: make nRF24L01 test script more portable - display/ssd1306: implement SSD1306_I2C poweron method - display/ssd1306: make poweron() work the same with SSD1306_SPI - wiznet5k: improve the performance of socket ops with threading - wiznet5k: get low-level W5500 driver working tools: - upip: upgrade to 1.2.2 - pyboard: use repr() when quoting data in error messages - pyboard: update docstring for additional device support tests: - object_new: better messages, check user __new__() method - class_new: add checks for __init__ being called and other improvements - class_new: add another testcase for __new__/__init__ interaction - class_inplace_op: test for inplace op fallback to normal one - run-bench-tests: update locations of executables, now in ports/ - class_reverse_op: test for reverse arith ops special methods - run-tests: skip class_inplace_op for minimal profile - run-tests: fix copy-paste mistake in var name - cpydiff: add cases for locals() discrepancies - extmod: add test for ure regexes leading to infinite recursion - extmod: add test for '-' in character class in regex - run-tests: close device under test using "finally" - net_inet: update tls test to work with CPython and incl new site unix port: - rename modsocket.c to modusocket.c - modusocket: remove #if MICROPY_SOCKET_EXTRA code blocks - enable MICROPY_PY_REVERSE_SPECIAL_METHODS stm32 port: - modmachine: make machine.bootloader() work when MPU is enabled - modmachine: improve support for sleep/deepsleep on F7 MCUs - compute PLL freq table during build instead of at run time - modmachine: for F7 MCU, save power by reducing internal volt reg - boards/pllvalues.py: make script work with both Python 2 and 3 - Makefile: use lib/stm32lib instead of local cmsis and hal files - remove cmsis and hal files, they are now a submodule - Makefile: automatically fetch stm32lib submodule if needed - update to new STM Cube HAL library - fix clock initialisation of L4 MCUs - rename stmhal port directory to stm32 - remove unused usbd_msc.c file - boards: change remaining stm32f4xx_hal_conf.h to unix line ending - boards: change linker scripts to use "K" instead of hex byte size - boards: fix I2C1 pin mapping on NUCLEO_F401RE/F411RE boards - i2c: when scanning for I2C devices only do 1 probe per address - modnwwiznet5k: release the GIL on blocking network operations - boards: add new board B_L475E_IOT01A based on STM32L475 - make-stmconst.py: make sure mpz const data lives in ROM - timer: make pyb.Timer() instances persistent - mpconfigport.h: add configuration for max periphs on L4 series - usbdev: make the USBD callback struct const so it can go in ROM - usbdev: change static function variable to non-static - usbdev: put all CDC state in a struct - usbdev: put all HID state in a struct - usbdev: simplify CDC tx/rx buffer passing - usbdev: simplify HID tx/rx buffer passing - usbdev/core: add state parameter to all callback functions - usbdev: put all state for the USB device driver in a struct - usbdev: simplify pointers to MSC state and block dev operations - usbdev: merge all global USB device state into a single struct - usbdev: make device descriptor callbacks take a state pointer - usbdev: move all the USB device descriptor state into its struct - timer: enable ARPE so that timer freq can be changed smoothly - modnwwiznet5k: get the IP address of an established socket - boards: fix typos in stm32f767_af.csv table - usbd_cdc_interface: don't reset CDC output buf on initialisation - modnwwiznet5k: implement WIZNET5K.isconnected() method - modusocket: make getaddrinfo() work when passed an IP address - modusocket: return OSError(-2) if getaddrinfo fails - mpconfigport.h: add MICROPY_THREAD_YIELD() macro - modnwwiznet5k: add support for W5500 Ethernet chip - modnwwiznet5k: increase SPI bus speed to 42MHz - modnwwiznet5k: implement stream ioctl for the Wiznet driver - mphalport: improve efficiency of mp_hal_stdout_tx_strn_cooked - make uos.dupterm() conform to specs by using extmod version cc3200 port: - enable micropython.kbd_intr() method - use standard implementation of keyboard interrupt esp8266 port: - rename axtls_helpers.c to posix_helpers.c - posix_helpers: set ENOMEM on memory alloc failure - set DEFPSIZE=1024, MINCACHE=3 for "btree" module - esp_mphal: send data in chunks to mp_uos_dupterm_tx_strn - modnetwork: add "bssid" keyword arg to WLAN.connect() method - modules/webrepl_setup: add info about allowed password length zephyr port: - Makefile: revamp "test" target after ports were moved to ports/ - use CONFIG_NET_APP_SETTINGS to setup initial network addresses - switch to interrupt-driven pull-style console pic16bit port: - add definition of SEEK_SET to unistd.h docs: - pyboard/tutorial: add "timeout=0" to UART in pass-through example - more xrefs to "MicroPython port" in glossary - library/network: fix ref to "socket" module (should be "usocket") - machine.Signal: improve style/grammar and add usage example - library: add description of "index" parameter to uos.dupterm() - library/micropython: fix typo in RST formatting - library/framebuf.rst: generalise constructor to all colour formats - btree: describe page caching policy of the underlying implementation - esp8266/tutorial: update neopixel with example of using 4 bbp - library/network: clarify usage of "bssid" arg in connect() method - pyboard/quickref: add info for Switch, RTC, CAN, Accel classes - pyboard/tutorial: update now that yellow LED also supports PWM - esp8266/quickref: add quickref info for RTC class - library: add missing cross-ref links for classes in pyb module - library/network: update docs to state that W5500 is supported - uselect: document one-shot polling mode - usocket: elaborate descriptions - usocket: document inet_ntop(), inet_pton() - library/network: add dhcp_hostname parameter - reference/isr_rules: minor typo correction - ussl: fix module name refs and use "MicroPython port" term - esp8266/general: add section on TLS limitations - usocket: document that settimeout() isn't supported by all ports - ure: add "|" (alternative) to the list of supported operators - reference/isr_rules.rst: add tutorial on use of micropython.schedule() travis: - use --upgrade when pip is installing cpp-coveralls - update build command now that stm32 Wiznet config has changed examples: - hwconfig_console: add .on()/.off() methods all: - convert mp_uint_t to mp_unary_op_t/mp_binary_op_t where appropriate - convert remaining "mp_uint_t n_args" to "size_t n_args" - make new ports/ sub-directory and move all ports there - update Makefiles and others to build with new ports/ dir layout - remove inclusion of internal py header files - use NULL instead of "" when calling mp_raise exception helpers README: - update "Dependencies" section - add explicit section on contributing - add gcc and arm-none-eabi-newlib to list of required components .gitattributes: - remove obsolete entries for stmhal/hal, stmhal/cmsis - add entries for files that will move to ports/ dir
2017-11-02docs/esp8266/general: Minor grammar fixes.Paul Sokolovsky
2017-11-01docs/esp8266/general: TLS limitations: Mention also "ussl" module limitations.Paul Sokolovsky