@hi-brylle/rpi-wifi-connection v2.5.4

rpi-wifi-connection

A wrapper library that uses wpa_cli for connecting a Raspberry Pi to Wi-Fi.

Installation

$ npm i @hi-brylle/rpi-wifi-connection

Initialization

import RpiWiFiConnection from '@hi-brylle/rpi-wifi-connection';
let wifi = new RpiWiFiConnection() // "wlan0" default network interface

Types

WifiNetwork

Type returned when scanning for available networks.

interface WiFiNetwork {
    bssid: string,
    frequency: number,
    signal_level: number,
    ssid: string
}

ConfiguredNetwork

Type returned when querying for networks previously connected to.

interface ConfiguredNetwork {
    id: number,
    ssid: string
}

Methods

get_status()

Returns a singleton list containing the sole SSID if device is connected or empty list if not connected.

scan_networks()

Returns a list of WifiNetwork or empty list if nothing is detected.

get_configured_networks()

Returns a list of ConfiguredNetwork or empty list if the RPi has never connected to a Wi-Fi network.

connect_to_network(ssid: string, password: string)

Attempts connection with ssid and password input. Doesn't return anything. Use get_status() to check whether connection attempt succeeded.

forget_network(ssid_to_forget: string)

Remove previously configured network from the RPi to prevent it from auto-connecting to that network in the future.

auto_connect_to_network(ssid: string)

Auto-connect to a previously configured network. If ssid input doesn't belong to the list returned by get_configured_networks(), nothing happens. Use get_status() to check whether connection attempt succeeded.

disconnect_from_wifi()

Disconnect from Wi-Fi.

reconnect_to_wifi()

Reconnect to Wi-Fi. Effects may not be immediate so call get_status() to check connection status or call scan_networks() to query all available networks after some timeout.