Skip to end of metadata
Go to start of metadata
Author
Logo

State

STABLE

Version2.2
Min. LB Version

1.1 = LB 0.2.3 2.2 = LB 1.4

Downloadhttps://github.com/Gagi2k/LoxBerry-Plugin-WifiScanner/archive/v2.2.zip
Description

Scans the network for devices and sends the state to the miniserver. This can be used for presence detection for example.

 Version History...

Version 1.0-rc1

  • first release

Version 1.1

  • english translation

Version 2.0

  • New Plugin Structure
  • Scan of IP-Adresses
  • Scan without FritzBox (Router) possible
  • Addidional autmoatic Scan with arping
  • Start Scan from Miniserver

Version 2.1

  • Fixed German Translations
  • Send information as soon as possible
  • MQTT-Support

Version 2.2

  • Improved Logging Output
  • Determine the ip adress from the mac address
  • Option to configure active scanning
  • Option for using ping instead of arping
  • Fixed MQTT problems

Inhalt



Download

All releases are listed here: https://github.com/Gagi2k/LoxBerry-Plugin-WifiScanner/releases

Installation

The plugin can be installed as zip file into Loxberry. Similar to all other plugins.

Configuration options

You can activate the scanner using the "Activate Scanner" button.
The scanner will scan for new users in a periodic manner, which can be setup in the next step.

The ComboBox after the "Activate Scanner" button defines the scanning interval.

A new user can be added by using the "New User" button. The now appearing fields can be used to configure this user.

Every user needs to be identified by it's name. The plugin doesn't check that the names are unique, but the name will be used for sending the data to the miniserver, which can lead to problems if the users are not unique.
For every user you can setup one or more MAC addresses. Multiple addresses can be added separated by ;
Instead of MAC addresses, it is also possible to add an IP address or mix both.

The MAC addresses can be found in the network overview of your FritzBox or by using a scanning software like LANScan.

You can setup the FritzBox address and port in the "FritzBox connection" section. Most of the times nothing need to be changed here. In case you don't have a FritzBox, you can disable the scan using the "Ask FritzBox" ComboBox.

The "Miniserver connection" section is used for setting up the UDP port which will be used for sending the data to the miniserver.

After activating the scanner and saving the configuration a first scan will be initiated. The result of this scan can be found in the log file, which can be opened using the "Open Logfile" button.

Functionality of the plugin

The plugin is based on this script from the wiki.
Most of the times, the plugin is used for presence detection of certain users in your Wifi network. For that users can be setup with one or more mac addresses. The plugin will scan periodically for the setup mac addresses by fetching this information from the FritzBox. The result will be send to the miniserver using the UDP protocol.

Setup in the Loxone Config Software

First a new Virtueller UDP Input needs to be added. The UDP Port needs to be the same port that was setup in the plugin configuration.
Following an example setting up the default port:

For every user a new Virtual UDP Input Command needs to be added.

Use the following command recognition: \i<USER>:\i\v
<USER> needs to be replaced by the user setup in your plugin configuration.
Following an example for the user "Dominik"

Start Scan from Miniserver

In some Situations it makes sense to start a Scan now and then repeat it in a short interval. One example for this is when an alarm is triggered and can be used to detect whether it is a "false alarm" and to disable the alarm system.
To start a new scan add a new Virtual Output. The address needs to be set to the IP address of your Loxberry. In the Virtual Output Command you need to set the Command for On to the following value:
/plugins/wifiscanner/scan.cgi


Roadmap

  • English Translation (1.1)
  • Scan for IP addresses (2.0
  • independence from the FritzBox (2.0
  • Start a scan from the Miniserver (2.0)
  • Update to the new plugin API (2.0)
  • Start using the Loxberry Update Mechanism (2.0)

Asking questions and reporting problems

Question about the plugin will be answered in the forum or in this wiki page. Please report your errors here.



  • No labels