mirror of
https://github.com/fhem/fhem-mirror.git
synced 2025-01-31 12:49:34 +00:00
74_Nmap.pm/59_Luftdateinfo.pm: fix documentation by Beta-User (Forum #125662)
git-svn-id: https://svn.fhem.de/fhem/trunk@25647 2b470e98-0d58-463d-a4d8-8e2adae1ed80
This commit is contained in:
rudolfkoenig
parent
80dd969ecd
commit
34c05378ad
@ -552,16 +552,18 @@ sub LuftdatenInfo_statusRequest($) {
|
||||
|
||||
1;
|
||||
|
||||
__END__
|
||||
|
||||
# commandref ##################################################################
|
||||
=pod
|
||||
=encoding utf8
|
||||
=item summary provides data from Luftdaten.info
|
||||
=item summary_DE stellt Daten von Luftdaten.info bereit
|
||||
|
||||
=begin html
|
||||
|
||||
<a name="LuftdatenInfo"></a>
|
||||
<a id="LuftdatenInfo"></a>
|
||||
<h3>LuftdatenInfo</h3>
|
||||
(en | <a href="commandref_DE.html#LuftdatenInfo"><u>de</u></a>)
|
||||
<div>
|
||||
<ul>
|
||||
LuftdatenInfo is the FHEM module to read particulate matter, temperature
|
||||
@ -580,9 +582,8 @@ sub LuftdatenInfo_statusRequest($) {
|
||||
Under Debian (based) system, this can be installed using
|
||||
<code>"apt-get install libjson-perl"</code>.
|
||||
</ul>
|
||||
<br>
|
||||
<a name="LuftdatenInfodefine"></a>
|
||||
<b>Define</b>
|
||||
<a id="LuftdatenInfo-define"></a>
|
||||
<h4>Define</h4>
|
||||
<ul>
|
||||
<code>
|
||||
define <name> LuftdatenInfo remote
|
||||
@ -603,28 +604,28 @@ sub LuftdatenInfo_statusRequest($) {
|
||||
specified.<br>
|
||||
If several similar sensors are used, the duplicate values can be written
|
||||
in another device.
|
||||
</ul><br>
|
||||
<a name="LuftdatenInfoset"></a>
|
||||
<b>Set</b>
|
||||
</ul>
|
||||
<a id="LuftdatenInfo-set"></a>
|
||||
<h4>Set</h4>
|
||||
<ul>
|
||||
<li>
|
||||
<a id="LuftdatenInfo-set-statusRequest"></a><li>
|
||||
<code>statusRequest</code><br>
|
||||
Starts a status request.
|
||||
</li>
|
||||
</ul><br>
|
||||
<a name="LuftdatenInfoget"></a>
|
||||
<b>Get</b>
|
||||
</ul>
|
||||
<a id="LuftdatenInfo-get"></a>
|
||||
<h4>Get</h4>
|
||||
<ul>
|
||||
<li>
|
||||
<a id="LuftdatenInfo-get-senors"></a><li>
|
||||
<code>sensors</code><br>
|
||||
Lists all senors.
|
||||
</li>
|
||||
</ul><br>
|
||||
<a name="LuftdatenInforeadings"></a>
|
||||
<b>Readings</b><br>
|
||||
</ul>
|
||||
<a name="LuftdatenInfo-readings"></a>
|
||||
<h4>Readings</h4><br>
|
||||
<ul>
|
||||
<li>
|
||||
<code>airQuality</code>
|
||||
<code>airQuality</code><br>
|
||||
1 => good<br>
|
||||
2 => moderate<br>
|
||||
3 => unhealthy for sensitive groups<br>
|
||||
@ -707,11 +708,11 @@ sub LuftdatenInfo_statusRequest($) {
|
||||
<code>UVRisk</code><br>
|
||||
UV risk from 1 to 5
|
||||
</li>
|
||||
</ul><br>
|
||||
<a name="LuftdatenInfoattr"></a>
|
||||
<b>Attribute</b>
|
||||
</ul>
|
||||
<a id="LuftdatenInfo-attr"></a>
|
||||
<h4>Attributes</h4>
|
||||
<ul>
|
||||
<li>
|
||||
<a id="LuftdatenInfo-attr-disable"></a><li>
|
||||
<code>disable 1</code><br>
|
||||
No queries are started.
|
||||
</li>
|
||||
@ -720,12 +721,12 @@ sub LuftdatenInfo_statusRequest($) {
|
||||
<u><code>disabledForIntervals HH:MM-HH:MM HH:MM-HH-MM ...</code></u>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a id="LuftdatenInfo-attr-interval"></a><li>
|
||||
<code>interval <seconds></code><br>
|
||||
Interval in seconds in which queries are performed.<br>
|
||||
The default and minimum value is 300 seconds for remote request and 30 seconds for local requests.
|
||||
</li>
|
||||
<li>
|
||||
<a id="LuftdatenInfo-attr-timeout"></a><li>
|
||||
<code>timeout <seconds></code><br>
|
||||
Timeout in seconds for the queries.<br>
|
||||
The default and minimum value is 5 seconds.
|
||||
@ -738,9 +739,8 @@ sub LuftdatenInfo_statusRequest($) {
|
||||
|
||||
=begin html_DE
|
||||
|
||||
<a name="LuftdatenInfo"></a>
|
||||
<a id="LuftdatenInfo"></a>
|
||||
<h3>LuftdatenInfo</h3>
|
||||
(<a href="commandref.html#LuftdatenInfo"><u>en</u></a> | de)
|
||||
<div>
|
||||
<ul>
|
||||
LuftdatenInfo ist das FHEM Modul um Feinstaub-, Temperatur- und
|
||||
@ -761,8 +761,8 @@ sub LuftdatenInfo_statusRequest($) {
|
||||
<code>"apt-get install libjson-perl"</code> installiert werden.
|
||||
</ul>
|
||||
<br>
|
||||
<a name="LuftdatenInfodefine"></a>
|
||||
<b>Define</b>
|
||||
<a id="LuftdatenInfo-define"></a>
|
||||
<h4>Define</h4>
|
||||
<ul>
|
||||
<code>
|
||||
define <name> LuftdatenInfo remote
|
||||
@ -783,28 +783,28 @@ sub LuftdatenInfo_statusRequest($) {
|
||||
Hostname angegeben werden.<br>
|
||||
Werden mehrere ähnliche Sensoren betrieben lassen sich die doppelten
|
||||
Werte in einem anderen Gerät geschrieben werden.
|
||||
</ul><br>
|
||||
<a name="LuftdatenInfoset"></a>
|
||||
<b>Set</b>
|
||||
</ul>
|
||||
<a id="LuftdatenInfo-set"></a>
|
||||
<h4>Set</h4>
|
||||
<ul>
|
||||
<li>
|
||||
<a id="LuftdatenInfo-set-statusRequest"></a><li>
|
||||
<code>statusRequest</code><br>
|
||||
Startet eine Abfrage der Daten.
|
||||
</li>
|
||||
</ul><br>
|
||||
<a name="LuftdatenInfoget"></a>
|
||||
<b>Get</b>
|
||||
</ul>
|
||||
<a id="LuftdatenInfo-get"></a>
|
||||
<h4>Get</h4>
|
||||
<ul>
|
||||
<li>
|
||||
<a id="LuftdatenInfo-get-senors"></a><li>
|
||||
<code>sensors</code><br>
|
||||
Listet alle Sensoren auf.
|
||||
</li>
|
||||
</ul><br>
|
||||
<a name="LuftdatenInforeadings"></a>
|
||||
<b>Readings</b><br>
|
||||
<a id="LuftdatenInfo-readings"></a>
|
||||
<h4>Readings</h4><br>
|
||||
<ul>
|
||||
<li>
|
||||
<code>airQuality</code>
|
||||
<code>airQuality</code><br>
|
||||
1 => gut<br>
|
||||
2 => mittelmä&suml;ig<br>
|
||||
3 => ungesund für empfindliche Menschen<br>
|
||||
@ -890,11 +890,11 @@ sub LuftdatenInfo_statusRequest($) {
|
||||
<code>UVRisk</code><br>
|
||||
UV Risiko von 1 bis 5
|
||||
</li>
|
||||
</ul><br>
|
||||
<a name="LuftdatenInfoattr"></a>
|
||||
<b>Attribute</b>
|
||||
</ul>
|
||||
<a id="LuftdatenInfo-attr"></a>
|
||||
<h4>Attribute</h4>
|
||||
<ul>
|
||||
<li>
|
||||
<a id="LuftdatenInfo-attr-disable"></a><li>
|
||||
<code>disable 1</code><br>
|
||||
Es werden keine Abfragen mehr gestartet.
|
||||
</li>
|
||||
@ -903,12 +903,12 @@ sub LuftdatenInfo_statusRequest($) {
|
||||
<u><code>disabledForIntervals HH:MM-HH:MM HH:MM-HH-MM ...</code></u>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a id="LuftdatenInfo-attr-interval"></a><li>
|
||||
<code>interval <seconds></code><br>
|
||||
Intervall in Sekunden in dem Abfragen durchgeführt werden.<br>
|
||||
Der Vorgabe- und Mindestwert beträgt 300 Sekunden für remote Abfragen und 30 Sekunden für local Abfragen.
|
||||
</li>
|
||||
<li>
|
||||
<a id="LuftdatenInfo-attr-timeout"></a><li>
|
||||
<code>timeout <seconds></code><br>
|
||||
Timeout in Sekunden für die Abfragen.<br>
|
||||
Der Vorgabe- und Mindestwert beträgt 5 Sekunden.
|
||||
|
||||
@ -567,17 +567,19 @@ sub Nmap_updateUptime($$;$) {
|
||||
|
||||
1;
|
||||
|
||||
__END__
|
||||
|
||||
# commandref ##################################################################
|
||||
=pod
|
||||
=encoding utf8
|
||||
=item device
|
||||
=item summary Interpret of an Nmap network scans
|
||||
=item summary_DE Auswertung eines Nmap Netzwerkscans
|
||||
|
||||
=begin html
|
||||
|
||||
<a name="Nmap"></a>
|
||||
<a id="Nmap"></a>
|
||||
<h3>Nmap</h3>
|
||||
( en | <a href="commandref_DE.html#Nmap"><u>de</u></a> )
|
||||
<div>
|
||||
<ul>
|
||||
Nmap is the FHEM module to perform a network scan with Nmap and to display information about the available network devices.<br>
|
||||
@ -596,8 +598,8 @@ sub Nmap_updateUptime($$;$) {
|
||||
.
|
||||
</ul>
|
||||
<br>
|
||||
<a name="Nmapdefine"></a>
|
||||
<b>Define</b>
|
||||
<a id="Nmap-define"></a>
|
||||
<h4>Define</h4>
|
||||
<ul>
|
||||
<code>define <name> Nmap <target specification></code><br>
|
||||
In the <target specification> are all target hosts, which are to be
|
||||
@ -616,29 +618,29 @@ sub Nmap_updateUptime($$;$) {
|
||||
<a href="https://nmap.org/man/de/man-target-specification.html">
|
||||
<u>Nmap Manpage (Specifying Destinations)</u>
|
||||
</a>.
|
||||
</ul><br>
|
||||
<a name="Nmapset"></a>
|
||||
<b>Set</b>
|
||||
</ul>
|
||||
<a id="Nmap-set"></a>
|
||||
<h4>Set</h4>
|
||||
<ul>
|
||||
<li>
|
||||
<a id="Nmap-set-clear"></a><li>
|
||||
<code>clear readings</code><br>
|
||||
Deletes all readings except "state".
|
||||
</li>
|
||||
<li>
|
||||
<a id="Nmap-set-deleteOldReadings"></a><li>
|
||||
<code>deleteOldReadings <s></code><br>
|
||||
Deletes all readings older than <s> seconds.
|
||||
</li>
|
||||
<li>
|
||||
<a id="Nmap-set-interrupt"></a><li>
|
||||
<code>interrupt</code><br>
|
||||
Cancels a running scan.
|
||||
</li>
|
||||
<li>
|
||||
<a id="Nmap-set-statusRequest"></a><li>
|
||||
<code>statusRequest</code><br>
|
||||
Starts a network scan.
|
||||
</li>
|
||||
</ul><br>
|
||||
<a name="Nmapreadings"></a>
|
||||
<b>Readings</b><br>
|
||||
</ul>
|
||||
<a id="Nmap-readings"></a>
|
||||
<h4>Readings</h4>
|
||||
<ul>
|
||||
General Readings:
|
||||
<ul>
|
||||
@ -733,11 +735,11 @@ sub Nmap_updateUptime($$;$) {
|
||||
device is reachable.
|
||||
</li>
|
||||
</ul>
|
||||
</ul><br>
|
||||
<a name="Nmapattr"></a>
|
||||
<b>Attribute</b>
|
||||
</ul>
|
||||
<a id="Nmap-attr"></a>
|
||||
<h4>Attributes</h4>
|
||||
<ul>
|
||||
<li>
|
||||
<a id="Nmap-attr-absenceThreshold"></a><li>
|
||||
<code>absenceThreshold <n></code><br>
|
||||
The number of network cans that must result in "absent" before the
|
||||
state of a network device changes to "absent". With this function you
|
||||
@ -746,17 +748,17 @@ sub Nmap_updateUptime($$;$) {
|
||||
"<metaReading>_state" remains on "present" until the final status
|
||||
changes to "absent".
|
||||
</li>
|
||||
<li>
|
||||
<a id="Nmap-attr-args"></a><li>
|
||||
<code>args <args></code><br>
|
||||
Arguments for the Nmap scan.<br>
|
||||
The default is "-sn".
|
||||
</li>
|
||||
<li>
|
||||
<a id="Nmap-attr-deleteOldReadings"></a><li>
|
||||
<code>deleteOldReadings <s></code><br>
|
||||
After a network scan, all host-specific readings older than <s>
|
||||
seconds are deleted
|
||||
</li>
|
||||
<li>
|
||||
<a id="Nmap-attr-devAlias"></a><li>
|
||||
<code>
|
||||
devAlias <ID>:<ALIAS> <ID2>:<ALIAS2> ...
|
||||
</code><br>
|
||||
@ -779,35 +781,35 @@ sub Nmap_updateUptime($$;$) {
|
||||
</code><br>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a id="Nmap-attr-disable"></a><li>
|
||||
<code>disable 1</code><br>
|
||||
A running scan is canceled and no new scans are started.
|
||||
</li>
|
||||
<li>
|
||||
<a id="Nmap-attr-excludeHosts"></a><li>
|
||||
<code>excludeHosts <target specification></code><br>
|
||||
All target hosts in the <target specification> are skipped during the scan.
|
||||
</li>
|
||||
<li>
|
||||
<a id="Nmap-attr-interval"></a><li>
|
||||
<code>interval <seconds></code><br>
|
||||
Interval in seconds in which the scan is performed.<br>
|
||||
The default value is 900 seconds and the minimum value is 30 seconds.
|
||||
</li>
|
||||
<li>
|
||||
<a id="Nmap-attr-keepReadings"></a><li>
|
||||
<code>keepReadings 1</code><br>
|
||||
If a new IP address is recognized for a device with a known MAC
|
||||
address, the invalid readings are deleted unless this attribute is set.
|
||||
</li>
|
||||
<li>
|
||||
<a id="Nmap-attr-leadingZeros"></a><li>
|
||||
<code>leadingZeros 1</code><br>
|
||||
For the readings, the IPv4 addresses are displayed with leading zeros.
|
||||
</li>
|
||||
<li>
|
||||
<a id="Nmap-attr-metaReading"></a><li>
|
||||
<code>metaReading <metaReading></code><br>
|
||||
You can specify "alias", "hostname", "ip" or "macAddress" as
|
||||
<metaReading> and is the identifier for the readings.<br>
|
||||
The default is "ip".
|
||||
</li>
|
||||
<li>
|
||||
<a id="Nmap-attr-path"></a><li>
|
||||
<code>path</code><br>
|
||||
Path under which the Nmap program is to be reached.<br>
|
||||
The default is "/urs/bin/nmap".
|
||||
@ -817,7 +819,7 @@ sub Nmap_updateUptime($$;$) {
|
||||
<u><code>readingFnAttributes</code></u>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a id="Nmap-attr-sudo"></a><li>
|
||||
<code>sudo 1</code><br>
|
||||
The scan runs with root privileges.<br>
|
||||
The prerequisite is that the user has these rights under the FHEM. For
|
||||
@ -834,9 +836,8 @@ sub Nmap_updateUptime($$;$) {
|
||||
|
||||
=begin html_DE
|
||||
|
||||
<a name="Nmap"></a>
|
||||
<a id="Nmap"></a>
|
||||
<h3>Nmap</h3>
|
||||
( <a href="commandref.html#Nmap"><u>en</u></a> | de )
|
||||
<div>
|
||||
<ul>
|
||||
Nmap ist das FHEM Modul um einen Netzwerkscan mit Nmap durchzuführen
|
||||
@ -859,8 +860,8 @@ sub Nmap_updateUptime($$;$) {
|
||||
installiert werden.
|
||||
</ul>
|
||||
<br>
|
||||
<a name="Nmapdefine"></a>
|
||||
<b>Define</b>
|
||||
<a id="Nmap-define"></a>
|
||||
<h4>Define</h4>
|
||||
<ul>
|
||||
<code>define <name> Nmap <target specification></code><br>
|
||||
In der <target specification> stehen alle Zielhosts, die gescannet
|
||||
@ -881,29 +882,29 @@ sub Nmap_updateUptime($$;$) {
|
||||
<a href="https://nmap.org/man/de/man-target-specification.html">
|
||||
<u>Nmap Man Page (Angabe von Zielen)</u>
|
||||
</a>.
|
||||
</ul><br>
|
||||
<a name="Nmapset"></a>
|
||||
<b>Set</b>
|
||||
</ul>
|
||||
<a id="Nmap-set"></a>
|
||||
<h4>Set</h4>
|
||||
<ul>
|
||||
<li>
|
||||
<a id="Nmap-set-clear"></a><li>
|
||||
<code>clear readings</code><br>
|
||||
Löscht alle Readings außer "state".
|
||||
</li>
|
||||
<li>
|
||||
<a id="Nmap-set-deleteOldReadings"></a><li>
|
||||
<code>deleteOldReadings <s></code><br>
|
||||
Löscht alle Readings die älter sind als <s> Sekunden.
|
||||
</li>
|
||||
<li>
|
||||
<a id="Nmap-set-interrupt"></a><li>
|
||||
<code>interrupt</code><br>
|
||||
Bricht einen laufenden Scan ab.
|
||||
</li>
|
||||
<li>
|
||||
<a id="Nmap-set-statusRequest"></a><li>
|
||||
<code>statusRequest</code><br>
|
||||
Startet einen Netzwerkscan.
|
||||
</li>
|
||||
</ul><br>
|
||||
<a name="Nmapreadings"></a>
|
||||
<b>Readings</b><br>
|
||||
</ul>
|
||||
<a id="Nmap-readings"></a>
|
||||
<h4>Readings</h4>
|
||||
<ul>
|
||||
Allgemeine Readings:
|
||||
<ul>
|
||||
@ -1001,11 +1002,11 @@ sub Nmap_updateUptime($$;$) {
|
||||
Netzwerkgerät erreichbar ist.
|
||||
</li>
|
||||
</ul>
|
||||
</ul><br>
|
||||
<a name="Nmapattr"></a>
|
||||
<b>Attribute</b>
|
||||
</ul>
|
||||
<a id="Nmap-attr"></a>
|
||||
<h4>Attribute</h4>
|
||||
<ul>
|
||||
<li>
|
||||
<a id="Nmap-attr-absenceThreshold"></a><li>
|
||||
<code>absenceThreshold <n></code><br>
|
||||
Die Anzahl an Netzwerkscans, welche in "absent" resultieren
|
||||
müssen, bevor der Status eines Netzwerkgeräts auf "absent"
|
||||
@ -1015,17 +1016,17 @@ sub Nmap_updateUptime($$;$) {
|
||||
ist, verbleibt das Reading "<metaReading>_state" auf "present",
|
||||
bis der Status final auf "absent" wechselt.
|
||||
</li>
|
||||
<li>
|
||||
<a id="Nmap-attr-args"></a><li>
|
||||
<code>args <args></code><br>
|
||||
Argumente für den Nmap-Scan.<br>
|
||||
Die Vorgabe ist "-sn".
|
||||
</li>
|
||||
<li>
|
||||
<a id="Nmap-attr-deleteOldReadings"></a><li>
|
||||
<code>deleteOldReadings <s></code><br>
|
||||
Nach einem Netzwerkscan werden alle hostspezifischen Readings, die
|
||||
älter sind als <s> Sekunden, gelöscht
|
||||
</li>
|
||||
<li>
|
||||
<a id="Nmap-attr-devAlias"></a><li>
|
||||
<code>
|
||||
devAlias <ID>:<ALIAS> <ID2>:<ALIAS2> ...
|
||||
</code><br>
|
||||
@ -1050,40 +1051,40 @@ sub Nmap_updateUptime($$;$) {
|
||||
</code><br>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a id="Nmap-attr-disable"></a><li>
|
||||
<code>disable 1</code><br>
|
||||
Ein laufender Scan wird abgebrochen und es werden keine neuen Scans
|
||||
gestartet.
|
||||
</li>
|
||||
<li>
|
||||
<a id="Nmap-attr-excludeHosts"></a><li>
|
||||
<code>excludeHosts <target specification></code><br>
|
||||
In der <target specification> stehen alle Zielhosts, die beim
|
||||
Scan übersprungen werden sollen.
|
||||
</li>
|
||||
<li>
|
||||
<a id="Nmap-attr-interval"></a><li>
|
||||
<code>interval <seconds></code><br>
|
||||
Intervall in Sekunden in dem der Scan durchgeführt wird.<br>
|
||||
Der Vorgabewert ist 900 Sekunden und der Mindestwert 30 Sekunden.
|
||||
</li>
|
||||
<li>
|
||||
<a id="Nmap-attr-keepReadings"></a><li>
|
||||
<code>keepReadings 1</code><br>
|
||||
Wird für ein Gertät mit bekannter MAC-Adresse eine neue IP-Adresse
|
||||
erkannt, werden die ungültig gewordenen Readings gelöscht es sei denn
|
||||
dieses Attribut ist gesetzt.
|
||||
</li>
|
||||
<li>
|
||||
<a id="Nmap-attr-leadingZeros"></a><li>
|
||||
<code>leadingZeros 1</code><br>
|
||||
Bei den Readings-Namen werden die IPv4-Adressen mit führenden
|
||||
Nullen dargestellt.
|
||||
</li>
|
||||
<li>
|
||||
<a id="Nmap-attr-metaReading"></a><li>
|
||||
<code>metaReading <metaReading></code><br>
|
||||
Als <metaReading> kann "alias", "hostname", "ip" oder
|
||||
"macAddress" angegeben werden und ist der Bezeichner für die
|
||||
Readings.<br>
|
||||
Die Vorgabe is "ip".
|
||||
</li>
|
||||
<li>
|
||||
<a id="Nmap-attr-path"></a><li>
|
||||
<code>path</code><br>
|
||||
Pfad unter dem das Nmap Programm zu erreichen ist.<br>
|
||||
Die Vorgabe ist "/urs/bin/nmap".
|
||||
@ -1093,7 +1094,7 @@ sub Nmap_updateUptime($$;$) {
|
||||
<u><code>readingFnAttributes</code></u>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a id="Nmap-attr-sudo"></a><li>
|
||||
<code>sudo 1</code><br>
|
||||
Der Scan wird mit Root-Rechten ausgeführt.<br>
|
||||
Voraussetzung ist, dass der Benutzer unter dem FHEM ausgeführt
|
||||
|
||||
Loading…
Reference in New Issue
Block a user