Added Loxone plattform #9706

JoDehli · 2017-10-05T20:18:10Z

Description:

First real integration of the Loxone Miniserver.

Example entry for `configuration.yaml` (if applicable):

#For the connection over Websocket to the Miniserver
loxone:
  username: !secret loxoneuser
  password: !secret loxonepassword
  host: 192.168.1.225
  port: 8080

#Simple analog sensor
sensor loxone:
  - platform: loxone
    uuid: "0dc8ca55-010c-1f6d-ffff403fb0c34b9e"
    unit_of_measurement: km/h
    sensorname: Windspeed
    sensortyp: InfoOnlyAnalog

#An automation example for sending values to the loxone with the loxone.event_websocket_command service
  - platform: template
    switches:
      plug_tv:
        friendly_name: ""
        value_template: "{{ is_state('sensor.plug_tv', 'on') }}"
        turn_on:
          service: loxone.event_websocket_command
          data:
            uuid: '0f14d364-00c4-63c2-ffff403fb0c34b9e'
            value: 'Pulse'
        turn_off:
          service: loxone.event_websocket_command
          data:
            uuid: '0f14d38c-0127-92a1-ffff403fb0c34b9e'
            value: 'Pulse'

Checklist:

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated in home-assistant.github.io

If the code communicates with devices, web services, or third-party tools:

Local tests with tox run successfully. Your PR cannot be merged unless tests pass
New dependencies have been added to the REQUIREMENTS variable (example).
script/gen_requirements_all.py.

homeassistant · 2017-10-05T20:18:12Z

Hi @JoDehli,

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

houndci-bot · 2017-10-05T20:18:19Z

homeassistant/components/loxone.py

+                      fields[1] + "-" + \
+                      fields[2] + "-" + \
+                      fields[3] + \
+                      fields[4]


continuation line over-indented for visual indent

houndci-bot · 2017-10-05T20:18:19Z

homeassistant/components/loxone.py

+            uuidstr = fields[0] + "-" + \
+                      fields[1] + "-" + \
+                      fields[2] + "-" + \
+                      fields[3] + \


continuation line over-indented for visual indent

houndci-bot · 2017-10-05T20:18:19Z

homeassistant/components/loxone.py

+            fields = event_uuid.urn.replace("urn:uuid:", "").split("-")
+            uuidstr = fields[0] + "-" + \
+                      fields[1] + "-" + \
+                      fields[2] + "-" + \


continuation line over-indented for visual indent

houndci-bot · 2017-10-05T20:18:19Z

homeassistant/components/loxone.py

+            event_uuid = uuid.UUID(bytes_le=packet[0:16])
+            fields = event_uuid.urn.replace("urn:uuid:", "").split("-")
+            uuidstr = fields[0] + "-" + \
+                      fields[1] + "-" + \


continuation line over-indented for visual indent

houndci-bot · 2017-10-05T20:18:19Z

homeassistant/components/loxone.py

+            _LOGGER.debug(parsed_data)
+            self._hass.bus.async_fire(EVENT, parsed_data)
+
+@asyncio.coroutine


expected 2 blank lines, found 1

houndci-bot · 2017-10-05T20:18:19Z

homeassistant/components/loxone.py

+        try:
+            if not self._ws:
+                self._ws = yield from wslib.connect(
+                    "ws://{}:{}/ws/rfc6455".format(self._host, self._port), timeout=5)


line too long (86 > 79 characters)

houndci-bot · 2017-10-05T20:18:20Z

homeassistant/components/loxone.py

+        :param device_uuid: Device id of a sensor or input
+        :param value: Value to be sent
+        """
+        yield from self._ws.send("jdev/sps/io/{}/{}".format(device_uuid, value))


line too long (80 > 79 characters)

houndci-bot · 2017-10-05T20:18:20Z

homeassistant/components/loxone.py

+        device_uuid = call.data.get(ATTR_UUID, DEFAULT)
+        yield from api.send_websocket_command(device_uuid, value)
+
+    hass.services.async_register(DOMAIN, 'event_websocket_command', handle_websocket_command)


line too long (93 > 79 characters)

houndci-bot · 2017-10-05T20:18:20Z

homeassistant/components/loxone.py

+        data = {device_uuid: value}
+        hass.bus.async_fire(EVENT, data)
+
+    hass.services.async_register(DOMAIN, 'event_bus_command', handle_event_bus_command)


line too long (87 > 79 characters)

houndci-bot · 2017-10-05T20:18:20Z

homeassistant/components/loxone.py

+
+import voluptuous as vol
+import homeassistant.helpers.config_validation as cv
+from homeassistant.const import (CONF_HOST, CONF_PORT, CONF_USERNAME, CONF_PASSWORD)


line too long (84 > 79 characters)

houndci-bot · 2017-10-05T20:42:03Z

homeassistant/components/loxone.py

+            event_uuid = uuid.UUID(bytes_le=packet[0:16])
+            fields = event_uuid.urn.replace("urn:uuid:", "").split("-")
+            uuidstr = fields[0] + "-" + fields[1] + "-" + fields[2] + "-" + \
+                      fields[3] + fields[4]


continuation line over-indented for visual indent

String formatting -> "".format()

JoDehli · 2017-10-05T20:49:23Z

Hello everybody,

can somebody help me to fix this errors? I think most of them are code styling problems.
I also need a documentation page on the github site of Home-Assistant. How do I do that.

Thanks for your help.

Jojo

fabaff

Just a couple of quick comments.

fabaff · 2017-10-06T07:18:45Z

homeassistant/components/sensor/loxone.py

+
+    def __init__(self, name, uuid, sensor_typ, unit_of_measurement):
+        """Initialize the sensor."""
+        self._state = 0.0


Set it to None and let Home Assistant handle the rest.

fabaff · 2017-10-06T07:19:02Z

homeassistant/components/sensor/loxone.py

+EVENT = 'loxone_received'
+
+_LOGGER = logging.getLogger(__name__)
+


Configuration validation is missing -> https://home-assistant.io/developers/code_review_platform/#3-configuration

fabaff · 2017-10-06T07:19:30Z

homeassistant/components/sensor/loxone.py

+Loxone simple sensor
+
+For more details about this platform, please refer to the documentation at
+https://home-assistant.io/components/loxone/


Needs to point to the sensor documentation.

fabaff · 2017-10-06T07:19:36Z

homeassistant/components/loxone.py

+            event_uuid = uuid.UUID(bytes_le=packet[0:16])
+            fields = event_uuid.urn.replace("urn:uuid:", "").split("-")
+            uuidstr = fields[0] + "-" + fields[1] + "-" + fields[2] + "-" + \
+                      fields[3] + fields[4]


String formatting -> "".format()

fabaff · 2017-10-06T07:20:12Z

homeassistant/components/loxone.py

+    """
+    key_dict = json.loads(key)
+    key_value = key_dict['LL']['value']
+    data = username + ":" + password


String formatting.

fabaff · 2017-10-06T07:20:42Z

homeassistant/components/loxone.py

+        :param user: Username to communicate with the Miniserver
+        :param password: Password of the user
+        :param host: Address where the Loxone Miniserver runs
+        :param port: Port of the Loxone Miniserver on the host


Please replace the parameter with a simple docstring.

fabaff · 2017-10-06T07:20:48Z

homeassistant/components/loxone.py

+    Main class for the communication with the miniserver
+    """
+
+    # pylint: disable=too-many-arguments, too-many-instance-attributes


Those are already disabled globally.

fabaff · 2017-10-06T07:20:50Z

homeassistant/components/loxone.py

+    """
+    Loxone Gateway
+    Main class for the communication with the miniserver
+    """


Please go for an one-line docstring.

fabaff · 2017-10-06T07:21:15Z

homeassistant/components/loxone.py

+_LOGGER = logging.getLogger(__name__)
+
+DOMAIN = 'loxone'
+DEFAULT_HOST = '127.0.0.1'


This doesn't make much sense. Or isn't the Miniserver an independent hardware unit only?

fabaff · 2017-10-06T07:23:25Z

homeassistant/components/loxone.py

+                                 CONF_PASSWORD)
+from homeassistant.helpers.event import async_track_time_interval
+
+REQUIREMENTS = ['websockets==3.2']


If needed then you could go with websockets 3.4. I guess that we haven't update the requirement because it's not heavily used.

fabaff · 2017-10-06T07:26:07Z

I also need a documentation page on the github site of Home-Assistant. How do I do that.

https://home-assistant.io/developers/website/

Please check the list in the PR template.

houndci-bot · 2017-10-06T15:45:56Z

homeassistant/components/loxone.py

+ATTR_UUID = 'uuid'
+ATTR_VALUE = 'value'
+
+@asyncio.coroutine


expected 2 blank lines, found 1

JoDehli · 2017-10-06T16:44:50Z

Hello fabaff,

can you help with the documentation and the errors for the "The Travis CI build"?
This is my first work with git and such tools.

Thanks in advance.

Jojo

fabaff

You need to pull the latest changes dev into your local branch and the run gen_requirements_all.py

Again, the checklist in the PR template is there to help.

fabaff · 2017-10-06T22:28:50Z

homeassistant/components/sensor/loxone.py

+CONF_SENSOR_TYP = 'sensortyp'
+CONF_UUID = 'uuid'
+
+CONFIG_SCHEMA = vol.Schema({


You have to extend the sensor validation. Get the details from the link I provided in the previous comment about the configuration validation.

fabaff · 2017-10-06T22:30:11Z

homeassistant/components/loxone.py

+                                 CONF_PASSWORD)
+from homeassistant.helpers.event import async_track_time_interval
+
+REQUIREMENTS = ['websockets==3.4']


You need to update the requirement of the other platform that uses websockets as well.

I think my biggest problem is that I do not know how to pull the latest changes from dev.
I tried it without a gui for github but I did not get it to work. Now I tried GitKraken. I fixed all of
the pylint issues. Maybe it is better you delete my pull request and I delete my fork. And I first try to get used with github and git.

And also I have big problems with the documentation page. But this is also a problem because I do not understand the github way to do it. I work personally with subversion and this is much easier for me. I believe that git is better but also more complicated.

fabaff · 2017-10-06T22:30:50Z

homeassistant/components/loxone.py

+    password = config[DOMAIN][CONF_PASSWORD]
+    host = config[DOMAIN][CONF_HOST]
+    port = config[DOMAIN][CONF_PORT]
+    api = LoxoneGateway(hass, user, password, host, port)


Will there be no exception if something is worn with the connection?

fabaff · 2017-10-06T22:34:46Z

homeassistant/components/loxone.py

+
+
+class LoxoneGateway:
+    """ Main class for the communication with the miniserver """


See PEP257 for details about proper docstrings and the docs about testing them.

…to loxone

houndci-bot · 2017-10-07T22:02:27Z

homeassistant/components/loxone.py

+            event_uuid = uuid.UUID(bytes_le=packet[0:16])
+            fields = event_uuid.urn.replace("urn:uuid:", "").split("-")
+            uuidstr = "{}-{}-{}-{}{}".format(fields[0], fields[1], fields[2],
+                                              fields[3], fields[4])


continuation line over-indented for visual indent

houndci-bot · 2017-10-07T22:02:28Z

homeassistant/components/loxone.py

+            event_uuid = uuid.UUID(bytes_le=packet[0:16])
+            fields = event_uuid.urn.replace("urn:uuid:", "").split("-")
+            uuidstr = "{}-{}-{}-{}{}".format(fields[0], fields[1], fields[2],
+                                              fields[3], fields[4])


continuation line over-indented for visual indent

andrey-git · 2017-10-10T05:36:57Z

homeassistant/components/loxone.py

+For more details about this component, please refer to the documentation at
+https://home-assistant.io/components/loxone/
+"""
+# pylint: disable=unused-import, too-many-lines


Do not disable pylint

andrey-git

Please add yourself as owner in https://github.com/home-assistant/home-assistant/blob/dev/CODEOWNERS for the new files.

The requirements files seem out of sync.

fabaff · 2017-10-13T22:18:27Z

Please exclude homeassistant/components/frontend/www_static/home-assistant-polymer from your commits.

JoDehli · 2017-10-14T06:45:21Z

Hello fabaff,
I want to delete my pull request. I can not get used to with git and git hub.
Can you delete the pull request. Than I delete my source. Maybe someone else will create a binding.

Thanks.

fabaff · 2017-10-23T10:00:45Z

I guess that you can close the PR by yourself.

Please consider to move forward with this PR as you are close to the finish line.

xAPPO · 2017-10-25T12:06:33Z

@JoDehli You sound frustrated but just to say I really do hope you persevere and successfully commit this into Home Assistant. I have a couple of Loxone servers and am really interested in this capability.
Kevin

JoDehli · 2017-10-25T17:22:21Z

Sorry but I deleted my repository. I switch to Node-Red. There you can find a good binding for the Loxone.
Git is too complicated for me ;-)

Added Loxone plattform

fcb13b0

homeassistant added new-platform integration: loxone platform: sensor.loxone labels Oct 5, 2017

homeassistant added the cla-needed label Oct 5, 2017

balloobbot added component platform labels Oct 5, 2017

houndci-bot reviewed Oct 5, 2017

View reviewed changes

homeassistant added cla-signed and removed cla-needed labels Oct 5, 2017

Fixed some code styling errors

4d2e80f

houndci-bot reviewed Oct 5, 2017

View reviewed changes

fabaff requested changes Oct 6, 2017

View reviewed changes

fabaff added the Hacktoberfest label Oct 6, 2017

JoDehli added 3 commits October 6, 2017 17:38

Fixed some styling issues

047a48d

Fixed some code styling issues

346cf2a

Fixed some code styling issues

71da53f

homeassistant added the cla-signed label Oct 6, 2017

balloobbot added the requirement label Oct 6, 2017

houndci-bot reviewed Oct 6, 2017

View reviewed changes

homeassistant/components/loxone.py Outdated

ATTR_UUID = 'uuid'

ATTR_VALUE = 'value'

@asyncio.coroutine

Copy link

houndci-bot Oct 6, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

expected 2 blank lines, found 1

Fixed some code styling issues

725a0bf

homeassistant added the cla-signed label Oct 6, 2017

fabaff reviewed Oct 6, 2017

View reviewed changes

Merge branch 'dev' into loxone

bdb0ba7

JoDehli requested a review from andrey-git as a code owner October 7, 2017 20:05

homeassistant added the cla-signed label Oct 7, 2017

JoDehli and others added 3 commits October 7, 2017 22:18

updated from dev

2e239fe

Merge branch 'loxone' of https://github.com/JoDehli/home-assistant in…

d36a411

…to loxone

Update loxone.py

66203c9

houndci-bot reviewed Oct 7, 2017

View reviewed changes

JoDehli added 5 commits October 8, 2017 09:01

fixed pylint errors

f090382

Fixed pylint errors

e0a13b6

Merge remote-tracking branch 'origin/loxone' into loxone

bc2252c

Fixed pylint issues.

2eaef85

Merge remote-tracking branch 'HomeAssistantUpstream/dev' into loxone

71de56d

andrey-git reviewed Oct 10, 2017

View reviewed changes

JoDehli added 8 commits October 11, 2017 21:29

Merge remote-tracking branch 'HomeAssistantUpstream/dev' into loxone

b8abbe8

Merge remote-tracking branch 'Home_Assistant_Main/dev' into loxone

cd08986

Merge remote-tracking branch 'Home_Assistant_Main/dev' into loxone

539285f

Merge remote-tracking branch 'origin/loxone' into loxone

139b81a

Uncommented pylint disable statement

9ec1485

Updated requirements.

a89edc2

EVENT_HOMEASSISTANT_STOP added

36942fc

Merge remote-tracking branch 'Home_Assistant_Main/dev' into loxone

4f147c1

Merge remote-tracking branch 'HomeAssistantUpstream/dev' into loxone

8833f71

JoDehli closed this Oct 25, 2017

home-assistant locked and limited conversation to collaborators Mar 3, 2018

ghost removed the platform: sensor.loxone label Mar 21, 2019

		EVENT = 'loxone_received'

		_LOGGER = logging.getLogger(__name__)



		class LoxoneGateway:
		""" Main class for the communication with the miniserver """

Added Loxone plattform #9706

Added Loxone plattform #9706

Conversation

JoDehli commented Oct 5, 2017 • edited

Description:

Example entry for configuration.yaml (if applicable):

Checklist:

homeassistant commented Oct 5, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JoDehli commented Oct 5, 2017

fabaff left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fabaff commented Oct 6, 2017

Choose a reason for hiding this comment

JoDehli commented Oct 6, 2017

fabaff left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

andrey-git left a comment

Choose a reason for hiding this comment

fabaff commented Oct 13, 2017

JoDehli commented Oct 14, 2017

fabaff commented Oct 23, 2017

xAPPO commented Oct 25, 2017

JoDehli commented Oct 25, 2017

JoDehli commented Oct 5, 2017 •

edited

Example entry for `configuration.yaml` (if applicable):