Skip to content

Commit 33be732

Browse files
danielpeintnerdanielpeintner
authored
Update Asset Interfaces Description (AID) submodel (#1222)
* refactor: update revised SemanticIDs * refactor: rename InterfaceMetadata to InteractionMetadata * refactor: change modbus to modv * refactor: add 2 new terms mostSignificantByte and mostSignificantWord for Modbus * refactor: update JSON schema with modbusMostSignificantByteElement and modbusMostSignificantWordElement
1 parent c130878 commit 33be732

5 files changed

Lines changed: 172 additions & 109 deletions

File tree

‎packages/td-tools/src/util/asset-interface-description.ts‎

Lines changed: 28 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ export class AssetInterfaceDescriptionUtil {
178178
},
179179
// created, modified, support ?
180180
this.createEndpointMetadata(td, protocol, aidID, submodelElementIdShort), // EndpointMetadata like base, security and securityDefinitions
181-
this.createInterfaceMetadata(td, protocol), // InterfaceMetadata like properties, actions and events
181+
this.createInteractionMetadata(td, protocol), // InteractionMetadata like properties, actions and events
182182
// Note: "ExternalDescriptor" should contain file values --> not applicable to TD
183183
/* {
184184
idShort: "ExternalDescriptor",
@@ -532,7 +532,7 @@ export class AssetInterfaceDescriptionUtil {
532532
}
533533

534534
private processSubmodelElement(smInformation: SubmodelInformation, submodelElement: Record<string, unknown>): void {
535-
// EndpointMetadata vs. InterfaceMetadata
535+
// EndpointMetadata vs. InteractionMetadata
536536
if (submodelElement.value instanceof Array) {
537537
// Note: iterate twice over to collect first EndpointMetadata
538538
let endpointMetadata: Record<string, unknown> = {};
@@ -543,7 +543,7 @@ export class AssetInterfaceDescriptionUtil {
543543
// e.g., idShort: base , contentType, securityDefinitions, alternativeEndpointDescriptor?
544544
endpointMetadata = smValue;
545545
smInformation.endpointMetadataArray.push(endpointMetadata);
546-
} else if (smValue.idShort === "InterfaceMetadata") {
546+
} else if (smValue.idShort === "InteractionMetadata") {
547547
// handled later
548548
} else if (smValue.idShort === "externalDescriptor") {
549549
// needed?
@@ -552,11 +552,11 @@ export class AssetInterfaceDescriptionUtil {
552552
}
553553
}
554554
}
555-
// the 2nd time look for InterfaceMetadata that *need* EndpointMetadata
555+
// the 2nd time look for InteractionMetadata that *need* EndpointMetadata
556556
for (const smValue of submodelElement.value) {
557557
if (smValue instanceof Object) {
558-
if (smValue.idShort === "InterfaceMetadata") {
559-
logInfo("InterfaceMetadata");
558+
if (smValue.idShort === "InteractionMetadata") {
559+
logInfo("InteractionMetadata");
560560
if (smValue.value instanceof Array) {
561561
for (const interactionValue of smValue.value) {
562562
if (interactionValue.idShort === "properties") {
@@ -929,7 +929,7 @@ export class AssetInterfaceDescriptionUtil {
929929
// scheme always
930930
values.push({
931931
idShort: "scheme",
932-
semanticId: this.createSemanticId("http://www.w3.org/1999/02/22-rdf-syntax-ns#type"),
932+
semanticId: this.createSemanticId("https://www.w3.org/2019/wot/security#SecurityScheme"),
933933
valueType: "xs:string",
934934
value: secValue.scheme,
935935
modelType: "Property",
@@ -1122,9 +1122,9 @@ export class AssetInterfaceDescriptionUtil {
11221122
}
11231123
}
11241124
} else if (protocol.startsWith("modbus")) {
1125-
// Modbus: href, modbus_function
1126-
// default for modbus:function depending on op, see https://w3c.github.io/wot-binding-templates/bindings/protocols/modbus/index.html#default-mappings
1127-
const mbKey = "modbus:function";
1125+
// Modbus: href, modv_function
1126+
// default for modv:function depending on op, see https://w3c.github.io/wot-binding-templates/bindings/protocols/modbus/index.html#default-mappings
1127+
const mbKey = "modv:function";
11281128
if (form[mbKey] == null) {
11291129
if (this.hasOp(form, "writeproperty") || this.hasOp(form, "invokeaction")) {
11301130
form[mbKey] = "writeSingleCoil";
@@ -1161,7 +1161,7 @@ export class AssetInterfaceDescriptionUtil {
11611161
}
11621162
}
11631163

1164-
private createInterfaceMetadata(td: ThingDescription, protocol: string): Record<string, unknown> {
1164+
private createInteractionMetadata(td: ThingDescription, protocol: string): Record<string, unknown> {
11651165
const properties: Array<unknown> = [];
11661166
const actions: Array<unknown> = [];
11671167
const events: Array<unknown> = [];
@@ -1372,18 +1372,22 @@ export class AssetInterfaceDescriptionUtil {
13721372
semanticId = "https://www.w3.org/2011/http#fieldName";
13731373
} else if (formTerm === "htv:fieldValue") {
13741374
semanticId = "https://www.w3.org/2011/http#fieldValue";
1375-
} else if (formTerm === "modbus:function") {
1376-
semanticId = "https://www.w3.org/2019/wot/modbus#Function";
1377-
} else if (formTerm === "modbus:entity") {
1378-
semanticId = "https://www.w3.org/2019/wot/modbus#Entity";
1379-
} else if (formTerm === "modbus:zeroBasedAddressing") {
1375+
} else if (formTerm === "modv:function") {
1376+
semanticId = "https://www.w3.org/2019/wot/modbus#hasFunction";
1377+
} else if (formTerm === "modv:entity") {
1378+
semanticId = "https://www.w3.org/2019/wot/modbus#hasEntity";
1379+
} else if (formTerm === "modv:zeroBasedAddressing") {
13801380
semanticId = "https://www.w3.org/2019/wot/modbus#hasZeroBasedAddressingFlag";
1381-
} else if (formTerm === "modbus:timeout") {
1381+
} else if (formTerm === "modv:timeout") {
13821382
semanticId = "https://www.w3.org/2019/wot/modbus#hasTimeout";
1383-
} else if (formTerm === "modbus:pollingTime") {
1383+
} else if (formTerm === "modv:pollingTime") {
13841384
semanticId = "https://www.w3.org/2019/wot/modbus#hasPollingTime";
1385-
} else if (formTerm === "modbus:type") {
1386-
semanticId = "https://www.w3.org/2019/wot/modbus#type";
1385+
} else if (formTerm === "modv:type") {
1386+
semanticId = "https://www.w3.org/2019/wot/modbus#hasPayloadDataType";
1387+
} else if (formTerm === "modv:mostSignificantByte") {
1388+
semanticId = "https://www.w3.org/2019/wot/modbus#hasMostSignificantByte";
1389+
} else if (formTerm === "modv:mostSignificantWord") {
1390+
semanticId = "https://www.w3.org/2019/wot/modbus#hasMostSignificantWord";
13871391
} else if (formTerm === "mqv:retain") {
13881392
semanticId = "https://www.w3.org/2019/wot/mqtt#hasRetainFlag";
13891393
} else if (formTerm === "mqv:controlPacket") {
@@ -1497,18 +1501,18 @@ export class AssetInterfaceDescriptionUtil {
14971501
modelType: "SubmodelElementCollection",
14981502
});
14991503

1500-
const interfaceMetadata: Record<string, unknown> = {
1501-
idShort: "InterfaceMetadata",
1504+
const interactionMetadata: Record<string, unknown> = {
1505+
idShort: "InteractionMetadata",
15021506
semanticId: this.createSemanticId(
1503-
"https://admin-shell.io/idta/AssetInterfacesDescription/1/0/InterfaceMetadata"
1507+
"https://admin-shell.io/idta/AssetInterfacesDescription/1/0/InteractionMetadata"
15041508
),
15051509
supplementalSemanticIds: [this.createSemanticId("https://www.w3.org/2019/wot/td#InteractionAffordance")],
15061510
// embeddedDataSpecifications ?
15071511
value: values,
15081512
modelType: "SubmodelElementCollection",
15091513
};
15101514

1511-
return interfaceMetadata;
1515+
return interactionMetadata;
15121516
}
15131517
}
15141518

‎packages/td-tools/test/AssetInterfaceDescriptionTest.ts‎

Lines changed: 36 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -233,10 +233,8 @@ class AssetInterfaceDescriptionUtilTest {
233233
expect(tdObj.properties.device_name.forms[0])
234234
.to.have.property("href")
235235
.to.eql("modbus+tcp://192.168.178.146:502/1/40020?quantity=16");
236-
expect(tdObj.properties.device_name.forms[0])
237-
.to.have.property("modbus:function")
238-
.to.eql("readHoldingRegisters");
239-
expect(tdObj.properties.device_name.forms[0]).to.have.property("modbus:type").to.eql("string");
236+
expect(tdObj.properties.device_name.forms[0]).to.have.property("modv:function").to.eql("readHoldingRegisters");
237+
expect(tdObj.properties.device_name.forms[0]).to.have.property("modv:type").to.eql("string");
240238
expect(tdObj.properties.device_name.forms[0])
241239
.to.have.property("contentType")
242240
.to.eql("application/octet-stream");
@@ -270,8 +268,8 @@ class AssetInterfaceDescriptionUtilTest {
270268
expect(tdObj.properties.soc.forms[0])
271269
.to.have.property("href")
272270
.to.eql("modbus+tcp://192.168.178.146:502/40361?quantity=1");
273-
expect(tdObj.properties.soc.forms[0]).to.have.property("modbus:function").to.eql("readHoldingRegisters");
274-
expect(tdObj.properties.soc.forms[0]).to.have.property("modbus:type").to.eql("uint16be");
271+
expect(tdObj.properties.soc.forms[0]).to.have.property("modv:function").to.eql("readHoldingRegisters");
272+
expect(tdObj.properties.soc.forms[0]).to.have.property("modv:type").to.eql("uint16be");
275273
expect(tdObj.properties.soc.forms[0]).to.have.property("contentType").to.eql("application/octet-stream");
276274
expect(tdObj.properties.device_name.forms[0]).not.to.have.property("security");
277275
}
@@ -352,11 +350,11 @@ class AssetInterfaceDescriptionUtilTest {
352350
expect(hasThingTitle, "No thing title").to.equal(true);
353351
expect(hasEndpointMetadata, "No EndpointMetadata").to.equal(true);
354352

355-
// InterfaceMetadata with properties etc
356-
let hasInterfaceMetadata = false;
353+
// InteractionMetadata with properties etc
354+
let hasInteractionMetadata = false;
357355
for (const smValue of smInterface.value) {
358-
if (smValue.idShort === "InterfaceMetadata") {
359-
hasInterfaceMetadata = true;
356+
if (smValue.idShort === "InteractionMetadata") {
357+
hasInteractionMetadata = true;
360358
expect(smValue).to.have.property("value").to.be.an("array").to.have.lengthOf.greaterThan(0);
361359
let hasProperties = false;
362360
for (const interactionValues of smValue.value) {
@@ -410,12 +408,12 @@ class AssetInterfaceDescriptionUtilTest {
410408
} else if (formEntry.idShort === "contentType") {
411409
hasContentType = true;
412410
expect(formEntry.value).to.equal("application/octet-stream");
413-
} else if (formEntry.idShort === "modbus_function") {
414-
// vs. "modbus:function"
411+
} else if (formEntry.idShort === "modv_function") {
412+
// vs. "modv:function"
415413
hasModbusFunction = true;
416414
expect(formEntry.value).to.equal("readHoldingRegisters");
417-
} else if (formEntry.idShort === "modbus_type") {
418-
// vs. "modbus:type"
415+
} else if (formEntry.idShort === "modv_type") {
416+
// vs. "modv:type"
419417
hasModbusType = true;
420418
expect(formEntry.value).to.equal("string");
421419
}
@@ -476,12 +474,12 @@ class AssetInterfaceDescriptionUtilTest {
476474
} else if (formEntry.idShort === "contentType") {
477475
hasContentType = true;
478476
expect(formEntry.value).to.equal("application/octet-stream");
479-
} else if (formEntry.idShort === "modbus_function") {
480-
// vs. "modbus:function"
477+
} else if (formEntry.idShort === "modv_function") {
478+
// vs. "modv:function"
481479
hasModbusFunction = true;
482480
expect(formEntry.value).to.equal("readHoldingRegisters");
483-
} else if (formEntry.idShort === "modbus_type") {
484-
// vs. "modbus:type"
481+
} else if (formEntry.idShort === "modv_type") {
482+
// vs. "modv:type"
485483
hasModbusType = true;
486484
expect(formEntry.value).to.equal("uint16be");
487485
}
@@ -506,7 +504,7 @@ class AssetInterfaceDescriptionUtilTest {
506504
expect(hasProperties).to.equal(true);
507505
}
508506
}
509-
expect(hasInterfaceMetadata, "No InterfaceMetadata").to.equal(true);
507+
expect(hasInteractionMetadata, "No InteractionMetadata").to.equal(true);
510508
}
511509

512510
td1Base = "https://www.example.com/";
@@ -671,11 +669,11 @@ class AssetInterfaceDescriptionUtilTest {
671669
expect(hasThingTitle, "No thing title").to.equal(true);
672670
expect(hasEndpointMetadata, "No EndpointMetadata").to.equal(true);
673671

674-
// InterfaceMetadata with properties etc
675-
let hasInterfaceMetadata = false;
672+
// InteractionMetadata with properties etc
673+
let hasInteractionMetadata = false;
676674
for (const smValue of smInterface.value) {
677-
if (smValue.idShort === "InterfaceMetadata") {
678-
hasInterfaceMetadata = true;
675+
if (smValue.idShort === "InteractionMetadata") {
676+
hasInteractionMetadata = true;
679677
expect(smValue).to.have.property("value").to.be.an("array").to.have.lengthOf.greaterThan(0);
680678
let hasProperties = false;
681679
for (const interactionValues of smValue.value) {
@@ -806,7 +804,7 @@ class AssetInterfaceDescriptionUtilTest {
806804
expect(hasProperties).to.equal(true);
807805
}
808806
}
809-
expect(hasInterfaceMetadata, "No InterfaceMetadata").to.equal(true);
807+
expect(hasInteractionMetadata, "No InteractionMetadata").to.equal(true);
810808

811809
// Test to use all possible prefixes -> in this case it is only https
812810
// Note: id is autogenerated (if not present) -> needs to be exluded/removed/set in TD
@@ -825,11 +823,11 @@ class AssetInterfaceDescriptionUtilTest {
825823
const smInterface = smObj.submodelElements[0];
826824
expect(smInterface).to.have.property("value").to.be.an("array").to.have.lengthOf.greaterThan(0);
827825

828-
// InterfaceMetadata with *no* properties for this protocol
829-
let hasInterfaceMetadata = false;
826+
// InteractionMetadata with *no* properties for this protocol
827+
let hasInteractionMetadata = false;
830828
for (const smValue of smInterface.value) {
831-
if (smValue.idShort === "InterfaceMetadata") {
832-
hasInterfaceMetadata = true;
829+
if (smValue.idShort === "InteractionMetadata") {
830+
hasInteractionMetadata = true;
833831
expect(smValue).to.have.property("value").to.be.an("array").to.have.lengthOf.greaterThan(0);
834832
for (const interactionValues of smValue.value) {
835833
if (interactionValues.idShort === "properties") {
@@ -838,7 +836,7 @@ class AssetInterfaceDescriptionUtilTest {
838836
}
839837
}
840838
}
841-
expect(hasInterfaceMetadata, "No InterfaceMetadata").to.equal(true);
839+
expect(hasInteractionMetadata, "No InteractionMetadata").to.equal(true);
842840
}
843841

844842
@test async "should correctly transform sample TD1 into JSON AAS"() {
@@ -866,8 +864,8 @@ class AssetInterfaceDescriptionUtilTest {
866864
{
867865
href: "modbus+tcp://127.0.0.1:60000/1",
868866
op: "readproperty",
869-
"modbus:function": "readCoil",
870-
"modbus:pollingTime": 1,
867+
"modv:function": "readCoil",
868+
"modv:pollingTime": 1,
871869
},
872870
],
873871
},
@@ -941,11 +939,11 @@ class AssetInterfaceDescriptionUtilTest {
941939
expect(hasThingTitle, "No thing title").to.equal(true);
942940
expect(hasEndpointMetadata, "No EndpointMetadata").to.equal(true);
943941

944-
// InterfaceMetadata with properties etc
945-
let hasInterfaceMetadata = false;
942+
// InteractionMetadata with properties etc
943+
let hasInteractionMetadata = false;
946944
for (const smValue of smInterface.value) {
947-
if (smValue.idShort === "InterfaceMetadata") {
948-
hasInterfaceMetadata = true;
945+
if (smValue.idShort === "InteractionMetadata") {
946+
hasInteractionMetadata = true;
949947
expect(smValue).to.have.property("value").to.be.an("array").to.have.lengthOf.greaterThan(0);
950948
let hasProperties = false;
951949
for (const interactionValues of smValue.value) {
@@ -995,10 +993,10 @@ class AssetInterfaceDescriptionUtilTest {
995993
hasOp = true;
996994
// Note: AID does not know "op"
997995
// expect(formEntry.value).to.equal("readproperty");
998-
} else if (formEntry.idShort === "modbus_function") {
996+
} else if (formEntry.idShort === "modv_function") {
999997
hasModbusFunction = true;
1000998
expect(formEntry.value).to.equal("readCoil");
1001-
} else if (formEntry.idShort === "modbus_pollingTime") {
999+
} else if (formEntry.idShort === "modv_pollingTime") {
10021000
hasModbusAddress = true;
10031001
expect(formEntry.value).to.equal("1");
10041002
expect(formEntry.valueType).to.equal("xs:int");
@@ -1023,7 +1021,7 @@ class AssetInterfaceDescriptionUtilTest {
10231021
expect(hasProperties).to.equal(true);
10241022
}
10251023
}
1026-
expect(hasInterfaceMetadata, "No InterfaceMetadata").to.equal(true);
1024+
expect(hasInteractionMetadata, "No InteractionMetadata").to.equal(true);
10271025
}
10281026

10291027
@test.skip async "should correctly transform counter TD into JSON AAS"() {

0 commit comments

Comments
 (0)