You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/migration_guide/2.x_to_3.0.rst
+25-25
Original file line number
Diff line number
Diff line change
@@ -5,8 +5,8 @@ Migration from 2.x to 3.0
5
5
Introduction
6
6
------------
7
7
8
-
This is a guide to show breaking changes in API and to help migrate projects from 2.X version to 3.0 version of Arduino ESP32 core.
9
-
For more informations about all changes and new features check `RELESE NOTES <https://github.com/espressif/arduino-esp32/releases>`_.
8
+
This is a guide to highlight breaking changes in the API and to help the migration of projects from versions 2.X to version 3.0 of the Arduino ESP32 core.
9
+
For more information about the changes and new features, check `RELEASE NOTES <https://github.com/espressif/arduino-esp32/releases>`_.
10
10
11
11
ADC
12
12
---
@@ -40,14 +40,14 @@ Removed APIs
40
40
I2S
41
41
---
42
42
43
-
I2S driver has beed completely redesigned and refactored to use new ESP-IDF driver.
44
-
For more informations about the new API check `I2S API <https://docs.espressif.com/projects/arduino-esp32/en/latest/api/i2s.html>`_.
43
+
The I2S driver has been completely redesigned and refactored to use the new ESP-IDF driver.
44
+
For more information about the new API, check `I2S API <https://docs.espressif.com/projects/arduino-esp32/en/latest/api/i2s.html>`_.
45
45
46
46
LEDC
47
47
----
48
48
49
-
LEDC API has been changed in order to support the Peripheral Manager and easier use as LEDC channels are now automaticaly assigned to pins.
50
-
For more informations about the new API check `LEDC API <https://docs.espressif.com/projects/arduino-esp32/en/latest/api/ledc.html>`_.
49
+
The LEDC API has been changed in order to support the Peripheral Manager and make it easier to use, as LEDC channels are now automatically assigned to pins.
50
+
For more information about the new API, check `LEDC API <https://docs.espressif.com/projects/arduino-esp32/en/latest/api/ledc.html>`_.
51
51
52
52
Removed APIs
53
53
************
@@ -58,21 +58,21 @@ Removed APIs
58
58
New APIs
59
59
********
60
60
61
-
* ``ledcAttach`` used to setup LEDC pin (merged ``ledcSetup`` and ``ledcAttachPin`` functions).
62
-
* ``timerGetFrequency`` used to get actual frequency of the timer.
63
-
* ``timerAttachInterruptArg`` used to attach interrupt to timer using argument.
61
+
* ``ledcAttach`` used to set up the LEDC pin (merged ``ledcSetup`` and ``ledcAttachPin`` functions).
62
+
* ``timerGetFrequency`` used to get the actual frequency of the timer.
63
+
* ``timerAttachInterruptArg`` used to attach the interrupt to a timer using arguments.
64
64
65
65
Changes in APIs
66
66
***************
67
67
68
68
* ``ledcDetachPin`` renamed to ``ledcDetach``.
69
-
* In all functions input parameter ``channel`` have been changed to ``pin``.
69
+
* In all functions, input parameter ``channel`` has been changed to ``pin``.
70
70
71
71
RMT
72
72
---
73
73
74
74
TODO:
75
-
For more informations about the new API check `RMT API <https://docs.espressif.com/projects/arduino-esp32/en/latest/api/rmt.html>`_.
75
+
For more information about the new API, check `RMT API <https://docs.espressif.com/projects/arduino-esp32/en/latest/api/rmt.html>`_.
76
76
77
77
Removed APIs
78
78
************
@@ -92,8 +92,8 @@ TODO:
92
92
SigmaDelta
93
93
----------
94
94
95
-
SigmaDelta has been refactored to use new ESP-IDF driver.
96
-
For more informations about the new API check `SigmaDelta API <https://docs.espressif.com/projects/arduino-esp32/en/latest/api/sigmadelta.html>`_.
95
+
SigmaDelta has been refactored to use the new ESP-IDF driver.
96
+
For more information about the new API, check `SigmaDelta API <https://docs.espressif.com/projects/arduino-esp32/en/latest/api/sigmadelta.html>`_.
97
97
98
98
Removed APIs
99
99
************
@@ -104,20 +104,20 @@ Removed APIs
104
104
New APIs
105
105
********
106
106
107
-
* ``sigmaDeltaAttach`` used to setup SigmaDelta pin (channel is aquired automatically).
108
-
* ``timerGetFrequency`` used to get actual frequency of the timer.
109
-
* ``timerAttachInterruptArg`` used to attach interrupt to timer using argument.
107
+
* ``sigmaDeltaAttach`` used to set up the SigmaDelta pin (channel is acquired automatically).
108
+
* ``timerGetFrequency`` used to get the actual frequency of the timer.
109
+
* ``timerAttachInterruptArg`` used to attach the interrupt to a timer using arguments.
110
110
111
111
Changes in APIs
112
112
***************
113
113
114
114
* ``sigmaDeltaDetachPin`` renamed to ``sigmaDeltaDetach``.
115
-
* ``sigmaDeltaWrite`` input parameter ``channel`` have been changed to ``pin``.
115
+
* ``sigmaDeltaWrite`` input parameter ``channel`` has been changed to ``pin``.
116
116
117
117
Timer
118
118
-----
119
119
120
-
Timer has been refactored to use new ESP-IDF driver and its API got simplified. For more informations about the new API check
120
+
Timer has been refactored to use the new ESP-IDF driver and its API got simplified. For more information about the new API check
121
121
`TIMER API <https://docs.espressif.com/projects/arduino-esp32/en/latest/api/timer.html>`_.
122
122
123
123
Removed APIs
@@ -143,22 +143,22 @@ Removed APIs
143
143
New APIs
144
144
********
145
145
146
-
* ``timerAlarm`` used to setup Alarm for timer and enables it automaticaly (merged ``timerAlarmWrite`` and ``timerAlarmEnable`` functions).
147
-
* ``timerGetFrequency`` used to get actual frequency of the timer.
148
-
* ``timerAttachInterruptArg`` used to attach interrupt to timer using argument.
146
+
* ``timerAlarm`` used to set up Alarm for the timer and enable it automatically (merged ``timerAlarmWrite`` and ``timerAlarmEnable`` functions).
147
+
* ``timerGetFrequency`` used to get the actual frequency of the timer.
148
+
* ``timerAttachInterruptArg`` used to attach the interrupt to a timer using arguments.
149
149
150
150
Changes in APIs
151
151
***************
152
152
153
-
* ``timerBegin`` now have only 1 parameter wich is frequency. There is an automatic calculation of divider through different clock sources¨
154
-
to achieve selected frequency.
155
-
* ``timerAttachInterrupt`` now have only 2 parameters -> parameter ``edge`` has been removed.
153
+
* ``timerBegin`` has now only 1 parameter (frequency). There is an automatic calculation of the divider using different clock sources
154
+
to achieve the selected frequency.
155
+
* ``timerAttachInterrupt`` has now only 2 parameters. The ``edge`` parameter has been removed.
156
156
157
157
UART
158
158
----
159
159
160
160
TODO:
161
-
For more informations about the new API check `UART API <https://docs.espressif.com/projects/arduino-esp32/en/latest/api/rmt.html>`_.
161
+
For more information about the new API, check `UART API <https://docs.espressif.com/projects/arduino-esp32/en/latest/api/rmt.html>`_.
0 commit comments