Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/improv-wifi/sdk-ble-js
JavaScript SDK to add Improv Wi-Fi over BLE to your website.
https://github.com/improv-wifi/sdk-ble-js
esp32 esp8266 webbluetooth wifi-provisioning
Last synced: 3 months ago
JSON representation
JavaScript SDK to add Improv Wi-Fi over BLE to your website.
- Host: GitHub
- URL: https://github.com/improv-wifi/sdk-ble-js
- Owner: improv-wifi
- License: apache-2.0
- Created: 2021-05-19T15:33:22.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-15T01:02:59.000Z (over 1 year ago)
- Last Synced: 2024-10-03T13:49:07.475Z (4 months ago)
- Topics: esp32, esp8266, webbluetooth, wifi-provisioning
- Language: TypeScript
- Homepage: https://www.improv-wifi.com
- Size: 758 KB
- Stars: 44
- Watchers: 1
- Forks: 8
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JavaScript SDK for Improv Wi-Fi over BLE
## Installation
You can use the JavaScript SDK by adding the following HTML to your website:
```html
```
If you are using a bundler and JavaScript package manager, you can install the SDK via NPM:
```
npm install --save improv-wifi-sdk
```
And then import it in your code:
```
import 'improv-wifi-sdk';
```
## Usage
Add the following to your website to show a button to start the provisioning process:
```html
```
A warning message will be rendered if the browser does not support WebBluetooth.
### Attributes
The following attributes are automatically added to `` and can be used for styling:
| Attribute | Description |
| -- | -- |
| `supported` | Added if this browser is supported
| `unsupported` | Added if this browser is not supported
### Slots
It is possible to customize the button and the message. You do this by putting your elements inside the `` element and adding the appropriate `slot` attribute. Use `activate` to replace the activation button and `unsupported` to replace the unsupported message:
```html
Start provisioning!
Your browser does not support provisioning.
```
## Events
When the state of provisioning changes, a `state-changed` event is fired.
A `state-changed` event contains the following information:
Field | Description
-- | --
state | The current state (`CONNECTING`, `AUTHORIZATION_REQUIRED`, `AUTHORIZED`, `PROVISIONING`, `PROVISIONED`, `ERROR`, `UNKNOWN`)
## Browser Support
This SDK requires a browser with support for WebBluetooth. Currently this is supported by Google Chrome, Microsoft Edge and other browsers based on the Blink engine.
No iOS devices are supported.