Relevant Payload Selection in (JSON) Payloads

[egekorkan]

Identifier

relevant payload selection

Submitter Contact Information

@egekorkan

Main Stakeholder (As a...)

Device Manufacturer

Other Stakeholders

gateway manufacturer/developer

Stakeholder Details

• Philips Hue would be an example
• WebThings gateway would be an example

Capability (I need...)

to indicate the relevant or interesting part of a payload on the wire

Capability Details

• Can be thought like the anchor in a link
• A JSON Payload on the wire such as {value:12} or {temperature:12, timestamp:56} would be modeled as an object but actually interesting part for the Consumer application is just value or temperature, respectively. So I want to say that the data schema is just a number and not an object
• This can be the case for all payloads, i.e. all of them are following the value pattern
• It would be interesting to model a single payload as multiple affordances, e.g. if there is a sensors property with a payload {temperature:12, humidity:56}, we can have two affordances, each pointing to one part of the payload.
• The point above exists in protocols like Modbus a lot. It can be that 2 Modbus registers contain values about 8 different alarms. So if we split this to 8 different properties, each form needs to point to the relevant part of the 2 registers.

Purpose (so that...)

the Consumer applications can automatically pick the relevant section and present to its users

Purpose Details

No response

Motivating Use Cases

• https://w3c.github.io/wot-usecases/#UC-leaving-and-coming-home-1 (anything with ECHONET)
• https://w3c.github.io/wot-usecases/#UC-home-wot-devices-synchronize-to-tv-programs-1 (mentions Philips Hue)
• https://w3c.github.io/wot-usecases/#UC-education-shared-devices-1
• https://github.com/w3c/wot-thing-description/blob/main/planning/work-items/analysis/analysis-data-mapping.md