/local-devices

🔮 Find devices connected to the current local network.

Primary LanguageJavaScriptMIT LicenseMIT

Local Devices

version MIT License js-standard-style All Contributors PRs Welcome

Build Status Coverage Status Watch on GitHub Star on GitHub

Find all devices connected to the local network using arp -a. This module also pings all possible ip's in the local network to build the arp table.

Installation

Npm

npm install local-devices

Example

// Using a transpiler
import find from 'local-devices'
// Without using a transpiler
const find = require('local-devices');

// Find all local network devices.
find().then(devices => {
  devices /*
  [
    { name: '?', ip: '192.168.0.10', mac: '...' },
    { name: '...', ip: '192.168.0.17', mac: '...' },
    { name: '...', ip: '192.168.0.21', mac: '...' },
    { name: '...', ip: '192.168.0.22', mac: '...' }
  ]
  */
})

// Find a single device by ip address.
find('192.168.0.10').then(device => {
  device /*
  {
    name: '?',
    ip: '192.168.0.10',
    mac: '...'
  }
  */
})

Contributions

  • Use npm test to run tests.

Please feel free to create a PR!

Contributors

Thanks goes to these wonderful people (emoji key):


Dylan Piercey

💬 💻 📖 💡 🤔 👀

Stefan Natter

🐛 💻 📖 🤔 ⚠️

kounelios13

🐛 📖

Markus Suomi

💻

Xavier Martin

💻

This project follows the all-contributors specification. Contributions of any kind are welcome!

LICENCE

MIT