4fb9452bff
docs/sys: Clean up print_exception() description.
2016-05-01 13:44:06 +03:00
ad2889c141
docs/sys: Clarify description of sys.exit().
2016-05-01 13:42:36 +03:00
8ad1659f68
docs/sys: Make module variable descriptions proper sentences.
2016-05-01 13:38:45 +03:00
7781caf8d3
docs/sys: Remove port-specific details from description of stdin/out/err.
2016-05-01 13:37:28 +03:00
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
a9ed42b3b4
docs/sys: Document sys.modules.
2016-05-01 13:32:15 +03:00
6b6acc5b5d
docs/ustruct: Document pack_into(), unpack_from().
2016-05-01 13:17:07 +03:00
d46cd02d95
docs/esp8266/quickref: Add info about WebREPL.
2016-05-01 11:41:46 +03:00
83e99f88cb
docs/utime: Clarify module purpose.
2016-05-01 01:48:30 +03:00
613fd0a1ca
docs/library/utime: Elaborate on epochs and calendar time maintenance.
2016-05-01 00:16:47 +03:00
348edad888
docs/esp8266: Update quickref to reflect changes to 1-wire and NeoPixel.
2016-04-28 14:31:37 +01:00
37d5aa1377
docs: Make the short port names in the port/version sidebar lowercase.
...
To make it neater and simpler.
2016-04-28 12:34:59 +01:00
6d8156ae28
docs/network: esp8266: Describe wlan.config() method.
2016-04-28 00:11:55 +03:00
06deec9d35
docs/network: esp8266: Add wlan.ifconfig() method.
2016-04-28 00:10:29 +03:00
1b45670c69
docs/ubinascii: Clean up grammar.
2016-04-27 15:47:33 +03:00
df4e1d1279
docs/library: Consistently use admonitions for CPython differences.
2016-04-27 15:43:48 +03:00
31300b5144
docs/utime: Describe sleep() peculiarities in MicroPython.
...
Not all ports accept floating-point value.
2016-04-27 15:28:46 +03:00
c564169c8f
docs/utime: Describe time() peculiarities in MicroPython.
2016-04-27 15:23:11 +03:00
556e5dfd35
docs/library/utime: Add more time functions for unix and esp8266 ports.
2016-04-27 12:30:59 +01:00
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
351ec6d4ab
docs/library: "os" module is actually "uos".
2016-04-27 01:55:06 +03:00
f3f5e975e4
docs/Makefile: Default BUILDDIR based on MICROPY_PORT.
...
It doesn't make sense to duplicate both on command line, and MICROPY_PORT
is effectively mandatory to build docs.
2016-04-27 01:50:05 +03:00
0df2ee0126
docs/library/index: Order sections from the most to least standard modules.
2016-04-27 01:38:59 +03:00
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
678f3a1e05
docs: Module "time" is actually "utime".
2016-04-27 01:38:59 +03:00
a119983328
docs/library/index: esp8266 has the same set of stdlibs as pyboard/unix.
2016-04-27 01:17:28 +03:00
88ed518390
docs/library/index: Move WiPy "micro-libraries" under corresponding heading.
2016-04-27 01:14:16 +03:00
8b8c32c09b
docs/library: Group MicroPython-specific modules under separate heading.
2016-04-27 01:11:24 +03:00
650df97c06
docs/network: esp8266: scan(): Add note that bssid is bytes object.
2016-04-26 01:09:11 +03:00
0d10e5310a
docs/usocket: Describe address format once at the beginning.
...
Different ports may have different formats.
2016-04-23 00:31:05 +03:00
92497bff94
docs/usocket: socket.IPPROTO_SEC is WiPy-specific.
2016-04-23 00:17:34 +03:00
955b8526f4
docs/usocket: Socket-specific exceptions are for WiPy only.
2016-04-23 00:17:09 +03:00
71c6f93016
docs/library/usocket: Add link to CPython's socket module.
2016-04-23 00:08:43 +03:00
bbe5245028
docs: esp8266: Include usocket module reference.
2016-04-23 00:08:11 +03:00
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
5c8147528e
docs/esp8266/tutorial: Add tutorial placeholder page.
2016-04-22 22:37:02 +03:00
fcc9d43c6d
docs/esp8266: Add info about using deep-sleep mode to quickref.
2016-04-21 12:01:50 +01:00
2a51f72ed1
docs/esp8266/general: Start "General information" for esp8266.
2016-04-21 01:03:51 +03:00
f73d78394b
docs/topindex.html: esp8266: Enable quickref/general on the main page.
2016-04-21 01:03:27 +03:00
67ece47121
docs/machine: reset_cause() has been implemented for esp8266.
2016-04-17 17:40:08 +03:00
53ac7830cb
docs/speed_python: Add article.
2016-04-15 20:09:59 +03:00
5801967496
docs/speed_python: Add many more details on memoryviews.
2016-04-15 18:18:18 +03:00
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
6c84f1e03a
docs/speed_python: Clarify/generalize "Buffers" subsection.
2016-04-15 17:24:56 +03:00
f474e956d7
docs/machine: Start to update for esp8266 port.
2016-04-15 17:06:11 +03:00
b122ed0732
docs/esp: Enumerate flash access functions.
2016-04-15 14:01:22 +03:00
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
9b0a150bd6
docs: Bump version to 1.7.
2016-04-11 12:18:10 +01:00
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
5e7fa7c80c
docs/ubinascii: Document non-standard "sep" argument to hexlify().
2016-04-07 12:39:00 +03:00
e4cb7c6158
docs/esp8266/quickref: Add note about physical vs logical pin numbers.
2016-04-05 16:30:51 +03:00
f81ea6307c
docs/ubinascii: Document a2b_base64(), b2a_base64().
2016-04-05 14:00:12 +03:00
28d4b94dce
docs/machine: Change wording to be a bit more port-neutral.
2016-04-03 20:49:29 +03:00
69b702276b
docs/os: Change wording to be a bit more port-neutral.
2016-04-03 20:49:25 +03:00
e24674d44e
docs: esp8266: esp.socket is deprecated, remove from docs.
2016-04-03 20:19:39 +03:00
254a5646c1
docs: Update copyright notice.
2016-04-03 00:05:23 +03:00
f50d9477c1
docs: network: esp8266: .scan() is now synchronous and returns result list.
2016-03-30 11:56:20 +03:00
d7019d0628
docs: network: esp8266: status is WLAN object method.
2016-03-30 11:53:45 +03:00
193795398d
docs: Correct pin interrupt example code for the WiPy.
2016-03-28 13:12:58 +02:00
87c783b454
docs/esp8266: esp.mac() replaced with network.WLAN.mac().
2016-03-27 06:59:39 +03:00
679fe0abae
docs/esp8266: esp.wifi_mode() replaced with network.WLAN.active().
2016-03-27 06:59:00 +03:00
eda8746324
docs/esp8266: phy_mode() moved to network module.
2016-03-27 06:58:06 +03:00
0cb10b5220
docs/esp8266/quickref: Add note about GPIO16.
2016-03-25 16:48:15 +02:00
159f1aaca8
docs/esp8266/quickref: Note that timers supported are virtual ones.
2016-03-25 16:44:13 +02:00
e589cddcd4
docs/esp: Remove getaddrinfo(), now in socket module as expected.
2016-03-25 16:39:18 +02:00
6e6488530e
docs: More standard modules for esp8266.
2016-03-25 16:33:05 +02:00
4b5606bc09
docs/network: esp8266: Update docs on WLAN constructor.
2016-03-25 16:30:06 +02:00
ee6fcc6f91
docs: Add standard modules list for esp8266.
2016-03-25 15:17:55 +02:00
96a644076d
docs/topindex.html: Refer to "pyb" module only for pyboard.
2016-03-25 15:12:26 +02:00
2b302dad51
docs: Update pyb.UART.any() to mention that it returns character count.
2016-03-17 20:19:36 +00:00
6d5a549067
docs: Mention that pyb.SPI constructor accepts "X" and "Y" arguments.
2016-03-17 20:19:08 +00:00
b8133c4c0f
docs: Update pyb.I2C constructor to reflect changes in Pyboard Lite.
2016-03-17 20:18:36 +00:00
4a6cac4643
docs: Update asm tutorial, maximum number of allowed args is now 4.
2016-03-17 20:17:40 +00:00
2466cb67f8
docs/esp8266: Update quick reference: i2c.readfrom and neopixel example.
2016-03-16 13:37:39 +00:00
21b74604f9
docs: Add Python speed optimisation guide, including minimal viper ref.
2016-03-11 16:33:36 +00:00
85d3b6165a
docs: Update details on using ADCAll object for vref/vbat channels.
2016-03-11 16:33:09 +00:00
70f32f0f73
docs: Update asm_thumb2_hints_tips re return type of asm funcs.
2016-03-11 16:32:42 +00:00
6b80ebe32e
docs/esp8266: Fix indent errors, typos, and add info about REPL UART.
2016-03-09 13:01:32 +00:00
42ef5a1567
docs: Allow list of versions to be specified by environment variable.
2016-03-09 12:43:22 +00:00
5b74bba3a3
docs: Add versions.html template and support code for a version sidebar.
2016-03-09 12:15:47 +00:00
4b6077b3fe
docs/esp8266: Minor tweaks to quickref, Timer and I2C classes.
2016-03-09 11:02:38 +00:00
809fbeefb7
docs: Add esp8266 quick reference page, with basic info.
2016-03-08 23:06:15 +00:00
6bb9d3ea3e
docs/uctypes.rst: Fix typo (steamlined -> streamlined).
2016-03-02 00:25:10 +02:00
57b96a7be2
docs: Correct machine.Timer code examples related to duty cycle.
2016-02-23 20:22:26 +01:00
8e1fdf2eb3
docs: Add note on machine.Timer class regarding PWM output pins.
2016-02-23 19:53:59 +01:00
add930c4b5
cc3200: Rename 'server' class to 'Server' for consistency.
2016-02-22 22:54:34 +01:00
12547ce737
docs: Minor change to improve clarity in machine.Timer docs.
2016-02-22 19:16:30 +01:00
0d210a0be8
docs: Correct WiPy Timer docs.
2016-02-21 21:53:20 +01:00
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
331a48195d
docs: Bump version to 1.6.
2016-01-31 23:22:41 +00:00
0f87a010e3
docs: Update to say that Timer(3) is free, and detail LED intensity.
2016-01-29 23:06:13 +00:00
c13b2f2d00
docs: Several minor changes: network, pyb, ADCAll and inline asm.
2016-01-13 21:53:26 +00:00
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
67f40fb237
docs: Include extra functions in time documentation for pyboard.
2016-01-04 22:57:21 +00:00
1d191fdf03
docs: Add link from pyboard switch tutorial to ISR rules document.
2016-01-04 16:18:44 +00:00
824f83fd20
docs: Set author as 'Damien P. George and contributors'.
2016-01-03 22:17:00 +02:00
275a0f25d3
docs: Fix readthedocs build by updating Latex params.
2016-01-03 22:15:07 +02:00
ed584e2ffd
docs: Bump version to 1.5.2.
2015-12-31 14:43:19 +00:00
521759ee18
docs: Add discussion on interrupt handlers incl uPy specific techniques.
2015-12-31 00:02:09 +00:00
67a5bfc6d8
docs/library: Add network server example.
2015-12-16 22:35:14 +01:00
4dea24e105
docs: Bump version to 1.5.1.
2015-11-23 21:27:33 +00:00
426f326d35
docs/wipy: Make wifi/wlan naming consistent with tutorial.rst.
2015-11-18 20:02:07 +01:00
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
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
f3308daa6f
docs/wipy: Fixed some typos in the WiPy's tutorials.
2015-11-18 19:40:29 +01:00
3551368424
docs: Fix a typo in the REPL documentation.
2015-11-10 22:19:20 +02:00
549c79d11e
docs/select: Document POLLIN/OUT/ERR/HUP.
2015-11-09 22:10:32 +02:00
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
a9f3030371
docs: Add docs about REPL paste-mode and Control-C
2015-11-03 23:28:53 +00:00
98fb0bf68a
docs: Move instructions on generating the documentation to docs/README.md
2015-11-03 23:28:27 +00:00
43efb46328
docs/library/index.rst: Minimally adapt for unix port.
2015-10-31 01:15:25 +03:00
c6bc5b69c2
docs: Actually add unix port indexes, so docs for it could be generated.
2015-10-31 01:00:03 +03:00
98b6d35c4f
docs: select: Describe poll.poll() return value in detail.
2015-10-29 22:08:10 +03:00
9011815d86
docs/wipy: Fix bug in example code and add note regarding OTA.
2015-10-26 23:51:27 +01:00
a13d22f921
docs/wipy: Fix several typos and change some pyboard to WiPy.
2015-10-26 23:36:51 +01:00
c773053f58
docs/wipy: Fix several typos.
2015-10-25 21:32:18 +01:00
359a8aa760
docs/wipy: Fix error in WLAN quickref.
2015-10-25 21:31:42 +01:00
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
cf6daa0966
docs: Explicitly specify behavior of UART stream protocol methods on timeout.
2015-10-25 08:25:34 +03:00
ee7bebc94f
docs: Correct machine.RTC examples.
2015-10-22 20:23:28 +02:00
4efed58df1
docs: Fix typos on wipy docs.
2015-10-22 16:35:04 +02:00
9273cca432
docs/wipy: Correct typo in safe boot description.
2015-10-22 00:31:22 +02:00
126373ac70
docs/wipy: Remove windows instructions that refer to the pyboard.
2015-10-21 23:22:16 +02:00
e954604ae0
docs: Add remark about ssl sockets and standard sockets.
2015-10-21 22:52:36 +02:00
fe08e3a54f
docs: Bump version to 1.5.
2015-10-21 16:58:52 +01:00
3b24e83731
docs/wipy: Fix formatting indentation.
2015-10-21 15:43:02 +02:00
bb489066e8
docs/wipy: Remove incorrect references to usb configuration.
2015-10-21 15:41:36 +02:00
109b363ddc
docs/wipy: Add more tutorials and examples.
2015-10-21 15:30:57 +02:00
ee0058d174
docs: Remove remaining references to 'af', which is now 'alt'.
2015-10-21 15:30:57 +02:00
ceb169008d
docs: Several corrections to the classes in the machine module.
2015-10-21 15:30:56 +02:00
04db848dc7
docs: Add usocket and ussl modules' documentation.
2015-10-21 15:30:56 +02:00
9c72c71c05
cc3200: WLAN class can retrieve the existing instance.
2015-10-19 21:17:15 +02:00
8faf2dc75b
docs/wipy: Add wipy tutorials section.
2015-10-19 21:17:15 +02:00
36ae417c9f
docs: Add wipy and network.server documentation.
2015-10-19 21:17:15 +02:00
020386b61c
docs: In top index fix machine module link for the WiPy.
2015-10-18 00:31:12 +02:00
4542643025
docs: Update all WiPy docs to reflect the new API.
2015-10-17 23:29:04 +02:00
d6442407f5
docs: Fix formatting of DAC code examples.
2015-10-13 14:44:00 +01:00
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
845b5a2a58
docs: Describe properly how MCU can be woken from pyb.standby() state.
2015-10-10 00:03:14 +01:00
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
5572f735b6
docs: Bump version to 1.4.6.
2015-09-23 17:16:22 +01:00
dffa9f6da6
cc3200: New SD and RTC API plus os and time modules' extensions.
2015-09-21 22:30:32 +02:00
861fad5819
docs: Adapt WiPy's ADC doc and quickref to the new API.
2015-09-16 10:10:40 +02:00
aba75e1233
cc3200: New SPI API.
2015-09-16 10:10:33 +02:00
624cdeacc4
docs/wipy: Add pins to the I2C constructor.
2015-09-16 10:10:31 +02:00
41f6948545
cc3200: New WDT API.
2015-09-16 10:10:29 +02:00
8332044f75
cc3200: Add UART.ODD and UART.EVEN to select parity.
2015-09-16 10:10:26 +02:00
d5ec336eef
cc3200: Replace Pin.PULL_NONE with None.
2015-09-16 10:10:24 +02:00
f38d16483a
docs: Update I2C and UART docs to match the new API.
2015-09-16 10:10:22 +02:00
f91f212d9f
cc3200: New UART API plus related test.
2015-09-10 07:59:47 +02:00
36821d095a
cc3200: Add alternate functions list to Pin object.
...
Also remove pin.high() and pin.low() methods.
2015-09-10 07:59:41 +02:00
d5e256486e
cc3200: Re-work Pin class according to the new API.
...
Also add relevant test.
2015-09-10 07:59:35 +02:00
aa8e8acb7d
cc3200: Change HeartBeat period from 5 to 4 seconds.
2015-08-16 20:18:09 +02:00
11d21081b4
cc3200: Rework SD API. Increase heap to avoid malloc failures.
2015-08-16 20:17:58 +02:00
34c290b678
cc3200: Rename SPI nss param to cs.
...
The nss param in the pyboard has a different meaning that doesn't
apply to the WiPy.
2015-08-16 20:17:55 +02:00
ea5061e409
cc3200: Improve callback API.
...
Rename "wakes" param to "wake_from" and make "value" an object
instead of an integer.
2015-08-16 20:17:52 +02:00
032b0e9369
docs: Bump version to 1.4.5.
2015-08-11 13:42:30 +01:00
7027fd5343
cc3200: Make ADC API compatible with the pyboard.
2015-08-10 23:42:05 +02:00
31f6a6fa70
cc3200: Enable bootloader safe boot on latest firmware.
...
The first safe boot level executes the latest firmware but skips
'main.py' and 'boot.py'.
2015-08-09 19:22:19 +02:00
e54a4f1f48
cc3200: Improve support for WEP security.
...
Key is always entered as a string, but if security is WEP, the key
is converted automatically to hex before connecting or configuring
the device as an AP.
2015-08-09 19:22:16 +02:00
d43019163d
docs: Add i2c keywork arguments only indication.
2015-08-09 19:22:14 +02:00
00c4d6562e
cc3200: Add nic.iwconfig() to set/get WLAN configuration.
...
Changes are based on this post:
https://github.com/micropython/micropython/issues/876#issuecomment-115255551
The constructor can optionally take the same params of iwconfig in
order to configure WiFi when creating the object. Params are
keyworkd only. The WiPy accepts:
- mode (int -> WLAN.AP or WLAN.STA)
- ssdi (string)
- security (int -> WLAN.OPEN, WLAN.WEP, WLAN.WPA, WLAN.WPA2)
- key (string)
- channel (int (1-11))
- antenna (int -> WLAN.INTERNAL, WLAN.EXTERNAL)
2015-08-09 19:22:12 +02:00
c6926c374d
cc3200: Make I2C and SPI API the same as in stmhal.
2015-08-02 20:22:15 +02:00
aa58c7ec74
cc3200: Append last 2 bytes of the MAC address to the default SSID.
2015-07-30 00:43:16 +02:00
da33b31c7d
docs/wipy: Correct nic.ifconfig() quickref example.
2015-07-30 00:43:11 +02:00
007878781c
cc3200: Rename pins from GPIO to just GP.
...
This is how the names will be printed on the sticker that goes on top
of the EMI shield. The shorter names also help saving a few bytes of
RAM and ROM.
2015-07-30 00:43:08 +02:00
7693ef3bd6
stmhal: Allow ADC.read_timed to take Timer object in place of freq.
...
This allows a user-specified Timer for the triggering of the ADC read,
mirroring the new behaviour of DAC.write_timed.
Addresses issue #1129 .
2015-07-22 19:41:13 +01:00
abc24c1876
stmhal: Allow DAC.write_timed to take Timer object in place of freq.
...
This allows the DAC to use a user-specified Timer for the triggering
(instead of the default Timer(6)), while still supporting original
behaviour.
Addresses issues #1129 and #1388 .
2015-07-21 23:39:49 +01:00
e955089da0
cc3200: Implement new OTA mechanism with 2 firmware update slots.
2015-07-15 14:25:28 +02:00
7463442e58
docs: Update pyb.Accel doc to reflect changes and explain filtered_xyz.
2015-07-08 11:10:51 +01:00
5161239c9f
cc3200: time.sleep() now receives seconds, like CPython.
2015-07-02 17:23:22 +02:00
bdf958df30
docs/wipy: Update safe boot comments to match actual behaviour.
2015-06-30 22:27:50 +02:00
813b581127
cc3200: Add `Pin.name()` method.
2015-06-28 14:14:22 +02:00
fa1cdb09fc
docs: Fix duplicate label error for network.WLAN.
2015-06-27 13:42:00 +01:00
8cc8f280eb
docs: Make index link point to "index.html" irrespective of port.
2015-06-27 13:41:24 +01:00
abfd4da287
docs: Add link from pyboard asm tutorial to asm reference.
2015-06-26 12:35:17 +01:00
0d3e309ebc
docs: Add link in references index to Thumb2 assembler docs.
2015-06-25 00:24:19 +01:00
2110dc5a6d
docs: Add reference for Thumb2 inline assembler.
...
Thanks to Peter Hinch for contributing this.
2015-06-25 00:21:35 +01:00
aef3846c13
docs: Add "reference" directory for putting docs about the language.
2015-06-25 00:20:57 +01:00
7c61249ae6
esp8266: Updated documentation for scan() and moved to network
2015-06-17 23:16:28 +03:00
ea2cc2b907
docs: Add more documentation for the CC3200 in the pyb module.
2015-06-16 15:45:24 +02:00
e78a8c94b6
docs: Bump version to 1.4.4.
2015-06-15 23:54:22 +01:00
05c6fbcae6
esp8266: Fix the documentation for esp.connect() and esp.disconnect()
...
Since the commit that moved those two functions failed to update
the documentation, this is a fix for that.
2015-06-13 23:03:06 +03:00
cfcf47c064
docs: Add initial draft documentation for the WiPy.
...
This makes all common files "port-aware" using the .. only directive.
2015-06-10 23:37:56 +02:00
06e85ecfa6
docs/uctype: Update for constructor argument order changes.
...
Also, other small cleanups/improvements.
2015-06-06 22:58:04 +03:00
3eece29807
docs: Change "Micro Python" to "MicroPython" in all places in docs.
2015-06-04 23:53:26 +01:00
601cfea6a3
docs: Update license date range to include 2015.
2015-06-04 23:47:10 +01:00
7ca1bd314b
docs: Generate a separate docs build for each port.
...
Using Damien's approach where conf.py and topindex.html are
shared by all ports.
2015-06-04 23:44:35 +01:00
32ce72cb9e
docs/uctypes: Typo fix.
2015-06-02 10:35:06 +03:00
f8bce131c0
docs/uctypes: Fix API description errors.
...
"Structure class" is its descriptor, encoded as a dictionary. Then,
uctypes.struct() instantiates an actual object, and thus requires memory
address.
2015-06-02 10:30:01 +03:00
78ccb44a90
docs: Document esp module for ESP8266.
...
I document as much as I could guess from experiments and reading the
code for the ``esp`` module for the ESP8266 port of Micropython.
For now the tag has to be set manually with -t option when building,
when we have properly split documentation, there will be a separate
config file for esp8266 with that the tag "port_esp8266" set.
To build use:
make SPHINXOPTS="-t port_esp8266" html
2015-05-30 12:49:58 +01:00
3ad94d6072
extmod: Add ubinascii.unhexlify
...
This also pulls out hex_digit from py/lexer.c and makes unichar_hex_digit
2015-05-20 09:29:22 +01:00
d7b7d5f6ee
docs: Bump version to 1.4.3.
2015-05-16 21:26:43 +01:00
0bfc57022d
docs: Document USB_VCP file-like methods.
2015-05-13 20:42:12 +01:00
c7df9c6c47
stmhal: Add os.rename function.
2015-05-12 23:43:11 +01:00
5df81de7af
sthmal/rtc.c: Add calibration() method to get/set RTC fine-tuning value.
2015-05-11 23:48:39 +01:00
dea853d3a3
docs: Document pyb.stop, pyb.standby and pyb.RTC.wakeup.
2015-04-21 22:35:17 +01:00
43d56f9ba9
docs: Bump version to 1.4.2.
2015-04-21 12:51:14 +00:00
e3cd154317
stmhal: Add support for sending and receiving CAN RTR messages.
2015-04-18 14:53:00 +01:00
7d5e34287c
stmhal: Allow sending CAN messages with timeout=0.
...
Thanks to Henrik Sölver for this patch.
2015-04-16 23:52:43 +01:00
feff00e1a5
Add .gitattributes file to force text line endings to LF.
...
Some files are excluded, otherwise a whole lot of files need converting.
2015-04-16 22:23:56 +01:00
e97dddcdca
docs: Document pyb.main function to set main script.
2015-04-09 10:08:25 +01:00
0f6424efda
docs: Bump version to 1.4.1.
2015-04-04 17:41:11 +01:00
344057ac50
docs: uctypes: Bullet list formatting fixes.
2015-03-31 01:29:07 +03:00
9d2c0c231c
docs: uctypes: Describe how to instantiate struct objects.
2015-03-31 01:16:14 +03:00
e178ef2520
docs: Add additional example/note for Timer's callback usage.
...
Add example: using named function for the Timer's callback.
Add note: improving traceback inside interrupt timers.
2015-03-30 00:43:04 +01:00
47098efbda
docs: Provide initial documentation for micropython module.
2015-03-30 00:32:29 +01:00
64e8b62291
docs: Bump version to 1.4.
2015-03-29 18:01:19 +01:00
c260836beb
docs: uctypes: Describe bytes_at(), bytearray_at().
2015-03-27 00:19:23 +02:00
ec1b1cf834
docs: uctypes: Describe couple more functions.
2015-03-24 22:42:54 +02:00
b4c9a25eab
stmhal: Add support for quadrature encoder mode to pyb.TimerChannel.
2015-03-09 13:23:14 +00:00
b57b56f293
docs: Update pyb.Timer.rst to fix pulse widths that exceed the period.
2015-03-09 12:14:32 +00:00
4fddbe5ab6
docs: Correct the documentation for math.frexp.
2015-02-23 22:15:11 +00:00
1babb6d0c7
docs: Update timer tutorial to reflect new behaviour of timer.
2015-02-23 22:14:54 +00:00
3527085587
pyb.UART.rst: Clean up note about stream protocol support.
2015-02-22 13:36:35 +02:00
77fc276c08
stmhal: For UART, check that baudrate is within 5% of desired value.
...
Also includes documentation about minimum baudrate.
Addresses issue #1090 .
2015-02-22 00:26:49 +00:00
f80f1a7077
stmhal: Add support for CAN rx callbacks.
2015-02-15 03:10:53 +00:00
baafb290ad
stmhal: Add uart.sendbreak() method, to send a break condition.
2015-02-13 19:04:24 +00:00
d39c7aa517
stmhal: Add Python-configurable USB HID mode.
...
Different HID modes can be configured in Python. You can either use
predefined mouse or keyboard, or write your own report descriptor.
2015-02-13 14:02:51 +00:00
79dc0a0886
docs: Bump version to 1.3.10.
2015-02-13 13:26:44 +00:00
552f7c40a0
docs: Bump version to 1.3.9.
2015-01-25 00:10:07 +00:00
73533247cb
docs: Fix frequency info for DAC.triangle.
2015-01-20 23:56:10 +00:00
3990dcfcd7
docs: Add note about maximum frequency of busses.
2015-01-08 22:54:26 +00:00
7a0636e80a
docs: Add initial "uctypes" modules docs. WIP.
2015-01-08 00:17:10 +02:00
b27c9876ea
docs: For Windows USB CDC driver setup, add link to existing PDF guide.
2015-01-06 16:09:49 +00:00
ddbcc79550
docs: Add quickref info about Servo; improve Servo docs.
2015-01-01 18:00:45 +00:00
ce5b5caf8c
Add a command for converting the WAV files
...
Add a command for converting the WAV files to the amp skin tutorial, so that people can use their own files easily.
2015-01-01 17:56:05 +00:00
96e22154d7
docs: Bump version to 1.3.8.
...
Should have done it before tagging...
2014-12-29 00:04:59 +00:00
7690b13953
stmhal: Add ability to mount custom block device.
2014-12-27 20:20:51 +00:00
90cd6cd987
docs: Add mention about using USB charger when resetting the filesystem.
...
It seems the Mac will happily wipe out at least some of the data on
a freshly reset filesytem, if the filesystem was reset while plugged
into the Mac.
2014-12-23 13:22:32 +00:00
a37656c132
docs: Make admonition for CPy-difference use "attention" class.
...
This renders it in yellow/orange box on RTD server.
2014-12-22 13:42:30 +00:00
7b80d908bf
docs: Add RTD local_settings file, to add custom templates.
2014-12-21 11:21:06 +00:00
9b561a7c0d
docs: Add custom CSS file, with code for admonition.
2014-12-21 00:22:49 +00:00
6d3ae569cf
docs: Add CPy diff note for print_exception; embellish sys.platform.
2014-12-19 22:10:38 +00:00
5cf7ac7309
Fix leds.rst
...
N (mod 4) is 0..3
2014-12-18 00:06:48 +03:00
9642846d71
docs: Define more clearly the behaviour of LED methods.
...
Addresses issue #1006 .
2014-12-16 11:55:46 +00:00
6c3fc74656
docs: Add sys.print_exception().
2014-12-10 20:31:38 +02:00
b66a31c42c
stmhal: Allow SPI.init to specify prescaler directly; improve SPI docs.
2014-12-08 21:34:07 +00:00
008251180d
stmhal: Enhance pyb.freq to configure bus (AHB, APB1, APB2) freqs.
...
This is useful if you need precise control over the speed of
peripherals (eg SPI clock).
2014-12-08 21:32:55 +00:00
41c07d5b80
docs: uzlib: Typo fix.
2014-12-05 02:08:30 +02:00
adf4c4cea8
docs: Add quick docs for uzlib.
2014-12-05 00:40:35 +02:00
c0b3d4540b
docs: Update network docs to reflect changes to code.
2014-12-04 19:43:56 +00:00
3a5352b483
docs: Add skeleton docs for ure module.
2014-12-04 00:07:00 +02:00
578ea6d4a5
docs: Add links to LCD and AMP skin schematics.
2014-12-02 12:32:39 +00:00
d8fd3103fa
docs: Add quick docs for ubinascii.
2014-12-02 01:51:56 +02:00
d96a916405
docs: Add quick docs for uhashlib.
2014-12-02 00:53:19 +02:00
7f0699eedf
docs: Sort "micro-library" module list alphabetically.
2014-12-01 20:42:38 +02:00
d8c2b2a1c4
Update documentation for the CAN class
2014-11-30 01:04:56 +00:00
19fb1b4dd7
stmhal: Add USB_VCP.setinterrupt method, to disable CTRL-C.
2014-11-29 15:23:21 +00:00
722fab7c2a
docs: Bump version to 1.3.7.
2014-11-28 17:48:48 +00:00
9aae41121b
Update uheapq.rst
...
Erratum in froh.
2014-11-28 17:32:29 +00:00
5228854f0e
docs: Fix RTD build configuration.
...
ReadTheDocs needs the root directory in its search path so it finds
topindex.html.
2014-11-15 21:33:07 +00:00
d1b42d7b51
stmhal: Improve CAN init so that it can take sjw, bs1, bs2 args.
...
Also update docs to explain how CAN baudrate is determined.
2014-11-15 21:28:14 +00:00
aec189a5ba
docs: Add optional sphinx_rtd_theme; add docs build instructions.
...
The sphinx_rtd_theme is used by ReadTheDocs to render a pretty looking
documentation. If you have this theme installed locally then your
locally-compiled docs will look exactly like the published
documentation. Otherwise it falls back to the default theme.
2014-11-15 19:01:19 +00:00
ca0b0cb83f
Document parameter "data" of i2c.mem_read() more clear
...
Hi,
i would like to add a little clarification to the parameter "data" of i2c.mem_read(): I misunderstood
``data`` can be an integer or a buffer to read into
as "i can give a integer variable to read a integer into" . This pull-request adds the following clarification:
``data`` can be an integer (number of bytes to read) or a buffer to read into
Thanks for your great work!
Best wishes,
Matthias
2014-11-15 18:31:37 +00:00
d8474d3617
docs: select: Describe extra details.
2014-11-09 01:48:05 +02:00
ff8d0e071c
docs: Bump version to 1.3.6.
...
This needs to be done before actually tagging the new version.
2014-11-04 19:04:12 +00:00
0e3722137f
docs: Update front page to display date of last update.
2014-11-04 18:51:29 +00:00
8e701604d5
docs: Add links from quickref to pyb classes.
2014-11-04 18:25:20 +00:00
bc0bc764fc
docs: Add debounce tutorial; order Pin methods; add pull resistor info.
2014-11-04 18:07:06 +00:00
183ac71dc8
docs: Add pdf size info to datasheet links.
2014-11-03 22:21:25 +00:00
1e3fde0a10
docs: Add skin imgs; change external links to micropython.org/resources.
2014-11-03 22:14:23 +00:00
72165c01f0
docs: Adjust table spacing in topindex page.
2014-11-03 20:48:43 +00:00
bfd11a35db
docs: Fix typo in Fading LEDs
2014-11-03 09:42:38 +01:00
f6e825b42e
docs: Disable logo and add spacing to top index.
2014-11-02 23:45:29 +00:00
6e6dfdc56b
docs: Make custom index page; add more docs.
2014-11-02 23:37:02 +00:00
38bd762121
stmhal: Improve pyb.freq to allow 8 and 16MHz (not usable with USB).
...
Also restrict higher frequencies to have a VCO_OUT frequency below
432MHz, as specified in the datasheet.
Docs improved to list allowed frequencies, and explain about USB
stability.
2014-11-02 15:10:15 +00:00
a58713a899
docs: Cleanup and update some docs.
2014-10-31 22:21:37 +00:00
109c1de015
py: Make gc.enable/disable just control auto-GC; alloc is still allowed.
...
gc.enable/disable are now the same as CPython: they just control whether
automatic garbage collection is enabled or not. If disabled, you can
still allocate heap memory, and initiate a manual collection.
2014-10-31 21:30:46 +00:00
4029f51842
stmhal: Fix UART so bits counts number of data bits, not incl parity.
...
Addresses issue #950 .
2014-10-31 20:28:10 +00:00
fa73c9cb25
docs: Add 2 images for tutorials.
2014-10-31 01:43:37 +00:00
88d3054ac0
docs: Import documentation from source-code inline comments.
...
The inline docs (prefixed with /// in .c files) have been converted to
RST format and put in the docs subdirectory.
2014-10-31 01:37:19 +00:00
47f349e7de
docs: Fix links to images and other parts of the docs.
2014-10-31 00:58:23 +00:00
c92ef361c7
docs: Add tutorial for fading LED using PWM, with fritzing image
2014-10-31 00:49:17 +00:00
ccedf000ed
docs: Increase size of pyboard pinout.
2014-10-26 22:58:18 +00:00
8768f8ad4b
docs: Add quick reference page, with pinout and short example code.
2014-10-26 22:11:34 +00:00
55a5b80793
docs: Make images and youtube video links work for LCD and AMP docs.
...
Images are currently served from micropython.org/static. I don't know
if there is a better way to handle images.
2014-09-25 19:42:27 +01:00
d19c256656
docs: Imported tutorials from previous documentation system.
2014-09-25 17:23:06 +01:00
6162bea5b2
docs: Initial commit of Sphinx documentation framework.
2014-09-25 17:23:06 +01:00
Paul Sokolovsky
Damien George
Peter Hinch
danicampora
Noah Rosamilia
Henrik Sölver
Chris Liechti
Jason Hildebrand
Noah
Dave Hylands
Martijn Koster
Radomir Dopieralski
Bill Owens
Steve Zatz
blmorris
Ivan Pejić
Peter Hinch
Radomir Dopieralski
Gregory
inaugurator
evildmp
Matthias
Márton Szinovszki
Shuning Bian