Skip to content

Commit 9e38079

Browse files
committed
docs: add readme file
1 parent ae8d367 commit 9e38079

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# MAC Address Device Tracker
2+
3+
MAC address device tracker for Home Assistant. Most codes are derived from [@mudape's iPhone Detect](https://github.com/mudape/iphonedetect).
4+
5+
## Installation
6+
7+
### Git clone from GitHub
8+
9+
```shell
10+
cd config
11+
git clone https://github.com/Timandes/mac-address-device-tracker.git
12+
cd mac-address-device-tracker
13+
./install.sh /config
14+
```
15+
16+
Then restart Home Assistant.
17+
18+
Update for vx.x.x:
19+
20+
```shell
21+
cd config/mac-address-device-tracker
22+
git fetch
23+
git checkout vx.x.x
24+
./install.sh /config
25+
```
26+
27+
### Configuration
28+
29+
Open and edit configuration.yaml located in `/config` directory:
30+
31+
```yaml
32+
device_tracker:
33+
- platform: mac_address_device_tracker
34+
consider_home: 180
35+
scan_interval: 12
36+
hosts:
37+
daddy: 9C:A6:92:99:98:D2
38+
mommy: 98:7F:53:56:1C:9E
39+
```
40+
41+
Restart Home Assistant. That will create entities named `device_tracker.daddy` and `device_tracker.mommy`.
42+
43+

0 commit comments

Comments
 (0)