PLCHandler Programming Guide - Esco Drives & Automation

More documents

Recommendations

Info

PLCHandler Programming Guide2.7.3 Reading the values of a cyclic listMethods: long ::CycEnterVarAccess(HCYCLIST hCycVarList)long ::CycReadVars(HCYCLIST hCycVarList, PlcVarValue ***pppValues,unsigned long *pulNumOfValues)void ::CycLeaveVarAccess(HCYCLIST hCycVarList)The methods CycEnterVarAccess() and CycLeaveVarAccess() must enclose each read operation in acyclic list to synchronize access to the variables of the list.The method CycReadVars() can be used to access the values of a cyclic list. Those get updatedaccording to the time pattern defined by UpdateRate.Return value : If no error occurs, the function CycEnterVarAccess() return 1. Otherwise, it returns …0: the cyclic list is invalid.Return value: If no error occurs, the function CycReadVars() returns RESULT_OK. Otherwise, it returnsRESULT_FAILED: common error in the underlaying interfaces. A specific error code can beretrieved by GetStatus() resp. GetLastError().RESULT_PLC_NOT_CONNECTED: lost connection to the PLC.RESULT_INVALID_PARAMETER: invalid function parameters (for e.g. NULL).RESULT_PLC_NO_CYCLIC_LIST_DEFINED: invalid list or no list variables to read.2.8 Synchronous reading of variablesMethods:HVARLIST ::SyncReadVarsFromPlc(char **ppszSymbols,unsigned long ulNumOfSymbols, PlcVarValue ***pppValues,unsigned long *pulNumOfValues)long ::SyncReadVarsFromPlcReleaseValues(HVARLIST hSyncRead)The method SyncReadVarsFromPlc() can be used to read the values of a list of variables from thePLC.ppszSymbols: specifies the list of variablesulNumOfSymbols: number of variables in the listpppValues: returns the list of variables values after the callpulNumOfValues: Number of read valuesSyncReadVarsFromPlcReleaseValues() then can be used to deallocate the list of read variablesReturn value: If no error occurs, the function returns a handle for the list. Otherwise, it returns …NULL: function failed. A specific error code can be retrieved by GetStatus() resp.GetLastError().2.9 Synchronous writing of variablesMethod: long ::SyncWriteVarsToPlc(char **ppszSymbols, unsigned long ulNumOfSymbols,unsigned char **ppbyValues)This method can be used to transfer a list of variable values to the PLC.ppszSymbols: specifies the list of variablesulNumOfSymbols: number of variables in the listppbyValues: specifies the variables values which should be written to the PLC. Must match the list ofthe specified variables !Return value: If no error occurs, the function returns RESULT_OK. Otherwise, it returns … 3S - Smart Software Solutions GmbHPLCHandler Programmming Guide.doc Page 8 of 17
PLCHandler Programming GuideRESULT_FAILED: common error in the underlying interfaces. A specific error code can beretrieved by GetStatus() resp. GetLastError().RESULT_PLC_NOT_CONNECTED: lost connection to the PLC.RESULT_EXCEPTION: an exception occurred in the underlying interface.2.10 General data transferMethods:long ::UploadFile(char *pszPlc, char *pszHost = NULL)long ::DownloadFile(char *pszHost, char *pszPlc = NULL)The method UploadFile() can be used to transfer files from the PLC to the client. pszPlc specifies thename of the file on the PLC, pszHost specifies the name of the file on the client.The method DownloadFile() can be used to transfer files from the client to the PLC. pszHost specifiesthe name of the file on the client, pszPlc specifies the name of the file on the PLC.The methods RenameFile() and DeleteFile() can be used to rename resp. delete files on the PLC.Return value: If no error occurs, the function returns RESULT_OK. Otherwise, it returns …RESULT_FAILED: common error in the underlying interfaces. A specific error code can beretrieved by GetStatus() resp. GetLastError().RESULT_PLC_NOT_CONNECTED: lost connection to the PLC.2.11 Reading the directory structure on the PLCMethod: long ::ReadDirectory(CDirInfo **ppdi, char *pszBaseDir = NULL)This method can be used to read the directory structure on the PLC. You can specify a basic folder inpszBaseDir.In object ppdi the complete directory structure is stored (including files and sub-directories).Return value: If no error occurs, the function returns RESULT_OK. Otherwise, it returns …RESULT_FAILED: common error in the underlying interfaces. A specific error code can beretrieved by GetStatus() resp. GetLastError().RESULT_PLC_NOT_CONNECTED: lost connection to the PLC.2.12 Protected method for sending and receiving any services to/from thePLCMethod: long ::SyncSendService(unsigned char *pbySend, unsigned long ulSendSize,unsigned char **ppbyRecv, unsigned long *pulRecvSize)This method can be used to transfer any runtime system service to the PLC.Return value: If no error occurs, the function returns RESULT_OK. Otherwise, it returns …RESULT_FAILED: common error in the underlying interfaces. A specific error code can beretrieved by GetStatus() resp. GetLastError().RESULT_PLC_NOT_CONNECTED: lost connection to the PLC.RESULT_EXCEPTION: an exception occurred in the underlying interface.ATTENTION: The structure of the service must be known in detail! An erroneous service might causea crash of the PLC! Due to this reason the method is only accessible in derivative classes and has notbeen published straightly. 3S - Smart Software Solutions GmbHPLCHandler Programmming Guide.doc Page 9 of 17
Page 1 and 2: PLCHandler Programming GuidePLCHand
Page 3 and 4: PLCHandler Programming Guide1 Intro
Page 5 and 6: PLCHandler Programming Guideunsigne
Page 7: PLCHandler Programming Guide2.6 Get
Page 11 and 12: PLCHandler Programming GuideAppendi
Page 17: PLCHandler Programming GuideChange

PLCHandler Programming Guide - Esco Drives & Automation

Create successful ePaper yourself

Delete template?

Save as template?