spacemanspiff2007 / HABApp

Easy home automation with MQTT and/or openHAB
Apache License 2.0
54 stars 23 forks source link

Doc tweaks #364

Closed Dantenz closed 1 year ago

Dantenz commented 1 year ago

I tried to push some changes for PR, but it seems the repo is locked down - so here's a ticket.

I ran into some major headaches when trying to use the set_metadata() function. The documentation for the namespace parameter currently says "namespace", which isn't very useful. I ended up searching the internet for some time trying to find out what an acceptable value would be and in the end figured it out by playing around with the OpenHAB UI. My recommendations for change are:

docs/interface_openhab.rst

======================================
If referring to namespaces, a full list can be found in the `openHAB repo
<https://github.com/openhab/openhab-webui/blob/main/bundles/org.openhab.ui/web/src/assets/definitions/metadata/namespaces.js>`_.

.. automodule:: HABApp.openhab.interface
   :members:
   :imported-members:

openhab/connection_handler/func_sync.py


    """
    Add/set metadata to an item

    :param item_name: name of the item or item
    :param namespace: namespace, e.g. stateDescription
    :param value: value
    :param config: configuration, e.g. {"options": "A,B,C"}
    :return: True if metadata was successfully created/updated
    """
spacemanspiff2007 commented 1 year ago

Thanks for the hint - I'll incorporate it in the next change.

I tried to push some changes for PR, but it seems the repo is locked down - so here's a ticket.

It's not possible to fork it and create a PR?

Dantenz commented 1 year ago

It's not possible to fork it and create a PR?

I'll do that next time 👍

spacemanspiff2007 commented 1 year ago

Fixed in 1.1.0