Skip to content

Commit 2f374bb

Browse files
committed
update formatting
1 parent bec517e commit 2f374bb

File tree

1 file changed

+25
-30
lines changed

1 file changed

+25
-30
lines changed

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

Lines changed: 25 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -8,117 +8,112 @@ Introduction
88
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.
99
For more informations about all changes and new features check `RELESE NOTES <https://github.com/espressif/arduino-esp32/releases>`_.
1010

11-
Breaking changes in API
12-
-----------------------
13-
14-
We all know how important documentation is. This project is no different.
15-
1611
ADC
17-
***
12+
---
1813

1914
Removed APIs
20-
^^^^^^^^^^^^
15+
************
2116

2217
* ``analogSetClockDiv``
2318
* ``adcAttachPin``
2419
* ``analogSetVRefPin``
2520

2621

2722
Hall Sensor
28-
***********
23+
-----------
2924

3025
Hall sensor is no longer supported.
3126

3227
Removed APIs
33-
^^^^^^^^^^^^
28+
************
3429

3530
* ``hallRead``
3631

3732
I2S
38-
***
33+
---
3934

4035
I2S driver has beed completely redesigned and refactored to use new ESP-IDF driver.
4136
For more informations about the new API check `I2S API <https://docs.espressif.com/projects/arduino-esp32/en/latest/api/i2s.html>`_.
4237

4338
LEDC
44-
****
39+
----
4540

4641
LEDC API has been changed in order to support the Peripheral Manager and easier use as LEDC channels are now automaticaly assigned to pins.
4742
For more informations about the new API check `LEDC API <https://docs.espressif.com/projects/arduino-esp32/en/latest/api/ledc.html>`_.
4843

4944
Removed APIs
50-
^^^^^^^^^^^^
45+
************
5146

5247
* ``ledcSetup``
5348
* ``ledcAttachPin``
5449

5550
New APIs
56-
^^^^^^^^
51+
********
5752

5853
* ``ledcAttach`` used to setup LEDC pin (merged ``ledcSetup`` and ``ledcAttachPin`` functions).
5954
* ``timerGetFrequency`` used to get actual frequency of the timer.
6055
* ``timerAttachInterruptArg`` used to attach interrupt to timer using argument.
6156

6257
Changes in APIs
63-
^^^^^^^^^^^^^^^
58+
***************
6459

6560
* ``ledcDetachPin`` renamed to ``ledcDetach``.
6661
* In all functions input parameter ``channel`` have been changed to ``pin``.
6762

6863
RMT
69-
****
64+
---
7065

7166
TODO:
7267
For more informations about the new API check `RMT API <https://docs.espressif.com/projects/arduino-esp32/en/latest/api/rmt.html>`_.
7368

7469
Removed APIs
75-
^^^^^^^^^^^^
70+
************
7671

7772
TODO:
7873

7974
New APIs
80-
^^^^^^^^
75+
********
8176

8277
TODO:
8378

8479
Changes in APIs
85-
^^^^^^^^^^^^^^^
80+
***************
8681

8782
TODO:
8883

8984
SigmaDelta
90-
**********
85+
----------
9186

9287
SigmaDelta has been refactored to use new ESP-IDF driver.
9388
For more informations about the new API check `SigmaDelta API <https://docs.espressif.com/projects/arduino-esp32/en/latest/api/sigmadelta.html>`_.
9489

9590
Removed APIs
96-
^^^^^^^^^^^^
91+
************
9792

9893
* ``sigmaDeltaSetup``
9994
* ``sigmaDeltaRead``
10095

10196
New APIs
102-
^^^^^^^^
97+
********
10398

10499
* ``sigmaDeltaAttach`` used to setup SigmaDelta pin (channel is aquired automatically).
105100
* ``timerGetFrequency`` used to get actual frequency of the timer.
106101
* ``timerAttachInterruptArg`` used to attach interrupt to timer using argument.
107102

108103
Changes in APIs
109-
^^^^^^^^^^^^^^^
104+
***************
110105

111106
* ``sigmaDeltaDetachPin`` renamed to ``sigmaDeltaDetach``.
112107
* ``sigmaDeltaWrite`` input parameter ``channel`` have been changed to ``pin``.
113108

114109
Timer
115-
*****
110+
-----
116111

117112
Timer has been refactored to use new ESP-IDF driver and its API got simplified. For more informations about the new API check
118113
`TIMER API <https://docs.espressif.com/projects/arduino-esp32/en/latest/api/timer.html>`_.
119114

120115
Removed APIs
121-
^^^^^^^^^^^^
116+
************
122117

123118
* ``timerGetConfig``
124119
* ``timerSetConfig``
@@ -138,36 +133,36 @@ Removed APIs
138133
* ``timerAttachInterruptFlag``
139134

140135
New APIs
141-
^^^^^^^^
136+
********
142137

143138
* ``timerAlarm`` used to setup Alarm for timer and enables it automaticaly (merged ``timerAlarmWrite`` and ``timerAlarmEnable`` functions).
144139
* ``timerGetFrequency`` used to get actual frequency of the timer.
145140
* ``timerAttachInterruptArg`` used to attach interrupt to timer using argument.
146141

147142
Changes in APIs
148-
^^^^^^^^^^^^^^^
143+
***************
149144

150145
* ``timerBegin`` now have only 1 parameter wich is frequency. There is an automatic calculation of divider through different clock sources¨
151146
to achieve selected frequency.
152147
* ``timerAttachInterrupt`` now have only 2 parameters -> parameter ``edge`` has been removed.
153148

154149
UART
155-
****
150+
----
156151

157152
TODO:
158153
For more informations about the new API check `UART API <https://docs.espressif.com/projects/arduino-esp32/en/latest/api/rmt.html>`_.
159154

160155
Removed APIs
161-
^^^^^^^^^^^^
156+
************
162157

163158
TODO:
164159

165160
New APIs
166-
^^^^^^^^
161+
********
167162

168163
TODO:
169164

170165
Changes in APIs
171-
^^^^^^^^^^^^^^^
166+
***************
172167

173168
TODO:

0 commit comments

Comments
 (0)