From 2fd1e6f406a8d1c0f978267bc008dab417739a23 Mon Sep 17 00:00:00 2001 From: pucherot Date: Sat, 9 Jan 2021 15:04:15 +0100 Subject: [PATCH] Update README.md --- README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) diff --git a/README.md b/README.md index 9611d612..2c226974 100644 --- a/README.md +++ b/README.md @@ -71,6 +71,52 @@ Linux distributions. [Instructions](doc/INSTALL.md) +# Device Management + +To edit device information: + - Select "Devices" in the menu on the left of the screen + - Find the device you want to edit in the central table + - Access the device by clicking on the name or status + - Activate the "Details" tab of the device + - edit device data + - Press the "Save" button + +### Main Info + - **MAC**: MAC addres of the device. Not editable. + - **Name**: Friendly device name + - **Owner**: Device owner (The list is self-populated with existing owners) + - **Type**: Select a device type from the dropdown list (Smartphone, Table, + Laptop, TV, router, ....) or type a new device type + - **Vendor**: Automatically updated by Pi.Alert + - **Favorite**: Mark the device as favorite and then it will appears at the + begining of the device list + - **Group**: Select a grouper ('Always on', 'Personal', Friends') or type + your own Group name + - **Comments**: Type any comments for the device + +### Session Info + - **Status**: Show device status : On-line / Off-Line + - **First Session**: Date and time of the first connection + - **Last Session**: Date and time of the last connection + - **Last IP**: Last known IP used during the last connection + - **Static IP**: Check this box to identify devices that always use the + same IP + +### Events & Alerts config + - **Scan Cycle**: Select the scan cycle: 0, 1', 15'. Some devices do not + respond to all ARP packets, for this cases is better to use a 15' cycle. + ***For apple devices I recommend using 15' cycle*** + - **Alert All Events**: Send a notification in each event (connection, + disconnection, IP Changed, ...) + - **Alert Down**: Send a notification when the device is down + *(userful with "always connected" devices: Router, AP, Camera, Alexa, + ...)* + - **Skip repeated notifications during**: Do not send more than one + notification to this device for X hours + *(useful to avoid notification saturation on devices that frequently + connects and disconnects) + + ## Other useful info