search

homieiot / convention

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

How to define/propose an extension? Concret: openHab label extension #170

Closed zocker1996 closed 5 years ago

zocker1996 commented 5 years ago

Is their a guide how to define an extension? What is an extension allowed to do?

Let me give you a concete example: I want to propose an extension, which allowes you to add openHab labels to nodes an properties. These labels can then automatically be processed by openHab and linked to the appropriate openHab items (for properties) / channel groups (for nodes). A simple way to add such labels would be to just create a new attribute "$openhab-label" for properties and nodes. For example: homie/super-car/engine/temperature/$openhab-label

What steps should I take to make an extension convention, what kind of information do I need to write down, is there a template?

davidgraeff commented 5 years ago

This is a primer, so there is no template yet. I would expect $type definitions and predefined properties and attribute values in such an extension. Maybe you give it a go as a PR to this repo? (Separate document)

If possible, make it independent of openHAB and think about the problem space and what you actually want to archive.

zocker1996 commented 5 years ago

I'll try to come up with an idea for a template and a general structure based on the original convention document.