ATV-IMC PLC System Library guide(EIO0000000596-2010.03)变频器使用说明书指南

EIO000000059617/03/2010EIO0000000596.00

[D-SE-0004281.22]

ATV.IMCDriveControllerSystemFunctionsandVariables

ATV-IMCPLCSystemLibraryGuide

17/03/2010

[D-SE-0004281.2.2]

Theinformationprovidedinthisdocumentationcontainsgeneraldescriptionsand/ortechnicalcharacteristicsoftheperformanceoftheproductscontainedherein.Thisdocumentationisnotintendedasasubstituteforandisnottobeusedfordeterminingsuitabilityorreliabilityoftheseproductsforspecificuserapplications.Itisthedutyofanysuchuserorintegratortoperformtheappropriateandcompleteriskanalysis,evaluationandtestingoftheproductswithrespecttotherelevantspecificapplicationorusethereof.NeitherSchneiderElectricnoranyofitsaffiliatesorsubsidiariesshallberesponsibleorliableformisuseoftheinformationcontainedherein.Ifyouhaveanysuggestionsforimprovementsoramendmentsorhavefounderrorsinthispublication,pleasenotifyus.

Nopartofthisdocumentmaybereproducedinanyformorbyanymeans,electronicormechanical,includingphotocopying,withoutexpresswrittenpermissionofSchneiderElectric.

Allpertinentstate,regional,andlocalsafetyregulationsmustbeobservedwheninstallingandusingthisproduct.Forreasonsofsafetyandtohelpensurecompliancewithdocumentedsystemdata,onlythemanufacturershouldperformrepairstocomponents.

Whendevicesareusedforapplicationswithtechnicalsafetyrequirements,therelevantinstructionsmustbefollowed.

FailuretouseSchneiderElectricsoftwareorapprovedsoftwarewithourhardwareproductsmayresultininjury,harm,orimproperoperatingresults.

Failuretoobservethisinformationcanresultininjuryorequipmentdamage.©2010SchneiderElectric.Allrightsreserved.

2 EIO000000059617/03/2010

[D-SE-0004281.2.2]

TableofContents

Chapter11.1

1.2

1.3

Chapter22.1

2.2

Chapter33.1

SafetyInformation.............................. 5AbouttheBook................................. 7ATVIMCSystemVariables....................... 9SystemVariables:DefinitionandUse............................10UnderstandingSystemVariables...............................11UsingSystemVariables......................................13PLC_RandPLC_WStructures.................................15PLC_R:ControllerReadOnlySystemVariables...................16PLC_W:ControllerRead/WriteSystemVariables.................19ETH_RandETH_WStructures.................................20ETH_R:EthernetPortReadOnlySystemVariables................21ETH_W:EthernetPortRead/WriteSystemVariables...............23ATVIMCSystemFunctions.......................25ATVIMCReadFunctions.....................................26GetEventsNumber:ReturnstheNumberofExternalEventsDetected...27GetLastStopTime:ReturnstheDateandTimeoftheLastDetectedStop28IsFirstMastColdCycle:IndicatesifCycleistheFirstMastColdStartCycle29IsFirstMastCycle:IndicatesifCycleistheFirstMastCycle...........30IsFirstMastWarmCycle:IndicatesifCycleistheFirstMastWarmStart

Cycle.................................................... 32ATVIMCWriteFunctions..................................... 33ResetEventsNumber:ResetsEventsNumber..................... 34ResetInternalErrorDiag:ResetsFlagsRaiseduponaHardware

WatchdogoranDetectedInternalError.......................... 35SetLEDBehaviour:DeterminestheBehaviorofaLED............... 36ATVIMCPLCSystemLibraryDataTypes............37PLC_R/WSystemVariableDataTypes.......................... 38PLC_R_APPLICATION_ERROR:DetectedApplicationErrorStatus

Codes.................................................... 39PLC_R_BATTERY_STATUS:BatteryStatusCodes................ 40PLC_R_BOOT_PROJECT_STATUS:BootProjectStatusCodes...... 41

EIO000000059617/03/2010 3

[D-SE-0004281.2.2]

3.2

3.3

AppendicesAppendixA

GlossaryIndex

PLC_R_IO_STATUS:I/OStatusCodes......................... 42PLC_R_STATUS:ControllerStatusCodes....................... 43PLC_R_STOP_CAUSE:RUNtoOtherStateTransitionCauseCodes. 44PLC_W_COMMAND:ControlCommandCodes................... 45ETH_R/WSystemVariablesDataTypes........................ 46ETH_R_IP_MODE:IPAddressSourceCodes.................... 47ETH_R_FRAME_PROTOCOL:FrameTransmissionProtocolCodes.. 48ETH_R_PORT_DUPLEX_STATUS:TransmissionModeCodes...... 49ETH_R_PORT_LINK_STATUS:CommunicationLinkDirectionCodes. 50ETH_R_PORT_SPEED:CommunicationSpeedoftheEthernetPort

Codes................................................... 51SystemFunctionsDataTypes................................. 52LED_BHV:SetLedBehaviorFunctionLedBhvParameterCodes.... 53LED_BHV_ERROR:DetectedSetLEDBehaviourFunctionErrorCodes 54LED_COLOR:SetLEDBehaviourFunctionLedColorParameterCodes 55LED_ID:SetLEDBehaviourFunctionLedIdParameterCodes...... 56PLC_ERROR_TYPE:ResetInternalErrorDiagFunctionerror

ParameterCodes........................................... 57...........................................59FunctionandFunctionBlockRepresentation........61DifferencesBetweenaFunctionandaFunctionBlock.............. 62HowtoUseaFunctionoraFunctionBlockinILLanguage.......... 63HowtoUseaFunctionoraFunctionBlockinSTLanguage......... 66...........................................69...........................................77

4 EIO000000059617/03/2010

[D-NA-0003897.14.3]

SafetyInformation §

ImportantInformation

NOTICE

Readtheseinstructionscarefully,andlookattheequipmenttobecomefamiliarwiththedevicebeforetryingtoinstall,operate,ormaintainit.Thefollowingspecialmessagesmayappearthroughoutthisdocumentationorontheequipmenttowarnofpotentialhazardsortocallattentiontoinformationthatclarifiesorsimplifiesaprocedure.

EIO000000059617/03/2010 5

[D-NA-0003897.14.3]

PLEASENOTE

Electricalequipmentshouldbeinstalled,operated,serviced,andmaintainedonlybyqualifiedpersonnel.NoresponsibilityisassumedbySchneiderElectricforanyconsequencesarisingoutoftheuseofthismaterial.

Aqualifiedpersonisonewhohasskillsandknowledgerelatedtotheconstructionandoperationofelectricalequipmentandtheinstallation,andhasreceivedsafetytrainingtorecognizeandavoidthehazardsinvolved.

6 EIO000000059617/03/2010

[D-NA-0003897.14.3]

AbouttheBook

AtaGlance

DocumentScope

ThisdocumentacquaintsyouwiththesystemfunctionsandvariablesofferedwithintheATVIMCDriveController.TheATVIMCPLCSystemlibrarycontainsfunctionsandvariablestogetinformationfromandtosendcommandstotheATVIMCDriveControllersystem.

ThisdocumentationdescribesthedatatypesfunctionsandvariablesoftheATVIMCPLCSystemlibrary.

Thefollowingbasicknowledgeisrequired:

zbasicinformationonfunctionality,structureandconfigurationoftheATVIMCzprogrammingintheFBD,LD,ST,IL,SFCorCFClanguage

zSystemVariables(GlobalVariables)

ValidityNote

ThisdocumenthasbeenupdatedwiththereleaseofSoMachineV2.0.

EIO000000059617/03/2010 7

[D-NA-0003897.14.3]

ProductRelatedInformation

WARNINGLOSSOFCONTROL

zThedesignerofanycontrolschememustconsiderthepotentialfailuremodesofcontrolpathsand,forcertaincriticalcontrolfunctions,provideameanstoachieveasafestateduringandafterapathfailure.Examplesofcriticalcontrolfunctionsareemergencystopandovertravelstop,poweroutageandrestart.

zSeparateorredundantcontrolpathsmustbeprovidedforcriticalcontrolfunctions.

zSystemcontrolpathsmayincludecommunicationlinks.Considerationmustbegiventotheimplicationsofunanticipatedtransmissiondelaysorfailuresofthelink.

zObserveallaccidentpreventionregulationsandlocalsafetyguidelines.1

zEachimplementationofthisequipmentmustbeindividuallyandthoroughlytestedforproperoperationbeforebeingplacedintoservice.

Failuretofollowtheseinstructionscanresultindeath,seriousinjury,orequipmentdamage.

1Foradditionalinformation,refertoNEMAICS1.1(latestedition),"SafetyGuidelinesfortheApplication,Installation,andMaintenanceofSolidStateControl"andtoNEMAICS7.1(latestedition),"SafetyStandardsforConstructionandGuideforSelection,InstallationandOperationofAdjustable-SpeedDriveSystems"ortheirequivalentgoverningyourparticularlocation.

UserComments

Wewelcomeyourcommentsaboutthisdocument.Youcanreachusbye-mailattechcomm@.

8 EIO000000059617/03/2010

ATVIMCSystemVariablesEIO000000059617/03/2010

[D-SE-0003286.1.11]

ATVIMCSystemVariables 1

Overview

Thischapter:

zgivesanintroductiontotheSystemVariables(seepage10)

zdescribestheSystemVariables(seepage16)includedwiththeATVIMCPLCSystemlibrary

What'sinthisChapter?

Thischaptercontainsthefollowingsections:

Section

1.1

1.2

1.3

Topic Page

SystemVariables:DefinitionandUse 10

PLC_RandPLC_WStructures 15

ETH_RandETH_WStructures 20

EIO000000059617/03/2010 9

ATVIMCSystemVariables [D-SE-0002672.1.6]

1.1 SystemVariables:DefinitionandUse

Overview

ThissectiondefinesSystemVariablesandhowtoimplementthemintheATVIMCDriveController.

What'sinthisSection?

Thissectioncontainsthefollowingtopics:

Topic Page

UnderstandingSystemVariables 11

UsingSystemVariables 13

10 EIO000000059617/03/2010

[D-SE-0002665.2.3] ATVIMCSystemVariables

UnderstandingSystemVariables

Introduction

ThissectiondescribeshowSystemVariablesareimplementedforthecontroller.Thesevariableshavethefollowingattributes:

zSystemVariablesallowyoutoaccessgeneralsysteminformation,performsystemdiagnostics,andcommandsimpleactions.

zSystemVariablesarestructuredvariablesconformingtoIEC61131definitionsandnamingconventions.TheymaybeaccessedusingtheIECsymbolicnamePLC_GVL.

zSomeofthePLC_GVLvariablesareread-only(forexamplePLC_R),andsomeareread-write(forexamplePLC_W).

zSystemVariablesareautomaticallydeclaredasglobalvariables.Theyhavesystem-widescopeandmustbehandledwithcarebecausetheycanbeaccessedbyanyProgramOrganizationUnit(POU)inanytask.

SystemVariablesNamingConvention

TheSystemVariablesareidentifiedby:

zastructurenamewhichrepresentsthecategoryofSystemVariable(e.g.PLC_Rrepresentsastructurenameofreadonlyvariablesusedforcontrollerdiagnosis).

zasetofcomponentnameswhichidentifiesthepurposeofthevariable(e.g.i_wVendorIDrepresentsthecontrollerVendorID).

Youcanaccessthevariablesbytypingthestructurenameofthevariablesfollowedbythenameofthecomponent.

HereisanexampleofSystemVariableimplementation:

VAR

myCtr_Serial:DWORD;myCtr_ID:DWORD;myCtr_FramesRx:UDINT;

END_VAR

myCtr_Serial:=PLC_R.i_dwSerialNumber;myCtr_ID:=PLC_R.i_wVendorID;

myCtr_FramesRx:=SERIAL_R[0].i_udiFramesReceivedOK;

NOTE:ThefullyqualifiednameofthesystemvariableintheexampleaboveisPLC_GVL.PLC_R.i_wVendorID.ThePLC_GVLisimplicitwhendeclaringavariableusingtheInputAssistant,butitmayalsobeenteredinfull.Goodprogrammingpracticeoftendictatestheuseofthefullyqualifiedvariablenameindeclarations.

EIO000000059617/03/2010 11

ATVIMCSystemVariables [D-SE-0002665.2.3]

SystemVariablesLocation

2kindsofsystemvariablesaredefinedforusewhenprogrammingtheController:zlocatedvariables

zunlocatedvariables

Thelocatedvariables:

zhaveafixedlocationinastatic%MWarea:

z%MW60000to%MW60199forReadonlySystemVariables

z%MW62000to%MW62199forRead/WriteSystemVariables

zareusedinSoMachineprogramsaccordingtothestructure_ponent_nameconventionexplainedpreviously(%MWaddressesbetween0and59999canbeaccesseddirectly;adressesgreaterthanthisareconsideredoutofrangebySoMachineandcanonlybeaccessedtroughthestructure_ponent_nameconvention.

Theunlocatedvariables:

zarenotphysicallylocatedinthe%MWarea

zarenotaccessiblethroughanyfieldbusornetworkrequestsunlessyoulocatethemintherelocationtable,andonlythencantheybeaccessedinRUNNINGandSTOPPEDstates.Therelocationtableusesthefollowingdynamic%MWareas:

z%MW60200to%MW61999forReadonlyVariables

z%MW62200to%MW63999forRead/WriteVariables

zareusedinSoMachineprogramsaccordingtothestructure_ponent_nameconventionexplainedpreviously(%MWaddressesbetween0and59999canbeaccesseddirectly;adressesgreaterthanthisareconsideredoutofrangebySoMachineandcanonlybeaccessedtroughthestructure_ponent_nameconvention.

12 EIO000000059617/03/2010

[D-SE-0002666.2.2] ATVIMCSystemVariables

UsingSystemVariables

Introduction

ThistopicdescribesthestepsrequiredtoprogramanduseSystemVariablesinSoMachine.

SystemVariablescanbeusedinalltheProgramOrganizationUnits(POUs)oftheapplication.

SystemVariablesdonotneedtobedeclaredintheGVL.TheyareautomaticallydeclaredfromthecontrollerSystemLibrary.

UsingSystemVariablesinaPOU

InthePOU,startbyenteringthesystemvariablestructurename(PLC_R,PLC_W...)followedbyadot.TheSystemVariablesappearintheInputAssistant.Youcanselectthedesiredvariableorenterthefullnamemanually.

NOTE:SoMachinehasanautocompletionfeature.Intheexampleabove,onceyouhavetypedthestructurenamePLC_R.,SoMachineoffersapop-upmenuofpossiblecomponentnames/variables.

Example

ThefollowingexampleshowstheuseofsomeSystemVariables:

EIO000000059617/03/2010 13

ATVIMCSystemVariables [D-SE-0002666.2.2]

VAR

myCtr_Serial:DWORD;myCtr_ID:WORD;myCtr_FramesRx:UDINT;

END_VAR

myCtr_Serial:=PLC_R.i_dwSerialNumber;myCtr_ID:=PLC_R.i_wVendorID;

myCtr_FramesRx:=SERIAL_R[0].i_udiFramesReceivedOK;

14 EIO000000059617/03/2010

[D-SE-0005709.1.2] ATVIMCSystemVariables

1.2 PLC_RandPLC_WStructures

Overview

ThissectionlistsanddescribesthedifferentSystemVariablesincludedinthePLC_RandPLC_Wstructures.

What'sinthisSection?

Thissectioncontainsthefollowingtopics:

Topic Page

PLC_R:ControllerReadOnlySystemVariables 16

PLC_W:ControllerRead/WriteSystemVariables 19

EIO000000059617/03/2010 15

ATVIMCSystemVariables [D-SE-0004809.4.4]

PLC_R:ControllerReadOnlySystemVariables

VariableStructure

ThefollowingtabledescribestheparametersofthePLC_RSystemVariable(PLC_R_STRUCTtype):

%MW VarName

60000 i_wVendorID

60001 i_wProductID

60002 i_dwSerialNumber60004 i_byFirmVersion[0..3]

60006 i_byBootVersion[0..3]

60008 i_dwHardVersion60010 i_dwHardwareID60012 i_wStatus

60013 i_wBootProjectStatus

60014 i_wLastStopCause

60015 i_wLastApplicationError

Type

WORD

WORD

DWORD

ARRAY[0..3]OFBYTE

ARRAY[0..3]OFBYTE

DWORD

DWORD

PLC_R_STATUS(seepage43)

PLC_R_BOOT_PROJECT_STATUS(seepage41)

PLC_R_STOP_CAUSE

(seepage44)

PLC_R_APPLICATION_ERROR(seepage39)

Comment

ControllerVendorID.

101Ahex=SchneiderElectric

ControllerReferenceID.

NOTE:VendorIDandReferenceIDarethecomponentsoftheTargetIDoftheControllerdisplayedintheCommunicationSettingsview(TargetID=101AXXXXhex).

ControllerSerialNumber

ControllerFirmwareVersion[aa.bb.cc.dd]:zi_byFirmVersion[0]=aa

z...

zi_byFirmVersion[3]=dd

ControllerBootVersion[aa.bb.cc.dd]:zi_byBootVersion[0]=aa

z...

zi_byBootVersion[3]=dd

ControllerHardwareVersion.

ControllerCoprocessorVersion.

Stateofthecontroller.

ReturnsinformationaboutthebootapplicationstoredinFLASHmemory.

CauseofthelasttransitionfromRUNtoanotherstate.

CauseofthelastControllerException.

16 EIO000000059617/03/2010

[D-SE-0004809.4.4] ATVIMCSystemVariables

%MW VarName

60016 i_lwSystemFault_1

60020 i_lwSystemFault_260024 i_wIOStatus1

60025 i_wIOStatus2

60026 i_wBatteryStatus

60028 i_dwAppliSignature1

Type

LWORD

LWORD

PLC_R_IO_STATUS

(seepage42)

PLC_R_IO_STATUS

(seepage42)

PLC_R_BATTERY_STATUS

(seepage40)

DWORD

Comment

BitfieldFFFFFFFFFFFFFFFFhexindicatesnodetectederror.

Abitatlowlevelmeansthatanerrorhasbeendtected:

zbit0=DetectederroronATV-IMCinternallink

zbit1=Ethernetlinknotconnectedzbit2=USBlinknotconnected

zbit3=CANopenlinknotrunningzbit4=Modbus/TCPtime-out

zbit5=DuplicateIPaddressdetectedzbit6=OverloaddetectedonEthernet

network

zbit7=DetectederroronEthernethardwarezbit8=Detectederroronnon-volatile

memory

zbit9=CANcommunicationmessagingdetectederror

zbit10=DetectederroronATV-IMCobjectdictionary

zbit11=Hardwarewatchdogdetectederrorzbit12=Internaldetectederror

zbit13=Logicaloutputdetectederror(overtemperature)

zbit14=Logicaloutput24Vpowersupplyinoperative

zbit15-63:Notused

NOTE:Bit11andbit12canberesetusingthefunctionResetInternalErrorDiag(seepage35).

Notused.

EmbeddedI/Ostatus.

notused(alwaysFFFFhex).

RealTimeClockbatterystatus.

1stDWORDof4DWORDsignature(16bytestotal).

TheApplicationSignatureisgeneratedbythesoftwareduringbuild.

EIO000000059617/03/2010 17

ATVIMCSystemVariables [D-SE-0004809.4.4]

%MW VarName

60030 i_dwAppliSignature2

60032 i_dwAppliSignature3

60034 i_dwAppliSignature4

n/a i_sVendorName

n/a i_sProductRef

Type

DWORD

DWORD

DWORD

STRING(31)

STRING(31)

Comment

2ndDWORDof4DWORDsignature(16bytestotal).

TheApplicationSignatureisgeneratedbythesoftwareduringbuild.

3rdDWORDof4DWORDsignature(16bytestotal).

TheApplicationSignatureisgeneratedbythesoftwareduringbuild.

4thDWORDof4DWORDsignature(16bytestotal).

TheApplicationSignatureisgeneratedbythesoftwareduringbuild.

Nameofthevendor:“SchneiderElectric”.

ReferenceoftheController.

NOTE:n/ameansthatthereisnopredefined%MWmappingforthisSystemVariable.

18 EIO000000059617/03/2010

[D-SE-0002619.3.2] ATVIMCSystemVariables

PLC_W:ControllerRead/WriteSystemVariables

VariableStructure

ThefollowingtabledescribestheparametersofthePLC_WSystemVariable(PLC_W_STRUCTtype):

%MW VarName

62000 q_uiOpenPLCControl

62001 q_wPLCControl

Type

UINT

PLC_W_COMMAND(seepage45)

Comment

WhenValuepassfrom0to6699,ThecommandpreviouslywritteninthefollowingPLC_W.q_wPLCControlisexecuted.

ControllerRUN/STOPcommandexecutedwhenthesystemvariablePLC_R.q_uiOpenPLCControlvaluepassfrom0to6699.

EIO000000059617/03/2010 19

ATVIMCSystemVariables [D-SE-0005711.1.2]

1.3 ETH_RandETH_WStructures

Overview

ThissectionlistsanddescribesthedifferentSystemVariablesincludedintheETH_RandETH_Wstructures.

What'sinthisSection?

Thissectioncontainsthefollowingtopics:

Topic Page

ETH_R:EthernetPortReadOnlySystemVariables 21

ETH_W:EthernetPortRead/WriteSystemVariables 23

20 EIO000000059617/03/2010

[D-SE-0003394.3.4] ATVIMCSystemVariables

ETH_R:EthernetPortReadOnlySystemVariables

VariableStructure

ThefollowingtabledescribestheparametersoftheETH_RSystemVariable(ETH_R_STRUCTtype):

%MW VarName

60050 i_byIPAddress[0..3]

60052 i_bySubNetMask[0..3]

60054 i_byGateway[0..3]

60056 i_byMACAddress[0..5]

60059 i_sDeviceName

60067 i_wIPMode

60068 i_byFDRServerIPAddress[0..3]

60070 i_udiOpenTcpConnections

60072 i_wFrameSendingProtocole

Type

ARRAY[0..3]OFBYTE

ARRAY[0..3]OFBYTE

ARRAY[0..3]OFBYTE

ARRAY[0..5]OFBYTE

STRING(16)

ETH_R_IP_MODE

(seepage47)

ARRAY[0..3]OFBYTE

UDINT

ETH_R_FRAME_PROTOCOL(seepage48)

Comment

IPaddress[aaa.bbb.ccc.ddd]:zi_byIPAddress[0]=aaa

z...

zi_byIPAddress[3]=ddd

SubnetMask[aaa.bbb.ccc.ddd]:zi_bySub-netMask[0]=aaa

z...

zi_bySub-netMask[3]=ddd

Gatewayaddress[aaa.bbb.ccc.ddd]:zi_byGateway[0]=aaaz...

zi_byGateway[3]=ddd

MACaddress[aa.bb.cc.dd.ee.ff]:zi_byMACAddress[0]=aaz...

zi_byMACAddress[5]=ff

NameusedtogetIPaddressfromserver.

MethodusedtoobtainanIPadress

TheIPaddress[aaa.bbb.ccc.ddd]oftheDHCPorBootPserver:

zi_byFDRServerIPAddress[0]=aaaz...

zi_byFDRServerIPAddress[3]=ddd

EqualsifStoredIPorDefaultIPused.

NumberofopenTCPconnections.

Ethernetprotocolconfiguredforframessending(IEEE802.3orEthernetII).

EIO000000059617/03/2010 21

ATVIMCSystemVariables [D-SE-0003394.3.4]

%MW VarName

60073 i_udiFramesTransmittedOK

60075 i_udiFramedReceivedOK

60077 i_udiTransmitBufferErrors

60079 i_udiReceiveBufferErrors

60081 i_wPortALinkStatus

60082 i_wPortASpeed

60083 i_wPortADuplexStatus

Type

UDINT

UDINT

UDINT

UDINT

ETH_R_PORT_LINK_STATUS(seepage50)

ETH_R_PORT_SPEED

(seepage51)

ETH_R_PORT_DUPLEX_STATUS

(seepage49)

Comment

Numberofframessuccessfullytransmitted.ResetatPowerONorwithresetcommandETH_W.q_wResetCounter.

Numberofframessuccessfullyreceived.ResetatPowerONorwithresetcommandETH_W.q_wResetCounter.

Numbersofframestransmittedwithdetectederrors.ResetatPowerONorwithresetcommandETH_W.q_wResetCounter.

Numbersofframesreceivedwithdetectederrors.ResetatPowerONorwithresetcommandETH_W.q_wResetCounter.

LinkdirectionoftheEthernetPort(0=Downor1=Up).

EthernetPortnetworkspeed(10Mb/sor100Mb/s).

EthernetPortduplexstatus(0=Halfor1=Fullduplex).

22 EIO000000059617/03/2010

[D-SE-0003395.3.2] ATVIMCSystemVariables

ETH_W:EthernetPortRead/WriteSystemVariables

VariableStructure

ThefollowingtabledescribestheparametersoftheETH_WSystemVariable(ETH_W_STRUCTtype):

%MW VarName Type

62066 q_wResetCounterWORD

Comment

Transitionfrom0to1resetsallETH_Rcounters.

Toresetagain,itisnecessarytowritethisregisterto0beforeanothertransitionfrom0to1cantakeplace.

EIO000000059617/03/2010 23

ATVIMCSystemVariables

24

[D-SE-0003395.3.2]

EIO000000059617/03/2010

ATVIMCSystemFunctionsEIO000000059617/03/2010

[D-SE-0002756.1.9]

ATVIMCSystemFunctions 2

Overview

ThischapterdescribesthefunctionsincludedintheATVIMCPLCSystemlibrary.

What'sinthisChapter?

Thischaptercontainsthefollowingsections:

Section

2.1

2.2

Topic Page

ATVIMCReadFunctions 26

ATVIMCWriteFunctions 33

EIO000000059617/03/2010 25

ATVIMCSystemFunctions [D-SE-0003305.1.13]

2.1 ATVIMCReadFunctions

Overview

ThissectiondescribesthereadfunctionsincludedintheATVIMCPLCSystemlibrary.

What'sinthisSection?

Thissectioncontainsthefollowingtopics:

Topic Page

GetEventsNumber:ReturnstheNumberofExternalEventsDetected 27

GetLastStopTime:ReturnstheDateandTimeoftheLastDetectedStop 28

IsFirstMastColdCycle:IndicatesifCycleistheFirstMastColdStartCycle 29

IsFirstMastCycle:IndicatesifCycleistheFirstMastCycle 30

IsFirstMastWarmCycle:IndicatesifCycleistheFirstMastWarmStartCycle 32

26 EIO000000059617/03/2010

[D-RU-0004833.5.2] ATVIMCSystemFunctions

GetEventsNumber:ReturnstheNumberofExternalEventsDetected

FunctionDescription

Thisfunctionreturnsthenumberofeventsthathaveoccurredsincethelastcoldstart,includingthosedetectedoninputsandHSCthresholdcompareevents.

GraphicalRepresentation

ILandSTRepresentation

ToseethegeneralrepresentationinILorSTlanguage,refertotheHowtoUseILandSTRepresentation(seepage61)chapter.

I/OVariableDescription

Thefollowingtabledescribestheoutputvariable:

Output Type

GetEventsNumber UINT

Comment

Thevaluerepresentingthenumberofeventsthathaveoccurredsincethelastcoldstart.Resetto0withacallofthefunctionResetEventsNumber(seepage34).

EIO000000059617/03/2010 27

ATVIMCSystemFunctions [D-RU-0004840.4.13]

GetLastStopTime:ReturnstheDateandTimeoftheLastDetectedStop

FunctionDescription

ThisfunctionreturnsthedateandtimeofthelasttransitionfromRUNtoanotherstate.

GraphicalRepresentation

ILandSTRepresentation

ToseethegeneralrepresentationinILorSTlanguage,refertotheHowtoUseILandSTRepresentation(seepage61)chapter.

I/OVariableDescription

Thefollowingtabledescribestheoutputvariable:

Output Type

GetLastStopTimeDWORD

Comment

ThetimeofthelastdetectedSTOPinsecondsbeginningwithJanuary1,1970at00:00.

28 EIO000000059617/03/2010

[D-RU-0004846.4.14] ATVIMCSystemFunctions

IsFirstMastColdCycle:IndicatesifCycleistheFirstMastColdStartCycle

FunctionDescription

ThisfunctionreturnsTRUEduringthe1stMastcycleafteracoldstart(firstcycleafterdownloadorresetcold).

GraphicalRepresentation

ILandSTRepresentation

ToseethegeneralrepresentationinILorSTlanguage,refertotheHowtoUseILandSTRepresentation(seepage61)chapter.

I/OVariableDescription

Thefollowingtabledescribestheoutputvariable:

Output Type

IsFirstMastColdCycle BOOL

Comment

TRUEduringthefirstMASTtaskcycleafteracoldstart.

Example

RefertothefunctionIsFirstMastCycle(seepage30).

EIO000000059617/03/2010 29

ATVIMCSystemFunctions [D-RU-0004847.6.1]

IsFirstMastCycle:IndicatesifCycleistheFirstMastCycle

FunctionDescription

ThisfunctionreturnsTRUEduringthe1stMastcycleafterastart.

GraphicalRepresentation

ILandSTRepresentation

ToseethegeneralrepresentationinILorSTlanguage,refertotheHowtoUseILandSTRepresentation(seepage61)chapter.

I/OVariableDescription

Output

IsFirstMastCycle

Type Comment

BOOL TRUEduringthefirstMASTtaskcycleafterastart.

Example

Thisexampledescribestheth