Damien George
3e0d587a49
docs/library/machine: Remove conditional docs for rng function.
And instead list its availability explicitly.
6 years ago
Damien George
163cc66a0b
docs/library/machine: Remove conditional docs for wake_reason function.
And instead list its availability explicitly.
6 years ago
Damien George
4cc65e22d4
docs/library/machine.UART: Remove conditional docs for wipy port.
The UART.init() method is now included unconditionally and its wording
adjusted to better describe ports other than the cc3200.
UART.irq() is also included unconditionally, but this is currently only
available on the WiPy target.
6 years ago
Damien George
164377f806
docs/library/pyb.DAC: Fix typo in markup to balance quotes.
6 years ago
Damien George
805fd0cfe6
docs/library: Remove "only" directive from all pyb module docs.
By virtue of its name, the pyb module would only be available on a pyboard
and so does not need to have conditional "only" directives throughout its
documentation.
These conditionals were added mostly in
cfcf47c064
in the initial development of the
cc3200 port, which had the pyb module before it switched to the machine
module. And wipy only conditionals were removed from the pyb module
documentation in 4542643025
, so there's no
need to retain any more conditionals.
6 years ago
Damien George
2cff340357
docs/pyboard: For latex build, use smaller quickref jpg, and no gifs.
The latexpdf target needs images that fit on the page, and does not support
gifs.
6 years ago
Damien George
41226e9a18
docs/ure: Document some more supported regex operators.
6 years ago
Damien George
4727bd1db8
docs/ure: Document sub(), groups(), span(), start() and end().
6 years ago
Damien George
ab02abe96d
docs/uos: Make it clear that block device block_num param is an index.
6 years ago
Yonatan Goldschmidt
473fe45da2
extmod/moducryptolib: Optionally export MODE_* constants to Python.
Allow including crypto consts based on compilation settings. Disabled by
default to reduce code size; if one wants extra code readability, can
enable them.
6 years ago
Damien George
11a7a70a6f
docs/usocket: Minor fixes to grammar of getaddrinfo.
6 years ago
Paul Sokolovsky
2e3468a68c
docs/usocket: getaddrinfo: Describe af/type/proto optional params.
These can be optionally specified, but all ports are expected to be able to
accept them, at the very least ignore, though handling of "type" param
(SOCK_STREAM vs SOCK_DGRAM) is recommended.
7 years ago
Paul Sokolovsky
12fde67a25
docs/ucryptolib: Add docs for new ucryptolib module.
7 years ago
Damien George
b9ec6037ed
docs/library: Add documentation for ucollections.deque.
6 years ago
jcea
5731e535dd
docs/esp8266: Fix minor typo in "certificates".
6 years ago
Damien George
6c955932f3
stm32/rtc: Don't try to set SubSeconds value on RTC.
The hardware doesn't allow it, instead the value is reset to 255 upon
setting the other calendar/time values.
7 years ago
Damien George
421b84af99
docs: Bump version to 1.9.4.
7 years ago
Damien George
c7818032b1
docs/library: Add ussl module to library index for unix port.
7 years ago
Damien George
c24b0a7f2b
docs/library/pyb.ADC: Fix typo of "prarmeter".
7 years ago
Peter Hinch
0600645944
docs/library/pyb.ADC: Remove outdated ADCAll code example.
7 years ago
Damien George
b30e0d2f26
stm32/dac: Add buffering argument to constructor and init() method.
This can be used to select the output buffer behaviour of the DAC. The
default values are chosen to retain backwards compatibility with existing
behaviour.
Thanks to @peterhinch for the initial idea to add this feature.
7 years ago
Damien George
aebd9701a7
stm32/adc: Optimise read_timed_multi() by caching buffer pointers.
7 years ago
Peter Hinch
4f40fa5cf4
stm32/adc: Add read_timed_multi() static method, with docs and tests.
7 years ago
T S
8f11d0b532
docs/library/pyb.ADC.rst: Document new features for ADCAll.
7 years ago
Damien George
0abbafd424
stm32/can: Add "list" param to CAN.recv() to receive data inplace.
This API matches (as close as possible) how other pyb classes allow inplace
operations, such as pyb.SPI.recv(buf).
7 years ago
Damien George
b7d576d69a
docs/library/pyb.CAN: Clean up documentation of data constants.
7 years ago
Damien George
a25e6c6b65
stm32/can: Add CAN.info() method to retrieve error and tx/rx buf info.
7 years ago
Damien George
d7e67fb1b4
stm32/can: Add CAN.state() method to get the state of the controller.
This is useful for monitoring errors on the bus and knowing when a restart
is needed.
7 years ago
Damien George
1272c3c65d
stm32/can: Add CAN.restart() method so controller can leave bus-off.
7 years ago
Damien George
823ca03008
stm32/can: Add "auto_restart" option to constructor and init() method.
7 years ago
Damien George
d91a1989f5
docs/library/pyb.CAN: Update markup to use latest doc conventions.
7 years ago
Damien George
0db49c37a4
docs: Fix some references and RST markup to eliminate Sphinx warnings.
7 years ago
Tom Collins
4d3a92c67c
extmod/vfs_fat: Add file size as 4th element of uos.ilistdir tuple.
7 years ago
Damien George
9cef2b03a7
docs/reference/repl.rst: Fix some minor errors in the REPL tutorial.
7 years ago
Damien George
8359210e71
docs/library/uos: Document mount, umount, VfsFat and block devices.
7 years ago
Damien George
63b003d523
docs/library/uos: Create sections for distinct parts and document uname.
7 years ago
Damien George
a5fb699d87
docs/library/micropython: Describe optimisation levels for opt_level().
7 years ago
Damien George
6e09320b4c
docs/library/usocket: Make xref to uerrno explicitly a module reference.
7 years ago
Damien George
c5fe610ba1
esp8266/modnetwork: Implement WLAN.status('rssi') for STA interface.
This will return the RSSI of the AP that the STA is connected to.
7 years ago
Damien George
e05fca4ef3
docs/library/ujson: Document dump() and load() functions.
7 years ago
Damien George
9e8b7b1b63
docs/library/ujson: Update to conform with docs conventions.
The formatting of exception objects is done as per CPython conventions, eg:
:exc:`TypeError`
7 years ago
Olivier Ortigues
298b325f3e
docs/esp8266: Add a note concerning GPIO16 pull capabilities.
7 years ago
Olivier Ortigues
d072573226
docs/esp8266: Update PWM doc regarding clipping of min/max values.
7 years ago
Damien George
e708e87139
docs/library/pyb.rst: Add note about availability of USB MSC-only mode.
7 years ago
Paul Sokolovsky
5de064fbd0
docs/library/index: Elaborate uPy libraries intro.
7 years ago
Paul Sokolovsky
e37ccfe59b
docs/packages: Explicitly recommend usage of setuptools instead of distutils.
7 years ago
Paul Sokolovsky
9251f1395e
docs/packages: Use "install_dir/" in examples.
7 years ago
Paul Sokolovsky
02d2a0fb3a
docs/conf: Reference CPython 3.5 docs.
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.
7 years ago
Paul Sokolovsky
448d93a04a
docs/glossary: micropython-lib: Clarify wording.
7 years ago
Paul Sokolovsky
bf73ee114f
docs/packages: mpy_bin2res no longer required to create resources.
Everything happens automagically with overridden "sdist" from
sdist_upip.py.
7 years ago