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 Component Manager ¶ Library Identification ¶ Placeholder: Component Manager Default Resolution: Component Manager, * (System) Namespace: Component_Manager Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Component Manager 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 IoDrvModbus ¶ Library Identification ¶ Placeholder: IoDrvModbus Default Resolution: IoDrvModbus, * (3S - Smart Software Solutions GmbH) Namespace: IoDrvModbus Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: IoDrvModbus 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 ModbusTCP Slave ¶ Library Identification ¶ Placeholder: ModbusTCP Slave Default Resolution: ModbusTCP Slave, * (3S - Smart Software Solutions GmbH) Namespace: ModbusTCP_Slave Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: ModbusTCP Slave Standard ¶ Library Identification ¶ Placeholder: Standard Default Resolution: Standard, * (System) Namespace: Standard Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Standard StringUtils ¶ Library Identification ¶ Placeholder: StringUtils Default Resolution: StringUtils, * (System) Namespace: Stu Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: StringUtils 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)
IoDrvModbusTCPSlave Library Documentation ¶ Company 3S - Smart Software Solutions GmbH Title IoDrvModbusTCPSlave Version 4.3.0.0 Categories Intern|IoDrivers Namespace IoDrvModbusTCPSlaveLibrary Author 3S - Smart Software Solutions GmbH Placeholder IoDrvModbusTCPSlave Description 1 ¶ ModbusTCP Slave IO-driver written in IEC. Contents: ¶ DeviceStatusT (Struct) IoDrvModbusTCPSlave (FunctionBlock) Enable (Property) UpdateCommunicationSettings (Method) Library Information GetLibVersion (Function) GetLibVersionNumber (Function) IsLibReleased (Function) ModbusTCPDeviceDiag (FunctionBlock) UpdateCommunicationSettings (Method) Indices and tables ¶ 1 Based on IoDrvModbusTCPSlave.library, last modified 16.05.2023, 15:44:12. LibDoc 4.4.0.0-b.27 The content file IoDrvModbusTCPSlave.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 16.05.2023, 15:44:12.
IoDrvModbusTCPSlave (FB) ¶ FUNCTION_BLOCK IoDrvModbusTCPSlave EXTENDS IoDrvBase IMPLEMENTS ICmpIoDrvParameter This function block is generated for each Modbus TCP slave device in the device tree. InOut: Scope Name Type Initial Comment Input xEnable BOOL TRUE TRUE : start operation, open sockets Output xOnline BOOL TCP Port opened, ready for receiving request. xInternalError BOOL FALSE Unrecoverable internal error (e.g. if mem-alloc fails or no license) ErrorCode UDINT error code Port UINT Port Number uiClientConnections UINT number of currently established client connections (TCP/IP) xTimeout BOOL Timeout (if configured) expired. Holding Registers and Coils are set to zero. Properties: Enable Methods: UpdateCommunicationSettings Structure: Enable (Property) UpdateCommunicationSettings (Method)
DeviceStatusT (STRUCT) ¶ TYPE DeviceStatusT : STRUCT
IoDrvModbusTCPSlave.Enable (PROP) ¶ PROPERTY Enable : BOOL
IoDrvModbusTCPSlave.UpdateCommunicationSettings (METH) ¶ METHOD UpdateCommunicationSettings : DINT Change the TCP-Port number. Existing TCP Connection will be aborted InOut: Scope Name Type Initial Comment Return UpdateCommunicationSettings DINT Input uiPortNr UINT 502 TCP-Port Number used by Modbus Server
Library Information ¶ GetLibVersion (Function) GetLibVersionNumber (Function) IsLibReleased (Function)
GetLibVersion (FUN) ¶ FUNCTION GetLibVersion : VERSION This function has been automatically generated from the project information. InOut: Scope Name Type Return GetLibVersion VERSION
GetLibVersionNumber (FUN) ¶ FUNCTION GetLibVersionNumber : DWORD This function has been automatically generated from the project information. InOut: Scope Name Type Return GetLibVersionNumber DWORD
ClientRequestReadWriteMultipleRegistersWide (FB) ¶ FUNCTION_BLOCK ClientRequestReadWriteMultipleRegistersWide EXTENDS ModbusFB.ClientRequest ReadWriteMultipleRegister client request (FC23) for registers > 16bit. For details about client request see |ClientRequest| . For details about “wide registers” and endianess see ServerTCP_extended or ServerSerial_extended . Please note: The write operation is performed before the read. Please visit https://forge.codesys.com/prj/codesys-example/modbus/home to find examples. InOut: Scope Name Type Initial Comment Inherited from Input xExecute BOOL Rising edge: Starts defined operation FALSE : Resets the defined operation after ready condition was reached ETrigTo udiTimeOut UDINT Max. operating time for executing [µs], 0: No operating time limit ETrigTo Output xDone BOOL Ready condition reached ETrigTo xBusy BOOL Operation is running ETrigTo xError BOOL Error condition reached ETrigTo Inout rClient Client Reference to |Client| . ClientRequest Input uiUnitId UINT 0 Unit-Id to send the request to. ClientRequest udiReplyTimeout UDINT (50 * 1000) 50 ms ClientRequest uiMaxRetries UINT 0 Maximum number of request retries in case of “reply timeout”. ClientRequest Output eErrorID Error Error status ClientRequest eException ExceptionCodes Request exception code. ClientRequest uiRetryCnt UINT 0 Number of request retries in case of “reply timeout”. ClientRequest Input uiWriteStartItem UINT 0 First “data item” to write. uiWriteQuantity UINT 1 Number of “data items” to write. pWriteData POINTER TO BYTE 0 Pointer to write data. uiWriteDataItemSize UINT write “data item” size / register width (in bytes). The ClientRequest has to know about the “data item” size a-priori to provide memory for result data. In case the server unexpectedly does have a different “data item” size than assumed, the ClientRequest can not succeed. uiReadStartItem UINT 0 First “data item” to read. uiReadQuantity UINT 1 Number of “data items” to read. pReadData POINTER TO BYTE 0 Pointer to read data. uiReadDataItemSize UINT read “data item” size / register width (in bytes).
