Team:Aachen/Notebook/Engineering/WatsOn

From 2014.igem.org

(Difference between revisions)
(Troubleshooting & Useful Links)
(Software)
 
Line 94: Line 94:
<span class="anchor" id="watsonsoftware"></span>
<span class="anchor" id="watsonsoftware"></span>
-
The software consists of several parts which provide an user interface and manage the connection to the hardware.
+
The software consists of several parts which provide an user interface and manage the connection to the hardware. It is also hosted in the [https://github.com/igemsoftware/AachenSoftProject2014 github igemsoftware] repository.
===GUI (Graphical User Interface)===
===GUI (Graphical User Interface)===

Latest revision as of 03:55, 18 October 2014

WatsOn

This page contains technical details and construction manuals for our measurement device WatsOn as well as information on the software controlling the hardware. For more details, please click on the respective tile. For the image analysis software, please visit our Measurarty page.


Hardware

Aachen Device 11.jpg
WatsOn

Our hardware consists of the casing and the electronical components. The casing which can be seen on the left was built from laser cut acrylic glass. A detailed description of the assembly is described in the section Build your own WatsOn.

The connection between the different electronical elements is visualized below.

Aachen Device Hardware Graphics.png
Interaction of electronical components
  • Raspberry Pi : The [http://www.raspberrypi.org/ Raspberry Pi] is a small single-board computer which runs a Linux operating system from an inserted SD card. The steps which are required to set up a fully working system are described in the DIY section of this page. The main purpose of the Raspberry Pi is to run the software described above, to control the attached camera and to show the GUI on the display. The big advantage of this board is that it is very powerful, cheap and therefore perfectly fit for our needs.
  • Raspberry Pi camera: The camera is directly connected to the Raspberry Pi board and takes the images of the chips.
  • Arduino: The [http://www.arduino.cc/ Arduino] board is also a single-board computer with less computing power than the Raspberry Pi but with a greater focus on controlling electronical components. Therefore, it is used to control the LEDs and the Peltier heater.
  • Relay: The 2-channel relay works like two light switches which are either turned on or off. They control the 450 nm and 480 nm LEDs. The channels are connected and turned on and off by the Arduino board.
  • Peltier element: A Peltier component transforms an applied power into a temperature gradient which leads to a hot surface on one side of the element and a cooler one on the other side. The Peltier element connected to the aluminum block heats up the interior of the device to incubate the sensing cells at 37°C.
  • USB WiFi stick: The USB WiFi stick connects the Raspberry Pi to a local network.
  • Display: A 8-digit display is connected to the Arduino board and shows the current interior temperature
Aachen Filter 010.png
010
Aachen Filter 505.png
505
  • Filter slides: To block the undesired wavelenghts emitted from the LEDs a filter slide is placed in front of the camera. This step is taken to get a clear fluorescence signal from the chips. The characteristic of the filter slide is selected depending on the frequency of the LEDs which are either 450 nm or 480 nm ones. We used '505 Sally Green' for the 450 nm and '010 Medium Yellow' for the 480 nm LEDs. The filters are shown on the right.


Software

The software consists of several parts which provide an user interface and manage the connection to the hardware. It is also hosted in the github igemsoftware repository.

GUI (Graphical User Interface)

On the graphical interface, the user can take images and time lapses of the chips inside the device. The software is written in C++. It makes use of the [http://qt-project.org/ Qt-Library] to provide a clear interface and a comfortable way to manage various software aspects such as handling images and establishing network connections. An advantage resulting from the utilization of Qt-Library is the multi-platform support for Windows, MacOS and Linux. Additionally, Qt is available with an Open Source license which can be used for free. The software can be used locally on the Raspberry Pi or remotely from a device in the same network.

The scheme below shows the different components of the software:

Aachen Device GUI.png

Features of the GUI include:

  • Change settings [1]:
    • The user can specify the iso-value and the shutter speed of the camera.
    • Custom settings can be labeled and saved for future reference.
    • Existing settings can be updated or deleted unless they are default configurations.
  • Take image/s [2]:
    • The excitation wavelength of GFP (480 nm) and iLOV (450 nm) can be selected.
    • The GUI offers two possibilities to take images:
      • Take a single image with the active camera settings.
      • Take time lapse shootings with the active camera settings and the specified interval. When activated, the images are saved automatically to a user defined directory with ascending filenames.
    • The last image which was taken by the camera is shown in the GUI, information containing the time stamp and used camera settings are displayed next to the image [3]. Previous images can be selected with the arrow buttons.
  • Analyze image [4]:
    • The image is analyzed by an image segmentation algorithm and shows whether the pathogen Pseudomonas aeruginosa is present on the chip or not

Download the GUI sourcecode: Download

Backend

The backend is a software that runs on the Raspberry Pi and is responsible for the connection between the GUI and the hardware. If the user interface is executed on another device, e.g. a notebook, it has to be in the same network as the Raspberry Pi. The backend works like a web server that receives commands and acts according to the submitted parameters. It can take images and returns them to the GUI.

Before an image is taken, the backend turns on the specified LEDs by sending a command to the connected Arduino board. Subsequently, the LEDs are turned off using the same mechanism. These steps are repeated in the given interval for a time lapse shooting.

Download the backend sourcecode: Download

Aachen Device SoftwareBackend.png
Sample connection between GUI and backend for taking an image

Arduino

The software on the Arduino board sets the power and thus controls the temperature of the Peltier heater. The power is set by evaluating the received values from the temperature sensors for the interior of the device and the aluminum block. Additionally, the Arduino receives commands from the Raspberry Pi to turn the LEDs on and off.

Download the Arduino sourcecode: Download

Measurarty

We have developed our own image analysis pipeline Measurarty. Please go to the Measurarty project page for further information.


Aachen 14-10-15 DIY Cellocks iNB.png

DIY: How To Build Your Own WatsOn

Technical Components

If you want to create your own WatsOn first take a look at the following list of necessary components. All parts except the laser cut acrylic glass can be readily purchased and do not require further adjustments.

Download the laser cutting plan here: Download (for acrylic glass with a height of 6 mm)

All needed components, their quantities and prices for creating your own WatsOn

WatsOn 1€= $1.27 on 14/10/2014
Quantity Component Costs [€] Costs [$] Final [€] Final [$]
1 [http://www.prolighting.de/Zubehoer/Farbfilter/Lee-Filter_HT/Lee-Filters_Musterheft_Designer_Edition_i174_3965_0.htm filter slides] (medium yellow 010, sally green 505)1.572.001.572.00
1 [http://www.dx.com/p/uno-r3-development-board-microcontroller-mega328p-atmega16u2-compat-for-arduino-blue-black-215600 Arduino UNO R3]9.1711.659.1711.65
1 [http://www.dx.com/p/arduino-2-channel-relay-shield-module-red-144140 2-channel relay shield]2.723.462.723.46
40jumper-wire cable2.352.992.352.99
1 [http://www.dx.com/p/2-54mm-1x40-pin-breakaway-straight-male-header-10-piece-pack-144191 40er male header (10-Piece Pack)]2.142.722.142.72
1 [http://www.dx.com/p/jtron-2-54mm-40-pin-single-row-seat-single-row-female-header-black-10-pcs-278953 40er female header (10-Piece Pack)]2.052.602.052.60
1 [http://www.dx.com/p/prototype-universal-printed-circuit-board-breadboard-brown-5-piece-pack-130926 circuit board]2.352.992.352.99
1 [http://www.newark.com/pro-signal/rp006/audio-video-cable-hdmi-1m-black/dp/96T7446 HDMI cable]1.471.871.471.87
1 [http://www.dx.com/p/hd-053-high-speed-usb-2-0-7-port-hub-black-174817 7 port USB hub]5.286.715.286.71
1[http://www.dx.com/p/dx-original-ultra-mini-usb-2-0-802-11n-b-g-150mbps-wi-fi-wlan-wireless-network-adapter-black-252716 USB WiFi stick]4.215.354.215.35
1USB mouse and keyboard9.8412.509.8412.50
1 [http://corporate.evonik.com/en/products/pages/default.aspx case acrylic glass XT 6mm~0.52]39.8850.6539.8850.65
1 black spray paint for acrylic glass5.156.545.156.54
1 [http://www.newark.com/raspberry-pi/raspberry-modb-512m/raspberry-pi-model-b-board/dp/68X0155 Raspberry Pi model B board]27.5635.0027.5635.00
1[http://www.newark.com/raspberry-pi/rpi-camera-board/add-on-brd-camera-module-raspberry/dp/69W0689 Raspberry Pi camera module]19.6925.0019.6925.00
1[http://www.pollin.de/shop/dt/NzUwOTc4OTk-/ 7” display]39.3549.9739.3549.97
1[http://www.dx.com/p/diy8-x-seven-segment-displays-module-for-arduino-595-driver-250813 8-segment display]3.043.863.043.86
2 [http://www.dx.com/p/arduino-dht11-digital-temperature-humidity-sensor-138531 digital temperature sensor DHT-22]5.917.5011.8215.00
1 aluminum block 100x100x15 mm11.2014.2311.2014.23
1 [http://www.dx.com/p/tec1-12706-semiconductor-thermoelectric-cooler-peltier-white-157283 Peltier heater 12V 60W]3.544.493.544.49
1power supply25.9032.8925.9032.89
6 [http://www.leds.de/Low-Mid-Power-LEDs/SuperFlux-LEDs/Nichia-Superflux-LED-blau-3lm-100-NSPBR70BSS.html superflux LED 480nm]0.991.265.947.54
16LED 450nm0.370.475.947.54
2 Resistor 40 Ohm0.120.150.240.30
4 Resistor 100 Ohm0.120.150.480.60
1cupboard button0.981.240.981.24
-Total--243.88309.70

You can find more economical information about WatsOn and the project on our Economical View page.


For building our WatsOn we used some tools that are not included in the list of necessary components because we assume that they are already available. We used a soldering iron to solder the resistors to the LEDs and fix the headers on the mount of the LEDs. For building electrical circuits our multimeter was very helpful. Furthermore, we applied special glue for plastic to hold the acrylic glass in place. All other components were fixed with tape or hot glue which is versatile and can be removed quickly during alignment of components.

Breadboard

Aachen Device Fritzing.png
Wiring of our device

Construction Manual

Aachen Device 1.jpg Start building your own WatsOn by assembling the base plate, the sides and the interior wall.
350px] [File:Aachen_Device_.3jpg Fix the Peltier heater on the back of the aluminum block and place it in the hole of the interior wall.
Arrange the 4x4 450 nm LEDs and the 2x3 480 nm LEDs
Aachen Device 7.jpg Assemble the camera holder with the camera and the corresponding filter slide on the lower part. Above the camera, you can place the temperature sensor for measuring the indoor temperature. Finally, put the fan on the back of the camera holder.
Aachen Device 8.jpg Connect the electronic components on the outside and the inside according to the wiring diagramm.
Aachen Device 4.jpg Put together the drawer.
Aachen Device 9.jpg Position the front panel and insert the drawer.
Aachen Device 10.jpg Place the temperature sensor measuring the aluminum block temperature directly on the block and put the back panel in front of it.
Aachen Device 6.jpg Setup the power supply1 and connect all devices to either 5 V or 12 V. For security reasons it has been placed into an aluminium casing. Plug the USB hub connector into the Raspberry. If you use the GUI locally on the device a mouse and a keyboard need to be attached to the USB hub to navigate on the user interface. Follow the steps described in the section Raspberry Pi - Setup.
Aachen Device 11.jpg Mount the device on top of the power supply casing. Add the display and apply some stickers to enjoy your custom-made WatsOn.

1By German law only certified electricians may work on 230 V electronics. Therefore, the electrical workshop at our institute created the power supply specifically for our design.

Raspberry Pi - Setup

In order to get a running linux system on the Raspberry Pi which includes all required components and configurations the following steps have to be considered:

  • The Raspberry Pi needs an SD card on which the operating system will be installed. Go to the [http://www.raspberrypi.org/downloads/ download page of the Raspberry Pi Foundation] and select an operating system of your choice - we used Raspbian - or just download the NOOBS package which offers all different operating systems during setup.
  • Follow the specific image installation guidelines to install the downloaded system onto your SD card.
  • Once finished, insert the SD card in the slot on the Raspberry Pi board, connect a monitor over HDMI, plug in a USB mouse and keyboard and start the Raspberry Pi by connecting it to the micro USB power supply. Follow the installation instructions; these should be straightforward. After the installation you will be shown the desktop of your new system.
  • To be able to use the Raspberry Pi camera you need activate it over a terminal. Search for a desktop icon labeled "LxTerminal", double click it and a terminal will appear where you can enter commands which will be executed after you press Return. Enter "raspi-config", press Return and activate the camera with the displayed corresponding option.
  • To check if the camera works, enter "raspistill -t 5000 -o camera_test.jpg" in the terminal. An overlay shows a 5 second preview from the camera on the screen, then an image is taken and saved as "camera_test.jpg" in the current directory.
  • An issue concerning the Raspberry Pi camera is that it supports just a fixed-focus which is per default set to infinity. This can be solved by removing the glue dots fixing the lense und unscrewing it until the required distance is focused.
  • Download the source files for the backend server and the graphical user interface (GUI). To be able to compile the GUI, you need to install the Qt5-libraries. Follow [http://qt-project.org/wiki/Native_Build_of_Qt5_on_a_Raspberry_Pi this guide] on how to get the Qt source code, compile it and setup your environment correctly. Make sure that your Raspberry Pi is constantly running, since this process takes some time and must not be interrupted.
  • With the Qt-libraries installed, open a terminal and change to the directory where you put the source for the GUI (command "cd [path to source]"). Call "qmake" followed by "make" and you will start compilation of the program. When finished, you can launch the GUI with the command "./igem_GUI".
  • The backend - that will establish the connection between hardware and the user interface - requires you to install additional packages for Python which is a high-level general-purpose programming language and an interpreter that will ship with your system. Open the README in the "Backend" directory and follow the instructions.
  • You now should be able to launch the backend by calling "python takeimageserver.py &" from the terminal.
  • Now start the GUI. An input dialog will show up asking you to provide the IP address of the backend server or the Raspberry Pi, respectively. Since you are running the GUI and the backend on the same device, just press Enter to select the default entry which is the IP of the local host. After a few seconds, when the connection to the backend server has been established, the user interface gets enabled and you can start to take images and time lapse shootings. If the image is not focused you need to adjust the lense in front of the camera by rotating it. For the full list of features refer to the Software section of this page.

In case you want to run the GUI on a remote machine, e.g. your notebook, follow these additional steps:

  • Install the [http://qt-project.org/ Qt-libraries and QtCreator] on your system. This is just an installation - you do not have to compile it. Get the source code for the GUI and open the ".pro" file with QtCreator. After importing the project and selecting a built directory, click the green arrow on the left side. Compilation is started and as soon as it is finished the GUI will start.
  • In order to be able to connect to the Raspberry Pi you need to be connected to the same network. Therefore, make sure the Raspberry Pi USB wifi stick is working properly (see Troubleshooting & Useful Links), and that you reside in the same network. Start the backend server on the Raspberry Pi. It will print the IP address on start up which you must enter in the GUI on your device running the GUI. Now you should be able to use all the features as if running the GUI on the Raspberry Pi.

Troubleshooting & Useful Links

  • Display resolution: If your connected display is not working properly you may refer to
    • http://elinux.org/RPiconfig#Video
    • http://www.raspberrypi.org/forums/viewtopic.php?f=29&t=24679
  • Raspberry Pi Camera Module
    • http://elinux.org/Rpi_Camera_Module
  • Network configuration:
    • http://www.raspberrypi.org/documentation/configuration/wireless/README.md
  • General
    • [http://elinux.org/R-Pi_Troubleshooting Raspberry Pi Troubleshooting]
    • [http://raspberrywebserver.com/linux-basics/ Linux basics]
    • [http://www.raspberrypi.org/ Raspberry Pi Foundation]