Skip to content

Semantic ConsumedThing part of Scripting APIΒ #527

Open
@danielpeintner

Description

@danielpeintner

With the current Scripting API one can interact with a ConsumedThing by knowing the interaction name, e.g., readProperty("temp"). If the interaction name is "temperature" instead of "temp" this needs to be updated accordingly.

Hence, what the current API does not offer is to interact with a thing based on the semantics attached to it like "read the temperature" no matter how the resource is named.

A possible addition to the current API could be to add a semantic layer around ConsumedThing that allows to ask for the temperature in a way that is independent of the interaction name, e.g, readSemanticProperty("iot:Temperature")

class SemanticConsumedThing extends ConsumedThing {

  readSemanticProperty(semanticType: string, options?: WoT.InteractionOptions): Promise<WoT.InteractionOutput> {
    // look for @type": "iot:Temperature" and call it based on the interaction name as of today
  }

  ...
}

The reason why I created this issue

  • I am wondering whether a SemanticConsumedThing API should be specified or left as an extension to implementations. In node-wot we have a VERY early version
  • Does it even make sense to standardize this behaviour? The benefit I see is that we could really say we can offer scripts that work across different vendors since any vendor is free to use any interaction name as long as the interaction is properly semantically typed

Note: There are many open points/questions. I just would like to get a first feedback about the feasibility to specify this.

Metadata

Metadata

Assignees

No one assigned

    Labels

    API-improvementSuggestions for changing the API

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions