Commit graph

76 commits

Author SHA1 Message Date
James-4DSystems
a9794f9c4f
Update partition_table.rst with Variants Folder detail (#8531)
* Update partition_table.rst

Updating Partition Table Partition with information regarding Variants folder

* Update docs/source/tutorials/partition_table.rst

Co-authored-by: Jan Procházka <90197375+P-R-O-C-H-Y@users.noreply.github.com>

---------

Co-authored-by: Jan Procházka <90197375+P-R-O-C-H-Y@users.noreply.github.com>
2023-08-29 13:51:55 +03:00
rstephan
7a3768460b
Soft-AP: get subnet mask (#8358)
In WiFiSTA you can ask for the subnet mask, but not in WiFiAP.
Only the CIDR is reported.
Therefor the missing method is added to have the same features in softAP as well.
2023-07-17 13:14:30 +03:00
schrolli
97e69666c9
Update gpio.rst: typo in function name 'attachInterrupt' (#8336) 2023-07-17 12:46:21 +03:00
w3jc
72c41d0953
Update ledc.rst (#8218)
typo
2023-05-31 15:03:16 +03:00
Tomáš Pilný
a2c892073b
Updated preferences and FAQ documentation (added SPIFFS) (#8150)
* Updated preferences.rst

* Added into FAQ info about SPIFFS failed mount
2023-05-11 13:49:30 +03:00
Renan Passos
2c71406680
Text correction of timer.rst (#8074)
* Update timer.rst

Changed text because of an inconsistence between title and text explaining the timerGetConfig function.
I don't know if the method timerSetConfig really exists.

* Update timer.rst

Add informations about timerSetConfig function.
2023-05-03 20:26:44 +03:00
Tomáš Pilný
266eea71b5
Added link to external examples to the doc (#8130) 2023-05-03 20:20:31 +03:00
Jan Procházka
7693f7410a
Changed location of results file (#8072) 2023-04-14 20:11:07 +03:00
Tyeth Gundry
dfa5e8dbff
Update installing to use CDN backed github links (#7876)
This increases the reliability of users hitting the boardsmanager urls, improving speed and avoiding request throttling, by using the github CDN frontend as mentioned in this old ticket:
https://github.com/espressif/arduino-esp32/issues/3505#issuecomment-1438813967

Co-authored-by: Me No Dev <me-no-dev@users.noreply.github.com>
2023-04-10 15:21:20 +03:00
Jan Procházka
df75f38a5c
[CI] External libraries compilation test (#8003)
* Workflow final + docs added

Delete LIBRARY_TEST.md

Update readme + documentation

Generated External Libraries Test Results

Updated docs

Generated External Libraries Test Results

revert last commit

DOnt install arduino-core manually

Update external_libraries_test.rst

Generated External Libraries Test Results

Align FQBNs to platform name

use manula platform installation

Generated External Libraries Test Results

remove verbose

remove - before sketch path

Add libs and examples for specific chip

Generated External Libraries Test Results

Generated External Libraries Test Results

Update README.md

Generated External Libraries Test Results

Update README.md

Update README.md

Generated External Libraries Test Results

change name of GH action

replace - for /

Generated External Libraries Test Results

Generated External Libraries Test Results

Update lib.yml

Update lib.yml

Generated External Libraries Test Results

remove types from pull_rewuest

add pull to lib.yml

Generated External Libraries Test Results

add back deltas_report

Update LIBRARY_TEST.md

add verbose logs

remove deltas report

Generated External Libraries Test Results

Change from schedule to push for testing

add P-R-O-C-H-Y repo to cron job

rename workflow

Update LIBRARY_TEST.md

Update LIBRARY_TEST.md

Edit URL

Generated External Libraries Test Results

remove unused ymls + run job on schedule

generated

Add action link

push only result file

generated

fix names

fix workflow

run workflow on push

Add report to file action

remove separator

fix example paths

fix library name

yaml list of examples edit

update universal sketches

examples path fix

update example paths

Add ESP32Servo

warnings -> all

change warnings to "default"

fix library name

fix list

add matrix to compile sketches

test compile for only 1 chip

remove GPIO example

use edited action

Add Blynk library

use v1

print arduino cli version

fix listing

update libs

list fix

remove if

fix typo

fix path

path test

list fix

fix folder creating

add install IDE

list fix

fix missing run command

Added V3 lib test + script for lib install

fix typo

add platform

updated on:

Lib testing v2

fix fqbn

test all chips

typo fix

replace blynk with Adafruit Neopixel

change blynk example

fix yml format

add action name

Add report for PR

Enable warnings report

changed position

typo

test

remove dbg level

add log level option

split command

typo

typo

add empty space

change position of cli flags

fix typo

cli compile flags not marking warning as error

Add new lib+example

install core manually

Install core by compile-sketch

fix url->path

fix typo

Install core from repo

remove external lib checkout

add lib example

update board

change platform name

change platform name

use BoardManager

update example

update example

use repo as platform

Initial commit

Update README.md

Update README.md

* fix readme links

* added JSON + lib_v2 YAML

* Update lib_v2.yml

* Update lib_v2.yml

* Update lib_v2.yml

* Update lib_v2.yml

* Update lib_v2.yml

* Update lib_v2.yml

* Update lib_v2.yml

* update JSON file

* Added json file

* Update lib.yml

* Update lib_v2.yml

* Update lib_v2.yml

* change JSON

* edit json + add version

* edit json

* update version

* fix path

* update fqbn platform name

* add empty test result file

* Add latest changes

* Update docs

* Update docs + clean YAML fifle

* Add ESPAsyncWebServer library

* Add test multiple required libs (will revert)

* Update docs + json

* Update lib.yml

* Fix typos in docs

* fix readme links
2023-04-04 12:54:42 +03:00
Sanket Wadekar
c6b850b13d
Rainmaker: Added enableSystemService API (#7875)
* Rainmaker: Added enableSystemService API

* Fixed broken links in espnow docs
2023-03-31 14:46:27 +03:00
Jacques Supcik
8ebf7581a5
fix return value of getBytes (#7981) 2023-03-31 13:42:50 +03:00
bytiful
d054889bc7
fixed the function header (#7674)
* fixed the function header

* fixed function name and paramaters

---------

Co-authored-by: Jan Procházka <90197375+P-R-O-C-H-Y@users.noreply.github.com>
2023-02-06 15:09:50 +02:00
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