Skip to content

Add Node-WoT client example to README #73

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 19, 2025

Conversation

PFKimmerle
Copy link
Contributor

Adds a Node-WoT client usage example to the README.

Covers:

  • Fetching TD via HTTP(S)
  • Creating a consumedThing
  • read/write property, invoke action, subscribe to event
  • Uses collapsible details blocks
  • Reference to verified examples

Fixes #68

Adds a README section showing how to use Node-WoT to consume Thing Descriptions from a hololinked server. Includes examples for reading/writing properties, invoking actions, and subscribing to events. Based on verified examples.
@VigneshVSV
Copy link
Collaborator

VigneshVSV commented Apr 18, 2025

Hi @PFKimmerle,

thanks a lot for this contribution and taking your time to do so!

Its already looking good.

I have made some comments, only to optimize them. You can work on them if you have time, otherwise let me know, I will merge it to another branch and make these small edits!

Its not extremely urgent, so take your time.

@VigneshVSV VigneshVSV self-assigned this Apr 18, 2025
@VigneshVSV VigneshVSV moved this to In review in hololinked Apr 18, 2025
- Section renamed & reordered	
- Thing Description URLs added	
- Online example URL + buffer warning	
- Example code with details block	
- React useEffect/useContext usage + links	
- HTTPS self-signed example added	
- readProperty async/await fix + explanation
@VigneshVSV VigneshVSV merged commit 45d46a5 into hololinked-dev:main Apr 19, 2025
2 checks passed
@github-project-automation github-project-automation bot moved this from In review to Done in hololinked Apr 19, 2025
@VigneshVSV
Copy link
Collaborator

VigneshVSV commented Apr 19, 2025

Hi @PFKimmerle,

I merged this to main, as you can see. Thanks a lot!

I also made some minor edits in my own branch as lot of review on details may also not be very effective.

You can see it here: https://github.com/hololinked-dev/hololinked/tree/updates?tab=readme-ov-file#using-apis-and-thing-descriptions

Just let me know if you object to anything. If not, I will merge that branch. Mainly, I kept changes from both your commits, and removed duplicate information.

Vignesh

VigneshVSV added a commit that referenced this pull request Apr 25, 2025
* fast forward doc and examples
* add contributing section in README
* allow class_member set only for class member parameters
* add Zenodo link
* Add Node-WoT client example to README (#73)
* add main-next-release to test workflows, & some minor generic updates (#75)
* resolve issue/69 (#76)
---------

Co-authored-by: Patricia Kimmerle <159075491+PFKimmerle@users.noreply.github.com>
Co-authored-by: Marcusfam-RB <71035055+Marcusfam-RB@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Add Thingweb client examples in top level README
2 participants