Add missing helper functions and logging

10-harp.rules

@@ -0,0 +1,3 @@
+# UDEV rules for a Harp Device (actually an ftdi RS232 Serial [Uart] IC)
+SUBSYSTEMS=="usb", ENV{.LOCAL_ifNum}="$attr{bInterfaceNumber}"
+SUBSYSTEMS=="usb", KERNEL=="ttyUSB*", ATTRS{idVendor}=="0403", ATTRS{idProduct}=="6001", MODE="0666", SYMLINK+="harp_device_%E{.LOCAL_ifNum}"

README.md

@@ -1,10 +1,16 @@
-
-
 # pyharp
 
 Harp implementation of the Harp protocol.
 
-## Edit the code
+## Install with Pip
+From this directory, install in editable mode with
+````
+pip install -e .
+````
+
+Note that for the above to work, a fairly recent version of pip (>= 21.3) is required.
+
+## Install with Poetry
 
 Each Python user has is own very dear IDE for editing. Here, we are leaving instructions on how to edit this code using pyCharm, Anaconda and Poetry.
 
@@ -69,3 +75,17 @@ Device info:
 * Firmware version: 1.0
 * Device user name: IBL_rig_0
 ```
+
+## 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/vibratome-controller/10-harp.rules /etc/udev/rules.d/10-harp.rules
+````
+
+Then reload udev rules with
+````
+sudo udevadm control --reload-rules
+````

examples/behavior_device_driver_test.py

@@ -0,0 +1,53 @@
+#!/usr/bin/env python3
+from pyharp.drivers.behavior import Behavior
+from pyharp.messages import HarpMessage
+from pyharp.messages import MessageType
+from struct import *
+import os
+
+
+# Open the device and print the info on screen
+# Open serial connection and save communication to a file
+device = None
+if os.name == 'posix': # check for Linux.
+    device = Behavior("/dev/harp_device_00", "ibl.bin")
+else: # assume Windows.
+    device = Behavior("COM95", "ibl.bin")
+
+print(f"digital inputs: {device.all_input_states:03b}")
+print(f"digital outputs: {device.all_output_states:016b}")
+print(f"setting digital outputs")
+#device.all_output_states = 0x0000 # Set the whole port directly.
+#device.set_outputs(0xFFFF) # Set the values set to logic 1 only.
+#device.clear_outputs(0xFFFF)# Clear values set to logic 1 only.
+print(f"digital outputs: {device.all_output_states:016b}")
+device.set_io_configuration(0b111)
+
+# TODO: FIXME. IOs are not working
+#device.set_io_configuration(0b111) # This is getting ignored?
+#device.set_io_outputs(0b000)
+#device.all_io_states = 0b000
+#print(f"digital ios: {device.all_io_states:03b}")
+
+#device.D0 = 0
+#print(f"D0: {device.D0}")
+#device.D0 = 1
+#print(f"D0: {device.D0}")
+#
+#device.D1 = 0
+#print(f"D1: {device.D1}")
+#device.D1 = 1
+#print(f"D1: {device.D1}")
+#
+#print(f"DI2: {device.DI2}")
+
+
+#import time
+#while True:
+#    print(f"PORT0 IN State:  {device.port0_i0}")
+#    print(f"PORT0 IO State:  {device.port0_io0}")
+#    print(f"PORT0 OUT State:  {device.port0_o0}")
+#    print(f"all port io states:     {device.all_port_io_states}")
+#    print(f"all port output states: {device.all_port_output_states}")
+#    print()
+#    time.sleep(0.1)

examples/check_device_id.py

@@ -1,7 +1,10 @@
+#!/usr/bin/env python3
 from pyharp.device import Device
 from pyharp.messages import HarpMessage
 from pyharp.messages import MessageType
+from pyharp.device_names import device_names
 from struct import *
+import os
 
 
 # ON THIS EXAMPLE
@@ -11,15 +14,19 @@
 
 
 # Open the device
-device = Device("COM95")                        # Open serial connection
+# Open serial connection
+if os.name == "posix": # check for Linux.
+    device = Device("/dev/harp_device_00")
+else: # assume Windows.
+    device = Device("COM95")
 
 # Get some of the device's parameters
 device_id = device.WHO_AM_I                     # Get device's ID
 device_id_description = device.WHO_AM_I_DEVICE  # Get device's user name
 device_user_name = device.DEVICE_NAME           # Get device's user name
 
 # Check if we are dealing with the correct device
-if device_id == 2080:
+if device_id in device_names:
     print("Correct device was found!")
     print(f"Device's ID: {device_id}")
     print(f"Device's name: {device_id_description}")

examples/get_info.py

@@ -1,7 +1,9 @@
-from pyharp.device import Device
+#!/usr/bin/env python3
+from pyharp.device import Device, DeviceMode
 from pyharp.messages import HarpMessage
 from pyharp.messages import MessageType
 from struct import *
+import os
 
 
 # ON THIS EXAMPLE
@@ -11,7 +13,13 @@
 
 
 # Open the device and print the info on screen
-device = Device("COM95", "ibl.bin")     # Open serial connection and save communication to a file
+# Open serial connection and save communication to a file
+if os.name == 'posix': # check for Linux.
+    #device = Device("/dev/harp_device_00", "ibl.bin")
+    #device = Device("/dev/ttyACM0")
+    device = Device("/dev/ttyUSB0")
+else: # assume Windows.
+    device = Device("COM95", "ibl.bin")
 device.info()                           # Display device's info on screen
 
 # Get some of the device's parameters
@@ -28,5 +36,9 @@
 device_harp_l = device.HARP_VERSION_L           # Get device's harp core version
 device_assembly = device.ASSEMBLY_VERSION       # Get device's assembly version
 
+reg_dump = device.dump_registers()
+for i in range(11):
+    print(reg_dump[i])
+
 # Close connection
-device.disconnect()
+device.disconnect()

examples/wait_for_events.py

@@ -0,0 +1,30 @@
+#!/usr/bin/env python3
+from pyharp.drivers.behavior import Behavior, Events
+from pyharp.messages import HarpMessage
+from pyharp.messages import MessageType
+from struct import *
+import os
+
+from pyharp.device import Device, DeviceMode
+
+
+# Open the device and print the info on screen
+# Open serial connection and save communication to a file
+device = None
+if os.name == 'posix': # check for Linux.
+    #device = Behavior("/dev/harp_device_00", "ibl.bin")
+    #device = Device("/dev/ttyACM0",)
+    device = Device("/dev/ttyUSB0",)
+else: # assume Windows.
+    device = Behavior("COM95", "ibl.bin")
+
+print("Setting mode to active.")
+# Mode will remain active for up to 3 seconds after CTS pin is brought low.
+device.set_mode(DeviceMode.Active)
+#device.disable_all_events()
+#device.enable_events(Events.port_digital_inputs)
+while True:
+    event_response = device._read() # read any incoming events.
+    if event_response is not None:# and event_response.address != 44:
+        print()
+        print(event_response)

examples/write_and_read_from_registers.py

@@ -1,7 +1,9 @@
+#!/usr/bin/env python3
 from pyharp.device import Device
 from pyharp.messages import HarpMessage
 from pyharp.messages import MessageType
 from struct import *
+import os
 
 
 # ON THIS EXAMPLE
@@ -12,26 +14,50 @@
 
 
 # Open the device and print the info on screen
-device = Device("COM95", "ibl.bin")     # Open serial connection and save communication to a file
+# Open serial connection and save communication to a file
+if os.name == 'posix': # check for Linux.
+    device = Device("/dev/harp_device_00", "ibl.bin")
+else: # assume Windows.
+    device = Device("COM95", "ibl.bin")
 
 # Read current analog sensor's higher threshold (ANA_SENSOR_TH0_HIGH) at address 42
-analog_threshold_h = device.send(HarpMessage.ReadU16(42).frame).payload_as_int()
-print(f"Analog sensor's higher threshold: {analog_threshold_h}")
-
-# Increase current analog sensor's higher threshold by one unit
-device.send(HarpMessage.WriteU16(42, analog_threshold_h+1).frame)
-
-# Check if the register was well written
-analog_threshold_h = device.send(HarpMessage.ReadU16(42).frame).payload_as_int()
-print(f"Analog sensor's higher threshold: {analog_threshold_h}")
-
-# Read 10 samples of the analog sensor and display the values
-# The value is at register STREAM[0], address 33
-analog_sensor = []
-for x in range(10):
-    value = device.send(HarpMessage.ReadS16(33).frame).payload_as_int()
-    analog_sensor.append(value & 0xffff)
-print(f"Analog sensor's values: {analog_sensor}")
+#analog_threshold_h = device.send(HarpMessage.ReadU16(42).frame).payload_as_int()
+#print(f"Analog sensor's higher threshold: {analog_threshold_h}")
+
+
+import time
+
+print(f"System time: {time.perf_counter():.6f}")
+data_stream = device.send(HarpMessage.ReadU8(33).frame) # returns a ReplyHarpMessage
+#data_stream = device.send(HarpMessage.ReadS16(33).frame).payload_as_int_array()
+print(f"Data Stream payload type: {data_stream.payload_type.name}")
+print(f"Data Stream message type: {data_stream.message_type.name}")
+print(f"Data Stream timestamp: {data_stream.timestamp}")
+print(f"Data Stream num bytes: {data_stream.length}")
+print(f"Data Stream payload: {data_stream.payload}")
+
+print(f"System time: {time.perf_counter():.6f}")
+event_reg_response = device.send(HarpMessage.ReadU8(77).frame) # returns a ReplyHarpMessage
+print(f"EVNT_ENABLE payload type: {event_reg_response.payload_type.name}")
+print(f"EVNT_ENABLE message type: {event_reg_response.message_type.name}")
+print(f"EVNT_ENABLE timestamp:    {event_reg_response.timestamp}")
+print(f"EVNT_ENABLE num bytes:    {event_reg_response.length}")
+print(f"EVNT_ENABLE payload:      {event_reg_response.payload[0]:08b}")
+
+## Increase current analog sensor's higher threshold by one unit
+#device.send(HarpMessage.WriteU16(42, analog_threshold_h+1).frame)
+#
+## Check if the register was well written
+#analog_threshold_h = device.send(HarpMessage.ReadU16(42).frame).payload_as_int()
+#print(f"Analog sensor's higher threshold: {analog_threshold_h}")
+#
+## Read 10 samples of the analog sensor and display the values
+## The value is at register STREAM[0], address 33
+#analog_sensor = []
+#for x in range(10):
+#    value = device.send(HarpMessage.ReadS16(33).frame).payload_as_int()
+#    analog_sensor.append(value & 0xffff)
+#print(f"Analog sensor's values: {analog_sensor}")
 
 # Close connection
-device.disconnect()
+device.disconnect()