{"id":15493393,"url":"https://github.com/jessebraham/d1-mini","last_synced_at":"2025-03-04T07:30:55.834Z","repository":{"id":57615691,"uuid":"288819549","full_name":"jessebraham/d1-mini","owner":"jessebraham","description":"Board Support Package for the WEMOS/LOLIN D1 mini","archived":true,"fork":false,"pushed_at":"2021-09-29T22:23:36.000Z","size":44,"stargazers_count":21,"open_issues_count":2,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-25T12:45:34.670Z","etag":null,"topics":["d1-mini","embedded","esp8266","rust","xtensa"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jessebraham.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE-APACHE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-08-19T19:29:28.000Z","updated_at":"2024-11-22T11:18:26.000Z","dependencies_parsed_at":"2022-09-17T11:01:02.592Z","dependency_job_id":null,"html_url":"https://github.com/jessebraham/d1-mini","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jessebraham%2Fd1-mini","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jessebraham%2Fd1-mini/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jessebraham%2Fd1-mini/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jessebraham%2Fd1-mini/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jessebraham","download_url":"https://codeload.github.com/jessebraham/d1-mini/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241804532,"owners_count":20023042,"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":["d1-mini","embedded","esp8266","rust","xtensa"],"created_at":"2024-10-02T08:06:13.464Z","updated_at":"2025-03-04T07:30:55.323Z","avatar_url":"https://github.com/jessebraham.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# d1-mini\n\n[![Crates.io](https://img.shields.io/crates/v/d1-mini.svg)](https://crates.io/crates/d1-mini)\n[![Docs](https://docs.rs/d1-mini/badge.svg)](https://docs.rs/d1-mini/)\n[![License](https://img.shields.io/badge/License-MIT%20OR%20Apache--2.0-blue)](LICENSE)\n\n\u003e A Board Support Package (BSP) which provides a type-safe API for the [WEMOS/LOLIN D1 mini](https://docs.wemos.cc/en/latest/d1/d1_mini.html).\n\n## [Documentation]\n\n[documentation]: https://docs.rs/d1-mini/\n\n## Resources\n\n- [LOLIN D1 mini official documentation](https://docs.wemos.cc/en/latest/d1/d1_mini.html)\n- [esp8266-hal](https://github.com/esp-rs/esp8266-hal)\n- [esp8266](https://github.com/esp-rs/esp8266)\n- [xtensa-lx-rt](https://github.com/esp-rs/xtensa-lx-rt)\n- [xtensa-lx](https://github.com/esp-rs/xtensa-lx)\n\n## Getting Started\n\n**NOTE:** This crate's dependencies are still in the early stages of development, and various features may be incomplete or missing altogether. With this being pre-`1.0` software, the public API is subject to change at any time.\n\n### Prerequisites\n\nBecause the Xtensa target is not officially supported, you must use a custom fork of Rust. Pre-built artifacts for common operating systems are available via the [esp-rs/rust-build] repository's releases page. Alternatively, you can build the compiler from source; for more information on this process, please refer the the [esp-rs/rust] fork's README, which has detailed instructions for most popular operating systems.\n\nYou will additionally need the appropriate Xtensa toolchain. You can download pre-built binaries from [Espressif], or build them yourself using [esp-open-sdk]. In either case, make sure that the resulting binaries are in your `$PATH`.\n\n[esp-rs/rust]: https://github.com/MabezDev/rust-xtensa\n[esp-rs/rust-build]: https://github.com/MabezDev/rust-build\n[espressif]: https://docs.espressif.com/projects/esp8266-rtos-sdk/en/latest/get-started/index.html#setup-toolchain\n[esp-open-sdk]: https://github.com/pfalcon/esp-open-sdk\n\n### Build the Examples\n\nYou can build all examples at once, or just build one at a time:\n\n```bash\n$ cargo build --release --examples\n$ cargo build --release --example=blinky\n```\n\n### Flash the Device\n\n### espflash\n\n[espflash] is a community developed tool (written entirely in Rust) for flashing _ESP32-_ and _ESP8266-based_ devices. It provides a CLI tool for flashing the aforementioned devices as well as an additional crate, [cargo-espflash], which provides a cargo subcommand which compiles and flashes your device with one command.\n\nFor more information on these tools, please refer to their respective `README`s.\n\n#### Examples\n\nMake sure you replace `\u003cPORT\u003e` with the appropriate value prior to running either of the below commands.\n\nUsing `espflash`:\n\n```bash\n$ espflash \u003cPORT\u003e target/xtensa-esp8266-none/release/examples/blinky\n```\n\nUsing `cargo-espflash`:\n\n```bash\n$ cargo espflash --release --example=blinky \u003cPORT\u003e\n```\n\n[espflash]: https://github.com/esp-rs/espflash\n[cargo-espflash]: https://github.com/esp-rs/espflash/tree/master/cargo-espflash\n\n### esptool\n\nYou can use the official tool from Espressif, [esptool.py], to flash the firmware to your device. Make sure this has been installed and `esptool.py` is available in your `$PATH`.\n\nFirst convert the ELF-formatted binary to a flashable image:\n\n```bash\n$ esptool.py \\\n\u003e   --chip esp8266 \\\n\u003e   elf2image \\\n\u003e   target/xtensa-esp8266-none/release/examples/blinky\n```\n\nThen you're ready to flash the image to the device; make sure you replace `\u003cPORT\u003e` with the appropriate value prior to running the command:\n\n```bash\n$ esptool.py \\\n\u003e   --port \u003cPORT\u003e \\\n\u003e   write_flash \\\n\u003e   -fm dio \\\n\u003e   -fs 32m \\\n\u003e   0x00000 \\\n\u003e   target/xtensa-esp8266-none/release/examples/blinky-0x00000.bin\n```\n\n[esptool.py]: https://github.com/espressif/esptool\n\n## License\n\nLicensed under either of:\n\n- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)\n- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)\n\nat your option.\n\n### Contribution\n\nUnless you explicitly state otherwise, any contribution intentionally submitted for inclusion in\nthe work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without\nany additional terms or conditions.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjessebraham%2Fd1-mini","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjessebraham%2Fd1-mini","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjessebraham%2Fd1-mini/lists"}