Skip to content

Commit 20af134

Browse files
authored
fix(UI): Fix breaking changes and lock textual version (espressif#214)
1 parent f488f41 commit 20af134

File tree

4 files changed

+14
-12
lines changed

4 files changed

+14
-12
lines changed

README.md

+8-7
Original file line numberDiff line numberDiff line change
@@ -22,20 +22,21 @@ For more information and troubleshooting, please refer to the [UI README](tools/
2222

2323
To use it, follow these steps:
2424

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

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

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

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

36-
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.
35+
5. Click on the "Compile Static Libraries" button to start the compilation process.
3736

38-
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.
37+
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.
38+
39+
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.
3940
- 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.
4041

4142
### Documentation

tools/config_editor/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ It has mouse support and can be pre-configured using command line arguments.
66

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

1212
## Troubleshooting

tools/config_editor/app.py

+4-4
Original file line numberDiff line numberDiff line change
@@ -112,10 +112,10 @@ class ConfigEditorApp(App):
112112
ENABLE_COMMAND_PALETTE = False
113113
CSS_PATH = "style.tcss"
114114
SCREENS = {
115-
"main": MainScreen(),
116-
"settings": SettingsScreen(),
117-
"compile": CompileScreen(),
118-
"editor": EditorScreen(),
115+
"main": MainScreen,
116+
"settings": SettingsScreen,
117+
"compile": CompileScreen,
118+
"editor": EditorScreen,
119119
}
120120

121121
def on_mount(self) -> None:

tools/config_editor/requirements.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
textual==0.79.0

0 commit comments

Comments
 (0)