Files
esp-protocols/esp_modem/index.html

174 lines
8.0 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18: http://docutils.sourceforge.net/" />
<title>ESP-MODEM Programmers manual &#8212; esp-modem documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="ESP MODEM" href="README.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="esp-modem-programmers-manual">
<h1>ESP-MODEM Programmers manual<a class="headerlink" href="#esp-modem-programmers-manual" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="README.html">Brief intro</a><ul>
<li class="toctree-l2"><a class="reference internal" href="README.html#modem-components">Modem components</a><ul>
<li class="toctree-l3"><a class="reference internal" href="README.html#dce">DCE</a></li>
<li class="toctree-l3"><a class="reference internal" href="README.html#dte">DTE</a></li>
<li class="toctree-l3"><a class="reference internal" href="README.html#ppp-netif">PPP netif</a></li>
<li class="toctree-l3"><a class="reference internal" href="README.html#module">Module</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="README.html#use-cases">Use cases</a></li>
<li class="toctree-l2"><a class="reference internal" href="README.html#extensibility">Extensibility</a><ul>
<li class="toctree-l3"><a class="reference internal" href="README.html#cmux">CMUX</a></li>
<li class="toctree-l3"><a class="reference internal" href="README.html#dte-s">DTEs</a></li>
<li class="toctree-l3"><a class="reference internal" href="README.html#other-devices">Other devices</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api_docs.html">C interface</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api_docs.html#lifecycle-api">Lifecycle API</a></li>
<li class="toctree-l2"><a class="reference internal" href="api_docs.html#modem-commands">Modem commands</a></li>
<li class="toctree-l2"><a class="reference internal" href="api_docs.html#configuration-structures">Configuration structures</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cxx_api_docs.html">C++ interface</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cxx_api_docs.html#create-dte-and-dce">Create DTE and DCE</a></li>
<li class="toctree-l2"><a class="reference internal" href="cxx_api_docs.html#mode-switching-commands">Mode switching commands</a></li>
<li class="toctree-l2"><a class="reference internal" href="cxx_api_docs.html#modem-commands">Modem commands</a></li>
<li class="toctree-l2"><a class="reference internal" href="cxx_api_docs.html#destroy-the-dce">Destroy the DCE</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="advanced_api.html">Advanced use cases</a><ul>
<li class="toctree-l2"><a class="reference internal" href="advanced_api.html#custom-instantiation-with-dce-factory">Custom instantiation with DCE factory</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced_api.html#create-custom-module">Create custom module</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced_api.html#create-new-communication-interface">Create new communication interface</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="internal_design.html">Internal design</a><ul>
<li class="toctree-l2"><a class="reference internal" href="internal_design.html#design-decisions">Design decisions</a></li>
<li class="toctree-l2"><a class="reference internal" href="internal_design.html#dce-collaboration-model">DCE collaboration model</a></li>
<li class="toctree-l2"><a class="reference internal" href="internal_design.html#terminal-inheritance">Terminal inheritance</a></li>
<li class="toctree-l2"><a class="reference internal" href="internal_design.html#cmux-terminal">CMUX terminal</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="internal_docs.html">Internal implementation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="internal_docs.html#dte-abstraction">DTE abstraction</a><ul>
<li class="toctree-l3"><a class="reference internal" href="internal_docs.html#terminal-interface">Terminal interface</a></li>
<li class="toctree-l3"><a class="reference internal" href="internal_docs.html#cmux-implementation">CMUX implementation</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="internal_docs.html#netif">Netif</a></li>
<li class="toctree-l2"><a class="reference internal" href="internal_docs.html#module-abstraction">Module abstraction</a><ul>
<li class="toctree-l3"><a class="reference internal" href="internal_docs.html#adding-new-devices">Adding new devices</a></li>
<li class="toctree-l3"><a class="reference internal" href="internal_docs.html#implement-a-new-generic-command">Implement a new generic command</a></li>
<li class="toctree-l3"><a class="reference internal" href="internal_docs.html#command-library">Command library</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="internal_docs.html#modem-types">Modem types</a></li>
</ul>
</li>
</ul>
</div>
</section>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="#">esp-modem</a></h1>
<h3>Navigation</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="README.html">Brief intro</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_docs.html">C interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="cxx_api_docs.html">C++ interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="advanced_api.html">Advanced use cases</a></li>
<li class="toctree-l1"><a class="reference internal" href="internal_design.html">Internal design</a></li>
<li class="toctree-l1"><a class="reference internal" href="internal_docs.html">Internal implementation</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="#">Documentation overview</a><ul>
<li>Next: <a href="README.html" title="next chapter">ESP MODEM</a></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2016 - 2021, Espressif Systems (Shanghai) Co., Ltd.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.3.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
<a href="_sources/index.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>