OVMS3-idf/docs/en/api-reference/peripherals/sigmadelta.rst

Sigma-delta Modulation
======================

Introduction
------------

{IDF_TARGET_NAME} has a second-order sigma-delta modulation module. This driver configures the channels of the sigma-delta module.

Functionality Overview
----------------------

There are eight independent sigma-delta modulation channels identified with :cpp:type:`sigmadelta_channel_t`. Each channel is capable to output the binary, hardware generated signal with the sigma-delta modulation.

Selected channel should be set up by providing configuration parameters in :cpp:type:`sigmadelta_config_t` and then applying this configuration with :cpp:func:`sigmadelta_config`.

Another option is to call individual functions, that will configure all required parameters one by one:

* **Prescaler** of the sigma-delta generator - :cpp:func:`sigmadelta_set_prescale`
* **Duty** of the output signal - :cpp:func:`sigmadelta_set_duty`
* **GPIO pin** to output modulated signal - :cpp:func:`sigmadelta_set_pin`

The range of the 'duty' input parameter of :cpp:func:`sigmadelta_set_duty` is from -128 to 127 (eight bit signed integer). If zero value is set, then the output signal's duty will be about 50%, see description of :cpp:func:`sigmadelta_set_duty`.

Application Example
-------------------

Sigma-delta Modulation example: :example:`peripherals/sigmadelta`.

API Reference
-------------

.. include-build-file:: inc/sigmadelta.inc
.. include-build-file:: inc/sigmadelta_types.inc
driver: sigma-delta 1. add sigma-delta code and example. 2. add gpio output signal in io matrix. Squashed commits: [a25e7d4] minor changes for doc [6a03a1e] minor changes on comments and doc. [97dd9e4] Add doc. update index.rst change example index 2016-11-23 08:28:16 +00:00			`Sigma-delta Modulation`
docs: fix some of the Sphinx warnings 2017-01-15 18:07:46 +00:00			`======================`
driver: sigma-delta 1. add sigma-delta code and example. 2. add gpio output signal in io matrix. Squashed commits: [a25e7d4] minor changes for doc [6a03a1e] minor changes on comments and doc. [97dd9e4] Add doc. update index.rst change example index 2016-11-23 08:28:16 +00:00
Updated sigma delta API documenation and example 2017-09-25 19:20:48 +00:00			`Introduction`
			`------------`
driver: sigma-delta 1. add sigma-delta code and example. 2. add gpio output signal in io matrix. Squashed commits: [a25e7d4] minor changes for doc [6a03a1e] minor changes on comments and doc. [97dd9e4] Add doc. update index.rst change example index 2016-11-23 08:28:16 +00:00
doc: updated peripherals api-reference for s2 2019-12-13 03:49:10 +00:00			`{IDF_TARGET_NAME} has a second-order sigma-delta modulation module. This driver configures the channels of the sigma-delta module.`
Updated sigma delta API documenation and example 2017-09-25 19:20:48 +00:00
doc: updated peripherals api-reference for s2 2019-12-13 03:49:10 +00:00			`Functionality Overview`
Updated sigma delta API documenation and example 2017-09-25 19:20:48 +00:00			`----------------------`

			There are eight independent sigma-delta modulation channels identified with :cpp:type:`sigmadelta_channel_t`. Each channel is capable to output the binary, hardware generated signal with the sigma-delta modulation.

			Selected channel should be set up by providing configuration parameters in :cpp:type:`sigmadelta_config_t` and then applying this configuration with :cpp:func:`sigmadelta_config`.

			`Another option is to call individual functions, that will configure all required parameters one by one:`

			* Prescaler of the sigma-delta generator - :cpp:func:`sigmadelta_set_prescale`
			* Duty of the output signal - :cpp:func:`sigmadelta_set_duty`
			* GPIO pin to output modulated signal - :cpp:func:`sigmadelta_set_pin`

			The range of the 'duty' input parameter of :cpp:func:`sigmadelta_set_duty` is from -128 to 127 (eight bit signed integer). If zero value is set, then the output signal's duty will be about 50%, see description of :cpp:func:`sigmadelta_set_duty`.
driver: sigma-delta 1. add sigma-delta code and example. 2. add gpio output signal in io matrix. Squashed commits: [a25e7d4] minor changes for doc [6a03a1e] minor changes on comments and doc. [97dd9e4] Add doc. update index.rst change example index 2016-11-23 08:28:16 +00:00
			`Application Example`
			`-------------------`

docs: use custom roles to generate GitHub links This change replaces direct links to GitHub master branch with auto-generated links using docutils custom roles. These auto-generated links point to the tree or blob for the git commit ID (or tag) of the repository. This is needed to ensure that links don’t become broken when files in master branch are moved around or deleted. The following roles are introduced: - :idf:`path` - points to directory inside ESP-IDF - :idf_blob:`path` - points to file inside ESP-IDF - :idf_raw:`path` - points to raw view of the file inside ESP-IDF - :component:`path` - points to directory inside ESP-IDF components dir - :component_blob:`path` - points to file inside ESP-IDF components dir - :component_raw:`path` - points to raw view of the file inside ESP-IDF components dir - :example:`path` - points to directory inside ESP-IDF examples dir - :example_blob:`path` - points to file inside ESP-IDF examples dir - :example_raw:`path` - points to raw view of the file inside ESP-IDF examples dir A check is added to the CI build script, which searches RST files for presence of hard-coded links (identified by tree/master, blob/master, or raw/master part of the URL). This check can be run manually: cd docs && make gh-linkcheck Additionally, Sphinx linkcheck build type is used to create new CI test, which check for broken links. This test has to be triggered explicitly, because including it in normal build process (when the commit is not yet deployed to Github) will not work. It can be triggered in a regular fashion using a combination of cron and Curl, similar to stress tests. 2017-01-19 08:16:06 +00:00			Sigma-delta Modulation example: :example:`peripherals/sigmadelta`.
driver: sigma-delta 1. add sigma-delta code and example. 2. add gpio output signal in io matrix. Squashed commits: [a25e7d4] minor changes for doc [6a03a1e] minor changes on comments and doc. [97dd9e4] Add doc. update index.rst change example index 2016-11-23 08:28:16 +00:00
			`API Reference`
			`-------------`

docs: add new top-level docs builder that builds docs for a single chip 2019-11-13 03:46:16 +00:00			`.. include-build-file:: inc/sigmadelta.inc`
doc: add peripheral_types.h as API reference for peripheral docs Closes DOC-136 Closes IDF-1673 2020-04-28 02:52:14 +00:00			`.. include-build-file:: inc/sigmadelta_types.inc`