Skip to content

Commit f9421d0

Browse files
committed
Updated README.md and INSTALL.md.
1 parent acf6c32 commit f9421d0

File tree

2 files changed

+74
-44
lines changed

2 files changed

+74
-44
lines changed

INSTALL.md

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,42 @@
33

44
## Development framework
55

6-
To install esp-idf framework, follow the procedure avaiable here:
7-
8-
https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/#get-started-get-esp-idf
6+
Install the Espressif SDK:
7+
* Get Espressif's ESP-IDF framework (version 4.4.2) and install it (following the instructions at https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/)
8+
* In the installation of ESP-IDF, make sure you specify `-b v4.4.2` when cloning
9+
```
10+
mkdir -p ~/esp
11+
cd ~/esp
12+
git clone --recursive -b v4.4.2 https://github.com/espressif/esp-idf.git
13+
cd esp-idf/
14+
./install.sh esp32
15+
. ./export.sh
16+
idf.py --version
17+
```
18+
* Verify the output, it should be 4.4.2
919

1020
## Hackwatch projet
1121

1222
Clone the hackwatch project from github:
1323

1424
cd ~/esp/
15-
git clone --recurse-submodules https://github.com/virtualabs/hackwatch
25+
git clone --recurse-submodules https://github.com/virtualabs/hackwatch
26+
cd hackwatch
27+
28+
Customize feature and select T-Watch 2020 version:
29+
* `idf.py menuconfig`
30+
* To decide what feature (Wifi, BLE and/or IR):
31+
* Choose `HackWatch menu`
32+
* To select your T-Watch version:
33+
* Choose `Component config`
34+
* Go at the very bottom and pick `T-Watch Lib`
35+
* Select `Target T-Watch version` to choose between `T-Watch 2020 v1`, `v2` or `v3`
36+
* (S)ave and quit
1637

1738
## Compile
1839

1940
To compile the project
2041

21-
cd ~/esp/hackwatch
2242
idf.py build
2343

2444
## Flash
@@ -27,12 +47,12 @@ Start the watch then connect it in USB to the computer.
2747

2848
To flash the code execute this command:
2949

30-
idf.py -p /dev/ttyUSB0 -b 460800 flash
50+
idf.py -p <your USB port> flash
3151

32-
## Monitor
52+
## Debugging the firmware (monitor mode)
3353

3454
To monitor the execution:
3555

36-
idf.py -p /dev/ttyUSB0 monitor
56+
idf.py -p <your USB port> monitor
3757

3858

README.md

Lines changed: 46 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -29,42 +29,52 @@ T-Watch 2020 v2 is a bit diferent:
2929
T-Watch 2020 v3 is very similar to v1 but add:
3030
* PDM microphone
3131

32+
3233
How to build this project
3334
-------------------------
3435

35-
Install the Espressif SDK:
36-
* Get Espressif's ESP-IDF framework (version 4.4.2) and install it (following the instructions at https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/)
37-
* In the installation of ESP-IDF, make sure you specify `-b v4.4.2` when cloning
38-
```
39-
mkdir -p ~/esp
40-
cd ~/esp
41-
git clone --recursive -b v4.4.2 https://github.com/espressif/esp-idf.git
42-
cd esp-idf/
43-
./install.sh esp32
44-
. ./export.sh
45-
idf.py --version
46-
```
47-
* Verify the output, it should be 4.4.2
48-
49-
Clone the main repo:
50-
```
51-
git clone https://github.com/virtualabs/hackwatch
52-
cd hackwatch/
53-
git submodule update --init --recursive
54-
```
55-
56-
57-
Customize feature and select T-Watch 2020 version:
58-
* `idf.py menuconfig`
59-
* To decide what feature (Wifi, BLE and/or IR):
60-
* Choose `HackWatch menu`
61-
* To select your T-Watch version:
62-
* Choose `Component config`
63-
* Go at the very bottom and pick `T-Watch Lib`
64-
* Select `Target T-Watch version` to choose between `T-Watch 2020 v1`, `v2` or `v3`
65-
* (S)ave and quit
66-
67-
68-
Compile and Flash your watch:
69-
* type `idf.py build` to build this project
70-
* type `idf.py -p <your USB port> flash` to also flash your smartwatch
36+
See [INSTALL](INSTALL.md).
37+
38+
39+
How to use it
40+
-------------
41+
42+
Once flashed, the watch will restart and display the current time and date. Swipe left or right to browse the
43+
main categories, swipe up on a category screen to access the different tools/screens available. Basically,
44+
categories/tools navigation is done by swiping the screen :).
45+
46+
Pressing the button on the right side of the watch will bring you back to the current category and then to
47+
the main screen. If this button is pressed when on the main screen (clock), the watch will go in deep sleep
48+
mode and can be wake up by pressing the button again.
49+
50+
Provided tools
51+
--------------
52+
53+
### WiFi
54+
55+
This smartwatch provides a real-time WiFi network scanner, a WiFi channel scanner, a rogue AP generator and
56+
a WiFi deauth tool.
57+
58+
The WiFi Scanner shows a list of available wireless access points, along with their RSSI levels and MAC
59+
addresses. Information about security and channel can be displayed when an access point is selected.
60+
61+
The WiFi channel scanner simply loops on every possible channel and shows the *activity*. It could be useful
62+
to find less noisy channels when setting up a WiFi network.
63+
64+
The WiFi Rogue AP generator provides a way to spoof a specific WiFi access point (previously selected) in
65+
order to force stations to connect to it instead of the legitimate access point. Security is set to open by
66+
default, and no IP will be provided on connection (no DHCP server started, and no web server).
67+
68+
The WiFi Deauth tool allows you to automatically disconnect every connected station from a given WiFi
69+
network. This is quite similar to other projects like [ESP32 WiFi Penetration tool](https://github.com/risinek/esp32-wifi-penetration-tool) or [ESP32 Deauther](https://github.com/GANESH-ICMC/esp32-deauther).
70+
71+
### Bluetooth Low Energy
72+
73+
The smartwatch includes a BLE scanner that performs fingerprinting of detected devices and classifying
74+
them in various categories (watch, health device, audio, etc.). It also provides a dedicated feature
75+
to retrieve the Bluetooth Low Energy baseband vendor and software version (using BLE LL_VERSION_IND PDU).
76+
77+
### Infrared
78+
79+
A TV-B-Gone feature has been added to the watch. It can be started from the Infrared tool, and kept active
80+
while the watch still remains on its main screen (stealth mode :D).

0 commit comments

Comments
 (0)