Add Python test script using pywinusb for the Class Driver Generic HID Device demo application.

2 files changed, 93 insertions, 0 deletions

diff --git a/Demos/Device/ClassDriver/GenericHID/HostTestApp/test_generic_hid.py b/Demos/Device/ClassDriver/GenericHID/HostTestApp/test_generic_hid.py
new file mode 100644
index 000000000..f04892a06
--- /dev/null
+++ b/Demos/Device/ClassDriver/GenericHID/HostTestApp/test_generic_hid.py
@@ -0,0 +1,92 @@
+"""
+             LUFA Library
+     Copyright (C) Dean Camera, 2013.
+
+  dean [at] fourwalledcubicle [dot] com
+           www.lufa-lib.org
+"""
+
+"""
+    LUFA Generic HID device demo host test script. This script will send a
+    continuous stream of generic reports to the device, to show a variable LED
+    pattern on the target board. Send and received report data is printed to
+    the terminal.
+
+    Requires the pywinusb library (https://pypi.python.org/pypi/pywinusb/).
+"""
+
+import sys
+from time import sleep
+import pywinusb.hid as hid
+
+
+def get_hid_device_handle(VID, PID):
+    hid_device_filter = hid.HidDeviceFilter(vendor_id = VID, product_id = PID)
+    valid_hid_devices = hid_device_filter.get_devices()
+
+    if len(valid_hid_devices) is 0:
+        return None
+    else:
+        return valid_hid_devices[0]
+
+
+def send_led_pattern(device, led1, led2, led3, led4):
+    # Length of the report: one byte for the report ID, remainder is the
+    # payload length as set in the demo
+    generic_report_size = 1 + 8
+
+    # Report data for the demo is the report ID (always zero) followed by the
+    # LED on/off data
+    report_data = [0, led1, led2, led3, led4]
+
+    # Zero-extend the array to the length the report should be
+    report_data.extend([0] * (generic_report_size - len(report_data)))
+
+    # Send the generated report to the device
+    device.send_output_report(report_data)
+
+    print("Sent LED Pattern: {0}".format(report_data[1:5]))
+
+
+def received_led_pattern(report_data):
+    print("Received LED Pattern: {0}".format(report_data[1:5]))
+
+
+def main():
+    hid_device = get_hid_device_handle(VID=0x03EB, PID=0x204F)
+
+    if hid_device is None:
+        print("No valid HID device found.")
+        sys.exit(1)
+
+    try:
+        hid_device.open()
+
+        print("Connected to device 0x%04X/0x%04X - %s [%s]" %
+              (hid_device.vendor_id, hid_device.product_id,
+               hid_device.product_name, hid_device.vendor_name))
+
+        # Set up the HID input report handler to receive reports
+        hid_device.set_raw_data_handler(received_led_pattern)
+
+        p = 0
+        while (hid_device.is_plugged()):
+            # Convert the current pattern index to a bit-mask and send
+            send_led_pattern(hid_device,
+                             (p >> 3) & 1,
+                             (p >> 2) & 1,
+                             (p >> 1) & 1,
+                             (p >> 0) & 1)
+
+            # Compute next LED pattern in sequence
+            p = (p + 1) % 16
+
+            # Delay a bit for visual effect
+            sleep(.2)
+
+    finally:
+        hid_device.close()
+
+
+if __name__ == '__main__':
+    main()
diff --git a/Demos/Device/ClassDriver/GenericHID/asf.xml b/Demos/Device/ClassDriver/GenericHID/asf.xml
index 3f0658f83..1f03490e5 100644
--- a/Demos/Device/ClassDriver/GenericHID/asf.xml
+++ b/Demos/Device/ClassDriver/GenericHID/asf.xml
@@ -53,6 +53,7 @@
 		<require idref="lufa.common"/>

 		<require idref="lufa.platform"/>

 		<require idref="lufa.drivers.usb"/>

+		<require idref="lufa.drivers.board"/>

 		<require idref="lufa.drivers.board.leds"/>

 	</module>

 </asf>