homieiot / convention

🏡 The Homie Convention: a lightweight MQTT convention for the IoT
https://homieiot.github.io/
Other
715 stars 60 forks source link

Extension Convention #171

Closed EP-u-NW closed 5 years ago

EP-u-NW commented 5 years ago

As described in issue 170 I tried to come up with an idea, what an extension is and what it is allowed to do. This ideas are bundled in the homie extension convention.md document and need to be discussed.

As a second step I wrote a template document for extensions based on the extension principles (see file extension template.md). Again, as the extension principles change, this document should be revised.

Subsequently, I wrote the extension document for the concrete extension I want to realize (homie meta extension.md).

After that I though it would be nice to have a table listing all extensions, so I added known extensions.md.

Then I remembered issue 102 and thought it would be nice to try to realize a solution based on the extension template. As result, this pull request contains homie legacy stats extension.md and homie legacy firmware extension.md. Note that I imagined that the last two extensions could somehow be official extensions, so I chose The Homie Community as author and also used the reserved term homie in the extension ID.

I suggest to move all extension related things to a new branch, but it seems you can not do that using pull requests, so I decided to create a new folder instead.

Maybe all this is a bit much for a single pull request, so take your time reading it and happy discussion :)

davidgraeff commented 5 years ago

Pretty slick. Thanks for the PR. I have two general comments:

I'm happy with the template document and vote for a fast merge and revise later if necessary. All 3 extensions look complete.

EP-u-NW commented 5 years ago

Thanks for your answer! I'll comment your reviews. How would you suggest we should procced after that? Should I create a new pull request, which only contains the reviewed extensions and the template, and you will add the parts of extensions convention to the convention (as an ohter pull request)?

davidgraeff commented 5 years ago

I suggest you also modify the main convention in this PR, adding the license part to the extensions section and remove the sentence that says that extensions are listed in that section. I will add a link to the website later on, as soon as the website has been updated.

Edit: I have updated the website with an extensions page containing your "extensions convention" text and a short intro. I need to update the build script at some point to generate a list of all extensions in the documents directory and inject that into the extensions page. For now it is a static list.

davidgraeff commented 5 years ago

@Thalhammer @timpur

EP-u-NW commented 5 years ago

I would suggest we merge then. Then I can fix the hyperlinks (since I know the path then), and the remaining typos :)