@4hera/local-devices

A powerful Node.js library for discovering devices on your local network by scanning ARP tables.

🔍 Network Discovery: Find all devices connected to your local network
🛡️ Security Enhanced: Built-in protection against command injection attacks
🌐 Cross-Platform: Works on Windows, macOS, and Linux
📊 Rich Device Info: Get IP addresses, MAC addresses, and hostnames
🎯 Flexible Targeting: Scan specific IP addresses or ranges
⚡ High Performance: Optimized for speed and reliability

Installation

npm install @4hera/local-devices

Usage

Basic Usage

const findLocalDevices = require('@4hera/local-devices')

// Find all devices on the local network
findLocalDevices()
  .then(devices => {
    console.log('Found devices:', devices)
    // Example output:
    // [
    //   { ip: '192.168.1.1', mac: 'aa:bb:cc:dd:ee:ff', name: 'router.local' },
    //   { ip: '192.168.1.100', mac: '11:22:33:44:55:66', name: 'laptop.local' }
    // ]
  })
  .catch(error => {
    console.error('Error finding devices:', error)
  })

Advanced Usage

// Scan a specific IP address
findLocalDevices({ address: '192.168.1.100' })
  .then(device => {
    console.log('Device:', device)
  })

// Scan a range of IP addresses
findLocalDevices({ address: '192.168.1.1-192.168.1.254' })
  .then(devices => {
    console.log('Devices in range:', devices)
  })

// Scan using CIDR notation
findLocalDevices({ address: '192.168.1.0/24' })
  .then(devices => {
    console.log('Devices in subnet:', devices)
  })

// Skip name resolution for faster scanning
findLocalDevices({ skipNameResolution: true })
  .then(devices => {
    console.log('Devices (no hostnames):', devices)
  })

// Use custom ARP command path
findLocalDevices({ arpPath: '/usr/sbin/arp' })
  .then(devices => {
    console.log('Devices:', devices)
  })

API Reference

findLocalDevices(options)

Returns a Promise that resolves to an array of device objects.

Options

| Option | Type | Default | Description | |--------|------|---------|-------------| | address | string | '' | IP address, range, or CIDR to scan | | skipNameResolution | boolean | false | Skip hostname resolution for faster scanning | | arpPath | string | 'arp' | Path to the ARP command |

Device Object

{
  ip: '192.168.1.100',           // IP address
  mac: '11:22:33:44:55:66',      // MAC address
  name: 'device.local'           // Hostname (if available)
}

Security Features

This 4HERA Team edition includes enhanced security features:

• Command Injection Protection: Validates all input parameters
• Input Sanitization: Sanitizes IP addresses and ranges
• Error Handling: Comprehensive error handling for invalid inputs

Platform Support

• ✅ Windows: Uses arp -a command
• ✅ Linux: Uses arp -a or arp -an command
• ✅ macOS: Uses arp -a command

Requirements

• Node.js >= 10.17
• Network access to local subnet
• Appropriate permissions to execute ARP commands

Contributing

This is a 4HERA Team maintained package. For contributions, issues, or feature requests, please visit our GitHub repository.

License

MIT License

MIT License

Copyright (c) 2025 4HERA Team

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

4HERA Team

This package is maintained by the 4HERA Team. For more information about our projects and team, visit our organization page.

Note: This is the official 4HERA Team edition of local-devices with enhanced security and additional features.