{"id":13453344,"url":"https://github.com/pfalcon/esp-open-sdk","last_synced_at":"2025-05-15T09:04:59.290Z","repository":{"id":23334777,"uuid":"26695164","full_name":"pfalcon/esp-open-sdk","owner":"pfalcon","description":"Free and open (as much as possible) integrated SDK for ESP8266/ESP8285 chips","archived":false,"fork":false,"pushed_at":"2022-01-12T01:11:42.000Z","size":342,"stargazers_count":1975,"open_issues_count":139,"forks_count":628,"subscribers_count":201,"default_branch":"master","last_synced_at":"2025-04-07T03:17:39.239Z","etag":null,"topics":["esp8266","xtensa"],"latest_commit_sha":null,"homepage":"","language":"Makefile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pfalcon.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-11-15T21:49:29.000Z","updated_at":"2025-03-25T12:03:13.000Z","dependencies_parsed_at":"2022-08-21T22:50:19.515Z","dependency_job_id":null,"html_url":"https://github.com/pfalcon/esp-open-sdk","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pfalcon%2Fesp-open-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pfalcon%2Fesp-open-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pfalcon%2Fesp-open-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pfalcon%2Fesp-open-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pfalcon","download_url":"https://codeload.github.com/pfalcon/esp-open-sdk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248890802,"owners_count":21178511,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["esp8266","xtensa"],"created_at":"2024-07-31T08:00:38.409Z","updated_at":"2025-04-14T13:48:01.462Z","avatar_url":"https://github.com/pfalcon.png","language":"Makefile","funding_links":[],"categories":["Makefile","อื่นๆ","Tools"],"sub_categories":["Work on SDK"],"readme":"esp-open-sdk\n------------\n\nThis repository provides the integration scripts to build a complete\nstandalone SDK (with toolchain) for software development with the\nEspressif ESP8266 and ESP8266EX chips.\n\nThe complete SDK consists of:\n\n1. Xtensa lx106 architecture toolchain (100% OpenSource), based on\n   following projects:\n    * https://github.com/jcmvbkbc/crosstool-NG\n    * https://github.com/jcmvbkbc/gcc-xtensa\n    * https://github.com/jcmvbkbc/newlib-xtensa\n    * https://github.com/tommie/lx106-hal\n\nThe source code above originates from work done directly by Tensilica Inc.,\nCadence Design Systems, Inc, and/or their contractors.\n\n2. ESP8266 IoT SDK from Espressif Systems. This component is only\n   partially open source, (some libraries are provided as binary blobs).\n    * http://bbs.espressif.com/viewforum.php?f=46\n\nOpenSource components of the SDK are based on:\n* lwIP, http://savannah.nongnu.org/projects/lwip/\n* Contiki, http://www.contiki-os.org/\n* axTLS, http://axtls.sourceforge.net/\n* wpa_supplicant, http://w1.fi/wpa_supplicant/ (source withheld by Espressif)\n* net80211/ieee80211 (FreeBSD WiFi stack),\n  http://www.unix.com/man-page/freebsd/9/NET80211\n  (source withheld by Espressif)\n\n\nRequirements and Dependencies\n=============================\n\nTo build the standalone SDK and toolchain, you need a GNU/POSIX system\n(Linux, BSD, MacOSX, Windows with Cygwin) with the standard GNU development\ntools installed: bash, gcc, binutils, flex, bison, etc.\n\nPlease make sure that the machine you use to build the toolchain has at least\n1G free RAM+swap (or more, which will speed up the build).\n\n## Debian/Ubuntu\n\nUbuntu 14.04:\n```\n$ sudo apt-get install make unrar-free autoconf automake libtool gcc g++ gperf \\\n    flex bison texinfo gawk ncurses-dev libexpat-dev python-dev python python-serial \\\n    sed git unzip bash help2man wget bzip2\n```\n\nLater Debian/Ubuntu versions may require:\n```\n$ sudo apt-get install libtool-bin\n```\n\n## MacOS:\n```bash\n$ brew tap homebrew/dupes\n$ brew install binutils coreutils automake wget gawk libtool help2man gperf gnu-sed --with-default-names grep\n$ export PATH=\"/usr/local/opt/gnu-sed/libexec/gnubin:$PATH\"\n```\n\nIn addition to the development tools MacOS needs a case-sensitive filesystem.\nYou might need to create a virtual disk and build esp-open-sdk on it:\n```bash\n$ sudo hdiutil create ~/Documents/case-sensitive.dmg -volname \"case-sensitive\" -size 10g -fs \"Case-sensitive HFS+\"\n$ sudo hdiutil mount ~/Documents/case-sensitive.dmg\n$ cd /Volumes/case-sensitive\n```\n\nBuilding\n========\n\nBe sure to clone recursively:\n\n```\n$ git clone --recursive https://github.com/pfalcon/esp-open-sdk.git\n```\n\nThe project can be built in two modes:\n\n1. Where the toolchain and tools are kept separate from the vendor IoT SDK\n   which contains binary blobs. This makes licensing more clear, and helps\n   facilitate upgrades to vendor SDK releases.\n\n2. A completely standalone ESP8266 SDK with the vendor SDK files merged\n   into the toolchain. This mode makes it easier to build software (no\n   additinal `-I` and `-L` flags are needed), but redistributability of\n   this build is unclear and upgrades to newer vendor IoT SDK releases are\n   complicated. This mode is default for local builds. Note that if you\n   want to redistribute the binary toolchain built with this mode, you\n   should:\n\n    1. Make it clear to your users that the release is bound to a\n       particular vendor IoT SDK and provide instructions how to upgrade\n       to a newer vendor IoT SDK releases.\n    2. Abide by licensing terms of the vendor IoT SDK.\n\nTo build the self-contained, standalone toolchain+SDK:\n\n```\n$ make STANDALONE=y\n```\n\nThis is the default choice which most people are looking for, so just the\nfollowing is enough:\n\n```\n$ make\n```\n\nTo build the bare Xtensa toolchain and leave ESP8266 SDK separate:\n\n```\n$ make STANDALONE=n\n```\n\nThis will download all necessary components and compile them.\n\nUsing the toolchain\n===================\n\nOnce you complete build process as described above, the toolchain (with\nthe Xtensa HAL library) will be available in the `xtensa-lx106-elf/`\nsubdirectory. Add `xtensa-lx106-elf/bin/` subdirectory to your `PATH`\nenvironment variable to execute `xtensa-lx106-elf-gcc` and other tools.\nAt the end of build process, the exact command to set PATH correctly\nfor your case will be output. You may want to save it, as you'll need\nthe PATH set correctly each time you compile for Xtensa/ESP.\n\nESP8266 SDK will be installed in `sdk/`. If you chose the non-standalone\nSDK, run the compiler with the corresponding include and lib dir flags:\n\n```\n$ xtensa-lx106-elf-gcc -I$(THISDIR)/sdk/include -L$(THISDIR)/sdk/lib\n```\n\nThe extra -I and -L flags are not needed when using the standalone SDK.\n\nSubdirectory `examples/` contains some example application(s) which\ncan be built with esp-open-sdk. If you are interested in real-world,\nfull-fledged, advanced example of a project built using esp-open-sdk,\ncheck https://github.com/micropython/micropython/tree/master/ports/esp8266.\n\nPulling updates\n===============\nThe project is updated from time to time, to get updates and prepare to\nbuild a new SDK, run:\n\n```\n$ make clean\n$ git pull\n$ git submodule sync\n$ git submodule update --init\n```\n\nIf you don't issue `make clean` (which causes toolchain and SDK to be\nrebuilt from scratch on next `make`), you risk getting broken/inconsistent\nresults.\n\nAdditional configuration\n========================\n\nYou can build a statically linked toolchain by uncommenting\n`CT_STATIC_TOOLCHAIN=y` in the file `crosstool-config-overrides`. More\nfine-tunable options may be available in that file and/or Makefile.\n\nLicense\n=======\n\nesp-open-sdk is in its nature merely a makefile, and is in public domain.\nHowever, the toolchain this makefile builds consists of many components,\neach having its own license. You should study and abide them all.\n\nQuick summary: gcc is under GPL, which means that if you're distributing\na toolchain binary you must be ready to provide complete toolchain sources\non the first request.\n\nSince version 1.1.0, vendor SDK comes under modified MIT license. Newlib,\nused as C library comes with variety of BSD-like licenses. libgcc, compiler\nsupport library, comes with a linking exception. All the above means that\nfor applications compiled with this toolchain, there are no specific\nrequirements regarding source availability of the application or toolchain.\n(In other words, you can use it to build closed-source applications).\n(There're however standard attribution requirements - see licences for\ndetails).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpfalcon%2Fesp-open-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpfalcon%2Fesp-open-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpfalcon%2Fesp-open-sdk/lists"}