Skip to content

Commit d732d4d

Browse files
committed
readme and troubleshooting updates
1 parent 3e3c67a commit d732d4d

3 files changed

Lines changed: 91 additions & 5 deletions

File tree

‎README.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,41 @@ Install the library directly from its public GitHub repository:
5252
lib_deps = https://github.com/mattbox03/Find_My_adv_ESP_library.git
5353
```
5454

55+
ESP32, ESP32-C3, and ESP32-S3 can use the stable PlatformIO platform:
56+
57+
```ini
58+
[env:esp32c3]
59+
platform = espressif32@7.0.1
60+
board = esp32-c3-devkitm-1
61+
framework = arduino
62+
lib_deps = https://github.com/mattbox03/Find_My_adv_ESP_library.git
63+
```
64+
65+
ESP32-C6 needs an Arduino-ESP32 3.x platform. This configuration is tested:
66+
67+
```ini
68+
[env:esp32c6]
69+
platform = https://github.com/pioarduino/platform-espressif32/releases/download/55.03.39/platform-espressif32.zip
70+
platform_packages =
71+
framework-arduinoespressif32 @ https://github.com/espressif/arduino-esp32/releases/download/3.3.9/esp32-core-3.3.9.tar.xz
72+
board = esp32-c6-devkitc-1
73+
framework = arduino
74+
lib_deps = https://github.com/mattbox03/Find_My_adv_ESP_library.git
75+
```
76+
77+
On a Windows machine that has already installed Arduino-ESP32 2.x, PlatformIO
78+
may reuse that same-named framework package instead of the C6 override. Build
79+
the C6 environment with an isolated package directory to avoid the collision:
80+
81+
```powershell
82+
$env:PLATFORMIO_PACKAGES_DIR="$PWD\.pio-packages-c6"
83+
pio run -e esp32c6
84+
```
85+
86+
The first isolated build downloads the complete C6 toolchain and can take
87+
several minutes. Later builds reuse `.pio-packages-c6`. See
88+
[`docs/TROUBLESHOOTING.md`](docs/TROUBLESHOOTING.md) for the Bash equivalent.
89+
5590
For a local checkout, copy the complete `FindMyAdv` directory into the
5691
project's `lib` directory:
5792

‎docs/README.it.md‎

Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,39 @@ una radio Bluetooth.
1818

1919
## Installazione
2020

21-
Con PlatformIO, copia l'intera cartella `FindMyAdv` nella cartella `lib` del
22-
progetto. Con Arduino IDE, installa lo ZIP della libreria tramite **Sketch >
23-
Include Library > Add .ZIP Library**.
21+
Con PlatformIO puoi installare direttamente la libreria pubblica:
22+
23+
```ini
24+
lib_deps = https://github.com/mattbox03/Find_My_adv_ESP_library.git
25+
```
26+
27+
ESP32, ESP32-C3 ed ESP32-S3 possono usare `espressif32@7.0.1`. Per ESP32-C6
28+
serve Arduino-ESP32 3.x; questa configurazione è verificata:
29+
30+
```ini
31+
[env:esp32c6]
32+
platform = https://github.com/pioarduino/platform-espressif32/releases/download/55.03.39/platform-espressif32.zip
33+
platform_packages =
34+
framework-arduinoespressif32 @ https://github.com/espressif/arduino-esp32/releases/download/3.3.9/esp32-core-3.3.9.tar.xz
35+
board = esp32-c6-devkitc-1
36+
framework = arduino
37+
lib_deps = https://github.com/mattbox03/Find_My_adv_ESP_library.git
38+
```
39+
40+
Se su Windows è già presente Arduino-ESP32 2.x, PlatformIO può riutilizzare
41+
per errore quel pacchetto omonimo al posto del core C6. Usa una cache isolata:
42+
43+
```powershell
44+
$env:PLATFORMIO_PACKAGES_DIR="$PWD\.pio-packages-c6"
45+
pio run -e esp32c6
46+
```
47+
48+
Il primo avvio scarica l'intera toolchain e può richiedere diversi minuti; le
49+
compilazioni successive riutilizzano `.pio-packages-c6`.
50+
51+
Per un'installazione locale puoi invece copiare l'intera cartella `FindMyAdv`
52+
nella cartella `lib` del progetto. Con Arduino IDE, installa lo ZIP della
53+
libreria tramite **Sketch > Include Library > Add .ZIP Library**.
2454

2555
## Uso minimo
2656

‎docs/TROUBLESHOOTING.md‎

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,27 @@ This cannot be solved transparently by two independent libraries.
4444
## C6/H2 does not compile
4545

4646
Use an Arduino-ESP32 3.x platform that includes NimBLE for the selected target.
47-
The standalone Find_My_Web project pins a known C6-compatible pioarduino
48-
platform as a reproducible reference.
47+
The repository's `ci/platformio.ini` pins a tested C6-compatible pioarduino
48+
platform and Arduino-ESP32 core.
4949

50+
PlatformIO stores packages by canonical name. If Arduino-ESP32 2.x is already
51+
installed, it may be selected instead of a same-named 3.x override and cause an
52+
early framework error such as `FRAMEWORK_DIR None`. Isolate the C6 packages
53+
from the global cache:
54+
55+
PowerShell:
56+
57+
```powershell
58+
$env:PLATFORMIO_PACKAGES_DIR="$PWD\.pio-packages-c6"
59+
pio run -e esp32c6
60+
```
61+
62+
Bash:
63+
64+
```bash
65+
PLATFORMIO_PACKAGES_DIR="$PWD/.pio-packages-c6" pio run -e esp32c6
66+
```
67+
68+
Keep the `platform` and `platform_packages` values shown in the main README.
69+
The first build downloads the complete framework and RISC-V toolchain; later
70+
builds reuse the isolated directory.

0 commit comments

Comments
 (0)