Menu
Home
People
Places
Arts
History
Plants & Animals
Science
Life & Culture
Technology
Reference.org
NodeMCU
open-in-new
<h2 id="overview">Overview</h2> <p>NodeMCU is an open source firmware for which open source <a href="/facts/Prototyping/q0yPLYdb">prototyping</a> board designs are available. The name "NodeMCU" combines "<a href="/facts/Node_(computer_science)/eYlvVE0z">node</a>" and "MCU" (<a href="/facts/Micro-controller/MKrnAhnm">micro-controller</a> unit).<a class="footnote-ref" id="fnref:5" href="#fn:5"><sup>5</sup></a> Strictly speaking, the term "NodeMCU" refers to the firmware rather than the associated <a href="/facts/Development_kits/2Hkk6Hbs">development kits</a>. </p><p>Both the firmware and prototyping board designs are <a href="/facts/Open_source/7X9rCdz4">open source</a>.<a class="footnote-ref" id="fnref:6" href="#fn:6"><sup>6</sup></a> </p><p>The firmware uses the <a href="/facts/Lua_(programming_language)/xkBCgta0">Lua</a> scripting language. The firmware is based on the eLua project, and built on the Espressif Non-OS SDK for ESP8266. It uses many open source projects, such as lua-cjson<a class="footnote-ref" id="fnref:7" href="#fn:7"><sup>7</sup></a> and SPIFFS, a <a href="/facts/Flash_file_system/WX2fXBHU">flash file system</a> for embedded controllers.<a class="footnote-ref" id="fnref:8" href="#fn:8"><sup>8</sup></a> Due to resource constraints, users need to select the modules relevant for their project and build a firmware tailored to their needs. Support for the 32-bit <a href="/facts/ESP32/gW5SX9df">ESP32</a> has also been implemented. </p><p>The prototyping hardware typically used is a circuit board functioning as a <a href="/facts/Dual_in-line_package/Qgu6Jave">dual in-line package</a> (DIP) which integrates a USB controller with a smaller surface-mounted board containing the MCU and antenna. The choice of the DIP format allows for easy prototyping on <a href="/facts/Breadboard/fokXRhUn">breadboards</a>. The design was initially based on the ESP-12 module of the <a href="/facts/ESP8266/vzvbjzXT">ESP8266</a>, which is a Wi-Fi SoC integrated with a <a href="/facts/Tensilica/PkKN657D">Tensilica</a> Xtensa LX106 core, widely used in IoT applications (see related projects). </p> <h2 id="types">Types</h2> <p>There are two available versions of NodeMCU as version 0.9 & 1.0 where the version 0.9 contains ESP-12 and version 1.0 contains ESP-12E where E stands for "Enhanced".<a class="footnote-ref" id="fnref:9" href="#fn:9"><sup>9</sup></a> </p> <h2 id="history">History</h2> <p>NodeMCU was created shortly after the <a href="/facts/ESP8266/vzvbjzXT">ESP8266</a> came out. On December 30, 2013, <a href="/facts/Espressif_Systems/QWDp3psY">Espressif Systems</a><a class="footnote-ref" id="fnref:10" href="#fn:10"><sup>10</sup></a> began production of the ESP8266.<a class="footnote-ref" id="fnref:11" href="#fn:11"><sup>11</sup></a> NodeMCU started on 13 Oct 2014, when Hong committed the first file of nodemcu-firmware to GitHub.<a class="footnote-ref" id="fnref:12" href="#fn:12"><sup>12</sup></a> Two months later, the project expanded to include an open-hardware platform when developer Huang R committed the <a href="/facts/Gerber_format/VJLmFm9j">gerber</a> file of an ESP8266 board, named devkit v0.9.<a class="footnote-ref" id="fnref:13" href="#fn:13"><sup>13</sup></a> Later that month, Tuan PM ported <a href="/facts/MQTT/JltGCjue">MQTT</a> client library from <a href="/facts/Contiki/KEj6UlaA">Contiki</a> to the ESP8266 SoC platform,<a class="footnote-ref" id="fnref:14" href="#fn:14"><sup>14</sup></a> and committed to NodeMCU project, then NodeMCU was able to support the MQTT IoT protocol, using Lua to access the MQTT broker. Another important update was made on 30 Jan 2015, when Devsaurus ported the u8glib<a class="footnote-ref" id="fnref:15" href="#fn:15"><sup>15</sup></a> to the NodeMCU project,<a class="footnote-ref" id="fnref:16" href="#fn:16"><sup>16</sup></a> enabling NodeMCU to easily drive LCD, Screen, OLED, even VGA displays. </p><p>In the summer of 2015 the original creators abandoned the firmware project and a group of independent contributors took over. By the summer of 2016 the NodeMCU included more than 40 different modules. </p> <h2 id="related-projects">Related projects</h2> <h3>ESP8266 Arduino Core</h3> <p>As <a href="/facts/Arduino/Ah1eKzyS">Arduino.cc</a> began developing new MCU boards based on non-<a href="/facts/AVR_microcontrollers/JvfUk4ya">AVR</a> processors like the ARM/SAM MCU used in the Arduino Due, they needed to modify the <a href="/facts/Arduino_IDE/Xu0hzHKb">Arduino IDE</a> so it would be relatively easy to change the IDE to support alternate toolchains to allow Arduino C/C++ to be compiled for these new processors. They did this with the introduction of the Board Manager and the SAM Core. A "core" is the collection of software components required by the Board Manager and the Arduino IDE to compile an Arduino C/C++ source file for the target MCU's machine language. Some ESP8266 enthusiasts developed an Arduino core for the ESP8266 WiFi SoC, popularly called the "ESP8266 Core for the Arduino IDE".<a class="footnote-ref" id="fnref:17" href="#fn:17"><sup>17</sup></a> This has become a leading software development platform for the various ESP8266-based modules and development boards, including NodeMCUs. </p> <h2 id="pins">Pins</h2> <p>NodeMCU provides access to the <a href="/facts/General-purpose_input/output/rIGeu7TW">GPIO</a> (General Purpose Input/Output) and a pin mapping table is part of the API documentation.<a class="footnote-ref" id="fnref:18" href="#fn:18"><sup>18</sup></a> </p> <table><tbody><tr><th>I/O index</th><th>ESP8266 pin</th></tr><tr><td>0 [*]</td><td>GPIO16</td></tr><tr><td>1</td><td>GPIO5</td></tr><tr><td>2</td><td>GPIO4</td></tr><tr><td>3</td><td>GPIO0</td></tr><tr><td>4</td><td>GPIO2</td></tr><tr><td>5</td><td>GPIO14</td></tr><tr><td>6</td><td>GPIO12</td></tr><tr><td>7</td><td>GPIO13</td></tr><tr><td>8</td><td>GPIO15</td></tr><tr><td>9</td><td>GPIO3</td></tr><tr><td>10</td><td>GPIO1</td></tr><tr><td>11</td><td>GPIO9</td></tr><tr><td>12</td><td>GPIO10</td></tr></tbody></table> <p>[*] D0 (GPIO16) can only be used for GPIO read/write. It does not support open-drain/interrupt/PWM/I²C or 1-Wire. </p> <h2 id="see-also">See also</h2> <ul><li><a href="/facts/Microcontroller/MKrnAhnm">MCU (Micro Controller Unit)</a></li></ul> <h2 id="external-links">External links</h2> <ul><li><a href="http://www.nodemcu.com/index_en.html">Official website</a> </li></ul> Wikimedia Commons has media related to NodeMCU. <h2 id="references">References</h2> <ol> <li id="fn:1"><p>Zeroday. "A lua based firmware for wifi-soc esp8266". Github. Retrieved 2 April 2015. <a href="https://github.com/nodemcu/nodemcu-firmware" target="_blank">https://github.com/nodemcu/nodemcu-firmware</a> <a href="#fnref:1" class="footnote-back-ref">↩</a></p></li> <li id="fn:2"><p>Hari Wiguna. "NodeMCU LUA Firmware". Hackaday. Retrieved 2 April 2015. <a href="https://hackaday.io/project/3465-playing-with-esp8266/log/11449-nodemcu-lua-firmware" target="_blank">https://hackaday.io/project/3465-playing-with-esp8266/log/11449-nodemcu-lua-firmware</a> <a href="#fnref:2" class="footnote-back-ref">↩</a></p></li> <li id="fn:3"><p>Systems, Espressif. "Espressif Systems". Espressif-WikiDevi. Archived from the original on 1 December 2017. Retrieved 3 June 2017. <a href="https://web.archive.org/web/20171201034024/https://wikidevi.com/wiki/Espressif" target="_blank">https://web.archive.org/web/20171201034024/https://wikidevi.com/wiki/Espressif</a> <a href="#fnref:3" class="footnote-back-ref">↩</a></p></li> <li id="fn:4"><p>Brian Benchoff (2 January 2015). "A DEV BOARD FOR THE ESP LUA INTERPRETER". Hackaday. Retrieved 2 April 2015. <a href="http://hackaday.com/2015/01/01/a-dev-board-for-the-esp-lua-interpreter/" target="_blank">http://hackaday.com/2015/01/01/a-dev-board-for-the-esp-lua-interpreter/</a> <a href="#fnref:4" class="footnote-back-ref">↩</a></p></li> <li id="fn:5"><p>"IBM Developer". <a href="https://developer.ibm.com/tutorials/iot-nodemcu-open-why-use/" target="_blank">https://developer.ibm.com/tutorials/iot-nodemcu-open-why-use/</a> <a href="#fnref:5" class="footnote-back-ref">↩</a></p></li> <li id="fn:6"><p>"IBM Developer". <a href="https://developer.ibm.com/tutorials/iot-nodemcu-open-why-use/" target="_blank">https://developer.ibm.com/tutorials/iot-nodemcu-open-why-use/</a> <a href="#fnref:6" class="footnote-back-ref">↩</a></p></li> <li id="fn:7"><p>Mpx. "Lua CJSON is a fast JSON encoding/parsing module for Lua". Github. Retrieved 2 April 2015. <a href="https://github.com/mpx/lua-cjson/" target="_blank">https://github.com/mpx/lua-cjson/</a> <a href="#fnref:7" class="footnote-back-ref">↩</a></p></li> <li id="fn:8"><p>Pellepl. "Wear-leveled SPI flash file system for embedded devices". GitHub. Retrieved 2 April 2015. <a href="https://github.com/pellepl/spiffs" target="_blank">https://github.com/pellepl/spiffs</a> <a href="#fnref:8" class="footnote-back-ref">↩</a></p></li> <li id="fn:9"><p>"NodeMCU - A Perfect Board for IoT". circuito.io blog. 2018-11-21. Retrieved 2021-05-27. <a href="https://www.circuito.io/blog/nodemcu-esp8266/" target="_blank">https://www.circuito.io/blog/nodemcu-esp8266/</a> <a href="#fnref:9" class="footnote-back-ref">↩</a></p></li> <li id="fn:10"><p>Systems, Espressif. "Espressif Systems". Espressif-WikiDevi. Archived from the original on 1 December 2017. Retrieved 3 June 2017. <a href="https://web.archive.org/web/20171201034024/https://wikidevi.com/wiki/Espressif" target="_blank">https://web.archive.org/web/20171201034024/https://wikidevi.com/wiki/Espressif</a> <a href="#fnref:10" class="footnote-back-ref">↩</a></p></li> <li id="fn:11"><p>Espressif system (December 30, 2013). "IoT Wi-Fi 802.11b/g/n integrated SoC implementation of volume production". 中国上海讯. Archived from the original on 2 April 2015. Retrieved 2 April 2015. <a href="https://web.archive.org/web/20150402133249/http://article.liepin.com/20140701/365564.shtml" target="_blank">https://web.archive.org/web/20150402133249/http://article.liepin.com/20140701/365564.shtml</a> <a href="#fnref:11" class="footnote-back-ref">↩</a></p></li> <li id="fn:12"><p>Hong. "First commit of NodeMCU Firmware". Github. Retrieved 2 April 2015. <a href="https://github.com/nodemcu/nodemcu-firmware/commit/9c98808289d0863a41c695e03d4067424fc1cdec" target="_blank">https://github.com/nodemcu/nodemcu-firmware/commit/9c98808289d0863a41c695e03d4067424fc1cdec</a> <a href="#fnref:12" class="footnote-back-ref">↩</a></p></li> <li id="fn:13"><p>Huang R. "Initial design of NodeMCU devkit". Github. Retrieved 2 April 2015. <a href="https://github.com/nodemcu/nodemcu-devkit/commit/3c155e5a9f24aa8463aef8c7b011c69e94fcd9c7" target="_blank">https://github.com/nodemcu/nodemcu-devkit/commit/3c155e5a9f24aa8463aef8c7b011c69e94fcd9c7</a> <a href="#fnref:13" class="footnote-back-ref">↩</a></p></li> <li id="fn:14"><p>Tuan PM. "MQTT client library for ESP8266". Github. Retrieved 2 April 2015. <a href="https://github.com/tuanpmt/esp_mqtt" target="_blank">https://github.com/tuanpmt/esp_mqtt</a> <a href="#fnref:14" class="footnote-back-ref">↩</a></p></li> <li id="fn:15"><p>Olikraus; Daniel Sittig. "Universal Graphics Library for 8 Bit Embedded Systems". Google code. Retrieved 2 April 2015. <a href="https://code.google.com/p/u8glib/" target="_blank">https://code.google.com/p/u8glib/</a> <a href="#fnref:15" class="footnote-back-ref">↩</a></p></li> <li id="fn:16"><p>Devsaurus. "U8glib for esp8266". Github. Retrieved 2 April 2015. <a href="https://github.com/devsaurus/nodemcu-firmware/commit/33601462efdcea189f1f20f2cece66581ee57951" target="_blank">https://github.com/devsaurus/nodemcu-firmware/commit/33601462efdcea189f1f20f2cece66581ee57951</a> <a href="#fnref:16" class="footnote-back-ref">↩</a></p></li> <li id="fn:17"><p>"ESP8266 core for Arduino". GitHub. Retrieved 10 January 2019. <a href="https://github.com/esp8266/Arduino" target="_blank">https://github.com/esp8266/Arduino</a> <a href="#fnref:17" class="footnote-back-ref">↩</a></p></li> <li id="fn:18"><p>"gpio - NodeMCU Documentation". nodemcu.readthedocs.io. Retrieved 2018-11-11. <a href="https://nodemcu.readthedocs.io/en/latest/en/modules/gpio/" target="_blank">https://nodemcu.readthedocs.io/en/latest/en/modules/gpio/</a> <a href="#fnref:18" class="footnote-back-ref">↩</a></p></li> </ol>