From 5a5b0f64adc4eff6bafa4ac095f4c9da8b845009 Mon Sep 17 00:00:00 2001 From: "bernhard.trinnes" Date: Fri, 6 Mar 2020 15:27:05 +0100 Subject: [PATCH] reworked avahi Readme --- avahimonitor/README.md | 24 ++++++++++++++++++++---- 1 file changed, 20 insertions(+), 4 deletions(-) diff --git a/avahimonitor/README.md b/avahimonitor/README.md index 91559864..9d1be956 100644 --- a/avahimonitor/README.md +++ b/avahimonitor/README.md @@ -1,7 +1,23 @@ -# Avahi Monitor +--- +id: AvahiMonitor +title: Avahi Monitor +--- -This plugin allows you to discover and monitor zeroconf based services in the local network. +This integration allows nymea to discover and monitor zeroconf services in the local area network. +Avahi is a free zeroconf implementation and is utilised by nymea. Inside nymea:app an added Avahi thing will appear as a presence sensor. -This allows also to monitor the existence of a certain device in the network or just a special service of interest. +## Supported Things -More information and explanation of zeroconf can be found [here](http://www.zeroconf.org/). +* Avahi Monitor + * List all zeroconf services in the local area network during device setup + * Displays the presence of the zeroconf service + * No internet or cloud connection required + +## Requirements + +* The zeroconf service must be in the same local area network as nymea. +* The router must not block avahi/zeroconf multicast messages +* The package “nymea-plugin-avahimonitor” must be installed. + +## More +See http://www.zeroconf.org for more information about the Zeroconf discovery protocol, or see https://www.avahi.org for more information about avahi.