-
Notifications
You must be signed in to change notification settings - Fork 331
/
MarklinThrottle.java
292 lines (258 loc) · 12.1 KB
/
MarklinThrottle.java
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
package jmri.jmrix.marklin;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import jmri.LocoAddress;
import jmri.SpeedStepMode;
import jmri.jmrix.AbstractThrottle;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* An implementation of DccThrottle with code specific to an TAMS connection.
* <p>
* Based on Glen Oberhauser's original LnThrottle implementation
*
* @author Kevin Dickerson Copyright (C) 2012
*/
public class MarklinThrottle extends AbstractThrottle implements MarklinListener {
/**
* Constructor.
*/
public MarklinThrottle(MarklinSystemConnectionMemo memo, LocoAddress address) {
super(memo);
tc = memo.getTrafficController();
this.speedSetting = 0;
this.f0 = false;
this.f1 = false;
this.f2 = false;
this.f3 = false;
this.f4 = false;
this.f5 = false;
this.f6 = false;
this.f7 = false;
this.f8 = false;
this.f9 = false;
this.f10 = false;
this.f11 = false;
this.f12 = false;
this.address = address;
this.isForward = true;
setSpeedStepMode(jmri.SpeedStepMode.NMRA_DCC_128);
tc.addMarklinListener(this);
tc.sendMarklinMessage(MarklinMessage.getQryLocoSpeed(getCANAddress()), this);
tc.sendMarklinMessage(MarklinMessage.getQryLocoDirection(getCANAddress()), this);
for (int i = 0; i <= 28; i++) {
tc.sendMarklinMessage(MarklinMessage.getQryLocoFunction(getCANAddress(), i), this);
}
}
/**
* Send the message to set the state of functions F0, F1, F2, F3, F4. To
* send function group 1 we have to also send speed, direction etc.
*/
@Override
protected void sendFunctionGroup1() {
tc.sendMarklinMessage(MarklinMessage.setLocoFunction(getCANAddress(), 0, (f0 ? 0x01 : 0x00)), this);
tc.sendMarklinMessage(MarklinMessage.setLocoFunction(getCANAddress(), 1, (f1 ? 0x01 : 0x00)), this);
tc.sendMarklinMessage(MarklinMessage.setLocoFunction(getCANAddress(), 2, (f2 ? 0x01 : 0x00)), this);
tc.sendMarklinMessage(MarklinMessage.setLocoFunction(getCANAddress(), 3, (f3 ? 0x01 : 0x00)), this);
tc.sendMarklinMessage(MarklinMessage.setLocoFunction(getCANAddress(), 4, (f4 ? 0x01 : 0x00)), this);
}
/**
* Send the message to set the state of functions F5, F6, F7, F8.
*/
@Override
protected void sendFunctionGroup2() {
tc.sendMarklinMessage(MarklinMessage.setLocoFunction(getCANAddress(), 5, (f5 ? 0x01 : 0x00)), this);
tc.sendMarklinMessage(MarklinMessage.setLocoFunction(getCANAddress(), 6, (f6 ? 0x01 : 0x00)), this);
tc.sendMarklinMessage(MarklinMessage.setLocoFunction(getCANAddress(), 7, (f7 ? 0x01 : 0x00)), this);
tc.sendMarklinMessage(MarklinMessage.setLocoFunction(getCANAddress(), 8, (f8 ? 0x01 : 0x00)), this);
}
@Override
protected void sendFunctionGroup3() {
tc.sendMarklinMessage(MarklinMessage.setLocoFunction(getCANAddress(), 9, (f9 ? 0x01 : 0x00)), this);
tc.sendMarklinMessage(MarklinMessage.setLocoFunction(getCANAddress(), 10, (f10 ? 0x01 : 0x00)), this);
tc.sendMarklinMessage(MarklinMessage.setLocoFunction(getCANAddress(), 11, (f11 ? 0x01 : 0x00)), this);
tc.sendMarklinMessage(MarklinMessage.setLocoFunction(getCANAddress(), 12, (f12 ? 0x01 : 0x00)), this);
}
@Override
protected void sendFunctionGroup4() {
tc.sendMarklinMessage(MarklinMessage.setLocoFunction(getCANAddress(), 13, (f13 ? 0x01 : 0x00)), this);
tc.sendMarklinMessage(MarklinMessage.setLocoFunction(getCANAddress(), 14, (f14 ? 0x01 : 0x00)), this);
tc.sendMarklinMessage(MarklinMessage.setLocoFunction(getCANAddress(), 15, (f15 ? 0x01 : 0x00)), this);
tc.sendMarklinMessage(MarklinMessage.setLocoFunction(getCANAddress(), 16, (f16 ? 0x01 : 0x00)), this);
tc.sendMarklinMessage(MarklinMessage.setLocoFunction(getCANAddress(), 17, (f17 ? 0x01 : 0x00)), this);
tc.sendMarklinMessage(MarklinMessage.setLocoFunction(getCANAddress(), 18, (f18 ? 0x01 : 0x00)), this);
tc.sendMarklinMessage(MarklinMessage.setLocoFunction(getCANAddress(), 19, (f19 ? 0x01 : 0x00)), this);
tc.sendMarklinMessage(MarklinMessage.setLocoFunction(getCANAddress(), 20, (f20 ? 0x01 : 0x00)), this);
}
@Override
protected void sendFunctionGroup5() {
tc.sendMarklinMessage(MarklinMessage.setLocoFunction(getCANAddress(), 21, (f21 ? 0x01 : 0x00)), this);
tc.sendMarklinMessage(MarklinMessage.setLocoFunction(getCANAddress(), 22, (f22 ? 0x01 : 0x00)), this);
tc.sendMarklinMessage(MarklinMessage.setLocoFunction(getCANAddress(), 23, (f23 ? 0x01 : 0x00)), this);
tc.sendMarklinMessage(MarklinMessage.setLocoFunction(getCANAddress(), 24, (f24 ? 0x01 : 0x00)), this);
tc.sendMarklinMessage(MarklinMessage.setLocoFunction(getCANAddress(), 25, (f25 ? 0x01 : 0x00)), this);
tc.sendMarklinMessage(MarklinMessage.setLocoFunction(getCANAddress(), 26, (f26 ? 0x01 : 0x00)), this);
tc.sendMarklinMessage(MarklinMessage.setLocoFunction(getCANAddress(), 27, (f27 ? 0x01 : 0x00)), this);
tc.sendMarklinMessage(MarklinMessage.setLocoFunction(getCANAddress(), 28, (f28 ? 0x01 : 0x00)), this);
}
/**
* Set the speed {@literal &} direction.
* <p>
* This intentionally skips the emergency stop value of 1.
*
* @param speed Number from 0 to 1; less than zero is emergency stop
*/
@SuppressFBWarnings(value = "FE_FLOATING_POINT_EQUALITY") // OK to compare floating point, notify on any change
@Override
public void setSpeedSetting(float speed) {
float oldSpeed = this.speedSetting;
this.speedSetting = speed;
int value = (int) ((1000) * this.speedSetting);
if (value > 1000) {
value = 1000; // max possible speed
}
if (value < 0) {
//Emergency Stop
tc.sendMarklinMessage(MarklinMessage.setLocoEmergencyStop(getCANAddress()), this);
} else {
tc.sendMarklinMessage(MarklinMessage.setLocoSpeed(getCANAddress(), value), this);
}
if (log.isDebugEnabled()) {
log.debug("Float speed = " + speed + " Int speed = " + value);
}
if (oldSpeed != this.speedSetting) {
notifyPropertyChangeListener(SPEEDSETTING, oldSpeed, this.speedSetting);
}
}
/**
* Convert a Marklin speed integer to a float speed value
*/
protected float floatSpeed(int lSpeed) {
if (lSpeed == 0) {
return 0.f;
}
return ((lSpeed) / 1000.f);
}
@Override
public void setIsForward(boolean forward) {
boolean old = isForward;
isForward = forward;
setSpeedSetting(0.0f); //Stop the loco first before changing direction.
tc.sendMarklinMessage(MarklinMessage.setLocoDirection(getCANAddress(), (forward ? 0x01 : 0x02)), this);
if (old != isForward) {
notifyPropertyChangeListener(ISFORWARD, old, isForward);
}
}
private LocoAddress address;
MarklinTrafficController tc;
@Override
public void setSpeedStepMode(SpeedStepMode Mode) {
if (log.isDebugEnabled()) {
log.debug("Speed Step Mode Change to Mode: " + Mode
+ " Current mode is: " + this.speedStepMode);
}
boolean isLong = ((jmri.ThrottleManager) adapterMemo.get(jmri.ThrottleManager.class)).canBeLongAddress(address.getNumber());
switch (address.getProtocol()) {
case DCC:
if (Mode == SpeedStepMode.NMRA_DCC_28 && isLong) {
tc.sendMarklinMessage(MarklinMessage.setLocoSpeedSteps(getCANAddress(), MarklinConstants.STEPLONG28), this);
} else if (Mode == SpeedStepMode.NMRA_DCC_28 && !isLong) {
tc.sendMarklinMessage(MarklinMessage.setLocoSpeedSteps(getCANAddress(), MarklinConstants.STEPSHORT28), this);
} else if (Mode == SpeedStepMode.NMRA_DCC_128 && isLong) {
tc.sendMarklinMessage(MarklinMessage.setLocoSpeedSteps(getCANAddress(), MarklinConstants.STEPLONG128), this);
} else if (Mode == SpeedStepMode.NMRA_DCC_128 && !isLong) {
tc.sendMarklinMessage(MarklinMessage.setLocoSpeedSteps(getCANAddress(), MarklinConstants.STEPSHORT128), this);
}
break;
default:
Mode = SpeedStepMode.NMRA_DCC_28;
break;
}
super.setSpeedStepMode(Mode);
}
@Override
public LocoAddress getLocoAddress() {
return address;
}
@Override
protected void throttleDispose() {
active = false;
}
@Override
public void message(MarklinMessage m) {
// messages are ignored
}
@Override
public void reply(MarklinReply m) {
if (m.getPriority() == MarklinConstants.PRIO_1 && m.getCommand() >= MarklinConstants.MANCOMMANDSTART && m.getCommand() <= MarklinConstants.MANCOMMANDEND) {
if (m.getAddress() != getCANAddress()) {
if (log.isDebugEnabled()) {
log.debug("Addressed packet is not for us " + m.getAddress() + " " + getCANAddress());
}
return;
}
if (m.getCommand() == MarklinConstants.LOCODIRECTION) {
if (log.isDebugEnabled()) {
log.debug("Loco Direction " + m.getElement(9));
}
//The CS2 sets the speed of the loco to Zero when changing direction, however it doesn't appear to broadcast it out.
switch (m.getElement(9)) {
case 0x00:
return; //No change
case 0x01:
if (!isForward) {
speedSetting = 0.0f;
super.setSpeedSetting(speedSetting);
notifyPropertyChangeListener(ISFORWARD, isForward, true);
isForward = true;
}
return;
case 0x02:
if (isForward) {
speedSetting = 0.0f;
super.setSpeedSetting(speedSetting);
notifyPropertyChangeListener(ISFORWARD, isForward, false);
isForward = false;
}
return;
case 0x03:
speedSetting = 0.0f;
super.setSpeedSetting(speedSetting);
notifyPropertyChangeListener(ISFORWARD, isForward, !isForward);
isForward = !isForward;
return;
default:
log.error("No Match Found for loco direction " + m.getElement(9));
return;
}
}
if (m.getCommand() == MarklinConstants.LOCOSPEED) {
int speed = m.getElement(9);
speed = (speed << 8) + (m.getElement(10));
Float newSpeed = Float.valueOf(floatSpeed(speed));
if (log.isDebugEnabled()) {
log.debug("Speed raw " + speed + " float " + newSpeed);
}
super.setSpeedSetting(newSpeed);
}
if (m.getCommand() == MarklinConstants.LOCOFUNCTION) {
updateFunction(m.getElement(9),!(m.getElement(10)==0));
}
}
}
int getCANAddress() {
switch (address.getProtocol()) {
case DCC:
return MarklinConstants.DCCSTART + address.getNumber();
case MOTOROLA:
return address.getNumber();
case SELECTRIX:
return MarklinConstants.SX2START + address.getNumber();
case MFX:
return MarklinConstants.MFXSTART + address.getNumber();
default:
return MarklinConstants.DCCSTART + address.getNumber();
}
}
// initialize logging
private final static Logger log = LoggerFactory.getLogger(MarklinThrottle.class);
}