Qistas.QistasLinks 1.0.0

QistasLinks

QistasLinks is a C# .NET 7 DLL library designed for serial or RS232 interface communication. It provides a comprehensive solution for establishing communication with microcontrollers and exchanging data according to any protocol used in your project. QistasLinks is part of the Qistas project, which aims to provide a collection of libraries and tools for microcontroller communication and integration.

Features

• Serial Communication: QistasLinks enables easy and efficient read/write operations for serial or RS232 interfaces. It provides a reliable and flexible communication channel between microcontrollers and computers.

• Data Transfer Pattern: The library offers a data transfer pattern that simplifies the process of exchanging data between microcontrollers and computers. It provides a structured approach for sending and receiving data packets.

• Protocol Agnostic: QistasLinks can be integrated into projects using any protocol of your choice. Whether you're working with custom protocols or industry-standard ones, the library can adapt to your specific requirements.

Installation

1. Download the QistasLinks DLL file from the repository.

2. Add the QistasLinks DLL reference to your C# .NET 7 project.

3. Ensure that your project is targeting the appropriate .NET version.

4. Build your project to ensure that the QistasLinks library is properly included.

Usage

1. Import the QistasLinks namespace into your code files:

   using Qistas;
   using QistasLinks;
   using System.Dynamic;
   using static Qistas.QFunctions; //If you want to take advantage of some valuable methods
   

2. Create an instance of the Qlink class:

   Qlink link = new Qlink
   {
       /*
       port = "....",
       rate = ....,
       ..... */
   };
   

3. Initialize the Qlink instance:

   link.Init();
   

4. Open the serial connection:

   link.open();
   

5. Retrieve the status of the connection:

   Console.WriteLine(link.GetStatus());
   

6. Subscribe to the Received and JunkData events for data handling:

   link.Received += Link_Received;
   link.JunkData += Link_JunkData;
   
   void Link_Received(string DataReceived, int patternId)
   {
       Console.WriteLine($"by applying ({patternId}) >> received: {DataReceived}");
   }
   
   void Link_JunkData(string JunkData)
   {
       Console.WriteLine("Junk: " + JunkData);
   }
   

7. Perform any necessary read and write operations using the Qlink instance.

8. Close the serial connection when you're finished:

   link.close();
   

Examples

If you encounter any issues or have any questions, please create an issue on the GitHub repository.

Contributing

Contributions to QistasLinks are welcome! If you would like to contribute, please follow these steps:

1. Fork the repository.

2. Create a new branch for your feature or bug fix.

3. Commit your changes and push the branch to your fork.

4. Submit a pull request, explaining the changes you've made and their purpose.

License

QistasLinks is open-source software licensed under the MIT license.

Support

If you encounter any issues or have any questions, please create an issue on the GitHub repository.

Acknowledgements

• QistasLinks is part of the Qistas project, which aims to provide a collection of libraries and tools for microcontroller communication and integration.

• We would like to express our gratitude to the open-source community for their contributions and support.

Contact

For any further inquiries or information, please contact our team at [email protected]

Thank you for using QistasLinks!

I have added the code you provided and included an explanation of how the pattern works and how to access the deserialized data using the specified variables. Feel free to adjust the code and explanation as needed.