Merge pull request #98 from MrClock8163/feature/socket-connection

Add support for socket based connections

Author: MrClock8163

.github/workflows/run-tests.yml

@@ -8,6 +8,7 @@ env:
   GEOCOMPY_TEST_PORT_CLIENT: /tmp/geocompy_pty_client
   GEOCOMPY_TEST_PORT_SERVER: /tmp/geocompy_pty_server
   GEOCOMPY_TEST_PORT_FAULTY: /tmp/geocompy_pty_faulty
+  GEOCOMPY_TEST_TCPPORT_SERVER: 12345
 
 jobs:
   testing:
@@ -30,6 +31,7 @@ jobs:
         run: |
           socat pty,raw,echo=0,link=$GEOCOMPY_TEST_PORT_CLIENT pty,raw,echo=0,link=$GEOCOMPY_TEST_PORT_SERVER &
           python tests/com_echo_server.py &
+          python tests/tcp_echo_server.py &
 
       - name: Test with pytest
         run: |

CHANGELOG.md

@@ -10,9 +10,22 @@ The project uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 ### Added
 
 - Added support for checksums in GeoCOM transactions
+- Added `SocketConnection` to allow socket based communication
+- Added `open_socket` function to create TCP and RFCOMM socket connections
 
 ## Changed
 
+- Changed the `Connection` interface definition to require `send_binary`,
+  `receive_binary` and `exchange_binary` methods
+- Changed `open_serial` to raise `ConnectionRefusedError` instead of the
+  original exception when the connection could not be opened
+- Changed all methods of `SerialConnection` to raise the general
+  `ConnectionEror` and `TimeoutError` instead of serial specific
+  `SerialException` and`SerialTimeoutException`
+- Changed `GeoCom` init to raise `ConnectionRefusedError` instead of
+  `ConnectionError` when the connection could not be verified
+- Changed `GsiOnlineDNA` init to raise `ConnectionRefusedError` instead of
+  `ConnectionError` when the connection could not be verified
 - Updated GeoCOM response parsing to raise exception when the number of
   received paramters does not match the number of parsers specified
 - Updated `GeoCom` init signature to require keyword arguments

docs/connections.rst

@@ -256,6 +256,37 @@ If the whole process was successful, the device will be accessible on the
     They have to be recreated after every restart either manually, or with
     a startup script.
 
+Internet
+--------
+
+The newest instruments (in addition to Bluetooth) also come with WLAN support.
+This enables connections through TCP/IP. 
+
+.. note::
+
+    In case of Leica instruments and GeoCOM, the GeoCOM interface on the
+    instrument might have to be manually switched to WLAN mode
+    before initiating a connection.
+
+To initiate a connection through internet sockets, the instrument and the
+controlling computer must be connected to the same WLAN.
+
+.. tip::
+
+    The IP address and TCP port number of the instrument can be checked in the
+    control menu of the connection settings on the instrument.
+
+.. code-block:: python
+    :caption: Connection through TCP/IP over WLAN
+    :linenos:
+
+    from geocompy import open_socket
+
+
+    with open_socket("192.168.0.1", 1212, "tcp") as soc:
+        soc.send("some message")
+
+
 Simulators
 ----------
 

src/geocompy/__init__.py

@@ -60,6 +60,9 @@
 ``geocompy.communication.open_serial``
     Serial connection context manager function.
 
+``geocompy.communication.open_socket``
+    Socket connection context manager function.
+
 ``geocompy.gsi.dna.GsiOnlineDNA``
     DNA instrument implementation.
 
@@ -86,7 +89,10 @@
     Coordinate as Coordinate
 )
 
-from .communication import open_serial as open_serial  # noqa: F401
+from .communication import (  # noqa: F401
+    open_serial as open_serial,
+    open_socket as open_socket
+)
 
 from .gsi.gsitypes import GsiOnlineResponse as GsiOnlineResponse  # noqa: F401
 from .gsi.dna import GsiOnlineDNA as GsiOnlineDNA  # noqa: F401