Skip to content

Latest commit

 

History

History
56 lines (44 loc) · 3.65 KB

README.md

File metadata and controls

56 lines (44 loc) · 3.65 KB
Raw

Cayenne MQTT ESP Library

The Cayenne MQTT ESP Library provides functions to easily connect to the Cayenne IoT project builder. This library is designed to work with ESP8266 and ESP32 WiFi modules. With it you can send data to and receive data from Cayenne.

alt text

Adafruit HUZZAH ESP8266 image by lady ada is licensed under CC BY-SA 3.0

alt text

SparkFun ESP32 Thing image by SparkFun is licensed under CC BY 2.0

Requirements

Hardware

Software

Getting Started

Environment Setup

  1. Download and install the Arduino IDE.
  2. Install the Board Package.
    1. For ESP8266:
      1. Under File -> Preferences add http://arduino.esp8266.com/stable/package_esp8266com_index.json to the Additional Boards Manager URLs field.
      2. Install the esp8266 platform from Tools -> Board -> Boards Manager.
    2. For ESP32, manually install the board package by following the instructions here: https://github.com/espressif/arduino-esp32/blob/master/README.md#installation-instructions.
  3. Download this library as a zip file here.
  4. Install the downloaded zip library from Sketch -> Include Library -> Add .ZIP Library.
  5. Connect your ESP module to your computer using a USB to Serial FTDI or console cable.
  6. Select your ESP module and port from the Tools menu.

Cayenne Setup

  1. Create your Cayenne account at https://www.cayenne-mydevices.com.
  2. Add a new device using the Bring Your Own Thing API selection.

Building Examples

  1. Open the included example sketch from File -> Examples -> Cayenne-MQTT-ESP.
  2. Modify the included sketch with your network info, and the Cayenne authentication info you received when adding your device.
  3. Compile and upload the sketch to your device. Uploading may require setting the device into bootload mode. For the Adafruit HUZZAH ESP8266 module this is done with the folowing steps:
    1. Hold down the GPIO0 button.
    2. Click the Reset button.
    3. Let go of the GPIO0 button.
    4. The red LED should light up, indicating the device is ready for uploading.
    5. Upload your sketch.
  4. Check the Cayenne dashboard to ensure it is receiving sample data from your device.

Compatibility

This library was tested with the Adafruit HUZZAH ESP8266 breakout module and an Espressif ESP32 development board. It should also work with other standard ESP8266 and ESP32 modules that are compatible with the Arduino IDE.

Contributions

Cayenne MQTT Libraries

Additional libraries are available for connecting to Cayenne on other platforms and devices. These can be found at https://github.com/myDevicesIoT.