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