mirror of
https://gitlab.com/zwirbel/illucat.git
synced 2025-12-15 17:58:20 +01:00
83 lines
2.4 KiB
Markdown
83 lines
2.4 KiB
Markdown
# Installation
|
|
|
|
## Initial Setup (TODO)
|
|
- download and flash firmware and filesystem
|
|
- or: rename example.config.json to config.json, build and upload it yourself
|
|
|
|
## Enduser Setup
|
|
1. Scan for access points
|
|
1. connect to access point "illucat"
|
|
1. open web browser and navigate to http://192.168.4.1
|
|
1. To connect the cat to your own WiFi, open the Settings section and change stationMode to 1 and set stationSSID and stationPassword
|
|
1. submit all changes
|
|
1. hit restart under the System section
|
|
1. illucat connects to your network and can be reached with http://illucat
|
|
|
|
|
|
## Install and setup Python
|
|
|
|
### Linux
|
|
Download udev rules and follow install instructions in rules file.
|
|
|
|
```
|
|
wget https://raw.githubusercontent.com/platformio/platformio-core/develop/scripts/99-platformio-udev.rules
|
|
```
|
|
|
|
### MacOs
|
|
{TBD}
|
|
|
|
### Windows
|
|
download and install python 2.7.x for Windows
|
|
https://www.python.org/downloads/
|
|
|
|
now open your command shell (start->cmd.exe)
|
|
type "python" and hit enter
|
|
|
|
python
|
|
|
|
if it starts up the python shell you can type "exit()" and hit enter
|
|
{IMG} python.png
|
|
|
|
if you get the error message: "'python' is not recognized as an internal or external command,
|
|
operable program or batch file" follow the instructions bellow, then resart your shell and retry the python command
|
|
https://superuser.com/questions/143119/how-do-i-add-python-to-the-windows-path/143121#143121
|
|
|
|
## Install Esptool
|
|
|
|
now open your command shell (start->cmd.exe)
|
|
type "python -m pip install --upgrade esptool" and hit enter
|
|
|
|
python -m pip install --upgrade esptool
|
|
|
|
{IMG} esptool.png
|
|
|
|
## Flash Firmware
|
|
|
|
Extract firmware.bin and spiffs.bin
|
|
|
|
in the command shell window change to the folder where you extracted the .bin files using cd
|
|
|
|
flash the firmware with the command "python -m esptool --port **YOUR SERIAL PORT** --baud 115200 write_flash 0x00000 firmware.bin 0x00300000 spiffs.bin"
|
|
hint: you can crank the baudrate up to 921600 bps ;)
|
|
|
|
python -m esptool --port COM11 --baud 115200 write_flash 0x00000 firmware.bin 0x00300000 spiffs.bin
|
|
|
|
# Configuration after first boot
|
|
|
|
the esp will build a AP with ssid name **illu** and password **illumination**
|
|
|
|
when connected browse to **http://illucat**
|
|
|
|
now you can enter the SSID and Password of your WLAN and set StationMode to 1
|
|
then press save and reset the esp)
|
|
|
|
the Cat should now joined your network
|
|
|
|
find the ip of your cat in your DHCP table
|
|
|
|
have fun
|
|
|
|
|
|
|
|
|