nodemcu-firmware/mkdocs.yml

site_name: NodeMCU Documentation
site_description: Description of the NodeMCU documentation
repo_url: https://github.com/nodemcu/nodemcu-firmware/

theme: readthedocs
strict: false # mustn't be true due to https://github.com/rtfd/readthedocs.org/issues/4314 

markdown_extensions:
#http://pythonhosted.org/Markdown/extensions/admonition.html
- admonition:
- toc:
    permalink: True

#requird due to https://github.com/rtfd/readthedocs.org/issues/1313
#see http://mkdocs.readthedocs.org/en/latest/user-guide/styling-your-docs/#customising-a-theme
extra_css:
- css/extra.css
extra_javascript:
- js/extra.js

pages:
- Overview: 'index.md'
- English:
    - Home: 'en/index.md'
    - Building the firmware: 'en/build.md'
    - Flashing the firmware: 'en/flash.md'
    - Uploading code: 'en/upload.md'
    - Support: 'en/support.md'
    - FAQs:
        - Lua Developer FAQ: 'en/lua-developer-faq.md'
        - Extension Developer FAQ: 'en/extn-developer-faq.md'
        - Hardware FAQ: 'en/hardware-faq.md'
    - Whitepapers:
        - Filesystem on SD card: 'en/sdcard.md'
        - Internal filesystem: 'en/spiffs.md'
        - Lua Compact Debug (LCD): 'en/lcd.md'
        - Lua Flash Store (LFS): 'en/lfs.md'
    - Modules:
        - 'adc': 'en/modules/adc.md'
        - 'ads1115' : 'en/modules/ads1115.md'
        - 'adxl345': 'en/modules/adxl345.md'
        - 'am2320': 'en/modules/am2320.md'
        - 'apa102': 'en/modules/apa102.md'
        - 'bit': 'en/modules/bit.md'
        - 'bloom' : 'en/modules/bloom.md'
        - 'bme280': 'en/modules/bme280.md'
        - 'bme680': 'en/modules/bme680.md'
        - 'bmp085': 'en/modules/bmp085.md'
        - 'cjson': 'en/modules/cjson.md'
        - 'coap': 'en/modules/coap.md'
        - 'color-utils': 'en/modules/color-utils.md'
        - 'cron': 'en/modules/cron.md'
        - 'crypto': 'en/modules/crypto.md'
        - 'dht': 'en/modules/dht.md'
        - 'ds18b20': 'en/modules/ds18b20.md'
        - 'encoder': 'en/modules/encoder.md'
        - 'enduser setup': 'en/modules/enduser-setup.md'
        - 'file': 'en/modules/file.md'
        - 'gdbstub': 'en/modules/gdbstub.md'
        - 'gpio': 'en/modules/gpio.md'
        - 'hdc1080': 'en/modules/hdc1080.md'
        - 'hmc5883l': 'en/modules/hmc5883l.md'
        - 'http': 'en/modules/http.md'
        - 'hx711' : 'en/modules/hx711.md'
        - 'i2c' : 'en/modules/i2c.md'
        - 'l3g4200d' : 'en/modules/l3g4200d.md'
        - 'mcp4725': 'en/modules/mcp4725.md'
        - 'mdns': 'en/modules/mdns.md'
        - 'mqtt': 'en/modules/mqtt.md'
        - 'net': 'en/modules/net.md'
        - 'node': 'en/modules/node.md'
        - 'ow (1-Wire)': 'en/modules/ow.md'
        - 'pcm' : 'en/modules/pcm.md'
        - 'perf': 'en/modules/perf.md'
        - 'pwm' : 'en/modules/pwm.md'
        - 'rc' : 'en/modules/rc.md'
        - 'rfswitch' : 'en/modules/rfswitch.md'
        - 'rotary' : 'en/modules/rotary.md'
        - 'rtcfifo': 'en/modules/rtcfifo.md'
        - 'rtcmem': 'en/modules/rtcmem.md'
        - 'rtctime': 'en/modules/rtctime.md'
        - 'si7021' : 'en/modules/si7021.md'
        - 'sigma delta': 'en/modules/sigma-delta.md'
        - 'sjson': 'en/modules/sjson.md'
        - 'sntp': 'en/modules/sntp.md'
        - 'somfy': 'en/modules/somfy.md'
        - 'spi': 'en/modules/spi.md'
        - 'sqlite3': 'en/modules/sqlite3.md'
        - 'struct': 'en/modules/struct.md'
        - 'switec': 'en/modules/switec.md'
        - 'tcs34725': 'en/modules/tcs34725.md'
        - 'tls': 'en/modules/tls.md'
        - 'tm1829': 'en/modules/tm1829.md'
        - 'tmr': 'en/modules/tmr.md'
        - 'tsl2561': 'en/modules/tsl2561.md'
        - 'u8g': 'en/modules/u8g.md'
        - 'uart': 'en/modules/uart.md'
        - 'ucg': 'en/modules/ucg.md'
        - 'websocket': 'en/modules/websocket.md'
        - 'wifi': 'en/modules/wifi.md'
        - 'wifi.monitor': 'en/modules/wifi_monitor.md'
        - 'wps': 'en/modules/wps.md'
        - 'ws2801': 'en/modules/ws2801.md'
        - 'ws2812': 'en/modules/ws2812.md'
        - 'ws2812-effects': 'en/modules/ws2812-effects.md'
        - 'xpt2046': 'en/modules/xpt2046.md'
#- Deutsch:
#    - Home: 'de/index.md'
Add first MkDocs skeleton 2015-12-04 23:12:28 +01:00			`site_name: NodeMCU Documentation`
			`site_description: Description of the NodeMCU documentation`
Playing with page structure 2015-12-05 01:05:14 +01:00			`repo_url: https://github.com/nodemcu/nodemcu-firmware/`
Fix blockquote style and admonition 2015-12-14 21:41:06 +01:00
Change ordering of properties 2015-12-17 17:33:43 +01:00			`theme: readthedocs`
Work around RTD issue with new MkDocs 2018-06-30 21:13:15 +02:00			`strict: false # mustn't be true due to https://github.com/rtfd/readthedocs.org/issues/4314`
Change ordering of properties 2015-12-17 17:33:43 +01:00
Playing with page structure 2015-12-05 01:05:14 +01:00			`markdown_extensions:`
Change ordering of properties 2015-12-17 17:33:43 +01:00			`#http://pythonhosted.org/Markdown/extensions/admonition.html`
Fix blockquote style and admonition 2015-12-14 21:41:06 +01:00			`- admonition:`
Playing with page structure 2015-12-05 01:05:14 +01:00			`- toc:`
			`permalink: True`
Fix blockquote style and admonition 2015-12-14 21:41:06 +01:00
Typo fix 2016-01-01 15:12:04 +01:00			`#requird due to https://github.com/rtfd/readthedocs.org/issues/1313`
Add config changes to to RTD behavior 2015-12-27 23:51:54 +01:00			`#see http://mkdocs.readthedocs.org/en/latest/user-guide/styling-your-docs/#customising-a-theme`
Add config changes to to RTD behavior 2015-12-27 23:49:11 +01:00			`extra_css:`
			`- css/extra.css`
Add config changes to to RTD behavior 2015-12-27 23:51:54 +01:00			`extra_javascript:`
Add config changes to to RTD behavior 2015-12-27 23:49:11 +01:00			`- js/extra.js`

Add first MkDocs skeleton 2015-12-04 23:12:28 +01:00			`pages:`
Add experimental localized content structure 2015-12-27 23:32:07 +01:00			`- Overview: 'index.md'`
			`- English:`
Rename DIR to dir and improve JavaScript for RTD 2015-12-28 17:25:00 +01:00			`- Home: 'en/index.md'`
			`- Building the firmware: 'en/build.md'`
			`- Flashing the firmware: 'en/flash.md'`
Final polishing on several pages 2016-01-16 23:11:40 +01:00			`- Uploading code: 'en/upload.md'`
Fix TOC structure and LCD/LFS links 2018-06-30 12:27:59 +02:00			`- Support: 'en/support.md'`
Add New Tasking I/F and rework GPIO, UART, etc to support it As with the last commit this rolls up the follwowing, but include the various review comments on the PR. - Documentation changes. I've added the taks FAQ as a stub new Extension developer FAQ, and split the old FAQ into a Lua Developer FAQ and a Hardware FAQ. - Tasking I/F. New `app/task/Makefile`, `app/task/task.c`, `app/include/task/task.h` and `app/Makefile` as per previous commit. Cascade changes to `app/driver/uart.c`, `app/include/driver/uart.h`, `app/user/user_main.c` and `app/modules/node.c` - GPIO Rework to `app/modules/gpio.c` and `pin_map.[hc]`, `platform.[hc]` in `app/platform` - Other Optimisations Move the `platform_*_exists()` from `app/platform/common.c` to static inline declarations in `platform.h` as this generates faster, smaller code. Move lgc.a routines out of iram0. 2016-02-17 18:13:17 +01:00			`- FAQs:`
			`- Lua Developer FAQ: 'en/lua-developer-faq.md'`
			`- Extension Developer FAQ: 'en/extn-developer-faq.md'`
			`- Hardware FAQ: 'en/hardware-faq.md'`
LFS patch updates following review II and testing 2018-06-22 23:29:16 +02:00			`- Whitepapers:`
			`- Filesystem on SD card: 'en/sdcard.md'`
Fix TOC structure and LCD/LFS links 2018-06-30 12:27:59 +02:00			`- Internal filesystem: 'en/spiffs.md'`
Fix LFS Markdown syntax Contributes to #2432 2018-07-23 23:00:11 +02:00			`- Lua Compact Debug (LCD): 'en/lcd.md'`
			`- Lua Flash Store (LFS): 'en/lfs.md'`
Add experimental localized content structure 2015-12-27 23:32:07 +01:00			`- Modules:`
Documented previously undocumented adc module. 2016-01-05 04:06:01 +01:00			`- 'adc': 'en/modules/adc.md'`
add ads1115 module (#1942) * add ads1115 module * replace os_delay with os_timer * typo 2017-05-07 09:49:57 +02:00			`- 'ads1115' : 'en/modules/ads1115.md'`
Added support for Analog Devices ADXL345 accelerometer (#1252) 2016-06-05 22:59:55 +02:00			`- 'adxl345': 'en/modules/adxl345.md'`
Add i2c based module for am2320 humidity sensor Example use: > sda=1 > scl=2 > am2320.init(sda,scl) > rh, t = am2320.read() > print(string.format("Temperature: %s degrees C", t / 10)) > print(string.format("RH: %s %%", rh / 10)) signed-off-by: henk.vergonet@gmail.com 2016-02-13 12:57:19 +01:00			`- 'am2320': 'en/modules/am2320.md'`
Make the APA102 docs available on RTD 2016-01-26 23:07:29 +01:00			`- 'apa102': 'en/modules/apa102.md'`
Transferred bit module documentation. 2016-01-05 06:07:29 +01:00			`- 'bit': 'en/modules/bit.md'`
Addition of a Bloom Filter object (#2176) * Initial checkin * Add bloom.md into mkdocs * Added reset and improved info * Update bloom.c * Update bloom.md * Add Wikipedia link 2017-12-03 13:10:59 +01:00			`- 'bloom' : 'en/modules/bloom.md'`
include new bme280 and fix list in sigma-delta 2016-02-21 22:28:01 +01:00			`- 'bme280': 'en/modules/bme280.md'`
Add missing BME680 2018-02-13 12:47:58 +01:00			`- 'bme680': 'en/modules/bme680.md'`
link bmp085 module doc 2016-01-14 22:37:22 +01:00			`- 'bmp085': 'en/modules/bmp085.md'`
Transferred cjson module documentation. 2016-01-06 01:51:48 +01:00			`- 'cjson': 'en/modules/cjson.md'`
add a doc for coap module typo fix 2016-01-16 06:25:54 +01:00			`- 'coap': 'en/modules/coap.md'`
ws2812 effects library (#2215) * ws2812 effects and color utils modules added * Added documentation for new modules to mkdocs.yml * changed mode option to string, documentation, default modules fixed * updated user_modules.h 2018-01-23 21:05:04 +01:00			`- 'color-utils': 'en/modules/color-utils.md'`
Cron module (#1674) 2016-12-26 14:19:12 +01:00			`- 'cron': 'en/modules/cron.md'`
Transferred crypto module documentation. 2016-01-05 04:23:26 +01:00			`- 'crypto': 'en/modules/crypto.md'`
transferred dht module documentation 2016-01-13 23:27:16 +01:00			`- 'dht': 'en/modules/dht.md'`
add ds18b20 module (#2003) * add ds18b20 module * add intitial eeprom value definition * adjust read() function and address handling 2017-08-16 21:04:23 +02:00			`- 'ds18b20': 'en/modules/ds18b20.md'`
Addition of encoder module with bas64 and hex encode/decode as per #925 2016-02-21 05:18:27 +01:00			`- 'encoder': 'en/modules/encoder.md'`
Transfer enduser-setup and mqtt docs 2016-01-10 22:52:05 +01:00			`- 'enduser setup': 'en/modules/enduser-setup.md'`
Transferred file module documentation. 2016-01-05 02:21:19 +01:00			`- 'file': 'en/modules/file.md'`
include gdbstub.md in doc generation (#1763) Thank you! 2017-01-26 21:10:26 +01:00			`- 'gdbstub': 'en/modules/gdbstub.md'`
Transfer enduser-setup and mqtt docs 2016-01-10 22:52:05 +01:00			`- 'gpio': 'en/modules/gpio.md'`
Hdc1080 Module Add (#1880) * Hdc1080 Module Add * for Float/Integer Build fixes * disable module for default * document fix * Deprecate init() in favor of setup() * Fix grammar and code sample * Deprecate init() in favor of setup() * Update hdc1080.md * Update hdc1080.md * Mini fix * Update user_modules.h 2017-04-20 22:23:51 +02:00			`- 'hdc1080': 'en/modules/hdc1080.md'`
Added support for Honeywell HMC5883L digital compass (#1253) 2016-06-05 22:59:39 +02:00			`- 'hmc5883l': 'en/modules/hmc5883l.md'`
Documented HTTP module. 2016-01-16 12:59:08 +01:00			`- 'http': 'en/modules/http.md'`
Register updated HX711 doc file 2016-01-10 23:32:51 +01:00			`- 'hx711' : 'en/modules/hx711.md'`
transferred i2c module 2016-01-10 21:27:09 +01:00			`- 'i2c' : 'en/modules/i2c.md'`
Added support for STM L3G4200D digital gyroscope (#1251) 2016-06-05 23:00:37 +02:00			`- 'l3g4200d' : 'en/modules/l3g4200d.md'`
Add mcp4725 module (#1966) 2017-05-21 16:30:26 +02:00			`- 'mcp4725': 'en/modules/mcp4725.md'`
Simple mdns implementation using the Espressif code 2016-01-28 03:57:58 +01:00			`- 'mdns': 'en/modules/mdns.md'`
transferred ow module documentation 2016-01-17 11:10:51 +01:00			`- 'mqtt': 'en/modules/mqtt.md'`
Add net module documentation 2016-01-11 23:30:30 +01:00			`- 'net': 'en/modules/net.md'`
Transfer enduser-setup and mqtt docs 2016-01-10 22:52:05 +01:00			`- 'node': 'en/modules/node.md'`
Minor syntax fixes for the 1-wire docs 2016-01-17 14:05:41 +01:00			`- 'ow (1-Wire)': 'en/modules/ow.md'`
Add pcm module. (#1255) * Add pcm module. * Add network streaming example. * document hw_timer dependency with pwm * Add vu peak callback. 2016-06-05 23:21:36 +02:00			`- 'pcm' : 'en/modules/pcm.md'`
Performance monitoring tool. Squashed commit of the following: commit f1820af82bb5467d0c79c03290fca809b0273030 Author: philip <philip@gladstonefamily.net> Date: Sun Feb 21 15:08:31 2016 -0500 Now uses userdata commit 74a2298f5f2d2b07097a9501046efb8d4061ec5e Merge: 4ffab15 716e682 Author: philip <philip@gladstonefamily.net> Date: Sun Feb 21 13:54:40 2016 -0500 Merge remote-tracking branch 'upstream/dev' into performance Conflicts: app/platform/hw_timer.c app/platform/hw_timer.h commit 4ffab15a2a15e0c6b2d7e93611a02be47bafdc79 Author: philip <philip@gladstonefamily.net> Date: Fri Feb 12 17:36:12 2016 -0500 Simple low level performance monitoring tool Make it work with the new hw_timer code commit 944db2bdb8a2b725ba683c564b39f30f3b61e47f Author: philip <philip@gladstonefamily.net> Date: Sun Feb 14 10:32:41 2016 -0500 Initial version of the hw_timer as part of the platform Addressed review comments Add the binsize return 2016-02-21 21:12:13 +01:00			`- 'perf': 'en/modules/perf.md'`
transferred pwm module documentation 2016-01-10 21:44:50 +01:00			`- 'pwm' : 'en/modules/pwm.md'`
Add meta-info block to every module doc page 2016-03-05 10:47:01 +01:00			`- 'rc' : 'en/modules/rc.md'`
add new rfswitch module to handle 433MHZ devices (#1565) 2016-12-01 22:19:01 +01:00			`- 'rfswitch' : 'en/modules/rfswitch.md'`
Squashed commit of the following: commit 2c7c3fc3985cc32866e8af496abea9971eaee90a Merge: 9179dae 41022c3 Author: philip <philip@gladstonefamily.net> Date: Sun Feb 28 14:47:47 2016 -0500 Merge remote-tracking branch 'upstream/dev' into rotary_2 commit 9179dae0824e6b35ad09e5113aacc26dc91692c0 Author: philip <philip@gladstonefamily.net> Date: Fri Feb 26 20:53:27 2016 -0500 Review comments commit 67741170e20ccb2b636e701f0664feff2aafbb4c Author: philip <philip@gladstonefamily.net> Date: Fri Feb 26 20:59:49 2016 -0500 Squashed commit of the following: commit 8c9a64731c4a8b9aedda18a399b433b173d2199f Merge: 085935f 19d3c1d Author: philip <philip@gladstonefamily.net> Date: Fri Feb 26 20:58:10 2016 -0500 Merge remote-tracking branch 'upstream/dev' into rotarymod Conflicts: app/platform/platform.c commit 085935fc56986d607ff5e05d1663970331959c34 Author: philip <philip@gladstonefamily.net> Date: Fri Feb 26 20:53:27 2016 -0500 Review comment commit 7732fd2d1044f28b8fcf5b0aa0f76d76fe80f449 Author: philip <philip@gladstonefamily.net> Date: Sat Feb 20 12:10:38 2016 -0500 Module to handle rotary decoders Eliminate ROTARY_DEBUG Remove unused file Eliminate a malloc call Cleaned up the register code. Now 0x114 bytes Fix bug with clearing bits in one case Fix the type in the #define name 2016-02-28 20:48:41 +01:00			`- 'rotary' : 'en/modules/rotary.md'`
Add meta-info block to every module doc page 2016-03-05 10:47:01 +01:00			`- 'rtcfifo': 'en/modules/rtcfifo.md'`
Transferred rtcmem module documentation. 2016-01-05 02:43:57 +01:00			`- 'rtcmem': 'en/modules/rtcmem.md'`
Transferred rtctime module documentation. 2016-01-05 02:56:46 +01:00			`- 'rtctime': 'en/modules/rtctime.md'`
Add missing .md 2017-04-30 19:25:13 +02:00			`- 'si7021' : 'en/modules/si7021.md'`
Add sigma_delta module. 2016-01-31 21:48:59 +01:00			`- 'sigma delta': 'en/modules/sigma-delta.md'`
Add support for streaming JSON encoder/decoder (#1755) Replaces the problematic cjson module. 2017-03-22 01:24:32 +01:00			`- 'sjson': 'en/modules/sjson.md'`
Transferred sntp module documentation. 2016-01-05 03:01:53 +01:00			`- 'sntp': 'en/modules/sntp.md'`
Fix Somfy docs 2016-12-01 21:57:24 +01:00			`- 'somfy': 'en/modules/somfy.md'`
transferred spi module documentation 2016-01-09 14:57:03 +01:00			`- 'spi': 'en/modules/spi.md'`
Add sqlite3 module (#2008) * add final sqlite3 patch * remove unused defines, join caching code with esp vfs code to reduce exported symbols and shrink final file size * Modules should by default be disabled and in alphabetical order 2018-01-10 22:45:56 +01:00			`- 'sqlite3': 'en/modules/sqlite3.md'`
Direct port of the struct module that provides access to packed structures in strings. Very useful for network protocol packing/unpacking. The docs are directly converted from the original. Review feedback Fix typo 2016-02-12 18:15:36 +01:00			`- 'struct': 'en/modules/struct.md'`
Add support for driving instrument gauge stepper motors (#1355) 2016-06-26 14:19:06 +02:00			`- 'switec': 'en/modules/switec.md'`
Add module for TCS34725 colour sensor. (#1895) * Add module for TCS34725 colour sensor. * Fix implicit return. * Fix timer disarm after init completion callback. * Rework init() into setup() as per PR#1887. * Add new module to mkdocs and user_modules. * Fix unclear debug messages. * Documentation updates. * Cleanup comments and formatting. * Don't auto-enable the sensor. * Add callback function to enable. * Simplify Read16. * Remove Lua state argument to enable callback. * Remove self_ref. 2017-04-19 20:16:27 +02:00			`- 'tcs34725': 'en/modules/tcs34725.md'`
Net functionality rewrite on top of LWIP (#1379) * Rewrite net.dns.resolve on LWIP * Move IGMP (net multicast) to LWIP * Cleanup net module * Move secure connection operations to tls module * Net module on LWIP * Server timeout parameter * TCP hold * Fixes in documentation * Documentation fixes * Note TLS module depends on net * Add TLS module to user_modules.h * Callback on connect event * Fix depends net module on tls module * Fix unhold exponential time issue 2016-12-31 13:14:03 +01:00			`- 'tls': 'en/modules/tls.md'`
Added support for tm1829 baed led controllers (#1330) 2016-06-03 23:47:36 +02:00			`- 'tm1829': 'en/modules/tm1829.md'`
Rewrote tmr module documentation, including new API. 2016-01-06 03:06:00 +01:00			`- 'tmr': 'en/modules/tmr.md'`
transferred tsl2561 module documentation 2016-01-12 21:08:46 +01:00			`- 'tsl2561': 'en/modules/tsl2561.md'`
Link u8g module documentation 2016-01-08 20:40:20 +01:00			`- 'u8g': 'en/modules/u8g.md'`
Transferred the uart module documentation. 2016-01-05 04:38:41 +01:00			`- 'uart': 'en/modules/uart.md'`
transferred ucg module documentation 2016-01-09 00:57:07 +01:00			`- 'ucg': 'en/modules/ucg.md'`
Implement initial version for websocket module (#1433) 2016-08-18 13:59:44 +02:00			`- 'websocket': 'en/modules/websocket.md'`
Transferred top-level WiFi module docs. Note that this does not include wifi.sta, wifi.ap or wifi.ap.dhcp docs. 2016-01-13 11:55:18 +01:00			`- 'wifi': 'en/modules/wifi.md'`
Add support for the wifi monitor mode in the SDK (#2204) 2018-01-10 21:24:41 +01:00			`- 'wifi.monitor': 'en/modules/wifi_monitor.md'`
Add WPS module (#1694) * WPS functionality added * WPS module switched off by default * Update mkdocs.yml 2017-01-09 08:43:47 +01:00			`- 'wps': 'en/modules/wps.md'`
fix extensions 2016-01-11 22:43:04 +01:00			`- 'ws2801': 'en/modules/ws2801.md'`
			`- 'ws2812': 'en/modules/ws2812.md'`
ws2812 effects library (#2215) * ws2812 effects and color utils modules added * Added documentation for new modules to mkdocs.yml * changed mode option to string, documentation, default modules fixed * updated user_modules.h 2018-01-23 21:05:04 +01:00			`- 'ws2812-effects': 'en/modules/ws2812-effects.md'`
Add driver for XPT2046 touch controller (#1848) 2017-03-09 07:20:01 +01:00			`- 'xpt2046': 'en/modules/xpt2046.md'`
Final polishing on several pages 2016-01-16 23:11:40 +01:00			`#- Deutsch:`
			`# - Home: 'de/index.md'`