Skip to content

fix(UI): Fix breaking changes and lock textual version #214

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,20 +22,21 @@ For more information and troubleshooting, please refer to the [UI README](tools/

To use it, follow these steps:

1. Make sure you have the required dependencies installed:
1. Make sure you have the following prerequisites:
- Python 3.9 or later
- The [Textual](https://github.com/textualize/textual/) library
- All the dependencies listed in the previous section

2. Execute the script `tools/config_editor/app.py` from any folder. It will automatically detect the path to the root of the repository.
2. Install the required UI packages using `pip install -r tools/config_editor/requirements.txt`.

3. Configure the compilation and ESP-IDF options as desired.
3. Execute the script `tools/config_editor/app.py` from any folder. It will automatically detect the path to the root of the repository.

4. Click on the "Compile Static Libraries" button to start the compilation process.
4. Configure the compilation and ESP-IDF options as desired.

5. The script will show the compilation output in a new screen. Note that the compilation process can take many hours, depending on the number of libraries selected and the options chosen.
5. Click on the "Compile Static Libraries" button to start the compilation process.

6. If the compilation is successful and the option to copy the libraries to the Arduino Core folder is enabled, it will already be available for use in the Arduino IDE. Otherwise, you can find the compiled libraries in the `esp32-arduino-libs` folder alongside this repository.
6. The script will show the compilation output in a new screen. Note that the compilation process can take many hours, depending on the number of libraries selected and the options chosen.

7. If the compilation is successful and the option to copy the libraries to the Arduino Core folder is enabled, it will already be available for use in the Arduino IDE. Otherwise, you can find the compiled libraries in the `esp32-arduino-libs` folder alongside this repository.
- Note that the copy operation doesn't currently support the core downloaded from the Arduino IDE Boards Manager, only the manual installation from the [`arduino-esp32`](https://github.com/espressif/arduino-esp32) repository.

### Documentation
Expand Down
2 changes: 1 addition & 1 deletion tools/config_editor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ It has mouse support and can be pre-configured using command line arguments.

## Requirements
- Python 3.9 or later
- The "textual" library (install it using `pip install textual`)
- Install the required packages using `pip install -r requirements.txt`
- The requirements from esp32-arduino-lib-builder

## Troubleshooting
Expand Down
8 changes: 4 additions & 4 deletions tools/config_editor/app.py
Original file line number Diff line number Diff line change
Expand Up @@ -112,10 +112,10 @@ class ConfigEditorApp(App):
ENABLE_COMMAND_PALETTE = False
CSS_PATH = "style.tcss"
SCREENS = {
"main": MainScreen(),
"settings": SettingsScreen(),
"compile": CompileScreen(),
"editor": EditorScreen(),
"main": MainScreen,
"settings": SettingsScreen,
"compile": CompileScreen,
"editor": EditorScreen,
}

def on_mount(self) -> None:
Expand Down
1 change: 1 addition & 0 deletions tools/config_editor/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
textual==0.79.0