racs-python 0.0.1__tar.gz → 0.2.0__tar.gz

{racs_python-0.0.1 → racs_python-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: racs-python
-Version: 0.0.1
+Version: 0.2.0
 Summary: Client library to access racs api server
 Author-email: Jonas Ahlf <javerik@javerik.space>
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -345,7 +345,7 @@ License:                     GNU GENERAL PUBLIC LICENSE
         
 Project-URL: Homepage, https://codeberg.org/javerik/RACS-RustAravisCamServe
 Project-URL: Bug Tracker, https://codeberg.org/javerik/RACS-RustAravisCamServe/issues
-Keywords: racs,aravis,camera,client,api
+Keywords: racs,aravis,camera,client,api,genicam,gev,gigevision
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
 Classifier: Operating System :: OS Independent
@@ -355,3 +355,49 @@ License-File: LICENSE
 Requires-Dist: requests>=2.31
 Requires-Dist: pydantic>=2.0
 Dynamic: license-file
+
+# RACS python client library
+
+Simple client which uses `requests` to interact with the [racs-api server](https://codeberg.org/javerik/RACS-RustAravisCamServe).
+
+## Install
+
+```shell
+pip install racs-python
+```
+
+## Usage
+
+> **Make sure an instance of racs-api server is running**
+
+```python
+from racs_python import RacsClient
+
+client = RacsClient("http://localhost:8742/api/v1")
+
+# discover devices
+devices = client.get_devices()
+print(f"Found {len(devices.available)} available devices.")
+
+if devices.available:
+        target_id = devices.available[0].id
+        
+        # 2. Connection
+        client.connect_device(target_id)
+        print(f"Connected to device {target_id}")
+
+        # 3. Read/Write Settings
+        width = client.get_device_gc_node_value(target_id, "Width")
+        print(f"Current Width: {width}")
+        
+        client.set_device_gc_node_value(target_id, "Width", "1920")
+
+        # 4. Grab an image
+        jpg_data = client.grab_jpg_frame(target_id)
+        with open("frame.jpg", "wb") as f:
+            f.write(jpg_data)
+
+        # 5. Cleanup
+        client.disconnect_device(target_id)
+
+```

racs_python-0.2.0/README.md

@@ -0,0 +1,45 @@
+# RACS python client library
+
+Simple client which uses `requests` to interact with the [racs-api server](https://codeberg.org/javerik/RACS-RustAravisCamServe).
+
+## Install
+
+```shell
+pip install racs-python
+```
+
+## Usage
+
+> **Make sure an instance of racs-api server is running**
+
+```python
+from racs_python import RacsClient
+
+client = RacsClient("http://localhost:8742/api/v1")
+
+# discover devices
+devices = client.get_devices()
+print(f"Found {len(devices.available)} available devices.")
+
+if devices.available:
+        target_id = devices.available[0].id
+        
+        # 2. Connection
+        client.connect_device(target_id)
+        print(f"Connected to device {target_id}")
+
+        # 3. Read/Write Settings
+        width = client.get_device_gc_node_value(target_id, "Width")
+        print(f"Current Width: {width}")
+        
+        client.set_device_gc_node_value(target_id, "Width", "1920")
+
+        # 4. Grab an image
+        jpg_data = client.grab_jpg_frame(target_id)
+        with open("frame.jpg", "wb") as f:
+            f.write(jpg_data)
+
+        # 5. Cleanup
+        client.disconnect_device(target_id)
+
+```

{racs_python-0.0.1 → racs_python-0.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "racs-python"
-version = "0.0.1"
+version = "0.2.0"
 authors = [
     { name="Jonas Ahlf", email="javerik@javerik.space" },
 ]
@@ -25,7 +25,7 @@ classifiers = [
     "Operating System :: OS Independent",
 ]
 
-keywords = ["racs", "aravis", "camera", "client", "api"]
+keywords = ["racs", "aravis", "camera", "client", "api", "genicam", "gev", "gigevision"]
 
 [project.urls]
 "Homepage" = "https://codeberg.org/javerik/RACS-RustAravisCamServe"

{racs_python-0.0.1 → racs_python-0.2.0}/src/racs_python/client.py

@@ -1,5 +1,5 @@
 import requests
-from typing import List
+from typing import List, Optional
 from .models import DeviceConnections, GenICamNodeCategory
 
 
@@ -35,18 +35,24 @@ class RacsClient:
 
     def get_devices(self) -> DeviceConnections:
         """
-        Discovers devices in network and shows connected devices.
+        Discovers devices in the network and shows connected devices.
         GET /devices
         """
         response = self._get("/devices")
         return DeviceConnections.model_validate(response.json())
 
-    def connect_device(self, device_id: int) -> None:
+    def connect_device(self, device_id: int, ip: Optional[str] = None) -> None:
         """
         Connect to a specific device.
+
+        Can connect to a device by specifying the IP address. The device_id has to be set as well, which will is needed for later operations.
+
         PUT /devices/{id}/connect
         """
-        self._put(f"/devices/{device_id}/connect")
+        if ip is not None:
+            self._put(f"/devices/{device_id}/connect", params={"ip": ip})
+        else:
+            self._put(f"/devices/{device_id}/connect")
 
     def disconnect_device(self, device_id: int) -> None:
         """
@@ -100,6 +106,8 @@ class RacsClient:
     def grab_jpg_frame(self, device_id: int) -> bytes:
         """
         Grab a single frame as JPEG.
+
+        PixelFormat is automatically set to MONO_8
         GET /devices/{id}/stream/frame/jpeg
         """
         response = self._get(f"/devices/{device_id}/stream/frame/jpeg")

{racs_python-0.0.1 → racs_python-0.2.0}/src/racs_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: racs-python
-Version: 0.0.1
+Version: 0.2.0
 Summary: Client library to access racs api server
 Author-email: Jonas Ahlf <javerik@javerik.space>
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -345,7 +345,7 @@ License:                     GNU GENERAL PUBLIC LICENSE
         
 Project-URL: Homepage, https://codeberg.org/javerik/RACS-RustAravisCamServe
 Project-URL: Bug Tracker, https://codeberg.org/javerik/RACS-RustAravisCamServe/issues
-Keywords: racs,aravis,camera,client,api
+Keywords: racs,aravis,camera,client,api,genicam,gev,gigevision
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
 Classifier: Operating System :: OS Independent
@@ -355,3 +355,49 @@ License-File: LICENSE
 Requires-Dist: requests>=2.31
 Requires-Dist: pydantic>=2.0
 Dynamic: license-file
+
+# RACS python client library
+
+Simple client which uses `requests` to interact with the [racs-api server](https://codeberg.org/javerik/RACS-RustAravisCamServe).
+
+## Install
+
+```shell
+pip install racs-python
+```
+
+## Usage
+
+> **Make sure an instance of racs-api server is running**
+
+```python
+from racs_python import RacsClient
+
+client = RacsClient("http://localhost:8742/api/v1")
+
+# discover devices
+devices = client.get_devices()
+print(f"Found {len(devices.available)} available devices.")
+
+if devices.available:
+        target_id = devices.available[0].id
+        
+        # 2. Connection
+        client.connect_device(target_id)
+        print(f"Connected to device {target_id}")
+
+        # 3. Read/Write Settings
+        width = client.get_device_gc_node_value(target_id, "Width")
+        print(f"Current Width: {width}")
+        
+        client.set_device_gc_node_value(target_id, "Width", "1920")
+
+        # 4. Grab an image
+        jpg_data = client.grab_jpg_frame(target_id)
+        with open("frame.jpg", "wb") as f:
+            f.write(jpg_data)
+
+        # 5. Cleanup
+        client.disconnect_device(target_id)
+
+```