Go to file
Jade Mattsson 53da95b5ae Fix uart.on('data') on console
With the switch to use the IDF's stdin for feeding the Lua VM, we
unintentionally lost the ability to use uart.on('data') on the console uart.
This is since we no longer install the nodemcu uart driver on said uart.
In order to resolve this shortcoming, this commit refactors the uart.on('data')
delimiter handling and moves it away from platform.c into uart.c where it
really belongs. A new function, uart_feed_data(), is introduced, which is used
both by the nodemcu uart driver task as well as the nodemcu console driver
task (assuming the console is in fact a uart).

The linebuffer allocation/freeing is still in response to
uart.start()/uart.stop(), but it is now in uart.c rather than
platform.c.

The whole uart integration is still too tightly coupled between the platform
component and the module component's uart.c, but this makes it slightly
better at least.
2024-05-21 16:22:51 +10:00
.github Initial support for ESP32-C6 and ESP32-H2, plus assorted fixes & improvements (#3646) 2024-04-26 17:35:22 -04:00
components Fix uart.on('data') on console 2024-05-21 16:22:51 +10:00
docs Update u8g2 docs (#3650) 2024-05-09 07:58:52 +02:00
examples consolidate telnet example 2016-01-06 23:18:42 +01:00
extcomp-template Improvements to external component/module support. 2023-01-17 14:08:47 +11:00
lua_compat Set missing DATABITS_8 property (#2672) 2019-04-22 11:41:13 +02:00
lua_examples Add touch sensor module (#2863) 2019-10-27 19:49:56 +01:00
lua_modules Joystick Lua library and example code (#2710) 2019-04-22 14:46:49 +02:00
sdk Initial support for ESP32-C6 and ESP32-H2, plus assorted fixes & improvements (#3646) 2024-04-26 17:35:22 -04:00
tools Update to IDF v4.4.3. 2023-02-09 15:52:38 +11:00
.gitignore Initial migration to IDFv5.0 2024-01-30 11:34:03 +11:00
.gitmodules ESP32 precompiled toolchain (#2730) 2019-04-22 14:45:27 +02:00
.readthedocs.yaml Fix the RTD configuration 2024-01-23 23:01:12 +01:00
CMakeLists.txt Initial support for using external components/modules. 2023-01-17 14:08:47 +11:00
CONTRIBUTING.md Switch from readthedocs.org to readthedocs.io 2016-04-28 08:09:35 +02:00
LICENSE update doc 2014-11-21 00:10:01 +08:00
Makefile Remove defunct extmod bits. 2023-01-17 14:08:47 +11:00
README.md Replace CI badge 2021-08-04 12:24:49 +02:00
install.sh idf4: overhaul to new build system, part 1 of 3 2021-07-15 16:27:03 +10:00
mkdocs.yml Added espnow module with documentation. 2024-03-27 15:43:59 +11:00
requirements.txt Remove old cryptography package lock. 2024-01-30 11:34:03 +11:00
sdkconfig.defaults IDF web server module (#3502) 2022-03-05 13:51:54 +11:00

README.md

NodeMCU on ESP32

Join the chat at https://gitter.im/nodemcu/nodemcu-firmware CI Documentation Status License

A Lua based firmware for ESP32 WiFi SOC

NodeMCU is an eLua based firmware for the ESP32 WiFi SOC from Espressif. The firmware is based on the Espressif IoT Development Framework and uses a file system based on spiffs. The code repository consists of 98.1% C-code that glues the thin Lua veneer to the SDK.

The NodeMCU firmware is a companion project to the popular NodeMCU dev kits, ready-made open source development boards with ESP8266-12E chips.

Summary

  • Easy to program wireless node and/or access point
  • Based on Lua 5.1.4 (without debug, os modules)
  • Asynchronous event-driven programming model
  • 10+ built-in modules
  • Firmware available with or without floating point support (integer-only uses less memory)
  • Up-to-date documentation at https://nodemcu.readthedocs.io

Programming Model

The NodeMCU programming model is similar to that of Node.js, only in Lua. It is asynchronous and event-driven. Many functions, therefore, have parameters for callback functions. To give you an idea what a NodeMCU program looks like study the short snippets below. For more extensive examples have a look at the /lua_examples folder in the repository on GitHub.

-- a simple HTTP server
srv = net.createServer(net.TCP)
srv:listen(80, function(conn)
	conn:on("receive", function(sck, payload)
		print(payload)
		sck:send("HTTP/1.0 200 OK\r\nContent-Type: text/html\r\n\r\n<h1> Hello, NodeMCU.</h1>")
	end)
	conn:on("sent", function(sck) sck:close() end)
end)
-- connect to WiFi access point
wifi.mode(wifi.STATION, true)

wifi.sta.on("connected", function() print("connected") end)
wifi.sta.on("got_ip", function(event, info) print("got ip "..info.ip) end)

-- mandatory to start wifi after reset
wifi.start()
wifi.sta.config({ssid="SSID", pwd="password", auto=true}, true)

Documentation

The entire NodeMCU documentation is maintained right in this repository at /docs. The fact that the API documentation is maintained in the same repository as the code that provides the API ensures consistency between the two. With every commit the documentation is rebuilt by Read the Docs and thus transformed from terse Markdown into a nicely browsable HTML site at https://nodemcu.readthedocs.io/en/dev-esp32/.

Support

See https://nodemcu.readthedocs.io/en/dev/en/support/.

License

MIT © zeroday/nodemcu.com