accelStepper #176

dtex · 2017-07-03T18:23:35Z

Implementation of stepper 2.

Works with this PR in ConfigurableFirmata

Still needs tests and testing. Also name may change from stepper2.

Here is the protocol PR: firmata/protocol#87

Still lots to do of course, but let me know if I should squash commits before this gets merged.

soundanalogous · 2017-07-08T19:06:27Z

Do you have an example script you are using? I recommend adding it to the examples directory. At least temporarily.

dtex · 2017-07-08T19:23:05Z

I'll get a couple in tonight (one for accel and one for multi)

soundanalogous · 2017-07-08T20:32:28Z

What are you using for 2 and 4 wire testing? I just use a couple of L293D H-bridges (one for a 2 wire configuration and another for a 4 wire configuration) on a breadboard. Curious if you've found any breakout boards or shields, etc that you prefer or if you just wire up a custom circuit as well? I use an EasyDriver for the step + direction configuration.

dtex · 2017-07-08T22:44:36Z

I've been using a couple of L298 breakout boards. One is from Keyes and the other is a no-label Ali Express special. Both are in four wire configurations. I honestly don't know anything about two wire stepper configurations (other than step+direction type) and couldn't find anything with Google.

I soldered up any Easy Driver today to test with, and also dug up an Arduino Motor Shield V1 and V2. I have some three phase motors on the way from eBay.

soundanalogous · 2017-07-08T22:59:21Z

Regarding 2 wire unipolar or bipolar drivers, this is the article + schematics I used: http://www.tigoe.com/pcomp/code/circuits/motors/stepper-motors/. Specifically the bipolar example with the 2 NPN transistors.

soundanalogous · 2017-07-08T23:01:40Z

you know that's old when an article has basic stamp code in it :-D

dtex · 2017-07-09T00:01:04Z

Those examples are ready

soundanalogous · 2017-07-09T00:50:57Z

Thanks. Trying them now.

A couple of early observations:

Step + Dir doesn't seem to work. It only takes 3 steps with my EasyDriver, but 4 wire with H-bridge works
The speed isn't right if an acceleration value is not specified. It's significantly slower if you omit the call to stepper2Acceleration.

dtex · 2017-07-09T01:03:40Z

It only takes 3 steps with my EasyDriver,

How many steps are you asking for on Step + Dir? I'm testing for the first time right now and I am getting 1/8th steps even thought my MS1 and MS2 logic pins are set low (which should be full step).

The speed isn't right if an acceleration value is not specified.

I believe this is expected behavior for accelStepper. We could certainly put in our own default for this.

soundanalogous · 2017-07-09T20:23:51Z

This is working for me now. I just had to switch the step and dir pins (but that should really be done in the firmware, not here).

soundanalogous · 2017-07-09T20:33:28Z

Currently stepType has no effect when using a DRIVER type board. We could however use the stepType as a multiplier so that the user can specify the actual number of steps in stead of the number of sub steps.

For example, by default an EasyDriver is configured for micro stepping (1/8) so if a user wants 1000 steps, they actually need to pass (1000 * 8) and to get the correct speed and acceleration they must also multiply those values by 8 as well. We could instead handle this under the hood (and I think this would be better handled in the client library than in the firmware). We'd also need to add a 1/4 step type, so we'd have WHOLE, HALF, QUARTER and either MICRO or EIGHTH (?). We're currently limited to WHOLE and HALF for non DRIVER types but that could be documented and also enforced in code (if not DRIVER type and stepType > 1 then stepType = 1 and print a warning to the console). But of this would have to be made clear to the user. Thoughts?

update I need to verify that the non DRIVER types actually work this way since it's just an assumption I have at this point (where WHOLE + 1000 steps will be 1000 steps and HALF + 1000 steps will be 1000 steps instead of 500 steps... need to verify).

dtex · 2017-07-09T21:27:38Z

I'll normalize the step/direction pin ordering to match accelStepper across protocol, configurableFirmata and firmata.js. Makes sense to keep it the same everywhere.

by default an EasyDriver is configured for micro stepping (1/8)

Ohhhhh they're pulled high. I missed that.

if a user wants 1000 steps, they actually need to pass (1000 * 8)

I guess in my mind the step "size" is what changes. Setting step type to HALF instead of WHOLE effectively turns a 200 step per revolution motor into a 400 step per revolution motor. That seems to be how both accelStepper and easyDriver reason about it with a "step" being one increment of the chosen type.

dtex · 2017-07-09T21:30:00Z

With non driver types, HALF + 1000 = WHOLE + 500.

soundanalogous · 2017-07-09T21:32:25Z

If I run this on a 4 wire configuration with a stepType of either WHOLE or HALF, I get exactly 10 steps.

    board.stepper2Speed(0, 4);
    board.stepper2Acceleration(0, 0);
    board.stepper2Step(0, 10);

soundanalogous · 2017-07-09T21:33:47Z

If I run this on a DRIVER configuration, I get exactly 10 steps.

    board.stepper2Speed(0, 4 * 8);
    board.stepper2Acceleration(0, 0);
    board.stepper2Step(0, 10 * 8);

With the 4 wire configuration no multiplication is necessary because it's handled by the AccelStepper library.

soundanalogous · 2017-07-09T21:37:18Z

I'm counting steps here also by what is audible. Maybe I just can't hear the microsteps.

soundanalogous · 2017-07-09T21:43:37Z

Okay interesting, I had never really though about it this way, but the count seems to really depends on what a user's perception of "steps" is. Substeps (half, quarter, eighth, etc) happen in quick succession, whereas there are larger intervals that you can hear/feel more easily. These larger intervals align with what the stepper2Step value is set as. I'm not sure however if this is specific to EasyDriver or a universal principle for stepper motors. I'd have to dig in more to figure it out.

Correction the value passed to stepper2Steps is the total number of steps (including substeps) but does not necessarily align with the perception of number steps that occurred).

dtex · 2017-07-09T21:49:56Z

You can definitely hear half steps on a four wire stepper, but they are much more subtle (smoother). I imagine wether you hear it or not depends on a lot of variables. Torque increases with higher voltages so the motor will snap into place with more force and be more audible. Motors with bigger steps are more likely to be audible as well.

It's easier to tell how many steps you are getting by finding the number of steps per revolution for your motor, and then asking for that number of steps. If it's a 200 step motor and you ask for 200 WHOLE steps it should turn exactly 360 degrees. 180 degrees for 200 HALF steps.

soundanalogous · 2017-07-09T21:52:55Z

But the way AccelStepper works, if you have a 200 SPR motor set stepType to HALF and set the number of steps to 200, it will still turn 360 degrees, because in half-step mode AccelStepper runs each step sequence twice in a row per call to step. You can see this here for the 4-wire configuration: https://github.com/firmata/ConfigurableFirmata/pull/72/files#diff-6264683f37652d37d943fd4f8ac70e28R502.

soundanalogous · 2017-07-09T21:54:12Z

Actually it's not running the same sequence twice in a row, it's running 2 half sequences making a whole sequence.

dtex · 2017-07-09T21:57:56Z

You're losing me here. There is just one call to step8 for each call to step and there is never more than one call to step on a pass through the loop.

soundanalogous · 2017-07-09T21:59:17Z

Nevermind, tested again and your right :)

soundanalogous · 2017-07-09T22:09:27Z

I never use stepper motors so you'll have to bear with my confusion as I gain an understanding of how they actually work. I think I have a pretty good grasp on them now. The steps-per-revolution tip is what helped make it all click.

soundanalogous · 2017-07-09T22:53:04Z

Have tested successfully with a 2 wire configuration. I still need to test groups but that will have to wait for another day. Also I don't have a 3 wire configuration to test. Not sure how common that is.

dtex · 2017-07-09T23:41:52Z

The three wire is actually for three phase motors which aren't really stepper motors. The most common three phase motors are those harvested from old hard drives. I don't have any either, but I ordered some off eBay.

coveralls · 2017-07-13T04:30:59Z

Coverage decreased (-13.2%) to 86.777% when pulling 5f9fcd9 on dtex:stepper2 into 0523f58 on firmata:master.

soundanalogous · 2017-07-13T05:32:35Z

lib/firmata.js

@@ -1773,12 +1773,14 @@ Board.prototype.stepper2Config = function(opts) {
    data.push(opts.motorPin4);
  }

-  if (opts.type === this.STEPPER.TYPE.DRIVER && opts.ms1Pin && opts.ms2Pin) {
+  if ((opts.type === this.STEPPER.TYPE.DRIVER) && opts.ms1Pin && opts.ms2Pin) {


Keep in mind that for some boards the pin number could be zero which would result in this evaluating to false. Same issue line 1781 as well. Could use opts.somePin != null (which is shorter than typeof opts.somePin !== 'undefined', but some developers prefer the later and others the former) to get around this.

coveralls · 2017-07-13T17:54:52Z

Coverage decreased (-12.9%) to 87.085% when pulling 3da6efb on dtex:stepper2 into 0523f58 on firmata:master.

coveralls · 2017-07-17T00:08:35Z

Coverage decreased (-0.5%) to 99.531% when pulling 70c50a9 on dtex:stepper2 into 0523f58 on firmata:master.

coveralls · 2017-07-17T01:16:57Z

Coverage decreased (-0.5%) to 99.53% when pulling 14be7e2 on dtex:stepper2 into 0523f58 on firmata:master.

coveralls · 2017-07-17T01:30:44Z

Coverage remained the same at 100.0% when pulling d4005da on dtex:stepper2 into 0523f58 on firmata:master.

coveralls · 2017-07-18T00:56:44Z

Coverage remained the same at 100.0% when pulling 68b4d77 on dtex:stepper2 into 0523f58 on firmata:master.

dtex · 2017-07-18T04:01:21Z

@soundanalogous

Update:

Three wire works fine, though I'll be darned if I can think of a good use. Maybe I'm just using crappy motors.

I can hit 920 steps per second with stepper2 in firmata so my assumption that stepper2 would be significantly slower was incorrect.

I have a couple of questions:

Should I squash commits on this and the PR's for protocol and configurableFirmata?

Should I remove stepper and rename stepper2 to stepper?

I've still only tested with an Arduino Uno. What other micro-controllers do you suggest trying?

coveralls · 2017-07-18T04:28:02Z

Coverage remained the same at 100.0% when pulling 29e9f8f on dtex:stepper2 into 0523f58 on firmata:master.

soundanalogous · 2017-07-18T05:04:41Z

I've still only tested with an Arduino Uno. What other micro-controllers do you suggest trying?

One thing I do is compile the code against several different architectures. You can simply do this by selecting different boards in the Arduino IDE then compiling (you don't actually need the boards). I recommend trying to compile for the following boards (you may need to install some of the using the Arduino Boards Manager):

Zero or MKR Zero
Due
Arduino 101
Leonardo
Mega
Teensy 2.0, LC, 3.2, 3.5 and 3.6
Generic ESP8266 module
Intel Galileo or Edison (although these are now discontinued boards).

You may see complier warnings as you try different architectures. The Xtensa complier used for the ESP8266 boards for example is very strict. I look over the warnings but tend to ignore a lot of them unless it seems like it could be a real issue.

As far as testing on physical boards, I'd recommend the following if you have them:

Arduino Zero or MKR Zero (SAMD architecture)
Arduino Leonardo (or other ATmega32u4 architecture board)
Any of the Teensy boards if you have one (but preferably LC or one of the 3.x boards)

soundanalogous · 2017-07-18T05:05:12Z

Should I squash commits on this and the PR's for protocol and configurableFirmata?

Yes please.

soundanalogous · 2017-07-18T05:06:11Z

Should I remove stepper and rename stepper2 to stepper?

I need to think a bit more about how I want to properly deprecate the older Stepper.

soundanalogous · 2017-07-18T05:08:02Z

lib/firmata.js

+
+  interface = ((opts.type & 0x07) << 4) | ((opts.stepType & 0x07) << 1);
+
+  if (opts.enablePin) {


enablePin could be 0

soundanalogous · 2017-07-18T05:08:57Z

lib/firmata.js

+    data.push(opts.motorPin4);
+  }
+
+  if (opts.enablePin) {


pin number could be 0

soundanalogous · 2017-07-18T05:10:02Z

lib/firmata.js

+
+  data.push(
+    interface,
+    opts.stepPin || opts.motorPin1,


one of these 4 pins could be zero

coveralls · 2017-07-18T18:35:52Z

Coverage remained the same at 100.0% when pulling 0a196d6 on dtex:stepper2 into 0523f58 on firmata:master.

coveralls · 2017-07-18T18:35:53Z

Coverage remained the same at 100.0% when pulling 0a196d6 on dtex:stepper2 into 0523f58 on firmata:master.

dtex · 2017-07-18T19:14:21Z

Fixed all the checks where pin value could be zero. I'm really bad about that.

Also squashed all the commits (for the other PR's as well). Sparkfun is going to send me a couple of the boards you mentioned they are kind hearted and awesome. Compiling for Zero is throwing a ton of errors, but they are all in servo.

coveralls · 2017-07-18T19:29:40Z

Coverage remained the same at 100.0% when pulling 5ad3b8d on dtex:stepper2 into 0523f58 on firmata:master.

soundanalogous · 2017-07-19T03:49:04Z

Let's call this feature AccelStepperFirmata and mark the old Stepper constructor and associated methods as 'deprecated' and add a note to the old constructor asking users to use the new AccelStepperFirmata instead.

@rwaldron does this sound good to you?

dtex · 2017-07-19T15:55:10Z

To be sure i'm clear... Do you want the old constructor still work (with the warning) or should I remove all the old stepper code from this, and configurableFirmata?

soundanalogous · 2017-07-19T15:58:20Z

I think we need to keep it for a while since other projects that depend on firmata.js may still depend on it for a while. That's where I wanted Rick's feedback to be sure.

coveralls · 2017-07-20T00:02:08Z

Coverage remained the same at 100.0% when pulling 7b237db on dtex:stepper2 into 0523f58 on firmata:master.

coveralls · 2017-07-20T00:16:44Z

Coverage remained the same at 100.0% when pulling e1fc76e on dtex:stepper2 into 0523f58 on firmata:master.

dtex · 2017-07-20T21:03:05Z

lib/firmata.js

@@ -478,15 +501,14 @@ function Board(port, options, callback) {

  this.STEPPER = {
    TYPE: {
-      DRIVER: 1,
+      DRIVER: 0,


I can't make this change if we want the original stepper to work.

You'd have to make a separate object called ACCEL_STEPPER unfortunately.

dtex · 2017-07-20T23:34:28Z

No worries. It's not like I have a strong argument for using 0 over 1.

________________________________ From: Jeff Hoefs <[email protected]> Sent: Thursday, July 20, 2017 5:32:22 PM To: firmata/firmata.js Cc: Donovan Buck; Author Subject: Re: [firmata/firmata.js] [WIP] Stepper2 (#176) @soundanalogous commented on this pull request.

________________________________ In lib/firmata.js<#176 (comment)>:

@@ -478,15 +501,14 @@ function Board(port, options, callback) {

this.STEPPER = { TYPE: { - DRIVER: 1, + DRIVER: 0, You'd have to make a separate object called ACCEL_STEPPER unfortunately. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub<#176 (comment)>, or mute the thread<https://github.com/notifications/unsubscribe-auth/AA0Lfy10x7TFV5aN9rElld3K9q4HIPPFks5sP9VygaJpZM4OMkzc>.

Add support for accelSteper and multiStepper Revert "Add default serial port" This reverts commit edf8f85. Merge remote-tracking branch 'origin/stepper2' into stepper2 Update Stepper Wrap accelStepper and multiStepper.

coveralls · 2017-07-27T04:36:08Z

Coverage remained the same at 100.0% when pulling 23d2a1f on dtex:stepper2 into 0523f58 on firmata:master.

dtex · 2017-08-27T04:35:09Z

Closed and replaced by #179

Nothing has changed. Just recovering from a git mishap.

dtex mentioned this pull request Jul 3, 2017

Stepper library callbacks issue rwaldron/johnny-five#1099

Closed

soundanalogous added the Feature label Jul 8, 2017

soundanalogous reviewed Jul 13, 2017

View reviewed changes

soundanalogous reviewed Jul 18, 2017

View reviewed changes

lib/firmata.js Outdated

data.push(opts.motorPin4);

}

if (opts.enablePin) {

Copy link

Member

soundanalogous Jul 18, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pin number could be 0

soundanalogous reviewed Jul 18, 2017

View reviewed changes

lib/firmata.js Outdated

data.push(

interface,

opts.stepPin || opts.motorPin1,

Copy link

Member

soundanalogous Jul 18, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one of these 4 pins could be zero

dtex mentioned this pull request Jul 19, 2017

Trying to use 6 steppers. rwaldron/johnny-five#1133

Closed

dtex commented Jul 20, 2017

View reviewed changes

Stepper 2

23d2a1f

Add support for accelSteper and multiStepper Revert "Add default serial port" This reverts commit edf8f85. Merge remote-tracking branch 'origin/stepper2' into stepper2 Update Stepper Wrap accelStepper and multiStepper.

dtex changed the title ~~[WIP] Stepper2~~ accelStepper Aug 21, 2017

dtex mentioned this pull request Aug 27, 2017

firmataAccelStepper #179

Closed

dtex closed this Aug 27, 2017


		interface = ((opts.type & 0x07) << 4) \| ((opts.stepType & 0x07) << 1);

		if (opts.enablePin) {

accelStepper #176

accelStepper #176

Conversation

dtex commented Jul 3, 2017

soundanalogous commented Jul 8, 2017

dtex commented Jul 8, 2017

soundanalogous commented Jul 8, 2017

dtex commented Jul 8, 2017

soundanalogous commented Jul 8, 2017

soundanalogous commented Jul 8, 2017

dtex commented Jul 9, 2017

soundanalogous commented Jul 9, 2017 • edited Loading

dtex commented Jul 9, 2017

soundanalogous commented Jul 9, 2017

soundanalogous commented Jul 9, 2017 • edited Loading

dtex commented Jul 9, 2017

dtex commented Jul 9, 2017

soundanalogous commented Jul 9, 2017

soundanalogous commented Jul 9, 2017 • edited Loading

soundanalogous commented Jul 9, 2017

soundanalogous commented Jul 9, 2017 • edited Loading

dtex commented Jul 9, 2017

soundanalogous commented Jul 9, 2017

soundanalogous commented Jul 9, 2017

dtex commented Jul 9, 2017

soundanalogous commented Jul 9, 2017

soundanalogous commented Jul 9, 2017

soundanalogous commented Jul 9, 2017 • edited Loading

dtex commented Jul 9, 2017

coveralls commented Jul 13, 2017 • edited Loading

soundanalogous Jul 13, 2017

Choose a reason for hiding this comment

coveralls commented Jul 13, 2017 • edited Loading

coveralls commented Jul 17, 2017 • edited Loading

coveralls commented Jul 17, 2017 • edited Loading

coveralls commented Jul 17, 2017 • edited Loading

coveralls commented Jul 18, 2017 • edited Loading

dtex commented Jul 18, 2017

coveralls commented Jul 18, 2017 • edited Loading

soundanalogous commented Jul 18, 2017

soundanalogous commented Jul 18, 2017

soundanalogous commented Jul 18, 2017

soundanalogous Jul 18, 2017

Choose a reason for hiding this comment

soundanalogous Jul 18, 2017

Choose a reason for hiding this comment

soundanalogous Jul 18, 2017

Choose a reason for hiding this comment

coveralls commented Jul 18, 2017 • edited Loading

coveralls commented Jul 18, 2017 • edited Loading

dtex commented Jul 18, 2017

coveralls commented Jul 18, 2017 • edited Loading

soundanalogous commented Jul 19, 2017

dtex commented Jul 19, 2017

soundanalogous commented Jul 19, 2017

coveralls commented Jul 20, 2017 • edited Loading

coveralls commented Jul 20, 2017 • edited Loading

dtex Jul 20, 2017

Choose a reason for hiding this comment

soundanalogous Jul 20, 2017

Choose a reason for hiding this comment

dtex commented Jul 20, 2017 via email

coveralls commented Jul 27, 2017 • edited Loading

dtex commented Aug 27, 2017

soundanalogous commented Jul 9, 2017 •

edited

Loading

soundanalogous commented Jul 9, 2017 •

edited

Loading

soundanalogous commented Jul 9, 2017 •

edited

Loading

soundanalogous commented Jul 9, 2017 •

edited

Loading

soundanalogous commented Jul 9, 2017 •

edited

Loading

coveralls commented Jul 13, 2017 •

edited

Loading

coveralls commented Jul 13, 2017 •

edited

Loading

coveralls commented Jul 17, 2017 •

edited

Loading

coveralls commented Jul 17, 2017 •

edited

Loading

coveralls commented Jul 17, 2017 •

edited

Loading

coveralls commented Jul 18, 2017 •

edited

Loading

coveralls commented Jul 18, 2017 •

edited

Loading

coveralls commented Jul 18, 2017 •

edited

Loading

coveralls commented Jul 18, 2017 •

edited

Loading

coveralls commented Jul 18, 2017 •

edited

Loading

coveralls commented Jul 20, 2017 •

edited

Loading

coveralls commented Jul 20, 2017 •

edited

Loading

coveralls commented Jul 27, 2017 •

edited

Loading