If you would like to contribute, have feedback or questions, please reach out! -If you are using or like the progress being made, please leave a star. Thanks!
Install package from Nuget.
Install-Package L5Sharp
The main entry point to the L5X is the LogixContent class.
-Use the factory methods Load to load a L5S file or Parse to parse a L5X string.
Load to load a L5X file or Parse to parse a L5X string.
var content = LogixContent.Load("C:\PathToMyFile\FileName.L5X");
Quickly query any type using the Find<T>() method on the content class.
Query any type across the L5X using the Find<T>() method on the content class.
+Find<T>() just returns an IEnumerable<T>, allowing for more complex queries
+using LINQ and the strongly typed objects in the library.
var tags = content.Find<Tag>();
NOTE: Find<T>() just returns an IEnumerable<T>, so it is essentially read only,
-but allows you to form more complex queries using LINQ and the strongly typed
-components in the library. To mutate components, see the following section.
Query or mutate components in the file using the top level LogixContainer collections,
-such as Tag, DataType, Module, Program, and more.
The following shows some simple querying via the controller tags container:
-//Get all controller tags.
-var controllerTags = content.Tags;
-
-//Get a tag by name.
-var myTag = content.Tags.Find("MyTag");
-
-//Use LINQ to query further.
-var timerTypeTags = content.Tags.Where(t => t.DataType == "TIMER");
+[!NOTE]
+Ths above query will return all Tag elements found, including controller and all program tags.
+Usage
+The LogixContent class contains LogixContainer collections for all L5X components,
+such as Tag, DataType,
+Moulde, and more.
+These classes expose methods for querying and modifying the collections
+and components within the collections.
+Get All Components
+var tags = content.Tags.ToList();
+
+Get Component By Name
+var tag = content.Tags.Find("MyTag");
-The following shows some simple modifications via the controller tags container:
-//Add a new component.
-var tag = new Tag { Name = "MyTag", Value = 100 };
+Filter Components
+var tags = content.Tags.Where(t => t.DataType == "TIMER" && t.Dimensions.IsEmpty && t["PRE"].Value >= 5000);
+
+Add Component
+var tag = new Tag { Name = "MyTag", Value = 100 };
content.Tags.Add(tag);
-
-//Remove an existing component.
-content.Tags.Remove("MyTag");
-
-//Repalce an existing component.
-content.Tags.Find("MyTag").Replace(tag);
-
-//Save changes when done.
-content.Save("C:\PathToMyOutputFile\FileName.L5X");
+
+Update Component
+var tag = content.Tags.Get("MyTag");
+tag.Value = 1234;
+tag.Description = "This is a tag's description";
+
+Remove Component
+content.Tags.Remove("MyTag");
+
+Save Changes
+content.Save("C:\PathToMyOutputFile\FileName.L5X");
See ... for more information.
diff --git a/docs/toc.html b/docs/toc.html
index e77dcce2..a704f27f 100644
--- a/docs/toc.html
+++ b/docs/toc.html
@@ -16,7 +16,7 @@
Articles
- Api Documentation
+ Api
diff --git a/docs/toc.json b/docs/toc.json
index 1217a7ab..6007a1eb 100644
--- a/docs/toc.json
+++ b/docs/toc.json
@@ -1,2 +1,2 @@
-{"items":[{"name":"Articles","href":"articles/intro.html","tocHref":"articles/toc.html","topicHref":"articles/intro.html"},{"name":"Api Documentation","href":"api/index.html","tocHref":"api/toc.html","topicHref":"api/index.html","homepage":"api/index.html"}]}
\ No newline at end of file
+{"items":[{"name":"Articles","href":"articles/intro.html","tocHref":"articles/toc.html","topicHref":"articles/intro.html"},{"name":"Api","href":"api/index.html","tocHref":"api/toc.html","topicHref":"api/index.html","homepage":"api/index.html"}]}
\ No newline at end of file
diff --git a/src/.idea/.idea.L5Sharp/.idea/workspace.xml b/src/.idea/.idea.L5Sharp/.idea/workspace.xml
index ff0b83de..664e1fb3 100644
--- a/src/.idea/.idea.L5Sharp/.idea/workspace.xml
+++ b/src/.idea/.idea.L5Sharp/.idea/workspace.xml
@@ -7,11 +7,9 @@
-
+
+
@@ -355,7 +353,7 @@
1677621948966