From 46ceb3ff0b9417e86482b53b465ac28a2fbef4bb Mon Sep 17 00:00:00 2001 From: "Vignesh.Vaidyanathan" Date: Wed, 6 Nov 2024 14:17:40 +0100 Subject: [PATCH 1/3] update README --- README.md | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 08cce7b..1f4c874 100644 --- a/README.md +++ b/README.md @@ -314,20 +314,15 @@ See a list of currently supported possibilities while using this package [below] > You may use a script deployment/automation tool to remote stop and start servers, in an attempt to remotely control your hardware scripts. -### Looking for sponsorships - -Kindly read my message [in my GitHub profile](https://github.com/sponsors/VigneshVSV). - ### A little more about Usage One may use the HTTP API according to one's beliefs (including letting the package auto-generate it), but it is mainly intended for web development and cross platform clients like the interoperable [node-wot](https://github.com/eclipse-thingweb/node-wot) HTTP(s) client. If your plan is to develop a truly networked system, it is recommended to learn more and -se [Thing Descriptions](https://www.w3.org/TR/wot-thing-description11) to describe your hardware. A Thing Description will be automatically generated if absent as shown in JSON examples above or can be supplied manually. The default end point to -fetch thing descriptions are:
`http(s):////resources/wot-td`
+use [Thing Descriptions](https://www.w3.org/TR/wot-thing-description11) to describe your hardware (This is optional and one can still use a classic HTTP client). A Thing Description will be automatically generated if absent as shown in JSON examples above or can be supplied manually. The default end point to fetch thing descriptions are:
`http(s):////resources/wot-td`
If there are errors in generation of Thing Description (mostly due to JSON non-complaint types), one could use:
`http(s):////resources/wot-td?ignore_errors=true` -(client docs will be updated here next) +(client docs will be updated here next, also check official docs) ### Currently Supported From bdb60b4cb4dd8259b0bd195f26b625a0ef51e9ef Mon Sep 17 00:00:00 2001 From: "Vignesh.Vaidyanathan" Date: Thu, 21 Nov 2024 15:40:51 +0100 Subject: [PATCH 2/3] update readme --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 1f4c874..c6123a6 100644 --- a/README.md +++ b/README.md @@ -316,8 +316,7 @@ See a list of currently supported possibilities while using this package [below] ### A little more about Usage -One may use the HTTP API according to one's beliefs (including letting the package auto-generate it), but it is mainly intended for web development and cross platform clients -like the interoperable [node-wot](https://github.com/eclipse-thingweb/node-wot) HTTP(s) client. If your plan is to develop a truly networked system, it is recommended to learn more and +The HTTP API may be autogenerated or adjusted by the user. If your plan is to develop a truly networked system, it is recommended to learn more and use [Thing Descriptions](https://www.w3.org/TR/wot-thing-description11) to describe your hardware (This is optional and one can still use a classic HTTP client). A Thing Description will be automatically generated if absent as shown in JSON examples above or can be supplied manually. The default end point to fetch thing descriptions are:
`http(s):////resources/wot-td`
If there are errors in generation of Thing Description (mostly due to JSON non-complaint types), one could use:
`http(s):////resources/wot-td?ignore_errors=true` From 54a3bcb4373d07120e42a46badf15f13d5eb73d8 Mon Sep 17 00:00:00 2001 From: "Vignesh.Vaidyanathan" Date: Mon, 2 Dec 2024 15:18:45 +0100 Subject: [PATCH 3/3] update readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c6123a6..ceca05d 100644 --- a/README.md +++ b/README.md @@ -136,7 +136,7 @@ Those familiar with Web of Things (WoT) terminology may note that these properti }, ``` If you are not familiar with Web of Things or the term "property affordance", consider the above JSON as a description of -what the property represents and how to interact with it from somewhere else. Such a JSON is both human-readable, yet consumable by any application that may use the property, say a client provider to create a client object to interact with the property or a GUI application to autogenerate a suitable input field for this property. +what the property represents and how to interact with it from somewhere else. Such a JSON is both human-readable, yet consumable by any application that may use the property - say, a client provider to create a client object to interact with the property or a GUI application to autogenerate a suitable input field for this property. For example, the Eclipse ThingWeb [node-wot](https://github.com/eclipse-thingweb/node-wot) supports this feature to produce a HTTP(s) client that can issue `readProperty("integration_time")` and `writeProperty("integration_time", 1000)` to read and write this property. The URL path segment `../spectrometer/..` in href field is taken from the `instance_name` which was specified in the `__init__`.