home-assistant / core

:house_with_garden: Open source home automation that puts local control and privacy first.
https://www.home-assistant.io
Apache License 2.0
73.98k stars 31.02k forks source link

Incomplete/confusing documentation of NMAP integration #129446

Open carefulcomputer opened 4 weeks ago

carefulcomputer commented 4 weeks ago

The problem

NMAP tracker integration documentation lists two fields -

  1. Minimum Number of minutes between scans
  2. Scan Interval The webpage explains the purpose of 1 as "Frequency of the scans. The lower the number, the quicker it will detect devices connected and disconnected usually at the cost of the devices battery life. The example above will scan every minute." However there is no explanation of 2 (Scan Interval) and just by look at name of field, it seems to be duplicate of (1). Please update the webpage to clarify the difference in these fields, if any. If not , please remove the second field.

What version of Home Assistant Core has the issue?

2024.10.3

What was the last working version of Home Assistant Core?

No response

What type of installation are you running?

Home Assistant Container

Integration causing the issue

Nmap Tracker

Link to integration documentation on our website

https://www.home-assistant.io/integrations/nmap_tracker

Diagnostics information

image

Shows two fields which seem to be duplicate.

Example YAML snippet

No response

Anything in the logs that might be useful for us?

No response

Additional information

No response

home-assistant[bot] commented 4 weeks ago

nmap_tracker documentation nmap_tracker source