kopia lustrzana https://github.com/evil-mad/EggBot
Removed all references to v4.0.0 of EBB firmware and replaced with 'a future version'.
EmbeddedMan
rodzic
7759f5ff7f
commit
1d65d96f0d
docs
|
|
@ -128,7 +128,7 @@
|
|||
There are, of course, many <a href="EBBReleaseNotes.html">smaller changes</a> in the code between the versions on older EBB firmware and the latest versions. If you are developing new applications with the EBB, we do encourage you to update to the newest version. On the other hand, if you are writing new software that targets machines of various ages (for example, new EggBot software), please be aware that many of the machines out there are still using older firmware revisions.
|
||||
</p>
|
||||
<p>
|
||||
As we will note in the next section, EBB firmware v3.x labels a <i>transitional</i> version between the v2.x syntax and the future v4.x syntax. While it maintains compatibility for existing applications that use the EBB (with firmware 2.x), it also introduces changes for compatibility with the 4.x syntax. These include deprecations of some commands and queries. There is also a new "unified" syntax -- disabled by default -- for responses to commands and queries. Enabling this syntax allows one to develop or adapt programs that use the EBB for future compatibility with EBB firmware v4.0.
|
||||
As we will note in the next section, EBB firmware v3.x labels a <i>transitional</i> version between the v2.x syntax and any future syntax. While it maintains significant compatibility for existing applications that use the EBB (with firmware 2.x), it also introduces changes for compatibility with a possible future syntax. These changes include deprecations of some commands and queries. There is also a new "unified" syntax -- disabled by default -- for responses to commands and queries. Enabling this syntax allows one to develop or adapt programs that use the EBB for future compatibility.
|
||||
</p>
|
||||
|
||||
|
||||
|
|
@ -139,36 +139,32 @@
|
|||
<h2><a name="version_differences"></a>Major Changes in Firmware v3.0</h2>
|
||||
|
||||
<p>
|
||||
EBB firmware v3.x is a transitional series introducing new features, optional in v3.x, which will become standard in v4.0, and deprecating some commands and queries.
|
||||
EBB firmware v3.x is a transitional series introducing new features, optional in v3.x, which will become standard in a future version, and deprecating some commands and queries.
|
||||
</p>
|
||||
<p>
|
||||
The most important change is the introduction of a <b>future syntax mode</b>, which is off by default, and which can be enabled by the command <a href="#CU"><code>CU,10,1</code></a>. Future syntax mode does not change the syntax that is used to send commands or queries to the EBB; it changes the format of <i>responses</i> to commands and queries. With future syntax mode enabled, these responses will use the format that is planned for firmware v4.0 and higher, rather than the default "legacy" response format. The legacy response format will be removed in firmware v4.0, and should be considered to be deprecated.
|
||||
The most important change is the introduction of a <b>future syntax mode</b>, which is off by default, and which can be enabled by the command <a href="#CU"><code>CU,10,1</code></a>. Future syntax mode does not change the syntax that is used to send commands or queries to the EBB; it changes the format of <i>responses</i> to commands and queries. With future syntax mode enabled, these responses will use the format that is planned for a future firmware version, rather than the default "legacy" response format. The legacy response format will be removed in the future firmware, and should be considered to be deprecated.
|
||||
</p>
|
||||
<p>
|
||||
|
||||
The following three queries have been deprecated as of EBB firmware v3.0, and will be removed as of EBB firmware v4.0. They are functional,
|
||||
but should be migrated to use <a href="#QG">QG</a> (Query General) instead.
|
||||
<ul>
|
||||
<li><a href="#QB">QB</a> — Query Button</li>
|
||||
<li><a href="#QM">QM</a> — Query Motors</li>
|
||||
<li><a href="#QP">QP</a> — Query Pen</li>
|
||||
</ul>
|
||||
</p>
|
||||
<p>
|
||||
The following three commands and queries have been deprecated as of EBB firmware v3.0, and will be removed as of EBB firmware v4.0. They are functional,
|
||||
but applications that use them should be migrated to use <a href="#SL">SL</a> and <a href="#QL">QL</a> instead.
|
||||
<ul>
|
||||
<li><a href="#ND">ND</a> — Node count Decrement</li>
|
||||
<li><a href="#NI">NI</a> — Node count Increment</li>
|
||||
<li><a href="#QN">QN</a> — Query Node count</li>
|
||||
</ul>
|
||||
|
||||
|
||||
The following three queries have been deprecated as of EBB firmware v3.0, and will be removed in a future firmware version. They are functional,
|
||||
but should be migrated to use <a href="#QG">QG</a> (Query General) instead.
|
||||
<ul>
|
||||
<li><a href="#QB">QB</a> — Query Button</li>
|
||||
<li><a href="#QM">QM</a> — Query Motors</li>
|
||||
<li><a href="#QP">QP</a> — Query Pen</li>
|
||||
</ul>
|
||||
</p>
|
||||
<p>
|
||||
Please see the <a href="EBBReleaseNotes.html">release notes</a> for additional information about differences between versions.
|
||||
The following three commands and queries have been deprecated as of EBB firmware v3.0, and will be removed in the future firmware version. They are functional,
|
||||
but applications that use them should be migrated to use <a href="#SL">SL</a> and <a href="#QL">QL</a> instead.
|
||||
<ul>
|
||||
<li><a href="#ND">ND</a> — Node count Decrement</li>
|
||||
<li><a href="#NI">NI</a> — Node count Increment</li>
|
||||
<li><a href="#QN">QN</a> — Query Node count</li>
|
||||
</ul>
|
||||
</p>
|
||||
<p>
|
||||
Please see the <a href="EBBReleaseNotes.html">release notes</a> for additional information about differences between versions.
|
||||
</p>
|
||||
|
||||
|
||||
<p />
|
||||
<hr />
|
||||
|
|
@ -344,7 +340,7 @@
|
|||
</li>
|
||||
<li>
|
||||
<span style="font-weight: bold;">This command is depreciated in v3.0.0:</span>
|
||||
It will continue to work up until v4.0.0, but the plan is to remove it in v4.0.0.
|
||||
It will continue to work up until a future firmware version but the plan is to remove it in that future version.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
|
@ -376,7 +372,7 @@
|
|||
</li>
|
||||
<li>
|
||||
<span style="font-weight: bold;">This command is depreciated in v3.0.0:</span>
|
||||
It will continue to work up until v4.0.0, but the plan is to remove it in v4.0.0.
|
||||
It will continue to work up until a future firmware version but the plan is to remove it in that future firmware version.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
|
@ -590,7 +586,7 @@
|
|||
<li>
|
||||
<i>Param_Number</i> = 10 : <b>Enable Future Syntax Mode</b>
|
||||
<p>
|
||||
When enabled, <b>future syntax mode</b> changes the response sent after each command or query to have a relatively consistent format. (This syntax is said to be "future syntax" because it is the formatting that will be default as of EBB firmware v4.0.)
|
||||
When enabled, <b>future syntax mode</b> changes the response sent after each command or query to have a relatively consistent format. (This syntax is said to be "future syntax" because it is the formatting that will be default in a future firmware version.)
|
||||
</p>
|
||||
<p>
|
||||
When the EBB boots up, future syntax mode is disabled; which we can abbreviate as being in <b>legacy syntax mode</b>. Legacy syntax mode <i>does not</i> have a consistent pattern of responses nor line endings in those responses. However, it is backward compatible with previous EBB firmware versions.
|
||||
|
|
@ -757,7 +753,7 @@
|
|||
<p><code>CU,50</code>, <code>CU,51</code>, <code>CU,52</code>, <code>CU,53</code>, <code>CU,250</code> through <code>CU,257</code> were added in v3.0.0</p>
|
||||
</li>
|
||||
|
||||
<li><span style="font-weight: bold;">Deprecation notice:</span> <code>CU,1</code> is deprecated as of EBB firmware v3.0 and will be removed in EBB firmware v4.0. <code>CU,10</code> will be allowed, but will have no effect, as of EBB firmware v4.0. (What is now "future" syntax will be the default syntax as of v4.0.)</li>
|
||||
<li><span style="font-weight: bold;">Deprecation notice:</span> <code>CU,1</code> is deprecated as of EBB firmware v3.0 and will be removed in a future firmware version. <code>CU,10</code> will be allowed, but will have no effect in that future firmware version. (What is now "future" syntax will be the default syntax in that future firmware version.)</li>
|
||||
</ul>
|
||||
|
||||
<hr class="short" />
|
||||
|
|
@ -973,7 +969,7 @@
|
|||
</li>
|
||||
<li>
|
||||
<span style="font-weight: bold;">This command is depreciated in v3.0.0:</span>
|
||||
It will continue to work up until v4.0.0, but the plan is to remove it in v4.0.0.
|
||||
It will continue to work up until a future firmware version but the plan is to remove it in that future firmware version.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
|
@ -1118,7 +1114,7 @@
|
|||
<span style="font-weight: bold;">Version History:</span> Added in firmware v2.7.0.
|
||||
</li>
|
||||
<li>
|
||||
<span style="font-weight: bold;">Version History:</span> As of firmware v3.0.0, using a negative number for either <i>Rate</i> argument to control motion direction is depreciated. It will still work, but this functionality has been replaced by using a negative number to either <i>Step</i> argument. In version v4.0.0 the ability to use negative <i>Rate</i> arguments will be removed.
|
||||
<span style="font-weight: bold;">Version History:</span> As of firmware v3.0.0, using a negative number for either <i>Rate</i> argument to control motion direction is depreciated. It will still work, but this functionality has been replaced by using a negative number to either <i>Step</i> argument. In a future version the ability to use negative <i>Rate</i> arguments will be removed.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
|
@ -1315,7 +1311,7 @@
|
|||
<p>See the <code><a href="#QN">QN</a></code> command for a description of the node counter and its operations.</p>
|
||||
</li>
|
||||
<li><span style="font-weight: bold;">Version History:</span> Added in v1.9.5</li>
|
||||
<li><span style="font-weight: bold;">Deprecation notice:</span> <code>ND</code> is deprecated as of EBB firmware v3.0 and will be removed in EBB firmware v4.0. It is recommended to use <a href="#SL">SL</a>/<a href="#QL">QL</a> instead.</li>
|
||||
<li><span style="font-weight: bold;">Deprecation notice:</span> <code>ND</code> is deprecated as of EBB firmware v3.0 and will be removed in a future version. It is recommended to use <a href="#SL">SL</a>/<a href="#QL">QL</a> instead.</li>
|
||||
</ul>
|
||||
|
||||
<hr class="short" />
|
||||
|
|
@ -1333,7 +1329,7 @@
|
|||
<p>See the <code><a href="#QN">QN</a></code> command for a description of the node counter and its operations.</p>
|
||||
</li>
|
||||
<li><span style="font-weight: bold;">Version History:</span> Added in v1.9.5</li>
|
||||
<li><span style="font-weight: bold;">Deprecation notice:</span> <code>NI</code> is deprecated as of EBB firmware v3.0 and will be removed in EBB firmware v4.0. It is recommended to use <a href="#SL">SL</a>/<a href="#QL">QL</a> instead.</li>
|
||||
<li><span style="font-weight: bold;">Deprecation notice:</span> <code>NI</code> is deprecated as of EBB firmware v3.0 and will be removed in a future version. It is recommended to use <a href="#SL">SL</a>/<a href="#QL">QL</a> instead.</li>
|
||||
</ul>
|
||||
|
||||
<hr class="short"/>
|
||||
|
|
@ -1362,7 +1358,7 @@
|
|||
</li>
|
||||
<li>
|
||||
<span style="font-weight: bold;">This command is depreciated in v3.0.0:</span>
|
||||
It will continue to work up until v4.0.0, but the plan is to remove it in v4.0.0.
|
||||
It will continue to work up until a future firmware version but the plan is to remove it in that future firmware version.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
|
@ -1575,7 +1571,7 @@
|
|||
<p>One of the GPIO input pins, B0, can also be used to initiate a "button press" event. B0 is normally pulled high, but if it is taken low, then that registers as though the PRG button itself was pressed. To ensure that a "button press" is registered, ensure that B0 is pulled low for at least 40 microseconds. This "alt_prg" feature is enabled by default but can be disabled with the <code><a href="#SC">SC</a></code> command.</p>
|
||||
</li>
|
||||
<li><span style="font-weight: bold;">Version History:</span> Added in v1.9.2</li>
|
||||
<li><span style="font-weight: bold;">Deprecation notice:</span> <code>QB</code> is deprecated as of EBB firmware v3.0 and will be removed in EBB firmware v4.0. It is recommended to use <a href="#QG">QG</a> instead.</li>
|
||||
<li><span style="font-weight: bold;">Deprecation notice:</span> <code>QB</code> is deprecated as of EBB firmware v3.0 and will be removed in a future version. It is recommended to use <a href="#QG">QG</a> instead.</li>
|
||||
</ul>
|
||||
|
||||
<hr class="short" />
|
||||
|
|
@ -1867,7 +1863,7 @@
|
|||
</p>
|
||||
</li>
|
||||
<li><span style="font-weight: bold;">Version History:</span> Added in v2.4.4</li>
|
||||
<li><span style="font-weight: bold;">Deprecation notice:</span> <code>QM</code> is deprecated as of EBB firmware v3.0 and will be removed in EBB firmware v4.0. It is recommended to use <a href="#QG">QG</a> instead.</li>
|
||||
<li><span style="font-weight: bold;">Deprecation notice:</span> <code>QM</code> is deprecated as of EBB firmware v3.0 and will be removed in a future version. It is recommended to use <a href="#QG">QG</a> instead.</li>
|
||||
</ul>
|
||||
|
||||
<hr class="short" />
|
||||
|
|
@ -1905,7 +1901,7 @@
|
|||
<span style="font-weight: bold;">Version History:</span>
|
||||
Added in v1.9.2
|
||||
</li>
|
||||
<li><span style="font-weight: bold;">Deprecation notice:</span> <code>QN</code> is deprecated as of EBB firmware v3.0 and will be removed in EBB firmware v4.0. It is recommended to use <a href="#SL">SL</a>/<a href="#QL">QL</a> instead.</li>
|
||||
<li><span style="font-weight: bold;">Deprecation notice:</span> <code>QN</code> is deprecated as of EBB firmware v3.0 and will be removed in a future version. It is recommended to use <a href="#SL">SL</a>/<a href="#QL">QL</a> instead.</li>
|
||||
</ul>
|
||||
|
||||
<hr class="short" />
|
||||
|
|
@ -1927,7 +1923,7 @@
|
|||
<li><span style="font-weight: bold;">Example Return Packet (legacy mode; default):</span> <code>1<NL><CR>OK<CR><NL></code></li>
|
||||
|
||||
<li><span style="font-weight: bold;">Version History:</span> Added in v1.9</li>
|
||||
<li><span style="font-weight: bold;">Deprecation notice:</span> <code>QP</code> is deprecated as of EBB firmware v3.0 and will be removed in EBB firmware v4.0. It is recommended to use <a href="#QG">QG</a> instead.</li>
|
||||
<li><span style="font-weight: bold;">Deprecation notice:</span> <code>QP</code> is deprecated as of EBB firmware v3.0 and will be removed in a future version. It is recommended to use <a href="#QG">QG</a> instead.</li>
|
||||
</ul>
|
||||
|
||||
<hr class="short" />
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue