Open Protocol Ethernet
11 min
review the following information for setting up and configuring the open protocol ethernet driver litmus edge compatible series compatibility parameter compatible items driver type ethernet validated devices/series atlas copco power focus 6000, firmware v3 6 https //www atlascopco com/en us/itba/products/assembly solutions/electric assembly systems/powerfocus 6000 cleco mpro300 series https //www clecotools com/products/product catalog/mpro300 series global controllers to set up and configure this device in litmus edge, do the following step 1 set up and configure the plc device step 2 set up the plc device in litmus edge devicehub step 3 configure the list of registers atlas copco open protocol the atlas copco open protocol is used to connect to network enabled nutrunners and torque drivers directly unhandled content type the following abbreviations are used in tag name prefixes gas global app sync job job info ltr last tightening result ms multi spindle result otr old tightening result pset parameter set spd spindle vin vehicle id number tags in this driver use one of the following interaction patterns depending on the associated mid request response to trigger a response from the controller, send a message to the tag's pollonce topic or write to the associated virtual tag mid description tag 0010/0011 parameter set id upload send a message to the pollonce topic for psetupload id 0064/0065 old tightening results write to otr request 1018/1019 global app sync (cleco controllers only) write to gas request subscribe the following mids publish data automatically when the controller sends a reply mid description 0014/0015 parameter set selected 0034/0035 job info 0051/0052 vehicle id number 0060/0061 last tightening result data 0100/0101 multi spindle result data write only the following mids accept values written to the tag's write topic mid description 0018 select parameter set 0019 set parameter set batch size requires two parameters parameter set id (000–999) and batch size (01–99) write format {"value" [parameter set id, batch size]} 0042/0043 disable/enable tool 0050 vehicle id number download step 1 set up and configure the plc device enable open protocol on the controller refer to your controller's documentation for instructions note the controller's ip address and tcp port (default 4545 ) ensure the controller is reachable from your litmus edge instance over the network note multi client connection support varies by controller model for example, pf6000 controllers support multi client connections, whereas older models such as the pf4000 support only single client connections verify your controller's documentation to confirm step 2 set up the plc device in litmus edge devicehub configure the following parameters when you connect a device docid\ pal6abpzbrimdu9lvgj30 with this driver update default values to the specific setup of your device parameter value type torque tool driver open protocol ethernet network address the ip address of the controller network port 4545 driver mode subscription (default) in publishing mode, tags publish according to the polling interval in subscription mode, tags publish only when the controller sends a reply; the polling interval is ignored keep alive time keep alive time (ms) optional, default 10000, range 1000–150000 message timeout message response timeout (ms) optional, default 2000 link ack timeout link acknowledgement timeout (ms) optional, default 1000 max outstation messages optional, default 1 message retries number of times to retry a message optional, default 3, range 0–3 step 3 configure the list of registers when you add a tag docid\ tuy hh0gi8djvot70wroh to the connected device, refer to the following register table and tag parameters see the following additional resources if necessary organize device and tag data by using metadata docid\ mu 6j6zhi0cvchdad0w8n tag formula variables docid\ io7xgyrdvv vmpnfxoaci register table unhandled content type name value types access types description gas global id string, int64, float64 r/o global application global id gas global version string, int64, float64 r/o global application global version gas local version string, int64, float64 r/o global application local version gas request string, int64, float64 r/w write to mid 1018 global app sync gas status string, int64, float64 r/o global application status gas tps status string, int64, float64 r/o global application tps status id download string, int64, float64 r/w identifier data job batch counter string, int64, float64 r/o job batch counter job batch mode string, int64, float64 r/o job batch mode job batch size string, int64, float64 r/o job batch size job current step string, int64, float64 r/o job current step job id string, int64, float64 r/o job id job sequence number string, int64, float64 r/o job sequence number job status string, int64, float64 r/o job batch status job step type string, int64, float64 r/o job step type job tightening status string, int64, float64 r/o job tightening status job timestamp string, int64, float64 r/o job time stamp job total number of steps string, int64, float64 r/o job total number of steps job vin identifier 2 string, int64, float64 r/o identifier result part 2 job vin identifier 3 string, int64, float64 r/o identifier result part 3 job vin identifier 4 string, int64, float64 r/o identifier result part 4 job vin number string, int64, float64 r/o vin number ltr angle denominator scale factor string, int64, float64 r/o angle denominator scale factor ltr angle max string, int64, float64 r/o angle max ltr angle min string, int64, float64 r/o angle min ltr angle numerator scale factor string, int64, float64 r/o angle numerator scale factor ltr angle status string, int64, float64 r/o angle status ltr angle target string, int64, float64 r/o angle final target ltr angle value string, int64, float64 r/o angle ltr batch counter string, int64, float64 r/o batch counter ltr batch size string, int64, float64 r/o batch size ltr batch status string, int64, float64 r/o batch status ltr cell id string, int64, float64 r/o cell id ltr chan id string, int64, float64 r/o channel id ltr changetime string, int64, float64 r/o date/time of last change in parameter set settings ltr compensated angle string, int64, float64 r/o compensated angle ltr current monitoring amp string, int64, float64 r/o current monitoring amp ltr current monitoring amp max string, int64, float64 r/o current monitoring amp max ltr current monitoring amp min string, int64, float64 r/o current monitoring amp min ltr current monitoring max string, int64, float64 r/o current monitoring max ltr current monitoring min string, int64, float64 r/o current monitoring min ltr current monitoring status string, int64, float64 r/o current monitoring status ltr current monitoring value string, int64, float64 r/o current monitoring angle ltr customer tightening error string, int64, float64 r/o customer tightening error code ltr final angle decimal string, int64, float64 r/o final angle decimal ltr id string, int64, float64 r/o tightening id ltr identifier result 2 string, int64, float64 r/o identifier result part 2 ltr identifier result 3 string, int64, float64 r/o identifier result part 3 ltr identifier result 4 string, int64, float64 r/o identifier result part 4 ltr job string, int64, float64 r/o job id ltr job sequence string, int64, float64 r/o job sequence number ltr num stage results string, int64, float64 r/o number of stage results ltr num stages string, int64, float64 r/o number of stages in multistage ltr overall angle max string, int64, float64 r/o overall angle max ltr overall angle min string, int64, float64 r/o overall angle min ltr overall angle status string, int64, float64 r/o overall angle status ltr overall angle value string, int64, float64 r/o overall angle ltr parameter set name string, int64, float64 r/o parameter set name ltr peak torque string, int64, float64 r/o peak torque ltr post view torque activated string, int64, float64 r/o post view torque activated ltr post view torque high string, int64, float64 r/o post view torque high ltr post view torque low string, int64, float64 r/o post view torque low ltr prevail monitoring max string, int64, float64 r/o prevail torque monitoring max ltr prevail monitoring min string, int64, float64 r/o prevail torque monitoring min ltr prevail torque string, int64, float64 r/o prevail torque ltr prevail torque compensate string, int64, float64 r/o prevail torque compensate value ltr prevail torque compensate status string, int64, float64 r/o prevail torque compensate status ltr prevail torque monitoring status string, int64, float64 r/o prevail torque monitoring status ltr pset string, int64, float64 r/o parameter set id ltr residual breakaway torque string, int64, float64 r/o residual breakaway torque ltr result type string, int64, float64 r/o result type ltr rundown angle complete string, int64, float64 r/o rundown angle complete ltr rundown angle max string, int64, float64 r/o rundown angle max ltr rundown angle min string, int64, float64 r/o rundown angle min ltr rundown angle status string, int64, float64 r/o rundown angle status ltr rundown angle value string, int64, float64 r/o rundown angle ltr self tap max string, int64, float64 r/o self tap max ltr self tap min string, int64, float64 r/o self tap min ltr self tap status string, int64, float64 r/o self tap status ltr self tap torque string, int64, float64 r/o self tap torque ltr stage result string, int64, float64 r/o stage result ltr start final angle string, int64, float64 r/o start final angle ltr start rundown angle string, int64, float64 r/o start rundown angle ltr strategy string, int64, float64 r/o strategies currently run by the controller ltr strategy options string, int64, float64 r/o strategy options (five bytes long bit field) ltr sync id string, int64, float64 r/o sync tightening id ltr tc name string, int64, float64 r/o torque controller name ltr tight status string, int64, float64 r/o tightening status ltr tightening error status string, int64, float64 r/o tightening error status ltr tightening error status 2 string, int64, float64 r/o tightening error status 2 ltr tightening id string, int64, float64 r/o tightening id ltr timestamp string, int64, float64 r/o time stamp ltr tool serial string, int64, float64 r/o tool serial number ltr torque max string, int64, float64 r/o torque max limit ltr torque min string, int64, float64 r/o torque min limit ltr torque status string, int64, float64 r/o torque status ltr torque target string, int64, float64 r/o torque final target ltr torque unit string, int64, float64 r/o torque values unit ltr torque value string, int64, float64 r/o torque ltr vin string, int64, float64 r/o vin number ms amax string r/o angle maximum limit ms amin string r/o angle minimum limit ms atarg string r/o angle final target ms bcount string r/o batch counter ms bsize string r/o batch size ms bstatus string r/o batch status ms changetime string r/o last change in setting ms jobnum string r/o job number (link group) ms number string r/o number of running spindles ms pset string r/o parameter set (app) ms syncid string r/o sync tightening id ms syncstat string r/o overall tightening status ms time string r/o time stamp ms tmax string r/o torque maximum limit ms tmin string r/o torque minimum limit ms ttarg string r/o torque final target ms vin string r/o vehicle id number otr angdensf string, int64, float64 r/o scale factor (numerator/denominator) otr angle string, int64, float64 r/o turning angle value in degrees otr angnumsf string, int64, float64 r/o scale factor (numerator/denominator) otr angstat string, int64, float64 r/o angle status otr batstat string, int64, float64 r/o batch status otr bcount string, int64, float64 r/o batch counter otr bsize string, int64, float64 r/o batch size otr cmamp string, int64, float64 r/o current monitoring value otr cmamp max string, int64, float64 r/o current monitoring max value otr cmamp min string, int64, float64 r/o current monitoring min value otr cmstat string, int64, float64 r/o current monitoring status otr cmvalue string, int64, float64 r/o current monitoring value (percent) otr custom err string, int64, float64 r/o customer tightening error code otr id2 string, int64, float64 r/o identifier result part 2 otr id3 string, int64, float64 r/o identifier result part 3 otr id4 string, int64, float64 r/o identifier result part 4 otr jobnum string, int64, float64 r/o job number otr jobseq string, int64, float64 r/o job sequence number otr oang string, int64, float64 r/o overall angle otr oangmax string, int64, float64 r/o overall angle max otr oangmin string, int64, float64 r/o overall angle min otr oangstat string, int64, float64 r/o overall angle status otr pktorque string, int64, float64 r/o peak torque otr pset string, int64, float64 r/o pset number otr ptcstat string, int64, float64 r/o prevail torque compensate otr ptmstat string, int64, float64 r/o prevail torque monitoring otr ptorque string, int64, float64 r/o prevail torque value otr pvt string, int64, float64 r/o pvt compensation value otr pvt act string, int64, float64 r/o pvt on/off otr pvt high string, int64, float64 r/o pvt high value otr pvt low string, int64, float64 r/o pvt low value otr rangle string, int64, float64 r/o rundown angle value otr ranglec string, int64, float64 r/o rundown angle complete otr rastat string, int64, float64 r/o rundown angle status otr rbtorque string, int64, float64 r/o residual breakaway torque otr request string, int64, float64 r/w write to mid 0064 old tightening result otr rtype string, int64, float64 r/o result type otr serial string, int64, float64 r/o tool serial number otr sfinang string, int64, float64 r/o torque to reach the snug level otr srangle string, int64, float64 r/o start rundown angle otr station id string, int64, float64 r/o station id otr station nam string, int64, float64 r/o station name otr stid string, int64, float64 r/o synch tightening id otr storque string, int64, float64 r/o selftap torque otr strategy string, int64, float64 r/o strategy otr stropt string, int64, float64 r/o strategy options otr ststat string, int64, float64 r/o selftap status otr terr status2 string, int64, float64 r/o tightening error status otr terrstat string, int64, float64 r/o tightening error status otr tightening id string, int64, float64 r/o tightening id otr tightstat string, int64, float64 r/o tightening status otr time string, int64, float64 r/o timestamp otr torqstat string, int64, float64 r/o torque status otr torque string, int64, float64 r/o torque value otr tvunit string, int64, float64 r/o torque value units otr vin string, int64, float64 r/o vehicle id number pset anglemax string, int64, float64 r/o angle max pset anglemin string, int64, float64 r/o angle min pset angletarget string, int64, float64 r/o final angle target pset batchsize string, int64, float64 r/o batch size pset direction string, int64, float64 r/o rotation direction pset firsttarget string, int64, float64 r/o first target pset id string, int64, float64 r/o parameter set id pset lastchange string, int64, float64 r/o date of last change in parameter set setting pset name string, int64, float64 r/o parameter set name pset request string, int64, float64 r/w write to mid 0010 parameter set pset stfinalangle string, int64, float64 r/o start final angle pset torquemax string, int64, float64 r/o torque max pset torquemin string, int64, float64 r/o torque min pset torquetarget string, int64, float64 r/o torque final target psetupload id int64[], string r/o parameter set id upload select pset string, int64, float64 r/w parameter set id set pset batch size int64[], string r/w set parameter set batch size write format {"value" [parameter set id, batch size]} spd angle string r/o individual angle spd astatus string r/o individual angle status spd chan string r/o channel id spd num string r/o spindle number spd status string r/o overall spindle status spd torque string r/o individual torque spd tstatus string r/o individual torque status tool disable string, int64, float64 r/w upper 4 digits of value is tool number, lower 2 digits of value is disable type tool enable string, int64, float64 r/w value is tool number vin identifier 2 string, int64, float64 r/o vin number identifiers vin identifier 3 string, int64, float64 r/o vin number identifiers vin identifier 4 string, int64, float64 r/o vin number identifiers vin number string, int64, float64 r/o vin number tag parameters name select a register name from the drop down list the available options depend on the names in the register table value type select a data type from the drop down list the available options depend on the register name selected polling interval enter a value in seconds this determines how often the tag should poll the register for data tag name enter a name for the tag description (optional) enter a description for the tag address enter a tag address the value must be in the decimal format, within the allowed min/max range omit the leading zeros the device might use the decimal (d), hexadecimal (h), or octal (o) address format see the register table at the bottom of the dialog box for bit tags, append the bit address without the bit separator the lowercase letters in the address format indicate how many digits you should enter in the bit address revision enter the revision that your tool is running tag formula enter a formula for the tag to process the generated data two variables are permitted value (current tag value) and timestamp (current tag unix time in milliseconds) the following math functions are available sin cos sqrt tan power power( x ) performs the operation 10^x log log( x ) is the natural logarithm (the logarithm is in base e ) exp exp( x ) performs the operation e^x only publish on change of value select the checkbox to only publish nats messages when the value parameter changes to a new value change of value only applies to boolean, numeric (such as int or float), and simple string data types it does not apply to complex types, such as json or array poll once topics will not be affected by change of value settings these topics will still only see a single message meta data metadata summarizes basic information about data this feature allows you to define key value pair data for the device output payload later on metadata can then be used to find, use, and reuse particular instances of data note if you use special characters in meta data key names, the special characters are replaced with underscore characters in the payload this can cause two key names to be combined into one for example, configuring the key names a b and a&\&b will cause only one key name to be created (a b) troubleshooting if you are unable to write the pset (parameter set) on the atlas copco pf6000 torque controller, follow these steps to configure the controller correctly 1 access the source configuration navigate to the section where sources are managed identify the existing source that maps tightening programs or create a new one if required 2 create or select a source if a new source is needed, create it and define its parameters if modifying an existing source, ensure it is correctly configured before proceeding 3 map the tightening programs to identifiers within the source configuration, assign tightening programs to their respective identifiers (e g , program numbers or tag mappings) double check the associations to ensure accuracy 4 verify mapping and configuration confirm that all mapped programs correspond correctly to their intended identifiers validate settings to avoid mismatches that could affect operations 5 write and validate use the litmus edge write topic to write to the pset parameter and retrieve the complete list of program numbers ensure the system correctly reflects the new tags and that mapped programs execute as expected