From b62136161df0b4389b49e254b2bc83769d22793a Mon Sep 17 00:00:00 2001 From: rudolfkoenig Date: Mon, 7 Feb 2022 09:14:08 +0000 Subject: [PATCH] 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 --- fhem/FHEM/59_LuftdatenInfo.pm | 88 ++++++++++++------------- fhem/FHEM/74_Nmap.pm | 117 +++++++++++++++++----------------- 2 files changed, 103 insertions(+), 102 deletions(-) diff --git a/fhem/FHEM/59_LuftdatenInfo.pm b/fhem/FHEM/59_LuftdatenInfo.pm index 982a58f7c..9bf23d5e3 100644 --- a/fhem/FHEM/59_LuftdatenInfo.pm +++ b/fhem/FHEM/59_LuftdatenInfo.pm @@ -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 - +

LuftdatenInfo

-(en | de)
-
- - Define + +

Define


- - Set + + +

Set

    -
  • +
  • statusRequest
    Starts a status request.
    • -

- - Get + + +

Get

    -
  • +
  • sensors
    Lists all senors.
    • -

- - Readings
+ + +

Readings


  • - airQuality + airQuality
    1 => good
    2 => moderate
    3 => unhealthy for sensitive groups
    @@ -707,11 +708,11 @@ sub LuftdatenInfo_statusRequest($) { UVRisk
    UV risk from 1 to 5
    • -

- - Attribute + + +

Attributes

    -
  • +
  • disable 1
    No queries are started.
    • @@ -720,12 +721,12 @@ sub LuftdatenInfo_statusRequest($) { disabledForIntervals HH:MM-HH:MM HH:MM-HH-MM ... -
  • +
  • interval <seconds>
    Interval in seconds in which queries are performed.
    The default and minimum value is 300 seconds for remote request and 30 seconds for local requests.
    • -
  • +
  • timeout <seconds>
    Timeout in seconds for the queries.
    The default and minimum value is 5 seconds. @@ -738,9 +739,8 @@ sub LuftdatenInfo_statusRequest($) { =begin html_DE - +

    LuftdatenInfo

    -(en | de)
      LuftdatenInfo ist das FHEM Modul um Feinstaub-, Temperatur- und @@ -761,8 +761,8 @@ sub LuftdatenInfo_statusRequest($) { "apt-get install libjson-perl" installiert werden.

    - - Define + +

    Define

      define <name> LuftdatenInfo remote @@ -783,28 +783,28 @@ sub LuftdatenInfo_statusRequest($) { Hostname angegeben werden.
      Werden mehrere ähnliche Sensoren betrieben lassen sich die doppelten Werte in einem anderen Gerät geschrieben werden. -

    - - Set +
+ +

Set

    -
  • +
  • statusRequest
    Startet eine Abfrage der Daten.
    • -

- - Get + + +

Get

    -
  • +
  • sensors
    Listet alle Sensoren auf.

- - Readings
+ +

Readings


  • - airQuality + airQuality
    1 => gut
    2 => mittelmä&suml;ig
    3 => ungesund für empfindliche Menschen
    @@ -890,11 +890,11 @@ sub LuftdatenInfo_statusRequest($) { UVRisk
    UV Risiko von 1 bis 5
    • -

- - Attribute + + +

Attribute

    -
  • +
  • disable 1
    Es werden keine Abfragen mehr gestartet.
    • @@ -903,12 +903,12 @@ sub LuftdatenInfo_statusRequest($) { disabledForIntervals HH:MM-HH:MM HH:MM-HH-MM ... -
  • +
  • interval <seconds>
    Intervall in Sekunden in dem Abfragen durchgeführt werden.
    Der Vorgabe- und Mindestwert beträgt 300 Sekunden für remote Abfragen und 30 Sekunden für local Abfragen.
    • -
  • +
  • timeout <seconds>
    Timeout in Sekunden für die Abfragen.
    Der Vorgabe- und Mindestwert beträgt 5 Sekunden. diff --git a/fhem/FHEM/74_Nmap.pm b/fhem/FHEM/74_Nmap.pm index 7c986c486..85cd73729 100644 --- a/fhem/FHEM/74_Nmap.pm +++ b/fhem/FHEM/74_Nmap.pm @@ -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 - +

    Nmap

    -( en | de )
      Nmap is the FHEM module to perform a network scan with Nmap and to display information about the available network devices.
      @@ -596,8 +598,8 @@ sub Nmap_updateUptime($$;$) { .

    - - Define + +

    Define

      define <name> Nmap <target specification>
      In the <target specification> are all target hosts, which are to be @@ -616,29 +618,29 @@ sub Nmap_updateUptime($$;$) { Nmap Manpage (Specifying Destinations) . -

    - - Set +
+ +

Set

    -
  • +
  • clear readings
    Deletes all readings except "state".
    • -
  • +
  • deleteOldReadings <s>
    Deletes all readings older than <s> seconds.
    • -
  • +
  • interrupt
    Cancels a running scan.
    • -
  • +
  • statusRequest
    Starts a network scan.
    • -

- - Readings
+ + +

Readings

    General Readings:
      @@ -733,11 +735,11 @@ sub Nmap_updateUptime($$;$) { device is reachable.
    -

- - Attribute + + +

Attributes

    -
  • +
  • absenceThreshold <n>
    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".
    • -
  • +
  • args <args>
    Arguments for the Nmap scan.
    The default is "-sn".
    • -
  • +
  • deleteOldReadings <s>
    After a network scan, all host-specific readings older than <s> seconds are deleted
    • -
  • +
  • devAlias <ID>:<ALIAS> <ID2>:<ALIAS2> ...
    @@ -779,35 +781,35 @@ sub Nmap_updateUptime($$;$) {
-
  • +
  • disable 1
    A running scan is canceled and no new scans are started.
    • -
  • +
  • excludeHosts <target specification>
    All target hosts in the <target specification> are skipped during the scan.
    • -
  • +
  • interval <seconds>
    Interval in seconds in which the scan is performed.
    The default value is 900 seconds and the minimum value is 30 seconds.
    • -
  • +
  • keepReadings 1
    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.
    • -
  • +
  • leadingZeros 1
    For the readings, the IPv4 addresses are displayed with leading zeros.
    • -
  • +
  • metaReading <metaReading>
    You can specify "alias", "hostname", "ip" or "macAddress" as <metaReading> and is the identifier for the readings.
    The default is "ip".
    • -
  • +
  • path
    Path under which the Nmap program is to be reached.
    The default is "/urs/bin/nmap". @@ -817,7 +819,7 @@ sub Nmap_updateUptime($$;$) { readingFnAttributes
    • -
  • +
  • sudo 1
    The scan runs with root privileges.
    The prerequisite is that the user has these rights under the FHEM. For @@ -834,9 +836,8 @@ sub Nmap_updateUptime($$;$) { =begin html_DE - +

    Nmap

    -( en | de )
      Nmap ist das FHEM Modul um einen Netzwerkscan mit Nmap durchzuführen @@ -859,8 +860,8 @@ sub Nmap_updateUptime($$;$) { installiert werden.

    - - Define + +

    Define

      define <name> Nmap <target specification>
      In der <target specification> stehen alle Zielhosts, die gescannet @@ -881,29 +882,29 @@ sub Nmap_updateUptime($$;$) { Nmap Man Page (Angabe von Zielen) . -

    - - Set + + +

    Set

      -
    • +
    • clear readings
      Löscht alle Readings außer "state".
      • -
    • +
    • deleteOldReadings <s>
      Löscht alle Readings die älter sind als <s> Sekunden.
      • -
    • +
    • interrupt
      Bricht einen laufenden Scan ab.
      • -
    • +
    • statusRequest
      Startet einen Netzwerkscan.
      • -

    - - Readings
    + + +

    Readings

      Allgemeine Readings:
        @@ -1001,11 +1002,11 @@ sub Nmap_updateUptime($$;$) { Netzwerkgerät erreichbar ist.
      -

    - - Attribute + + +

    Attribute

      -
    • +
    • absenceThreshold <n>
      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.
      • -
    • +
    • args <args>
      Argumente für den Nmap-Scan.
      Die Vorgabe ist "-sn".
      • -
    • +
    • deleteOldReadings <s>
      Nach einem Netzwerkscan werden alle hostspezifischen Readings, die älter sind als <s> Sekunden, gelöscht
      • -
    • +
    • devAlias <ID>:<ALIAS> <ID2>:<ALIAS2> ...
      @@ -1050,40 +1051,40 @@ sub Nmap_updateUptime($$;$) {
    • -
  • +
  • disable 1
    Ein laufender Scan wird abgebrochen und es werden keine neuen Scans gestartet.
    • -
  • +
  • excludeHosts <target specification>
    In der <target specification> stehen alle Zielhosts, die beim Scan übersprungen werden sollen.
    • -
  • +
  • interval <seconds>
    Intervall in Sekunden in dem der Scan durchgeführt wird.
    Der Vorgabewert ist 900 Sekunden und der Mindestwert 30 Sekunden.
    • -
  • +
  • keepReadings 1
    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.
    • -
  • +
  • leadingZeros 1
    Bei den Readings-Namen werden die IPv4-Adressen mit führenden Nullen dargestellt.
    • -
  • +
  • metaReading <metaReading>
    Als <metaReading> kann "alias", "hostname", "ip" oder "macAddress" angegeben werden und ist der Bezeichner für die Readings.
    Die Vorgabe is "ip".
    • -
  • +
  • path
    Pfad unter dem das Nmap Programm zu erreichen ist.
    Die Vorgabe ist "/urs/bin/nmap". @@ -1093,7 +1094,7 @@ sub Nmap_updateUptime($$;$) { readingFnAttributes
    • -
  • +
  • sudo 1
    Der Scan wird mit Root-Rechten ausgeführt.
    Voraussetzung ist, dass der Benutzer unter dem FHEM ausgeführt