README fixes

This commit is contained in:
Jonathan Flueren 2023-08-13 22:12:47 +02:00
parent 43574afcbc
commit be246fee21
3 changed files with 8 additions and 11 deletions

View file

@ -1,14 +1,16 @@
# CZI presence detector
Tool to detect the presence of pre-defined devices by their WiFi MAC addresses.
## How it works
Sets the wifi adapter into monitor mode, then listens to surrounding packets listing all detected devices into `wifi_map.yaml`. Resets the wifi adapter to normal mode for uploading the results, filters the results by the mac addresses in `identities.yaml` and sends all matched identities to the front-end webhook server in `public`. This server stores the presence information locally and displays it with `public/index.php` with a timestamp of the last update.
## How scanning works
Sets the wifi adapter into monitor mode, then listens to surrounding packets listing all detected devices into `wifi_map.yaml`. Resets the wifi adapter to normal mode for uploading the results, filters the results by the mac addresses in `identities.yaml` and sends all matched identities to the front-end webhook server in `website`. This server stores the presence information locally and displays it with `website/index.php` with a timestamp of the last update.
## What the website is capable of
Shows the last update of the `upload.py` routine. It also allows to add identities by their name and mac and to delete identities by their mac. The mac addresses are hashed server-side and then stored into the world-accessible `identities.json`.
## Set-up
Dependencies: Python3, trackerjacker (pip3), php (front-end)
Configs to change:
- wifi adapter in `scan.sh`
- system-specific wifi commands in `scan.sh`
- identities URL in `upload.py`
- webhook URL and secret in `upload.py`
- webhook secret in `public/update.php`
- mac-name-identities in `identities.yaml`
- webhook secret in `public/update.php`

View file

@ -1,5 +0,0 @@
identities:
- mac: 00:00:00:00:00:00
name: Jon
- mac: ff:ff:ff:ff:ff:ff
name: BROADCAST

View file

@ -1 +1 @@
[{"name":"Jon","mac_hash":"38fbdde984330e50c02382e647c576b71f41cc5c45b193d4f3177e6ee8f22a78"},{"name":"BROADCAST","mac_hash":"ef85d972b07fccdd79085ddb4713cd487c3838e128a7c4d11092909675c2022d"}]
[{"name":"Null","mac_hash":"38fbdde984330e50c02382e647c576b71f41cc5c45b193d4f3177e6ee8f22a78"},{"name":"BROADCAST","mac_hash":"ef85d972b07fccdd79085ddb4713cd487c3838e128a7c4d11092909675c2022d"}]