ModbusServer.IsComPortValid (PROP) ¶ PROPERTY IsComPortValid : BOOL
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 23.11.2021, 07:08:39 companyName string 3S-Smart Software Solutions GmbH libraryFile IoDrvModbusSerialSlave.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile IoDrvModbusSerialSlave.clean.json version version 2.0.0.0 ProjectInformation Released bool False LastModificationDateTime date 23.11.2021, 07:08:39 LibraryCategories library-category-list Intern|IoDrivers Author string 3S - Smart Software Solutions GmbH Company 3S - Smart Software Solutions GmbH CompiledLibraryCompatibilityVersion CODESYS V3.5 SP16 DefaultNamespace IoDrvModbusSerialSlaveLibrary Description See: Description DocFormat reStructuredText Placeholder IoDrvModbusSerialSlave Project IoDrvModbusSerialSlave Title IoDrvModbusSerialSlave Version version 4.1.0.0
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. 3SLicense ¶ Library Identification ¶ Placeholder: 3SLicense Default Resolution: 3SLicense, * (3S - Smart Software Solutions GmbH) Namespace: _3S_LICENSE Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: 3SLicense Base Interfaces ¶ Library Identification ¶ Name: Base Interfaces Version: newest Company: System Namespace: IBaseLibrary Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Base Interfaces, * (System) CAA Device Diagnosis ¶ Library Identification ¶ Placeholder: CAA Device Diagnosis Default Resolution: CAA Device Diagnosis, * (CAA Technical Workgroup) Namespace: DED Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CAA Device Diagnosis CmpErrors2 Interfaces ¶ Library Identification ¶ Name: CmpErrors2 Interfaces Version: newest Company: System Namespace: CmpErrors Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpErrors2 Interfaces, * (System) CmpLog ¶ Library Identification ¶ Placeholder: CmpLog Default Resolution: CmpLog, * (System) Namespace: CmpLog Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpLog IoDriver Interfaces ¶ Library Identification ¶ Name: IoDriver Interfaces Version: newest Company: System Namespace: IoDriver_Interfaces Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: IoDriver Interfaces, * (System) IoDriver Parameter Interfaces ¶ Library Identification ¶ Name: IoDriver Parameter Interfaces Version: newest Company: System Namespace: IIoDrvParameter Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: IoDriver Parameter Interfaces, * (System) IoDrvBase ¶ Library Identification ¶ Placeholder: IoDrvBase Default Resolution: IoDrvBase, * (System) Namespace: IoDrvBase Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: IoDrvBase IoDrvModbusBase ¶ Library Identification ¶ Placeholder: IoDrvModbusBase Default Resolution: IoDrvModbusBase, * (3S - Smart Software Solutions GmbH) Namespace: IoDrvModbusBase Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: IoDrvModbusBase IoStandard ¶ Library Identification ¶ Placeholder: IoStandard Default Resolution: IoStandard, * (System) Namespace: IoStandard Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: IoStandard Standard ¶ Library Identification ¶ Placeholder: Standard Default Resolution: Standard, * (System) Namespace: Standard Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Standard SysCom ¶ Library Identification ¶ Placeholder: SysCom Default Resolution: SysCom, * (System) Namespace: SysCom Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysCom SysCpuHandling ¶ Library Identification ¶ Placeholder: SysCpuHandling Default Resolution: SysCpuHandling, * (System) Namespace: SysCpuHandling Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysCpuHandling SysMem ¶ Library Identification ¶ Placeholder: SysMem Default Resolution: SysMem, * (System) Namespace: SysMem Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysMem SysTarget ¶ Library Identification ¶ Placeholder: SysTarget Default Resolution: SysTarget, * (System) Namespace: SysTarget Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysTarget SysTypes2 Interfaces ¶ Library Identification ¶ Name: SysTypes2 Interfaces Version: newest Company: System Namespace: SysTypes Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysTypes2 Interfaces, * (System)
Sercos3_IDNRead (FB) ¶ FUNCTION_BLOCK Sercos3_IDNRead This functionn block could be used to read Sercos III slave parameter. In contrast TO Sercos3_IDNRead4 also parameters longer than 4 Bytes will be supported. The parameter TO be read is specified BY the IDN as used in the object dictionary. InOut: Scope Name Type Initial Comment Input xExecute BOOL On a rising edge at this input the reading of the slave parameter will be started. In order to get the internal channel deallocated, the instance must be called at least once by “xExecute:= FALSE”. xAbort BOOL FALSE If this parameter is TRUE, the current read process will be aborted. usiCom USINT 1 Number of the Sercos III master: If only one Sercos III master is used, usiCom is ‘1’. In case of multiple masters use ‘1’ for the first, ‘2’ for the second, etc. uiAddress UINT Topological address or Sercos address, depends on the parameter xIsSercosAddress xIsSercosAddress BOOL FALSE This input switches between topological address and Sercos address FALSE: uiAddress is the topological address TRUE: uiAddress is the Sercos address usiChannel USINT 1 Reserved for future extensions. Currently not used. dwIDN DWORD IDN (Identification Number) with 4 Bytes (SI (structure instance) and SE (structure element)) wElem WORD Value 1: Structure of the IDN Value 2: Name of the parameters Value 3: Data attributes Value 4: Unit Value 5: Minimal value Value 6: Maximal value Value 7: Data value udiTimeOut UDINT Here you can set a timeout in milliseconds. If the reading of the parameter has not been finished within this time, an error message will be generated. pBuffer POINTER TO BYTE 0 Pointer on a data buffer in which the data will be stored after a successful parameter transfer szSize CAA_SIZE 0 Size of the data buffer (see above: pBuffer) in Bytes. Output xDone BOOL This output is TRUE as soon as the command has been finished successfully. xBusy BOOL This output is TRUE as long as the execution of the command has not been finished. xError BOOL This output is TRUE, if an error is detected. eError will show the cause. eError SERCOS3_ERROR This output shows the cause of the detected error, which is indicated by xError. For example ‘SERCOS3_TIMEOUT’ in case of an timeout. udiSercosError UDINT Error code if the function block has not been finished successfully. szDataRead CAA_SIZE Number of read bytes; maximum szSize (see input parameters).
Sercos3_IDNRead4 (FB) ¶ FUNCTION_BLOCK Sercos3_IDNRead4 This function block could be used to read Sercos III slave parameter. In contrast to Sercos3_IDNRead only parameters not longer than 4 Bytes will be supported. The parameter to be read is specified by the IDN as used in the object dictionary. InOut: Scope Name Type Initial Comment Input xExecute BOOL On a rising edge at this input the reading of the slave parameter will be started. In order to get the internal channel deallocated, the instance must be called at least once by “xExecute:= FALSE”. xAbort BOOL FALSE If this parameter is TRUE, the current read process will be aborted. usiCom USINT 1 Number of the Sercos III master: If only one Sercos III master is used, usiCom is ‘1’. In case of multiple masters use ‘1’ for the first, ‘2’ for the second, etc. uiAddress UINT Topological address or Sercos address, depends on the parameter xIsSercosAddress xIsSercosAddress BOOL FALSE This input switches between topological address and Sercos address FALSE: uiAddress is the topological address TRUE: uiAddress is the Sercos address usiChannel USINT 1 Reserved for future extensions. Currently not used. dwIDN DWORD IDN (Identification Number) with 4 Bytes (SI (structure instance) and SE (structure element)) wElem WORD Value 1: Structure of the IDN Value 2: Name of the parameters Value 3: Data attributes Value 4: Unit Value 5: Minimal value Value 6: Maximal value Value 7: Data value udiTimeOut UDINT Here you can set a timeout in milliseconds. If the reading of the parameter has not been finished within this time, an error message will be generated. Output xDone BOOL This output is TRUE as soon as the command has been finished successfully. xBusy BOOL This output is TRUE as long as the execution of the command has not been finished. xError BOOL This output is TRUE, if an error is detected. eError will show the cause. eError SERCOS3_ERROR This output shows the cause of the detected error, which is indicated by xError. For example ‘SERCOS3_TIMEOUT’ in case of an timeout. udiSercosError UDINT Error code if the function block has not been finished successfully. abyData ARRAY [1..4] OF BYTE This is an array of 4 Bytes to which the read parameter data will be copied. If 1 Byte have been read, this will be stored in index 1 of the array. Values of 2 resp. 4 bytes will be copied to the array according to Intel byte order. usiDataLength USINT Number of read bytes (1,2,4).
Sercos3_IDNWrite (FB) ¶ FUNCTION_BLOCK Sercos3_IDNWrite This function block could be used to write Sercos III slave parameter. In contrast to Sercos3_IDNWrite4 also parameters longer than 4 Bytes will be supported. The parameter to be written is specified by the IDN as used in the object dictionary. InOut: Scope Name Type Initial Comment Input xExecute BOOL On a rising edge at this input the reading of the slave parameter will be started. In order to get the internal channel deallocated, the instance must be called at least once by “xExecute:= FALSE”. xAbort BOOL FALSE If this parameter is TRUE, the current write process will be aborted. usiCom USINT 1 Number of the Sercos III master: If only one Sercos III master is used, usiCom is ‘1’. In case of multiple masters use ‘1’ for the first, ‘2’ for the second, etc. uiAddress UINT Topological address or Sercos address, depends on the parameter xIsSercosAddress xIsSercosAddress BOOL FALSE This input switches between topological address and Sercos address FALSE: uiAddress is the topological address TRUE: uiAddress is the Sercos address usiChannel USINT 1 Reserved for future extensions. Currently not used. dwIDN DWORD IDN (Identification Number) with 4 Bytes (SI (structure instance) and SE (structure element)) wElem WORD Value 7: Data value udiTimeOut UDINT Here you can set a timeout in milliseconds. If the writing of the parameter has not been finished within this time, an error message will be generated. pBuffer POINTER TO BYTE 0 Pointer on a the buffer which contains the data to be written szSize CAA_SIZE 0 Size of the data buffer (see above: pBuffer) in Bytes. Output xDone BOOL This output is TRUE as soon as the command has been finished successfully. xBusy BOOL This output is TRUE as long as the execution of the command has not been finished. xError BOOL This output is TRUE, if an error is detected. eError will show the cause. eError SERCOS3_ERROR This output shows the cause of the detected error, which is indicated by xError. For example ‘SERCOS3_TIMEOUT’ in case of an timeout. udiSercosError UDINT Error code if the function block has not been finished successfully. szDataWritten CAA_SIZE Number of written Bytes; will be set to szSize after successful writing
Sercos3_IDNWrite4 (FB) ¶ FUNCTION_BLOCK Sercos3_IDNWrite4 This function block could be used to write Sercos III slave parameter. In contrast to Sercos3_IDNWrite only parameters not longer than 4 Bytes will be supported. The parameter to be written is specified by the IDN as used in the object dictionary. InOut: Scope Name Type Initial Comment Input xExecute BOOL On a rising edge at this input the reading of the slave parameter will be started. In order to get the internal channel deallocated, the instance must be called at least once by “xExecute:= FALSE”. xAbort BOOL FALSE If this parameter is TRUE, the current write process will be aborted. usiCom USINT 1 Number of the Sercos III master: If only one Sercos III master is used, usiCom is ‘1’. In case of multiple masters use ‘1’ for the first, ‘2’ for the second, etc. uiAddress UINT Topological address or Sercos address, depends on the parameter xIsSercosAddress xIsSercosAddress BOOL FALSE This input switches between topological address and Sercos address FALSE: uiAddress is the topological address TRUE: uiAddress is the Sercos address usiChannel USINT 1 Reserved for future extensions. Currently not used. dwIDN DWORD IDN (Identification Number) with 4 Bytes (SI (structure instance) and SE (structure element)) wElem WORD Value 7: Data value udiTimeOut UDINT Here you can set a timeout in milliseconds. If the writing of the parameter has not been finished within this time, an error message will be generated. abyData ARRAY [1..4] OF BYTE This array of 4 Bytes contains the data to be written If 1 byte have been written, this will be stored in index 1 of the array. Values of 2 resp. 4 bytes will be copied to the array according to Intel byte order. usiDataLength USINT Number of bytes to be written (1,2,4). Output xDone BOOL This output is TRUE as soon as the command has been finished successfully. xBusy BOOL This output is TRUE as long as the execution of the command has not been finished. xError BOOL This output is TRUE, if an error is detected. eError will show the cause. eError SERCOS3_ERROR This output shows the cause of the detected error, which is indicated by xError. For example ‘SERCOS3_TIMEOUT’ in case of an timeout. udiSercosError UDINT Error code if the function block has not been finished successfully.
IoDrvSercos ¶ ConfigStructs IoDrvSercos3 (FunctionBlock) AutoRestartMaster (Property) FirstSlave (Property) LastInstance (Property) NextInstance (Property) SERCOS_TOPOLOGY (Enum) Sercos3MasterGlobals (GVL) Sercos3Slave (FunctionBlock) IOControlStatusUsed (Property) IsConfigAsOptional (Property) LastInstance (Property) NextInstance (Property) SercosAddress (Property) SercosIndex (Property) SercosTopologyAddress (Property) SlaveActive (Property) SlaveOptional (Property) StatusWord (Property)
ConfigStructs ¶ /// for internal use only
IoDrvSercos3 (FB) ¶ FUNCTION_BLOCK IoDrvSercos3 EXTENDS IoDrvBase IMPLEMENTS ICmpIoDrvParameter The program organization unit IoDrvSercos3. For each Sercos master an instance of POU IoDrvSercos3 is created. The properties may be accessed respecting the syntax “<Instance name>.<Property name”. Examples of using the instance: Restart of master: SercosIII_Master.xRestart := xRestart SercosIII_Master(); Call of master to retrieve information about the success of downloading the configuration parameters: xFinish := SercosIII_Master.xConfigFinished; InOut: Scope Name Type Comment Input xRestart BOOL A rising edge at this input will restart the master. All configuration data will be reloaded. wRequiredTopology SERCOS_TOPOLOGY The required topology (Ring, L1, L2 etc) xRecoverRingTopology BOOL If a ring topology is required and a ring break was detected then it is possible to recover the ring topology with this input. Output xConfigFinished BOOL If the output is TRUE, the transmission of all configuration data has been executed properly. The communication on the bus is in process. wState WORD The parameter wState has a value between 0 and 100 telling about the state of the initialization phase; the greater the value, the more the initialization process is advanced. wTopology SERCOS_TOPOLOGY The current topology of the Sercos III bus. xTopologyError BOOL IF wRequiredTopologiy is not equal to wTopology there is an error. xBusError BOOL If the bus is not working then this output is set to true Properties: AutoRestartMaster FirstSlave LastInstance NextInstance Structure: AutoRestartMaster (Property) FirstSlave (Property) LastInstance (Property) NextInstance (Property)
