# multicast-scanner

> Scan your local network for mDNS devices.

Latest version **2.3.0** (published 2020-06-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install multicast-scanner
pnpm add multicast-scanner
yarn add multicast-scanner
bun add multicast-scanner
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.3.0 |
| Published | 2020-06-25 |
| First published | 2019-02-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Rafostar |
| Maintainers | rafostar |
| Keywords | chromecast, mdns, scanner |

## Links

- npm: https://www.npmjs.com/package/multicast-scanner
- Repository: https://github.com/Rafostar/multicast-scanner
- Homepage: https://github.com/Rafostar/multicast-scanner#readme
- Issues: https://github.com/Rafostar/multicast-scanner/issues
- npm.io page: https://npm.io/package/multicast-scanner

## Dependencies (1)

- [multicast-dns](https://npm.io/package/multicast-dns.md) ^7.2.0

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 2.3.0 (latest) — 2020-06-25
- 2.2.3 — 2020-02-28
- 2.2.2 — 2020-02-28
- 2.2.1 — 2019-09-07
- 2.2.0 — 2019-09-07
- 2.1.1 — 2019-09-05
- 2.1.0 — 2019-09-05
- 2.0.1 — 2019-05-10
- 2.0.0 — 2019-05-09
- 1.0.0 — 2019-02-27

## README

# multicast-scanner
[![Donate](https://img.shields.io/badge/Donate-PayPal-blue.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=TFVDFD88KQ322)
[![Donate](https://img.shields.io/badge/Donate-PayPal.Me-lightgrey.svg)](https://www.paypal.me/Rafostar)

### Scan your local network for mDNS devices.
Based on [xat/chromecast-scanner](https://github.com/xat/chromecast-scanner).

Scanner is set to scan for Chromecasts by default. Service name and type to scan for can be set when launching scan.

Defaults:
```javascript
{
  ttl: 7000,
  interval: 2500,
  full_scan: false,
  name: null,
  friendly_name: null,
  service_name: '_googlecast._tcp.local',
  service_type: 'PTR',
  mdns: {}
}
```

The `mdns` object in options is passed to `multicast-dns` and can be used to alter its defaults.

### Usage Example
```javascript
var scanner = require('multicast-scanner');

scanner({ full_scan: true }, (err, devices) => {
  if(err) return console.log(err.message);

  devices.forEach(device => {
    console.log(device);
  });
});
```

```javascript
/* Example Output:
{ name: 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX.local',
  friendlyName: 'My Chromecast',
  ip: '192.168.1.XXX',
  port: 8009 }
*/
```

### Installation

`npm install multicast-scanner`

## License
MIT

## Donation
If you like my work please support it by buying me a cup of coffee :grin:

[![PayPal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=TFVDFD88KQ322)

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