Device Communication Basics

Overview

This document covers the basics of device communication and configuration. OpenSync devices employ USB on-the-go (OTG), so no drivers are necessary to communicate with an OpenSync device. This is beneficial as device discovery revolves arounds a computer’s ability to detect a USB device that is actively connected to the computer.

Purpose

This example demonstrates how to search, connect, and “talk” to an OpenSync device. OpenSync relies on a stable USB connection, so make sure one is present for this demonstration.

Imports

To begin, import opensync as such.

import opensync

Device Connection

We need to search for any OpenSync devices to connect to. This is performed by the function device_comm_search.

avail_ports = opensync.device_comm_search()
avail_ports

['COM7']

There are two ways we can open a connection once we found the correct port to connect to. We can manually manage the resources with device_comm_open and device_comm_close or use context managers to automatically manage resources with device_comm_managed. Both methods will be shown in this document.

Manually Open Device Connection

# Open USB port
sync_device = opensync.device_comm_open(avail_ports[0])
sync_device

Serial<id=0x18968321ea0, open=True>(port='COM7', baudrate=19200, bytesize=8, parity='N', stopbits=1, timeout=0.1, xonxoff=False, rtscts=False, dsrdtr=False)

# Get device state and version
print(opensync.device_system_version(sync_device))
print(opensync.device_system_status(sync_device))

['OpenPIV', 'OpenSync', '5A3F6CE6128EEB36', '0.7.3']
['IDLE']

# Close USB port
opensync.device_comm_close(sync_device)

Open with Context Manager

with opensync.device_comm_managed(avail_ports[0]) as sync_device:
    # Get device state and version
    print(opensync.device_system_version(sync_device))
    print(opensync.device_system_status(sync_device))

['OpenPIV', 'OpenSync', '5A3F6CE6128EEB36', '0.7.3']
['IDLE']

Status Information

OpenSync allows one to poll system status information even when running a pulse sequence. Below are the most commonly used requests.

with opensync.device_comm_managed(avail_ports[0]) as sync_device:
    print(opensync.device_system_version(sync_device))
    print(opensync.device_system_status(sync_device))
    print(opensync.device_system_freq(sync_device))

['OpenPIV', 'OpenSync', '5A3F6CE6128EEB36', '0.7.3']
['IDLE']
['pll_sys = 250000kHz', 'pll_usb = 48000kHz', 'rosc = 10180kHz', 'clk_sys = 250000kHz', 'clk_peri = 48000kHz', 'clk_usb = 48000kHz', 'clk_adc = 48000kHz']

Executing Device Parameters

Two of the more important functions for OpenSync are device_system_fire and device_system_stop. device_system_fire executes a pulse sequence with the current pulse and clock configrations. To prematurely stop a pulse sequence iteration, one can use device_system_stop and an abort signal will be sent to the OpenSync device.