Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding more detail to docs #16

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Adding more detail to docs #16

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
35196c1
Update README.md
clutchdude May 28, 2023
a9dcc85
Update README.md
clutchdude May 28, 2023
24f71ae
Update README.md
clutchdude May 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 23 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,26 @@ A detailed writeup about how this works will probably be here at some point.

Lightleak is used together with the [Cloudcutter Android](https://github.com/tuya-cloudcutter/cloudcutter-android) application. Currently, there's no other way to use it.

Additionally, you need a device (ESP32/ESP8266/BK7231 or RTL8710B with LibreTuya) to serve as a dummy Wi-Fi Access Point - hereinafter referred to as `CustomAP device`. This will be configured and used by the Android app throughout the process. The [`platformio-custom-ap`](https://github.com/tuya-cloudcutter/lightleak/tree/master/platformio-custom-ap) directory contains a PlatformIO project that can be compiled on any of the platforms mentioned above. You need to download this code, build it, and upload to your device of choice.
Additionally, you need a device (ESP32/ESP8266 with USB or OTA update capable firmware OR BK7231/RTL8710B with LibreTuya) to serve as a dummy Wi-Fi Access Point - hereinafter referred to as `CustomAP device`. This will be configured and used by the Android app throughout the process. The [`platformio-custom-ap`](https://github.com/tuya-cloudcutter/lightleak/tree/master/platformio-custom-ap) directory contains a PlatformIO project that can be compiled on any of the platforms mentioned above. You need to download this code, build it, and upload to your device of choice - please note that the device you choose WILL NOT be OTA flashable after this. It's advised to get a cheap ESP32 chipset with USB before proceeding.

### Compiling & Installing CustomAP firmware

The easiest way to compile the CustomAP firmware is to install visual studio code and install the PlatformIO extension. You can find full instructions here: https://platformio.org/platformio-ide

Once installed, open the IDE and select the chip you want to build the custom firmware for from the IDE menu - it should automatically happen. Once, built, the firmware will appear in your local directory, such as 'lightleak/platformio-custom-ap/.pio/build/esp8266/firmware.bin`

If you do not have an idle ESP chipset, you can temporarily change an ESPHome device by configuring the webserver component:

```
web_server:
port: 80
```

This will then allow you to manually upload the CustomAP firmware. Just be aware that you will **not** be able to OTA flash the device back after this.

Once installed, check that the LightleakIdle AP is visible before proceeding but do not connect to it.

###

Plug in the CustomAP device and make sure it works (a `LightleakIdle` Wi-Fi network should be available - scan with your smartphone or laptop). Do not connect to the network manually.

Expand All @@ -24,12 +43,14 @@ Plug in the CustomAP device and make sure it works (a `LightleakIdle` Wi-Fi netw
- [Install the app](https://github.com/tuya-cloudcutter/cloudcutter-android/blob/master/README.md).
- Go to `App Info` (Android settings), choose `Permissions` and grant the `Location` permission (it's required for Wi-Fi connecting and scanning). **The app won't ask for it yet, so you have to grant it manually.**
- Before running the process, ensure you have both Wi-Fi and Location enabled (otherwise it'll just fail silently, waiting forever and timing out).
- It may be helpful to "Forget" any local wifi networks. Your phone may try to join those while running the app, causing unexepected failures. You can add them back afterwards.
- Open the app. Select one of the Lightleak profiles (depending on the CPU of your device). If you don't know the CPU you have, you can try all the profiles, one by one. Trying an incompatible profile will not brick the device; it will just freeze and reboot after ~60 seconds.
- Read the message about choosing device state.
- If it's the first time exploiting a particular device, choose `Unconfigured`. Other options are too hard to explain here, so just don't use them please.
- It will first connect to and configure the CustomAP device.
- **Note 1:** Android (10+) will probably ask you when first connecting to a network. There will be a dialog message with the network name. You can just click the name or press `Connect`.
- **Note 2:** if the entire process fails at any point, please reset the CustomAP device before trying it again.
- **Note 2:** if the entire process fails at any point, please reset/unplug the CustomAP device before trying it again
- **Note 3:** If you are having issues joining the Smart Device AP during the process, check if the wifi network shows "Access point is temporarily full" - if so, cycle the smart device. If it starts in slow-blink, the app should proceed. Otherwise start over.
- Look carefully at the message window at the bottom, and do what it says. It will tell you when it's time to reboot the target device into AP mode.
- If the process completes successfully, another window will open. Currently, it allows you to dump flash contents of the device.
- Pressing `Read flash` should download the entire 2 MiB of flash, saving it to the directory of choice. It should take around 30-40 seconds.
Expand Down