1.59 2018-08-28 Update commercial licensing, remove binpress.
This commit is contained in:
parent
b25c47ae8d
commit
d54e55a358
@ -767,7 +767,7 @@ Protected Attributes</h2></td></tr>
|
|||||||
</tr>
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
</div><div class="memdoc">
|
</div><div class="memdoc">
|
||||||
<p>Sets the maximum permitted speed. The <a class="el" href="classAccelStepper.html#a608b2395b64ac15451d16d0371fe13ce">run()</a> function will accelerate up to the speed set by this function. Caution: the maximum speed achievable depends on your processor and clock speed. </p><dl class="params"><dt>Parameters</dt><dd>
|
<p>Sets the maximum permitted speed. The <a class="el" href="classAccelStepper.html#a608b2395b64ac15451d16d0371fe13ce">run()</a> function will accelerate up to the speed set by this function. Caution: the maximum speed achievable depends on your processor and clock speed. The default maxSpeed is 1.0 steps per second. </p><dl class="params"><dt>Parameters</dt><dd>
|
||||||
<table class="params">
|
<table class="params">
|
||||||
<tr><td class="paramdir">[in]</td><td class="paramname">speed</td><td>The desired maximum speed in steps per second. Must be > 0. Caution: Speeds that exceed the maximum speed supported by the processor may Result in non-linear accelerations and decelerations. </td></tr>
|
<tr><td class="paramdir">[in]</td><td class="paramname">speed</td><td>The desired maximum speed in steps per second. Must be > 0. Caution: Speeds that exceed the maximum speed supported by the processor may Result in non-linear accelerations and decelerations. </td></tr>
|
||||||
</table>
|
</table>
|
||||||
@ -948,7 +948,7 @@ Protected Attributes</h2></td></tr>
|
|||||||
</div><div class="memdoc">
|
</div><div class="memdoc">
|
||||||
<p>Sets the desired constant speed for use with <a class="el" href="classAccelStepper.html#aa4a6bdf99f698284faaeb5542b0b7514">runSpeed()</a>. </p><dl class="params"><dt>Parameters</dt><dd>
|
<p>Sets the desired constant speed for use with <a class="el" href="classAccelStepper.html#aa4a6bdf99f698284faaeb5542b0b7514">runSpeed()</a>. </p><dl class="params"><dt>Parameters</dt><dd>
|
||||||
<table class="params">
|
<table class="params">
|
||||||
<tr><td class="paramdir">[in]</td><td class="paramname">speed</td><td>The desired constant speed in steps per second. Positive is clockwise. Speeds of more than 1000 steps per second are unreliable. Very slow speeds may be set (eg 0.00027777 for once per hour, approximately. Speed accuracy depends on the Arduino crystal. Jitter depends on how frequently you call the <a class="el" href="classAccelStepper.html#aa4a6bdf99f698284faaeb5542b0b7514">runSpeed()</a> function. </td></tr>
|
<tr><td class="paramdir">[in]</td><td class="paramname">speed</td><td>The desired constant speed in steps per second. Positive is clockwise. Speeds of more than 1000 steps per second are unreliable. Very slow speeds may be set (eg 0.00027777 for once per hour, approximately. Speed accuracy depends on the Arduino crystal. Jitter depends on how frequently you call the <a class="el" href="classAccelStepper.html#aa4a6bdf99f698284faaeb5542b0b7514">runSpeed()</a> function. The speed will be limited by the current value of <a class="el" href="classAccelStepper.html#abee8d466229b87accba33d6ec929c18f">setMaxSpeed()</a> </td></tr>
|
||||||
</table>
|
</table>
|
||||||
</dd>
|
</dd>
|
||||||
</dl>
|
</dl>
|
||||||
|
@ -54,7 +54,7 @@ $(function() {
|
|||||||
<li>Extensive API </li>
|
<li>Extensive API </li>
|
||||||
<li>Subclass support</li>
|
<li>Subclass support</li>
|
||||||
</ul>
|
</ul>
|
||||||
<p>The latest version of this documentation can be downloaded from <a href="http://www.airspayce.com/mikem/arduino/AccelStepper">http://www.airspayce.com/mikem/arduino/AccelStepper</a> The version of the package that this documentation refers to can be downloaded from <a href="http://www.airspayce.com/mikem/arduino/AccelStepper/AccelStepper-1.58.zip">http://www.airspayce.com/mikem/arduino/AccelStepper/AccelStepper-1.58.zip</a></p>
|
<p>The latest version of this documentation can be downloaded from <a href="http://www.airspayce.com/mikem/arduino/AccelStepper">http://www.airspayce.com/mikem/arduino/AccelStepper</a> The version of the package that this documentation refers to can be downloaded from <a href="http://www.airspayce.com/mikem/arduino/AccelStepper/AccelStepper-1.59.zip">http://www.airspayce.com/mikem/arduino/AccelStepper/AccelStepper-1.59.zip</a></p>
|
||||||
<p>Example Arduino programs are included to show the main modes of use.</p>
|
<p>Example Arduino programs are included to show the main modes of use.</p>
|
||||||
<p>You can also find online help and discussion at <a href="http://groups.google.com/group/accelstepper">http://groups.google.com/group/accelstepper</a> Please use that group for all questions and discussions on this topic. Do not contact the author directly, unless it is to discuss commercial licensing. Before asking a question or reporting a bug, please read</p><ul>
|
<p>You can also find online help and discussion at <a href="http://groups.google.com/group/accelstepper">http://groups.google.com/group/accelstepper</a> Please use that group for all questions and discussions on this topic. Do not contact the author directly, unless it is to discuss commercial licensing. Before asking a question or reporting a bug, please read</p><ul>
|
||||||
<li><a href="http://en.wikipedia.org/wiki/Wikipedia:Reference_desk/How_to_ask_a_software_question">http://en.wikipedia.org/wiki/Wikipedia:Reference_desk/How_to_ask_a_software_question</a></li>
|
<li><a href="http://en.wikipedia.org/wiki/Wikipedia:Reference_desk/How_to_ask_a_software_question">http://en.wikipedia.org/wiki/Wikipedia:Reference_desk/How_to_ask_a_software_question</a></li>
|
||||||
@ -74,9 +74,9 @@ $(function() {
|
|||||||
<dl class="section user"><dt>Trademarks</dt><dd></dd></dl>
|
<dl class="section user"><dt>Trademarks</dt><dd></dd></dl>
|
||||||
<p><a class="el" href="classAccelStepper.html" title="Support for stepper motors with acceleration etc. ">AccelStepper</a> is a trademark of AirSpayce Pty Ltd. The <a class="el" href="classAccelStepper.html" title="Support for stepper motors with acceleration etc. ">AccelStepper</a> mark was first used on April 26 2010 for international trade, and is used only in relation to motor control hardware and software. It is not to be confused with any other similar marks covering other goods and services.</p>
|
<p><a class="el" href="classAccelStepper.html" title="Support for stepper motors with acceleration etc. ">AccelStepper</a> is a trademark of AirSpayce Pty Ltd. The <a class="el" href="classAccelStepper.html" title="Support for stepper motors with acceleration etc. ">AccelStepper</a> mark was first used on April 26 2010 for international trade, and is used only in relation to motor control hardware and software. It is not to be confused with any other similar marks covering other goods and services.</p>
|
||||||
<dl class="section user"><dt>Copyright</dt><dd></dd></dl>
|
<dl class="section user"><dt>Copyright</dt><dd></dd></dl>
|
||||||
<p>This software is Copyright (C) 2010 Mike McCauley. Use is subject to license conditions. The main licensing options available are GPL V2 or Commercial:</p>
|
<p>This software is Copyright (C) 2010-2018 Mike McCauley. Use is subject to license conditions. The main licensing options available are GPL V2 or Commercial:</p>
|
||||||
<dl class="section user"><dt>Open Source Licensing GPL V2</dt><dd>This is the appropriate option if you want to share the source code of your application with everyone you distribute it to, and you also want to give them the right to share who uses it. If you wish to use this software under Open Source Licensing, you must contribute all your source code to the open source community in accordance with the GPL Version 2 when your application is distributed. See <a href="https://www.gnu.org/licenses/gpl-2.0.html">https://www.gnu.org/licenses/gpl-2.0.html</a></dd></dl>
|
<dl class="section user"><dt>Open Source Licensing GPL V2</dt><dd>This is the appropriate option if you want to share the source code of your application with everyone you distribute it to, and you also want to give them the right to share who uses it. If you wish to use this software under Open Source Licensing, you must contribute all your source code to the open source community in accordance with the GPL Version 2 when your application is distributed. See <a href="https://www.gnu.org/licenses/gpl-2.0.html">https://www.gnu.org/licenses/gpl-2.0.html</a></dd></dl>
|
||||||
<dl class="section user"><dt>Commercial Licensing</dt><dd>This is the appropriate option if you are creating proprietary applications and you are not prepared to distribute and share the source code of your application. Purchase commercial licenses at <a href="http://airspayce.binpress.com/">http://airspayce.binpress.com/</a></dd></dl>
|
<dl class="section user"><dt>Commercial Licensing</dt><dd>This is the appropriate option if you are creating proprietary applications and you are not prepared to distribute and share the source code of your application. To purchase a commercial license, contact <a href="#" onclick="location.href='mai'+'lto:'+'inf'+'o@'+'air'+'sp'+'ayc'+'e.'+'com'; return false;">info@<span style="display: none;">.nosp@m.</span>airs<span style="display: none;">.nosp@m.</span>payce<span style="display: none;">.nosp@m.</span>.com</a></dd></dl>
|
||||||
<dl class="section user"><dt>Revision History</dt><dd></dd></dl>
|
<dl class="section user"><dt>Revision History</dt><dd></dd></dl>
|
||||||
<dl class="section version"><dt>Version</dt><dd>1.0 Initial release</dd>
|
<dl class="section version"><dt>Version</dt><dd>1.0 Initial release</dd>
|
||||||
<dd>
|
<dd>
|
||||||
@ -134,7 +134,7 @@ $(function() {
|
|||||||
<dd>
|
<dd>
|
||||||
1.27 Added stop() function to stop as fast as possible with current acceleration parameters. Also added new Quickstop example showing its use. </dd>
|
1.27 Added stop() function to stop as fast as possible with current acceleration parameters. Also added new Quickstop example showing its use. </dd>
|
||||||
<dd>
|
<dd>
|
||||||
1.28 Fixed another problem where certain combinations of speed and accelration could cause oscillation about the target position. Added support for 3 wire full and half steppers such as Hard Disk Drive spindle. Contributed by Yuri Ivatchkovitch. </dd>
|
1.28 Fixed another problem where certain combinations of speed and acceleration could cause oscillation about the target position. Added support for 3 wire full and half steppers such as Hard Disk Drive spindle. Contributed by Yuri Ivatchkovitch. </dd>
|
||||||
<dd>
|
<dd>
|
||||||
1.29 Fixed a problem that could cause a DRIVER stepper to continually step with some sketches. Reported by Vadim. </dd>
|
1.29 Fixed a problem that could cause a DRIVER stepper to continually step with some sketches. Reported by Vadim. </dd>
|
||||||
<dd>
|
<dd>
|
||||||
@ -207,7 +207,9 @@ $(function() {
|
|||||||
<dd>
|
<dd>
|
||||||
1.57 2017-03-28 _direction moved to protected at the request of Rudy Ercek. setMaxSpeed() and setAcceleration() now correct negative values to be positive. </dd>
|
1.57 2017-03-28 _direction moved to protected at the request of Rudy Ercek. setMaxSpeed() and setAcceleration() now correct negative values to be positive. </dd>
|
||||||
<dd>
|
<dd>
|
||||||
1.58 2018-04-13 Add initialisation for _enableInverted in constructor.</dd></dl>
|
1.58 2018-04-13 Add initialisation for _enableInverted in constructor. </dd>
|
||||||
|
<dd>
|
||||||
|
1.59 2018-08-28 Update commercial licensing, remove binpress.</dd></dl>
|
||||||
<dl class="section author"><dt>Author</dt><dd>Mike McCauley (<a href="#" onclick="location.href='mai'+'lto:'+'mik'+'em'+'@ai'+'rs'+'pay'+'ce'+'.co'+'m'; return false;">mikem<span style="display: none;">.nosp@m.</span>@air<span style="display: none;">.nosp@m.</span>spayc<span style="display: none;">.nosp@m.</span>e.co<span style="display: none;">.nosp@m.</span>m</a>) DO NOT CONTACT THE AUTHOR DIRECTLY: USE THE LISTS </dd></dl>
|
<dl class="section author"><dt>Author</dt><dd>Mike McCauley (<a href="#" onclick="location.href='mai'+'lto:'+'mik'+'em'+'@ai'+'rs'+'pay'+'ce'+'.co'+'m'; return false;">mikem<span style="display: none;">.nosp@m.</span>@air<span style="display: none;">.nosp@m.</span>spayc<span style="display: none;">.nosp@m.</span>e.co<span style="display: none;">.nosp@m.</span>m</a>) DO NOT CONTACT THE AUTHOR DIRECTLY: USE THE LISTS </dd></dl>
|
||||||
</div></div><!-- contents -->
|
</div></div><!-- contents -->
|
||||||
<!-- start footer part -->
|
<!-- start footer part -->
|
||||||
|
File diff suppressed because one or more lines are too long
@ -1,5 +1,5 @@
|
|||||||
name=AccelStepper
|
name=AccelStepper
|
||||||
version=1.58
|
version=1.59
|
||||||
author=Mike McCauley <mikem@airspayce.com>
|
author=Mike McCauley <mikem@airspayce.com>
|
||||||
maintainer=Patrick Wasp <patrickwasp@gmail.com>
|
maintainer=Patrick Wasp <patrickwasp@gmail.com>
|
||||||
sentence=Allows Arduino boards to control a variety of stepper motors.
|
sentence=Allows Arduino boards to control a variety of stepper motors.
|
||||||
|
@ -23,7 +23,7 @@
|
|||||||
/// The latest version of this documentation can be downloaded from
|
/// The latest version of this documentation can be downloaded from
|
||||||
/// http://www.airspayce.com/mikem/arduino/AccelStepper
|
/// http://www.airspayce.com/mikem/arduino/AccelStepper
|
||||||
/// The version of the package that this documentation refers to can be downloaded
|
/// The version of the package that this documentation refers to can be downloaded
|
||||||
/// from http://www.airspayce.com/mikem/arduino/AccelStepper/AccelStepper-1.58.zip
|
/// from http://www.airspayce.com/mikem/arduino/AccelStepper/AccelStepper-1.59.zip
|
||||||
///
|
///
|
||||||
/// Example Arduino programs are included to show the main modes of use.
|
/// Example Arduino programs are included to show the main modes of use.
|
||||||
///
|
///
|
||||||
@ -81,7 +81,7 @@
|
|||||||
///
|
///
|
||||||
/// \par Copyright
|
/// \par Copyright
|
||||||
///
|
///
|
||||||
/// This software is Copyright (C) 2010 Mike McCauley. Use is subject to license
|
/// This software is Copyright (C) 2010-2018 Mike McCauley. Use is subject to license
|
||||||
/// conditions. The main licensing options available are GPL V2 or Commercial:
|
/// conditions. The main licensing options available are GPL V2 or Commercial:
|
||||||
///
|
///
|
||||||
/// \par Open Source Licensing GPL V2
|
/// \par Open Source Licensing GPL V2
|
||||||
@ -95,7 +95,7 @@
|
|||||||
/// \par Commercial Licensing
|
/// \par Commercial Licensing
|
||||||
/// This is the appropriate option if you are creating proprietary applications
|
/// This is the appropriate option if you are creating proprietary applications
|
||||||
/// and you are not prepared to distribute and share the source code of your
|
/// and you are not prepared to distribute and share the source code of your
|
||||||
/// application. Purchase commercial licenses at http://airspayce.binpress.com/
|
/// application. To purchase a commercial license, contact info@airspayce.com
|
||||||
///
|
///
|
||||||
/// \par Revision History
|
/// \par Revision History
|
||||||
/// \version 1.0 Initial release
|
/// \version 1.0 Initial release
|
||||||
@ -158,7 +158,7 @@
|
|||||||
/// oscillation about the target position.
|
/// oscillation about the target position.
|
||||||
/// \version 1.27 Added stop() function to stop as fast as possible with current acceleration parameters.
|
/// \version 1.27 Added stop() function to stop as fast as possible with current acceleration parameters.
|
||||||
/// Also added new Quickstop example showing its use.
|
/// Also added new Quickstop example showing its use.
|
||||||
/// \version 1.28 Fixed another problem where certain combinations of speed and accelration could cause
|
/// \version 1.28 Fixed another problem where certain combinations of speed and acceleration could cause
|
||||||
/// oscillation about the target position.
|
/// oscillation about the target position.
|
||||||
/// Added support for 3 wire full and half steppers such as Hard Disk Drive spindle.
|
/// Added support for 3 wire full and half steppers such as Hard Disk Drive spindle.
|
||||||
/// Contributed by Yuri Ivatchkovitch.
|
/// Contributed by Yuri Ivatchkovitch.
|
||||||
@ -242,6 +242,8 @@
|
|||||||
/// setMaxSpeed() and setAcceleration() now correct negative values to be positive.
|
/// setMaxSpeed() and setAcceleration() now correct negative values to be positive.
|
||||||
/// \version 1.58 2018-04-13
|
/// \version 1.58 2018-04-13
|
||||||
/// Add initialisation for _enableInverted in constructor.
|
/// Add initialisation for _enableInverted in constructor.
|
||||||
|
/// \version 1.59 2018-08-28
|
||||||
|
/// Update commercial licensing, remove binpress.
|
||||||
///
|
///
|
||||||
/// \author Mike McCauley (mikem@airspayce.com) DO NOT CONTACT THE AUTHOR DIRECTLY: USE THE LISTS
|
/// \author Mike McCauley (mikem@airspayce.com) DO NOT CONTACT THE AUTHOR DIRECTLY: USE THE LISTS
|
||||||
// Copyright (C) 2009-2013 Mike McCauley
|
// Copyright (C) 2009-2013 Mike McCauley
|
||||||
@ -395,6 +397,7 @@ public:
|
|||||||
/// Sets the maximum permitted speed. The run() function will accelerate
|
/// Sets the maximum permitted speed. The run() function will accelerate
|
||||||
/// up to the speed set by this function.
|
/// up to the speed set by this function.
|
||||||
/// Caution: the maximum speed achievable depends on your processor and clock speed.
|
/// Caution: the maximum speed achievable depends on your processor and clock speed.
|
||||||
|
/// The default maxSpeed is 1.0 steps per second.
|
||||||
/// \param[in] speed The desired maximum speed in steps per second. Must
|
/// \param[in] speed The desired maximum speed in steps per second. Must
|
||||||
/// be > 0. Caution: Speeds that exceed the maximum speed supported by the processor may
|
/// be > 0. Caution: Speeds that exceed the maximum speed supported by the processor may
|
||||||
/// Result in non-linear accelerations and decelerations.
|
/// Result in non-linear accelerations and decelerations.
|
||||||
@ -417,6 +420,7 @@ public:
|
|||||||
/// second are unreliable. Very slow speeds may be set (eg 0.00027777 for
|
/// second are unreliable. Very slow speeds may be set (eg 0.00027777 for
|
||||||
/// once per hour, approximately. Speed accuracy depends on the Arduino
|
/// once per hour, approximately. Speed accuracy depends on the Arduino
|
||||||
/// crystal. Jitter depends on how frequently you call the runSpeed() function.
|
/// crystal. Jitter depends on how frequently you call the runSpeed() function.
|
||||||
|
/// The speed will be limited by the current value of setMaxSpeed()
|
||||||
void setSpeed(float speed);
|
void setSpeed(float speed);
|
||||||
|
|
||||||
/// The most recently set speed
|
/// The most recently set speed
|
||||||
|
Loading…
x
Reference in New Issue
Block a user