Skip to content
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

readProperty documentation fault #1344

Open
BinkertR opened this issue Jan 29, 2025 · 3 comments
Open

readProperty documentation fault #1344

BinkertR opened this issue Jan 29, 2025 · 3 comments

Comments

@BinkertR
Copy link

The API documentation of how to read a property is currently faulty.

current description is:

let read1 = await thing.readProperty("count");
console.info("count value is", read1);

but it is necessary to read the value like:

let read1 = await thing.readProperty("count");
let value = await read1.value()
console.info("count value is", value);
@danielpeintner
Copy link
Member

You are right, the MD files is out of date.

It needs more work.
e.g., on ExposedThing there is no thing.writeProperty() method anymore etc.

I wonder whether we should keep this document at all or rather point to something like https://thingweb.io/hands-on/articles/intro-raspberry

@relu91 @egekorkan

@egekorkan
Copy link
Member

I would keep this document and update it. This will be also rendered on the new website

@relu91
Copy link
Member

relu91 commented Jan 29, 2025

Yes, let's discuss the concrete steps in the next committer meeting. Meanwhile, we can merge #1345

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants