{"id":13418297,"url":"https://github.com/nodemcu/nodemcu-firmware","last_synced_at":"2026-10-18T22:29:59.028Z","repository":{"id":23550345,"uuid":"26917568","full_name":"nodemcu/nodemcu-firmware","owner":"nodemcu","description":"Lua based interactive firmware for ESP8266, ESP8285 and ESP32","archived":false,"fork":false,"pushed_at":"2026-06-07T14:37:16.000Z","size":113147,"stargazers_count":7944,"open_issues_count":119,"forks_count":3101,"subscribers_count":530,"default_branch":"release","last_synced_at":"2026-09-04T03:40:13.550Z","etag":null,"topics":["esp32","esp8266","esp8285","espressif","firmware","lua","nodemcu","spiffs"],"latest_commit_sha":null,"homepage":"https://nodemcu.readthedocs.io","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nodemcu.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":"docs/support.md","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2014-11-20T15:06:45.000Z","updated_at":"2026-08-31T17:37:39.000Z","dependencies_parsed_at":"2024-02-25T08:31:15.457Z","dependency_job_id":"9f8c2934-f813-4cd1-8484-c5a11a306e96","html_url":"https://github.com/nodemcu/nodemcu-firmware","commit_stats":{"total_commits":1952,"total_committers":207,"mean_commits":9.429951690821255,"dds":0.8627049180327868,"last_synced_commit":"36cbf9f017d356319a6369e299765eedff191154"},"previous_names":[],"tags_count":33,"template":false,"template_full_name":null,"purl":"pkg:github/nodemcu/nodemcu-firmware","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodemcu%2Fnodemcu-firmware","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodemcu%2Fnodemcu-firmware/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodemcu%2Fnodemcu-firmware/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodemcu%2Fnodemcu-firmware/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nodemcu","download_url":"https://codeload.github.com/nodemcu/nodemcu-firmware/tar.gz/refs/heads/release","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodemcu%2Fnodemcu-firmware/sbom","scorecard":{"id":692658,"data":{"date":"2025-08-11","repo":{"name":"github.com/nodemcu/nodemcu-firmware","commit":"36cbf9f017d356319a6369e299765eedff191154"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.3,"checks":[{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":8,"reason":"Found 22/25 approved changesets -- score normalized to 8","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/AutoCreateRelease.yml:1","Warn: no topLevel permission defined: .github/workflows/build.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Binary-Artifacts","score":9,"reason":"binaries present in source code","details":["Warn: binary detected: tools/xxd.exe:1"],"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact 3.0.0-release_20240225 not signed: https://api.github.com/repos/nodemcu/nodemcu-firmware/releases/143515916","Warn: release artifact 3.0.0-release_20211229 not signed: https://api.github.com/repos/nodemcu/nodemcu-firmware/releases/56203409","Warn: release artifact 3.0.0-release_20210201 not signed: https://api.github.com/repos/nodemcu/nodemcu-firmware/releases/37243268","Warn: release artifact 3.0-release_20201107 not signed: https://api.github.com/repos/nodemcu/nodemcu-firmware/releases/33599538","Warn: release artifact 3.0-release_20200910 not signed: https://api.github.com/repos/nodemcu/nodemcu-firmware/releases/31877052","Warn: release artifact 3.0.0-release_20240225 does not have provenance: https://api.github.com/repos/nodemcu/nodemcu-firmware/releases/143515916","Warn: release artifact 3.0.0-release_20211229 does not have provenance: https://api.github.com/repos/nodemcu/nodemcu-firmware/releases/56203409","Warn: release artifact 3.0.0-release_20210201 does not have provenance: https://api.github.com/repos/nodemcu/nodemcu-firmware/releases/37243268","Warn: release artifact 3.0-release_20201107 does not have provenance: https://api.github.com/repos/nodemcu/nodemcu-firmware/releases/33599538","Warn: release artifact 3.0-release_20200910 does not have provenance: https://api.github.com/repos/nodemcu/nodemcu-firmware/releases/31877052"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/AutoCreateRelease.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/nodemcu/nodemcu-firmware/AutoCreateRelease.yml/release?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/AutoCreateRelease.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/nodemcu/nodemcu-firmware/AutoCreateRelease.yml/release?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/AutoCreateRelease.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/nodemcu/nodemcu-firmware/AutoCreateRelease.yml/release?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/AutoCreateRelease.yml:68: update your workflow using https://app.stepsecurity.io/secureworkflow/nodemcu/nodemcu-firmware/AutoCreateRelease.yml/release?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/AutoCreateRelease.yml:74: update your workflow using https://app.stepsecurity.io/secureworkflow/nodemcu/nodemcu-firmware/AutoCreateRelease.yml/release?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:266: update your workflow using https://app.stepsecurity.io/secureworkflow/nodemcu/nodemcu-firmware/build.yml/release?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/nodemcu/nodemcu-firmware/build.yml/release?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:53: update your workflow using https://app.stepsecurity.io/secureworkflow/nodemcu/nodemcu-firmware/build.yml/release?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:64: update your workflow using https://app.stepsecurity.io/secureworkflow/nodemcu/nodemcu-firmware/build.yml/release?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:77: update your workflow using https://app.stepsecurity.io/secureworkflow/nodemcu/nodemcu-firmware/build.yml/release?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:103: update your workflow using https://app.stepsecurity.io/secureworkflow/nodemcu/nodemcu-firmware/build.yml/release?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:107: update your workflow using https://app.stepsecurity.io/secureworkflow/nodemcu/nodemcu-firmware/build.yml/release?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:133: update your workflow using https://app.stepsecurity.io/secureworkflow/nodemcu/nodemcu-firmware/build.yml/release?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:137: update your workflow using https://app.stepsecurity.io/secureworkflow/nodemcu/nodemcu-firmware/build.yml/release?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:166: update your workflow using https://app.stepsecurity.io/secureworkflow/nodemcu/nodemcu-firmware/build.yml/release?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:170: update your workflow using https://app.stepsecurity.io/secureworkflow/nodemcu/nodemcu-firmware/build.yml/release?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:203: update your workflow using https://app.stepsecurity.io/secureworkflow/nodemcu/nodemcu-firmware/build.yml/release?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:207: update your workflow using https://app.stepsecurity.io/secureworkflow/nodemcu/nodemcu-firmware/build.yml/release?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:239: update your workflow using https://app.stepsecurity.io/secureworkflow/nodemcu/nodemcu-firmware/build.yml/release?enable=pin","Warn: pipCommand not pinned by hash: .github/workflows/build.yml:33","Info:   0 out of  19 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'release'","Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Vulnerabilities","score":5,"reason":"5 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-cpwx-vrp4-4pq7","Warn: Project is vulnerable to: GHSA-gmj6-6f8f-6699","Warn: Project is vulnerable to: GHSA-h5c8-rqwp-cp95","Warn: Project is vulnerable to: GHSA-h75v-3vvj-5mfj","Warn: Project is vulnerable to: GHSA-q2x7-8rv6-6q7h"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 29 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-22T02:40:54.069Z","repository_id":23550345,"created_at":"2025-08-22T02:40:54.069Z","updated_at":"2025-08-22T02:40:54.069Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":344872684,"owners_count":38342766,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-10-03T21:59:58.778Z","status":"online","status_checked_at":"2026-10-18T02:00:06.448Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["esp32","esp8266","esp8285","espressif","firmware","lua","nodemcu","spiffs"],"created_at":"2024-07-30T22:01:00.765Z","updated_at":"2026-10-18T22:29:59.021Z","avatar_url":"https://github.com/nodemcu.png","language":"C","funding_links":[],"categories":["C","Other","Prototyping","Lua Tools, Libraries, and Frameworks","Tools","IoT 笔记","Firmware","Robotics \u0026 Embedded Systems"],"sub_categories":["Scientific Computing","viii. Linear Regression","Mesh networks","开发平台"],"readme":"# NodeMCU 3.0.0\n\u003e Lua-based firmware for ESP8266 WiFi SOC\n\n[![Join the chat at https://gitter.im/nodemcu/nodemcu-firmware](https://img.shields.io/gitter/room/badges/shields.svg)](https://gitter.im/nodemcu/nodemcu-firmware?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge)\n[![CI](https://github.com/nodemcu/nodemcu-firmware/actions/workflows/build.yml/badge.svg)](https://github.com/nodemcu/nodemcu-firmware/actions/workflows/build.yml)\n[![Documentation Status](https://img.shields.io/badge/docs-release-yellow.svg?style=flat)](http://nodemcu.readthedocs.io/en/release/)\n[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](#license)\n\nNodeMCU is an open source [Lua](https://www.lua.org/) based firmware for the [ESP8266 WiFi SOC from Espressif](https://www.espressif.com/en/products/socs/esp8266) and uses an on-module flash-based [SPIFFS](https://github.com/pellepl/spiffs) file system. NodeMCU is implemented in C and is layered on the [Espressif NON-OS SDK](https://github.com/espressif/ESP8266_NONOS_SDK).\n\nThe firmware was initially developed as is a companion project to the popular ESP8266-based [NodeMCU development modules]((https://github.com/nodemcu/nodemcu-devkit-v1.0)), but the project is now community-supported, and the firmware can now be run on _any_ ESP module.\n\n**The NodeMCU `release` and `dev` branches target the ESP8266. The `dev-esp32` branch targets the ESP32.**\n\n## Summary\n\n- Easy to program wireless node and/or access point\n- Based on Lua 5.1.4 or Lua 5.3 but without `debug`, `io`, `os` and (most of the) `math` modules\n- Asynchronous event-driven programming model\n- More than **70 built-in C modules** and **close to 20 Lua modules**\n- Firmware available with or without floating point support (integer-only uses less memory)\n- Up-to-date documentation at [https://nodemcu.readthedocs.io](https://nodemcu.readthedocs.io)\n\n### LFS support\n\nIn July 2018 support for a Lua Flash Store (LFS) was introduced. LFS  allows Lua code and its associated constant data to be executed directly out of flash-memory; just as the firmware itself is executed. This now enables NodeMCU developers to create **Lua applications with up to 256Kb** Lua code and read-only constants executing out of flash. All of the RAM is available for read-write data!\n\n## Programming Model\n\nThe NodeMCU programming model is similar to that of [Node.js](https://en.wikipedia.org/wiki/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`](lua_examples) folder in the repository on GitHub.\n\n```lua\n-- a simple HTTP server\nsrv = net.createServer(net.TCP)\nsrv:listen(80, function(conn)\n\tconn:on(\"receive\", function(sck, payload)\n\t\tprint(payload)\n\t\tsck:send(\"HTTP/1.0 200 OK\\r\\nContent-Type: text/html\\r\\n\\r\\n\u003ch1\u003e Hello, NodeMCU.\u003c/h1\u003e\")\n\tend)\n\tconn:on(\"sent\", function(sck) sck:close() end)\nend)\n```\n```lua\n-- connect to WiFi access point\nwifi.setmode(wifi.STATION)\nwifi.sta.config{ssid=\"SSID\", pwd=\"password\"}\n```\n\n## Documentation\n\nThe entire [NodeMCU documentation](https://nodemcu.readthedocs.io) is maintained right in this repository at [/docs](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](https://nodemcu.readthedocs.io).\n\n\nPages:\n\n- How to [build the firmware](https://nodemcu.readthedocs.io/en/release/build/)\n- How to [flash the firmware](https://nodemcu.readthedocs.io/en/release/flash/)\n- How to [upload code and NodeMCU IDEs](https://nodemcu.readthedocs.io/en/release/upload/)\n- API documentation for every module\n\n\n## Releases\n\nDue to the ever-growing number of modules available within NodeMCU, pre-built binaries are no longer made available. Use the automated [custom firmware build service](http://nodemcu-build.com/) to get the specific firmware configuration you need, or consult the [documentation](http://nodemcu.readthedocs.io/en/release/build/) for other options to build your own firmware.\n\nThis project uses two main branches, `release` and `dev`. `dev` is actively worked on and it's also where PRs should be created against. `release` thus can be considered \"stable\" even though there are no automated regression tests. The goal is to merge back to `release` roughly every 2 months. Depending on the current \"heat\" (issues, PRs) we accept changes to `dev` for 5-6 weeks and then hold back for 2-3 weeks before the next snap is completed.\n\nA new tag is created every time the `dev` branch is merged back to `release`. They are listed in this repo's [releases](https://github.com/nodemcu/nodemcu-firmware/releases).\n\nTag names follow the `\u003cSDK-version\u003e-release_yyyymmdd` pattern.\n\n## Support\n\nSee [https://nodemcu.readthedocs.io/en/release/support/](https://nodemcu.readthedocs.io/en/release/support/).\n\n## License\n\n[MIT](/LICENSE) © [zeroday](https://github.com/NodeMCU)/[nodemcu.com](http://nodemcu.com/index_en.html)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnodemcu%2Fnodemcu-firmware","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnodemcu%2Fnodemcu-firmware","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnodemcu%2Fnodemcu-firmware/lists"}