diff --git a/docs/howto-compile.md b/docs/howto-compile.md index beef811..5415739 100644 --- a/docs/howto-compile.md +++ b/docs/howto-compile.md @@ -2,15 +2,15 @@ ## Prequisite -Arduino IDE version 2.x +Arduino IDE version 2.x ([download](https://www.arduino.cc/en/software)) ## Steps for ESP32C3 based board (ONE and Open Air Model) -1. Install esp32 board on board manager with version **2.0.17** +1. Install "esp32 by Espressif Systems" in board manager with version **2.0.17** (Tools ➝ Board ➝ Boards Manager ➝ search for `"espressif"`) ![board manager](images/esp32-board.png) -2. Install AirGradient library on library manager using the latest version (at the time of writing, its 3.2.0) +2. Install AirGradient library on library manager using the latest version (Tools ➝ Manage Libraries... ➝ search for `"airgradient"`) ![Aigradient Library](images/ag-lib.png) @@ -24,7 +24,7 @@ Core Debug Level ➝ None (or choose as needed) Erase All Flash Before Sketch Upload ➝ Enabled (or choose as needed) Flash Frequency ➝ 80MHz Flash Mode ➝ QIO -Flash Size ➝ 4MB +Flash Size ➝ 4MB (32Mb) JTAG Adapter ➝ Disabled Partition Scheme ➝ Minimal SPIFFS (1.9MB APP with OTA/190KB SPIFFS) Upload Speed ➝ 921600 @@ -32,17 +32,29 @@ Upload Speed ➝ 921600 ![Compile Settings](images/settings.png) -4. Compile +4. Open sketch to compile (File ➝ Examples ➝ AirGradient Air Quality Sensor ➝ OneOpenAir). This sketch for AirGradient ONE and Open Air monitor model +5. Compile + +![compiled esp32](images/compiled.png) ## Steps for ESP8266 based board (DIY model) -1. Add esp8266 board by adding http://arduino.esp8266.com/stable/package_esp8266com_index.json into Additional Board Manager URLs field. -2. Install esp8266 board on board manage with version **3.1.2** +1. Add esp8266 board by adding http://arduino.esp8266.com/stable/package_esp8266com_index.json into Additional Board Manager URLs field (File ➝ Preferences ➝ Additional boards manager URLs) + +![additional-board](images/additional-board.png) + +2. Install esp8266 board on board manager with version **3.1.2** (Tools ➝ Board ➝ Boards Manager ➝ search for `"esp8266"`) ![board manager](images/esp8266-board.png) -3. Set board to `LOLIN(WEMOS) D1 R2 & mini`, let other settings to default -4. Compile +3. On tools tab, set board to `LOLIN(WEMOS) D1 R2 & mini`, and let other settings to default + +![settings esp8266](images/settings-esp8266.png) + +4. Open sketch to compile (File ➝ Examples ➝ AirGradient Air Quality Sensor ➝ ``). Depends on the DIY model, either `BASIC`, `DiyProIndoorV3_3` and `DiyProIndoorV4_2` +5. Compile + +![compiled esp8266](images/compiled-esp8266.png) ## Possible Issues diff --git a/docs/images/additional-board.png b/docs/images/additional-board.png new file mode 100644 index 0000000..a7c7803 Binary files /dev/null and b/docs/images/additional-board.png differ diff --git a/docs/images/compiled-esp8266.png b/docs/images/compiled-esp8266.png new file mode 100644 index 0000000..2ad6afd Binary files /dev/null and b/docs/images/compiled-esp8266.png differ diff --git a/docs/images/compiled.png b/docs/images/compiled.png new file mode 100644 index 0000000..9fed0b8 Binary files /dev/null and b/docs/images/compiled.png differ diff --git a/docs/images/settings-esp8266.png b/docs/images/settings-esp8266.png new file mode 100644 index 0000000..37989b6 Binary files /dev/null and b/docs/images/settings-esp8266.png differ