diff --git a/.gitignore b/.gitignore index 16c3c191..a686ac78 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,5 @@ tools/xtensa-esp32-elf tools/dist +tools/esptool +tools/esptool.exe diff --git a/README.md b/README.md index 9d95f9bb..aa3810d9 100644 --- a/README.md +++ b/README.md @@ -30,9 +30,6 @@ Most of the framework is implemented. Most noticable is the missing analogWrite. - Open Terminal and execute the following command (copy->paste and hit enter): ```bash - curl -o get-pip.py https://bootstrap.pypa.io/get-pip.py && \ - sudo python get-pip.py && \ - sudo pip install pyserial && \ mkdir -p ~/Documents/Arduino/hardware/espressif && \ cd ~/Documents/Arduino/hardware/espressif && \ git clone https://github.com/espressif/arduino-esp32.git esp32 && \ @@ -48,9 +45,6 @@ Most of the framework is implemented. Most noticable is the missing analogWrite. ```bash sudo usermod -a -G dialout $USER && \ sudo apt-get install git && \ - wget https://bootstrap.pypa.io/get-pip.py && \ - sudo python get-pip.py && \ - sudo pip install pyserial && \ mkdir -p ~/Arduino/hardware/espressif && \ cd ~/Arduino/hardware/espressif && \ git clone https://github.com/espressif/arduino-esp32.git esp32 && \ diff --git a/doc/gitbash-admin-start.png b/doc/gitbash-admin-start.png deleted file mode 100644 index b8476b05..00000000 Binary files a/doc/gitbash-admin-start.png and /dev/null differ diff --git a/doc/gitbash-admin.png b/doc/gitbash-admin.png deleted file mode 100644 index 0e6a920c..00000000 Binary files a/doc/gitbash-admin.png and /dev/null differ diff --git a/doc/gitbash-user.png b/doc/gitbash-user.png deleted file mode 100644 index 332798c6..00000000 Binary files a/doc/gitbash-user.png and /dev/null differ diff --git a/doc/python-install.png b/doc/python-install.png deleted file mode 100644 index d8ad31c4..00000000 Binary files a/doc/python-install.png and /dev/null differ diff --git a/doc/win-gui-1.png b/doc/win-gui-1.png new file mode 100644 index 00000000..5129cd0d Binary files /dev/null and b/doc/win-gui-1.png differ diff --git a/doc/win-gui-2.png b/doc/win-gui-2.png new file mode 100644 index 00000000..b4a2ebba Binary files /dev/null and b/doc/win-gui-2.png differ diff --git a/doc/win-gui-3.png b/doc/win-gui-3.png new file mode 100644 index 00000000..4f0fe759 Binary files /dev/null and b/doc/win-gui-3.png differ diff --git a/doc/win-gui-4.png b/doc/win-gui-4.png new file mode 100644 index 00000000..9e975c08 Binary files /dev/null and b/doc/win-gui-4.png differ diff --git a/doc/win-gui-5.png b/doc/win-gui-5.png new file mode 100644 index 00000000..5eeb1b41 Binary files /dev/null and b/doc/win-gui-5.png differ diff --git a/doc/win-gui-update-1.png b/doc/win-gui-update-1.png new file mode 100644 index 00000000..9162bf46 Binary files /dev/null and b/doc/win-gui-update-1.png differ diff --git a/doc/win-gui-update-2.png b/doc/win-gui-update-2.png new file mode 100644 index 00000000..702c9b0a Binary files /dev/null and b/doc/win-gui-update-2.png differ diff --git a/doc/windows.md b/doc/windows.md index bbce29bf..90a938eb 100644 --- a/doc/windows.md +++ b/doc/windows.md @@ -2,34 +2,46 @@ ### Tested on 32 and 64 bit Windows 10 machines 1. Download and install the latest Arduino IDE ```Windows Installer``` from [arduino.cc](https://www.arduino.cc/en/Main/Software) -2. Download ```Windows x86 MSI installer``` or ```Windows x86-64 MSI installer``` from [python.org](https://www.python.org/downloads/release/python-2712/). When installing: - - Install for all users - - In ```Customize Python 2.7.X``` page, make sure you enable the last option: ```Add python.exe to Path``` - ![Python](python-install.png) -3. Download and install Git from [git-scm.com](https://git-scm.com/download/win) -4. Start ```Git Bash``` as Administrator and execute the following command - - ```bash - python -m pip install --upgrade pip && \ - pip install pyserial && \ - pip install requests - ``` - ![Git Bash As Admin](gitbash-admin-start.png) - ![Git Bash Admin CMD](gitbash-admin.png) -5. Start ```Git Bash``` normally and execute the following command - - ```bash - mkdir -p ~/Documents/Arduino/hardware/espressif && \ - cd ~/Documents/Arduino/hardware/espressif && \ - git clone https://github.com/espressif/arduino-esp32.git esp32 && \ - cd esp32/tools/ && \ - python get.py - ``` - ![Git Bash User CMD](gitbash-user.png) -6. Plug your ESP32 board and wait for the drivers to install (or install manually any that might be required) -7. Start Arduino IDE -8. Select your board in ```Tools > Board``` menu -9. Select the COM port that the board is attached to -10. Compile and upload (You might need to hold the boot button while uploading) +2. Download and install Git from [git-scm.com](https://git-scm.com/download/win) +3. Start ```Git GUI``` and run through the following steps: + - Select ```Clone Existing Repository``` + + ![Step 1](win-gui-1.png) + + - Select source and destination + - Source Location: ```https://github.com/espressif/arduino-esp32.git``` + - Target Directory: ```C:/Users/[YOUR_USER_NAME]/Documents/Arduino/hardware/espressif/esp32``` + - Click ```Clone``` to start cloning the repository + + ![Step 2](win-gui-2.png) + ![Step 3](win-gui-3.png) + + - Open ```C:/Users/[YOUR_USER_NAME]/Documents/Arduino/hardware/espressif/esp32/tools``` and double-click ```get.exe``` + + ![Step 4](win-gui-4.png) + - When ```get.exe``` finishes, you should the following files you the directory + + ![Step 5](win-gui-5.png) + +4. Plug your ESP32 board and wait for the drivers to install (or install manually any that might be required) +5. Start Arduino IDE +6. Select your board in ```Tools > Board``` menu +7. Select the COM port that the board is attached to +8. Compile and upload (You might need to hold the boot button while uploading) ![Arduino IDE Example](arduino-ide.png) + +### How to update to the latest code + +1. Start ```Git GUI``` and you should see the repository under ```Open Recent Repository```. Click on it! + + ![Update Step 1](win-gui-update-1png) + +2. From menu ```Remote``` select ```Fetch from``` > ```origin``` + + ![Update Step 2](win-gui-update-2png) + +3. Wait for git to pull any changes and close ```Git GUI``` +4. Open ```C:/Users/[YOUR_USER_NAME]/Documents/Arduino/hardware/espressif/esp32/tools``` and double-click ```get.exe``` + + ![Step 4](win-gui-4.png) diff --git a/package/package_esp32_index.template.json b/package/package_esp32_index.template.json index 4ecbba7e..a6dcb7db 100644 --- a/package/package_esp32_index.template.json +++ b/package/package_esp32_index.template.json @@ -34,6 +34,11 @@ "packager": "esp32", "name": "xtensa-esp32-elf-gcc", "version": "1.22.0-61-gab8375a-5.2.0" + }, + { + "packager": "esp32", + "name": "esptool", + "version": "fe69994" } ] } @@ -72,6 +77,40 @@ "size": "32734156" } ] + }, + { + "name": "esptool", + "version": "fe69994", + "systems": [ + { + "host": "i686-mingw32", + "url": "https://dl.espressif.com/dl/esptool-fe69994-windows.zip", + "archiveFileName": "esptool-fe69994-windows.zip", + "checksum": "SHA-256:b2702efc045f5f61f821c72495301a0f2016e87e33f49fa16e262d0522d2b021", + "size": "3389457" + }, + { + "host": "x86_64-apple-darwin", + "url": "https://dl.espressif.com/dl/esptool-fe69994-macos.tar.gz", + "archiveFileName": "esptool-fe69994-macos.tar.gz", + "checksum": "SHA-256:49ab32fbdf4f855925638d4b76ffd292255a47c4445b1069737f7151f66a03aa", + "size": "3886730" + }, + { + "host": "x86_64-pc-linux-gnu", + "url": "https://dl.espressif.com/dl/esptool-fe69994-linux64.tar.gz", + "archiveFileName": "esptool-fe69994-linux64.tar.gz", + "checksum": "SHA-256:6ff54604bb3e1af39a7dd4f0e54b02b0f48bcd8a0b9259bc202385fdea573e05", + "size": "3937680" + }, + { + "host": "i686-pc-linux-gnu", + "url": "https://dl.espressif.com/dl/esptool-fe69994-linux32.tar.gz", + "archiveFileName": "esptool-fe69994-linux32.tar.gz", + "checksum": "SHA-256:4912aa39b3b78fbe4f959c496e52968b207e66e92cf186ad583812526a455f48", + "size": "3766885" + } + ] } ] } diff --git a/platform.txt b/platform.txt index 34c90861..d112108e 100644 --- a/platform.txt +++ b/platform.txt @@ -3,8 +3,8 @@ version=0.0.1 runtime.tools.xtensa-esp32-elf-gcc.path={runtime.platform.path}/tools/xtensa-esp32-elf -tools.esptool.cmd=python "{runtime.platform.path}/tools/esptool.py" -tools.esptool.cmd.windows=python.exe "{runtime.platform.path}/tools/esptool.py" +tools.esptool.cmd="{runtime.platform.path}/tools/esptool" +tools.esptool.cmd.windows="{runtime.platform.path}/tools/esptool.exe" compiler.warning_flags=-w compiler.warning_flags.none=-w