HomeMatic GQLS (Graph Query Language Service)

This Flask-based wrapper of the great homematicip-rest-api <https://github.com/coreGreenberet/homematicip-rest-api>_ can be used to integrate with various other gateways that allow for a GraphQL access.

.. image:: https://repository-images.githubusercontent.com/288663383/6ccbd800-f080-11ea-8c04-dd17821a7334 :height: 100px :width: 200 px :scale: 50 %

.. note:: This is a very first version. As of now, the model only supports TemperatureHumiditySensorDisplay and ShutterContact, as these are those sensors that I have in use right now. However this could be easily extended.

Setup ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

#. Clone this repo .. code-block::

    git clone https://github.com/martin-riedl/homematic-gqls

#. Obtain authtoken from Homematic IP Cloud #. Follow the instructions from homematicip-rest-api <https://github.com/coreGreenberet/homematicip-rest-api>_ to obtain an authtoken for your homematicIP cloud account (hereby a file config.ini is created). #. Copy the resulting file config.ini into the main directory of this repository.

#. Install the requirements .. code-block::

    pip3 install -r requirements --user

#. Start the server .. code-block::

    python3 server.py

Serving via HTTP ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

GraphQL can serve over http <httphttps://graphql.org/learn/serving-over-http/>_ via GET and POST requests.

A POST request using curl

.. code-block::

curl -X POST localhost:8191/graphql -H "Content-Type: application/json" --data '{"query":"{shuttercontacts{windowState}}"}'

or using a filter on the label

.. code-block::

curl -X POST localhost:8191/graphql -H "Content-Type: application/json" --data '{"query":"{shuttercontacts_filtered (label_filter : "mylabelorempty") {label windowState}}"}'

A GET request using curl

.. code-block::

curl -X GET localhost:8191/graphql?query=%7Bshuttercontacts%7BwindowState%7D%7D

Include in OpenHAB ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

For further information see OpenHAB HTTP Binding <https://www.openhab.org/addons/bindings/http1/>_.

A request via HTTP GET which refreshes each 60k ms may look as follows:

.. code-block::

String windowstatus "WindowStatus [%s]" { http="<[http://myhost:8191/graphql?query=%%7Bshuttercontacts%%7BwindowState%%7D%%7D:8191:JSONPATH($.data.shuttercontacts[0].windowState)]" }

Docker ^^^^^^^^^^^^

Building the image:

.. code-block:: bash

docker build --tag hmgqls .

Running the container (bound to localhost on the host):

.. code-block:: bash

docker run -p 8191:8191 -d --restart unless-stopped --name hmgqls hmgqls

And check in the browser to see the Playground UI <http://localhost:5000/graphql>_.

Or query a specific device, e.g. http://localhost:8191/graphql?query={shuttercontacts{windowState}}