Git Product home page Git Product logo

blueretroroot's Introduction

BlueRetroRoot

Root repository to sync esp-idf and BlueRetro version

See BlueRetro repo for main projet infomation.

Development instructions

Instructions for Ubuntu 20.04+
Instructions for macOS 13+
Instructions for Windows 10+

These instructions likely mostly apply for older version and/or different distribution as well. But they are not tested, so YMMV and you're on your own.

BlueRetro development on Ubuntu 20.04+

1 - Initial setup

1.1 - Install ESP-IDF Prerequisites

  1. Open a Terminal (like gnome-terminal or konsole).
  2. Do the following command:
    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

1.2 - BlueRetro code checkout

  1. Open a Terminal (like gnome-terminal or konsole).
  2. Do the following commands:
    cd ~
    git clone https://github.com/darthcloud/BlueRetroRoot.git
    cd ~/BlueRetroRoot/
    git submodule update --init --recursive
    export IDF_TOOLS_PATH=$(pwd)
    cd esp-idf
    ./install.sh

2 - Compiling BlueRetro firmware

  1. Open a Terminal (like gnome-terminal or konsole).
  2. Do the following commands:
    cd ~/BlueRetroRoot/
    . ./blueretro_dev.sh
    cd BlueRetro
    # Replace configs/hw1/universal by any other config you may wish
    cp configs/hw1/universal sdkconfig
    idf.py build
    # Replace serial device with your own
    idf.py -p /dev/ttyUSB0 flash
    idf.py -p /dev/ttyUSB0 monitor

ESP32 embedded development tips

Dump spiffs

esptool.py --chip esp32 read_flash 0x310000 0xF0000 spiffs.bin
mkspiffs.exe -u spiffs_unpack -b 4096 -p 256 -s 0xF0000 .\spiffs.bin

Delete spiffs

esptool.py erase_region 0x310000 0xF0000

QEMU

(cd build; esptool.py --chip esp32 merge_bin --fill-flash-size 4MB -o flash_image.bin @flash_args)
qemu-system-xtensa -machine esp32 -drive file=build/flash_image.bin,if=mtd,format=raw -serial tcp::5555,server,nowait -display none -daemonize

Running GitHub action offline

Using github.com/nektos/act

Checkout main repo separately, then:

act -W .github/workflows/quick.yml --input hw_version=hw1 --input br_config=universal --artifact-server-path /tmp

blueretroroot's People

Contributors

darthcloud avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.