hurry07 / mdns_listener_advanced

Simple mDNS Listener to add and listen .local hostnames in your network compatible with zeroconf, bonjour, avahi

mDNS Listener Advanced

⚠️ This is a Major update From the version 3.0.0 this package is using a Typescript Implementation it is currently being tested on Mac OS 12.6 and windows 11 If you have an issue on the current version please go back to the previous stable version and be free to open an issue here

Advanced mDNS Listener to add and listen .local hostnames in your network compatible with zeroconf, bonjour, avahi

I recommand using python publisher https://github.com/aminekun90/python_zeroconf_publisher since this code is fully compatible with it, if you dont have access to it you can contact me further bellow ;) I can make you an offer.

Note: The original idea was from @Richie765 https://github.com/Richie765/mdns-listener and got updated and enhanced, few parts of the original code still exist, recently updated to typescript.

Installation

npm install mdns-listener-advanced

Usage

var mdnsListenerAdvanced = require("mdns-listener-advanced");
const mdns = new mdnsListenerAdvanced.Core(['MyDevice2']);
const event = mdns.listen();
event.on('response', (found_hostnames) => {
  console.log('found_hostnames', found_hostnames);
  // mdns.stop();// To stop the listener
});
event.on('error', (error) => {
  console.log('error', error);
  // mdns.stop();// To stop the listener
});

⚠️ Being tested

import { Core } from "@mdns-listener-advanced";
const mdns = new Core(['MyDevice2']);
const event = mdns.listen();
event.on('response', (found_hostnames) => {
  console.log('found_hostnames', found_hostnames);
  // mdns.stop();// To stop the listener
});
event.on('error', (error) => {
  console.log('error', error);
  // mdns.stop();// To stop the listener
});

• To Stop listening to the event use :

mdns.stop();

Configuration

Method 1

Provide hostnames list in the constructor like this :

var mdnsListenerAdvanced = require("mdns-listener-advanced");
const mdns = new mdnsListenerAdvanced.Core(['MyDevice1','MyDevice2']);

The file .mdns-hosts is created automatically.

Method 2

Add and Edit the file named .mdns-hosts, this file must be in your HOME directory for windows [HDD]:\Users\<username>\.mdns-hosts and for linux/Mac ~/.mdns-hosts, place hostnames ending on separate lines like so:

myhost1
myhost2

You can specify the hostnames that you want to detect !

Whenever you change this file, you should restart the service.

Details :

Functions	Params	Type	Description
new mdnsListenerAdvanced.Core(['MyDevice2']);	hostsList	Array<string>	List of hostnames
new advanced_mdns(..,mdnsHostsPath)	mdnsHostsPath	string	Full path of your .mdns-hosts (not available)
new advanced_mdns(..,..,options)	options	{debug:boolean}	Enable debug
.listen().on(event,callback(object))	event	string	To catch a response event when set to "response"
	callback	function(object)	callback to do custome code
	object	object	a received object i.e {MyDevice1:{...}}
.stop()			to stop the event listener

known / reported issues :

TBD

Want to contribute or have any suggestions or questions?

Contact me on Linkedin Here.