Socket
Socket
Sign inDemoInstall

improv-wifi-sdk

Package Overview
Dependencies
6
Maintainers
2
Versions
18
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

improv-wifi-sdk

Improv Wi-Fi SDK for the browser


Version published
Maintainers
2
Weekly downloads
3
decreased by-66.67%

Weekly downloads

Readme

Source

JavaScript SDK for Improv Wi-Fi over BLE

Installation

You can use the JavaScript SDK by adding the following HTML to your website:

<script type="module" src="https://www.improv-wifi.com/sdk-js/launch-button.js"></script>

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:

<improv-wifi-launch-button></improv-wifi-launch-button>

A warning message will be rendered if the browser does not support WebBluetooth.

Attributes

The following attributes are automatically added to <improv-wifi-launch-button> and can be used for styling:

AttributeDescription
supportedAdded if this browser is supported
unsupportedAdded 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 <improv-wifi-launch-button> element and adding the appropriate slot attribute. Use activate to replace the activation button and unsupported to replace the unsupported message:

<improv-wifi-launch-button>
  <button slot='activate'>Start provisioning!</button>
  <span slot='unsupported'>Your browser does not support provisioning.</span>
</improv-wifi-launch-button>

Events

When the state of provisioning changes, a state-changed event is fired.

A state-changed event contains the following information:

FieldDescription
stateThe 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.

FAQs

Last updated on 16 Jan 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc