diff --git a/docs/howto-compile.md b/docs/howto-compile.md index 0eeb6d8..e016e5f 100644 --- a/docs/howto-compile.md +++ b/docs/howto-compile.md @@ -12,17 +12,27 @@ Arduino IDE version 2.x ([download](https://www.arduino.cc/en/software)) ![board manager](images/esp32-board.png) -2. Install AirGradient library on library manager using the latest version (Tools ➝ Manage Libraries... ➝ search for `"airgradient"`) +2. Install AirGradient library + +#### Version < 3.2.0 + +Using library manager install the latest version (Tools ➝ Manage Libraries... ➝ search for `"airgradient"`) ![Aigradient Library](images/ag-lib.png) +#### Version >= 3.3.0 + +- From your terminal, go to Arduino libraries folder (windows and mac: `Documents/Arduino/libraries` or linux: `~/Arduino/Libraries`). +- With **git** cli, execute this command `git clone --recursive https://github.com/airgradienthq/arduino.git AirGradient_Air_Quality_Sensor` +- Restart Arduino IDE + 3. On tools tab, follow settings below ``` Board ➝ ESP32C3 Dev Module USB CDC On Boot ➝ Enabled CPU Frequency ➝ 160MHz (WiFi) -Core Debug Level ➝ None (or choose as needed) +Core Debug Level ➝ Info Erase All Flash Before Sketch Upload ➝ Enabled (or choose as needed) Flash Frequency ➝ 80MHz Flash Mode ➝ QIO @@ -32,8 +42,6 @@ Partition Scheme ➝ Minimal SPIFFS (1.9MB APP with OTA/190KB SPIFFS) Upload Speed ➝ 921600 ``` -![Compile Settings](images/settings.png) - 4. Open sketch to compile (File ➝ Examples ➝ AirGradient Air Quality Sensor ➝ OneOpenAir). This sketch for AirGradient ONE and Open Air monitor model 5. Compile @@ -87,4 +95,4 @@ Please follow github [contributing to a project](https://docs.github.com/en/get- There are 2 environment options to compile this project, PlatformIO and ArduinoIDE. - For PlatformIO, it should work out of the box -- For arduino, files in `src` folder and also from `Examples` can be modified at `Documents/Arduino/libraries` for windows and mac, and `~/Arduino/Libraries` for linux \ No newline at end of file +- For arduino, files in `src` folder and also from `Examples` can be modified at `Documents/Arduino/libraries` for windows and mac, and `~/Arduino/Libraries` for linux