https://github.com/booyaa/wifiscanner
A crate to list WiFi hotspots in your area
https://github.com/booyaa/wifiscanner
airport crates hacktoberfest iw netsh-client wifi-hotspots wifiscanner
Last synced: about 1 year ago
JSON representation
A crate to list WiFi hotspots in your area
- Host: GitHub
- URL: https://github.com/booyaa/wifiscanner
- Owner: booyaa
- License: apache-2.0
- Created: 2016-07-29T20:55:29.000Z (almost 10 years ago)
- Default Branch: main
- Last Pushed: 2023-08-06T10:37:23.000Z (almost 3 years ago)
- Last Synced: 2025-03-30T17:11:12.378Z (about 1 year ago)
- Topics: airport, crates, hacktoberfest, iw, netsh-client, wifi-hotspots, wifiscanner
- Language: Rust
- Homepage:
- Size: 3.9 MB
- Stars: 61
- Watchers: 1
- Forks: 34
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# wifiscanner
[](https://github.com/booyaa/wifiscanner/actions?query=workflow%3ACI)
[](https://crates.io/crates/wifiscanner)
[](https://docs.rs/wifiscanner)
[](https://deps.rs/repo/github/booyaa/wifiscanner)
## Important note to existing contributors!
If you have a local clone you will need to update your default branch from `master` to `main`. The easiest way to do this is to delete the clone and recreate it.
Alternatively type the following commands (thanks [Scott](https://www.hanselman.com/blog/EasilyRenameYourGitDefaultBranchFromMasterToMain.aspx)):
```sh
git checkout master
$ git branch -m master main
$ git fetch
$ git branch --unset-upstream
$ git branch -u origin/main
$ git symbolic-ref refs/remotes/origin/HEAD refs/remotes/origin/main
```
## Intro
A crate to list WiFi hotspots in your area.
As of v0.5.x now supports macOS, Linux and Windows. :tada:
Inspired by Maurice Svay's [node-wifiscanner](https://github.com/mauricesvay/node-wifiscanner)
Tests shameless pilfered from Christian Kuster's [node-wifi-scanner](https://github.com/ancasicolica/node-wifi-scanner)
Full documentation can be found [here](https://docs.rs/wifiscanner).
## Usage
This crate is [on crates.io](https://crates.io/crates/wifiscanner) and can be
used by adding `wifiscanner` to the dependencies in your project's `Cargo.toml`.
```toml
[dependencies]
wifiscanner = "0.5.*"
```
and this to your crate root:
```rust
extern crate wifiscanner;
```
## Example
```rust
use wifiscanner;
println!("{:?}", wifiscanner::scan());
```
Alternatively if you've cloned the Git repo, you can run the above example
using: `cargo run --example scan`.
## Changelog
- 0.5.1 - crates.io metadata update
- 0.5.0 - add window support (props to @brianjaustin)
- 0.4.0 - replace iwlist with iw (props to @alopatindev)
- 0.3.6 - crates.io metadata update
- 0.3.5 - remove hardcoded path for iwlist (props to @alopatindev)
- 0.3.4 - initial stable release
## How to contribute
see [CONTRIBUTING.md](/CONTRIBUTING.md)
## Contributors
wifiscanner would not be possible without the following folks:
@alopatindev, @bizzu, @bash, @cristicbz, @lpmi-13, @brianjaustin
## Copyright
Copyright 2019 Mark Sta Ana.
see [LICENSE](/LICENSE)