From 003b64c19c119171ac18bf47ac0a748ff12eaef9 Mon Sep 17 00:00:00 2001 From: Larry Bernstone Date: Sun, 8 Jul 2018 10:37:44 -0600 Subject: [PATCH 1/7] Added instructions for installation with boards manager (stolen directly from esp8266) --- docs/arduino-ide/boards_manager.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 docs/arduino-ide/boards_manager.md diff --git a/docs/arduino-ide/boards_manager.md b/docs/arduino-ide/boards_manager.md new file mode 100644 index 00000000000..5125112c402 --- /dev/null +++ b/docs/arduino-ide/boards_manager.md @@ -0,0 +1,12 @@ +Installation instructions using Arduino IDE Boards Manager +========================================================== + +Starting with 1.6.4, Arduino allows installation of third-party platform packages using Boards Manager. We have packages available for Windows, Mac OS, and Linux (32 and 64 bit). + +- Install the current upstream Arduino IDE at the 1.8 level or later. The current version is at the [Arduino website](http://www.arduino.cc/en/main/software). +- Start Arduino and open Preferences window. +- Enter ```https://dl.espressif.com/dl/package_esp32_dev_index.json``` into *Additional Board Manager URLs* field. You can add multiple URLs, separating them with commas. +- Open Boards Manager from Tools > Board menu and install *esp32* platform (and don't forget to select your ESP32 board from Tools > Board menu after installation). + +#### Latest release [![Latest release](https://img.shields.io/github/release/espressif/arduino-esp32.svg)](https://github.com/espressif/arduino-esp32/releases/latest/) +Boards manager link: `https://dl.espressif.com/dl/package_esp32_dev_index.json` From 9d03515dcc6e219288f9b518d4f0752092d319c6 Mon Sep 17 00:00:00 2001 From: Larry Bernstone Date: Thu, 12 Jul 2018 13:16:01 -0600 Subject: [PATCH 2/7] changed to production link instead of dev --- docs/arduino-ide/boards_manager.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/arduino-ide/boards_manager.md b/docs/arduino-ide/boards_manager.md index 5125112c402..21ffe502efc 100644 --- a/docs/arduino-ide/boards_manager.md +++ b/docs/arduino-ide/boards_manager.md @@ -5,8 +5,8 @@ Starting with 1.6.4, Arduino allows installation of third-party platform package - Install the current upstream Arduino IDE at the 1.8 level or later. The current version is at the [Arduino website](http://www.arduino.cc/en/main/software). - Start Arduino and open Preferences window. -- Enter ```https://dl.espressif.com/dl/package_esp32_dev_index.json``` into *Additional Board Manager URLs* field. You can add multiple URLs, separating them with commas. +- Enter ```https://dl.espressif.com/dl/package_esp32_index.json``` into *Additional Board Manager URLs* field. You can add multiple URLs, separating them with commas. - Open Boards Manager from Tools > Board menu and install *esp32* platform (and don't forget to select your ESP32 board from Tools > Board menu after installation). #### Latest release [![Latest release](https://img.shields.io/github/release/espressif/arduino-esp32.svg)](https://github.com/espressif/arduino-esp32/releases/latest/) -Boards manager link: `https://dl.espressif.com/dl/package_esp32_dev_index.json` +Boards manager link: `https://dl.espressif.com/dl/package_esp32_index.json` From a78021ced61674aa06f134cdf22b01aa69b0a2a6 Mon Sep 17 00:00:00 2001 From: Larry Bernstone Date: Wed, 25 Jul 2018 10:54:23 -0600 Subject: [PATCH 3/7] Added to main README. Made mods to images as requested. --- README.md | 6 +++++- docs/arduino-ide/boards_manager.md | 3 ++- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4b3c14a4bff..1e2fecf2f90 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,11 @@ Most of the framework is implemented. Most noticable is the missing analogWrite. ## Installation Instructions -- Using Arduino IDE +#### [Latest release ![Release Version](https://img.shields.io/github/release/espressif/arduino-esp32/all.svg?style=plastic) ![Release Date](https://img.shields.io/github/release-date/espressif/arduino-esp32.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/) + +- Using Arduino IDE Boards Manager (preferred) + + [Instructions for Boards Manager](docs/arduino-ide/boards_manager.md) +- Using Arduino IDE with the development repository + [Instructions for Windows](docs/arduino-ide/windows.md) + [Instructions for Mac](docs/arduino-ide/mac.md) + [Instructions for Debian/Ubuntu Linux](docs/arduino-ide/debian_ubuntu.md) diff --git a/docs/arduino-ide/boards_manager.md b/docs/arduino-ide/boards_manager.md index 21ffe502efc..a2237b968ae 100644 --- a/docs/arduino-ide/boards_manager.md +++ b/docs/arduino-ide/boards_manager.md @@ -8,5 +8,6 @@ Starting with 1.6.4, Arduino allows installation of third-party platform package - Enter ```https://dl.espressif.com/dl/package_esp32_index.json``` into *Additional Board Manager URLs* field. You can add multiple URLs, separating them with commas. - Open Boards Manager from Tools > Board menu and install *esp32* platform (and don't forget to select your ESP32 board from Tools > Board menu after installation). -#### Latest release [![Latest release](https://img.shields.io/github/release/espressif/arduino-esp32.svg)](https://github.com/espressif/arduino-esp32/releases/latest/) Boards manager link: `https://dl.espressif.com/dl/package_esp32_index.json` + +#### [Latest release ![Release Version](https://img.shields.io/github/release/espressif/arduino-esp32/all.svg?style=plastic) ![Release Date](https://img.shields.io/github/release-date/espressif/arduino-esp32.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/) From 3ff365e0f1beb2b23bc849c15d10d6c13b698c24 Mon Sep 17 00:00:00 2001 From: Larry Bernstone Date: Wed, 25 Jul 2018 16:26:26 -0600 Subject: [PATCH 4/7] Added links for development package --- docs/arduino-ide/boards_manager.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/arduino-ide/boards_manager.md b/docs/arduino-ide/boards_manager.md index a2237b968ae..921b72c49bc 100644 --- a/docs/arduino-ide/boards_manager.md +++ b/docs/arduino-ide/boards_manager.md @@ -8,6 +8,8 @@ Starting with 1.6.4, Arduino allows installation of third-party platform package - Enter ```https://dl.espressif.com/dl/package_esp32_index.json``` into *Additional Board Manager URLs* field. You can add multiple URLs, separating them with commas. - Open Boards Manager from Tools > Board menu and install *esp32* platform (and don't forget to select your ESP32 board from Tools > Board menu after installation). -Boards manager link: `https://dl.espressif.com/dl/package_esp32_index.json` +#### [Latest stable release ![Release Version](https://img.shields.io/github/release/espressif/arduino-esp32.svg?style=plastic) ![Release Date](https://img.shields.io/github/release-date/espressif/arduino-esp32.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/) +Stable release link: `https://dl.espressif.com/dl/package_esp32_index.json` -#### [Latest release ![Release Version](https://img.shields.io/github/release/espressif/arduino-esp32/all.svg?style=plastic) ![Release Date](https://img.shields.io/github/release-date/espressif/arduino-esp32.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/) +#### [Latest development release ![Development Version](https://img.shields.io/github/release/espressif/arduino-esp32/all.svg?style=plastic) ![Development Date](https://img.shields.io/github/release-date-pre/espressif/arduino-esp32.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/) +Development release link: `https://dl.espressif.com/dl/package_esp32_dev_index.json` From 0c4bf9aa288e2a65fdba986a59d740bf10606083 Mon Sep 17 00:00:00 2001 From: Larry Bernstone Date: Fri, 27 Jul 2018 12:35:18 -0600 Subject: [PATCH 5/7] Moved version images to README.md --- README.md | 7 ++++--- docs/arduino-ide/boards_manager.md | 2 -- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 1e2fecf2f90..c92fdf37df3 100644 --- a/README.md +++ b/README.md @@ -12,15 +12,16 @@ - [ESP32Dev Board PINMAP](#esp32dev-board-pinmap) ## Development Status +[Latest stable release ![Release Version](https://img.shields.io/github/release/espressif/arduino-esp32.svg?style=plastic) ![Release Date](https://img.shields.io/github/release-date/espressif/arduino-esp32.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/) + +[Latest development release ![Development Version](https://img.shields.io/github/release/espressif/arduino-esp32/all.svg?style=plastic) ![Development Date](https://img.shields.io/github/release-date-pre/espressif/arduino-esp32.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/) + Most of the framework is implemented. Most noticable is the missing analogWrite. While analogWrite is on it's way, there are a few other options that you can use: - 16 channels [LEDC](cores/esp32/esp32-hal-ledc.h) which is PWM - 8 channels [SigmaDelta](cores/esp32/esp32-hal-sigmadelta.h) which uses SigmaDelta modulation - 2 channels [DAC](cores/esp32/esp32-hal-dac.h) which gives real analog output ## Installation Instructions - -#### [Latest release ![Release Version](https://img.shields.io/github/release/espressif/arduino-esp32/all.svg?style=plastic) ![Release Date](https://img.shields.io/github/release-date/espressif/arduino-esp32.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/) - - Using Arduino IDE Boards Manager (preferred) + [Instructions for Boards Manager](docs/arduino-ide/boards_manager.md) - Using Arduino IDE with the development repository diff --git a/docs/arduino-ide/boards_manager.md b/docs/arduino-ide/boards_manager.md index 921b72c49bc..9161ba6ff3e 100644 --- a/docs/arduino-ide/boards_manager.md +++ b/docs/arduino-ide/boards_manager.md @@ -8,8 +8,6 @@ Starting with 1.6.4, Arduino allows installation of third-party platform package - Enter ```https://dl.espressif.com/dl/package_esp32_index.json``` into *Additional Board Manager URLs* field. You can add multiple URLs, separating them with commas. - Open Boards Manager from Tools > Board menu and install *esp32* platform (and don't forget to select your ESP32 board from Tools > Board menu after installation). -#### [Latest stable release ![Release Version](https://img.shields.io/github/release/espressif/arduino-esp32.svg?style=plastic) ![Release Date](https://img.shields.io/github/release-date/espressif/arduino-esp32.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/) Stable release link: `https://dl.espressif.com/dl/package_esp32_index.json` -#### [Latest development release ![Development Version](https://img.shields.io/github/release/espressif/arduino-esp32/all.svg?style=plastic) ![Development Date](https://img.shields.io/github/release-date-pre/espressif/arduino-esp32.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/) Development release link: `https://dl.espressif.com/dl/package_esp32_dev_index.json` From f0f9a93e593c6dcb72de18fdbb453fac71d90b51 Mon Sep 17 00:00:00 2001 From: Larry Bernstone Date: Fri, 27 Jul 2018 15:43:11 -0600 Subject: [PATCH 6/7] Just a little change for cleaner look --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index c92fdf37df3..22a81abed75 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,4 @@ -# Arduino core for ESP32 WiFi chip - -[![Build Status](https://travis-ci.org/espressif/arduino-esp32.svg?branch=master)](https://travis-ci.org/espressif/arduino-esp32) +# Arduino core for ESP32 WiFi chip [![Build Status](https://travis-ci.org/espressif/arduino-esp32.svg?branch=master)](https://travis-ci.org/espressif/arduino-esp32) ### Need help or have a question? Join the chat at [![https://gitter.im/espressif/arduino-esp32](https://badges.gitter.im/espressif/arduino-esp32.svg)](https://gitter.im/espressif/arduino-esp32?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) From 34db800d6a67172ba6eb73f3ae78d88eeb0d64d5 Mon Sep 17 00:00:00 2001 From: Larry Bernstone Date: Sat, 28 Jul 2018 08:56:42 -0600 Subject: [PATCH 7/7] Cleaned up README.md and boards_manager.md to make installation easier. --- README.md | 11 +++++------ docs/arduino-ide/boards_manager.md | 2 -- 2 files changed, 5 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 1e2fecf2f90..22a81abed75 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,4 @@ -# Arduino core for ESP32 WiFi chip - -[![Build Status](https://travis-ci.org/espressif/arduino-esp32.svg?branch=master)](https://travis-ci.org/espressif/arduino-esp32) +# Arduino core for ESP32 WiFi chip [![Build Status](https://travis-ci.org/espressif/arduino-esp32.svg?branch=master)](https://travis-ci.org/espressif/arduino-esp32) ### Need help or have a question? Join the chat at [![https://gitter.im/espressif/arduino-esp32](https://badges.gitter.im/espressif/arduino-esp32.svg)](https://gitter.im/espressif/arduino-esp32?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) @@ -12,15 +10,16 @@ - [ESP32Dev Board PINMAP](#esp32dev-board-pinmap) ## Development Status +[Latest stable release ![Release Version](https://img.shields.io/github/release/espressif/arduino-esp32.svg?style=plastic) ![Release Date](https://img.shields.io/github/release-date/espressif/arduino-esp32.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/) + +[Latest development release ![Development Version](https://img.shields.io/github/release/espressif/arduino-esp32/all.svg?style=plastic) ![Development Date](https://img.shields.io/github/release-date-pre/espressif/arduino-esp32.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/) + Most of the framework is implemented. Most noticable is the missing analogWrite. While analogWrite is on it's way, there are a few other options that you can use: - 16 channels [LEDC](cores/esp32/esp32-hal-ledc.h) which is PWM - 8 channels [SigmaDelta](cores/esp32/esp32-hal-sigmadelta.h) which uses SigmaDelta modulation - 2 channels [DAC](cores/esp32/esp32-hal-dac.h) which gives real analog output ## Installation Instructions - -#### [Latest release ![Release Version](https://img.shields.io/github/release/espressif/arduino-esp32/all.svg?style=plastic) ![Release Date](https://img.shields.io/github/release-date/espressif/arduino-esp32.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/) - - Using Arduino IDE Boards Manager (preferred) + [Instructions for Boards Manager](docs/arduino-ide/boards_manager.md) - Using Arduino IDE with the development repository diff --git a/docs/arduino-ide/boards_manager.md b/docs/arduino-ide/boards_manager.md index 921b72c49bc..9161ba6ff3e 100644 --- a/docs/arduino-ide/boards_manager.md +++ b/docs/arduino-ide/boards_manager.md @@ -8,8 +8,6 @@ Starting with 1.6.4, Arduino allows installation of third-party platform package - Enter ```https://dl.espressif.com/dl/package_esp32_index.json``` into *Additional Board Manager URLs* field. You can add multiple URLs, separating them with commas. - Open Boards Manager from Tools > Board menu and install *esp32* platform (and don't forget to select your ESP32 board from Tools > Board menu after installation). -#### [Latest stable release ![Release Version](https://img.shields.io/github/release/espressif/arduino-esp32.svg?style=plastic) ![Release Date](https://img.shields.io/github/release-date/espressif/arduino-esp32.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/) Stable release link: `https://dl.espressif.com/dl/package_esp32_index.json` -#### [Latest development release ![Development Version](https://img.shields.io/github/release/espressif/arduino-esp32/all.svg?style=plastic) ![Development Date](https://img.shields.io/github/release-date-pre/espressif/arduino-esp32.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/) Development release link: `https://dl.espressif.com/dl/package_esp32_dev_index.json`