4727bd1db8
docs/ure: Document sub(), groups(), span(), start() and end().
2018-07-02 14:55:05 +10:00
ab02abe96d
docs/uos: Make it clear that block device block_num param is an index.
2018-06-28 13:25:10 +10:00
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.
2018-06-27 16:29:26 +10:00
11a7a70a6f
docs/usocket: Minor fixes to grammar of getaddrinfo.
2018-06-27 15:18:46 +10:00
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.
2018-06-27 14:57:19 +10:00
12fde67a25
docs/ucryptolib: Add docs for new ucryptolib module.
2018-06-27 14:57:11 +10:00
b9ec6037ed
docs/library: Add documentation for ucollections.deque.
2018-06-26 14:29:22 +10:00
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.
2018-05-21 14:08:37 +10:00
c7818032b1
docs/library: Add ussl module to library index for unix port.
2018-04-26 17:14:51 +10:00
c24b0a7f2b
docs/library/pyb.ADC: Fix typo of "prarmeter".
2018-04-20 15:54:09 +10:00
0600645944
docs/library/pyb.ADC: Remove outdated ADCAll code example.
2018-04-20 15:52:28 +10:00
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.
2018-04-11 14:22:21 +10:00
aebd9701a7
stm32/adc: Optimise read_timed_multi() by caching buffer pointers.
2018-04-11 14:09:09 +10:00
4f40fa5cf4
stm32/adc: Add read_timed_multi() static method, with docs and tests.
2018-04-11 13:36:17 +10:00
8f11d0b532
docs/library/pyb.ADC.rst: Document new features for ADCAll.
2018-04-10 13:06:26 +10:00
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).
2018-03-19 15:12:24 +11:00
b7d576d69a
docs/library/pyb.CAN: Clean up documentation of data constants.
2018-03-16 18:29:43 +11:00
a25e6c6b65
stm32/can: Add CAN.info() method to retrieve error and tx/rx buf info.
2018-03-16 18:28:35 +11:00
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.
2018-03-16 17:10:41 +11:00
1272c3c65d
stm32/can: Add CAN.restart() method so controller can leave bus-off.
2018-03-15 17:29:30 +11:00
823ca03008
stm32/can: Add "auto_restart" option to constructor and init() method.
2018-03-15 17:17:33 +11:00
d91a1989f5
docs/library/pyb.CAN: Update markup to use latest doc conventions.
2018-03-15 16:30:05 +11:00
0db49c37a4
docs: Fix some references and RST markup to eliminate Sphinx warnings.
2018-03-15 15:50:51 +11:00
4d3a92c67c
extmod/vfs_fat: Add file size as 4th element of uos.ilistdir tuple.
2018-03-12 12:26:36 +11:00
8359210e71
docs/library/uos: Document mount, umount, VfsFat and block devices.
2018-03-07 14:50:38 +11:00
63b003d523
docs/library/uos: Create sections for distinct parts and document uname.
2018-03-07 14:49:25 +11:00
a5fb699d87
docs/library/micropython: Describe optimisation levels for opt_level().
2018-03-05 19:10:45 +11:00
6e09320b4c
docs/library/usocket: Make xref to uerrno explicitly a module reference.
2018-03-05 19:07:39 +11:00
c5fe610ba1
esp8266/modnetwork: Implement WLAN.status('rssi') for STA interface.
...
This will return the RSSI of the AP that the STA is connected to.
2018-02-26 16:41:13 +11:00
e05fca4ef3
docs/library/ujson: Document dump() and load() functions.
2018-02-15 11:37:48 +11:00
9e8b7b1b63
docs/library/ujson: Update to conform with docs conventions.
...
The formatting of exception objects is done as per CPython conventions, eg:
:exc:`TypeError`
2018-02-15 11:31:34 +11:00
e708e87139
docs/library/pyb.rst: Add note about availability of USB MSC-only mode.
2018-02-01 15:52:49 +11:00
5de064fbd0
docs/library/index: Elaborate uPy libraries intro.
2017-12-23 21:21:08 +02:00
46b35356e1
extmod/modframebuf: Add 8-bit greyscale format (GS8).
2017-12-14 17:36:13 +11:00
34247465c3
extmod/modframebuf: Add 2-bit color format (GS2_HMSB).
...
This format is used in 2-color LED matrices and in e-ink displays like
SSD1606.
2017-12-14 17:13:02 +11:00
3ff7040c8a
docs/library: Add xrefs to "stream" dictionary entry for many modules.
2017-12-04 18:36:20 +02:00
140acc9a32
docs/uerrno: Fix xref-vs-code markup.
2017-12-03 15:50:37 +02:00
4fee35a32c
docs/glossary: Describe the callee-owned tuple concept.
2017-12-03 15:08:39 +02:00
cb9da2279b
docs/uselect: ipoll: Fix grammar/wording of one-shot flag description.
2017-11-30 20:32:49 +02:00
7d25a19220
docs/library/utime: Fix incorrect example with ticks_diff args order.
...
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-30 14:56:08 +11:00
f59c6b48ae
docs/uselect: Describe POLLHUP/POLLERR semantics in more details.
...
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-26 09:58:19 +02:00
50cffcfe2c
docs/uctypes: Tweak descriptor reference to hopefully be easier to follow.
...
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-25 09:02:08 +02:00
c23cc4cc81
docs/uctypes: Typo/article fixes.
2017-11-25 09:01:11 +02:00
067bf849d2
docs/uselect: poll: Explicitly specify that no-timeout value is -1.
2017-11-23 18:03:32 +02:00
ec1e9a10a7
docs: Add notes on heap allocation caused by bound method refs.
2017-11-23 11:35:58 +11:00
31550a52e4
docs/library/network: Enhance AbstractNIC.status to take an argument.
...
The argument is optional and if given should be a string naming the
status variable to query.
2017-11-16 14:48:04 +11:00
579b86451d
docs/_thread: Add a placeholder docs for _thread module.
...
Doesn't list specific API calls yet, the purpose is to let user know that
the module exists.
2017-11-10 00:09:43 +02:00
5b1b80a8db
docs/ure: Emphasize not supported features more.
...
Plus, additional descriptions/formatting.
2017-11-08 00:24:39 +02:00
ad5a6f5917
docs/ure: Add flags arg to ure.compile(), mention that ure.DEBUG is optional.
2017-11-04 00:26:31 +02:00
80e3f07e7f
docs/ure: Add "|" (alternative) to the list of supported operators.
2017-10-31 14:46:08 +02:00
b81fbf938f
docs/usocket: Document that settimeout() isn't supported by all ports.
...
And describe an alternative of using uselect.poll().
2017-10-31 00:28:28 +02:00
6fb093282b
docs/ussl: Fix module name refs and use "MicroPython port" term.
2017-10-30 18:03:54 +02:00
b9923262db
docs/library/network: Add dhcp_hostname parameter
...
I have not actually tested this, going by information available in https://forum.micropython.org/viewtopic.php?t=2584
2017-10-27 11:04:52 +03:00
a33fca99a1
docs/usocket: Document inet_ntop(), inet_pton().
2017-10-27 00:27:27 +03:00
d1cd533134
docs/usocket: Elaborate descriptions.
...
Use the "usocket" module name everywhere. Use "MicroPython port"
terminology. Suggest to avoid using IPPROTO_* constants in socket()
call.
2017-10-26 14:20:37 +03:00
328c1e78be
docs/uselect: Document one-shot polling mode.
2017-10-26 00:30:07 +03:00
d90ade5e3e
docs/library/network: Update docs to state that W5500 is supported.
2017-10-16 15:51:56 +11:00
65ba481cb0
stm32/modnwwiznet5k: Implement WIZNET5K.isconnected() method.
2017-10-16 13:16:00 +11:00
b1457db002
docs/library: Add missing cross-ref links for classes in pyb module.
2017-10-11 11:30:16 +11:00
add933feaf
docs/library/network: Clarify usage of "bssid" arg in connect() method.
2017-10-09 23:11:25 +11:00
72491b3e40
docs/btree: Describe page caching policy of the underlying implementation.
2017-09-17 21:35:33 +03:00
d42b89bc3a
docs/library/framebuf.rst: Generalise constructor to all colour formats.
2017-09-13 16:36:57 +10:00
fe6f0354f6
docs/library/micropython: Fix typo in RST formatting.
2017-08-29 16:53:30 +10:00
e30ba2f1c7
docs/library: Add description of "index" parameter to uos.dupterm().
2017-08-29 16:50:28 +10:00
d5336ba136
docs/machine.Signal: Improve style/grammar and add usage example.
2017-08-29 00:08:40 +03:00
c5c095690f
docs/library/network: Fix ref to "socket" module (should be "usocket").
2017-08-28 14:00:16 +03:00
358a7ba014
docs: More xrefs to "MicroPython port" in glossary.
2017-08-28 13:51:05 +03:00
64a3c52f66
docs: Consistently link to micropython-lib in glossary.
2017-08-22 09:33:31 +03:00
3f91570483
docs/library/usocket: Describe complete information on address formats.
...
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-20 09:49:12 +03:00
ccaad53270
docs/library/usocket: Move socket.error to its own section.
...
It's too minor a point to start the module description with it.
2017-08-20 09:04:48 +03:00
0aa1d3f447
docs/library/ubinascii: Update base64 docs.
...
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-17 09:25:51 +03:00
c127ace28a
docs/library/machine.RTC.rst: Fix typo.
2017-08-14 15:42:25 +10:00
c9a48eb464
docs,teensy: Use the name MicroPython consistently in documentation
2017-07-15 11:44:32 +02:00
503cf3d097
docs/uzlib: Update description of decompress() and mention DecompIO.
2017-07-04 02:32:42 +03:00
ffb13cc633
docs/uerrno: Document "uerrno" module.
2017-07-03 00:55:09 +03:00
465d84b7e7
docs/library: Add CPython docs xref to each pertinent module.
...
Cross-reference text/link is implemented as RST substitution, so easy to
consistently.
2017-07-02 15:37:31 +03:00
d80ecad03f
docs/ure: Elaborate doc, update markup to the latest conventions.
2017-07-02 02:01:47 +03:00
d42bb58c33
docs/builtins: Add AssertionError, SyntaxError, ZeroDivisionError.
...
Also, update heading of 1st sections to "Functions and types".
2017-07-01 22:20:49 +03:00
8b7d311595
reference/index: Rewrite introduction paragraph to avoid confusion.
...
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-07-01 22:09:40 +03:00
871a45dd0c
docs/{uselect,ussl,ustruct}: Use markup adhering to latest docs conventions.
2017-06-30 14:50:52 +03:00
1942f0ceef
docs/{framebuf,usocket}: Use markup adhering to the latest docs conventions.
2017-06-29 02:22:14 +03:00
f8ac28964d
docs/{micropython,sys,uos}: Use markup adhering to the latest docs conventions.
2017-06-28 00:37:47 +03:00
fbd252b77c
docs/{esp,pyb,ubinascii}: Use markup adhering to the latest docs conventions.
2017-06-27 00:38:05 +03:00
7a4694fc4e
docs/library/gc: Fix grammar and improve readability of gc.threshold().
2017-06-26 15:25:51 +10:00
dd16e21562
docs/network: Use markup adhering to the latest docs conventions.
2017-06-26 00:37:30 +03:00
7c0e1f1a08
docs/machine*: Use markup adhering to the latest docs conventions.
2017-06-25 13:30:29 +03:00
cfce7d784e
docs/lcd160cr: Group related constants together. Use full sentences.
...
Per the latest docs conventions.
2017-06-25 13:28:23 +03:00
6f87b03e3c
docs/utime: Use markup adhering to the latest conventions.
2017-06-25 00:54:38 +03:00
1e31d4bdf6
docs/lcd160cr: Use markup adhering to the latest conventions.
2017-06-25 00:46:07 +03:00
7f2bc83dbc
docs/btree: Use markup adhering to the latest conventions.
2017-06-25 00:17:18 +03:00
bc790b5145
docs/builtins: List builtin exceptions.
...
If for nothing else, then at least to cross-reference them.
2017-06-24 23:45:38 +03:00
c4e3a03fa5
docs/gc: Document gc.threshold() function.
2017-06-24 13:35:41 +03:00
4cdddfed8e
docs/gc: Mark mem_alloc()/mem_free() as uPy-specific.
2017-06-24 13:12:09 +03:00
94696973a0
docs/select: Rename to uselect, to match the actual module name.
...
Also, add ipoll() documentation and markup changes to comply with CPython
usage.
2017-06-16 11:28:06 +03:00
fd860dc552
stmhal: Add .value() method to Switch object, to mirror Pin and Signal.
2017-06-15 17:34:51 +10:00
08c73d9734
docs/btree: Typo/wording fixes.
2017-06-11 18:23:13 +03:00
6ca086a89a
docs/btree: Add hints about opening db file and need to flush db.
2017-06-11 17:44:11 +03:00
cd64b3082e
docs/network: First step to describe standard network class interface.
...
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-04 21:25:23 +03:00
f245f5d7cc
docs/machine: Sort machine classes in logical order, not alphabetically.
...
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-03 14:50:54 +03:00
e91b1cdae3
docs/uos: Move cc3200 port legacy VFS mounting functions to its ref doc.
...
This patch also unconditionalizes uos.dupterm(), though exact interface
and semantics is yet to be defined.
2017-06-03 14:19:53 +03:00
1ce44f3046
docs/uos: Deconditionalize, remove minor port-specific details.
...
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-03 13:51:13 +03:00
92206a78ae
docs/network: Move confusingly-named cc3200 Server class to its reference.
...
cc3200 port has network.Server class to control behavior of builtin
Telnet/FTP server of that port.
2017-06-03 13:34:28 +03:00
d5b8825d5f
docs/machine.Pin: Add on() and off() methods.
2017-05-29 20:56:13 +03:00
3496d9e4bd
docs/machine.Pin: Remove out_value() method.
...
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-29 20:51:30 +03:00
ca16c38210
various: Spelling fixes
2017-05-29 11:36:05 +03:00
3ebd67fc09
library/machine.Pin: Remove .id() method and .board class attr.
...
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-21 15:50:16 +03:00
436d97b3f9
docs/library/machine.UART: Update and improve uart.any() docs.
2017-05-19 15:48:22 +10:00
d007351b33
docs/library/micropython: Document the newer micropython functions.
2017-05-18 00:25:09 +10:00
f351c6db5e
drivers/display/lcd160cr: Fix get_line method and enhance screen_dump.
...
The docs are updated and describe the new behaviour of these methods.
2017-05-17 19:53:13 +10:00
d5713c8618
docs/library/index: Add important summary of the intro section as warning.
...
To make them harder to miss.
2017-05-15 00:26:44 +03:00
0ba136fbe9
docs/machine.Signal: Add initial draft description of Signal class.
2017-05-14 23:12:06 +03:00
c19f07bd52
docs/machine.Pin: There's no toggle() method in MicroPython hardware API.
...
May be a port-specific method, not portable, not part of the official
specification.
2017-05-14 22:52:16 +03:00
6d221fe284
docs/library/uos: Add description of uos.ilistdir() function.
2017-05-10 12:44:21 +10:00
29b26f3922
docs/library/machine.SPI: Fix formatting of bullet list to stop warning.
2017-04-18 15:40:04 +10:00
850f79e552
docs/library/machine.I2C: Remove WiPy-specific return values.
...
cc3200 has been updated to conform to the API and now returns None.
2017-04-18 15:39:27 +10:00
d4675e7674
docs/library/machine.*: Add cross-reference label to individual classes.
2017-04-18 15:27:37 +10:00
1f1a03d0c3
docs/library/machine.I2C: Deconditionalise all methods.
...
The cc3200 port is now similar enough to the standard machine.I2C API so
that all conditionals can be removed.
2017-04-18 15:04:51 +10:00
fabaa61437
docs/library/machine.UART: Remove pyboard-specific section.
...
stmhal doesn't have a machine.UART class so this section is not needed.
2017-04-18 12:13:51 +10:00
a78703f188
docs/library/machine: Typo fix in machine_callbacks section.
2017-04-16 10:14:05 +03:00
9ef6bb5480
docs/machine: Move machine.main() misnomer to wipy's known issues.
2017-04-16 10:12:01 +03:00
a8ece0358f
docs/machine.UART: Deconditionalize normal methods.
2017-04-16 09:54:55 +03:00
ac8843ceec
docs/library/ussl: Deconditionalize, wipy notes moved to its documentation.
2017-04-16 09:41:32 +03:00
a0fb360f1b
docs/library/uos: urandom: Generalize description.
...
Don't give a guarantee of HW RNG, only a possibility of its usage.
2017-04-16 09:22:47 +03:00
ae831ec0a8
docs/library/micropython: Deconditionalize.
2017-04-16 09:18:47 +03:00
b87432b8fb
docs/uhashlib: Deconditionalize.
...
Notes on WiPy incompatibilities with the standard module API are
moved under "Known issues" to its documentation.
2017-04-09 00:57:54 +03:00
2e58474580
docs/usocket: Deconditionalize.
...
Notes on WiPy incompatibilities with the standard socket module API are
moved under "Known issues" to its documentation.
2017-04-09 00:48:28 +03:00
3acace588a
docs/utime: Deconditionalize description of sleep().
2017-04-09 00:42:32 +03:00
1d74559b6b
docs/library/machine.UART: Remove some conditionals.
2017-04-09 00:25:27 +03:00
bcf3c8bf17
docs/library/builtins: int: Add notice on byteorder param for to/from_bytes.
2017-04-09 00:06:54 +03:00
390d5a3bf1
docs/machine.Pin: Move wipy-specific methods to its docs.
2017-04-05 13:05:04 +03:00
d46899626e
docs/machine.Pin: Move wipy-specific details to its own docs.
2017-04-05 12:09:36 +03:00
9a38b7afe0
cc3200/modmachine: Return frequency value directly, like other ports.
2017-04-05 11:58:17 +03:00
4333b2fb53
docs/machine.SPI: Remove outdated wipy chunk.
2017-04-05 11:47:15 +03:00
906d58f6f2
docs/uos: De-conditionalize statvfs() description.
...
It's a standard function, and it's already described (in the library
intro) that for any given port, any function may be missing.
2017-04-05 11:44:10 +03:00
0a861db91c
docs/utime: De-conditionalize description of sleep_ms() and friends.
...
These are basic MicroPython API, and all ports should implement them.
2017-04-05 11:40:47 +03:00
468c6f9da1
extmod/modframebuf: Make monochrome bitmap formats start with MONO_.
...
MONO_xxx is much easier to read if you're not familiar with the code.
MVLSB is deprecated but kept for backwards compatibility, for the time
being.
This patch also updates the associated docs and tests.
2017-04-04 17:38:33 +10:00
bb296482c3
docs/library/btree: Add btree module docs.
2017-04-04 00:29:23 +03:00
fb981107eb
docs/library/machine.I2C: Fix scan() doc to match implementation.
...
Since eaef6b5324
2017-03-20 15:30:41 +11:00
9b80a1e3e9
utime module documentation fixes and cleanup:
...
* Fix mis-spelling of `ticks_add` in code examples.
* Be consistent about parentheses after function names.
* Be consistent about formatting of function, variable and constant names.
* Be consistent about spaces and punctuation.
* Fix some language errors (missing or wrong words, wrong word order).
* Keep line length under 90 chars.
Signed-off-by: Christopher Arndt <chris@chrisarndt.de>
2017-03-17 20:45:08 +03:00
fcab435607
docs/library/framebuf: Fix typo in bit-width for MVLSB description.
2017-03-15 21:54:56 +11:00
2646b9e022
docs/library/lcd160cr: Add link to framebuf page.
2017-03-07 18:17:40 +11:00
f9d18d96b7
docs/library: Add framebuf documentation.
2017-03-07 18:16:46 +11:00
1f549a3496
docs/library/lcd160cr: Add note about supported JPEG format/encodings.
2017-02-28 17:45:24 +11:00
ed81574fe9
docs/machine: Fix formatting of Constants section.
...
Render related constants grouped together, with common description.
2017-02-28 00:38:15 +03:00
e2f1a8a7ee
docs/uhashlib: Provide port-neutral description.
...
TODO: Remove WiPy-specific chunks.
2017-02-26 00:55:33 +03:00
d80df91ef2
docs/library/lcd160cr: Mention the valid values for set_power() method.
2017-02-17 16:57:22 +11:00
ee3615d800
docs/uos: Remove mention of uos.sep.
...
MicroPython guarantees '/' to be a path separator, so extra constant taking
precious ROM space are not needed. MicroPython never had such constant, only
one vendor port had it (now unmaintained).
2017-02-14 13:14:46 +03:00
0c821f7def
docs/library/machine: Make separate TOC for WiPy vs non-WiPy.
...
WiPy is the only port with ADC and SD, so they shouldn't be included in
other ports' documentation.
2017-02-13 13:06:51 +11:00
2f76c3ca0a
docs/library/pyb.Pin: Minor typo fix, B6 should be A0.
...
On the PYBv1.0, X1 maps to A0, not B6.
2017-02-13 11:52:44 +11:00
27c149efe0
stmhal: Add pyb.fault_debug() function, to control hard-fault behaviour.
...
This new function controls what happens on a hard-fault:
- debugging disabled: board will do a reset
- debugging enabled: board will print registers and stack and flash LEDs
The default is disabled, ie to do a reset. This is different to previous
behaviour which flashed the LEDs and waited indefinitely.
2017-02-06 13:22:17 +11:00
d5e9ab6e61
extmod/machine_pulse: Make time_pulse_us() not throw exceptions.
...
machine.time_pulse_us() is intended to provide very fine timing, including
while working with signal bursts, where each transition is tracked in row.
Throwing and handling an exception may take too much time and "signal loss".
So instead, in case of a timeout, just return negative value. Cases of
timeout while waiting for initial signal stabilization, and during actual
timing, are recognized.
The documentation is updated accordingly, and rewritten somewhat to clarify
the function behavior.
2017-02-05 14:20:17 +03:00
50a9dd59f5
docs: For LCD160CR driver and tutorial, add link to positioning image.
2017-02-03 12:48:54 +11:00
0ddeedfc73
docs/uio: Typo fixes/lexical improvements.
2017-01-29 16:18:33 +03:00
ef6fb66d23
docs/uio: Describe differences between uPy an CPy stream hierarchy.
2017-01-28 16:35:40 +03:00
6947a7f6a9
docs/usocket: Dedent Methods section.
...
This was apparently of an ::only directive which was later removed.
2017-01-28 15:49:54 +03:00
f23c47fea7
docs/usocket: Clarify description of various methods.
2017-01-28 15:39:18 +03:00
74fcb122f0
docs/usocket: Elaborate "Constants" section.
2017-01-28 14:46:58 +03:00
59540dccf1
docs/usocket: Clarify exceptions used.
2017-01-28 13:55:51 +03:00
0aa83142a4
docs/machine: Add explicit note on machine module level and scope.
...
It's very low, hardware level, with associated constraints on operations
and callbacks.
2017-01-28 12:08:25 +03:00
56e7ebf07a
docs/machine.Timer: Move WiPy adhoc parts to its documentation.
2017-01-28 12:08:00 +03:00
c707668d9e
docs/library/lcd160cr: Fix set_brightness range, should be 0..31.
2017-01-24 00:17:39 +11:00
e72e343908
docs: Add documentation for lcd160cr module.
2017-01-23 14:37:10 +11:00
a79f6676c3
docs: Fix some minor spelling mistakes.
...
paramter -> parameter
send a receive -> send and receive
repsonse -> response
particualr -> particular
constructore -> constructor
2017-01-18 15:30:31 +11:00
a1a8f01799
docs/usocket: Clarify that socket timeout raises OSError exception.
2017-01-07 14:23:33 +03:00
36ec5c8f27
docs/library/esp: Remove para and add further warning about flash.
...
There is no longer space reserved by default for native code.
2017-01-06 18:32:49 +11:00
c3f70c603e
docs/library/esp: Document esp.set_native_code_location() function.
2017-01-04 23:48:19 +11:00
d377c83794
docs/library/machine.I2C: Fix I2C constructor docs to match impl.
2016-12-30 15:25:48 +11:00
a5b3c7e7f9
docs/library/pyb.UART: Moved writechar doc to sit with other writes.
2016-12-15 09:59:45 +11:00
0caac94b98
docs/library/pyb.UART: Added clarification about timeouts.
2016-12-15 09:59:32 +11:00
46e59c52af
docs/library/pyb.Accel: Add hardware note about pins used by accel.
2016-12-02 17:39:13 +11:00
63a5df3cb4
docs/library/machine.I2C: Refine definitions of I2C methods.
2016-11-23 17:05:02 +11:00
64db4080ce
docs/library/index: Elaborate on u-modules.
...
Also, remove an "only" directive in u-modules description.
2016-11-16 01:18:19 +03:00
a392b3aa75
docs: Remove references to readall() and update stream read() docs.
2016-11-14 23:31:40 +11:00
c4e58eaa98
stmhal/i2c: Add option to I2C to enable/disable use of DMA transfers.
...
New keyword option in constructor and init() method is "dma=<bool>".
DMA is now disabled by default for I2C transfers because it currently does
not handle I2C bus errors very well (eg if slave device doesn't ACK or
NACK correctly during a transfer).
2016-11-11 17:36:19 +11:00
3e5e4f95b2
docs/library/machine.Pin: Update Pin docs to align with new HW API.
2016-11-09 11:08:01 +11:00
805f7ea2f2
docs/utime: Add docs for ticks_add(), improvements for other ticks_*().
2016-11-01 00:14:12 +03:00
8679d9e6a6
docs/utime: Remove only:: for ticks_diff().
...
It's mandatory function which should be present in every port. Even if
it's not, in the stdlib intro we waarn users that a particular port can
lack anything of described in the docs.
2016-11-01 00:03:40 +03:00
d60ad5cf53
docs/utime: Describe new semantics of ticks_diff() (signed ring arithmetics).
2016-10-31 00:17:56 +03:00
153665f159
docs/utime: Document ticks_cpu() in more detail.
...
Also, drop ::only directive.
2016-10-30 23:15:28 +03:00
7219a18d17
docs/library/index: Update TOCs so builtins sorted before modules.
2016-10-30 23:13:52 +03:00
c28f9df63a
docs/library/network: Typo fixes, consistent acronym capitalization.
2016-10-28 12:03:35 +03:00
b9a88683a4
docs/library/network: Reword intro paragraph.
2016-10-28 04:42:27 +03:00
67c91df7e8
docs/machine.SPI.rst: Fix typos and formatting, clarify.
...
Clarify the class implements master side of the protocol, also put adhoc
WiPy paramter after the generic, described in the current Hardware API
version.
2016-10-25 17:03:35 +03:00
f1b2b1b600
docs/library/builtins: Add docs for delattr and slice.
2016-10-25 11:02:47 +11:00
266e4acdc2
docs/library/machine.SPI: Remove spurious "of".
2016-10-24 14:41:21 +11:00
f12047f66d
docs/machine.SPI: Improve descriptions of xfer methods.
...
In particular remove the "*" because not all ports support keyword
arguments.
2016-10-18 10:14:26 +11:00
a0b2f48c2f
docs/machine.SPI: Bring up to date with Hardware API, make vendor-neutral.
2016-10-17 18:05:16 +03:00
00c1fc6d77
docs/uos: Add uos.statvfs() documentation.
2016-10-07 13:16:54 +11:00
eb239b8398
stmhal/usb: Add support to receive USB HID messages from host.
2016-10-04 15:38:01 +11:00
219245e10f
extmod/machine_i2c: Add support for the addrsize parameter in mem xfers.
...
The memory read/write I2C functions now take an optional keyword-only
parameter that specifies the number of bits in the memory address.
Only mem-addrs that are a multiple of 8-bits are supported (otherwise
the behaviour is undefined).
Due to the integer type used for the address, for values larger than 32
bits, only 32 bits of address will be sent, and the rest will be padded
with 0s. Right now no exception is raised when that happens. For values
smaller than 8, no address is sent. Also no exception then.
Tested with a VL6180 sensor, which has 16-bit register addresses.
Due to code refactoring, this patch reduces stmhal and esp8266 builds
by about 50 bytes.
2016-09-28 14:45:29 +10:00
eeb9d99333
docs/library/machine: Update description of disable/enable IRQ funcs.
2016-09-23 13:15:58 +10:00
4ab3eef8d7
docs/library/pyb.SPI: init(): Describe "bits" argument.
...
Based on https://github.com/micropython/micropython/pull/2210 .
2016-09-18 21:41:21 +03:00
f3b5480be7
stmhal,cc3200,esp8266: Consistently use PWRON_RESET constant.
...
machine.POWER_ON is renamed to machine.PWRON_RESET to match other
reset-cause constants that all end in _RESET. The cc3200 port keeps a
legacy definition of POWER_ON for backwards compatibility.
2016-09-08 12:50:38 +10:00
4a9542c0c0
docs/library/machine.WDT: Add that WDT is available on pyboard.
2016-09-06 14:20:52 +10:00
0f8b1ba8a2
docs/library: Add reference for pyb.usb_mode and pyb.USB_HID.
2016-08-29 15:17:20 +10:00
64c5a9435c
docs/library/machine.WDT: Add note that WDT is only available on WiPy.
2016-08-17 14:22:39 +10:00
5c73de0337
docs/uio: Mention seek()/flush() support for io.BytesIO.
2016-08-09 01:52:56 +03:00
fdb411a8c5
docs/library/index: Include array module in ToC.
2016-08-07 00:16:41 +03:00
8a0b6f561c
docs/array: Document array module.
2016-08-07 00:13:48 +03:00
ce166e6b68
docs: Spelling mistakes
2016-08-02 11:17:46 +03:00
Damien George
Yonatan Goldschmidt
Paul Sokolovsky
Peter Hinch
T S
Tom Collins
Petr Viktorin
Paul Carver
Joar Wandborg
Mike Causer
Alex Robbins
Javier Candeira
Alexander Steffen
Ville Skyttä
transistortim
Christopher Arndt
Rami Ali
Dave Hylands
Lorenz Schmid
Alex March
Philip Potter
Radomir Dopieralski