From ec10c9f96257a003c8ee510a52aa95e3ca2f6e93 Mon Sep 17 00:00:00 2001 From: pucherot Date: Sat, 9 Jan 2021 21:08:05 +0100 Subject: [PATCH] Doc --- README.md | 45 ++-------------------------- doc/DEVICE_MANAGEMENT.md | 64 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 66 insertions(+), 43 deletions(-) create mode 100644 doc/DEVICE_MANAGEMENT.md diff --git a/README.md b/README.md index eea39bb8..a7b81e11 100644 --- a/README.md +++ b/README.md @@ -71,51 +71,10 @@ Linux distributions. [Instructions](doc/INSTALL.md) -# Device Management +## 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 - - Go to the device page by clicking on the device name or status - - Press "Details" tab of the device - - Edit the 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)* + [Device Management](doc/DEVICE_MANAGEMENT.md) ## Other useful info diff --git a/doc/DEVICE_MANAGEMENT.md b/doc/DEVICE_MANAGEMENT.md new file mode 100644 index 00000000..a2f2dae5 --- /dev/null +++ b/doc/DEVICE_MANAGEMENT.md @@ -0,0 +1,64 @@ +# Pi.Alert - 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 + - Go to the device page by clicking on the device name or status + - Press "Details" tab of the device + - Edit the device data + - Press the "Save" button + + +![Device Details][screen1] + + +## 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)* + +### License + GPL 3.0 + [Read more here](LICENSE.txt) + +### Contact + pi.alert.application@gmail.com + + ***Suggestions and comments are welcome*** + + + +[main]: ./img/1_devices.jpg "Main screen" +[screen1]: ./img/2_1_device_details.jpg "Screen 1" +