Get Information from Captive Portal

Moddable SDK 9.5.0

About

Binary Data

Overview

Convert String to ArrayBuffer

Convert ArrayBuffer to String

Convert ArrayBuffers to String

Handle Errors Converting ArrayBuffer to String

Immutable ArrayBuffers

Resize an ArrayBuffer

Combine ArrayBuffers

Convert Base64 to Binary Data

Convert Binary Data to Base64

Convert Binary Data to Hex

Convert Hex to Binary Data

Calculate CRC for Binary Data

Compress Binary Data – One Buffer

Compress Binary Data – Streaming

Decompress Binary Data – One Buffer

Decompress Binary Data – Streaming

Captive Portal

Overview

Create Captive Portal

Close Captive Portal

Provide Web Pages for Captive Portal

Get Information from Captive Portal

DNS

Overview

Resolve Name

Resolve Multiple Names

DNS Service Discovery

Overview

Claim Local Name

Advertise Services

Discover Services

EventSource

Overview

Connect

Connect Securely

Close

Receive

Connection Information

Files

Overview

Create, Open, and Close File

Read File

Write File

Delete File

Get File Information

Create Directory

Enumerate Directory

Delete Directory

Open Directory

HTTP

Overview

Make Request using fetch()

Make Secure Request using fetch()

Send Request Headers using fetch()

Receive Response Headers using fetch()

Send Request Body using fetch()

Make Request using HTTP Client

Make Secure Request using HTTP Client

Send Request Headers using HTTP Client

Receive Response Headers using HTTP Client

Send Request Body using HTTP Client

HTTP Server

Overview

Create Server

Route Request

Respond to Request

Respond to Request with File

Receive Request Body

Receive Request Body to File

Implementing ECMA-419 Modules

Overview

Constructor Sets target

Constructor IO

Constructor Clean-up on Failure

close() and [Symbol.dispose]

Calling Callbacks

Setting Options with configure()

Keep Instance Surface Clean

Key-Value Storage

Overview

Read and Write Values using Web Storage

Delete Keys using Web Storage

Enumerate Keys using Web Storage

Read and Write Values using Key-Value Pair

Change Data Formats using Key-Value Pair

Delete Keys using Key-Value Pair

Enumerate Keys using Key-Value Pair

Logging

Overview

Logging with Console

Logging with trace()

MQTT

Overview

Connect to MQTT Server using MQTT()

Connect Securely to MQTT Server using MQTT()

Close Connection using MQTT()

Publish Message using MQTT()

Subscribe to Topic using MQTT()

Receive Messages using MQTT()

Get Connection Information using MQTT()

Connect to MQTT Server using MQTT Client

Connect Securely to MQTT Server using MQTT Client

Close Connection using MQTT Client

Publish Message using MQTT Client

Subscribe to Topic using MQTT Client

Receive Messages using MQTT Client

Optimizing Embedded JavaScript

Overview

When to Optimize

Know Where to Optimize

Loop through an Array

Iterate Over a String

Build a String

Avoid Copying Buffers

Accessing Properties

Map versus Object

Append to an Array

Operate on Bits

Define Class Methods

Streams

Overview

Time

Overview

Get Unix Time

Get Time of Day

Get Date

Get Time Since System Start

Get Microseconds

Set System Date and Time

How Time and Timezone are Initialized

Get Time and Date from Real-Time Clock

Set Real-Time Clock Time

Get Time and Date from Network

Sleep

Time Callbacks

Overview

One-Time Callback

Repeating Callback

Repeating Callback with Initial Delay

Immediate Callback

Reschedule Callback

Cancel Callback

Suspend Callback

Transport Layer Security (TLS)

Overview

Include Public Certificates

Include Private Certificates

Diagnostics

DER and PEM Certificates

WebSocket

Overview

Connect to Server using WebSocket()

Connect Securely to Server using WebSocket()

Close Connection using WebSocket()

Send Message using WebSocket()

Receive Message using WebSocket()

Get Connection Information using WebSocket()

Connect to Server using WebSocket Client

Connect Securely to Server using WebSocket Client

Close Connection using WebSocket Client

Send Message using WebSocket Client

Receive Message using WebSocket Client

Control Messages using WebSocket Client

Connect to Server using WebSocketStream

Connect Securely to Server using WebSocketStream

Close Connection using WebSocketStream

Send Message using WebSocketStream

Receive Message using WebSocketStream

WebSocket Server

Overview

Create WebSocket Server Endpoint

Accept WebSocket Request

Wi-Fi

Overview

Scan for Access Points

Scan Continuously for Access Points

Connect

Reconnect Automatically

Disconnect

Get Connection Information

Use Static IP Address

Wi-Fi Access Point

Overview

Create Access Point

Close Access Point

Get Information

Manage Stations

DNS Redirect

Provide HTTP Server

Get Information from Captive Portal

The captive portal reports configuration values to the onInfo() callback. The primary use of this is to provide the Wi-Fi credentials the user selected during provisioning. It can also provide other configuration such as the time settings or preferred language (see Provide Web Pages for Captive Portal).

onInfo() is called with an object that contains an event property to indicate what is being configured. For example, the provisioned Wi-Fi credentials event is "credentials".

import CaptivePortal from "captiveportal";

const cp = new CaptivePortal({
	SSID: "Dryer Setup",
	onPage(path) {
		// see Provide Web Pages for Captive Portal
	},
	onInfo(msg) {
		if ("credentials" !== msg.event)
			return;
		trace(`Wi-Fi provisioned\n`);
		trace(` SSID: ${msg.SSID}\n`);
		if (msg.password)
			trace(` Password: ${msg.password}\n`);
	}
});

Your project probably will want to store the Wi-Fi credentials so that it can reconnect to Wi-Fi after restarting. Key-Value Storage is a convenient way to store these. See the Wi-Fi Guide for examples of connecting to a Wi-Fi access point.

import CaptivePortal from "captiveportal";

new CaptivePortal({
	SSID: "Dryer Setup",
	onPage(path) {
		// see Provide Web Pages for Captive Portal
	},
	onInfo(msg) {
		if ("credentials" !== msg.event)
			return;

		using wifi = device.keyValue.open({
			path: "wifi",
			format: "string"
		});

		wifi.write("SSID", msg.SSID);
		if (msg.password)
			wifi.write("password", msg.password);
	}
});

The Wi-Fi provisioning process goes through several phases, starting with initializing the Wi-Fi access point and ending with the success or failure of provisioning. The captive portal reports the current phase to onStatus() along with any relevant details about the phase.

For example, once the Wi-Fi access point is ready to accept connections, the phase is "ready" and the actual SSID and password selected are reported. This status information is useful for projects that display a user interface that reflects the progress of provisioning. See the Captive Portal example's readme for a list of phases.

import CaptivePortal from "captiveportal";

new CaptivePortal({
	SSID: "Dryer Setup",
	onPage(path) {
		// see Provide Web Pages for Captive Portal
	},
	onStatus(phase, details) {
		trace(`phase: ${phase}\n`);
		if (details)
			trace(` ${JSON.stringify(details)}\n`);
	}
});