-
Notifications
You must be signed in to change notification settings - Fork 8
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
Example TD and declarative protocol binding illustration - closes #90 #91
Conversation
@benfrancis |
@mlagally Please see #90 for an explanation for the purpose of the two different examples and why both are needed. You indicated in #81 (comment) that you agreed with this general approach. |
cefa5cb
to
cd63db6
Compare
I think this is pretty much complete now and ready for review. To recap, there are two example Thing Descriptions in this PR. The first Thing Description is provided at the start of the Core Profile Protocol Binding section and provides an example TD for the Web Thing which is used in all the examples in the protocol binding specification text. This Thing Description is in the concise form that a Web Thing conforming to the Core Profile is able to use due to all the defaults and assumptions implied by setting the The second example is an illustration of what that Thing Description would look like if the full protocol binding was instead provided declaratively in the Thing Description, without all of the defaults and assumptions implied by the profile member. The idea is to provide a concise Thing Description at the start to demonstrate what a conforming Web Thing would actually use in order to benefit from all of the defaults and assumptions, then an expanded form at the end which demonstrates what it would look like with all of those defaults and assumptions made explicit rather than being implied by the profile member. Some open points for discussion around the second (expanded) example:
|
I've updated the PR to move the second example (the declarative protocol binding example) to an appendix, since it is only an informative example to illustrate the benefits of the profiling mechanism and is not required for implementation. I've also improved the descriptions of the two examples because I wasn't happy with the wording. |
@benfrancis Please resolve the merge conflict. |
8e6123d
to
8f4b9d1
Compare
I've resolved the merge conflict, but these examples will require a re-think if #188 lands because events will be split out into a separate profile. |
Replaced by #195 |
This is an example Thing Description and corresponding declarative protocol binding to help illustrate the Core Profile Protocol Binding, as suggested in #90.
Preview | Diff
Preview | Diff