Commit graph

106 commits

Author SHA1 Message Date
Pedro Minatel
f1b06d2a74
Added the example guideline and template (#7665)
* Added the example guideline and template

* PR review changes with some typos and grammar fixes

* Changes according to the PR review
2023-01-17 15:28:39 +01:00
Sanket Wadekar
161b1673d9
Draft: Esp insights library support (#7566)
* ESP Insights: Added library support

* ESP Insights: Added Examples

* ESP Insights: Added custom partitions file

* ESP Insights: Added API documentation.

* Added recipe and script to create Insights package

* Updated ESP Insights examples.

* Changed Insights Firmware package output directory

* Changed license to include SPDX license

* Fix Insights package for Windows

* Updated .exe of insights script

* Added coredump partition to all schemes

* Updated header files of Insights diagnostics

* hotfix: Added elf-sha256-offset flag in elf2bin
builder

* Update API to be more Arduino-like and partitions offsets

Co-authored-by: Me No Dev <me-no-dev@users.noreply.github.com>
2022-12-22 17:42:56 +02:00
Claus Näveke
a95ce27ad7
Reflect ledc API changes in Docs (#7612)
* Update ledc.rst

API has changed with https://github.com/espressif/arduino-esp32/pull/6570

* Update ledc.rst

Fix whitespace

Co-authored-by: Jan Procházka <90197375+P-R-O-C-H-Y@users.noreply.github.com>
2022-12-21 18:46:52 +02:00
Pedro Minatel
c2caad9a22
Release version update to 2.0.6 in the Docs (#7592)
Co-authored-by: Me No Dev <me-no-dev@users.noreply.github.com>
2022-12-15 12:46:41 +02:00
Pedro Minatel
ffdfd7e309
Added missing API references (#7553)
API docs changes according to the PR review
Contribution message updated
2022-12-14 17:17:28 +01:00
Pedro Minatel
6b33cbb648
Fixed the countUp description (#7590) 2022-12-14 12:14:10 +01:00
Jan Procházka
dbeae9480d
AnalogWrite - frequency and resolution log errors + returns (#7471)
* Added log errors + returns
* Update LEDC docs
2022-12-08 10:25:31 -03:00
RefactorFactory
bf53e2b8d6
How to use USBHID classes with ESP32-S2 and ESP32-S3 (#7214)
These instructions are based on esp32-arduino-lib-builder's build process, including https://github.com/espressif/esp32-arduino-lib-builder/blob/master/tools/update-components.sh which explains how to clone tinyusb.
2022-11-16 12:55:27 +01:00
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