Add example usage to readme
This commit is contained in:
parent
46cf56767e
commit
65534e966c
25
README.md
25
README.md
@ -1,3 +1,26 @@
|
|||||||
# embedded-bt-rssi-monitor
|
# embedded-bt-rssi-monitor
|
||||||
|
|
||||||
A bluetooth RSSI monitor to run on a tiny system such as a microcontroller or single board computer.
|
A bluetooth RSSI monitor to run on a tiny system such as a microcontroller or single board computer.
|
||||||
|
|
||||||
|
|
||||||
|
### Usage
|
||||||
|
|
||||||
|
Configure env.sh with the devices you want to monitor. The environment variables must have an _%d suffix, in series, starting from 0.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
#/bin/bash
|
||||||
|
|
||||||
|
export btmacaddress_0="69:42:69:FF:04:20" # your phone
|
||||||
|
export btmacaddress_1="0F:F0:0F:F6:44:55" # your smart watch
|
||||||
|
export btmacaddress_2="0F:44:24:F5:69:69" # your tablet
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
Then source the env.sh file to load the variables, build the program with go and then run it.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
|
||||||
|
source env.sh
|
||||||
|
go build . && ./embedded-bt-rssi-monitor
|
||||||
|
|
||||||
|
```
|
Loading…
Reference in New Issue
Block a user