eclipse / editdor Goto Github PK

Thing Descriptions being generated out of Thing Models are keeping the title and id of the model. But typically you'll want different values for both fields. It would be nice to have to optional text boxes to define them in the "Generated TD from TM" dialog.

For the TM below which does not have forms in the affordances, there is a warning saying they are missing. This is not following the standard.

https://eclipse.github.io/editdor/?td=%7B%22%40context%22%3A%22https%3A%2F%2Fwww.w3.org%2F2019%2Fwot%2Ftd%2Fv1%22%2C%22title%22%3A%22ediTDor%20Thing%22%2C%22%40type%22%3A%22tm%3AThingModel%22%2C%22securityDefinitions%22%3A%7B%22nosec_sc%22%3A%7B%22scheme%22%3A%22nosec%22%7D%7D%2C%22security%22%3A%22nosec_sc%22%2C%22properties%22%3A%7B%22asd%22%3A%7B%22title%22%3A%22asd%22%2C%22observable%22%3Afalse%2C%22readOnly%22%3Afalse%7D%7D%2C%22actions%22%3A%7B%22dsf%22%3A%7B%22title%22%3A%22dsf%22%7D%7D%7D

When I create a new TD/TM by the assistance it would be good to get the option to select a number of context namespaces that may be integrated in the @context file. There can be a pre-defined list. If a context is not available manually input fields for prefix and namespace value can be provided.

We can start with a simple context list like schema.org, https://w3id.org/saref#, and http://www.ontology-of-units-of-measure.org/resource/om-2/

With @fexpal we have discussed the posibility to transfer TDs from Editdor to Playground and vice versa. TD Links in Playground are generated via https://www.npmjs.com/package/lz-string (also see eclipse-thingweb/playground#359) which has some advantages to usual URL encoding. A button can be placed that simply does the same encoding to the TD in the JSON Editor part and open a new tab with playground in it for future tests on the TD.

It might be also worthwhile to use the same compression here but we can do a more objective comparison first.

I was generating the implementation report for editdor and found the following problems when looking at TM to TD generation specifically:

• The pop up UI asks for "which placeholders to replace" even where there are no placeholders.
• tm:extends is not removed when the TD is generated. TD spec says:

If used, links element entry with "rel":"tm:extends" MUST be removed from the current Partial TD

• required affordances can be deselected and not carried over:

All required interactions (not listed in tm:optional) MUST be taken over to the Partial TD instance.

• tm:extends is not resolved. So the final TD does not have those:

Copy all definitions from the input Thing Model to the resulting Partial TD instance. If used, the extension and imports feature MUST be resolved and represented in the Partial TD instance according to 9.3.2 Extension and Import.

• TD generation fails in this specific case since the URL parsing fails:

{
    "@context": "https://www.w3.org/2019/wot/td/v1",
    "title": "ediTDor Thing",
    "@type": "tm:ThingModel",
    "securityDefinitions": {
        "nosec_sc": {
            "scheme": "nosec"
        }
    },
    "security": "nosec_sc",
    "properties": {
        "dim": {
            "title": "Dimming level",
            "type": "integer",
            "minimum": 0,
            "maximum": 100
        },
        "dim2": {
            "title": "Dimming level",
            "type": "integer",
            "minimum": 0,
            "maximum": 100
        }
    },
    "tm:optional": [
        "/properties/dim2"
    ]
}

This TM also is picked up as TD for some reason. It has correct @type

When a Thing Model is created, we still can use the share button, get a link and use it afterwards. When we use the resulting link and despite having the ""@type": "tm:ThingModel"" there is no convert to TD button in the new tab.
Example of a resulting link:
https://eclipse.github.io/editdor/?td=%7B%22%40context%22%3A%22https%3A%2F%2Fwww.w3.org%2F2019%2Fwot%2Ftd%2Fv1%22%2C%22title%22%3A%22ediTDor%20Thing%22%2C%22%40type%22%3A%22tm%3AThingModel%22%2C%22securityDefinitions%22%3A%7B%22nosec_sc%22%3A%7B%22scheme%22%3A%22nosec%22%7D%7D%2C%22security%22%3A%22nosec_sc%22%2C%22properties%22%3A%7B%7D%2C%22actions%22%3A%7B%7D%2C%22events%22%3A%7B%7D%7D

When clicked on save or save as, the files are prompted to be saved as untitled.txt . Firstly, TMs should use tm.jsonld and TDs td.jsonld and then for the filename, title or id can be used.

@sebastiankb shared this link in a github comment. When clicking it the browser refuses to follow it and return simpy URI too long.

I tried with Brave and Chrome. Platfrom Windows.

By checking the code of ediTDor support for required interaction affordances should be in place, but it doesn't appear to work on the deployed instance.

If I'm right, apparently the problem is that the last deployment took place 5 months ago.

Anyway, in the current demo deployment https://eclipse.github.io/editdor/ is not fully compliant with the current version of the Thing Description Working Draft.

• Feature request
• Nice to have

When adding new affordances or any user interaction with a pop-up window, it would be nice to have CTRL+Enter as a shortcut to click on the (mostly) blue button that is for adding/confirming (see the screenshot below)

A first version of a TM JSON Schema is available here.

All readme files and eclipse webpages that uses the term "Thing Description Template" shall be replaced by "Thing Model".

@kolotu will update the Eclipse webpage

@sebastiankb updates the readme file + the slides

As a User I want to have the option to add a property to the TD with a guided UI in order not to use a texteditor.

idea:
Use a popup window where you are able to add a Property with the mandatory fields and also to add forms if you like.

Converting a TM to TD and then trying to share it results in an error. The reason is that after converting the TM to TD, the resulting URL is used as a base URL to construct the sharing URL. Also sharing a TD/TM two times results in the same problem.

Asking for a New TM the resulting skeleton is being reported to be erroneous, though it looks good to me. The error message is also really weird "[...] should NOT be valid [...]" 🤨

Issue observed on currently deployed version 0.5.0.

How to reproduce it? Simply click on "New" and select "ThingModel" as type in the dialog without entering any other data.

See screenshot:

In a chat with @danielpeintner, @sebastiankb, and @wiresio , we discussed the possibility of swapping the place of the left and right windows since the current right-hand side is mainly used to create a TD. However, the intuition of some users might be to start from left.

In swagger editor or even latex editors, the output is on the right but those are really just the output. However, editdor excels at the creation of TDs and thus the workflow would make more sense in putting the interactable UI on the left side, making the TD a mere output. Given that this might be a change that some actually do not want, it would be nice to let users swap the place the order.

Using the new feature to visualize the links entries may result to text overflow in some boxes:

Maybe the text font size have to be reduced or the box has to be scaled to a larger size. Another option would be to cut off the text when it starts to overflow.

Sometimes you will copy a TD to the editor window such as http://plugfest.thingweb.io:8083/smart-coffee-machine

It would be nice if the TD could be formatted in a readable presentation.

I've started some tests to have auto-completion on @type. See vcharpenay/editdor-onto-integration.

Could you try to add the file schema.json to the editor and tell me if it has the expected behavior? Note that this is a preliminary test, where only a fixed list of labels are suggested for @type, regardless of a context and/or other annotations.

beside of the "Add new (top level) Form" there should be "Add new "Add new top level Link. There we could apply the new relation types that are currently introduced in the TD: w3c/wot-thing-description#1034

The rendered version can be seen here: https://pr-preview.s3.amazonaws.com/w3c/wot-thing-description/pull/1034.html#links-relation-types-values

The process should be also part in the assistance when creating a new TD / TM. E.g., it can be asked if a TD instance is an instance of a Thing Model or a Thing Model extends another Thing Model etc.

The JSON-LD playground allows to generate a permalink that associate an example that was created like here.

It would be cool to have the same feature for the ediTDor. This would help to exchange examples without copying the whole TD / TM somewhere.

As a User I want to have the possibility to sort the properties in order to get a better overview of all properties.

• First step would be to add a button that can sort them alphabetically.

• Second step could be to add a Drag and Drop option for the properties.

currently there is a label 'Add new Form'. It would be good to have more clear that this is a 'Add top level Form'.

It would be great if we have a area that provides some information about the TD / TM like the number of defined properties, actions and events, TD size in bytes etc. This information can be relevant when you design instances that should be stored on resource constrained devices.

Indentifiers --> Identifiers

The current version of the Thing Description Working Draft states:

The tm:ThingModel value of the top-level @type MUST to be replaced by the value Thing in the Partial TD instance.

but the current demo deployment https://eclipse.github.io/editdor/ is not doing so.

I haven't found any code taking care of that replacement, therefore I suppose that it isn't a deployment issue (like in the case of #74), but a missing feature.

when creating new TD it seems the the ID field is mandatory. However, it is optional.

One idea how this can be reflected: If there is an optional field and the user do not enter a value this field is not generated.

As a user I want to see all semantic enrichments of the TD in order to fully understand the Thing.

When a new form entry is created, it would be great if there is an assistance that ask you what kind of protocol you like to define (e.g., HTTP, MQTT, OPC UA, Modbus, ...). Depending of the selected protocol corresponding fields should be generated like for Modbus' the offset and length.

It would be good to have a place (footer position?) to see the current version of the ediTDor + a link to this github to report issues

I have to do a force refresh or clean the browser cache when I am sharing TDs as links. It is probably due to the change on how the links are created and something is using a cached version of something. We should either:

• Change the underlying mechanism
• Add a small warning to the pop up which currently says the following

Note: After cleaning the cache, the issue disappears for good but not everyone will do that. For someone opening the page for the first time, this is of course not a real issue.

When using "Generate to TD" feature, the masks says "Generate TM From TD". However it should be more "Generate TD From TM"

I think it would be nice that Editdor can generate defaults values for different parts of a TD. Playground has an open source package for doing that at https://www.npmjs.com/package/@thing-description-playground/defaults

Currently, the logo on the top left is just an image with no hyperlink behind it. It would be nice to point to the website itself so that I can easily open another instance of the website in another tab or window. Now I need to open a new tab and enter the URL.

• Minor improvement

When a TD is generated from a TM, it would be nice to generate at least some boilerplate forms objects with empty href and default content types

Using editdor via browser is fine and easy. However some aspects could be improved if it would also be available as a VS Code extension:

1. Working easier with local files
2. Working with other TDs and other files inside a bigger project
3. Source control (git) integration

For example, draw.io offers a web editor as well as a VS Code extension and also a desktop editor.

cc: @rhofer @fexpal

• Minor improvement

Currently, when I click on the Share button, a link for the TD/TM is automatically copied to the clipboard. I think this is mostly fine but then the pop-up window should be improved:

• More visual feedback that it is already copied. (see below for one option)
• The Share button in the pop-up has no real use. I think that a small animation can be played in the beginning saying "Link Copied" instead of "Share"
• Cancel should be replaced with Close since there is no way for the operation to be cancelled.

• nice to have

When I add a property, I choose a type that can have values of string, array, object etc. Currently, only this top-level type is manageable by the UI. This means that if I choose array or object as the type, I need to use the editor side to add more type description. It would be nice if I get an empty items or properties object.

For local connections, it would be great to try out the TD on the real thing/asset.

Provide some basic information about the Eclipse EdiTDor project. Copy the content from the "old" README file.

Terms that are mainly used in a Thing model context now always use the tm: prefix. That means,

• tm:ThingModel
• tm:extend
• tm:ref
• tm:required

Also see here.

There can be TDs that have similar affordances like turnOff and turnOn. With a text editor, I would write one and copy paste and edit for the second one. With editdor's right hand side, I cannot do this but have to resort to the text editor.

It is a nice to have but has impacts on usability/UX.

I wanted to add some dummy TDs/TMs linked to a TD/TM via the links container. The pop-up of the user interface tries to actually fetch the resource even if the resource is located at example.com or localhost. When it cannot find it, it shows an error but it is actually added to the interface and to the editor side. I would need to understand why the fetching functionality is needed but I think that the error message can be extended by saying that the resource could not be fetched but the link is actually added

For debugging and development purposes an online mode would be helpful.

Workflow:

1. Prepare a Thing Description for a certain device which is available on the network
2. Go online in editdor, which switches the view to a thing viewer mode
3. Execute the InteractionAffordances on the thing: read/write/observe properties, invoke actions, subscribe/unsubscribe to events and get notifications; and show the results
4. Also provide a log view to monitor what's happening on the wire.

Restrictions:

• Support only a few selected protocols, e.g. just http for the beginning.

This could also be a separate tool complementing editdor or a plugin to it.

It would be great if ediTDor could be split up into two standalone npm packages. One package for the viewer part and one providing the editor+viewer (analogue to swagger-ui and swagger-editor).

This would give us some greater flexibility:

• ediTDor could be used inside other projects
• the viewer could be used as a standalone component

I do see some difficulties in splitting up the components due to the usage of one global React Context. But a simpler solution could be to build only one ediTDor package and provide some configuration for hiding the editor part (something like a read only mode).

What do you all think about this idea?
Does anyone else have such requirements or might be interested in such a solution?