node-wifi

    2.0.16 • Public • Published

    node-wifi

    build size version

    We think about switching to ES Modules only for next major release. We would like to have your opinion on this. Please consider leave a comment in the discussion thread.

    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 macOS, 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 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

    # Use as a module
    npm install node-wifi

    Getting started

    const 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((error, networks) => {
      if (error) {
        console.log(error);
      } 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' }, () => {
      console.log('Connected'); 
      // on windows, the callback is called even if the connection failed due to netsh limitations
      // if your software may work on windows, you should use `wifi.getCurrentConnections` to check if the connection succeeded
    });
    
    // Disconnect from a network
    // not available on all os for now
    wifi.disconnect(error => {
      if (error) {
        console.log(error);
      } else {
        console.log('Disconnected');
      }
    });
    
    // Delete a saved network
    // not available on all os for now
    wifi.deleteConnection({ ssid: 'ssid' }, error => {
      if (error) {
        console.log(error);
      } else {
        console.log('Deleted');
      }
    });
    
    // List the current wifi connections
    wifi.getCurrentConnections((error, currentConnections) => {
      if (error) {
        console.log(error);
      } else {
        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(networks => {
        // networks
      })
      .catch(error => {
        // error
      });

    Use as CLI

    node-wifi is also usable as a CLI tool with the library node-wifi-cli.

    Platforms compatibility

    This project is tested with operating systems:

    • macOS Catalina 10.15.5
    • macOS Big Sur 11.5.1
    • linux Ubuntu 18.04.3 LTS

    Do not hesitate to create a pull request to add the OS you are using.

    Dependencies

    Linux:

    • network-manager (nmcli)

    Windows:

    • netsh

    MacOS:

    • airport
    • networksetup

    Contribute

    Please read development guidelines 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
    • [x] generate changelog and release note
    • [x] stdout how to reproduce bug
    • [x] use github actions
    • [ ] add unit tests (in progress)
    • [ ] rewrite the library using ES7 (in progress)
    • [ ] harmonize security flags and modes
    • [ ] install commitizen
    • [ ] use xml to stabilize parsers

    Install

    npm i node-wifi

    DownloadsWeekly Downloads

    3,403

    Version

    2.0.16

    License

    MIT

    Unpacked Size

    151 kB

    Total Files

    75

    Last publish

    Collaborators

    • friedrit