Paul Sokolovsky
53ac7830cb
docs/speed_python: Add article.
2016-04-15 20:09:59 +03:00
Paul Sokolovsky
5801967496
docs/speed_python: Add many more details on memoryviews.
2016-04-15 18:18:18 +03:00
Paul Sokolovsky
47f9b10b30
docs/speed_python: Generalize "Floating point" subsection.
...
Don't describe just single port's peculiarities, note aboute possible
array of issues with floating-point.
2016-04-15 17:43:03 +03:00
Paul Sokolovsky
6c84f1e03a
docs/speed_python: Clarify/generalize "Buffers" subsection.
2016-04-15 17:24:56 +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
Damien George
9b0a150bd6
docs: Bump version to 1.7.
2016-04-11 12:18:10 +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
e4cb7c6158
docs/esp8266/quickref: Add note about physical vs logical pin numbers.
2016-04-05 16:30:51 +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
254a5646c1
docs: Update copyright notice.
2016-04-03 00:05:23 +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
danicampora
193795398d
docs: Correct pin interrupt example code for the WiPy.
2016-03-28 13:12:58 +02:00
Paul Sokolovsky
87c783b454
docs/esp8266: esp.mac() replaced with network.WLAN.mac().
2016-03-27 06:59:39 +03:00
Paul Sokolovsky
679fe0abae
docs/esp8266: esp.wifi_mode() replaced with network.WLAN.active().
2016-03-27 06:59:00 +03:00
Paul Sokolovsky
eda8746324
docs/esp8266: phy_mode() moved to network module.
2016-03-27 06:58:06 +03:00
Paul Sokolovsky
0cb10b5220
docs/esp8266/quickref: Add note about GPIO16.
2016-03-25 16:48:15 +02:00
Paul Sokolovsky
159f1aaca8
docs/esp8266/quickref: Note that timers supported are virtual ones.
2016-03-25 16:44:13 +02:00
Paul Sokolovsky
e589cddcd4
docs/esp: Remove getaddrinfo(), now in socket module as expected.
2016-03-25 16:39:18 +02:00
Paul Sokolovsky
6e6488530e
docs: More standard modules for esp8266.
2016-03-25 16:33:05 +02:00
Paul Sokolovsky
4b5606bc09
docs/network: esp8266: Update docs on WLAN constructor.
2016-03-25 16:30:06 +02:00
Paul Sokolovsky
ee6fcc6f91
docs: Add standard modules list for esp8266.
2016-03-25 15:17:55 +02:00
Paul Sokolovsky
96a644076d
docs/topindex.html: Refer to "pyb" module only for pyboard.
2016-03-25 15:12:26 +02:00
Peter Hinch
2b302dad51
docs: Update pyb.UART.any() to mention that it returns character count.
2016-03-17 20:19:36 +00:00
Peter Hinch
6d5a549067
docs: Mention that pyb.SPI constructor accepts "X" and "Y" arguments.
2016-03-17 20:19:08 +00:00
Peter Hinch
b8133c4c0f
docs: Update pyb.I2C constructor to reflect changes in Pyboard Lite.
2016-03-17 20:18:36 +00:00
Peter Hinch
4a6cac4643
docs: Update asm tutorial, maximum number of allowed args is now 4.
2016-03-17 20:17:40 +00:00
Damien George
2466cb67f8
docs/esp8266: Update quick reference: i2c.readfrom and neopixel example.
2016-03-16 13:37:39 +00:00
Peter Hinch
21b74604f9
docs: Add Python speed optimisation guide, including minimal viper ref.
2016-03-11 16:33:36 +00:00
Peter Hinch
85d3b6165a
docs: Update details on using ADCAll object for vref/vbat channels.
2016-03-11 16:33:09 +00:00
Peter Hinch
70f32f0f73
docs: Update asm_thumb2_hints_tips re return type of asm funcs.
2016-03-11 16:32:42 +00:00
Damien George
6b80ebe32e
docs/esp8266: Fix indent errors, typos, and add info about REPL UART.
2016-03-09 13:01:32 +00:00
Damien George
42ef5a1567
docs: Allow list of versions to be specified by environment variable.
2016-03-09 12:43:22 +00:00
Damien George
5b74bba3a3
docs: Add versions.html template and support code for a version sidebar.
2016-03-09 12:15:47 +00:00
Damien George
4b6077b3fe
docs/esp8266: Minor tweaks to quickref, Timer and I2C classes.
2016-03-09 11:02:38 +00:00
Damien George
809fbeefb7
docs: Add esp8266 quick reference page, with basic info.
2016-03-08 23:06:15 +00:00
Noah Rosamilia
6bb9d3ea3e
docs/uctypes.rst: Fix typo (steamlined -> streamlined).
2016-03-02 00:25:10 +02:00
danicampora
57b96a7be2
docs: Correct machine.Timer code examples related to duty cycle.
2016-02-23 20:22:26 +01:00
danicampora
8e1fdf2eb3
docs: Add note on machine.Timer class regarding PWM output pins.
2016-02-23 19:53:59 +01:00
danicampora
add930c4b5
cc3200: Rename 'server' class to 'Server' for consistency.
2016-02-22 22:54:34 +01:00
danicampora
12547ce737
docs: Minor change to improve clarity in machine.Timer docs.
2016-02-22 19:16:30 +01:00
danicampora
0d210a0be8
docs: Correct WiPy Timer docs.
2016-02-21 21:53:20 +01:00
danicampora
73c9f85b4c
cc3200: Simplify the Timer API and correct the documents.
...
Make the PWM duty cycle configurable from 0.00 to 100.00 by
accepting values from 0 to 10000.
Add automatic Pin assignment when operating in PWM mode.
2016-02-21 21:53:16 +01:00
Damien George
331a48195d
docs: Bump version to 1.6.
2016-01-31 23:22:41 +00:00
Damien George
0f87a010e3
docs: Update to say that Timer(3) is free, and detail LED intensity.
2016-01-29 23:06:13 +00:00
Peter Hinch
c13b2f2d00
docs: Several minor changes: network, pyb, ADCAll and inline asm.
2016-01-13 21:53:26 +00:00
Damien George
ea8be373a9
py/inlinethumb: Remove 30-bit restriction on movwt instruction.
...
movwt can now move a full 32-bit constant into a register.
2016-01-07 16:34:11 +00:00
Henrik Sölver
67f40fb237
docs: Include extra functions in time documentation for pyboard.
2016-01-04 22:57:21 +00:00
Damien George
1d191fdf03
docs: Add link from pyboard switch tutorial to ISR rules document.
2016-01-04 16:18:44 +00:00
Paul Sokolovsky
824f83fd20
docs: Set author as 'Damien P. George and contributors'.
2016-01-03 22:17:00 +02:00
Paul Sokolovsky
275a0f25d3
docs: Fix readthedocs build by updating Latex params.
2016-01-03 22:15:07 +02:00
Damien George
ed584e2ffd
docs: Bump version to 1.5.2.
2015-12-31 14:43:19 +00:00
Peter Hinch
521759ee18
docs: Add discussion on interrupt handlers incl uPy specific techniques.
2015-12-31 00:02:09 +00:00
danicampora
67a5bfc6d8
docs/library: Add network server example.
2015-12-16 22:35:14 +01:00
Damien George
4dea24e105
docs: Bump version to 1.5.1.
2015-11-23 21:27:33 +00:00
Chris Liechti
426f326d35
docs/wipy: Make wifi/wlan naming consistent with tutorial.rst.
2015-11-18 20:02:07 +01:00
Jason Hildebrand
9142179f81
docs/wipy: Add warning about losing wlan connection when changing mode.
...
Also provide workarounds, link to other revelant sections,
and fix some typos.
2015-11-18 19:55:55 +01:00
Noah
00960133c2
docs: Update docs for WiPy wlan.connect().
...
- The link establishment timeout is infinite by default
- Fix typo in notes about the auth kwarg
2015-11-18 19:47:40 +01:00
Dave Hylands
f3308daa6f
docs/wipy: Fixed some typos in the WiPy's tutorials.
2015-11-18 19:40:29 +01:00
Dave Hylands
3551368424
docs: Fix a typo in the REPL documentation.
2015-11-10 22:19:20 +02:00
Paul Sokolovsky
549c79d11e
docs/select: Document POLLIN/OUT/ERR/HUP.
2015-11-09 22:10:32 +02:00
Damien George
b7ca945877
lib/mp-readline: Make it easy to exit auto-indent mode by pressing enter.
...
This patch allows you to stop auto-indent by pressing enter on a second
blank line. Easier than having to use backspace, and prevents new users
from getting stuck in auto-indent mode.
2015-11-07 13:07:43 +00:00
Dave Hylands
a9f3030371
docs: Add docs about REPL paste-mode and Control-C
2015-11-03 23:28:53 +00:00
Dave Hylands
98fb0bf68a
docs: Move instructions on generating the documentation to docs/README.md
2015-11-03 23:28:27 +00:00
Paul Sokolovsky
43efb46328
docs/library/index.rst: Minimally adapt for unix port.
2015-10-31 01:15:25 +03:00
Paul Sokolovsky
c6bc5b69c2
docs: Actually add unix port indexes, so docs for it could be generated.
2015-10-31 01:00:03 +03:00
Paul Sokolovsky
98b6d35c4f
docs: select: Describe poll.poll() return value in detail.
2015-10-29 22:08:10 +03:00
danicampora
9011815d86
docs/wipy: Fix bug in example code and add note regarding OTA.
2015-10-26 23:51:27 +01:00
Martijn Koster
a13d22f921
docs/wipy: Fix several typos and change some pyboard to WiPy.
2015-10-26 23:36:51 +01:00
Martijn Koster
c773053f58
docs/wipy: Fix several typos.
2015-10-25 21:32:18 +01:00
danicampora
359a8aa760
docs/wipy: Fix error in WLAN quickref.
2015-10-25 21:31:42 +01:00
Paul Sokolovsky
b7ab70c71c
docs: USB_VCP: Always in non-blocking mode, clarify stream method returns.
...
They return None if no data available.
2015-10-25 13:24:29 +03:00
Paul Sokolovsky
cf6daa0966
docs: Explicitly specify behavior of UART stream protocol methods on timeout.
2015-10-25 08:25:34 +03:00
danicampora
ee7bebc94f
docs: Correct machine.RTC examples.
2015-10-22 20:23:28 +02:00
danicampora
4efed58df1
docs: Fix typos on wipy docs.
2015-10-22 16:35:04 +02:00
danicampora
9273cca432
docs/wipy: Correct typo in safe boot description.
2015-10-22 00:31:22 +02:00
danicampora
126373ac70
docs/wipy: Remove windows instructions that refer to the pyboard.
2015-10-21 23:22:16 +02:00
danicampora
e954604ae0
docs: Add remark about ssl sockets and standard sockets.
2015-10-21 22:52:36 +02:00
Damien George
fe08e3a54f
docs: Bump version to 1.5.
2015-10-21 16:58:52 +01:00
danicampora
3b24e83731
docs/wipy: Fix formatting indentation.
2015-10-21 15:43:02 +02:00
danicampora
bb489066e8
docs/wipy: Remove incorrect references to usb configuration.
2015-10-21 15:41:36 +02:00
danicampora
109b363ddc
docs/wipy: Add more tutorials and examples.
2015-10-21 15:30:57 +02:00
danicampora
ee0058d174
docs: Remove remaining references to 'af', which is now 'alt'.
2015-10-21 15:30:57 +02:00
danicampora
ceb169008d
docs: Several corrections to the classes in the machine module.
2015-10-21 15:30:56 +02:00
danicampora
04db848dc7
docs: Add usocket and ussl modules' documentation.
2015-10-21 15:30:56 +02:00
danicampora
9c72c71c05
cc3200: WLAN class can retrieve the existing instance.
2015-10-19 21:17:15 +02:00
danicampora
8faf2dc75b
docs/wipy: Add wipy tutorials section.
2015-10-19 21:17:15 +02:00
danicampora
36ae417c9f
docs: Add wipy and network.server documentation.
2015-10-19 21:17:15 +02:00
danicampora
020386b61c
docs: In top index fix machine module link for the WiPy.
2015-10-18 00:31:12 +02:00
danicampora
4542643025
docs: Update all WiPy docs to reflect the new API.
2015-10-17 23:29:04 +02:00
Damien George
d6442407f5
docs: Fix formatting of DAC code examples.
2015-10-13 14:44:00 +01:00
Damien George
b5c43be135
stmhal: Allow to set bits resolution for DAC; 8 is default, can have 12.
...
This patch allows to configure the DAC resolution in the constructor and
in the init function, eg:
dac = DAC(1, bits=12).
The default resolution is 8 bits for backwards compatibility. The bits
sets the maximum value accepted by write and write_timed methods, being
2**bits - 1.
When using write_timed with 12-bit resolution, the input buffer is
treated as an unsigned half-word array, typecode 'H'.
See PR #1130 for discussion.
2015-10-13 14:33:04 +01:00
Damien George
845b5a2a58
docs: Describe properly how MCU can be woken from pyb.standby() state.
2015-10-10 00:03:14 +01:00
Radomir Dopieralski
37ab061f4d
docs: Update esp8266 documentation to match the code.
...
* Move the esp.status() to network module.
* Describe the wifi.isconnected() method.
* Describe esp.mac(), esp.wifi_mode(), esp.phy_mode(), esp.sleep_type(),
esp.deepsleep(), and esp.flash_id() functions.
2015-10-06 23:25:35 +01:00
