harp-protocol 0.2.0a1__py3-none-any.whl

harp_protocol-0.2.0a1.dist-info/METADATA

@@ -0,0 +1,88 @@
+Metadata-Version: 2.4
+Name: harp-protocol
+Version: 0.2.0a1
+Summary: Library for data acquisition and control of devices implementing the Harp protocol.
+Project-URL: Repository, https://github.com/fchampalimaud/pyharp/
+Project-URL: Bug Tracker, https://github.com/fchampalimaud/pyharp/issues
+Project-URL: Documentation, https://fchampalimaud.github.io/pyharp/
+Author-email: "Hardware and Software Platform, Champalimaud Foundation" <software@research.fchampalimaud.org>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: harp,python
+Requires-Python: <4.0,>=3.9
+Requires-Dist: pyserial>=3.5
+Description-Content-Type: text/markdown
+
+# pyharp
+
+Python implementation of the Harp protocol for hardware control and data acquisition.
+
+## Installation
+
+```bash
+uv add pyharp
+# or
+pip install pyharp
+```
+
+## Quick Start
+
+```python
+from pyharp import MessageType, PayloadType
+from pyharp.device import Device
+from pyharp.messages import HarpMessage
+
+# Connect to a device
+device = Device("/dev/ttyUSB0")
+#device = Device("COM3")  # for Windows
+
+# Get device information
+device.info()
+
+# define register_address
+register_address = 32
+
+# Read from register
+value = device.send(HarpMessage.create(MessageType.READ, register_address, PayloadType.U8))
+
+# Write to register
+device.send(HarpMessage.create(MessageType.WRITE, register_address, PayloadType.U8, value))
+
+# Disconnect when done
+device.disconnect()
+```
+
+or using the `with` statement:
+
+```python
+from pyharp import MessageType, PayloadType
+from pyharp.device import Device
+from pyharp.messages import HarpMessage
+
+with Device("/dev/ttyUSB0") as device:
+    # Get device information
+    device.info()
+
+    # define register_address
+    register_address = 32
+
+    # Read from register
+    value = device.send(HarpMessage.create(MessageType.READ, register_address, PayloadType.U8))
+
+    # Write to register
+    device.send(HarpMessage.create(MessageType.WRITE, register_address, PayloadType.U8, value))
+```
+
+## for Linux
+
+### Install UDEV Rules
+
+Install by either copying `10-harp.rules` over to your `/etc/udev/rules.d` folder or by symlinking it with:
+````
+sudo ln -s /absolute/path/to/10-harp.rules /etc/udev/rules.d/10-harp.rules
+````
+
+Then reload udev rules with
+````
+sudo udevadm control --reload-rules
+````

harp_protocol-0.2.0a1.dist-info/RECORD

@@ -0,0 +1,19 @@
+pyharp/communication/__init__.py,sha256=jsBSxOBlwyjPy5O5ntmCuUE1coo0XSE0BHia7qKQS_I,87
+pyharp/communication/device.py,sha256=x-LjC7ArC9LEGCPlj9rhflI3ic7ZFW_sD9OUFeAkD-M,34573
+pyharp/communication/harp_serial.py,sha256=vZKiI5oP9w2X7zUq8jc5B6BzMeWOh9oKQYODGGOs_dA,4725
+pyharp/devices/.gitignore,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pyharp/protocol/__init__.py,sha256=5ryzj5RZctLnvyCcgypVDq5N1obwhds-Vir7Q4Vmg10,35
+pyharp/protocol/base.py,sha256=PTgHrq3vydDckaoltURqMCDRaZU-yW8s1QOg8ZiuyXY,11600
+pyharp/protocol/device_names.py,sha256=9r3ZBVgeeT9vglepiufSuXbmVH3kTq2CowVoI_dAGeY,1500
+pyharp/protocol/exceptions.py,sha256=yC-Qs_Uf72pH6tfPqKRcUZGaVnBIm9QKIa1Be3DDwzo,104
+pyharp/protocol/messages.py,sha256=2Z061uacrukmvQrc6TrrNXG3EV14ccelL28bmj20JVc,18894
+pyharp.devices/pyharp.behavior/pyharp/devices/behavior/__init__.py,sha256=lpQO5qMQE8xWnP6ylitRh94HaC2tKbkQvDKPKWBKBlk,28
+pyharp.devices/pyharp.behavior/pyharp/devices/behavior/pyharpdevice.py,sha256=WDOoEB0FYTiKx8iwRguG31-Y-sjMzOlNMlqsB5P-jvw,66089
+pyharp.devices/pyharp.loadcells/pyharp/devices/loadcells/__init__.py,sha256=lpQO5qMQE8xWnP6ylitRh94HaC2tKbkQvDKPKWBKBlk,28
+pyharp.devices/pyharp.loadcells/pyharp/devices/loadcells/pyharpdevice.py,sha256=K1BccxC7imVhpKz71gkoEpciSKhYxHyV_wwbDYoEPNo,52030
+pyharp.devices/pyharp.olfactometer/pyharp/devices/olfactometer/__init__.py,sha256=lpQO5qMQE8xWnP6ylitRh94HaC2tKbkQvDKPKWBKBlk,28
+pyharp.devices/pyharp.olfactometer/pyharp/devices/olfactometer/pyharpdevice.py,sha256=oU6IyxRS-rVqQgp10UjG7twCoZCsgmsyJ8Ju0qa4V9I,55172
+harp_protocol-0.2.0a1.dist-info/METADATA,sha256=neQnXtaJE_0hHuLe93XWBEzOhJfAsnmssne7zrMfuo8,2260
+harp_protocol-0.2.0a1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+harp_protocol-0.2.0a1.dist-info/licenses/LICENSE,sha256=ish_WawV1WE7CaRCoiyvgwKWbPNtX1-q0cQOShnlSdE,1133
+harp_protocol-0.2.0a1.dist-info/RECORD,,

harp_protocol-0.2.0a1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

harp_protocol-0.2.0a1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Hardware and Software Platform, Champalimaud Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pyharp/communication/__init__.py

@@ -0,0 +1,2 @@
+from .device import Device as Device
+from .harp_serial import HarpSerial as HarpSerial