Kxware.SecsGem 1.3.1.25105

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher. .NET Framework 4.5 This package targets .NET Framework 4.5. The package is compatible with this framework or higher. 
dotnet add package Kxware.SecsGem --version 1.3.1.25105
                    


                    

                
NuGet\Install-Package Kxware.SecsGem -Version 1.3.1.25105
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Kxware.SecsGem" Version="1.3.1.25105" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Kxware.SecsGem" Version="1.3.1.25105" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Kxware.SecsGem" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Kxware.SecsGem --version 1.3.1.25105
                    


                    

                
#r "nuget: Kxware.SecsGem, 1.3.1.25105"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#addin nuget:?package=Kxware.SecsGem&version=1.3.1.25105
                    


                            Install Kxware.SecsGem as a Cake Addin
                        

                    

                
#tool nuget:?package=Kxware.SecsGem&version=1.3.1.25105
                    


                            Install Kxware.SecsGem as a Cake Tool

SEMI SECS/GEM Library for .NET

This is an .NET library for SEMI standard E4, E5, E30, E37 and E172.

Why Use This Library?

Performance

This library is developed by pure C#, designed with event-driven mechanism, single-threaded drive, without any thread locks, and has the ultimate operating efficiency.

Multi-platform Compatibility

Support multiple operating systems:

  • Windows
  • Linux
  • MacOS

Provides multiple .NET runtime libraries:

  • .Net Framework 4.5
  • .Net Framework 4.6
  • .Net Framework 4.7
  • .Net Framework 4.8
  • .NET 6
  • .NET 7
  • .NET 8

Bug Fixes

50+ semiconductor front-end factories, back-end factories, packaging factories, electronic manufacturing factories, etc. have equipment running KXware SECS/GEM software library running 24 hours x 365 days. Only a few minor bugs have been reported in the last two years.

Functional Completeness

It complies with SEMI E5/E30/E37 standards and fully implements all functions defined in SEMI E30 GEM. In addition, each Equipment can support multiple HSMS port communications at the same time, and support the creation of multiple Equipment SECS/GEM communication instances in the same process.

The following libraries or applications are developed based on the Kxware SECS/GEM library:

Quick Start

Install the latest library from Nuget. https://www.nuget.org/packages/Kxware.SecsGem/

The following sample code demostrates how to create a SECS/GEM instance, and call the API to update variable, event, and alarm.

    using Kxware.Common;
    using Kxware.ToolAutomation;

    class Program
    {
        static void Main(string[] args)
        {
            // Set default logging directory
            Log.SetLoggingDirectory("logs");
            
            // Get current PC's machine code
            //var machineCode = License.GetMachineCode();
         
            // Open https://activation.kxware.com/ to apply for a free KXGEM runtime license
            // Install the license file after received the activation code
            //License.SetRuntimeLicenseKey("XXXX-XXXX-XXXX-XXXX");

            // Enable console logging
            Log.EnableConsolePrint = true;

            // Create SECS/GEM Equipment instance
            var mySecsGemTool = new Equipment("MyEtchTool");

            // Initialize SECS/GEM stuff from configuration file
            //mySecsGemTool.Initialize("MyEtchTool.config");
            mySecsGemTool.Initialize();

            // Update SV
            //mySecsGemTool.SetValue("TemperatureSensorReading", 123.45);
            //mySecsGemTool.SetValue("RecipeStepName", "ABC.rcp");

            // Trigger Event
            //mySecsGemTool.TriggerEvent("RecipeStart", new[] { "Module", "Recipe" }, new object[] { "PMA", "ABC.rcp" });

            // Set Alarm
            //mySecsGemTool.SetAlarm("ReciepFailure", "Out of tolerance", new[] { "Module", "Recipe" }, new object[] { "PMA", "ABC.rcp" });

            // Done
            Thread.Sleep(-1);
        }
    }
FAQs in running the sample code
1. Enable BinaryFormatterSerialization in .NET core

KXGEM library uses BinaryFormatter to serialize and deserialize SECS message. If you are using the library in .NET 5/6/7/8/9, it needs to manually enable BinaryFormatterSerialization in .csproj file.

<PropertyGroup>
  <TargetFramework>net8.0</TargetFramework>
  
  <EnableUnsafeBinaryFormatterSerialization>true</EnableUnsafeBinaryFormatterSerialization>
</PropertyGroup>
2. How to get a free KXGEM license?
  • Call API 'Kxware.Common.License.GetMachineCode()' to get current PC's machine code.
  • Open hyperlink in browser https://activation.kxware.com/ , fill in the machine code and apply for a free runtime license.
  • Check your email box to get the activation code for KXGEM free license. Notice this license is a permanent license. Even you can use it in commercial small project free.
  • Call API once 'Kxware.Common.License.SetRuntimeLicenseKey("XXXX-XXXX-XXXX-XXXX")' to install the license file in your PC. Then, you can freely call KXware SECS/GEM library APIs. Enjoy~~
3. How to check logging messages?
  • If you are using a console application, please call 'Log.EnableConsolePrint = true;' to enable the console message printing.
  • At the beginning of your code, call 'Log.SetLoggingDirectory(..)' method to specify the logging directory.
  • Default logging directory is at 'C:\ProgramData\Kxware{YourEquipmentName}'

Goals

The goals of this project are:

  1. .NET Standard support: It must run on the full .NET Framework and all platforms supported by .NET Core.
  2. High performance: Avoid unnecessary allocations and copies when reading data.
  3. Lightweight: Only one library file is implemented.
  4. Independent: No third-party dependencies are required to run the library.
  5. Managed: Managed code only, no native code.

License

This library provides a free version of K GEM FREE, which allows users to apply for and activate the license online. It can even be used for free in commercial projects that integrate small devices to implement SECS/GEM. If you want to use the full-featured SECS/GEM library, please contact sales@kxware.com to apply for a Demo license, or purchase a commercial, official runtime license.

Contact

Development of KXGEM is supported by KXware Development Team. Contact support@kxware.com if you need further technical information.

Kxware Development Team

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed. 
.NET Framework net45 is compatible.  net451 was computed.  net452 was computed.  net46 is compatible.  net461 was computed.  net462 was computed.  net463 was computed.  net47 is compatible.  net471 was computed.  net472 was computed.  net48 is compatible.  net481 was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.3.1.25105 198 4/15/2025
1.3.1.25101 308 4/13/2025 1.3.1.25101 is deprecated because it has critical bugs.

2025/04/11     Version 1.3.1.25105
=======================
1. Initial version for Nuget.
2. Added online license activation, https://activation.kxware.com/