Wifi.js
I have great ambitions for this project and I am looking for maintainers who could help me to handle all improvements and
bug fixes about this project because the hardware/os dependencies make it quite
hard to test.
The node-wifi module allows macOS, windows and linux users to interact with surrounding wifi networks through various methods. These methods include scanning for wifi access points and connecting to these access points.
Features | Linux | Mac | Windows |
---|
Connect | ✓ | ✓ | ✓ |
Scan | ✓ | ✓ | ✓ |
List current wifi connections | ✓ | ✓ | ✓ |
Disconnect | ✓ | | ✓ |
Delete connection information | ✓ | ✓ | |
We wish to be clear in saying that this module is inspired from node-wifi-control but with some slight modifications to certain functions such as the various OS-specific parsers for terminal output as we noticed that these parsers did not work well on certain operating systems.
As everything with hardware dependencies, weird behaviors may happen depending of your configuration. You should never hesitate to notify us about a specificity of your OS/Hardware/Wifi card/whatever.
Installation
npm install wifi.js
npm install wifi.js -g
Getting started
var wifi = require('wifi.js');
wifi.init({
iface: null
});
wifi.scan((error, networks) => {
if (error) {
console.log(error);
} else {
console.log(networks);
}
});
wifi.connect({ ssid: 'ssid', password: 'password' }, error => {
if (error) {
console.log(error);
}
console.log('Connected');
});
wifi.disconnect(error => {
if (error) {
console.log(error);
} else {
console.log('Disconnected');
}
});
wifi.deleteConnection({ ssid: 'ssid' }, error => {
if (error) {
console.log(error);
} else {
console.log('Deleted');
}
});
wifi.getCurrentConnections((error, currentConnections) => {
if (error) {
console.log(error);
} else {
console.log(currentConnections);
}
});
wifi
.scan()
.then(networks => {
})
.catch(error => {
});
Use as CLI
wifi --scan
wifi --connect --ssid <ssid> --password <password> [--iface <wlan0>]
wifi --disconnect
wifi --current
Platforms compatibility
This project is tested with operating systems:
- macOS Catalina 10.15.5
- linux Ubuntu 18.04.3 LTS
Do not hesitate to create a pull request to add the OS you are using.
Dependencies
Linux: