Skip to content

Latest commit

 

History

History
79 lines (48 loc) · 3.13 KB

GettingStarted.md

File metadata and controls

79 lines (48 loc) · 3.13 KB

Getting Started

The BleepingLibrary is based around the NVS partition in flash, exposing various configuration parameters through a BLE configuration server when in Setup mode.

The configuration characteristics which can be read / written by another BLE device will allow an end-user to provision and configure their device, making connecting to WiFi network easier then ever.

Example Sketches

Each of the following examples will show a different feature of the BleepingLibrary, many applications will use a combination of them all.

BleepingWiFiExample

The BleepingWiFiProvision example sketch will demonstrate:

  • Checking if a device is configured
  • Optionally launching setup mode
  • Loading WiFi credentials from config

On boot the device will check if it needs to be configured and optionally launch setup mode. Once the user has configured and rebooted the device, this example will connect to WiFi and then be ready to serve your application.

BleepingGPIO

The BleepingGPIO example sketch will demonstrate:

  • Manuall starting the BLE setup server
  • Adding a custom service, characteristics, and a callback
  • Controlling a GPIO pin using BLE

BleepingOTAUpdate

The BleepingOTAUpdate example skecth will demonstrate:

  • Check for updates
  • Download and install new firmware

When booted, a configred device will download and install a new firmware image using either the target specified in setup, or the default target.

BleepingFirmwareManager

The BleepingFirmwareManager example sketch will demonstrate:

  • Manually starting the BLE setup server
  • Enabling the Updater service
  • Managing the Firmware using BLE

BleepingCustomConfig

The BleepingCustomConfig example sketch will demonstrate:

  • Manually starting the BLE setup server
  • Adding custom configuration properties to the setup server
  • Accessing custom properties in config
  • Running and application with setup mode in the background

BleepingCustomBLE

The BleepingCustomBLE example sketch will demonstrate:

  • Manually starting the BLE setup server
  • Adding a custom service, characteristics, and a callback
  • Running an application with setup mode in the background

This example will add a custom service and characteristics to the setup server, with a custom callback attached. After starting the BLE setup server, control is returned to the user application.

Configuration

When in configuration mode, the ESP32 will host a BLE server which can be configured from any device also supporting BLE.

Device Control

System parameters have a special callback which allow then to interact with the running device.

UUID Parameter Mode
00000000-0000-beef-001f-320101000000 Device MAC R
00000000-0000-beef-001f-320401000000 Device Uptime R
00000000-0000-beef-001f-32F902000000 Restart Device W
00000000-0000-beef-001f-32FE02000000 Reset Device W