wifi_scan 0.7.2

A crate to list WiFi hotspots in your area. Fork of booyaa/wifiscanner with many improvements to make it future-proof.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

# wifi_scan

[![CI](https://github.com/simon0302010/wifi-scan/actions/workflows/ci.yml/badge.svg)](https://github.com/simon0302010/wifi-scan/actions/workflows/ci.yml)
[![Crates](https://img.shields.io/crates/v/wifi_scan.svg)](https://crates.io/crates/wifi_scan)
[![docs.rs](https://docs.rs/wifi_scan/badge.svg)](https://docs.rs/wifi_scan)
[![dependency status](https://deps.rs/repo/github/simon0302010/wifi-scan/status.svg)](https://deps.rs/repo/github/simon0302010/wifi-scan)

## Intro

This is a fork of [wifiscanner](https://github.com/booyaa/wifiscanner), a crate to list WiFi hotspots in your area.
This fork moves `wifiscanner` away from using command line utilities that can't be relied on.
Use versions 0.6.* if you want a drop-in replacement for the original crate.

Full documentation can be found [here](https://docs.rs/wifi_scan).

I started developing this project during [Midnight Hackathon](https://midnight.hackclub.com/) organised by Hack Club.

## Supported Operating Systems

| ✅ Fully working | ⚠️ Partially working | 🛠️ Planned |

Operating System    | Status    | Notes
--------------------|-----------|--------------------------------------------------
macOS               | ⚠️        | requires location access to show bssid and ssid
Linux               | ✅        |
Windows             | ✅        |
OpenBSD             | ✅        | wpa3-enterprise networks cannot be detected as such
FreeBSD             | 🛠️        |
Android             | 🛠️        |

## Usage

This crate is [on crates.io](https://crates.io/crates/wifi_scan) and can be
used by adding `wifi_scan` to the dependencies in your project's `Cargo.toml`.

```toml
[dependencies]
wifi_scan = "0.7.*"
```

## Example

```rust
use wifi_scan;
println!("{:?}", wifi_scan::scan());
```

Alternatively if you've cloned the Git repo, you can run the above example
using: `cargo run --example scan`.

## Changelog

- 0.7.1 - added full support for OpenBSD
- 0.7.0 - changed api for scan function. also added other functions. more details in the docs.
- 0.6.3 - switch to using `corewlan` on macOS due to the removal of the `airport` utility
- 0.6.2 - stop relying on `netsh` utility on windows
- 0.6.1 - support for multiple wifi adapters on linux
- 0.6.0 - remove `iw` dependency for linux
- 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

wifi_scan would not be possible without the following people:

@alopatindev, @bizzu, @bash, @cristicbz, @lpmi-13, @brianjaustin, @booyaa

## Copyright

Copyright 2019 Mark Sta Ana.
Forked and maintained by simon0302010.

Copyright 2025 simon0302010.

see [LICENSE](/LICENSE)