Commit graph

198 commits

Author SHA1 Message Date
Sanket Wadekar
5737016cdd
Add enableScenes API in Rainmaker (#7436)
* Added enableScenes API

* Added enableScenes API documentation

* Added enableScenes API to example

Co-authored-by: Jan Procházka <90197375+P-R-O-C-H-Y@users.noreply.github.com>
2022-11-14 14:27:20 +00:00
Jan Procházka
7a76aded54
Add touch sleep wakeup API (#7439) 2022-11-09 14:17:46 -03:00
Jan Procházka
3c033236f7
[DOCS] Add TOUCH peripheral API (#7421)
* add touch.rst

* update touchRead comment in header file

* Edited examples

* typo changes + updates

* about edit
2022-11-04 09:12:52 +00:00
Jan Procházka
bf265039eb
[DOCS] Add ESP32S3 to libraries support list (#7415)
* Add ESP32S3 to libraries support list

* Update libraries.rst
2022-11-03 12:58:50 +01:00
Sanket Wadekar
c1dc4f2e24
Added Docs for Rainmaker (#7260)
Co-authored-by: Pedro Minatel <pedro.minatel@espressif.com>
2022-10-28 12:00:50 +01:00
Vojtěch Bartoška
1092f4852e
Update of supported SoCs (#7385)
* Update of supported SoCs

Changed ESP32-S3 support to stable.

* Update getting_started.rst

Co-authored-by: Pedro Minatel <pedro.minatel@espressif.com>
2022-10-25 12:49:23 +01:00
Me No Dev
2075bd492b
Lib-builder does not allow to build for more than one target when -t is used 2022-09-27 11:44:30 +03:00
Tomáš Pilný
9e7f772948
Doc update: added note about global arduino component (#7277)
* Doc update: added note about global arduino component

* Requested changne IDF -> ESP-IDF
2022-09-23 08:01:58 +02:00
Ren Xiao
85aecec8d4
Update boards.rst (#7195) 2022-09-14 12:46:29 +03:00
Tomáš Pilný
b58e7ab0b8
Doc addition: How to compile libs with different debug level (#7193)
* Initial commit with guide on building libs wirh higher debug level

* Added reference to FAQ

* Reword portion of core_debug.rst

* Removed extra empty line

Co-authored-by: Vojtěch Bartoška <76958047+VojtechBartoska@users.noreply.github.com>
2022-09-14 11:58:08 +03:00
Daniel Egnor
adb01cf0c6
Compile error if CONFIG_FREERTOS_HZ != 1000 (#6955)
* Compile error if CONFIG_FREERTOS_HZ != 1000
* add a check at the CMake level, per feedback
* Set CONFIG_FREERTOS_HZ=1000 in CI test of Arduino-as-component
2022-08-26 11:14:59 +03:00
Tomáš Pilný
3cb73dccd0
Add erase flash option to Arduino IDE menu (#7043) 2022-08-10 08:23:12 -03:00
Ivan Grokhotkov
52160ac6d8
docs: add FAQ entry about modifying sdkconfig options 2022-07-25 10:35:36 +02:00
Rotzbua
cf01523ded
Doc: Add doc about minimum security for connection to AP (#6909)
* Add troubleshooting to connect to WEP/WPA APs.
* Add troubleshooting about WPA3 support.
2022-06-28 12:38:24 +03:00
Rotzbua
95a45ce259
Doc: Update deprecation of setAutoConnect, etc.. (#6908)
* Doc: Update deprecation of `setAutoConnect`...

... and `getAutoConnect`

* Doc: Add doc to `setAutoReconnect`..

.. and `getAutoReconnect`
2022-06-27 14:01:00 +03:00
Pedro Minatel
bd83727cd7
[DOCS] Added USB DFU and CDC tools guide (#6756)
* USB CDC and DFU docs

* Added DFU and CDC guide for flashing

* Added tools menu reference guide

* Deleted unrelated file to this PR

The file was added by mistake.

* Small fix in the Serial.begin mention

* Added a not for USB CDC isntead of DFU

* PR review changes
2022-06-16 13:42:01 +03:00
Pedro Minatel
33011ede30
[DOCS] Added partition table tutorial (#6758)
* Added partition table guide

* Using a custom partition file

* Added some more examples for partitions

* Fixed the app partition offset

* Added bare_minimum_2MB partition table file

* PR review changes
2022-05-30 13:47:53 +03:00
Valerii Koval
45583af189
[Docs] Actualize PlatformIO installation instructions (#6629)
* Actualize PlatformIO installation instructions

Split instructions for stable and upstream versions

* Add link to platformio.ini documentation
2022-04-26 14:29:54 +01:00
Me No Dev
8ee5f0a11e
Esp32 s3 support (#6341)
Co-authored-by: Jason2866 <24528715+Jason2866@users.noreply.github.com>
Co-authored-by: Unexpected Maker <seon@unexpectedmaker.com>
Co-authored-by: Rodrigo Garcia <rodrigo.garcia@espressif.com>
Co-authored-by: Tomáš Pilný <34927466+PilnyTomas@users.noreply.github.com>
Co-authored-by: Pedro Minatel <pedro.minatel@espressif.com>
Co-authored-by: Ivan Grokhotkov <ivan@espressif.com>
Co-authored-by: Jan Procházka <90197375+P-R-O-C-H-Y@users.noreply.github.com>
Co-authored-by: Limor "Ladyada" Fried <limor@ladyada.net>
2022-03-28 12:09:41 +03:00
Xylopyrographer
3f79097d5f
Add Preferences library API and tutorial documents (#6442)
* Add Preferences library API and tutorial documents

Add API and tutorial documents for the  Preferences library.

* Revise per review

Correct some errors. Remove the "wordiness" is a few places.

* Correct link to Preferences API

Update the references and link to the Preferences API document.

Co-authored-by: Pedro Minatel <pedro.minatel@espressif.com>
Co-authored-by: Me No Dev <me-no-dev@users.noreply.github.com>
2022-03-28 12:02:10 +03:00
Rodrigo Garcia
6014ff433f
Fixes USB CDC setRxBufferSize(), begin(), _onRX() (#6413)
* Fixes USB CDC setRxBufferSize(), begin(), _onRX()

* Fixes SetRxBufferSize(0) with end()

* Fixes reset when 2x call to end()

* Adds RX_OVERFLOW_EVENT and Queue Copy in setBufferSize

* changed event name to ARDUINO_USB_CDC_RX_OVERFLOW_EVENT
2022-03-28 11:40:02 +03:00
Pedro Minatel
0b10c8b79e
[Docs] Added the guideline for documentation (#6409)
* [Docs] Added the guideline for documentation

* [Docs] Added more descriptions about the API documenting process

* [Docs] PR review

* [Docs] PR review and minor typos and grammar fixes
2022-03-18 18:28:18 +02:00
Pedro Minatel
eae67a9fb4
WiFi DA: Added Dual Antenna to the docs and example created (#6357)
Summary

Added the Dual Antenna documentation.
Added the DA example.
2022-02-28 16:48:51 +02:00
Pedro Minatel
d1f0d6c0fc
Added more details about PlatformIO (#5540)
* Added more details about PlatformIO

* Fixed typo
2022-02-28 15:06:28 +02:00
P-R-O-C-H-Y
2884215f85
Documentation for DAC peripheral (#6337) 2022-02-23 16:00:16 +02:00
P-R-O-C-H-Y
a57cac63e4
Timer API docs + esp32-hal-timer.h edit (#6335) 2022-02-23 15:59:20 +02:00
P-R-O-C-H-Y
de6994187d
LEDC & SigmaDelta documentation (#6330)
* LEDC preripheral doc

* SigmaDelta peripheral doc

* Added missing symbol

* Edited grammar, mistakes

* quick edit
2022-02-23 15:58:27 +02:00
Pedro Minatel
491444c15a
[Docs] Added more details about embedded FLASH and PSRAM on ESP32-S3. (#6321)
* [Docs] Added more information about embedded PSRAM and Flash for ESP32-S3

* [Docs] Fixed some typos

* [Docs] Fixed some spacing issues
2022-02-23 15:57:31 +02:00
P-R-O-C-H-Y
a135169176
Added ADC API doc + simple example (#6301)
* Added ADC API doc + simple example

* Added attenuation input voltage range + conf.py added tabs extension

* Update requirements.txt

* Update adc.rst
2022-02-23 15:45:19 +02:00
Tomáš Pilný
b5f3d6c836
Update doc: Arduino as IDF component; fixes #5833 (#6299)
Summary

Updated documentation describing the usage of Arduino-esp32 core as ESP-IDF component.

Impact

Removed confusing mentions of advanced menuconfig options.
Extended process of installation, setup, and usage.

Related links

Closes #5833
2022-02-23 15:24:40 +02:00
Pedro Minatel
4900979906
Added documentation for the Arduino IDE tools menu (#6284)
* Added the Tools Options into the docs.

* Added more options

* Deleted wrong file.

* [Docs] Added image to show the MSC and some grammar fixes

* [Docs] Added more information about the core selection

* Deleted wrong file.

* [Docs] Added more information about the core selection

* [Docs] Changes according to the PR review
2022-02-16 15:43:21 +02:00
Vojtěch Bartoška
2c7052a64c
Installing.rst_update (#6292)
Co-authored-by: Pedro Minatel <pminatel@gmail.com>
2022-02-16 13:34:51 +02:00
Pedro Minatel
dafdc05249
Docs cleanup and version updated to 2.0.2 (#6213)
* Docs cleanup and version updated to 2.0.2

* Removed issue template information

* Removed issue template file

* Added referecnces for the issue and feature request form
2022-02-01 11:24:06 +02:00
Pedro Minatel
7ba11cc1ae
[Docs] Added USB documentation (#6036)
Summary

Added USB documentation.

Closes: #5784
2021-12-21 12:51:38 +02:00
Pedro Minatel
7b96374ea6
[Fix] Added the Win32 not supported notice/warning (#6031)
Related to:
#6012
#5994
#5991
2021-12-20 13:11:22 +02:00
Halysson Carvalho
fb00b51f99
[DOCS] Writing a new Arduino documentation about GPIO (#5894)
* add new documation GPIO

Co-authored-by: pedro.minatel <pedro.minatel@espressif.com>
2021-12-14 15:39:54 +02:00
Pedro Minatel
6e0b57784f
[Docs] Update on the Windows install procedures (#6018) 2021-12-14 13:56:26 +02:00
P-R-O-C-H-Y
399f4ecbb3
[DOCS] Editing usage of Arduino as a component in ESP-IDF (#5896)
* Editing esp-idf_component docs

* Changed idt to ESP-IDF

Co-authored-by: Pedro Minatel <pminatel@gmail.com>
2021-11-22 13:37:06 +00:00
Pedro Minatel
5de09a9a49
[Docs] Add link to supported soc list on README and ESP32-S3 datasheet (#5891)
* [Docs] Added the supported SoC table link on the README file

* [Docs] Added the ESP32-S3 datasheet link to the getting started page
2021-11-15 15:19:28 +00:00
Pedro Minatel
b1497fb257
[Docs] Peripheral list updated to include all supported SoCs (#5851) 2021-11-08 12:36:06 +02:00
VojtechBartoska
80b8262595 Update esp-idf_component.rst 2021-11-04 17:21:44 +01:00
Pedro Minatel
666cd3cde5
[Docs] Added I2C driver docs (#5770)
* Added I2C driver docs
docs: Changes on the images and added more details about the I2C slave

* docs: Added slaveWrite description and added docs build folder to the gitignore file
2021-11-04 14:32:05 +02:00
Pedro Minatel
3e851b537a
[Docs] Added useStaticBuffers function description (#5820)
* docs: Added useStaticBuffers function description

* docs: Default useStaticBuffers configuration in highlight
2021-11-04 14:30:16 +02:00
Pedro Minatel
f410728444
docs: Added supported peripherals list on libraries section (#5829) 2021-11-04 14:29:42 +02:00
pedro.minatel
49f525c91d Added Python is missing on the troubleshooting section 2021-10-12 13:26:13 +01:00
Michał Szczepaniak
bd54ee442b
Remove git submodule update (#5696)
We don't have submodules.
2021-10-01 18:11:59 +03:00
pedro.minatel
8be2f7b1cc Changes according to the PR review 2021-09-21 14:34:21 +01:00
pedro.minatel
e1cdbd7816 Minor changes on the blink tutorial 2021-09-20 12:39:05 +01:00
pedro.minatel
7a35be3e7e Added blink example with Wokwi embedded simulation 2021-09-20 12:00:52 +01:00
pedro.minatel
453af3800c Supported devices table updated due the 2.0.0 release 2021-08-31 11:29:10 +01:00
Pedro Minatel
ce680708ec
Fixed the external link to a new tab (LOLIN boards) (#5571)
Moved links to the botton
2021-08-23 15:41:07 +03:00
pedro.minatel
a7ea737f30 Added LOLIN boards o the boards list. 2021-08-16 09:35:36 +01:00
Sagar
d5a98f9a39
Doc: Updated Troubleshooting file (#5430) 2021-07-26 20:37:12 +03:00
Me No Dev
1775dd1faa
Add ReadTheDocs CI (#5456) 2021-07-26 16:04:20 +03:00
Pedro Minatel
1effae46ea
Docs: Initial documentation structure using Sphinx (#5355)
This PR is the initial documentation structure including the basic information about the project and Sphinx configuration.

####CONTENTS:
- Getting Started
- Installing
- Boards
- Libraries
- Library Builder
- Tutorials
- ESP-IDF as Component
- OTA Web Update
- makeEspArduino
- Troubleshooting
- Contributing

This PR also changes the README.md.
2021-07-19 13:37:26 +03:00
Leziga
b1bcec08f8
Update boards_manager.md (#5296) 2021-06-16 20:58:31 +03:00
Pedro Minatel
23820874ec
Added the README template for examples and libraries (#5228)
Typos fixed and added more details and instructions
Added README file to WiFiScan example
Review on the README template
Added link to DevKits
2021-06-09 21:12:29 +03:00
Me No Dev
7f87d0fc3a
Fix compilation for use as IDF component (#5265) 2021-06-09 12:56:12 +03:00
Pedro Minatel
f385ee4219
Fixed labels on the boards pinouts images (#5213) 2021-06-09 12:33:12 +03:00
Pedro Minatel
cb2fbe445d
Added new boads pinout images for ESP32, ESP32-S2 and ESP32-C3 (#5133)
Board images updated and added warning on Flash/PSRAM pins
2021-05-18 13:33:57 +03:00
lbernstone
aeb4a13aad
ESP32S2 pinmap (#5015) 2021-04-05 16:54:40 +03:00
Dedik Serhii
5da4a47bdf
Update debian_ubuntu.md (#4907)
* Update debian_ubuntu.md

ERROR: This script does not work on Python 2.7 The minimum supported Python version is 3.6. Please use https://bootstrap.pypa.io/2.7/get-pip.py instead.

* Update debian_ubuntu.md

Co-authored-by: Me No Dev <me-no-dev@users.noreply.github.com>
2021-03-15 13:22:34 +02:00
Jorropo
c2346c37da
Add initial support for arm64 toolchain. (#4117)
Closes #4111.
gcc: I was not able to find an arm64 build on espressif's website so I choosed to put the armhf version, even if this should works this is only ok as temporary, arm64 runs better on arm64 than armhf :)
esptool: being interpreted python its ok
mkspiff: need igrr/mkspiffs#74 to be merged and artifacts added in /package/package_esp32_index.template.json.
2020-11-02 20:39:31 +02:00
lbernstone
1014ba40af
Update ISSUE_TEMPLATE.md (#4416)
Make options list into a table
2020-11-02 18:59:46 +02:00
Dimitre
c917ed2504
shallow clone to make installation faster (#4246)
shallow clone (board and submodules) to make installation faster
2020-10-01 14:43:48 +03:00
ducalex
7b613c1238
Added documentation regarding delay() resolution in esp-idf component (#3014) 2020-09-30 14:17:53 +03:00
lbernstone
e59355df71 Docs for lib builder (#3415)
* Docs for lib builder

* Typos and such
2019-11-11 15:30:52 +01:00
Me No Dev
048b26547a
Update boards_manager.md 2019-10-02 16:06:15 +03:00
Me No Dev
b10ed77aaf
Update boards_manager.md 2019-10-02 15:58:58 +03:00
Me No Dev
01d9345d28
Update development JSON location 2019-10-01 12:14:07 +03:00
Rotzbua
ee6336a312 links http -> https (#3010)
more secure
2019-08-20 16:47:43 +03:00
Amon Moce Rodolphe BAZONGO
2743e7b739 Update mac.md (#2745) 2019-05-11 11:21:25 +03:00
Tanishq Jasoria
00a546ee06 python2 get.py does not work behind proxy (#2349)
Executing python2 get.py behind proxy give error "IOError: [Errno socket error] [SSL: UNKNOWN_PROTOCOL] unknown protocol (_ssl.c:590)"
2019-01-22 17:28:27 +08:00
LynXzp
3a8ac27a86 layout fix (#1845)
(removed quotes from last line, and fixed indentation, no text changes)
2018-09-17 21:20:57 +02:00
lbernstone
6e4e4c96ee Updated ISSUE_TEMPLATE to try to get better postings (#1730)
* Updated ISSUE_TEMPLATE to try to get better postings

* Added line for PSRAM enabled

* More complete info request as per @stickbreaker
2018-09-17 21:11:41 +02:00
Eric
a989853d4a Update mac.md (#1760)
add a troubleshooting hint
2018-08-18 08:50:14 +02:00
Tokusei Noborio
7d3a67ada0 Update Arduino/hardware path (#1727) 2018-08-14 11:53:34 +02:00
lbernstone
a7ddf39521 Cleanup on README and boards_manager (#1693)
* Added instructions for installation with boards manager (stolen directly from esp8266)

* changed to production link instead of dev

* Added to main README. Made mods to images as requested.

* Added links for development package

* Moved version images to README.md

* Just a little change for cleaner look

* Cleaned up README.md and boards_manager.md to make installation easier.
2018-07-30 10:21:03 +03:00
lbernstone
2fba81223e Added instructions for installation with boards manager (#1630)
* Added instructions for installation with boards manager (stolen directly from esp8266)

* changed to production link instead of dev

* Added to main README. Made mods to images as requested.

* Added links for development package
2018-07-26 08:10:46 +02:00
Karan Sharma
0161e28614 Added OTAWebUpdater Doc (#1583) 2018-07-03 20:43:18 +02:00
lbernstone
c7b38008e2 Changed pinmap to show pins34-39 as GPI (#1510) 2018-06-19 11:34:05 +03:00
lbernstone
4ad27b4adc Added link to compilation issues for arduino as esp-idf component (#1435) 2018-05-25 16:27:50 +02:00
Marcel Stör
7bf1f47c97 Add note about sketch book location (#1374) 2018-05-14 13:04:44 +02:00
JP Liew
14ed6c4c25 Corrected Instructions for Windows typo error (#1210) 2018-04-06 19:12:17 +03:00
birgersp
77a8e47914 Changed Python version in Debian/Ubuntu install instructions (#1043)
As discussed in #1042.
2018-03-04 20:23:08 +01:00
Ivan Kravets
c8596cb9bb
Update integration with @PlatformIO 2018-02-05 13:00:31 +02:00
Vysakh P Pillai
81e0250983 Update windows.md (#946)
adding an additional step that is required to make sure the BLE libs are synced
2018-01-18 01:03:27 +02:00
Mark D
46d1b17319 doc typo (#889) 2017-11-28 13:53:33 +01:00
Ivan Kravets
aa83fca438 Update link to PIO Core (#877) 2017-11-28 11:10:36 +01:00
me-no-dev
823fb8fdbb Reword some instructions 2017-11-28 11:09:41 +01:00
Ted Timmons
2f73dd7920 add alternate location of this directory (#732) 2017-10-16 21:26:59 +03:00
Me No Dev
9fe32304c8 Update esp-idf_component.md 2017-10-14 00:08:41 +03:00
me-no-dev
409c75da04 Implement ESP_LOGx override option
Usable for library developers who write code not dependent on Arduino.
Adding 3 lines to the includes will permit their debug messages to be
visible in Arduino IDE or when enabled under IDF
2017-10-14 00:06:55 +03:00
Me No Dev
60b8b47455 Update IDF to de750e9 and add BLE (#723)
* Update IDF to de750e9

* Add BLE Library submodule
2017-10-13 22:07:41 +03:00
Me No Dev
cc00af38ec Update opensuse.md 2017-09-26 17:50:21 +08:00
joba1
dbf7b108f1 Update README.md with install instructions for openSUSE (#585)
* Update README.md

* Create opensuse.md
2017-09-26 17:49:18 +08:00
Rouan van der Ende
a7108969a3 Missing missing xcrun fix. (#601)
Had to run "xcode-select --install" before your script worked.
2017-08-31 15:56:47 +03:00
Pranav Cherukupalli
e6ba0f6281 DOCUMENTATION: Moved installation instructions to separate page (#561)
* DOCUMENTATION: Moved installation instructions to separate page

* Added Fedora to contents table
* Added Issue/Bug Report section to README
* Some minor improvements

* DOCUMENTATION: Rename directory doc to docs

* Also move ISSUE_TEMPLATE.md to docs directory

* DOCUMENTATION: Use current repo's files

* This makes it consistent instead  of having few local and few pointing to
  espressif/arduino-esp32 by all linking to local files

* DOCUMENTATION: Fix hyperlink to issue/bug template in contents

* DOCUMENTATION: contents: supress platform specific installation instruction
2017-08-17 16:14:01 +03:00