Support

Example

var newTag = new kSDKv1.l5xTag();
newTag.setName("NewTag");
console.log(newTag.getName()); // -> "NewTag"

Example

var newTag = new kSDKv1.l5xTag();
newTag.setData("1");
console.log(newTag.getData()); // -> "1"

Example

var newTag = new kSDKv1.l5xTag();
newTag.setTagType("Base");
console.log(newTag.getTagType()); // -> "Base"

Note:

1. Kiptr does not check the validity of the data type entry. You will get an error when importing an l5x file into Studio5000 software if tag is assigned a data type that is not existing in the project.
2. Kiptr will auto-capitalize newDataType.
3. Kiptr will automatically add necessary attributes if the new data type is ALARM_ANALOG, ALARM_DIGITAL, MESSAGE or TIMER.
4. Kiptr has currently limited support for organizing parameters for several kinds of tag (e.g. arrays of UDTs, motion related tags). We are working on improving this function. Contact tech support if you experience difficulties.

Example

var newTag = new kSDKv1.l5xTag();
newTag.setDataType("sint");
console.log(newTag.getDataType()); // -> "SINT"

Creating an array of tags with data type of AOI:

var newPrj = new kSDKv1.l5xProject();
var myXML = "<SomeXMLcode/>" // Assuming you use your own AOI with parameters defined
var myAOI = new kSDKv1.l5xAOI(myXML);
var newTag = new kSDKv1.l5xTag(); // Creating a default BOOL
newTag.setName("myArray"); // Setting new tag name
newtag.fixAOITag(myAOI); // This will set the Data Type = AOI name
// and will update the structure of the tag to match AOI parameters
newTag.setDataType(newTag.getDataType(), 10); // This will modify the tag to an array of 10 tags with same Data Type

var newTag = new kSDKv1.l5xTag();
newTag.setDataType("sint", "5,5");
newTag.setName("myNewTag");
newTag.setValue("15", "myNewTag[1,3]");
console.log(newTag.getValue("myNewTag[1,3]")); // -> "15"
console.log(newTag.getValue()); // -> Error. Tag name is missing for complex structure

Complex Structures:

var newTag = new kSDKv1.l5xTag();
newTag.setDataType("someUDT"); // Creation of data type "SomeUDT" is not shown here
newTag.setName("myNewTag");
newTag.setValue("1", "myNewTag.tagBranch1.tagBranch2[0].Enable");
console.log(newTag.getValue("myNewTag.tagBranch1.tagBranch2[2].Enable")); // -> "1"

Note:

1. Kiptr does not check if the value matches the type of the tag.
2. String length (stringTag.LEN) and individual characters are not supported (stringTag.DATA[xx]). You can reference the whole string only (see example below). This is the limitation of L5X format.

Example 

Atomic types:

var newTag = new kSDKv1.l5xTag();
newTag.setValue("1");
console.log(newTag.getValue()); // -> "1"
console.log(newTag.getValue(newTag.getName())); // -> "1"
newTag.setDataType("String");
console.log(newTag.getValue()); // -> ""
newTag.setValue("SomeText");
console.log(newTag.getValue()); // -> "SomeText"

var newTag = new kSDKv1.l5xTag();
newTag.setDataType("sint", "5,5");
newTag.setName("myNewTag");
newTag.setValue("15", "myNewTag[1,3]");
console.log(newTag.getValue("myNewTag[1,3]")); // -> "15"
console.log(newTag.getValue()); // -> Error. Tag name is missing for a complex structure

var newTag = new kSDKv1.l5xTag();
newTag.setDataType("someUDT"); // Creation of data type "SomeUDT" is not shown here
newTag.setName("myNewTag");
newTag.setValue("1", "myNewTag.tagBranch1.tagBranch2[0].Enable");
console.log(newTag.getValue("myNewTag.tagBranch1.tagBranch2[2].Enable")); // -> "1"

Note:

1. Kiptr does not check if the value matches the type of the tag.

Example

var newTag = new kSDKv1.l5xTag();
newTag.setAttribute("ExternalAccess", "None");
console.log(newTag.getAttribute("ExternalAccess")); // -> "None"

Note:

1. Kiptr does not check if the alias exists.
2. Kiptr will automatically change the tag type to “Alias”.

Example

var newTag = new kSDKv1.l5xTag();
newTag.setTagType("Alias");
newTag.setAliasFor("SomeTag");
console.log(newTag.getAliasFor()); // -> "SomeTag"

Example

var newTag = new kSDKv1.l5xTag();
newTag.setDescription("New Tag Description");
console.log(newTag.getDescription()); // -> "New Tag Description"

Example

var newTag = new kSDKv1.l5xTag();
newTag.setTagType("Consumed");
newTag.setConsumedInfo("Producer", "RemotePLC");
console.log(newTag.getConsumedInfo("Producer")); // -> "RemotePLC"

Example

var newTag = new kSDKv1.l5xTag();
newTag.setTagType("Produced");newTag.setProducedInfo("ProduceCount","20");
console.log(newTag.getProducedInfo("ProduceCount")); // -> "20"

Example

var newTag = new kSDKv1.l5xTag();
newTag.setDataType("Message");
newTag.setMSGAttribute("RequestedLength", "2");
console.log(newTag.getMSGAttribute("RequestedLength")); // -> "2"

Example

var newTag = new kSDKv1.l5xTag();
newTag.setDataType("Alarm_Digital");
newTag.setALMAttribute("Severity", "200");
console.log(newTag.getALMAttribute("Severity")); // -> "200"

Note:

Message type can be any value if working with Alarm Digital. Kiptr will automatically replace it with “AM” (the only option available for Alarm Digital). Type for Alarm Analog can be any of: “HH” (high-high alarm), “H” (high alarm), “L” (low alarm), “LL” (low-low alarm), “POS” (rate-of-change positive alarm), “NEG” (rate-of change negative alarm).

Example

var newTag = new kSDKv1.l5xTag();
newTag.setDataType("Alarm_Analog");
newTag.setALMMessage("HH", "New message for High High alarm");
console.log(newTag.getALMMessages()[0].Type); // -> "HH"
console.log(newTag.getALMMessages()[0].Text); // -> "New message for High High alarm"

Example

var newTag = new kSDKv1.l5xTag();
newTag.setDataType("Alarm_Analog");
newTag.setALMClass("NewAlmClass");
console.log(newTag.getALMClass()); // -> "NewAlmClass"

Example

var newTag = new kSDKv1.l5xTag();
newTag.setDataType("Alarm_Analog");
newTag.setHMICommand("{[PLC]SomeAction = 0}");
console.log(newTag.getHMICommand()); // -> "{[PLC]SomeAction = 0}"

var newPrj = new kSDKv1.l5xProject();
console.log(newPrj.toText());

var newTag = new kSDKv1.l5xTag();
var newAOI = new kSDKv1.l5xAOI();
newAOI.setName("SomeAOI");
console.log(newTag.getDataType()); // -> "BOOL"
newTag.fixAOITag(newAOI);
console.log(newTag.getDataType()); // -> "SOMEAOI"

var newTag = new kSDKv1.l5xTag();
var newUDT = new kSDKv1.l5xUDT();
newUDT.setName("SomeUDT");
console.log(newTag.getDataType()); // -> "BOOL"
newTag.fixUDTTag(newUDT);
console.log(newTag.getDataType()); // -> "SOMEUDT"