{"id":31769193,"url":"https://github.com/second-state/echokit_box","last_synced_at":"2025-10-10T02:41:44.248Z","repository":{"id":304801117,"uuid":"1015857468","full_name":"second-state/echokit_box","owner":"second-state","description":"ESP32 firmware for the EchoKit voice device","archived":false,"fork":false,"pushed_at":"2025-09-20T09:54:44.000Z","size":8763,"stargazers_count":64,"open_issues_count":2,"forks_count":67,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-20T11:42:11.102Z","etag":null,"topics":["ai","esp32","rust","voice"],"latest_commit_sha":null,"homepage":"https://echokit.dev/","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/second-state.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"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":"2025-07-08T06:26:42.000Z","updated_at":"2025-09-20T09:54:47.000Z","dependencies_parsed_at":"2025-07-15T19:59:18.489Z","dependency_job_id":"d9da87c3-82a6-45d3-8e08-eef7601a8794","html_url":"https://github.com/second-state/echokit_box","commit_stats":null,"previous_names":["second-state/echokit_box"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/second-state/echokit_box","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/second-state%2Fechokit_box","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/second-state%2Fechokit_box/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/second-state%2Fechokit_box/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/second-state%2Fechokit_box/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/second-state","download_url":"https://codeload.github.com/second-state/echokit_box/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/second-state%2Fechokit_box/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279002541,"owners_count":26083403,"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","status":"online","status_checked_at":"2025-10-10T02:00:06.843Z","response_time":62,"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":["ai","esp32","rust","voice"],"created_at":"2025-10-10T02:41:40.334Z","updated_at":"2025-10-10T02:41:44.243Z","avatar_url":"https://github.com/second-state.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Setup the EchoKit device\n\n## Buttons on the device\n\nThe `RST` button is to restart the system. On the EchoKit devkit, it is labeled as `rst` on the main ESP32 board.\n\nThe `K0` button is the main action button for the application. On the EchoKit devkit, it is the single button to the left of the LCD screen on the extension board.\n\n\u003e The `boot` button on the ESP32 board is the SAME as the `K0` button.\n\n## Quick start\n\nFlash the `echokit.bin` device image using the web-based [ESP Launchpad](https://espressif.github.io/esp-launchpad/?flashConfigURL=https://echokit.dev/firmware/echokit.toml) tool.\n\n## Install espflash\n\nAssume that you [installed the Rust compiler](https://www.rust-lang.org/tools/install) on your computer.\n\n```\ncargo install cargo-espflash espflash ldproxy\n```\n\n## Build the firmware\n\nGet a pre-compiled binary version of the firmware. The firmware binary file is `echokit`.\n\n```\ncurl -L -o echokit https://echokit.dev/firmware/echokit-boards\n```\n\nTo build the `echokit` firmware file from source, you need to make sure that you install the [OS-specific dependencies](https://docs.espressif.com/projects/rust/book/installation/std-requirements.html) and then [ESP toolchain for Rust](https://docs.espressif.com/projects/rust/book/installation/riscv-and-xtensa.html). You can then build from the source and find the binary firmware in `target/xtensa-esp32s3-espidf/release/`.\n\n```\ncargo build --release\n```\n\nOptional: Build the device image.\n\n```\nespflash save-image --chip esp32s3 --merge --flash-size 16mb target/xtensa-esp32s3-espidf/release/echokit echokit.bin\n```\n\n\u003cdetails\u003e\n\u003csummary\u003e Alternative firmware \u003c/summary\u003e\n\nIf you have the fully integrared box device, you can use the following command to download a pre-built binary.\n\n```\ncurl -L -o echokit https://echokit.dev/firmware/echokit-box\n```\n\nTo build it from the Rust source code. \n\n```\ncargo build  --no-default-features --features box\n```\n\n\u003c/details\u003e\n\n## Flash the firmware\n\nConnect to your computer to the EchoKit device USB port labeled `TTL`. Allow the computer to accept connection from the device when prompted. \n\n\u003e On many devices, there are two USB ports, but only the `SLAVE` port can take commands from another computer. You must connect to that `SLAVE` USB port. The detected USB serial port should be `JTAG`. IT CANNOT be `USB Single`.\n\n```\nespflash flash --monitor --flash-size 16mb echokit\n```\n\nThe response is as follows.\n\n```\n[2025-04-28T16:51:43Z INFO ] Detected 2 serial ports\n[2025-04-28T16:51:43Z INFO ] Ports which match a known common dev board are highlighted\n[2025-04-28T16:51:43Z INFO ] Please select a port\n✔ Remember this serial port for future use? · no\n[2025-04-28T16:52:00Z INFO ] Serial port: '/dev/cu.usbmodem2101'\n[2025-04-28T16:52:00Z INFO ] Connecting...\n[2025-04-28T16:52:00Z INFO ] Using flash stub\nChip type:         esp32s3 (revision v0.2)\nCrystal frequency: 40 MHz\nFlash size:        8MB\nFeatures:          WiFi, BLE\n... ...\nI (705) boot: Loaded app from partition at offset 0x10000\nI (705) boot: Disabling RNG early entropy source...\nI (716) cpu_start: Multicore app\n```\n\n\u003e If you have problem with flashing, try press down the `RST` button and, at the same time, press and release the `boot` (or `K0`) button. The device should enter into a special mode and be ready for flashing. \n\n## Reset the device\n\nReset the device (simulate the RST button or power up).\n\n```\nespflash reset\n```\n\nDelete the existing firmware if needed.\n\n```\nespflash erase-flash\n```\n\n## Next steps\n\nYou will need to configure and start up an [EchoKit server](https://github.com/second-state/echokit_server), and then configure your device to connect to the server in order for the EchoKit device to be fully functional.\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsecond-state%2Fechokit_box","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsecond-state%2Fechokit_box","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsecond-state%2Fechokit_box/lists"}