{"id":16237780,"url":"https://github.com/darthcloud/blueretroroot","last_synced_at":"2025-04-08T08:47:09.277Z","repository":{"id":49325242,"uuid":"265333112","full_name":"darthcloud/BlueRetroRoot","owner":"darthcloud","description":"Root repository to sync esp-idf and BlueRetro version","archived":false,"fork":false,"pushed_at":"2024-02-22T14:51:15.000Z","size":428,"stargazers_count":7,"open_issues_count":0,"forks_count":9,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-04-13T16:40:29.096Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://github.com/darthcloud/BlueRetro","language":"Dockerfile","has_issues":false,"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/darthcloud.png","metadata":{"files":{"readme":"README","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":["darthcloud"],"patreon":"darthcloud","open_collective":null,"ko_fi":"darthcloud","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2020-05-19T18:40:59.000Z","updated_at":"2024-04-06T11:11:58.000Z","dependencies_parsed_at":"2024-02-28T00:48:02.179Z","dependency_job_id":null,"html_url":"https://github.com/darthcloud/BlueRetroRoot","commit_stats":{"total_commits":75,"total_committers":1,"mean_commits":75.0,"dds":0.0,"last_synced_commit":"e7699dc5158cfc713f5f5b80a799d4dfba3cf811"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/darthcloud%2FBlueRetroRoot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/darthcloud%2FBlueRetroRoot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/darthcloud%2FBlueRetroRoot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/darthcloud%2FBlueRetroRoot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/darthcloud","download_url":"https://codeload.github.com/darthcloud/BlueRetroRoot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247808913,"owners_count":20999802,"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":[],"created_at":"2024-10-10T13:36:56.898Z","updated_at":"2025-04-08T08:47:09.253Z","avatar_url":"https://github.com/darthcloud.png","language":"Dockerfile","funding_links":["https://github.com/sponsors/darthcloud","https://patreon.com/darthcloud","https://ko-fi.com/darthcloud"],"categories":[],"sub_categories":[],"readme":"# BlueRetroRoot\nRoot repository to sync esp-idf and BlueRetro version\n\nSee [BlueRetro repo](https://github.com/darthcloud/BlueRetro) for main projet infomation.\n\n# Development instructions\n\n[Instructions for Ubuntu 20.04+](#blueretro-development-on-ubuntu-2004)\\\n[Instructions for macOS 13+](README.macos)\\\n[Instructions for Windows 10+](README.windows)\n\nThese instructions likely mostly apply for older version and/or different distribution as well.\nBut they are not tested, so YMMV and you're on your own.\n\n# BlueRetro development on Ubuntu 20.04+\n\n## 1 - Initial setup\n\n### 1.1 - Install ESP-IDF Prerequisites\n1. Open a Terminal (like gnome-terminal or konsole).\n2. Do the following command:\n   ```bash\n   sudo apt-get install git wget flex bison gperf python3 python3-pip python3-venv cmake ninja-build ccache libffi-dev libssl-dev dfu-util libusb-1.0-0\n   ```\n\n### 1.2 - BlueRetro code checkout\n1. Open a Terminal (like gnome-terminal or konsole).\n3. Do the following commands:\n   ```bash\n   cd ~\n   git clone https://github.com/darthcloud/BlueRetroRoot.git\n   cd ~/BlueRetroRoot/\n   git submodule update --init --recursive\n   export IDF_TOOLS_PATH=$(pwd)\n   cd esp-idf\n   ./install.sh\n   ```\n\n##  2 - Compiling BlueRetro firmware\n1. Open a Terminal (like gnome-terminal or konsole).\n3. Do the following commands:\n   ```bash\n   cd ~/BlueRetroRoot/\n   . ./blueretro_dev.sh\n   cd BlueRetro\n   # Replace configs/hw1/universal by any other config you may wish\n   cp configs/hw1/universal sdkconfig\n   idf.py build\n   # Replace serial device with your own\n   idf.py -p /dev/ttyUSB0 flash\n   idf.py -p /dev/ttyUSB0 monitor\n   ```\n\n# ESP32 embedded development tips\n\n## Dump spiffs\n```bash\nesptool.py --chip esp32 read_flash 0x310000 0xF0000 spiffs.bin\nmkspiffs.exe -u spiffs_unpack -b 4096 -p 256 -s 0xF0000 .\\spiffs.bin\n```\n\n## Delete spiffs\n```bash\nesptool.py erase_region 0x310000 0xF0000\n```\n\n## QEMU\n```bash\n(cd build; esptool.py --chip esp32 merge_bin --fill-flash-size 4MB -o flash_image.bin @flash_args)\n```\n```bash\nqemu-system-xtensa -machine esp32 -drive file=build/flash_image.bin,if=mtd,format=raw -serial tcp::5555,server,nowait -display none -daemonize\n```\n\n## Running GitHub action offline\n\nUsing [github.com/nektos/act](https://github.com/nektos/act)\n\nCheckout main repo separately, then:\n```bash\nact -W .github/workflows/quick.yml --input hw_version=hw1 --input br_config=universal --artifact-server-path /tmp\n```\n\n\u003c!-- vim: set syntax=Markdown: --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdarthcloud%2Fblueretroroot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdarthcloud%2Fblueretroroot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdarthcloud%2Fblueretroroot/lists"}