Merge pull request #83 from fransjacobs/79-when-auto-mode-is-stopped-dispatchers-do-not-continue-until-destination-is-reached

79 when auto mode is stopped dispatchers do not continue until destination is reached

Author: fransjacobs

README.md

@@ -31,6 +31,12 @@ The aim of the program is to automate the running of trains on my layout.
 * [Marklin CS-2](https://www.marklin.nl/producten/details/article/60215)
 * [Marklin CS-3](https://www.marklin.nl/producten/details/article/60216)
 * [HSI-S88](https://www.ldt-infocenter.com/dokuwiki/doku.php?id=en:hsi-88-usb) or the [DIY version](https://mobatron.4lima.de/2020/05/s88-scanner-mit-arduino) for feedback
+
+## NEW
+* Layout router, After the layout is created automatically all driveways are calculated.
+* Autopilot, automatically drive locomotives.
+* Virtual Command station.
+* Auto [Simulator](https://youtu.be/xP6eUdScMY0) in the Virtual Commandstation to test routes.
 
 ## Current status
 Currently the following modules are build:

src/main/java/jcs/commandStation/AbstractController.java

@@ -89,7 +89,7 @@ public void removeDisconnectionEventListener(DisconnectionEventListener listener
     this.disconnectionEventListeners.remove(listener);
   }
 
-  public boolean isPower() {
+  public synchronized boolean isPower() {
     return this.power;
   }
 

src/main/java/jcs/commandStation/JCSCommandStationImpl.java

@@ -431,6 +431,9 @@ public void changeLocomotiveDirection(Direction newDirection, LocomotiveBean loc
       address = locomotive.getUid().intValue();
     }
     if (decoderController != null) {
+      //Set the velocity to zero before changing the direction
+      //Run this in a worker thread...
+
       decoderController.changeVelocity(address, 0, locomotive.getDirection());
       decoderController.changeDirection(address, newDirection);
     }
@@ -781,7 +784,7 @@ private class LocomotiveDirectionChangeEventListener implements LocomotiveDirect
     public void onDirectionChange(LocomotiveDirectionEvent directionEvent) {
       LocomotiveBean lb = directionEvent.getLocomotiveBean();
       if (lb != null) {
-        LocomotiveBean dblb;
+        LocomotiveBean dblb = null;
         //For marklin use the ID 
         if ("marklin.cs".equals(lb.getCommandStationId())) {
           dblb = PersistenceFactory.getService().getLocomotive(lb.getId());
@@ -792,7 +795,19 @@ public void onDirectionChange(LocomotiveDirectionEvent directionEvent) {
           } else {
             address = lb.getId().intValue();
           }
-          dblb = PersistenceFactory.getService().getLocomotive(address, lb.getDecoderType(), lb.getCommandStationId());
+          if (lb.getDecoderType() != null) {
+            dblb = PersistenceFactory.getService().getLocomotive(address, lb.getDecoderType(), lb.getCommandStationId());
+          } else {
+            //Try to match one...
+            Set<Protocol> protocols = PersistenceFactory.getService().getDefaultCommandStation().getSupportedProtocols();
+            for (Protocol protocol : protocols) {
+              DecoderType decoder = DecoderType.get(protocol.getProtocol());
+              dblb = PersistenceFactory.getService().getLocomotive(address, decoder, lb.getCommandStationId());
+              if (dblb != null) {
+                break;
+              }
+            }
+          }
         }
 
         if (dblb != null) {

src/main/java/jcs/commandStation/autopilot/AutoPilot.java

@@ -85,6 +85,31 @@ public synchronized void startAutoMode() {
     }
   }
 
+  public boolean isAutoModeActive() {
+    if (this.autoPilotThread != null) {
+      return this.autoPilotThread.isRunning();
+    } else {
+      return false;
+    }
+  }
+
+  boolean isAutoPilotThreadStopped() {
+    if (this.autoPilotThread != null) {
+      return this.autoPilotThread.isStopped();
+    } else {
+      return true;
+    }
+  }
+
+  public boolean isRunning(LocomotiveBean locomotive) {
+    if (this.isAutoModeActive() && this.dispatchers.containsKey(locomotive.getName())) {
+      Dispatcher dispatcher = this.dispatchers.get(locomotive.getName());
+      return dispatcher.isRunning();
+    } else {
+      return false;
+    }
+  }
+
   public synchronized void stopAutoMode() {
     this.autoPilotThread.stopAutoMode();
     notifyAll();
@@ -142,7 +167,7 @@ public synchronized void clearDispatchers() {
 
     for (Dispatcher dispatcher : this.dispatchers.values()) {
       dispatcher.stopLocomotiveAutomode();
-      dispatcher.forceStopRunning();
+      //dispatcher.forceStopRunning();
     }
 
     this.dispatchers.clear();
@@ -250,6 +275,7 @@ public void resetStates() {
             }
             default -> {
               if (BlockBean.BlockState.OCCUPIED == block.getBlockState()) {
+                block.setArrivalSuffix(null);
                 occupiedBlockCounter++;
               }
             }
@@ -386,23 +412,6 @@ public synchronized void removeAutoPilotStatusListener(AutoPilotStatusListener l
     Logger.trace("Status listeners: " + autoPilotStatusListeners.size());
   }
 
-  public boolean isAutoModeActive() {
-    if (this.autoPilotThread != null) {
-      return this.autoPilotThread.isRunning();
-    } else {
-      return false;
-    }
-  }
-
-  public boolean isRunning(LocomotiveBean locomotive) {
-    if (this.isAutoModeActive() && this.dispatchers.containsKey(locomotive.getName())) {
-      Dispatcher dispatcher = this.dispatchers.get(locomotive.getName());
-      return dispatcher.isRunning();
-    } else {
-      return false;
-    }
-  }
-
   public boolean tryAquireLock() {
     return semaphore.tryAcquire();
   }
@@ -421,6 +430,7 @@ private class AutoPilotThread extends Thread {
     private final List<SensorListener> sensorListeners = new ArrayList<>();
 
     private boolean running = false;
+    private boolean stopped = false;
 
     AutoPilotThread(AutoPilot autoPilot) {
       this.autoPilot = autoPilot;
@@ -508,7 +518,7 @@ public void run() {
       if (dispatchersRunning) {
         for (Dispatcher ld : dispatchers.values()) {
           if (ld.isRunning()) {
-            ld.forceStopRunning();
+            //ld.forceStopRunning();
             Logger.trace("Forse Stop on " + ld.getName());
           }
         }
@@ -521,7 +531,12 @@ public void run() {
         asl.statusChanged(running);
       }
 
-      Logger.trace("Autopilot Finished. Notify " + autoPilotStatusListeners.size() + " Listeners...");
+      Logger.trace("Autopilot Finished. Notified " + autoPilotStatusListeners.size() + " Listeners. Power is " + (JCS.getJcsCommandStation().isPowerOn() ? "on" : "off"));
+      stopped = true;
+    }
+
+    boolean isStopped() {
+      return this.stopped;
     }
   }
 

src/main/java/jcs/commandStation/autopilot/state/Dispatcher.java

@@ -53,7 +53,14 @@ public class Dispatcher {
   private String destinationBlockId;
 
   private String waitingForSensorId;
+  //Enter Sensor of the destination
+  private String enterSensorId;
+  //In Sensor of the destination
   private String inSensorId;
+
+  //The Occupation sensor of the departure 
+  private String occupationSensorId;
+  //The exit of the departure
   private String exitSensorId;
 
   private final List<StateEventListener> stateEventListeners;
@@ -62,8 +69,9 @@ public class Dispatcher {
 
   public Dispatcher(LocomotiveBean locomotiveBean, AutoPilot autoPilot) {
     this.locomotiveBean = locomotiveBean;
+    //Prefill with the current locomotive direction
+    this.locomotiveBean.setDispatcherDirection(locomotiveBean.getDirection());
     this.autoPilot = autoPilot;
-
     this.stateEventListeners = new LinkedList<>();
     this.stateMachineThread = new StateMachineThread(this);
   }
@@ -107,15 +115,18 @@ public boolean isLocomotiveAutomodeOn() {
     return this.stateMachineThread.isEnableAutomode();
   }
 
-  public void startLocomotiveAutomode() {
-    stateMachineThread.setEnableAutomode(true);
-    //is the thread running?
-    startRunning();
+  public boolean startLocomotiveAutomode() {
+    //Only when the Autopilot is ON!
+    if (autoPilot.isAutoModeActive()) {
+      stateMachineThread.setEnableAutomode(true);
+      //is the thread running?
+      startRunning();
+    }
+    return this.stateMachineThread.isEnableAutomode();
   }
 
   public void stopLocomotiveAutomode() {
     stateMachineThread.setEnableAutomode(false);
-    stopRunning();
   }
 
   void startRunning() {
@@ -139,21 +150,17 @@ void stopRunning() {
     }
   }
 
-  public void forceStopRunning() {
-//    if (stateMachineThread != null && stateMachineThread.isThreadRunning()) {
-//      this.stateMachineThread.forceStop();
-//    }
-  }
-
   void resetDispatcher() {
     this.routeBean = null;
     this.departureBlockId = null;
     this.destinationBlockId = null;
     this.waitingForSensorId = null;
+    this.enterSensorId = null;
     this.inSensorId = null;
     this.exitSensorId = null;
     this.stateEventListeners.clear();
-    this.stateMachineThread = new StateMachineThread(this);
+    this.locomotiveBean.setDispatcherDirection(Direction.SWITCH);
+    this.stateMachineThread = new StateMachineThread(null);
   }
 
   public void reset() {
@@ -220,9 +227,9 @@ String getDestinationArrivalSuffix() {
     return destinationArrivalSuffix;
   }
 
-  public String getDispatcherStateString() {
+  public String getStateName() {
     if (stateMachineThread != null) {
-      return stateMachineThread.getState().getClass().getSimpleName();
+      return stateMachineThread.getDispatcherStateName();
     } else {
       return "#Idle";
     }
@@ -237,6 +244,14 @@ public String getWaitingForSensorId() {
     return waitingForSensorId;
   }
 
+  public String getEnterSensorId() {
+    return enterSensorId;
+  }
+
+  void setEnterSensorId(String enterSensorId) {
+    this.enterSensorId = enterSensorId;
+  }
+
   public String getInSensorId() {
     return inSensorId;
   }
@@ -245,6 +260,14 @@ void setInSensorId(String inSensorId) {
     this.inSensorId = inSensorId;
   }
 
+  public String getOccupationSensorId() {
+    return occupationSensorId;
+  }
+
+  void setOccupationSensorId(String occupationSensorId) {
+    this.occupationSensorId = occupationSensorId;
+  }
+
   public String getExitSensorId() {
     return exitSensorId;
   }
@@ -265,7 +288,7 @@ void registerIgnoreEventHandler(String sensorId) {
 
   synchronized void clearDepartureIgnoreEventHandlers() {
     if (departureBlockId != null) {
-      BlockBean departureBlock = this.getDepartureBlock();
+      BlockBean departureBlock = getDepartureBlock();
       String minSensorId = departureBlock.getMinSensorId();
       autoPilot.removeHandler(minSensorId);
       String plusSensorId = departureBlock.getPlusSensorId();
@@ -282,6 +305,12 @@ synchronized void onIgnoreEvent(SensorEvent event) {
         }
       }
 
+      if (this.enterSensorId != null && this.enterSensorId.equals(event.getId())) {
+        if (!event.isActive()) {
+          this.enterSensorId = null;
+        }
+      }
+
       if (this.inSensorId != null && this.inSensorId.equals(event.getId())) {
         if (!event.isActive()) {
           this.inSensorId = null;