Skip to content

Commit

Permalink
pi30max docs edits
Browse files Browse the repository at this point in the history
  • Loading branch information
jblance authored Feb 3, 2025
1 parent b51ec8e commit 3ee9e45
Show file tree
Hide file tree
Showing 7 changed files with 83 additions and 79 deletions.
49 changes: 26 additions & 23 deletions docs/html/_sources/protocols.docs.pi30max.rst.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
***************************************************
PI30(MAX) - Model MAX | PIP4048MAX
PI30MAX - Model MAX | PIP4048MAX
***************************************************

Document Details
Expand Down Expand Up @@ -111,47 +111,50 @@ Inquiry Command
2.1 QPI<cr>: Device Protocol ID Inquiry
---------------------------------------

Function: To request the device Protocol ID.

Computer: ``QPI<CRC><cr>``

Device: ``(PI<NN> <CRC><cr>``

N is an integer number ranging from 0 to 9.

Function: To request the device Protocol ID.

Protocol ID distribution: 30 for Axpert KS series


2.2 QID<cr>: The device serial number inquiry
---------------------------------------------

Computer: ``QID <CRC><cr>``

```
Computer: QID <CRC><cr>
Device: (XXXXXXXXXXXXXX <CRC><cr>
```
### 2.3 QSID<cr>: The device serial number inquiry (the length is more than 14)
Device: ``(XXXXXXXXXXXXXX <CRC><cr>``


2.3 QSID<cr>: The device serial number inquiry (the length is more than 14)
---------------------------------------------------------------------------

Computer: ``QSID<CRC><cr>``

Device: ``(NNXXXXXXXXXXXXXXXXXXXX <CRC><cr>``

```
Computer: QSID<CRC><cr>
Device: (NNXXXXXXXXXXXXXXXXXXXX <CRC><cr>
NN: Serial number valid length, X: Serial number, invalid part is filled as ‘0’, total X is 20.
```
### 2.4 QVFW<cr>: Main CPU Firmware version inquiry

```
Computer: QVFW<CRC><cr>
```
2.4 QVFW<cr>: Main CPU Firmware version inquiry
-----------------------------------------------

Computer: ``QVFW<CRC><cr>``

Device: ``(VERFW:<NNNNN.NN><CRC><cr>``

```
Device: (VERFW:<NNNNN.NN><CRC><cr>
<N> is a HEX number from 0...9 or A...F.

Example:
Computer: QVFW<CRC><cr>
Device: (VERFW:00 0 23.01<CRC><cr>
00123: firmware series number; 01 :version
```
### 2.5 QVFW3<cr>: Another CPU (remote panel) Firmware version inquiry
|Computer: ``QVFW<CRC><cr>``
|Device: ``(VERFW:00123.01<CRC><cr>``
|00123: firmware series number; 01 :version
2.5 QVFW3<cr>: Another CPU (remote panel) Firmware version inquiry
------------------------------------------------------------------

```
Computer: QVFW3<CRC><cr>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,7 @@ <h2>Documentation<a class="headerlink" href="#documentation" title="Link to this
<li class="toctree-l2"><a class="reference internal" href="protocols.html#inverter-protocols">Inverter Protocols</a><ul>
<li class="toctree-l3"><a class="reference internal" href="protocols.mppsolar.html">MPPsolar Protocols</a><ul>
<li class="toctree-l4"><a class="reference internal" href="protocols.docs.pi30.html">PI30</a></li>
<li class="toctree-l4"><a class="reference internal" href="protocols.docs.pi30max.html">PI30(MAX) - Model MAX | PIP4048MAX</a></li>
<li class="toctree-l4"><a class="reference internal" href="protocols.docs.pi30max.html">PI30MAX - Model MAX | PIP4048MAX</a></li>
</ul>
</li>
</ul>
Expand Down
Binary file modified docs/html/objects.inv
Binary file not shown.
58 changes: 28 additions & 30 deletions docs/html/protocols.docs.pi30max.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1"><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>PI30(MAX) - Model MAX | PIP4048MAX</title>
<title>PI30MAX - Model MAX | PIP4048MAX</title>

<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/theme.css " type="text/css" />
Expand Down Expand Up @@ -161,7 +161,7 @@

<li><a href="protocols.mppsolar.html">MPPsolar Protocols</a> &raquo;</li>

<li>PI30(MAX) - Model MAX | PIP4048MAX</li>
<li>PI30MAX - Model MAX | PIP4048MAX</li>
</ul>


Expand All @@ -180,8 +180,8 @@
<hr>
<div class="content" role="main" v-pre>

<section id="pi30-max-model-max-pip4048max">
<h1>PI30(MAX) - Model MAX | PIP4048MAX<a class="headerlink" href="#pi30-max-model-max-pip4048max" title="Link to this heading"></a></h1>
<section id="pi30max-model-max-pip4048max">
<h1>PI30MAX - Model MAX | PIP4048MAX<a class="headerlink" href="#pi30max-model-max-pip4048max" title="Link to this heading"></a></h1>
<section id="document-details">
<h2>Document Details<a class="headerlink" href="#document-details" title="Link to this heading"></a></h2>
<p>Source:</p>
Expand Down Expand Up @@ -290,8 +290,8 @@ <h2>Document Details<a class="headerlink" href="#document-details" title="Link t
</section>
<section id="communication-format">
<h2>Communication format<a class="headerlink" href="#communication-format" title="Link to this heading"></a></h2>
<table class="docutils align-left" id="id1">
<caption><span class="caption-text">RS232</span><a class="headerlink" href="#id1" title="Link to this table"></a></caption>
<table class="docutils align-left" id="id7">
<caption><span class="caption-text">RS232</span><a class="headerlink" href="#id7" title="Link to this table"></a></caption>
<thead>
<tr class="row-odd"><th class="head"><p>Baud rate</p></th>
<th class="head"><p>Start bit</p></th>
Expand All @@ -314,37 +314,35 @@ <h2>Communication format<a class="headerlink" href="#communication-format" title
<h2>Inquiry Command<a class="headerlink" href="#inquiry-command" title="Link to this heading"></a></h2>
<section id="qpi-cr-device-protocol-id-inquiry">
<h3>2.1 QPI&lt;cr&gt;: Device Protocol ID Inquiry<a class="headerlink" href="#qpi-cr-device-protocol-id-inquiry" title="Link to this heading"></a></h3>
<p>Function: To request the device Protocol ID.</p>
<p>Computer: <code class="docutils literal notranslate"><span class="pre">QPI&lt;CRC&gt;&lt;cr&gt;</span></code></p>
<p>Device: <code class="docutils literal notranslate"><span class="pre">(PI&lt;NN&gt;</span> <span class="pre">&lt;CRC&gt;&lt;cr&gt;</span></code></p>
<p>N is an integer number ranging from 0 to 9.</p>
<p>Function: To request the device Protocol ID.</p>
<p>Protocol ID distribution: 30 for Axpert KS series</p>
</section>
<section id="qid-cr-the-device-serial-number-inquiry">
<h3>2.2 QID&lt;cr&gt;: The device serial number inquiry<a class="headerlink" href="#qid-cr-the-device-serial-number-inquiry" title="Link to this heading"></a></h3>
<p><code class="docutils literal notranslate"><span class="pre">`</span>
<span class="pre">Computer:</span> <span class="pre">QID</span> <span class="pre">&lt;CRC&gt;&lt;cr&gt;</span>
<span class="pre">Device:</span> <span class="pre">(XXXXXXXXXXXXXX</span> <span class="pre">&lt;CRC&gt;&lt;cr&gt;</span>
<span class="pre">`</span></code>
### 2.3 QSID&lt;cr&gt;: The device serial number inquiry (the length is more than 14)</p>
<p><code class="docutils literal notranslate"><span class="pre">`</span>
<span class="pre">Computer:</span> <span class="pre">QSID&lt;CRC&gt;&lt;cr&gt;</span>
<span class="pre">Device:</span> <span class="pre">(NNXXXXXXXXXXXXXXXXXXXX</span> <span class="pre">&lt;CRC&gt;&lt;cr&gt;</span>
<span class="pre">NN:</span> <span class="pre">Serial</span> <span class="pre">number</span> <span class="pre">valid</span> <span class="pre">length,</span> <span class="pre">X:</span> <span class="pre">Serial</span> <span class="pre">number,</span> <span class="pre">invalid</span> <span class="pre">part</span> <span class="pre">is</span> <span class="pre">filled</span> <span class="pre">as</span> <span class="pre">‘0’,</span> <span class="pre">total</span> <span class="pre">X</span> <span class="pre">is</span> <span class="pre">20.</span>
<span class="pre">`</span></code>
### 2.4 QVFW&lt;cr&gt;: Main CPU Firmware version inquiry</p>
<p><code class="docutils literal notranslate"><span class="pre">`</span>
<span class="pre">Computer:</span> <span class="pre">QVFW&lt;CRC&gt;&lt;cr&gt;</span>
<span class="pre">`</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">`</span>
<span class="pre">Device:</span> <span class="pre">(VERFW:&lt;NNNNN.NN&gt;&lt;CRC&gt;&lt;cr&gt;</span>
<span class="pre">&lt;N&gt;</span> <span class="pre">is</span> <span class="pre">a</span> <span class="pre">HEX</span> <span class="pre">number</span> <span class="pre">from</span> <span class="pre">0...9</span> <span class="pre">or</span> <span class="pre">A...F.</span>
<span class="pre">Example:</span>
<span class="pre">Computer:</span> <span class="pre">QVFW&lt;CRC&gt;&lt;cr&gt;</span>
<span class="pre">Device:</span> <span class="pre">(VERFW:00</span> <span class="pre">0</span> <span class="pre">23.01&lt;CRC&gt;&lt;cr&gt;</span>
<span class="pre">00123:</span> <span class="pre">firmware</span> <span class="pre">series</span> <span class="pre">number;</span> <span class="pre">01</span> <span class="pre">:version</span>
<span class="pre">`</span></code>
### 2.5 QVFW3&lt;cr&gt;: Another CPU (remote panel) Firmware version inquiry</p>
<p>Computer: <code class="docutils literal notranslate"><span class="pre">QID</span> <span class="pre">&lt;CRC&gt;&lt;cr&gt;</span></code></p>
<p>Device: <code class="docutils literal notranslate"><span class="pre">(XXXXXXXXXXXXXX</span> <span class="pre">&lt;CRC&gt;&lt;cr&gt;</span></code></p>
</section>
<section id="qsid-cr-the-device-serial-number-inquiry-the-length-is-more-than-14">
<h3>2.3 QSID&lt;cr&gt;: The device serial number inquiry (the length is more than 14)<a class="headerlink" href="#qsid-cr-the-device-serial-number-inquiry-the-length-is-more-than-14" title="Link to this heading"></a></h3>
<p>Computer: <code class="docutils literal notranslate"><span class="pre">QSID&lt;CRC&gt;&lt;cr&gt;</span></code></p>
<p>Device: <code class="docutils literal notranslate"><span class="pre">(NNXXXXXXXXXXXXXXXXXXXX</span> <span class="pre">&lt;CRC&gt;&lt;cr&gt;</span></code></p>
<p>NN: Serial number valid length, X: Serial number, invalid part is filled as ‘0’, total X is 20.</p>
</section>
<section id="qvfw-cr-main-cpu-firmware-version-inquiry">
<h3>2.4 QVFW&lt;cr&gt;: Main CPU Firmware version inquiry<a class="headerlink" href="#qvfw-cr-main-cpu-firmware-version-inquiry" title="Link to this heading"></a></h3>
<p>Computer: <code class="docutils literal notranslate"><span class="pre">QVFW&lt;CRC&gt;&lt;cr&gt;</span></code></p>
<p>Device: <code class="docutils literal notranslate"><span class="pre">(VERFW:&lt;NNNNN.NN&gt;&lt;CRC&gt;&lt;cr&gt;</span></code></p>
<p>&lt;N&gt; is a HEX number from 0…9 or A…F.</p>
<p>Example:
<a href="#id1"><span class="problematic" id="id2">|</span></a>Computer: <code class="docutils literal notranslate"><span class="pre">QVFW&lt;CRC&gt;&lt;cr&gt;</span></code>
<a href="#id3"><span class="problematic" id="id4">|</span></a>Device: <code class="docutils literal notranslate"><span class="pre">(VERFW:00123.01&lt;CRC&gt;&lt;cr&gt;</span></code>
<a href="#id5"><span class="problematic" id="id6">|</span></a>00123: firmware series number; 01 :version</p>
</section>
<section id="qvfw3-cr-another-cpu-remote-panel-firmware-version-inquiry">
<h3>2.5 QVFW3&lt;cr&gt;: Another CPU (remote panel) Firmware version inquiry<a class="headerlink" href="#qvfw3-cr-another-cpu-remote-panel-firmware-version-inquiry" title="Link to this heading"></a></h3>
<p><code class="docutils literal notranslate"><span class="pre">`</span>
<span class="pre">Computer:</span> <span class="pre">QVFW3&lt;CRC&gt;&lt;cr&gt;</span>
<span class="pre">Device:</span> <span class="pre">(VERFW:</span> <span class="pre">&lt;NNNNN.NN&gt;&lt;CRC&gt;&lt;cr&gt;</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/protocols.mppsolar.html
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ <h1>MPPsolar Protocols<a class="headerlink" href="#mppsolar-protocols" title="Li
<li class="toctree-l2"><a class="reference internal" href="protocols.docs.pi30.html#frame-structure">Frame Structure</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="protocols.docs.pi30max.html">PI30(MAX) - Model MAX | PIP4048MAX</a><ul>
<li class="toctree-l1"><a class="reference internal" href="protocols.docs.pi30max.html">PI30MAX - Model MAX | PIP4048MAX</a><ul>
<li class="toctree-l2"><a class="reference internal" href="protocols.docs.pi30max.html#document-details">Document Details</a></li>
<li class="toctree-l2"><a class="reference internal" href="protocols.docs.pi30max.html#communication-format">Communication format</a></li>
<li class="toctree-l2"><a class="reference internal" href="protocols.docs.pi30max.html#inquiry-command">Inquiry Command</a></li>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/searchindex.js

Large diffs are not rendered by default.

49 changes: 26 additions & 23 deletions docs_source/source/protocols.docs.pi30max.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
***************************************************
PI30(MAX) - Model MAX | PIP4048MAX
PI30MAX - Model MAX | PIP4048MAX
***************************************************

Document Details
Expand Down Expand Up @@ -111,47 +111,50 @@ Inquiry Command
2.1 QPI<cr>: Device Protocol ID Inquiry
---------------------------------------

Function: To request the device Protocol ID.

Computer: ``QPI<CRC><cr>``

Device: ``(PI<NN> <CRC><cr>``

N is an integer number ranging from 0 to 9.

Function: To request the device Protocol ID.

Protocol ID distribution: 30 for Axpert KS series


2.2 QID<cr>: The device serial number inquiry
---------------------------------------------

Computer: ``QID <CRC><cr>``

```
Computer: QID <CRC><cr>
Device: (XXXXXXXXXXXXXX <CRC><cr>
```
### 2.3 QSID<cr>: The device serial number inquiry (the length is more than 14)
Device: ``(XXXXXXXXXXXXXX <CRC><cr>``


2.3 QSID<cr>: The device serial number inquiry (the length is more than 14)
---------------------------------------------------------------------------

Computer: ``QSID<CRC><cr>``

Device: ``(NNXXXXXXXXXXXXXXXXXXXX <CRC><cr>``

```
Computer: QSID<CRC><cr>
Device: (NNXXXXXXXXXXXXXXXXXXXX <CRC><cr>
NN: Serial number valid length, X: Serial number, invalid part is filled as ‘0’, total X is 20.
```
### 2.4 QVFW<cr>: Main CPU Firmware version inquiry

```
Computer: QVFW<CRC><cr>
```
2.4 QVFW<cr>: Main CPU Firmware version inquiry
-----------------------------------------------

Computer: ``QVFW<CRC><cr>``

Device: ``(VERFW:<NNNNN.NN><CRC><cr>``

```
Device: (VERFW:<NNNNN.NN><CRC><cr>
<N> is a HEX number from 0...9 or A...F.

Example:
Computer: QVFW<CRC><cr>
Device: (VERFW:00 0 23.01<CRC><cr>
00123: firmware series number; 01 :version
```
### 2.5 QVFW3<cr>: Another CPU (remote panel) Firmware version inquiry
|Computer: ``QVFW<CRC><cr>``
|Device: ``(VERFW:00123.01<CRC><cr>``
|00123: firmware series number; 01 :version
2.5 QVFW3<cr>: Another CPU (remote panel) Firmware version inquiry
------------------------------------------------------------------

```
Computer: QVFW3<CRC><cr>
Expand Down

0 comments on commit 3ee9e45

Please sign in to comment.