franjsco/lscanbot
1
0
Fork 0
mirror of https://github.com/franjsco/lscanbot synced 2025-02-21 05:50:35 +01:00
Code Issues Releases Wiki Activity

edit README

Browse Source
This commit is contained in:
Francesco Esposito 2019-02-12 22:52:46 +01:00
parent 5824f3abc2
commit acdc619067
2 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -2,18 +2,25 @@
An opensource telegram bot to find devices on your LAN. An opensource telegram bot to find devices on your LAN.
<img src="screenshot.png" height="400">
The bot is written in Node.js. The bot is written in Node.js.
## Usage ## Usage
**lscanbot** scans devices with arp-scan, showing only devices registered in the inventory. **lscanbot** scans devices with arp-scan, showing only devices registered in the inventory.
### Scan
Before scanning, you must insert the devices into the inventory (to track it): Before scanning, you must insert the devices into the inventory (to track it):
> /add [Device name] ; [Owner] ; [MAC Address] > /add [Device name] ; [Owner] ; [MAC Address]
(use `;` to split arguments) (use `;` to split arguments)
example: (/add My device; Me; AB:CC:MY:MC:AD)
After that, you can scan: After that, you can scan:
>/scan >/scan
@ -21,9 +28,12 @@ After that, you can scan:
It will send back the devices connected to your network. It will send back the devices connected to your network.
### Remove
> /remove [MAC Address]
## Installation ## Installation
In order to use this bot is required that the code is hosted on a linux system connected to your LAN (Raspberry Pi would be a good choice) In order to use this bot is required that the code is hosted on a GNU/Linux system connected to your LAN (Raspberry Pi would be a good choice)
### Prerequisites ### Prerequisites
@ -49,4 +59,4 @@ In order to use this bot is required that the code is hosted on a linux system c
GPLv3 GPLv3
--- ---
Made with ❤️ by Francesco Esposito ([@f3sposito](https://github.com/f3sposito)) Made with ❤️ by Francesco Esposito ([@frab1t](https://github.com/frab1t))

BIN
screenshot.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 476 KiB