Merge pull request #3 from NitorCreations/bump

Bump pytelnetdevice, add example code

Author: Jalle19

.github/workflows/unittest.yaml

@@ -12,7 +12,7 @@ jobs:
     - name: Setup Python
       uses: actions/setup-python@v5
       with:
-        python-version: "3.11"
+        python-version: "3.13"
     - name: Install dependencies
       run: |
         pip install .

README.md

@@ -1,2 +1,47 @@
 # pylw3
-Lightware LW3 protocol library
+
+[![Tests](https://github.com/NitorCreations/pylw3/actions/workflows/unittest.yaml/badge.svg)](https://github.com/NitorCreations/pylw3/actions/workflows/unittest.yaml)
+[![Linting](https://github.com/NitorCreations/pylw3/actions/workflows/ruff.yaml/badge.svg)](https://github.com/NitorCreations/pylw3/actions/workflows/ruff.yaml)
+
+Lightware LW3 protocol library for controlling Lightware encoders and decoders.
+
+This library uses our [pytelnetdevice](https://github.com/NitorCreations/pytelnetdevice) library under the hood.
+
+## Usage
+
+This is just a basic example, explore the library to and the documentation for the LW3 protocol for your specific 
+device to learn more.
+
+```python
+import asyncio
+
+from pylw3 import LW3
+
+
+async def main():
+    # Connect to a VINX decoder and print the current input
+    decoder_device = LW3("10.211.0.23", 6107)
+    async with decoder_device.connection():
+        video_channel_id = await decoder_device.get_property("/SYS/MB/PHY.VideoChannelId")
+        print(video_channel_id)
+
+    # Connect to a VINX encoder and print whether signal is present
+    encoder_device = LW3("10.211.0.86", 6107)
+    async with encoder_device.connection():
+        signal_present = await encoder_device.get_property("/MEDIA/VIDEO/I1.SignalPresent")
+        print(signal_present)
+
+
+asyncio.run(main())
+```
+
+This will output something like:
+
+```
+9
+0
+```
+
+## License
+
+GNU GENERAL PUBLIC LICENSE version 3

examples/basic.py

@@ -0,0 +1,20 @@
+import asyncio
+
+from pylw3 import LW3
+
+
+async def main():
+    # Connect to a VINX decoder and print the current input
+    decoder_device = LW3("10.211.0.23", 6107)
+    async with decoder_device.connection():
+        video_channel_id = await decoder_device.get_property("/SYS/MB/PHY.VideoChannelId")
+        print(video_channel_id)
+
+    # Connect to a VINX encoder and print whether signal is present
+    encoder_device = LW3("10.211.0.86", 6107)
+    async with encoder_device.connection():
+        signal_present = await encoder_device.get_property("/MEDIA/VIDEO/I1.SignalPresent")
+        print(signal_present)
+
+
+asyncio.run(main())

pyproject.toml

@@ -10,9 +10,9 @@ classifiers = [
     "Operating System :: OS Independent",
     "Programming Language :: Python :: 3",
 ]
-requires-python = ">=3.11"
+requires-python = ">=3.13"
 dependencies = [
-    "pytelnetdevice @ git+https://github.com/NitorCreations/pytelnetdevice@ab5b48c"
+    "pytelnetdevice @ git+https://github.com/NitorCreations/pytelnetdevice@0.2.0"
 ]
 
 [tool.ruff]