Fisothemes' Standard Library for TwinCAT

Welcome to the Fisothemes's Standard Library for TwinCAT! This library aims to consolidate, clean up, and improve the existing TwinCAT library on my GitHub profile. The goal is to provide TwinCAT developers with a clean, simple, and consistent library that enhances their development experience and helps them build projects more efficiently.

Features

• Modularity: The library is organized into different modules, each focusing on a specific area such as core functionality, error handling, strings, numerics, collections, I/O, hashing, streams, sockets, and callbacks.
• 🚧 Reusability: The modules will be designed to be reusable components that can be easily integrated into your TwinCAT projects.
• 🚧 Documentation: The repository will include comprehensive documentation that guides you on how to use the library effectively and efficiently.
• 🚧 Examples: A collection of examples will be provided to showcase the usage of different modules and help you get started quickly.
• 🚧 Contributions: Contributions from the TwinCAT community are welcome! Please refer to the Contribution Guidelines for more information.

Getting Started

Please note that the Fisothemes's Standard Library for TwinCAT is currently under development. While it is not yet ready for full usage, I would like to provide you with a glimpse of what is planned. Here are some code snippets to give you a taste of what I have in mind:

Base Class

FsFB_Object IMPLEMENTS FsI_Object
├── Methods
│   ├── Is(ipObject : FsI_Object) -> BOOL
│   └── ToString() -> FsT_LStr
└── Properties
    ├── TypeName : FsT_Str
    ├── InstacePath : FsT_LStr
    ├── Address : FsT_Ptr
    ├── Size : FsT_Size
    └── MemoryArea : FsT_MemArea

Error Class

FsFB_Error EXTENDS FsFB_Object IMPLEMENTS FsI_Error
└── Properties
    ├── Code : FsT_ErrCode
    └── Message : FsT_ErrMsg

Immutable String Example

Declarations:

VAR
    sValue : STRING(255);
    fbImmutStr : FsFB_ImmutableString('I love cats!');
    DogPos : FsT_Pos;
    fbErr : FsFB_Error;
END_VAR

Implementation:

sValue := fbImmutStr
    .Search('Dogs', 0, Pos => DogPos, e => fbErr)
    .ToString();
CASE fbErr.Code OF
    0: ...
ELSE
    // Handle Error.
    END_CASE

TCP Client Example

Declarations:

VAR
    SendBuffer, RecvBuffer : FsT_Str;
    fbTcpClient : FsFB_TcpClient;
    fbErr : FsFB_Error;
END_VAR

Implementation:

IF bConnect THEN
    // The Connect method returns TRUE when done irrespective of error.
    bConnect := NOT fbTcpClient.Connect('127.0.0.1', 8008, e => fbErr);
    IF fbErr.Code <> 0 THEN
        // Handle error.
	END_IF
    END_IF
	
IF bDisconnect THEN
    bDisconnect := NOT fbTcpClient.Disconnect(e => ipErr);
    END_IF
	
IF bSend THEN
    bSend := NOT fbTcpClient.Send(SendBuffer, e => ipErr);
    END_IF

IF bReceive THEN
    bReceive := NOT fbTcpClient.Receive(RecvBuffer, nBytes => nRBytes, e => ipErr);
    END_IF

License

This project is licensed under the MIT License.

Contact

If you have any questions or suggestions regarding the Fisothemes's Standard Library for TwinCAT, you can reach out to me via fisothemes@gmail.com.