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
21f08524ba
docs: Add M-logo as favicon.
2017-02-07 20:04:40 +11:00
Damien George
3217bbe491
docs/esp8266/tutorial: Specify the baudrate in picocom example command.
2017-02-07 16:58:43 +11:00
Damien George
9779c99317
stmhal: Add ability to skip booting from SD card via /flash/SKIPSD file.
2017-02-07 12:35:39 +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
Damien George
5ec5bfb0d3
docs/pyboard/tutorial/lcd160cr_skin: Fix typo, get_touched->get_touch.
2017-01-30 18:19:29 +11:00
Paul Sokolovsky
0ddeedfc73
docs/uio: Typo fixes/lexical improvements.
2017-01-29 16:18:33 +03:00
Paul Sokolovsky
bdb0d22fe2
docs/conf.py: Add myself as a copyright holder on the docs.
...
Based on the following statistics:
$ git log docs |grep Author | sort | uniq -c | sort -n -r
175 Author: Paul Sokolovsky
135 Author: Damien George
31 Author: Daniel Campora
26 Author: danicampora
14 Author: Peter Hinch
git blame stats script from http://stackoverflow.com/a/13687302/496009 :
$ sh git-authors docs
9977 author Damien George
2679 author Paul Sokolovsky
1699 author Daniel Campora
1580 author danicampora
1286 author Peter Hinch
282 author Shuning Bian
249 author Dave Hylands
Total lines per this script: 18417, my contribution is 14.5%.
2017-01-29 16:12:07 +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
7d08bc27e2
docs/pyboard/tutorial: Add tutorial for LCD160CR.
2017-01-23 15:50:37 +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
Damien George
5653e3c72f
docs: Bump version to 1.8.7.
2017-01-08 23:53:08 +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
Paul Sokolovsky
52c19875a4
esp8266/general: Add "Scarcity of runtime resources" section.
...
With warnings of need to close files, sockets, etc.
2017-01-04 10:33:48 +03:00
Max
e1f495a4bd
docs/esp8266/tutorial: Close socket after reading page content.
2017-01-04 11:15:02 +11:00
Damien George
d377c83794
docs/library/machine.I2C: Fix I2C constructor docs to match impl.
2016-12-30 15:25:48 +11:00
Andrew Mulholland
71ff0b549d
docs/esp8266/tutorial: Update intro to add Getting the firmware section.
...
Add a "Getting the firmware" section to better describe how to get hold of
the MicroPython firmware, especially if you have a 512kb module.
2016-12-30 14:27:02 +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
5a1d63fc14
docs: Bump version to 1.8.6.
2016-11-10 21:24:53 +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
5630778f0f
esp8266: Update docs for esptool 1.2.1/SDK 2.0 (--flash_size=detect).
2016-11-08 04:52:07 +03:00
puuu
933198c55f
docs/*/quickref.rst: Use new semantics of ticks_diff()
2016-11-08 02:01:05 +03:00
Paul Sokolovsky
5c3d75c937
docs/esp8266: Update for new WebREPL setup procedure.
2016-11-06 10:02:33 +03: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