https://github.com/jarikai/homenetworkmonitor
Get local network hosts information to Homeassistant from other server in your network running Nmap
https://github.com/jarikai/homenetworkmonitor
home network network-analysis nmap nmap-parser
Last synced: 18 days ago
JSON representation
Get local network hosts information to Homeassistant from other server in your network running Nmap
- Host: GitHub
- URL: https://github.com/jarikai/homenetworkmonitor
- Owner: jarikai
- License: mit
- Created: 2025-12-10T16:19:46.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2026-01-20T06:48:33.000Z (23 days ago)
- Last Synced: 2026-01-20T14:59:45.233Z (23 days ago)
- Topics: home, network, network-analysis, nmap, nmap-parser
- Language: C#
- Homepage:
- Size: 368 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Home Assistant Home Network Monitor integration
This Home Assistant integration provides a [Nmap](https://nmap.org/) network scanner information of all devices on your local network.
## Why?
This integration was made to save server resources on Home Assistant server by running Nmap in the other server. User can setup the other server for scanning with their own needs with available resources. After you have working configuration you can make automations to get you local network more secure. Examples:
- Alert when unknown device is found in your network
- Alert when security risk in your device is found
- Alert when important device is down
## Features
- Automatically updates the list of devices on a periodic basis.
- Displays the total number of devices currently identified on the network.
- Displays the last scanning time.
## Nmap Server installation
Before you can use the integration, you need to have the server configured in your local network for scanning and sharing the json data. Official [Nmap](https://nmap.org/) does not provide the json output, so i made the [dotnet commandline application](dotnet/nmapxml2json/README.md) to convert Nmap xml output to json. If you need to use other methos to convert xml, the json data needs to be in this format:
***
```json
{
"scaninfo": null,
"verbose": null,
"debugging": null,
"hosthint": null,
"host": [
{
"status": {
"state": "up",
"reason": "localhost",
"reason_ttl": 0
},
"address": [
{
"addr": "127.0.0.1",
"addrtype": "ipv4",
"vendor": null
}
],
"hostnames": {},
"ports": {
"extraports": null,
"port": null
},
"os": null,
"uptime": null,
"distance": null,
"tcpsequence": null,
"ipidsequence": null,
"tcptssequence": null,
"hostscript": null,
"trace": null,
"times": null,
"starttime": 1616161616,
"endtime": 1616161620
}
],
"postscript": null,
"runstats": {
"finished": {
"time": 1616161620,
"timestr": "Wed Mar 17 12:00:00 2021",
"summary": "Nmap done at Wed Mar 17 12:00:00 2021; 1 IP address (1 host up) scanned in 4.00 seconds",
"elapsed": 4.00,
"exit": "success"
},
"hosts": {
"up": 1,
"down": 0,
"total": 1
}
},
"scanner": "nmap",
"args": "-sV -oX test.xml scanme.nmap.org",
"start": 1616161616,
"startstr": null,
"version": 7.0,
"xmloutputversion": 1.0
}
```
***
Server configuration:
1. Install the Nmap with your server’s installation method
2. If your server has no web server installed, install nginx or what ever web server that can output json
3. Create shell script to run the Nmap and xml to json conversion. I have this in my script:
***
```sh
nmap -sS -sV --version-intensity 7 -O -p- --script "default,vuln" --host-timeout 60s -oX /tmp/local_network.xml 192.168.1.0/24
dotnet /opt/kaipio/nmap/nmapxml2json.dll /tmp/local_network.xml /var/www/html/data/local_network.json
```
***
4. Test that the script is working by running it manually
5. Add script to crontab. I have this in my server:
```crontab
*/20 * * * * /opt/kaipio/nmap/script/gen_localmap.sh
```
## Installation through HACS (NOT AVAILABLE UNTIL THIS COMMENT IS REMOVED)
To install the homenetworkmonitor integration using HACS:
1. Open Home Assistant, go to HACS -> Integrations.
2. Search for Nmap Localnetwork and install it.
3. Restart Home Assistant.
4. After restart, add the integration from Settings -> Devices & services -> Add integration and add configuration, when asked. You need to have the whole URL to the json output and username & password if they are required.
## Manual Installation
To install this integration manually:
1. Copy the homenetworkmonitor directory into the custom_components directory of your Home Assistant installation.
2. Restart Home Assistant.
3. After restart, add the integration from Settings -> Devices & services -> Add integration and add configuration, when asked. You need to have the whole URL to the json output and username & password if they are required.
## TODO
1. Make changes to be approved to HACS
## Contributing
Contributions to this integration are welcome. Please refer to the project's GitHub repository for contributing guidelines.