From feac082df832579f7d504e48a2d75f619317075f Mon Sep 17 00:00:00 2001
From: Nicolas <Nicolas@nonan.net>
Date: Thu, 22 May 2025 14:36:35 +0200
Subject: [PATCH] test for readme example added

---
 .github/workflows/publish.yml | 35 +++++++++++++++++++++++++++++++++++
 tests/test_readme_example.py  | 24 ++++++++++++++++++++++++
 2 files changed, 59 insertions(+)
 create mode 100644 .github/workflows/publish.yml
 create mode 100644 tests/test_readme_example.py

diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
new file mode 100644
index 0000000..ae82350
--- /dev/null
+++ b/.github/workflows/publish.yml
@@ -0,0 +1,35 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  publish:
+    name: Build and publish
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Ensure this is main branch
+        if: github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/v')
+        run: echo "Proceeding with publish"
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install build tools
+        run: python -m pip install --upgrade build twine
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+        
+        run: python -m twine upload dist/*
diff --git a/tests/test_readme_example.py b/tests/test_readme_example.py
new file mode 100644
index 0000000..343581c
--- /dev/null
+++ b/tests/test_readme_example.py
@@ -0,0 +1,24 @@
+from pyhoff.devices import KL2404, KL2424, KL9100, KL1104, \
+    KL3202, KL4002, KL9188, KL3054, KL3214, KL4004, KL9010, BK9050
+
+
+def test_readme_example():
+    # connect to the BK9050 by tcp/ip on default port 502
+    bk = BK9050("172.16.17.1")
+
+    # add all bus terminals connected to the bus coupler
+    # in the order of the physical arrangement
+    bk.add_bus_terminals(KL2404, KL2424, KL9100, KL1104, KL3202,
+                         KL3202, KL4002, KL9188, KL3054, KL3214,
+                         KL4004, KL9010)
+
+    # Set 1. output of the first KL2404-type bus terminal to hi
+    bk.select(KL2404, 0).write_coil(1, True)
+
+    # read temperature from the 2. channel of the 2. KL3202-type
+    # bus terminal
+    t = bk.select(KL3202, 1).read_temperature(2)
+    print(f"t = {t:.1f} °C")
+
+    # Set 1. output of the 1. KL4002-type bus terminal to 4.2 V
+    bk.select(KL4002, 0).set_voltage(1, 4.2)