# wifi-network

> Cross-platform wireless network control

Latest version **0.3.1** (published 2020-04-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install wifi-network
pnpm add wifi-network
yarn add wifi-network
bun add wifi-network
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.1 |
| Published | 2020-04-25 |
| First published | 2017-05-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 10.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| Author | Jonas Hermsmeier |
| Maintainers | jhermsmeier |
| Keywords | wifi, wlan, lan, network, scanner, wireless |

## Links

- npm: https://www.npmjs.com/package/wifi-network
- Repository: https://github.com/jhermsmeier/node-wifi-network
- Issues: https://github.com/jhermsmeier/node-wifi-network/issues
- npm.io page: https://npm.io/package/wifi-network

## Dependencies (3)

- [nan](https://npm.io/package/nan.md) ^2.14.1
- [bindings](https://npm.io/package/bindings.md) ^1.5.0
- [prebuild-install](https://npm.io/package/prebuild-install.md) ^5.3.3

## Recent versions

- 0.3.1 (latest) — 2020-04-25
- 0.3.0 — 2020-02-13
- 0.2.1 — 2017-11-29
- 0.2.0 — 2017-06-18
- 0.1.0 — 2017-05-30

## README

# WiFi-Network
[![npm](https://img.shields.io/npm/v/wifi-network.svg?style=flat-square)](https://npmjs.com/package/wifi-network)
[![stability](https://img.shields.io/badge/stability-experimental-orange.svg?style=flat-square)](https://nodejs.org/api/documentation.html#documentation_stability_index)
[![npm license](https://img.shields.io/npm/l/wifi-network.svg?style=flat-square)](https://npmjs.com/package/wifi-network)
[![npm downloads](https://img.shields.io/npm/dm/wifi-network.svg?style=flat-square)](https://npmjs.com/package/wifi-network)
[![build status](https://img.shields.io/travis/jhermsmeier/node-wifi-network/master.svg?style=flat-square)](https://travis-ci.org/jhermsmeier/node-wifi-network)

Cross-platform wireless network control

## Install via [npm](https://npmjs.com)

```sh
$ npm install --save wifi-network
```

## Supported Platforms

- [x] Mac OS
- [ ] Windows
- [ ] Linux

## Usage

```js
var wifi = require( 'wifi-network' )
```

### Scan for available networks

```js
wifi.scan( function( error, networks ) {
  console.log( error || networks )
})
```

```js
[
  {
    ssid: 'Vodafone Hotspot',
    bssid: 'a6:31:c4:f2:2d:ca',
    countryCode: 'DE',
    beaconInterval: 100,
    noise: -88,
    rssi: -52,
    channelNumber: 1,
    channelBand: 2,
    channelWidth: 20,
  },
  ...
]
```

## Contributing

### Auxiliary Dependencies

- [cpplint](https://github.com/cpplint/cpplint)

```
$ pip install cpplint
```

## References

- [Apple / CoreWLAN](https://developer.apple.com/reference/corewlan)
- [Microsoft / Native Wifi API](https://msdn.microsoft.com/en-us/library/ms706556(VS.85).aspx)

---
_Source: https://npm.io/package/wifi-network · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._