Communication interface used for controlling the BlobAnalyzer

• Communication interface used for controlling the BlobAnalyzer
• Supported commands:
  • START
  • SAMPLING_DONE
  • STOP
  • FLUSH
  • FINISH
  • Example transaction after the blobAnalyzer is started
• Technical details
  • BlobAnalyzercontroller
  • SocketServer

Supported commands:

The Communication protocol relates to messages between the socket server and External controller

START

Starts a new measurement, start is send from external controller, the recipe is loaded and the blob analyzer starts analyzing, if state and recipe is valid the acknowledge is send back with the original message (ACK)

START|Sample Id|Recipe name|Operator|Comment
ACK|START|Sample Id|Recipe name|Operator|Comment

SAMPLING_DONE

When all product was presented the Blob analyzer sends SAMPLING_DONE, the external controller should reply with ACK and the original message. To Finish the measurement, send the Finish Command.

SAMPLING_DONE|Sample Id
ACK|SAMPLING_DONE|Sample Id

STOP

Stops analysis or flushing, corresponds to pressing the stop button on the user interface, the device will not empty/flush after this command

STOP
ACK|STOP

FLUSH

Flushes conveyor or vacuums the X/Y plate

FLUSH
ACK|FLUSH

FINISH

Saves the generated results and blob collections, Notice, this can only be called after a measurement was made and the device is in the stopped state

FINISH
ACK|FINISH

Example transaction after the blobAnalyzer is started

>> Customer: START|lot543887|Corn_2022_v2|CHG|A test measurement
<< VMController: ACK|START|lot543887|Corn_2022_v2|CHG|A test measurement
<< VMController: SAMPLING_DONE
>> Customer: ACK|SAMPLING_DONE
>> Customer: FINISH
<< VMController: ACK|FINISH

Technical details

BlobAnalyzercontroller

Handles message generation and consumption between controller/PLC and BlobAnalyzer, the commands are send to the BlobAnalyzer via the _IBlobAnalyzerControlListener

SocketServer

Raw socket server that creates a socket server and forwards messages to the BlobAnalyzerController

A more detailed sequence diagram is shown below

sequenceDiagram
  actor Operator as Operator
  participant VMLAB as VideometerLab 
  participant EXT as External Controller 
  participant SocketServer as SocketServer/BlobAnalyzerController
  

  Operator->>+VMLAB: Open Software and BlobAnalyzerTool
  VMLAB->>+BlobAnalyzer: Open Blob analyzer tool
  BlobAnalyzer-)Operator:Show U.I.
  
  Operator->>+EXT: Initiates measurement sequence
  EXT->>+SocketServer: START|...
  SocketServer->>BlobAnalyzer:Load recipe
  alt Recipe Loaded successfully
    BlobAnalyzer->>SocketServer: Recipe Loaded
    SocketServer->>+BlobAnalyzer:Start(id, initial, comments)
    SocketServer->>EXT:ACK|START|...
    BlobAnalyzer->>BlobAnalyzer:Perform measurement
    BlobAnalyzer->>-SocketServer:done
    SocketServer->>-EXT:SAMPLING_DONE|ID
    EXT->>SocketServer:ACK|SAMPLING_DONE|ID  
    opt the operator observes more material and continues the measurement pressing "start/continue" using the Blob Analyzer UI
      EXT->>Operator: Notify operator that additional material is observed
      Operator->>VMLAB: Continue measurement
      SocketServer->>EXT:SAMPLING_DONE|ID
      EXT->>SocketServer:ACK|SAMPLING_DONE|ID
    end
    EXT->>-SocketServer:Finish (FINISH|ID)
    SocketServer->>+BlobAnalyzer:Finish
    BlobAnalyzer->>+SocketServer:Saving finished
    SocketServer->>+EXT:ACK|FINISH|ID
  else Failed loading recipe
    BlobAnalyzer->>SocketServer: Failed loading recipe
    SocketServer->>EXT: NACK|Failed loading recipe
  end

Loading

classDiagram
class BlobAnalyzerControl {
    <<Abstract>>
	#IBlobAnalyzerControlListener _listener
    +BlobAnalyzerControl(IBlobAnalyzerControlListener listener)
    +void StateChanged(BlobAnalyzerState oldState, BlobAnalyzerState newState, string sampleId, DataTable result)*
    +string GetBlobCollectionSubfolder(DateTime measurementStartTime)*
    +string GetPredictionResultFilename(DateTime measurementStartTime)*
}

BlobAnalyzerController --* SocketServer 
class SocketServer {
    +SocketServer(Action<string> messageRecievedHandler)
    +void Start(short port)
    +public void Stop()
    +void Broadcast(string message)
}

BlobAnalyzerControl <|-- BlobAnalyzerController 
class BlobAnalyzerController {
    -CommunicationStateController
    -ResultCalculationController
    -SocketServer
}

class MessagePacket {
    +MessagePacket[] CreateResultVector(string activityId, DataTable resultTable)$
    +MessagePacket(string message)
    +string Ack(string originalMessage)$
    
    +PacketHeader Header 
    +string ErrorMessage 
    +string ActivityID 
    +string LabNo 
    +string ProductGroup 
    +string SetCount 
    +float TotalSampleWeight 
    +float WG5 
    +float W2T5 
    +string OrgCode 
    +SamplingStatus Status 
    +MessagePacket AckPackage 
    
    +int ResultLineIdx 
    +int ResultLineCount 
    +string ResultLineName 
    +string ResultLineValue 
}

MessagePacket -- PacketHeader
class PacketHeader {
    UNKNOWN
    START
    ACK
    SAMPLING_DONE
    NACK
    FINISH
    STOP
    FLUSH
}

Loading