feedc0de/esp-protocols
1
0 Fork 0
forked from espressif/esp-protocols
Code Pull Requests Activity

Final cleanup of the docs and examples

Browse Source
This commit is contained in:
David Cermak committed 2021-10-04 11:32:55 +02:00
1 parent 6e9ddbef32
commit ac475f2560
30 files changed
+359 -332
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

esp_modem/docs/advanced_api.rst
+4 -1
View File
@@ -31,11 +31,14 @@ the specific module, using :cpp:func:`esp_modem::dce_factory::Factory::build`.
Please refer to the implementation of the existing modules.
Please note that the ``modem_console`` example defines a trivial custom modem DCE which overrides one command,
for demonstration purposes only.
Create new communication interface
----------------------------------
In order to connect to a device using an unsuppoeted interface (e.g. SPI or I2C), it is necessary to implement
In order to connect to a device using an unsupported interface (e.g. SPI or I2C), it is necessary to implement
a custom DTE object and supply it into :ref:`the DCE factory<dce_factory>`. The DCE is typically created in two steps:
- Define and create the corresponding terminal, which can communicate on the custom interface. This terminal should support basic IO methods defined in :cpp:class:`esp_modem::Terminal` and derive from it.