Windows - r41d/ClusterDuck-Protocol GitHub Wiki

This page documents the steps to install Arduino IDE on Windows, set up your Dev environment, and prepare to upload the CDP on your electronics. This page will go through:

• Part One: Install Arduino IDE on Windows
• Part Two: Install Libraries and Dependencies
• Part Three: Upload CDP to electronics.

Some helpful links:

• Windows Installation video

Part One: Install Arduino IDE on Windows

1. Download and install the Arduino IDE and make sure to select Windows

2. Install the ESP32 core Library by opening the Arduino IDE menu and go to [File] > [Preferences]. In [Additional Boards Manager URLs] add the following string: https://dl.espressif.com/dl/package_esp32_index.json,https://adafruit.github.io/arduino-board-index/package_adafruit_index.json - if there is already a URL here, add a comma at the end and then add this URL.

3. Next, you will need to load the ESP32 Boards to your Arduino IDE, from Arduino IDE menu, select [Tools] > [Board] > [Boards Manager] and Search for "esp32". You should see the "esp32" by Espressif Systems" library. Install this library.

Part Two: Install Libraries and Dependencies

There are 3 different methods you can use to install libraries and dependencies on your machine. If you have SSH enabled on your GitHub, we recommend method A: Script installation as it will be the fastest and easiest. Method B: Manual Install, or Method C: Zip Install will also work if you prefer either of those.

Method A. Script Installation

If you have SSH set up with your GitHub account you can use the CDP install script to run an install script for the ClusterDuck protocol.

1. Make sure SSH is enabled on your laptop with your GitHub Account, if not instructions to setup here
2. Fork the ClusterDuck Protocol source code (This repository)
3. Copy and run the following command in Git Bash and change it to your github username curl -s https://clusterduckprotocol.org/assets/Wiki_Script/windows.sh | bash -s <YOUR GITHUB USERNAME>

---

B. Manual Install

1. Install Git Bash here

2. Open Git Bash

3. git clone --recursive https://github.com/Call-for-Code/ClusterDuck-Protocol.git

4. Copy the ClusterDuck-Protocolfolder into your local Arduino Libraries folder /Users/USER/Documents/Arduino/libraries.

5. Navigate into the ClusterDuck-Protocol folder and open the Libraries folder

6. Copy all the libraries form the ClusterDuck-Protocol Libraries folder and Paste it into your local Arduino IDE Libraries folder /Users/USER/Documents/Arduino/libraries.

7. Open Arduino IDE

8. You should now be able to see the examples by going to File -> Examples -> ClusterDuck Protocol

You should be able to pull new commits directly to this folder in your Arduino library.

---

C. Zip Install

Go to the following websites and download the Libraries:

• adafruit/Adafruit-BMP085-Library: A powerful but easy to use BMP085/BMP180 Library
• adafruit/Adafruit_BMP280_Library: Arduino Library for BMP280 sensors
• https://arduinojson.org/v6/doc/installation/
• me-no-dev/AsyncTCP: Async TCP Library for ESP32
• adafruit/DHT-sensor-library: Arduino library for DHT11, DHT22, etc Temperature & Humidity Sensors
• https://github.com/ThingPulse/esp8266-oled-ssd1306
• https://github.com/me-no-dev/ESPAsyncWebServer
• https://github.com/FastLED/FastLED
• https://github.com/sandeepmistry/arduino-LoRa
• https://github.com/swatish17/MQ7-Library
• https://github.com/knolleary/pubsubclient
• https://github.com/olikraus/u8g2
• https://github.com/mkarawacki/wavesharesharpdustsensor
• adafruit/Adafruit_Sensor: Common sensor library
• Arduino-timer
• espressif/arduino-esp32: Arduino core for the ESP32
• ESPAscyncWebServer

To add Libraries by zip files. Go to Sketch > include Library > add .zip Library…

Part Three: Upload CDP to electronics.

Now follow these steps to get started inside the Arduino IDE