<div align="center">
<p>
<img src="https://raw.githubusercontent.com/friedrith/assets/master/node-wifi/logo.png" alt="node-wifi" />
<br>
<br>
<img src="https://travis-ci.org/friedrith/node-wifi.svg?branch=master" alt="travis" />
</p>
</div>
**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 mac, 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](https://github.com/msolters/wifi-control-node) 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.
---
## Install
```bash
# Use as a module
npm install node-wifi
# Use as a CLI
npm install node-wifi -g
```
## Getting started
```javascript
var wifi = require("node-wifi");
// Initialize wifi module
// Absolutely necessary even to set interface to null
wifi.init({
iface: null // network interface, choose a random wifi interface if set to null
});
// Scan networks
wifi.scan(function(err, networks) {
if (err) {
console.log(err);
} else {
console.log(networks);
/*
networks = [
{
ssid: '...',
bssid: '...',
mac: '...', // equals to bssid (for retrocompatibility)
channel: <number>,
frequency: <number>, // in MHz
signal_level: <number>, // in dB
quality: <number>, // same as signal level but in %
security: 'WPA WPA2' // format depending on locale for open networks in Windows
security_flags: '...' // encryption protocols (format currently depending of the OS)
mode: '...' // network mode like Infra (format currently depending of the OS)
},
...
];
*/
}
});
// Connect to a network
wifi.connect({ ssid: "ssid", password: "password" }, function(err) {
if (err) {
console.log(err);
}
console.log("Connected");
});
// Disconnect from a network
// not available on all os for now
wifi.disconnect(function(err) {
if (err) {
console.log(err);
}
console.log("Disconnected");
});
// Delete a saved network
// not available on all os for now
wifi.deleteConnection({ ssid: "ssid" }, function(err) {
if (err) {
console.log(err);
}
console.log("Deleted");
});
// List the current wifi connections
wifi.getCurrentConnections(function(err, currentConnections) {
if (err) {
console.log(err);
}
console.log(currentConnections);
/*
// you may have several connections
[
{
iface: '...', // network interface used for the connection, not available on macOS
ssid: '...',
bssid: '...',
mac: '...', // equals to bssid (for retrocompatibility)
channel: <number>,
frequency: <number>, // in MHz
signal_level: <number>, // in dB
quality: <number>, // same as signal level but in %
security: '...' //
security_flags: '...' // encryption protocols (format currently depending of the OS)
mode: '...' // network mode like Infra (format currently depending of the OS)
}
]
*/
});
// All functions also return promise if there is no callback given
wifi
.scan()
.then(function(networks) {
// networks
})
.catch(function(error) {
// error
});
```
## Use as CLI
```javascript
wifi --scan
wifi --connect --ssid <ssid> --password <password> [--iface <wlan0>]
wifi --disconnect
wifi --current
```
## Dependencies
Linux:
- network-manager
## Contribute
Please read [development guidelines](./CONTRIBUTING.md) before proposing a pull request.
## Roadmap
- [x] add conventional commits
- [x] plug to travis
- [x] add github templates
- [x] add eslint
- [x] add prettier
- [x] switch to MIT license
- [ ] rewrite the library using ES7
- [ ] add unit tests
- [ ] stdout how to reproduce bug
- [ ] install commitizen
- [ ] generate changelog and release note
没有合适的资源?快使用搜索试试~ 我知道了~
资源详情
资源评论
资源推荐
收起资源包目录
node-wifi-master.zip (42个子文件)
node-wifi-master
.travis.yml 171B
bin
wifi.js 4KB
package.json 2KB
.eslintrc.json 107B
.github
PULL_REQUEST_TEMPLATE.md 887B
ISSUE_TEMPLATE.md 1KB
lock.yml 1KB
CODE_OF_CONDUCT.md 3KB
test
test-connect.js 599B
test-delete.js 310B
test-current-connections.js 565B
test-scan.js 510B
README.md 482B
test-disconnect.js 268B
test-frequency.js 0B
test-linux-scan.js 278B
LICENSE 1KB
package-lock.json 146KB
CONTRIBUTING.md 3KB
src
network-utils.js 1KB
mac-scan.js 2KB
linux-current-connections.js 2KB
windows-disconnect.js 714B
mac-delete.js 975B
linux-delete.js 717B
windows-scan.js 3KB
windows-current-connections.js 2KB
linux-scan.js 2KB
wifi.js 3KB
windows-connect.js 5KB
linux-disconnect.js 701B
mac-connect.js 1KB
linux-connect.js 1KB
env.js 127B
mac-current-connections.js 2KB
.npmignore 18B
.gitignore 18B
CHANGELOG.md 2KB
commitlint.config.js 65B
README.md 5KB
BIBLIOGRAPHY.md 413B
.prettierrc.json 59B
共 42 条
- 1
inspirely
- 粉丝: 2
- 资源: 15
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功
评论0