README.md

# Guitastro Device FLIPRO library

GUITAstro stands for General Use of Instruments and Telescopes in ASTROnomy.

GuitAstro is a Python module that provides classes and methods to write easily Python scripts for astronomical observations. 

[GIT repository: https://gitlab.in2p3.fr/irap-omp/guitastrolib/guitastro.git](https://gitlab.in2p3.fr/irap-omp/guitastrolib/guitastro.git)

Guitastro device Flipro complete Guitastro to provide access to FLIPRO camera drivers:

[GIT repository: https://gitlab.in2p3.fr/irap-omp/guitastrolib/guitastro_device_flipro.git](https://gitlab.in2p3.fr/irap-omp/guitastrolib/guitastro_device_flipro.git)

## Few basic examples of use

First example: To connect a Flipro controler and acquire an image:
```
import guitastro
import guitastro_device_flipro

dev = Device_Flipro("FLIPRO", name="Flipro")
dev.open(True)
dev.commandstring("camera SET exptime 0.1")
dev.commandstring("camera DO ACQ START")
while True:
    timer = dev.commandstring("camera GET timer")
    if timer == -1:
        break
    time.sleep(1)
ima = dev.component('camera').ima
ima.save("my_image.fit")
```

## Guitastro functionalities

GuitAstro device Flipro wraps the driver functions dispatched into the classes:

- **Device_Flipro**: Manage device Flipro drivers.

This class inheritate from the classes Component* of Guitastro.
As a consequece, it is needed to install Guitastro before using Guitastro Flipro.
Moreover, this class imports internally a Python wrapper to use the SDK FLIPro libraries provided by Finger Lakes Instruments.
You need to compile the python wrapper *wrapper_flipro*:

```
$ cd guitastro_device_flipro/src/wrapper_flipro
$ python setup.py build_ext --inplace
```

A complete documentation can be generated from .rst files in the folder doc/doc_rst

## Support and contact

The main author is alain.klotz@irap.omp.eu