mt.proto

##################################################
#
# Protocol file for Mettler Toledo Balance.
# 
# This implements some of the MT-SICS commands 
# (level 0 and level 1), which will apply across the
# range of MT balances.
#
# Oak Ridge National Lab, UT-Battelle, 2018.
# 
##################################################

##################################################
# General Settings

Terminator = "\r\n";
ReplyTimeout = 2000;

LongTimeout = 60000;

# Note on timeouts:
#
# The 2s timeout for general commands seems necessary. I often didn't get a reply 
# within 1s, even though most of the time the response is well below 1s and we can 
# poll weight at 10Hz.
#
# The LongTimeout is for the blocking stable weight, tare and zero commands. If 
# the scaler isn't stable these commands can take a long time to complete, until
# a timeout is reached in the scale (which seems to be about 30s in the one I tested).

###################################################
# General functions

# Note: for the string commands the device will send 
#       a string back in quotes like "blah" so it's 
#       hard to use %s or %c without getting the quotes.
#       So I found that a character based format converter 
#       works fine, where I read all characters except a quote mark.

# /// Send a cancel command
mtCancel {
   out "@";
   in "I4 A \"%[^\"]\"";
}

# /// Read the device ID
mtI2 {
   out "I2";
   in "I2 A \"%[^\"]\"";
}

# /// Read the software version
mtI3 {
   out "I3";
   in "I3 A \"%[^\"]\"";
}

# /// Read the serial number
mtI4 {
   out "I4";
   in "I4 A \"%[^\"]\"";
}

# /// Read the software ID
mtI5 {
   out "I5";
   in "I5 A \"%[^\"]\"";
}


###################################################
# Immediate response or fast set/read functions

# /// Read the immediate weight
mtSI {
   out "SI";
   in "S %(\$1_STAT)c %f %(\$1_EGU)s";
   @mismatch {in "S %(\$1_STAT)c";}
}

# /// Perform an immediate tare.
mtTI {
   out "TI";
   in "TI %(\$1_STAT)c %f %(\$1_EGU)s";
   @mismatch {in "TI %(\$1_STAT)c";}
}

# /// Perform an immediate zero.
mtZI {
   out "ZI";
   in "ZI %(\$1_STAT)c";
}

# /// Read the tare weight
mtTA {
   out "TA";
   in "TA %(\$1_STAT)c %f %(\$1_EGU)s";
   @mismatch {in "TA %(\$1_STAT)c";}
}

# /// Set the tare weight
mtTASet {
   out "TA %f %(\$1_EGU)s";
   in "TA %(\$1_STAT)c %f %(\$1_EGU)s";
   @mismatch {in "TA %(\$1_STAT)c";}
}

# /// Clear the tare weight
mtTAC {
   out "TAC";
   in "TAC %(\$1_STAT)c";
}

###################################################
# Blocking set/read functions

# /// Stable weight
mtS {
   ReplyTimeout = $LongTimeout;
   out "S";
   in "S %(\$1_STAT)c %f %(\$1_EGU)s";
   @mismatch {in "S %(\$1_STAT)c";}
}

# /// Stable tare
mtT {
   ReplyTimeout = $LongTimeout;
   out "T";
   in "T %(\$1_STAT)c %f %(\$1_EGU)s";
   @mismatch {in "T %(\$1_STAT)c";}
}

# /// Stable zero
mtZ {
   ReplyTimeout = $LongTimeout;
   out "Z";
   in "Z %(\$1_STAT)c";
}