ble-wifi-setup-manager (community library)

Summary

Name	Value
Name	ble-wifi-setup-manager
Version	1.0.0
Installs
License	MIT
Author	Dan Kouba dan.kouba@particle.io
Maintainer	Dan Kouba dan.kouba@particle.io
URL	https://github.com/Dan-Kouba/ble_wifi_setup_manager
Repository	Dan-Kouba/ble_wifi_setup_manager
Download	.tar.gz
All Versions	1.0.0, 0.2.0

Particle Argon & P2 WiFi provisioning via BLE Enables Particle Argon & P2 WiFi provisioning via BLE, specifically for use with the Chrome Web Bluetooth framework

Example Build Testing

Device OS Version:

This table is generated from an automated build. Success only indicates that the code compiled successfully.

Library Read Me

This content is provided by the library maintainer and has not been validated or approved.

BLE WiFi Setup Manager Library

About

This library enables a user of a Particle Argon or P2 device to provision WiFi credentials over BLE, including the following functionality:

Exposes and advertises a custom BLE service for WiFi provisioning
Provides a simple JSON-based communication interface
Enables scanning for nearby WiFi networks
Enables a user to provision of one of the found networks
Provides an optional callback function for user code to handle a provisioning event (eg. restart WiFi, connect to the cloud, etc.)

Future functionality may include:

[ ] Clear, get, and set WiFi credentials on the device
[ ] Expose ability to turn library on and off in user code (currently it runs all the time)
[x] Add callbacks for successful configuration of credentials
[x] Support for P2 module

Use

Add this library to your project (Name: `ble-wifi-setup-manager)
Implement the provided example code

A functional example webpage that can be used for BLE setup, using the Chrome Web Bluetooth standard, can be found here. This code is easy to implement into your own webpage and white-labelled for customer use.

Please note: the web example only works on Chrome running on a desktop OS (Windows/OSX/Linux), or on Android devices. iOS does not natively support the Web Bluetooth standard (yet), however, there does exist at least one paid app that exposes the functionality required.

API

BLE Services and Characteristcs

The firmware exposes a custom service, which has two characteristics for communication channels. Characteristics are named from the device's perspective, meaning the device sends on tx, and receives on rx.

Description	UUID
Service	`b4ad5b8d-d2db-44d6-9d35-5d43b9e5060c`
Characteristic: `tx`	`3c673f3a-382a-4835-8433-c1c1b6b65346`
Characteristic: `rx`	`226285d5-7a5a-448d-8317-dae1fd2d6c36`

Messages

All messages are in JSON format. They start with a value msg_t that informs either side what kind of message is being sent.

`msg_t`	Direction	Description	Example
`scan_resp`	Response from device (`rx`)	Contains details about one WiFi access point that has been found during a scan	`{"msg_t":"scan_resp", "ssid":"MySSID", "sec":"WPA2", "ch":11, "rssi":-53}`
`scan`	Send to device (`tx`)	Initiates WiFi scan on the device	`{"msg_type":"scan"}`
`set_creds`	Send to device (`tx`)	Provisions credentials for a given WiFi access point	`{"msg_type":"set_creds","ssid":"MySSID","password":"MyPassword"}`