Skip to content

Latest commit

 

History

History

README.md

WiBLE Examples

This directory contains a comprehensive set of examples demonstrating how to use the WiBLE library.

🔰 Starting Point

Example Description Recommended For
SimplestProvisioning The absolute minimum - just 20 lines! First-time users! Quick testing and learning.
BasicProvisioning A complete, production-ready template with logging, CLI, and error handling. Production apps! Use this as the base for your commercial product.

🚀 Advanced Features

Example Description Key Features
AdvancedProvisioning Demonstrates specific advanced APIs. Security (PIN), Custom Data, Callbacks.
DeepSleep Power management patterns. State persistence, Deep Sleep integration.
WebClient Browser-based provisioning. Web Bluetooth API (includes index.html).

🔌 Connection Methods

Example Description Method
BLE_Client Connect to other BLE devices. GATT Client
Status_Broadcaster Broadcast data without connection. Advertising (Beacon/Custom)
GatewayMode Scan for devices while being provisionable. Server + Client (Scanner)
BeaconMode Act as an iBeacon. iBeacon
Mesh_Node Simulates Mesh network provisioning. Custom Data Provisioning

☁️ Cloud & IoT

Example Description Integration
SensorDashboard Bidirectional data: 4 sensors → app, 2 LEDs ← app. Custom Protocol (see PROTOCOL.md)
MQTT_Client Full IoT flow: Provision -> WiFi -> MQTT. PubSubClient
AWS_IoT Secure Cloud connectivity. AWS IoT Core, Certificates
OTA_Update Wireless Firmware Update. Update library

💡 Which one should I choose?

  1. Just Learning? Start with SimplestProvisioning.ino (20 lines!).
  2. Building a Product? Copy BasicProvisioning.ino (production template).
  3. Need High Security? Check AdvancedProvisioning for PIN pairing and AWS_IoT for certs.
  4. Battery Powered? Study DeepSleep.
  5. No Mobile App? Use WebClient.