Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
brentru authored Jul 11, 2023
1 parent c6983b1 commit f5ac523
Showing 1 changed file with 22 additions and 30 deletions.
52 changes: 22 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
# Adafruit IO - WipperSnapper Beta ![Build CI](https://github.com/adafruit/Adafruit_Wippersnapper_Arduino/actions/workflows/build-clang-doxy.yml/badge.svg)[![Documentation](https://github.com/adafruit/ci-arduino/blob/master/assets/doxygen_badge.svg)](http://adafruit.github.io/Adafruit_Wippersnapper_Arduino/html/index.html)
<p align="center">
<img src="https://i.imgur.com/EsMTDH1.png" />
</p>

# Adafruit WipperSnapper
![Build CI](https://github.com/adafruit/Adafruit_Wippersnapper_Arduino/actions/workflows/build-clang-doxy.yml/badge.svg)[![Documentation](https://github.com/adafruit/ci-arduino/blob/master/assets/doxygen_badge.svg)](http://adafruit.github.io/Adafruit_Wippersnapper_Arduino/html/index.html)

Adafruit.io allows you to monitor, interact with, and share your project's data in minutes.
Adafruit.io WipperSnapper is a firmware designed to turn any Wi-Fi capable board into an Internet-of-Things (IoT) device. No code required!

Adafruit.io WipperSnapper is the firmware designed to turn any Wi-Fi capable board into an Internet-of-Things (IoT) device. No code required!

WipperSnapper works with multiple microcontroller architectures such as ESP8266, ESP32, ESP32-S2, ESP32-C3, and ATSAMD51.
WipperSnapper works with multiple microcontroller architectures such as ESP8266, ESP32, ESP32-S2, ESP32-C3, RP2040, and ATSAMD51.

You will need a **free** [Adafruit IO](https://io.adafruit.com) account to use WipperSnapper.

**This software is in beta** and is actively being developed. Please report bugs via the [Adafruit IO Support Page](https://io.adafruit.com/support).
**NOTE: WipperSnapper firmware is in beta** and is actively being developed. Please [report bugs via the issues page on this repository](https://github.com/adafruit/Adafruit_Wippersnapper_Arduino/issues/new?assignees=&labels=&projects=&template=bug_report.md&title=).

# Get Started
[Learn how to install and use WipperSnapper by following this guide on the Adafruit Learning System - QuickStart: Adafruit IO WipperSnapper](https://learn.adafruit.com/quickstart-adafruit-io-wippersnapper).
Expand All @@ -18,34 +20,24 @@ You will need a **free** [Adafruit IO](https://io.adafruit.com) account to use W
## Get WipperSnapper
Pre-compiled binaries and UF2 files for supported hardware are provided on the [releases page](https://github.com/adafruit/Adafruit_Wippersnapper_Arduino/releases) of this repository.

## Supported Hardware
The following microcontrollers are supported by Adafruit WipperSnapper:
* Espressif ESP8266
* Espressif ESP32
* Espressif ESP32-S2
* Espressif ESP32-S3
* Espressif ESP32-C3
* Raspberry Pi RP2040
* Microchip ATSAMD51 + [AirLift WiFi Co-Processor](https://www.adafruit.com/?q=airlift+wifi&sort=BestMatch)
## Supported Platforms

|Platform| MCU(s) |
|--|--|
|[ESP32](https://github.com/espressif/arduino-esp32)| ESP32, ESP32-S2, ESP32-S3, ESP32-C3 |
|[ESP8266](https://github.com/esp8266/Arduino)| ESP8266 |
|[RP2040](https://github.com/earlephilhower/arduino-pico)| RP2040 MCU w/WiFi (i.e: Pico W) |
|[ATSAMD](https://github.com/adafruit/ArduinoCore-samd/)| SAMD51 MCU w/separate WiFi Co-Processor (i.e: Adafruit "AirLift")|

## Contributing to Adafruit.io and WipperSnapper

If you have a sensor, input, or output you'd like to add Adafruit IO support for it - [we have a guide for contributing a new sensor to Adafruit.io and WipperSnapper here](https://learn.adafruit.com/how-to-add-a-new-component-to-adafruit-io-wippersnapper).

If you have a WiFi-enabled development board with a compatible microcontroller (see: "Supported Hardware" section above) and would like to add Adafruit IO support for it - [we have a guide for adding a new board to Adafruit.io and WipperSnapper here](https://learn.adafruit.com/how-to-add-a-new-board-to-wippersnapper).

## Building WipperSnapper with Arduino
If you would like to build and develop WipperSnapper locally, [we suggest following the steps presented on the guide on this page](https://learn.adafruit.com/how-to-add-a-new-board-to-wippersnapper/build-wippersnapper).

## (BETA) Building WipperSnapper with PlatformIO
We support building and locally testing WipperSnapper with the Platform IO IDE for Visual Studio Code. These instructions are subject to modification.

### Platform IO Build Instructions
* Download and install [Microsoft Visual Studio Code](https://code.visualstudio.com), PlatformIO IDE is built on top of it
* Follow the instructions on [platformio's website to install the Platform IO IDE extension](https://platformio.org/install/ide?install=vscode).
* [Make a local clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) of the [Adafruit WipperSnapper Arduino repository](https://github.com/adafruit/Adafruit_Wippersnapper_Arduino) on your computer.
* In `platformio.ini` file in the root of this repository, find the board you'd like to build WipperSnapper for. Change its `upload_port` and `monitor_port` to match your system.
* The `platformio.ini` file in the root of this repository includes multiple environments to build WipperSnapper for different boards. In the [Platform IO toolbar](https://docs.platformio.org/en/stable//integration/ide/vscode.html#platformio-toolbar), use the Project environment switcher to switch to the board you'd like to upload to.
* Open the `examples/Wippersnapper_demo/Wippersnapper_demo.ino` file.
* On the [Platform IO toolbar](https://docs.platformio.org/en/stable//integration/ide/vscode.html#platformio-toolbar), click the build (checkmark) button. If there are no build errors, click the upload (right arrow) button.
* WipperSnapper should be uploaded to your board. You may use the PlatformIO Serial Monitor to view WipperSnapper's debug output.
## Building WipperSnapper

There are two options for building WipperSnapper locally:

- (Preferred) Build WipperSnapper with PlatformIO
- Build WipperSnapper with Arduino

0 comments on commit f5ac523

Please sign in to comment.