Skip to content

booyaa/wifiscanner

Repository files navigation

wifiscanner

CI Crates docs.rs dependency status

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):

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. 🎉

Inspired by Maurice Svay's node-wifiscanner

Tests shameless pilfered from Christian Kuster's node-wifi-scanner

Full documentation can be found here.

Usage

This crate is on crates.io and can be used by adding wifiscanner to the dependencies in your project's Cargo.toml.

[dependencies]
wifiscanner = "0.5.*"

and this to your crate root:

extern crate wifiscanner;

Example

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

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