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 21, 2024
1 parent 2bd1fe4 commit cccb063
Show file tree
Hide file tree
Showing 54 changed files with 1,458 additions and 544 deletions.
10 changes: 5 additions & 5 deletions docs/latest/_generated/modules/PN532TokenProvider.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,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="13.1.28. PacketSniffer" href="PacketSniffer.html" />
<link rel="next" title="13.1.28. PN7160TokenProvider" href="PN7160TokenProvider.html" />
<link rel="prev" title="13.1.26. OCPPExtensionExample" href="OCPPExtensionExample.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
Expand All @@ -29,7 +29,7 @@ <h3>Navigation</h3>
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="PacketSniffer.html" title="13.1.28. PacketSniffer"
<a href="PN7160TokenProvider.html" title="13.1.28. PN7160TokenProvider"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="OCPPExtensionExample.html" title="13.1.26. OCPPExtensionExample"
Expand Down Expand Up @@ -173,8 +173,8 @@ <h4>Previous topic</h4>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="PacketSniffer.html"
title="next chapter"><span class="section-number">13.1.28. </span>PacketSniffer</a></p>
<p class="topless"><a href="PN7160TokenProvider.html"
title="next chapter"><span class="section-number">13.1.28. </span>PN7160TokenProvider</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
Expand Down Expand Up @@ -210,7 +210,7 @@ <h3>Navigation</h3>
<a href="../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="PacketSniffer.html" title="13.1.28. PacketSniffer"
<a href="PN7160TokenProvider.html" title="13.1.28. PN7160TokenProvider"
>next</a> |</li>
<li class="right" >
<a href="OCPPExtensionExample.html" title="13.1.26. OCPPExtensionExample"
Expand Down
210 changes: 210 additions & 0 deletions docs/latest/_generated/modules/PN7160TokenProvider.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,210 @@

<!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.19: https://docutils.sourceforge.io/" />

<title>13.1.28. PN7160TokenProvider &#8212; EVerest documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../_static/sphinxdoc.css" />
<link rel="stylesheet" type="text/css" href="../../_static/contentui.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/_sphinx_javascript_frameworks_compat.js"></script>
<script src="../../_static/doctools.js"></script>
<script src="../../_static/sphinx_highlight.js"></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="13.1.29. PacketSniffer" href="PacketSniffer.html" />
<link rel="prev" title="13.1.27. PN532TokenProvider" href="PN532TokenProvider.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="PacketSniffer.html" title="13.1.29. PacketSniffer"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="PN532TokenProvider.html" title="13.1.27. PN532TokenProvider"
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="../../appendix/01_everest_reference/index.html" ><span class="section-number">13. </span>EVerest Reference</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="../../appendix/01_everest_reference/modules.html" accesskey="U"><span class="section-number">13.1. </span>EVerest Modules</a> &#187;</li>
<li class="nav-item nav-item-this"><a href=""><span class="section-number">13.1.28. </span>PN7160TokenProvider</a></li>
</ul>
</div>

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

<section id="pn7160tokenprovider">
<span id="everest-modules-pn7160tokenprovider"></span><h1><span class="section-number">13.1.28. </span>PN7160TokenProvider<a class="headerlink" href="#pn7160tokenprovider" title="Permalink to this heading"></a></h1>
<div class="line-block">
<div class="line">PN7160 RFID/NFC token provider returning the token as soon as the tag can be read by the reader</div>
</div>
<p>For a detailed handwritten documentation see <a class="reference internal" href="../../_included/modules_doc/PN7160TokenProvider.html#everest-modules-handwritten-pn7160tokenprovider"><span class="std std-ref">here</span></a></p>
<section id="provides">
<h2><span class="section-number">13.1.28.1. </span>Provides<a class="headerlink" href="#provides" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><strong>main</strong>:<a class="reference internal" href="../interfaces/auth_token_provider.html#everest-interfaces-auth-token-provider"><span class="std std-ref">auth_token_provider</span></a></div>
<div class="line-block">
<div class="line">Implementation of PN7160 RFID/NFC token provider</div>
<div class="line">config:</div>
<div class="line-block">
<div class="line">token_debounce_interval_ms:</div>
<div class="line-block">
<div class="line">description:Minimal wait time in ms until next token will be published (debounce interval).</div>
<div class="line">type:integer</div>
</div>
<div class="line">disable_nfc_rfid:</div>
<div class="line-block">
<div class="line">description:Disable NFC RFID reader</div>
<div class="line">type:boolean</div>
</div>
<div class="line">debug:</div>
<div class="line-block">
<div class="line">description:Show debug output on command line.</div>
<div class="line">type:boolean</div>
</div>
</div>
<div class="line">config:</div>
<div class="line-block">
<div class="line"><strong>token_debounce_interval_ms</strong>:<em>integer</em> &lt;optional&gt;</div>
<div class="line"><em>default: 3000</em></div>
<div class="line-block">
<div class="line">Minimal wait time in ms until next token will be published (debounce interval).</div>
</div>
<div class="line"><strong>disable_nfc_rfid</strong>:<em>boolean</em> &lt;optional&gt;</div>
<div class="line"><em>default: False</em></div>
<div class="line-block">
<div class="line">Disable NFC RFID reader</div>
</div>
<div class="line"><strong>debug</strong>:<em>boolean</em> &lt;optional&gt;</div>
<div class="line"><em>default: False</em></div>
<div class="line-block">
<div class="line">Show debug output on command line.</div>
</div>
</div>
</div>
</div>
</section>
<section id="metadata">
<h2><span class="section-number">13.1.28.2. </span>Metadata<a class="headerlink" href="#metadata" title="Permalink to this heading"></a></h2>
<section id="authors">
<h3><span class="section-number">13.1.28.2.1. </span>Authors<a class="headerlink" href="#authors" title="Permalink to this heading"></a></h3>
<div class="line-block">
<div class="line">Cornelius Claussen</div>
<div class="line">Kai-Uwe Hermann</div>
<div class="line">Thilo Molitor</div>
<div class="line">Anton Wöllert</div>
<div class="line">Christoph Burandt</div>
</div>
</section>
<section id="license">
<h3><span class="section-number">13.1.28.2.2. </span>License<a class="headerlink" href="#license" title="Permalink to this heading"></a></h3>
<div class="line-block">
<div class="line"><a class="reference external" href="https://opensource.org/licenses/Apache-2.0">https://opensource.org/licenses/Apache-2.0</a></div>
</div>
</section>
</section>
</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/index.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"><a class="reference internal" href="../../general/05_existing_modules.html">5. EVerest Module Configurations</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../general/06_handling_bank_cards.html">6. Bank Card Payment</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../general/07_configure_plug_and_charge.html">7. Configure Plug&amp;Charge</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../dev_tools/index.html">8. EVerest development tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/index.html">9. Tutorials</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../general/faq.html">10. Frequently Asked Questions And Best Practices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../hardware/pionix_belay_box.html">11. Pionix BelayBox</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../appendix/02_snapshot.html">12. Snapshot</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../../appendix/01_everest_reference/index.html">13. EVerest Reference</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="../../appendix/01_everest_reference/modules.html">13.1. EVerest Modules</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../appendix/01_everest_reference/interfaces.html">13.2. EVerest Interfaces</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../appendix/01_everest_reference/types.html">13.3. EVerest Types</a></li>
</ul>
</li>
</ul>

<div>
<h4>Previous topic</h4>
<p class="topless"><a href="PN532TokenProvider.html"
title="previous chapter"><span class="section-number">13.1.27. </span>PN532TokenProvider</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="PacketSniffer.html"
title="next chapter"><span class="section-number">13.1.29. </span>PacketSniffer</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../_sources/_generated/modules/PN7160TokenProvider.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="PacketSniffer.html" title="13.1.29. PacketSniffer"
>next</a> |</li>
<li class="right" >
<a href="PN532TokenProvider.html" title="13.1.27. PN532TokenProvider"
>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="../../appendix/01_everest_reference/index.html" ><span class="section-number">13. </span>EVerest Reference</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="../../appendix/01_everest_reference/modules.html" ><span class="section-number">13.1. </span>EVerest Modules</a> &#187;</li>
<li class="nav-item nav-item-this"><a href=""><span class="section-number">13.1.28. </span>PN7160TokenProvider</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> 5.3.0.
</div>
</body>
</html>
Loading

0 comments on commit cccb063

Please sign in to comment.