Skip to content

Commit

Permalink
Add doc build snapshot nightly
Browse files Browse the repository at this point in the history
  • Loading branch information
pionix-compiler committed Dec 12, 2023
1 parent 12e2828 commit 9f03276
Show file tree
Hide file tree
Showing 26 changed files with 528 additions and 166 deletions.
1 change: 1 addition & 0 deletions docs/latest/_generated/modules/EvseSlac.html
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ <h3>Navigation</h3>
<div class="line-block">
<div class="line">Implementation of SLAC data link negotiation according to ISO15118-3.</div>
</div>
<p>For a detailed handwritten documentation see <span class="xref std std-ref">here</span></p>
<section id="provides">
<h2><span class="section-number">11.1.13.1. </span>Provides<a class="headerlink" href="#provides" title="Permalink to this heading"></a></h2>
<div class="line-block">
Expand Down
10 changes: 5 additions & 5 deletions docs/latest/_included/modules_doc/EvseManager.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<script src="../../_static/contentui.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="5.2.2. GenericPowermeter" href="GenericPowermeter.html" />
<link rel="next" title="5.2.2. EvseSlac" href="EvseSlac.html" />
<link rel="prev" title="5. EVerest Module Configurations" href="../../general/05_existing_modules.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
Expand All @@ -25,7 +25,7 @@ <h3>Navigation</h3>
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="GenericPowermeter.html" title="5.2.2. GenericPowermeter"
<a href="EvseSlac.html" title="5.2.2. EvseSlac"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="../../general/05_existing_modules.html" title="5. EVerest Module Configurations"
Expand Down Expand Up @@ -226,8 +226,8 @@ <h4>Previous topic</h4>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="GenericPowermeter.html"
title="next chapter"><span class="section-number">5.2.2. </span>GenericPowermeter</a></p>
<p class="topless"><a href="EvseSlac.html"
title="next chapter"><span class="section-number">5.2.2. </span>EvseSlac</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
Expand Down Expand Up @@ -263,7 +263,7 @@ <h3>Navigation</h3>
<a href="../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="GenericPowermeter.html" title="5.2.2. GenericPowermeter"
<a href="EvseSlac.html" title="5.2.2. EvseSlac"
>next</a> |</li>
<li class="right" >
<a href="../../general/05_existing_modules.html" title="5. EVerest Module Configurations"
Expand Down
153 changes: 153 additions & 0 deletions docs/latest/_included/modules_doc/EvseSlac.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,153 @@
<!DOCTYPE html>

<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>5.2.2. EvseSlac &#8212; EVerest documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=649a27d8" />
<link rel="stylesheet" type="text/css" href="../../_static/sphinxdoc.css?v=0a676766" />
<link rel="stylesheet" type="text/css" href="../../_static/contentui.css" />
<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=b3ba4146"></script>
<script src="../../_static/doctools.js?v=888ff710"></script>
<script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
<script src="../../_static/contentui.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="5.2.4. GenericPowermeter" href="GenericPowermeter.html" />
<link rel="prev" title="5.2.1. EvseManager" href="EvseManager.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="GenericPowermeter.html" title="5.2.4. GenericPowermeter"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="EvseManager.html" title="5.2.1. EvseManager"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html">EVerest documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../general/05_existing_modules.html" accesskey="U"><span class="section-number">5. </span>EVerest Module Configurations</a> &#187;</li>
<li class="nav-item nav-item-this"><a href=""><span class="section-number">5.2.2. </span>EvseSlac</a></li>
</ul>
</div>

<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">

<section id="evseslac">
<h1><span class="section-number">5.2.2. </span>EvseSlac<a class="headerlink" href="#evseslac" title="Permalink to this heading"></a></h1>
<p>This is an implementation of the ISO 15118-3 EVSE side SLAC protocol.
The general flow of operation will be like this:</p>
<ul class="simple">
<li><p>start of operation begins with a control pilot transition from state
A, E or F to Bx, Cx or Dx. This is indicated by the EvseManager by calling
the commands enter_bcd/leave_bcd.</p></li>
<li><p>Once started, it waits for a CM_SLAC_PARM_REQ from the EV side to start the SLAC session.</p></li>
<li><p>In case of success, SLAC finishes with a CM_SLAC_MATCH_RES, which sends a new NMK to the EV side.
The EV then joins the logical network and the two modems are paired. A dlink_ready(true) is published
to signal to the EvseManager that the low level PLC link is ready for communication.</p></li>
</ul>
<p>If not run as root user, this modules requires the capability CAP_NET_RAW.</p>
</section>
<section id="todo">
<h1><span class="section-number">5.2.3. </span>Todo<a class="headerlink" href="#todo" title="Permalink to this heading"></a></h1>
<ul class="simple">
<li><p>make use of the enable flag in the reset command or drop it, if not needed</p></li>
<li><p>handle CM_VALIDATE.REQ message</p></li>
<li><p>implement PLC chip resetting after unplug or failed SLAC sessions (especially for QCA chips)</p></li>
</ul>
</section>


<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="../../index.html">Table of Contents</a></h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../../general/01_framework.html">1. EVerest framework</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../general/02_detail_pre_setup.html">2. Prepare Your Development Environment</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../general/03_quick_start_guide.html">3. A Kind Of Quick Guide To EVerest</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../general/04_detail_module_concept.html">4. EVerest Modules in Detail</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../../general/05_existing_modules.html">5. EVerest Module Configurations</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../../general/05_existing_modules.html#module-connections-for-dedicated-use-cases">5.1. Module connections for dedicated use cases</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="../../general/05_existing_modules.html#module-functionality-in-detail">5.2. Module functionality in detail</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../dev_tools/index.html">6. EVerest development tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/index.html">7. Tutorials</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../general/faq.html">8. Frequently Asked Questions And Best Practices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../hardware/pionix_belay_box.html">9. Pionix BelayBox</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../appendix/02_snapshot.html">10. Snapshot</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../appendix/01_everest_reference/index.html">11. EVerest Reference</a></li>
</ul>

<div>
<h4>Previous topic</h4>
<p class="topless"><a href="EvseManager.html"
title="previous chapter"><span class="section-number">5.2.1. </span>EvseManager</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="GenericPowermeter.html"
title="next chapter"><span class="section-number">5.2.4. </span>GenericPowermeter</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../_sources/_included/modules_doc/EvseSlac.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div><h3>Community</h3>
<ul class="nav nav-sidebar">
<li><a href="https://lists.lfenergy.org/g/everest" target="_blank"><img src="../../_static/icons/mail.svg" style="height: 0.8em" /> Get Support</a></li>
<li><a href="https://www.youtube.com/@lfe_everest" target="_blank"><img src="../../_static/icons/youtube.svg" style="height: 0.8em" /> YouTube Channel</a></li>
<li><a href="https://twitter.com/everestincharge" target="_blank"><img src="../../_static/icons/twitter.svg" style="height: 0.8em" /> Twitter</a></li>
<li><a href="https://fosstodon.org/@EVerest" target="_blank">Mastodon</a></li>
</ul>
<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>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="GenericPowermeter.html" title="5.2.4. GenericPowermeter"
>next</a> |</li>
<li class="right" >
<a href="EvseManager.html" title="5.2.1. EvseManager"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html">EVerest documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../general/05_existing_modules.html" ><span class="section-number">5. </span>EVerest Module Configurations</a> &#187;</li>
<li class="nav-item nav-item-this"><a href=""><span class="section-number">5.2.2. </span>EvseSlac</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2021, Pionix GmbH.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.1.2.
</div>
</body>
</html>
Loading

0 comments on commit 9f03276

Please sign in to comment.