Skip to content

Latest commit

 

History

History
77 lines (45 loc) · 2.38 KB

README.md

File metadata and controls

77 lines (45 loc) · 2.38 KB

Weave Banner

The Ultimate Telematics and Telemetry Library for the ESP32

Weave is a collection of niche telemetry libraries designed to create a sophisticated all-in-one solution for collecting and displaying data in real-time, beautifully. This library is primarily designed for the ESP32 microcontroller but may also be compatible with the ESP8266 microcontroller.

   

Features

Weave includes the following features and functionality:

  • ESPDash
  • ElegantOTA
  • Webserial
  • MQTT
  • AsyncTimer
  • mDNS support
  • ESP-NOW support for all configurations

API

init(const char* ssid, const char* password, wifi_mode_t WIFITYPE, const char* mdnsName);

Initializes Weave.

init takes in the SSID and PASSWORD from the main program. The WIFITYPE is either WIFI_AP, WIFI_STA, or WIFI_AP_STA. The mdnsName is the domain where the dashboard, webserial, and OTA will be accessed from.

If WIFITYPE is WIFI_AP, the SSID and PASSWORD are used to create an AP hosted on the ESP32 with those credentials.

If WIFITYPE is WIFI_STA, the SSID and PASSWORD are used to try and connect to an existing wifi network with those credentials.

if WIFITYPE is WIFI_AP_STA, the ESP32 will use the SSID and PASSWORD to connect to an existing wifi network, exactly how WIFI_STA behaves. A hidden additional network is hosted from the ESP32 with the SSID of mdnsName and the arbitrary password: pinecones

Example:

  • Initializing the ESP32 to connect to your exising network
  const char* SSID = "yourSSID";
  const char* PASS = "yourpass";
  const char* mdns = "weave";
  wv.init(SSID, PASS, WIFI_AP, mdns);
  wv.startwifi();

Examples

  • WeaveOTA - Demonstrate OTA functionality
  • WeaveMQTT - Send a message to an MQTT broker with the ESP32 acting as a client.
  • WeaveWebSerial - Demonstrate WebSerial functionality
  • Weave-NOW - Show how to setup an ESP-NOW mesh
  • WeaveDashboard - ESPDash integration demonstration.

License

This library is licensed under MIT.

Copyright

Copyright 2023 - Adojang

Adriaan van Wijk