4114c663b5
* Update sigmadelta docs * minor docs updates * Added migration guide to docs * Update Introduction to migration guide * update formatting * fix typo * Add BLE breaking changes * Apply changes from code review by @lucasssvaz Co-authored-by: Lucas Saavedra Vaz <lucassvaz@yahoo.com.br> * uart migration * added RMT and UART + links fix * fix renamed BLE examples * Apply suggestions from code review by @lucasssvaz Co-authored-by: Lucas Saavedra Vaz <lucassvaz@yahoo.com.br> * Change UART driver changes to HardwareSerial changes * update sigmadelta * BLE and examples update + rename --------- Co-authored-by: Lucas Saavedra Vaz <lucassvaz@yahoo.com.br>
78 lines
2 KiB
ReStructuredText
78 lines
2 KiB
ReStructuredText
##########
|
|
SigmaDelta
|
|
##########
|
|
|
|
About
|
|
-----
|
|
|
|
ESP32 provides a second-order sigma delta modulation module and 8 (4 for ESP32-C3)
|
|
independent modulation channels. The channels are capable to output 1-bit
|
|
signals (output index: 100 ~ 107) with sigma delta modulation.
|
|
|
|
========= =============================
|
|
ESP32 SoC Number of SigmaDelta channels
|
|
========= =============================
|
|
ESP32 8
|
|
ESP32-S2 8
|
|
ESP32-S3 8
|
|
ESP32-C3 4
|
|
ESP32-C6 4
|
|
ESP32-H2 4
|
|
========= =============================
|
|
|
|
Arduino-ESP32 SigmaDelta API
|
|
----------------------------
|
|
|
|
sigmaDeltaAttach
|
|
****************
|
|
|
|
This function is used to set up the SigmaDelta channel with the selected frequency and attach it to the selected pin.
|
|
|
|
.. code-block:: arduino
|
|
|
|
bool sigmaDeltaAttach(uint8_t pin, uint32_t freq);
|
|
|
|
* ``pin`` select GPIO pin.
|
|
* ``freq`` select frequency.
|
|
|
|
* range is 1-14 bits (1-20 bits for ESP32).
|
|
|
|
This function returns ``true`` if the configuration was successful.
|
|
If ``false`` is returned, an error occurred and the SigmaDelta channel was not configured.
|
|
|
|
sigmaDeltaWrite
|
|
***************
|
|
|
|
This function is used to set duty for the SigmaDelta pin.
|
|
|
|
.. code-block:: arduino
|
|
|
|
bool sigmaDeltaWrite(uint8_t pin, uint8_t duty);
|
|
|
|
* ``pin`` selects the GPIO pin.
|
|
* ``duty`` selects the duty to be set for selected pin.
|
|
|
|
This function returns ``true`` if setting the duty was successful.
|
|
If ``false`` is returned, error occurs and duty was not set.
|
|
|
|
sigmaDeltaDetach
|
|
****************
|
|
|
|
This function is used to detach a pin from SigmaDelta and deinitialize the channel that was attached to the pin.
|
|
|
|
.. code-block:: arduino
|
|
|
|
bool sigmaDeltaDetach(uint8_t pin);
|
|
|
|
* ``pin`` select GPIO pin.
|
|
|
|
This function returns ``true`` if detaching was successful.
|
|
If ``false`` is returned, an error occurred and pin was not detached.
|
|
|
|
Example Applications
|
|
********************
|
|
|
|
Here is example use of SigmaDelta:
|
|
|
|
.. literalinclude:: ../../../libraries/ESP32/examples/AnalogOut/SigmaDelta/SigmaDelta.ino
|
|
:language: arduino
|