Update README.md

This commit is contained in:
Michael Smith 2018-03-09 14:34:09 +01:00 committed by GitHub
parent 004a83846b
commit 75153304f4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,13 +1,16 @@
# ESPerPass
A 3DS HomePass implementation for the ESP8266 programmable WiFi chip.
Inspired by [this reddit post](https://www.reddit.com/r/3DS/comments/80k0qb/homepass_for_cheap_using_an_esp8266/)
and largely based on the great work done by [Martin Ger's ESP WiFi Repeater](https://github.com/martin-ger/esp_wifi_repeater).
and largely based on the great work done by [Martin Ger and his ESP WiFi Repeater](https://github.com/martin-ger/esp_wifi_repeater).
## Instructions (need improvement)
1. Flash firmware.
2. Connect ESP8266 to USB and connect with terminal program.
3. Power cycle ESP8266.
3. Follow instructions in terminal program.
## Instructions (needs improvement)
1. Get an ESP8266 based WiFi module. I use a [Wemos D1 mini](https://www.aliexpress.com/item/ESP8266-ESP12-ESP-12-WeMos-D1-Mini-WIFI-Dev-Kit-Development-Board-NodeMCU-Lua/32653918483.html).
2. Get the firmware. You need [this bin file](https://github.com/michaelshmitty/esperpass/raw/master/firmware/0x00000.bin) and [this one](https://github.com/michaelshmitty/esperpass/raw/master/firmware/0x00000.bin).
3. Flash the binary firmware files to the ESP8266 module with the esptool.py software. I use the following parameters: esptool.py --port /dev/tty.wchusbserial1420 write_flash -fs 32m -ff 80m -fm dio 0x00000 0x00000.bin 0x10000 0x10000.bin.
Replace /dev/tty.wchusbserial1420 with your ESP usb to serial.
4. Connect ESP8266 to USB and connect with a terminal program at 115200 baud.
5. Power cycle ESP8266.
6. Follow instructions in the terminal program to configure your WiFi Internet connection.
## TODO
* Implement firewall rules to restrict connections to official servers.