Damien George
3e0d587a49
docs/library/machine: Remove conditional docs for rng function.
...
And instead list its availability explicitly.
2018-07-18 16:28:30 +10:00
Damien George
163cc66a0b
docs/library/machine: Remove conditional docs for wake_reason function.
...
And instead list its availability explicitly.
2018-07-18 16:23:34 +10:00
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.
2018-07-18 16:20:53 +10:00
Damien George
164377f806
docs/library/pyb.DAC: Fix typo in markup to balance quotes.
2018-07-18 15:52:48 +10:00
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.
2018-07-18 15:47:44 +10:00
Damien George
41226e9a18
docs/ure: Document some more supported regex operators.
2018-07-02 14:55:05 +10:00
Damien George
4727bd1db8
docs/ure: Document sub(), groups(), span(), start() and end().
2018-07-02 14:55:05 +10:00
Damien George
ab02abe96d
docs/uos: Make it clear that block device block_num param is an index.
2018-06-28 13:25:10 +10:00
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.
2018-06-27 16:29:26 +10:00
Damien George
11a7a70a6f
docs/usocket: Minor fixes to grammar of getaddrinfo.
2018-06-27 15:18:46 +10:00
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.
2018-06-27 14:57:19 +10:00
Paul Sokolovsky
12fde67a25
docs/ucryptolib: Add docs for new ucryptolib module.
2018-06-27 14:57:11 +10:00
Damien George
b9ec6037ed
docs/library: Add documentation for ucollections.deque.
2018-06-26 14:29:22 +10:00
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.
2018-05-21 14:08:37 +10:00
Damien George
c7818032b1
docs/library: Add ussl module to library index for unix port.
2018-04-26 17:14:51 +10:00
Damien George
c24b0a7f2b
docs/library/pyb.ADC: Fix typo of "prarmeter".
2018-04-20 15:54:09 +10:00
Peter Hinch
0600645944
docs/library/pyb.ADC: Remove outdated ADCAll code example.
2018-04-20 15:52:28 +10:00
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.
2018-04-11 14:22:21 +10:00
Damien George
aebd9701a7
stm32/adc: Optimise read_timed_multi() by caching buffer pointers.
2018-04-11 14:09:09 +10:00
Peter Hinch
4f40fa5cf4
stm32/adc: Add read_timed_multi() static method, with docs and tests.
2018-04-11 13:36:17 +10:00
T S
8f11d0b532
docs/library/pyb.ADC.rst: Document new features for ADCAll.
2018-04-10 13:06:26 +10:00
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).
2018-03-19 15:12:24 +11:00
Damien George
b7d576d69a
docs/library/pyb.CAN: Clean up documentation of data constants.
2018-03-16 18:29:43 +11:00
Damien George
a25e6c6b65
stm32/can: Add CAN.info() method to retrieve error and tx/rx buf info.
2018-03-16 18:28:35 +11:00
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.
2018-03-16 17:10:41 +11:00
Damien George
1272c3c65d
stm32/can: Add CAN.restart() method so controller can leave bus-off.
2018-03-15 17:29:30 +11:00
Damien George
823ca03008
stm32/can: Add "auto_restart" option to constructor and init() method.
2018-03-15 17:17:33 +11:00
Damien George
d91a1989f5
docs/library/pyb.CAN: Update markup to use latest doc conventions.
2018-03-15 16:30:05 +11:00
Damien George
0db49c37a4
docs: Fix some references and RST markup to eliminate Sphinx warnings.
2018-03-15 15:50:51 +11:00
Tom Collins
4d3a92c67c
extmod/vfs_fat: Add file size as 4th element of uos.ilistdir tuple.
2018-03-12 12:26:36 +11:00
Damien George
8359210e71
docs/library/uos: Document mount, umount, VfsFat and block devices.
2018-03-07 14:50:38 +11:00
Damien George
63b003d523
docs/library/uos: Create sections for distinct parts and document uname.
2018-03-07 14:49:25 +11:00
Damien George
a5fb699d87
docs/library/micropython: Describe optimisation levels for opt_level().
2018-03-05 19:10:45 +11:00
Damien George
6e09320b4c
docs/library/usocket: Make xref to uerrno explicitly a module reference.
2018-03-05 19:07:39 +11:00
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.
2018-02-26 16:41:13 +11:00
Damien George
e05fca4ef3
docs/library/ujson: Document dump() and load() functions.
2018-02-15 11:37:48 +11:00
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`
2018-02-15 11:31:34 +11:00
Damien George
e708e87139
docs/library/pyb.rst: Add note about availability of USB MSC-only mode.
2018-02-01 15:52:49 +11:00
Paul Sokolovsky
5de064fbd0
docs/library/index: Elaborate uPy libraries intro.
2017-12-23 21:21:08 +02:00
Damien George
46b35356e1
extmod/modframebuf: Add 8-bit greyscale format (GS8).
2017-12-14 17:36:13 +11:00
Petr Viktorin
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
Paul Sokolovsky
3ff7040c8a
docs/library: Add xrefs to "stream" dictionary entry for many modules.
2017-12-04 18:36:20 +02:00
Paul Sokolovsky
140acc9a32
docs/uerrno: Fix xref-vs-code markup.
2017-12-03 15:50:37 +02:00
Paul Sokolovsky
4fee35a32c
docs/glossary: Describe the callee-owned tuple concept.
2017-12-03 15:08:39 +02:00
Paul Sokolovsky
cb9da2279b
docs/uselect: ipoll: Fix grammar/wording of one-shot flag description.
2017-11-30 20:32:49 +02:00
Paul Carver
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
Paul Sokolovsky
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
Paul Sokolovsky
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
Paul Sokolovsky
c23cc4cc81
docs/uctypes: Typo/article fixes.
2017-11-25 09:01:11 +02:00
Paul Sokolovsky
067bf849d2
docs/uselect: poll: Explicitly specify that no-timeout value is -1.
2017-11-23 18:03:32 +02:00
Peter Hinch
ec1e9a10a7
docs: Add notes on heap allocation caused by bound method refs.
2017-11-23 11:35:58 +11:00
Damien George
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
Paul Sokolovsky
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
Paul Sokolovsky
5b1b80a8db
docs/ure: Emphasize not supported features more.
...
Plus, additional descriptions/formatting.
2017-11-08 00:24:39 +02:00
Paul Sokolovsky
ad5a6f5917
docs/ure: Add flags arg to ure.compile(), mention that ure.DEBUG is optional.
2017-11-04 00:26:31 +02:00
Paul Sokolovsky
80e3f07e7f
docs/ure: Add "|" (alternative) to the list of supported operators.
2017-10-31 14:46:08 +02:00
Paul Sokolovsky
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
Paul Sokolovsky
6fb093282b
docs/ussl: Fix module name refs and use "MicroPython port" term.
2017-10-30 18:03:54 +02:00
Joar Wandborg
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
Paul Sokolovsky
a33fca99a1
docs/usocket: Document inet_ntop(), inet_pton().
2017-10-27 00:27:27 +03:00
Paul Sokolovsky
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
Paul Sokolovsky
328c1e78be
docs/uselect: Document one-shot polling mode.
2017-10-26 00:30:07 +03:00
Damien George
d90ade5e3e
docs/library/network: Update docs to state that W5500 is supported.
2017-10-16 15:51:56 +11:00
Damien George
65ba481cb0
stm32/modnwwiznet5k: Implement WIZNET5K.isconnected() method.
2017-10-16 13:16:00 +11:00
Mike Causer
b1457db002
docs/library: Add missing cross-ref links for classes in pyb module.
2017-10-11 11:30:16 +11:00
Damien George
add933feaf
docs/library/network: Clarify usage of "bssid" arg in connect() method.
2017-10-09 23:11:25 +11:00
Paul Sokolovsky
72491b3e40
docs/btree: Describe page caching policy of the underlying implementation.
2017-09-17 21:35:33 +03:00
Peter Hinch
d42b89bc3a
docs/library/framebuf.rst: Generalise constructor to all colour formats.
2017-09-13 16:36:57 +10:00
Damien George
fe6f0354f6
docs/library/micropython: Fix typo in RST formatting.
2017-08-29 16:53:30 +10:00
Damien George
e30ba2f1c7
docs/library: Add description of "index" parameter to uos.dupterm().
2017-08-29 16:50:28 +10:00
Paul Sokolovsky
d5336ba136
docs/machine.Signal: Improve style/grammar and add usage example.
2017-08-29 00:08:40 +03:00
Paul Sokolovsky
c5c095690f
docs/library/network: Fix ref to "socket" module (should be "usocket").
2017-08-28 14:00:16 +03:00
Paul Sokolovsky
358a7ba014
docs: More xrefs to "MicroPython port" in glossary.
2017-08-28 13:51:05 +03:00
Paul Sokolovsky
64a3c52f66
docs: Consistently link to micropython-lib in glossary.
2017-08-22 09:33:31 +03:00
Paul Sokolovsky
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
Paul Sokolovsky
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
Alex Robbins
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
Javier Candeira
c127ace28a
docs/library/machine.RTC.rst: Fix typo.
2017-08-14 15:42:25 +10:00
Alexander Steffen
c9a48eb464
docs,teensy: Use the name MicroPython consistently in documentation
2017-07-15 11:44:32 +02:00
Paul Sokolovsky
503cf3d097
docs/uzlib: Update description of decompress() and mention DecompIO.
2017-07-04 02:32:42 +03:00
Paul Sokolovsky
ffb13cc633
docs/uerrno: Document "uerrno" module.
2017-07-03 00:55:09 +03:00
Paul Sokolovsky
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
Paul Sokolovsky
d80ecad03f
docs/ure: Elaborate doc, update markup to the latest conventions.
2017-07-02 02:01:47 +03:00
Paul Sokolovsky
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
Paul Sokolovsky
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
Paul Sokolovsky
871a45dd0c
docs/{uselect,ussl,ustruct}: Use markup adhering to latest docs conventions.
2017-06-30 14:50:52 +03:00
Paul Sokolovsky
1942f0ceef
docs/{framebuf,usocket}: Use markup adhering to the latest docs conventions.
2017-06-29 02:22:14 +03:00
Paul Sokolovsky
f8ac28964d
docs/{micropython,sys,uos}: Use markup adhering to the latest docs conventions.
2017-06-28 00:37:47 +03:00
Paul Sokolovsky
fbd252b77c
docs/{esp,pyb,ubinascii}: Use markup adhering to the latest docs conventions.
2017-06-27 00:38:05 +03:00
Damien George
7a4694fc4e
docs/library/gc: Fix grammar and improve readability of gc.threshold().
2017-06-26 15:25:51 +10:00
Paul Sokolovsky
dd16e21562
docs/network: Use markup adhering to the latest docs conventions.
2017-06-26 00:37:30 +03:00
Paul Sokolovsky
7c0e1f1a08
docs/machine*: Use markup adhering to the latest docs conventions.
2017-06-25 13:30:29 +03:00
Paul Sokolovsky
cfce7d784e
docs/lcd160cr: Group related constants together. Use full sentences.
...
Per the latest docs conventions.
2017-06-25 13:28:23 +03:00
Paul Sokolovsky
6f87b03e3c
docs/utime: Use markup adhering to the latest conventions.
2017-06-25 00:54:38 +03:00
Paul Sokolovsky
1e31d4bdf6
docs/lcd160cr: Use markup adhering to the latest conventions.
2017-06-25 00:46:07 +03:00
Paul Sokolovsky
7f2bc83dbc
docs/btree: Use markup adhering to the latest conventions.
2017-06-25 00:17:18 +03:00
Paul Sokolovsky
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
Paul Sokolovsky
c4e3a03fa5
docs/gc: Document gc.threshold() function.
2017-06-24 13:35:41 +03:00
Paul Sokolovsky
4cdddfed8e
docs/gc: Mark mem_alloc()/mem_free() as uPy-specific.
2017-06-24 13:12:09 +03:00
Paul Sokolovsky
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
Damien George
fd860dc552
stmhal: Add .value() method to Switch object, to mirror Pin and Signal.
2017-06-15 17:34:51 +10:00
Paul Sokolovsky
08c73d9734
docs/btree: Typo/wording fixes.
2017-06-11 18:23:13 +03:00
Paul Sokolovsky
6ca086a89a
docs/btree: Add hints about opening db file and need to flush db.
2017-06-11 17:44:11 +03:00
Paul Sokolovsky
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
Paul Sokolovsky
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
Paul Sokolovsky
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
Paul Sokolovsky
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
Paul Sokolovsky
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
Paul Sokolovsky
d5b8825d5f
docs/machine.Pin: Add on() and off() methods.
2017-05-29 20:56:13 +03:00
Paul Sokolovsky
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
Ville Skyttä
ca16c38210
various: Spelling fixes
2017-05-29 11:36:05 +03:00
Paul Sokolovsky
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
Damien George
436d97b3f9
docs/library/machine.UART: Update and improve uart.any() docs.
2017-05-19 15:48:22 +10:00
Damien George
d007351b33
docs/library/micropython: Document the newer micropython functions.
2017-05-18 00:25:09 +10:00
Damien George
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
Paul Sokolovsky
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
Paul Sokolovsky
0ba136fbe9
docs/machine.Signal: Add initial draft description of Signal class.
2017-05-14 23:12:06 +03:00
Paul Sokolovsky
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
Damien George
6d221fe284
docs/library/uos: Add description of uos.ilistdir() function.
2017-05-10 12:44:21 +10:00
Damien George
29b26f3922
docs/library/machine.SPI: Fix formatting of bullet list to stop warning.
2017-04-18 15:40:04 +10:00
Damien George
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
Damien George
d4675e7674
docs/library/machine.*: Add cross-reference label to individual classes.
2017-04-18 15:27:37 +10:00
Damien George
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
Damien George
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
Paul Sokolovsky
a78703f188
docs/library/machine: Typo fix in machine_callbacks section.
2017-04-16 10:14:05 +03:00
Paul Sokolovsky
9ef6bb5480
docs/machine: Move machine.main() misnomer to wipy's known issues.
2017-04-16 10:12:01 +03:00
Paul Sokolovsky
a8ece0358f
docs/machine.UART: Deconditionalize normal methods.
2017-04-16 09:54:55 +03:00
Paul Sokolovsky
ac8843ceec
docs/library/ussl: Deconditionalize, wipy notes moved to its documentation.
2017-04-16 09:41:32 +03:00
Paul Sokolovsky
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
Paul Sokolovsky
ae831ec0a8
docs/library/micropython: Deconditionalize.
2017-04-16 09:18:47 +03:00
Paul Sokolovsky
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
Paul Sokolovsky
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
Paul Sokolovsky
3acace588a
docs/utime: Deconditionalize description of sleep().
2017-04-09 00:42:32 +03:00
Paul Sokolovsky
1d74559b6b
docs/library/machine.UART: Remove some conditionals.
2017-04-09 00:25:27 +03:00
Paul Sokolovsky
bcf3c8bf17
docs/library/builtins: int: Add notice on byteorder param for to/from_bytes.
2017-04-09 00:06:54 +03:00
Paul Sokolovsky
390d5a3bf1
docs/machine.Pin: Move wipy-specific methods to its docs.
2017-04-05 13:05:04 +03:00
Paul Sokolovsky
d46899626e
docs/machine.Pin: Move wipy-specific details to its own docs.
2017-04-05 12:09:36 +03:00
Paul Sokolovsky
9a38b7afe0
cc3200/modmachine: Return frequency value directly, like other ports.
2017-04-05 11:58:17 +03:00
Paul Sokolovsky
4333b2fb53
docs/machine.SPI: Remove outdated wipy chunk.
2017-04-05 11:47:15 +03:00
Paul Sokolovsky
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
Paul Sokolovsky
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
Peter Hinch
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
Paul Sokolovsky
bb296482c3
docs/library/btree: Add btree module docs.
2017-04-04 00:29:23 +03:00
transistortim
fb981107eb
docs/library/machine.I2C: Fix scan() doc to match implementation.
...
Since eaef6b5324
writes are used instead of
reads.
2017-03-20 15:30:41 +11:00
Christopher Arndt
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
Damien George
fcab435607
docs/library/framebuf: Fix typo in bit-width for MVLSB description.
2017-03-15 21:54:56 +11:00
Rami Ali
2646b9e022
docs/library/lcd160cr: Add link to framebuf page.
2017-03-07 18:17:40 +11:00
Rami Ali
f9d18d96b7
docs/library: Add framebuf documentation.
2017-03-07 18:16:46 +11:00
Peter Hinch
1f549a3496
docs/library/lcd160cr: Add note about supported JPEG format/encodings.
2017-02-28 17:45:24 +11:00
Paul Sokolovsky
ed81574fe9
docs/machine: Fix formatting of Constants section.
...
Render related constants grouped together, with common description.
2017-02-28 00:38:15 +03:00
Paul Sokolovsky
e2f1a8a7ee
docs/uhashlib: Provide port-neutral description.
...
TODO: Remove WiPy-specific chunks.
2017-02-26 00:55:33 +03:00
Damien George
d80df91ef2
docs/library/lcd160cr: Mention the valid values for set_power() method.
2017-02-17 16:57:22 +11:00
Paul Sokolovsky
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
Damien George
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
Dave Hylands
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
Damien George
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
Paul Sokolovsky
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
Damien George
50a9dd59f5
docs: For LCD160CR driver and tutorial, add link to positioning image.
2017-02-03 12:48:54 +11:00
Paul Sokolovsky
0ddeedfc73
docs/uio: Typo fixes/lexical improvements.
2017-01-29 16:18:33 +03:00
Paul Sokolovsky
ef6fb66d23
docs/uio: Describe differences between uPy an CPy stream hierarchy.
2017-01-28 16:35:40 +03:00
Paul Sokolovsky
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
Paul Sokolovsky
f23c47fea7
docs/usocket: Clarify description of various methods.
2017-01-28 15:39:18 +03:00
Paul Sokolovsky
74fcb122f0
docs/usocket: Elaborate "Constants" section.
2017-01-28 14:46:58 +03:00
Paul Sokolovsky
59540dccf1
docs/usocket: Clarify exceptions used.
2017-01-28 13:55:51 +03:00
Paul Sokolovsky
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
Paul Sokolovsky
56e7ebf07a
docs/machine.Timer: Move WiPy adhoc parts to its documentation.
2017-01-28 12:08:00 +03:00
Damien George
c707668d9e
docs/library/lcd160cr: Fix set_brightness range, should be 0..31.
2017-01-24 00:17:39 +11:00
Damien George
e72e343908
docs: Add documentation for lcd160cr module.
2017-01-23 14:37:10 +11:00
Mike Causer
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
Paul Sokolovsky
a1a8f01799
docs/usocket: Clarify that socket timeout raises OSError exception.
2017-01-07 14:23:33 +03:00
Damien George
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
Damien George
c3f70c603e
docs/library/esp: Document esp.set_native_code_location() function.
2017-01-04 23:48:19 +11:00
Damien George
d377c83794
docs/library/machine.I2C: Fix I2C constructor docs to match impl.
2016-12-30 15:25:48 +11:00
Lorenz Schmid
a5b3c7e7f9
docs/library/pyb.UART: Moved writechar doc to sit with other writes.
2016-12-15 09:59:45 +11:00
Lorenz Schmid
0caac94b98
docs/library/pyb.UART: Added clarification about timeouts.
2016-12-15 09:59:32 +11:00
Peter Hinch
46e59c52af
docs/library/pyb.Accel: Add hardware note about pins used by accel.
2016-12-02 17:39:13 +11:00
Damien George
63a5df3cb4
docs/library/machine.I2C: Refine definitions of I2C methods.
2016-11-23 17:05:02 +11:00
Paul Sokolovsky
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
Damien George
a392b3aa75
docs: Remove references to readall() and update stream read() docs.
2016-11-14 23:31:40 +11:00
Damien George
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
Damien George
3e5e4f95b2
docs/library/machine.Pin: Update Pin docs to align with new HW API.
2016-11-09 11:08:01 +11:00
Paul Sokolovsky
805f7ea2f2
docs/utime: Add docs for ticks_add(), improvements for other ticks_*().
2016-11-01 00:14:12 +03:00
Paul Sokolovsky
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
Paul Sokolovsky
d60ad5cf53
docs/utime: Describe new semantics of ticks_diff() (signed ring arithmetics).
2016-10-31 00:17:56 +03:00
Paul Sokolovsky
153665f159
docs/utime: Document ticks_cpu() in more detail.
...
Also, drop ::only directive.
2016-10-30 23:15:28 +03:00
Paul Sokolovsky
7219a18d17
docs/library/index: Update TOCs so builtins sorted before modules.
2016-10-30 23:13:52 +03:00
Paul Sokolovsky
c28f9df63a
docs/library/network: Typo fixes, consistent acronym capitalization.
2016-10-28 12:03:35 +03:00
Paul Sokolovsky
b9a88683a4
docs/library/network: Reword intro paragraph.
2016-10-28 04:42:27 +03:00
Paul Sokolovsky
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
Damien George
f1b2b1b600
docs/library/builtins: Add docs for delattr and slice.
2016-10-25 11:02:47 +11:00
Damien George
266e4acdc2
docs/library/machine.SPI: Remove spurious "of".
2016-10-24 14:41:21 +11:00
Damien George
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
Paul Sokolovsky
a0b2f48c2f
docs/machine.SPI: Bring up to date with Hardware API, make vendor-neutral.
2016-10-17 18:05:16 +03:00
Alex March
00c1fc6d77
docs/uos: Add uos.statvfs() documentation.
2016-10-07 13:16:54 +11:00
Philip Potter
eb239b8398
stmhal/usb: Add support to receive USB HID messages from host.
2016-10-04 15:38:01 +11:00
Radomir Dopieralski
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
Damien George
eeb9d99333
docs/library/machine: Update description of disable/enable IRQ funcs.
2016-09-23 13:15:58 +10:00
Paul Sokolovsky
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
Damien George
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
Damien George
4a9542c0c0
docs/library/machine.WDT: Add that WDT is available on pyboard.
2016-09-06 14:20:52 +10:00
Philip Potter
0f8b1ba8a2
docs/library: Add reference for pyb.usb_mode and pyb.USB_HID.
2016-08-29 15:17:20 +10:00
Damien George
64c5a9435c
docs/library/machine.WDT: Add note that WDT is only available on WiPy.
2016-08-17 14:22:39 +10:00
Paul Sokolovsky
5c73de0337
docs/uio: Mention seek()/flush() support for io.BytesIO.
2016-08-09 01:52:56 +03:00
Paul Sokolovsky
fdb411a8c5
docs/library/index: Include array module in ToC.
2016-08-07 00:16:41 +03:00
Paul Sokolovsky
8a0b6f561c
docs/array: Document array module.
2016-08-07 00:13:48 +03:00
Mike Causer
ce166e6b68
docs: Spelling mistakes
2016-08-02 11:17:46 +03:00
Martin Müller
047ac2044d
docs/library: Fix typo in docs for usocket.listen().
2016-06-26 12:38:20 +01:00
Paul Sokolovsky
2b6dcdd3e4
docs/sys: print_exception: Fixes/clarifications.
2016-06-18 19:06:53 +03:00
Paul Sokolovsky
617e033e2f
docs/select: Add an article.
2016-06-18 19:06:42 +03:00
Paul Sokolovsky
9de5eb278d
docs/sys: Detailed description of print_exception() diff from traceback module.
2016-06-10 23:06:56 +03:00
Paul Sokolovsky
343b5c1081
docs/uctypes: Improve documentation.
...
Seealso and Limitations sectiosn added, better formatting and grammar.
2016-06-09 05:02:55 +03:00
Paul Sokolovsky
79b40d1127
docs/machine*: Remove explicit targets and "machine." prefixes on classes.
...
With currentmodule:: set properly, none are needed. Extra "machine." prefix
produces wrong indexing data.
2016-06-09 03:03:53 +03:00
Paul Sokolovsky
a0c296f6d5
docs/machine.Pin: Disambiguate object call method.
2016-06-09 02:58:15 +03:00
Paul Sokolovsky
1d3b903eb5
docs/library/index: Add builtins.rst.
2016-06-09 00:26:44 +03:00
Paul Sokolovsky
0cec4e9bb8
docs/builtins: Enumerate all builtin functions implemented.
...
Based on unix version. No descriptions so far.
2016-06-09 00:24:52 +03:00
Paul Sokolovsky
f1eb672d88
docs/pyb.Pin: Sort .af() and .af_list() methods together.
2016-06-08 16:36:22 +03:00
Paul Sokolovsky
a384a53130
docs/pyb.*: Use proper class case in method headers.
...
Class designator will be used as is in indexes, so must match actual class
name.
2016-06-08 16:21:28 +03:00
Paul Sokolovsky
585aafc27e
docs/pyb.ExtInt,pyb.Pin: Mark up class methods as such.
2016-06-08 16:00:12 +03:00
Paul Sokolovsky
0d8c22b122
docs/pyb.Pin: af_list() is a normal method, not a class method.
2016-06-08 15:57:46 +03:00
Paul Sokolovsky
8171995ee9
docs/pyb.CAN: Mark CAN.initfilterbanks() as classmethod explicitly.
2016-06-08 15:49:30 +03:00
Paul Sokolovsky
bba77a2d01
docs/machine.Pin: Add class designator to all constants.
...
This makes rendered docs to not provide incorrect information and
consistent with how it's down for other machine classes.
2016-06-08 01:37:03 +03:00
Paul Sokolovsky
7d7243f44c
docs/machine.*: Use proper class case in method headers.
...
Class designator will be used as is in indexes, so must match actual class
name.
2016-06-08 01:33:49 +03:00
Paul Sokolovsky
93968bd6fb
docs/machine.UART: Cleanup pyboard section.
2016-06-08 01:32:16 +03:00
Paul Sokolovsky
0a4361ca67
docs/machine.Pin: Remove explicit target.
...
With currentmodule:: support, all targets should be generated properly by
Sphinx.
2016-06-08 01:13:59 +03:00
Paul Sokolovsky
0a4cc24b2e
docs/pyb.*: Add "currentmodule:: pyb" directive.
...
Makes sure that classes described in these separate files are properly
designated as belonging to "pyb" module in indexes.
2016-06-08 00:57:41 +03:00
Paul Sokolovsky
c8b7628094
docs/machine.*: Add "currentmodule:: machine" directive.
...
Makes sure that classes described in these separate files are properly
designated as belonging to "machine" module in indexes.
2016-06-08 00:46:27 +03:00
Paul Sokolovsky
2c5fc681c8
docs/library/machine.Pin: Mention GPIO and cross-link .value() function.
2016-06-07 17:49:00 +03:00
Paul Sokolovsky
6e2fa5237d
docs/usocket: There must be empty line after .only:: .
2016-06-07 17:41:21 +03:00
Paul Sokolovsky
9b18811951
docs/ure: Typo fix.
2016-06-07 08:53:54 +03:00
Paul Sokolovsky
753a965363
docs/esp.socket: Remove unused file.
2016-06-07 02:40:05 +03:00
Paul Sokolovsky
9487b80666
docs/library/network: wipy: Fix literal block indentation.
2016-06-07 02:07:08 +03:00
Damien George
ed4e5d2583
docs/library/index: Fix grammar and spelling in intro paragraph.
2016-06-02 11:05:13 +01:00
Paul Sokolovsky
09f764dc04
docs/library/index: Add intro paragraph regarding availability of modules.
...
This introductions makes explicit the fact that whenever possible,
the documentation describes full MicroPython functionality, and arbitrary
functions/classes/modules may be missing in a paricular port or build.
2016-06-02 00:08:07 +03:00
Paul Sokolovsky
c4ab8895e8
docs: math, cmath: Add port availability information.
2016-06-01 22:12:39 +03:00
Paul Sokolovsky
1a05a59116
docs/math: Typo fix.
2016-06-01 22:09:51 +03:00
Damien George
93a9c2e840
docs/library/machine: Add documentation for machine.time_pulse_us.
2016-05-31 14:06:33 +01:00
Peter Hinch
641300dccb
stmhal/dac: DAC deinit() method added.
2016-05-31 13:10:35 +03:00
Damien George
a3dc2c6031
docs/machine: Make disable_irq and enable_irq docs available for all.
2016-05-26 15:47:47 +01:00
Paul Sokolovsky
3e33aeb0db
docs: esp8266: Include ussl module in the docs.
2016-05-22 23:57:26 +03:00
Paul Sokolovsky
bca4c9e465
docs/ussl: Add basic description of axTLS-based modussl.
...
In particular, disclose the fact that server certificates are not
validated.
2016-05-22 23:56:22 +03:00
Paul Sokolovsky
ca63c77073
docs/ustruct: Describe supported type codes.
2016-05-14 20:48:43 +03:00
Radomir Dopieralski
0c86a9471a
docs/machine.UART: Filter out unimplemented UART methods from esp8266 docs.
2016-05-07 20:20:04 +03:00
Damien George
5036b6ad18
docs/library/machine.Pin: Update pin docs to reflect ESP8266 support.
2016-05-03 13:55:37 +01:00
Paul Sokolovsky
81a99eb388
docs/machine: idle() description generalization.
2016-05-03 12:53:57 +03:00
Paul Sokolovsky
bb6458bf43
docs/machine: More generic description of sleep's, WiPy details to its genref.
2016-05-03 12:48:20 +03:00
Paul Sokolovsky
db99ae00a2
docs/machine: Move WiPy-specific hardware details to its general reference.
2016-05-03 12:26:55 +03:00
Paul Sokolovsky
06ec96b47b
docs/machine: Generalize docs from just WiPy to other ports.
2016-05-03 12:15:29 +03:00
Paul Sokolovsky
a6cf45864f
docs/network: esp8266: MAC address is set via .config() method.
2016-05-03 01:04:40 +03:00
Paul Sokolovsky
ae845f13de
docs: Use getaddrinfo() result in easy way.
...
Instead of extracting 4th element, extact last. Much easier to remember!
2016-05-03 00:48:04 +03:00
Damien George
c816b89353
docs/library/machine.I2C: Update to reflect ESP8266 implementation.
...
This machine.I2C documentation is now closer to a more port-neutral
description, although there are still differences between WiPy and
ESP8266.
2016-05-02 12:31:17 +01:00
Paul Sokolovsky
621c644205
docs: _io and _collections were renamed to have standard "u" prefix.
2016-05-02 14:02:54 +03:00
Damien George
70ff7350e7
stmhal, cc3200: Change i2c.scan() method to scan addresses 0x08-0x77.
...
A standard I2C address is 7 bits but addresses 0b0000xxx and 0b1111xxx
are reserved. The scan() method is changed to reflect this, along with
the docs.
2016-05-02 11:15:36 +01:00
Paul Sokolovsky
8ebdbcfb27
docs: Add _io module reference.
2016-05-02 00:39:36 +03:00
Paul Sokolovsky
348caaf940
docs: Add _collections module reference.
2016-05-02 00:36:58 +03:00
Paul Sokolovsky
fd283eba64
docs/sys: Describe sys.platform is port-neutral manner.
2016-05-01 14:39:38 +03:00
Paul Sokolovsky
e9b7610748
docs/sys: Describe sys.maxsize.
2016-05-01 14:31:08 +03:00
Paul Sokolovsky
59603a2e89
docs/sys: Describe sys.implementation.
2016-05-01 13:59:34 +03:00
Paul Sokolovsky
4fb9452bff
docs/sys: Clean up print_exception() description.
2016-05-01 13:44:06 +03:00
Paul Sokolovsky
ad2889c141
docs/sys: Clarify description of sys.exit().
2016-05-01 13:42:36 +03:00
Paul Sokolovsky
8ad1659f68
docs/sys: Make module variable descriptions proper sentences.
2016-05-01 13:38:45 +03:00
Paul Sokolovsky
7781caf8d3
docs/sys: Remove port-specific details from description of stdin/out/err.
2016-05-01 13:37:28 +03:00
Paul Sokolovsky
c468fe65c5
docs/ustruct: Fix argument formatting.
...
Per current CPython docs conventions, arguments are in italics. Follow
that.
2016-05-01 13:34:16 +03:00
Paul Sokolovsky
a9ed42b3b4
docs/sys: Document sys.modules.
2016-05-01 13:32:15 +03:00
Paul Sokolovsky
6b6acc5b5d
docs/ustruct: Document pack_into(), unpack_from().
2016-05-01 13:17:07 +03:00
Paul Sokolovsky
83e99f88cb
docs/utime: Clarify module purpose.
2016-05-01 01:48:30 +03:00
Paul Sokolovsky
613fd0a1ca
docs/library/utime: Elaborate on epochs and calendar time maintenance.
2016-05-01 00:16:47 +03:00
Paul Sokolovsky
6d8156ae28
docs/network: esp8266: Describe wlan.config() method.
2016-04-28 00:11:55 +03:00
Paul Sokolovsky
06deec9d35
docs/network: esp8266: Add wlan.ifconfig() method.
2016-04-28 00:10:29 +03:00
Paul Sokolovsky
1b45670c69
docs/ubinascii: Clean up grammar.
2016-04-27 15:47:33 +03:00
Paul Sokolovsky
df4e1d1279
docs/library: Consistently use admonitions for CPython differences.
2016-04-27 15:43:48 +03:00
Paul Sokolovsky
31300b5144
docs/utime: Describe sleep() peculiarities in MicroPython.
...
Not all ports accept floating-point value.
2016-04-27 15:28:46 +03:00
Paul Sokolovsky
c564169c8f
docs/utime: Describe time() peculiarities in MicroPython.
2016-04-27 15:23:11 +03:00
Damien George
556e5dfd35
docs/library/utime: Add more time functions for unix and esp8266 ports.
2016-04-27 12:30:59 +01:00
Damien George
e0f7e001e8
docs: Fix uos and utime heading underlines to be the correct length.
...
Otherwise Sphinx gives a warning.
2016-04-27 12:11:27 +01:00
Paul Sokolovsky
351ec6d4ab
docs/library: "os" module is actually "uos".
2016-04-27 01:55:06 +03:00
Paul Sokolovsky
0df2ee0126
docs/library/index: Order sections from the most to least standard modules.
2016-04-27 01:38:59 +03:00
Paul Sokolovsky
492bf12499
docs/library/index: Make single section for "micro-ified" modules.
...
Even the modules whose names don't start with "u" prefix are micro-ified
anyway, i.e. provide only subset of CPython's functionality (and sometimes
extensions to it). So, it doesn't make much sense to devide them by
criteria of having/not having "u" prefix.
2016-04-27 01:38:59 +03:00
Paul Sokolovsky
678f3a1e05
docs: Module "time" is actually "utime".
2016-04-27 01:38:59 +03:00
Paul Sokolovsky
a119983328
docs/library/index: esp8266 has the same set of stdlibs as pyboard/unix.
2016-04-27 01:17:28 +03:00
Paul Sokolovsky
88ed518390
docs/library/index: Move WiPy "micro-libraries" under corresponding heading.
2016-04-27 01:14:16 +03:00
Paul Sokolovsky
8b8c32c09b
docs/library: Group MicroPython-specific modules under separate heading.
2016-04-27 01:11:24 +03:00
Paul Sokolovsky
650df97c06
docs/network: esp8266: scan(): Add note that bssid is bytes object.
2016-04-26 01:09:11 +03:00
Paul Sokolovsky
0d10e5310a
docs/usocket: Describe address format once at the beginning.
...
Different ports may have different formats.
2016-04-23 00:31:05 +03:00
Paul Sokolovsky
92497bff94
docs/usocket: socket.IPPROTO_SEC is WiPy-specific.
2016-04-23 00:17:34 +03:00
Paul Sokolovsky
955b8526f4
docs/usocket: Socket-specific exceptions are for WiPy only.
2016-04-23 00:17:09 +03:00
Paul Sokolovsky
71c6f93016
docs/library/usocket: Add link to CPython's socket module.
2016-04-23 00:08:43 +03:00
Paul Sokolovsky
bbe5245028
docs: esp8266: Include usocket module reference.
2016-04-23 00:08:11 +03:00
Paul Sokolovsky
3bc9b571bb
docs/ustruct: There's no complete "struct" module, only "ustruct" subset.
...
"ustruct" is good example of micro-ified module, so rather should belong
to the corresponding list.
2016-04-22 22:37:14 +03:00
Paul Sokolovsky
67ece47121
docs/machine: reset_cause() has been implemented for esp8266.
2016-04-17 17:40:08 +03:00
Paul Sokolovsky
f474e956d7
docs/machine: Start to update for esp8266 port.
2016-04-15 17:06:11 +03:00
Paul Sokolovsky
b122ed0732
docs/esp: Enumerate flash access functions.
2016-04-15 14:01:22 +03:00
Peter Hinch
22cbcd55f0
stmhal: Properly handle RTS/CTS flow control for buf/unbuf transfers.
...
Fixes issues #1912 and #1913 . UART documentation is also updated.
2016-04-13 08:42:32 +01:00
Paul Sokolovsky
9c04299da1
docs: esp8266: Enable "machine" module docs.
...
The docs are still heavily biased towards WiPy, so will need a lot of
exclusions.
2016-04-07 16:44:10 +03:00
Paul Sokolovsky
5e7fa7c80c
docs/ubinascii: Document non-standard "sep" argument to hexlify().
2016-04-07 12:39:00 +03:00
Paul Sokolovsky
f81ea6307c
docs/ubinascii: Document a2b_base64(), b2a_base64().
2016-04-05 14:00:12 +03:00
Paul Sokolovsky
28d4b94dce
docs/machine: Change wording to be a bit more port-neutral.
2016-04-03 20:49:29 +03:00
Paul Sokolovsky
69b702276b
docs/os: Change wording to be a bit more port-neutral.
2016-04-03 20:49:25 +03:00
Paul Sokolovsky
e24674d44e
docs: esp8266: esp.socket is deprecated, remove from docs.
2016-04-03 20:19:39 +03:00
Paul Sokolovsky
f50d9477c1
docs: network: esp8266: .scan() is now synchronous and returns result list.
2016-03-30 11:56:20 +03:00
Paul Sokolovsky
d7019d0628
docs: network: esp8266: status is WLAN object method.
2016-03-30 11:53:45 +03:00