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.

Sign up for GitHub

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

Corections to meta extension #173

Merged
merged 2 commits into from
Jul 17, 2019
Merged

Corections to meta extension #173

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
172521e
Corrections to meta extension
arjanmels Jul 17, 2019
d200705
Swapped Alexa and Homekit keys
arjanmels Jul 17, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions extensions/documents/homie_meta_extension.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ License: **<!--LICENSE-->[CCA 4.0](https://homieiot.github.io/license)<!--LICENS
## Abstract
This extension defines how to add metadata and tags to devices, nodes and properties.

Tags are simple annotations that every device, node oder property can have.
Tags are simple annotations that every device, node or property can have.
Metadata on the other hand are more complex. They allow the definition of multiple *mainkeys* and *mainvalues* for each device, node or property.
Each main-key-value-pair may have nested sub-key-value-pairs.
Having metadata might be useful for Homie controllers.
Expand Down Expand Up @@ -58,10 +58,10 @@ For each element in the `$mainkey-ids` list, two nested attributes are **require
**Examples**
With respect to the previous example:
```java
homie/super-car/engine/temperature/$meta/0/$key → "HomeKit"
homie/super-car/engine/temperature/$meta/0/$value → "Fan.v2"
homie/super-car/engine/temperature/$meta/1/$key → "Alexa"
homie/super-car/engine/temperature/$meta/1/$value → "Fan"
homie/super-car/engine/temperature/$meta/alexa/$key → "HomeKit"
homie/super-car/engine/temperature/$meta/alexa/$value → "Fan.v2"
homie/super-car/engine/temperature/$meta/homekit/$key → "Alexa"
homie/super-car/engine/temperature/$meta/homekit/$value → "Fan"
```

Notice that in this example, the *mainkey ids* are *alexa* and *homekit*, but the actual key names are *Alexa* and *HomeKit*.
Expand Down Expand Up @@ -96,4 +96,4 @@ homie/super-car/engine/temperature/$meta/alexa/type/$key → "type"
homie/super-car/engine/temperature/$meta/alexa/type/$value → "oscillating"
homie/super-car/engine/temperature/$meta/alexa/step-speed/$key → "stepSpeed"
homie/super-car/engine/temperature/$meta/alexa/step-speed/$value → "3"
```
```