Skip to main content
Join the official 2020 Python Developers SurveyStart the survey!

Python client code for the OpenFlexure Microscope

Project description

A Python client for the OpenFlexure Microscope.

The OpenFlexure Microscope is most often controlled by two pieces of software - the OpenFlexure Microscope Server, which is written in Python and runs on the embedded Raspberry Pi, and OpenFlexure eV which is a graphical interface written in Electron, that can be run either on the Raspberry Pi, or on another computer via a network connection. However, if you want to write your own scripts to perform particular experiments or protocols, it's useful not to have to embed these in eV or package them up as plugins. This library exists to make it easy to control your microscope from a simple Python script that can run either on the Raspberry Pi, or over the network. I particularly like to use it from a Jupyter notebook on my laptop, because it allows me to plot graphs and display images as I go.


This module can be installed with pip install openflexure-microscope-client, or by cloning the repository and running poetry install.


Connect to your microscope

You can connect to the microscope either by specifying a hostname or IP address, or using mDNS. If your network is relatively simple, and if you can see your microscope in the "nearby devices" section of eV, then mDNS is a zero-faff way of connecting to your microscope:

import openflexure_microscope_client as ofm_client
microscope = ofm_client.find_first_microscope()

If your network is more complicated, or you know the address of your microscope, you can connect using the hostname or IP address. By default, your microscope will declare itself as microscope.local though this also relies on mDNS so if the method above doesn't work, microscope.local may also not work.

microscope = ofm_client.MicroscopeClient("")

Check the connection

Usually, I run a few commands to check my microscope is working properly:

pos = microscope.position
starting_pos = pos.copy()
pos['x'] += 100
assert microscope.position == pos
pos['x'] -= 100
assert microscope.position == starting_pos

# Check the microscope will autofocus
ret = microscope.autofocus()

# Acquire an image for sanity-checking too
image = microscope.grab_image()
f, ax = plt.subplots(1,1)
print("Active microscope extensions")
for k in microscope.extensions.keys():

After running this block, you should see a list of extensions that are currently active, and a picture taken by the microscope. Given that we just autofocused, this image should be nice and sharp!

Basic commands

There are a few basic commands built in as methods of the MicroscopeClient object:

  • position is a property that returns a dictionary with 'x', 'y', and 'z' components, giving the position of the stage.
  • get_position_array() returns a 3-element numpy array with the same position in it.
  • move(position) accepts either a 3-element array or a dictionary as returned by position, and performs an absolute move
  • move_rel(displacement) performs a relative move (i.e. supplying 0 will not move that axis)
  • capture_image() will take a new image from the camera and return it as a PIL image object
  • grab_image() will return the next image the camera sends in its MJPEG preview stream (i.e. it's quicker but lower quality than capture_image())
  • grab_image_array() returns the image as a numpy array.
  • autofocus() runs the fast autofocus routine, just like clicking the "autofocus" button in eV


To run methods provided by the microscope extensions, you can use the extensions dictionary, to make get or post requests:


Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for openflexure-microscope-client, version 0.1.3
Filename, size File type Python version Upload date Hashes
Filename, size openflexure_microscope_client-0.1.3-py3-none-any.whl (6.6 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size openflexure-microscope-client-0.1.3.tar.gz (6.5 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page