Skip to content

Commit ced65a9

Browse files
P-R-O-C-H-YP-R-O-C-H-Y
committed
Added migration guide to docs
1 parent bb25428 commit ced65a9

File tree

3 files changed

+185
-0
lines changed

3 files changed

+185
-0
lines changed

‎docs/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Here you will find all the relevant information about the project.
1616
Guides <guides/guides>
1717
Tutorials <tutorials/tutorials>
1818
Advanced Utilities <advanced_utils>
19+
Migration Guide <migration_guide/migration_guide>
1920
FAQ <faq>
2021
Troubleshooting <troubleshooting>
2122
Contributing <contributing>

‎docs/source/migration_guide/2.x_to_3.0.rst

Lines changed: 174 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,174 @@
1+
#########################
2+
Migration from 2.x to 3.0
3+
#########################
4+
5+
Introduction
6+
------------
7+
8+
This is a guideline for the Arduino ESP32 project documentation. The idea for this guideline is to show how to start collaborating on the project.
9+
10+
The guideline works to give you the directions and to keep the documentation more concise, helping users to better understand the structure.
11+
12+
Breaking changes in API
13+
-----------------------
14+
15+
We all know how important documentation is. This project is no different.
16+
17+
ADC
18+
***
19+
20+
Removed APIs
21+
^^^^^^^^^^^^
22+
23+
* ``analogSetClockDiv``
24+
* ``adcAttachPin``
25+
* ``analogSetVRefPin``
26+
27+
28+
Hall Sensor
29+
***********
30+
31+
Hall sensor is no longer supported.
32+
33+
Removed APIs
34+
^^^^^^^^^^^^
35+
36+
* ``hallRead``
37+
38+
I2S
39+
***
40+
41+
I2S driver has beed completely redesigned and refactored to use new ESP-IDF driver.
42+
For more informations about the new API check `I2S API <https://docs.espressif.com/projects/arduino-esp32/en/latest/api/i2s.html>`_.
43+
44+
LEDC
45+
****
46+
47+
LEDC API has been changed in order to support the Peripheral Manager and easier use as LEDC channels are now automaticaly assigned to pins.
48+
For more informations about the new API check `LEDC API <https://docs.espressif.com/projects/arduino-esp32/en/latest/api/ledc.html>`_.
49+
50+
Removed APIs
51+
^^^^^^^^^^^^
52+
53+
* ``ledcSetup``
54+
* ``ledcAttachPin``
55+
56+
New APIs
57+
^^^^^^^^
58+
59+
* ``ledcAttach`` used to setup LEDC pin (merged ``ledcSetup`` and ``ledcAttachPin`` functions).
60+
* ``timerGetFrequency`` used to get actual frequency of the timer.
61+
* ``timerAttachInterruptArg`` used to attach interrupt to timer using argument.
62+
63+
Changes in APIs
64+
^^^^^^^^^^^^^^^
65+
66+
* ``ledcDetachPin`` renamed to ``ledcDetach``.
67+
* In all functions input parameter ``channel`` have been changed to ``pin``.
68+
69+
RMT
70+
****
71+
72+
TODO:
73+
For more informations about the new API check `RMT API <https://docs.espressif.com/projects/arduino-esp32/en/latest/api/rmt.html>`_.
74+
75+
Removed APIs
76+
^^^^^^^^^^^^
77+
78+
TODO:
79+
80+
New APIs
81+
^^^^^^^^
82+
83+
TODO:
84+
85+
Changes in APIs
86+
^^^^^^^^^^^^^^^
87+
88+
TODO:
89+
90+
SigmaDelta
91+
**********
92+
93+
SigmaDelta has been refactored to use new ESP-IDF driver.
94+
For more informations about the new API check `SigmaDelta API <https://docs.espressif.com/projects/arduino-esp32/en/latest/api/sigmadelta.html>`_.
95+
96+
Removed APIs
97+
^^^^^^^^^^^^
98+
99+
* ``sigmaDeltaSetup``
100+
* ``sigmaDeltaRead``
101+
102+
New APIs
103+
^^^^^^^^
104+
105+
* ``sigmaDeltaAttach`` used to setup SigmaDelta pin (channel is aquired automatically).
106+
* ``timerGetFrequency`` used to get actual frequency of the timer.
107+
* ``timerAttachInterruptArg`` used to attach interrupt to timer using argument.
108+
109+
Changes in APIs
110+
^^^^^^^^^^^^^^^
111+
112+
* ``sigmaDeltaDetachPin`` renamed to ``sigmaDeltaDetach``.
113+
* ``sigmaDeltaWrite`` input parameter ``channel`` have been changed to ``pin``.
114+
115+
Timer
116+
*****
117+
118+
Timer has been refactored to use new ESP-IDF driver and its API got simplified. For more informations about the new API check
119+
`TIMER API <https://docs.espressif.com/projects/arduino-esp32/en/latest/api/timer.html>`_.
120+
121+
Removed APIs
122+
^^^^^^^^^^^^
123+
124+
* ``timerGetConfig``
125+
* ``timerSetConfig``
126+
* ``timerSetDivider``
127+
* ``timerSetCountUp``
128+
* ``timerSetAutoReload``
129+
* ``timerGetDivider``
130+
* ``timerGetCountUp``
131+
* ``timerGetAutoReload``
132+
* ``timerAlarmEnable``
133+
* ``timerAlarmDisable``
134+
* ``timerAlarmWrite``
135+
* ``timerAlarmEnabled``
136+
* ``timerAlarmRead``
137+
* ``timerAlarmReadMicros``
138+
* ``timerAlarmReadSeconds``
139+
* ``timerAttachInterruptFlag``
140+
141+
New APIs
142+
^^^^^^^^
143+
144+
* ``timerAlarm`` used to setup Alarm for timer and enables it automaticaly (merged ``timerAlarmWrite`` and ``timerAlarmEnable`` functions).
145+
* ``timerGetFrequency`` used to get actual frequency of the timer.
146+
* ``timerAttachInterruptArg`` used to attach interrupt to timer using argument.
147+
148+
Changes in APIs
149+
^^^^^^^^^^^^^^^
150+
151+
* ``timerBegin`` now have only 1 parameter wich is frequency. There is an automatic calculation of divider through different clock sources¨
152+
to achieve selected frequency.
153+
* ``timerAttachInterrupt`` now have only 2 parameters -> parameter ``edge`` has been removed.
154+
155+
UART
156+
****
157+
158+
TODO:
159+
For more informations about the new API check `UART API <https://docs.espressif.com/projects/arduino-esp32/en/latest/api/rmt.html>`_.
160+
161+
Removed APIs
162+
^^^^^^^^^^^^
163+
164+
TODO:
165+
166+
New APIs
167+
^^^^^^^^
168+
169+
TODO:
170+
171+
Changes in APIs
172+
^^^^^^^^^^^^^^^
173+
174+
TODO:

‎docs/source/migration_guide/migration_guide.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
###############
2+
Migration Guide
3+
###############
4+
5+
.. toctree::
6+
:caption: Migration Guide:
7+
:maxdepth: 1
8+
:glob:
9+
10+
*

0 commit comments

Comments
 (0)