Files
IronOS/Flashing/Pinecil V2/index.html
2024-05-22 09:44:35 +00:00

226 lines
12 KiB
HTML

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><link rel="canonical" href="https://ralim.github.io/IronOS/Flashing/Pinecil%20V2/" />
<link rel="shortcut icon" href="../../img/favicon.ico" />
<title>Pinecil V2 - IronOS</title>
<link rel="stylesheet" href="../../css/theme.css" />
<link rel="stylesheet" href="../../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "Pinecil V2";
var mkdocs_page_input_path = "Flashing/Pinecil V2.md";
var mkdocs_page_url = "/IronOS/Flashing/Pinecil%20V2/";
</script>
<!--[if lt IE 9]>
<script src="../../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/languages/yaml.min.js"></script>
<script>hljs.highlightAll();</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="../.." class="icon icon-home"> IronOS
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../..">Home</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../GettingStarted/">Getting Started</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Flashing the firmware</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../MHP30/">MHP30</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Pinecil%20V1/">Pinecil V1</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="#">Pinecil V2</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#downloading-source-file">Downloading source file</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#main-release">Main release</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#bleeding-edge-latest">Bleeding edge / latest</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../TS80%28P%29/">TS80(P)</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../TS100/">TS100</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Operation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../Menu/">Main Menu</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../Settings/">Settings</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../DebugMenu/">Debug Menu</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../Power/">Power</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../Temperature/">Temperature</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../Logo/">Startup Logo</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Hardware</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../HallSensor/">Hall Sensor (Pinecil)</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../Bluetooth/">Bluetooth (Pinecil V2)</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../Hardware/">Hardware Notes</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../Troubleshooting/">Troubleshooting</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../HardwareIssues/">Known Hardware Issues</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../PowerSources/">Power sources</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../PortingToNewDevice/">New Hardware Requirements</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../Translation/">Translations</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../Development/">Development</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../History/">Changelog</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../..">IronOS</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../.." class="icon icon-home" aria-label="Docs"></a></li>
<li class="breadcrumb-item">Flashing the firmware</li>
<li class="breadcrumb-item active">Pinecil V2</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/ralim/IronOS/edit/dev/Documentation/Flashing/Pinecil V2.md" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<h1 id="flashing-upgrading-your-iron">Flashing / Upgrading your iron</h1>
<h2 id="downloading-source-file">Downloading source file</h2>
<p>In the development of this firmware, there are three <em>types</em> of firmware released.
These are the "Main" stable releases, which generally have high confidence in being bug free.
Release candidates are released slightly more often, and these are generally perfectly fine for everyday use. These are released early to allow for translation checking and for wonderful people to help spot bugs and regressions.
Finally, there are the "mainline" builds, which are built from the main git branch.
These are built on every change and can be found on the Actions tab (see below).</p>
<h3 id="main-release">Main release</h3>
<p>Main releases are made to the <a href="https://github.com/Ralim/IronOS/releases">releases page</a>.
Download the zip file that matches your model of soldering iron and extract it.
Select the appropriate file type for your unit, in general Miniware devices need <code>.hex</code>, Pinecil V1 needs <code>.dfu</code>, and Pinecil V2 needs <code>.bin</code>.
Flash according to details below.</p>
<h3 id="bleeding-edge-latest">Bleeding edge / latest</h3>
<p>For the <em>latest</em> code, you need to download the zip file from the artifacts page for the build that you want.
Head to the <a href="https://github.com/Ralim/IronOS/actions">Actions</a> page and then select the run for the appropriate branch and beta you would like.
In general you probably want <code>master</code>.</p>
<p>Once you click on a run, scroll down to the "Artifacts" section and then click on your device model name to download a zip file.
Then this works the same as a production release (use the correct file).</p>
<h1 id="pinecil-v2">Pinecil V2</h1>
<ul>
<li>The MCU in Pinecil V2 is Bouffalo BL706 and does <em>not</em> use usb-dfu for flashing as the previous Pinecil V1 MCU did.</li>
<li>See the Pinecil Wiki page <a href="https://wiki.pine64.org/wiki/Pinecil#Firmware_&amp;_Updates">here</a> for instructions.</li>
<li>The V2 uses the <a href="https://github.com/pine64/blisp">BLISP flasher</a> to upload the firmware to the MCU.</li>
<li>The <a href="https://wiki.pine64.org/wiki/Pinecil">Pinecil Wiki</a> is a great resource for all things Pinecil.</li>
<li>Community chat: if there are issues updating, then join the Pine64 &gt; Pinecil channel <a href="https://wiki.pine64.org/wiki/Pinecil#Live_Community_Chat">here</a>. There are knowledgeable members in Discord/Telegram/Matrix. Discord has a bridge bot connection to Telegram and Matrix so that all pine64 volunteers/members can see advice for Pinecil and related items or just get tips on which power supply to purchase.</li>
<li>One advantage of Pinecil is that you cannot permanently damage it doing a firmware update (because BIN is in ROM); an update could render Pinecil temporarily inoperable if you flash an invalid firmware. But no worries, simply re-flashing with a working firmware copy will fix everything.</li>
<li>USB-C cable is required to do an update. Generally, all USB controllers work, but some hubs have issues, so it is preferred to avoid USB hubs for updates.</li>
<li>Background on the <a href="https://lupyuen.github.io/articles/bl706">BL706 chipset</a></li>
</ul>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../Pinecil%20V1/" class="btn btn-neutral float-left" title="Pinecil V1"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../TS80%28P%29/" class="btn btn-neutral float-right" title="TS80(P)">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span>
<a href="https://github.com/ralim/IronOS/" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../Pinecil%20V1/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../TS80%28P%29/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
<script src="../../js/jquery-3.6.0.min.js"></script>
<script>var base_url = "../..";</script>
<script src="../../js/theme_extra.js"></script>
<script src="../../js/theme.js"></script>
<script src="../../search/main.js"></script>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>