1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
|
package org.reprap.devices;
import java.io.IOException;
import org.reprap.utilities.Debug;
import org.reprap.Device;
import org.reprap.Preferences;
import org.reprap.ReprapException;
import org.reprap.comms.Address;
import org.reprap.comms.Communicator;
import org.reprap.comms.IncomingContext;
import org.reprap.comms.OutgoingMessage;
import org.reprap.comms.IncomingMessage;
import org.reprap.comms.IncomingMessage.InvalidPayloadException;
import org.reprap.comms.messages.IncomingIntMessage;
import org.reprap.comms.messages.OutgoingAddressMessage;
import org.reprap.comms.messages.OutgoingBlankMessage;
import org.reprap.comms.messages.OutgoingByteMessage;
import org.reprap.comms.messages.OutgoingIntMessage;
/**
*
*/
public class GenericStepperMotor extends Device {
/**
* API for firmware
* Activate the stepper motor in forward direction
*/
public static final byte MSG_SetForward = 1;
/**
* Activate the stepper motor in reverse direction
*/
public static final byte MSG_SetReverse = 2;
/**
* Set the stepper motor position (how?)
*/
public static final byte MSG_SetPosition = 3;
/**
* Get the current stepper motor position
*/
public static final byte MSG_GetPosition = 4;
/**
*
*/
public static final byte MSG_Seek = 5;
/**
* Set the motor to idle; this turns the torque off whereas speed = 0 keeps torque on
*/
public static final byte MSG_SetIdle = 6;
/**
* Set notification (?)
*/
public static final byte MSG_SetNotification = 7;
/**
* Set the sync mode (?)
*/
public static final byte MSG_SetSyncMode = 8;
/**
* Calibrate (?)
*/
public static final byte MSG_Calibrate = 9;
/**
* Get the range (?)
*/
public static final byte MSG_GetRange = 10;
/**
* DDAMaster ?
*/
public static final byte MSG_DDAMaster = 11;
/**
* Move on step in forward direction
*/
public static final byte MSG_StepForward = 12;
/**
* Move on step in backward direction
*/
public static final byte MSG_StepBackward = 13;
/**
* Set the power to the stepper motor
*/
public static final byte MSG_SetPower = 14;
/**
* Homereset(??
*/
public static final byte MSG_HomeReset = 16;
/**
*
*/
public static final byte SYNC_NONE = 0;
public static final byte SYNC_SEEK = 1;
public static final byte SYNC_INC = 2;
public static final byte SYNC_DEC = 3;
/**
*
*/
private boolean haveInitialised = false;
private boolean haveSetNotification = false;
private boolean haveCalibrated = false;
/**
* Useful to know what we're called
*/
private String axis;
/**
* Power output limiting (0-100 percent)
*/
private int maxTorque;
/**
* @param communicator
* @param address
* @param prefs
* @param motorId
*/
public GenericStepperMotor(Communicator communicator, Address address, Preferences prefs, int motorId) {
//Address address, int maxTorque
super(communicator, address);
switch(motorId)
{
case 1:
axis = "X";
break;
case 2:
axis = "Y";
break;
case 3:
axis = "Z";
break;
default:
axis = "X";
System.err.println("GenericStepperMotor - dud axis id: " + motorId);
}
this.maxTorque = prefs.loadInt(axis + "Axis" + "Torque(%)");
}
/**
* @throws IOException
*/
private void initialiseIfNeeded() throws IOException {
if (!haveInitialised) {
haveInitialised = true;
setMaxTorque(maxTorque);
}
}
/**
* Dispose of this object
*/
public void dispose() {
}
/**
* Set the motor speed (or turn it off)
* @param speed A value between -255 and 255.
* @throws ReprapException
* @throws IOException
*/
public void setSpeed(int speed) throws IOException {
initialiseIfNeeded();
lock();
Debug.d(axis + " axis - setting speed: " + speed);
try {
OutgoingMessage request = new RequestSetSpeed(speed);
sendMessage(request);
}
finally {
unlock();
}
}
/**
* @throws IOException
*/
public void setIdle() throws IOException {
initialiseIfNeeded();
lock();
Debug.d(axis + " axis - going idle.");
try {
OutgoingMessage request = new RequestSetSpeed();
sendMessage(request);
}
finally {
unlock();
}
}
/**
* @throws IOException
*/
public void stepForward() throws IOException {
initialiseIfNeeded();
lock();
Debug.d(axis + " axis - stepping forward.");
try {
OutgoingMessage request = new RequestOneStep(true);
sendMessage(request);
}
finally {
unlock();
}
}
/**
* @throws IOException
*/
public void stepBackward() throws IOException {
initialiseIfNeeded();
lock();
Debug.d(axis + " axis - stepping backward.");
try {
OutgoingMessage request = new RequestOneStep(false);
sendMessage(request);
}
finally {
unlock();
}
}
/**
* @throws IOException
*/
public void resetPosition() throws IOException {
setPosition(0);
}
/**
* @param position
* @throws IOException
*/
public void setPosition(int position) throws IOException {
initialiseIfNeeded();
lock();
Debug.d(axis + " axis - setting position to: " + position);
try {
sendMessage(new RequestSetPosition(position));
}
finally {
unlock();
}
}
/**
* @return current position of the motor
* @throws IOException
*/
public int getPosition() throws IOException {
int value;
initialiseIfNeeded();
lock();
Debug.d(axis + " axis - getting position. It is... ");
try {
IncomingContext replyContext = sendMessage(
new OutgoingBlankMessage(MSG_GetPosition));
IncomingIntMessage reply = new RequestPositionResponse(replyContext);
try {
value = reply.getValue();
}
catch (IncomingMessage.InvalidPayloadException ex) {
throw new IOException(ex.getMessage());
}
}
finally {
unlock();
}
Debug.d("..." + value);
return value;
}
/**
* @param speed
* @param position
* @throws IOException
*/
public void seek(int speed, int position) throws IOException {
initialiseIfNeeded() ;
lock();
Debug.d(axis + " axis - seeking position " + position + " at speed " + speed);
try {
sendMessage(new RequestSeekPosition(speed, position));
}
finally {
unlock();
}
}
/**
* @param speed
* @param position
* @throws IOException
*/
public void seekBlocking(int speed, int position) throws IOException {
initialiseIfNeeded();
lock();
Debug.d(axis + " axis - seeking-blocking position " + position + " at speed " + speed);
try {
setNotification();
new RequestSeekResponse(this, new RequestSeekPosition(speed, position), 50000);
setNotificationOff();
} catch (Exception e) {
// TODO: Nasty error. But WTF do we do about it?
e.printStackTrace();
} finally {
unlock();
}
}
/**
* @param speed
* @return range of the motor
* @throws IOException
* @throws InvalidPayloadException
*/
public Range getRange(int speed) throws IOException, InvalidPayloadException {
initialiseIfNeeded() ;
lock();
Debug.d(axis + " axis - getting range.");
try {
if (haveCalibrated) {
IncomingContext replyContext = sendMessage(
new OutgoingBlankMessage(MSG_GetRange));
RequestRangeResponse response = new RequestRangeResponse(replyContext);
return response.getRange();
} else {
setNotification();
IncomingContext replyContext = sendMessage(
new OutgoingByteMessage(MSG_Calibrate, (byte)speed));
RequestRangeResponse response = new RequestRangeResponse(replyContext);
setNotificationOff();
return response.getRange();
}
}
finally {
unlock();
}
}
/**
* @param speed
* @throws IOException
* @throws InvalidPayloadException
*/
public void homeReset(int speed) throws IOException, InvalidPayloadException {
initialiseIfNeeded() ;
lock();
Debug.d(axis + " axis - home reset at speed " + speed);
try {
setNotification();
new RequestHomeResetResponse(this, new OutgoingByteMessage(MSG_HomeReset, (byte)speed), 60000);
setNotificationOff();
} finally {
unlock();
}
}
/**
* @param syncType
* @throws IOException
*/
public void setSync(byte syncType) throws IOException {
initialiseIfNeeded() ;
lock();
Debug.d(axis + " axis - setting sync to " + syncType);
try {
sendMessage(
new OutgoingByteMessage(MSG_SetSyncMode, syncType));
}
finally {
unlock();
}
}
/**
* @param speed
* @param x1
* @param deltaY
* @throws IOException
*/
public void dda(int speed, int x1, int deltaY) throws IOException {
initialiseIfNeeded() ;
lock();
Debug.d(axis + " axis - dda at speed " + speed + ". x1 = " + x1 + ", deltaY = " + deltaY);
try {
setNotification();
new RequestDDAMasterResponse(this, new RequestDDAMaster(speed, x1, deltaY), 60000);
setNotificationOff();
}
finally {
unlock();
}
}
/**
* @throws IOException
*/
private void setNotification() throws IOException {
initialiseIfNeeded() ;
Debug.d(axis + " axis - setting notification on.");
if (!haveSetNotification) {
sendMessage(new OutgoingAddressMessage(MSG_SetNotification,
getCommunicator().getAddress()));
haveSetNotification = true;
}
}
/**
* @throws IOException
*/
private void setNotificationOff() throws IOException {
initialiseIfNeeded() ;
Debug.d(axis + " axis - setting notification off.");
if (haveSetNotification) {
sendMessage(new OutgoingAddressMessage(MSG_SetNotification, getAddress().getNullAddress()));
haveSetNotification = false;
}
}
/**
*
* @param maxTorque An integer value 0 to 100 representing the maximum torque percentage
* @throws IOException
*/
public void setMaxTorque(int maxTorque) throws IOException {
initialiseIfNeeded() ;
if (maxTorque > 100) maxTorque = 100;
double power = maxTorque * 68.0 / 100.0;
byte scaledPower = (byte)power;
lock();
Debug.d(axis + " axis - setting maximum torque to: " + maxTorque);
try {
sendMessage(
new OutgoingByteMessage(MSG_SetPower, scaledPower));
}
finally {
unlock();
}
}
/**
*
*/
protected class RequestPositionResponse extends IncomingIntMessage {
/**
* @param incomingContext
* @throws IOException
*/
public RequestPositionResponse(IncomingContext incomingContext) throws IOException {
super(incomingContext);
}
/* (non-Javadoc)
* @see org.reprap.comms.messages.IncomingIntMessage#isExpectedPacketType(byte)
*/
protected boolean isExpectedPacketType(byte packetType) {
return packetType == MSG_GetPosition;
}
}
/**
*
*/
protected class RequestSeekResponse extends IncomingIntMessage {
/**
* @param device
* @param message
* @param timeout
* @throws IOException
*/
public RequestSeekResponse(Device device, OutgoingMessage message, long timeout) throws IOException {
super(device, message, timeout);
}
/* (non-Javadoc)
* @see org.reprap.comms.messages.IncomingIntMessage#isExpectedPacketType(byte)
*/
protected boolean isExpectedPacketType(byte packetType) {
return packetType == MSG_Seek;
}
}
/**
*
*/
protected class RequestSetPosition extends OutgoingIntMessage {
/**
* @param position
*/
public RequestSetPosition(int position) {
super(MSG_SetPosition, position);
}
}
protected class RequestSetSpeed extends OutgoingMessage {
/**
*
*/
byte [] message;
/**
* The empty constructor will create a message to idle the motor
*/
RequestSetSpeed() {
message = new byte [] { MSG_SetIdle };
}
/**
* Create a message for setting the motor speed.
* @param speed The speed to set the motor to. Note that specifying
* 0 will stop the motor and hold it at 0 and thus still draws
* high current. To idle the motor, use the message created by the
* empty constructor.
*/
RequestSetSpeed(int speed) {
byte command;
if (speed >= 0) {
command = MSG_SetForward;
} else {
command = MSG_SetReverse;
speed = -speed;
}
if (speed > 255) speed = 255;
message = new byte[] { command, (byte)speed };
}
/* (non-Javadoc)
* @see org.reprap.comms.OutgoingMessage#getBinary()
*/
public byte[] getBinary() {
return message;
}
}
/**
*
*/
protected class RequestOneStep extends OutgoingMessage
{
/**
*
*/
byte [] message;
/**
* @param forward
*/
RequestOneStep(boolean forward) {
byte command;
if (forward)
command = MSG_StepForward;
else
command = MSG_StepBackward;
message = new byte[] { command };
}
/* (non-Javadoc)
* @see org.reprap.comms.OutgoingMessage#getBinary()
*/
public byte[] getBinary() {
return message;
}
}
/**
*
*/
protected class RequestSeekPosition extends OutgoingMessage {
/**
*
*/
byte [] message;
/**
* @param speed
* @param position
*/
RequestSeekPosition(int speed, int position) {
message = new byte[] { MSG_Seek,
(byte)speed,
(byte)(position & 0xff),
(byte)((position >> 8) & 0xff)};
}
/* (non-Javadoc)
* @see org.reprap.comms.OutgoingMessage#getBinary()
*/
public byte[] getBinary() {
return message;
}
}
/**
*
*/
protected class RequestDDAMaster extends OutgoingMessage {
byte [] message;
/**
* @param speed
* @param x1
* @param deltaY
*/
RequestDDAMaster(int speed, int x1, int deltaY) {
message = new byte[] { MSG_DDAMaster,
(byte)speed,
(byte)(x1 & 0xff),
(byte)((x1 >> 8) & 0xff),
(byte)(deltaY & 0xff),
(byte)((deltaY >> 8) & 0xff)
};
}
/* (non-Javadoc)
* @see org.reprap.comms.OutgoingMessage#getBinary()
*/
public byte[] getBinary() {
return message;
}
}
/**
*
*/
protected class RequestDDAMasterResponse extends IncomingIntMessage {
/**
* @param device
* @param message
* @param timeout
* @throws IOException
*/
public RequestDDAMasterResponse(Device device, OutgoingMessage message, long timeout) throws IOException {
super(device, message, timeout);
}
/* (non-Javadoc)
* @see org.reprap.comms.messages.IncomingIntMessage#isExpectedPacketType(byte)
*/
protected boolean isExpectedPacketType(byte packetType) {
return packetType == MSG_DDAMaster;
}
}
/**
*
*/
protected class RequestRangeResponse extends IncomingIntMessage {
/**
* @param incomingContext
* @throws IOException
*/
public RequestRangeResponse(IncomingContext incomingContext) throws IOException {
super(incomingContext);
}
/* (non-Javadoc)
* @see org.reprap.comms.messages.IncomingIntMessage#isExpectedPacketType(byte)
*/
protected boolean isExpectedPacketType(byte packetType) {
// We could get this either as an asynchronous notification
// from calibration or by explicit request
return packetType == MSG_GetRange || packetType == MSG_Calibrate;
}
/**
* @return
* @throws InvalidPayloadException
*/
public Range getRange() throws InvalidPayloadException {
byte [] reply = getPayload();
if (reply == null || reply.length != 3)
throw new InvalidPayloadException("Unexpected payload getting range");
Range r = new Range();
r.minimum = 0;
r.maximum = IncomingIntMessage.ConvertBytesToInt(reply[1], reply[2]);
return r;
}
}
/**
*
*/
protected class RequestHomeResetResponse extends IncomingMessage {
/**
* @param device
* @param message
* @param timeout
* @throws IOException
*/
public RequestHomeResetResponse(Device device, OutgoingMessage message, long timeout) throws IOException {
super(device, message, timeout);
}
/* (non-Javadoc)
* @see org.reprap.comms.IncomingMessage#isExpectedPacketType(byte)
*/
protected boolean isExpectedPacketType(byte packetType) {
return packetType == MSG_HomeReset;
}
}
/**
*
*/
public class Range {
/**
*
*/
public int minimum;
/**
*
*/
public int maximum;
}
}
|