Add support got signum ip to velbus gateway (#68)

* Add support for tls connection to signum

* Update with port formats

* update README

* Black format

* More format fixes

* More format fixes

* More format fixes

* Add 3.9 to pytest

* More formatting

Author: cereal2nd

.github/workflows/pythonTest.yml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [ '2.7', '3.6', '3.7', '3.8' ]
+        python-version: [ '2.7', '3.6', '3.7', '3.8', '3.9' ]
     name: Python ${{ matrix.python-version }} test
     steps:
       - name: Checkout

README.md

@@ -10,39 +10,12 @@ I would like to extend this module to support all Velbus modules, so feel free t
 
 API documentation is available [here](http://python-velbus.readthedocs.io/en/latest/)
 
-# Example usage
+# Port format
 
-The library currently only supports a serial connection to the Velbus controller (either through USB module or through RS-232 interface). In order to use the library, you need to first initialize the controller and can then send and receive messages on the Velbus. The library currently does not validate if a message is supported by a certain module (e.g., you can send a blind up message to a relay)
-
-```python
-import velbus
-import time
-
-# serial (or USB over serial) device connected to Velbus controller
-port = "/dev/ttyACM0"
-
-connection = velbus.VelbusUSBConnection(port)
-controller = velbus.Controller(connection)
-controller.subscribe(_on_message)
-
-# set module address
-module_address = 0xdc
-message = velbus.SwitchRelayOnMessage(module_address)
-
-channel_number = 1
-
-message.relay_channels = [channel_number]
-
-controller.send(message)
-
-def _on_message(received_message):
-    print("Velbus message received")
-    print(received_message.address)
-
-time.sleep(5)
-
-connection.stop()
-```
+There are 3 possible port formats:
+- /dev/ttyACME0             = A direct connection to a serial device (for vmbusb for example)
+- ip:port               = A connection to a TCP/IP port
+- tls://signum ip:27015   = A connection to a signum ip
 
 # Installation
 

velbus/connections/socket.py

@@ -4,6 +4,7 @@
 import time
 import threading
 import logging
+import ssl
 from queue import Queue
 import socket
 from velbus.connections.connection import VelbusConnection
@@ -18,7 +19,7 @@ class SocketConnection(VelbusConnection):
     :author: Maikel Punie <maikel.punie@gmail.com>
     """
 
-    def __init__(self, device, controller=None):
+    def __init__(self, device, controller=None, tls=False):
         VelbusConnection.__init__(self)
         self.logger = logging.getLogger("velbus")
         self._device = device
@@ -28,6 +29,12 @@ def __init__(self, device, controller=None):
         addr = (addr[0], int(addr[1]))
         try:
             self._socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+            if tls:
+                ctx = ssl._create_unverified_context()
+                sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+                self._socket = ctx.wrap_socket(sock)
+            else:
+                self._socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
             self._socket.connect(addr)
         except Exception:
             self.logger.error(

velbus/controller.py

@@ -38,7 +38,15 @@ def __init__(self, port):
         self._modules = {}
         self._loadModuleData()
         if ":" in port:
-            self.connection = SocketConnection(port, self)
+            print(port)
+            if port.startswith("tls://"):
+                print("tls")
+                print(port.replace("tls://", ""))
+                self.connection = SocketConnection(
+                    port.replace("tls://", ""), self, True
+                )
+            else:
+                self.connection = SocketConnection(port, self, False)
         else:
             self.connection = VelbusUSBConnection(port, self)