{% extends "defindex.html" %}
{% block body %}

  <h1>Pycom Documentation</h1>

  <p>
    Welcome to the Pycom documentation site. The documentation is split into 5 sections; we recommend reading through all the sections to familiarize yourself with the various tools and features available to you to help you develop on your Pycom module.
  </p>
  <p>
    All the new Pycom modules are based on the same ESP32 chip and therefore share similar schematics, pinouts &amp; firmware. Majority of the documentation is applicable for all Pycom devices, with separate sections for tutorials and firmware references.
</p>
<p>
    To get started, read through the <strong><a class="biglink" href="{{ pathto(port + "/getstarted") }}">Quickstart Guide</a></strong> then feel free to jump straight into the tutorials and examples in <strong><a class="biglink" href="{{ pathto(port + "/tutorial/index") }}">Tutorials &amp; Examples</a></strong> to begin building your projects.
  </p>

  <div class="admonition note">
  	<p class="first admonition-title">Note</p>
  	<p class="last">Note that this documentation is <strong>only for our ESP32 based products</strong> such as the LoPy, SiPy and WiPy 2.0. For the WiPy 1.0 (which uses the CC3200), please go to <a href="https://docs.pycom.io/wipy/" target="_blank">docs.pycom.io/wipy</a>.</p>
    </div>

  <p>
    We continue to add to our documentation as we update our software/firmware and welcome any suggestions or improvements!
  </p>


  {% if port == 'pycom_esp32' %}
  <table class="contentstable"><tr>
    <td width="40%" style="padding-left:2em;">
        <p class="biglink">
          <a class="biglink" href="{{ pathto(port + "/getstarted") }}">1. Quickstart Guide</a><br/>
          <span class="linkdescr">Connect your Pycom module and run your first lines of code.</span>
        </p>
        <p class="biglink">
          <a class="biglink" href="{{ pathto(port + "/tutorial/index") }}">3. Tutorials &amp; Examples</a><br/>
          <span class="linkdescr">Examples, code snippets and complete projects.</span>
        </p>
        <p class="biglink">
          <a class="biglink" href="{{ pathto(port + "/datasheets") }}">5. Datasheets</a><br/>
          <span class="linkdescr">Pinouts and datasheets for available hardware.</span>
        </p>
    </td>
    <td width="40%" style="padding-left:2em;">
        <p class="biglink">
          <a class="biglink" href="{{ pathto(port + "/toolsandfeatures") }}">2. Tools &amp; Features</a><br/>
          <span class="linkdescr">Learn about the tools &amp; features we have available.</span>
        </p>
        <p class="biglink">
          <a class="biglink" href="{{ pathto("library/index") }}">4. Firmware API Reference</a><br/>
          <span class="linkdescr">Documentation for modules and libraries. Library class &amp; method reference.</span>
        </p>
		<p class="biglink">
          <a class="biglink" href="{{ pathto(port + "/docshowto") }}">6. Documentation Notes</a><br/>
          <span class="linkdescr">Support for understanding and using this documentation.</span>
        </p>
    </td>

    </tr></table>
  {% endif %}


{% if port != 'pycom_esp32' %}
  <table class="contentstable"><tr>
    <td width="40%" style="padding-left:2em;">
      {% if port in ("pyboard", "wipy", "esp8266", "lopy", "2wipy") %}
        <p class="biglink">
          <a class="biglink" href="{{ pathto(port + "/quickref") }}">Quick reference for {{ port_name }}</a><br/>
          <span class="linkdescr">pinout for {{ port_name }} and snippets of useful code</span>
        </p>
        <p class="biglink">
          <a class="biglink" href="{{ pathto(port + "/general") }}">General information about {{ port_name }}</a><br/>
          <span class="linkdescr">read this first for a quick overview</span>
        </p>
        <p class="biglink">
          <a class="biglink" href="{{ pathto(port + "/tutorial/index") }}">Tutorials and code examples</a><br/>
          <span class="linkdescr">start here</span>
        </p>
        <p class="biglink">
          <a class="biglink" href="{{ pathto("library/index") }}">Library Reference</a><br/>
          {% if port == "pyboard" %}
            <span class="linkdescr">MicroPython libraries, including the <a href="{{ pathto("library/pyb") }}">pyb module</a></span>
          {% else %}
              <span class="linkdescr">MicroPython libraries, including the <a href="{{ pathto("library/machine") }}">machine module</a></span>
          {% endif %}
        </p>
      {% endif %}
    </td>
    <td width="40%" style="padding-left:2em;">
      <p class="biglink">
        <a class="biglink" href="{{ pathto("reference/index") }}">Language Reference</a><br/>
        <span class="linkdescr">information about MicroPython specific language features</span>
      </p>
      {% if port == "pyboard" %}
        <p class="biglink">
            <a class="biglink" href="{{ pathto(port + "/hardware/index") }}">The {{ port }} hardware</a><br/>
            <span class="linkdescr">schematics, dimensions and component datasheets</span>
        </p>
        <p class="biglink">
            <a class="biglink" href="http://micropython.org/resources/Micro-Python-Windows-setup.pdf">Guide for {{ port_name }} on Windows (PDF)</a><br/>
            <span class="linkdescr">including DFU programming</span>
        </p>
      {% endif %}
    </td>
  </tr></table>

  <p><strong>Indices and tables:</strong></p>
  <table class="contentstable"><tr>
    <td width="40%" style="padding-left:2em;">
      <p class="biglink">
        <a class="biglink" href="{{ pathto("py-modindex") }}">Module index</a><br/>
        <span class="linkdescr">quick access to all modules</span>
      </p>
      <p class="biglink">
        <a class="biglink" href="{{ pathto("genindex") }}">Full index</a><br/>
        <span class="linkdescr">all functions, classes, constants</span>
      </p>
    </td>
    <td width="40%" style="padding-left:2em;">
      <p class="biglink">
        <a class="biglink" href="{{ pathto(port + "_contents") }}">Table of contents</a><br/>
        <span class="linkdescr">a list of all sections and subsections</span>
      </p>
    </td></tr>
  </table>
  {% endif %}

  <p><strong>External links:</strong></p>

  <table class="contentstable"><tr>
    <td width="40%" style="padding-left:2em;">
        <p class="biglink">
         <a class="biglink" href="https://github.com/pycom">GitHub</a><br/>
         <span class="linkdescr">Pycom on GitHub</span>
       </p>
       {% if port == "wipy" %}
         <p class="biglink">
           <a class="biglink" href="http://forum.micropython.org/viewforum.php?f=11">The WiPy homepage</a><br/>
           <span class="linkdescr">The official WiPy site</span>
         </p>
       {% endif %}
   </td>
   <td width="40%" style="padding-left:2em;">
       <p class="biglink">
        <a class="biglink" href="https://forum.pycom.io/">Pycom forum</a><br/>
        <span class="linkdescr">Pycom Community Forum</span>
      </p>
  </td>
  </tr></table>


{% endblock %}