Skip to content

Latest commit

 

History

History
195 lines (147 loc) · 8.71 KB

README.md

File metadata and controls

195 lines (147 loc) · 8.71 KB
Raw

INDI 3rd Party Drivers

CircleCI

INDI 3rd party drivers include all the drivers not included by default in the INDI Core Library.

Which drivers are in 3rd party?

Check the Device Driver documentation for detailed information on how to operate each device driver.

All the driver documentation is community-contributed. Any updates or correction to the documentation in INDI library is greatly appreciated.

The following classes of devices are supported in the INDI 3rd party repository:

  • Cameras: CCDs, CMOS, and DSLR
  • Mounts.
  • Focusers.
  • Filter Wheels.
  • Domes.
  • GPS.
  • Adaptive Optics.
  • Radio Astronomy Receivers.
  • Spectrometers.
  • Weather Stations.
  • Auxiliary drivers.

What decides if a driver belongs to INDI Core or INDI 3rd party?

If a driver meets any of the following criteria, then it needs to be included in the INDI 3rd party repository:

  • Any camera driver.
  • Any driver with external dependencies not satisfied by INDI core library.
  • Any driver that would like to remain independent from INDI core library release schedule.

Learn more about INDI:

Building

Before building INDI 3rd party drivers. INDI Core Library must be already installed on your system.

Install Pre-requisites

On Debian/Ubuntu:

sudo apt-get -y install libnova-dev libcfitsio-dev libusb-1.0-0-dev zlib1g-dev libgsl-dev build-essential cmake git libjpeg-dev libcurl4-gnutls-dev libtiff-dev libfftw3-dev libftdi-dev libgps-dev libraw-dev libdc1394-22-dev libgphoto2-dev libboost-dev libboost-regex-dev librtlsdr-dev liblimesuite-dev libftdi1-dev libavcodec-dev libavdevice-dev

Create Project Directory

mkdir -p ~/Projects
cd ~/Projects

Get the code

To build INDI in order to run drivers, then it is recommended to perform a quick shallow clone that will save lots of bandwidth and space:

git clone --depth=1 https://github.com/indilib/indi-3rdparty

On the other hand, if you plan to submit a PR or engage in INDI driver development, then getting a full clone is recommended:

git clone https://github.com/indilib/indi-3rdparty

3rd Party Drivers vs. 3rd Party Libraries

Some of the drivers included in the INDI 3rd party repository require a library (usually made by the device manufacturer) to be installed before the driver can be built and installed. For example indi-qsi depends on libqsi, so libqsi must be built and installed before attempting to build and install the indi-qsi driver. Many of these libraries are included in the 3rd Party Repository and can be installed just like the drivers.

Building individual 3rd Party Drivers (typically recommended)

While you can build all the 3rd party drivers and libraries at once, it is typically recommended to build/install each 3rd party driver as required, since each 3rd party driver may have its own pre-requisites and requirements, and you probably don't need all the drivers. If you want build and install just one driver, please see this example of how to build INDI EQMod driver:

mkdir -p ~/Projects/build/indi-eqmod
cd ~/Projects/build/indi-eqmod
cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Debug ~/Projects/indi-3rdparty/indi-eqmod
make -j4
sudo make install

The complete list of system dependancies for all drivers on Debian / Ubuntu

sudo apt-get install libnova-dev libcfitsio-dev libusb-1.0-0-dev zlib1g-dev libgsl-dev build-essential cmake git libjpeg-dev libcurl4-gnutls-dev libtiff-dev libftdi-dev libgps-dev libraw-dev libdc1394-22-dev libgphoto2-dev libboost-dev libboost-regex-dev librtlsdr-dev liblimesuite-dev libftdi1-dev

Building all the 3rd Party Libraries

You can build all the 3rd Party Libraries at once if you already have all of the requirements for each library installed. To install all the libraries, you would want to use the BUILD-LIBS build flag. If you want to build all 3rd Party drivers as described in the section below, you need to do this step first. You can use the following commands to install all the libraries:

mkdir -p ~/Projects/build/indi-3rdparty-libs
cd ~/Projects/build/indi-3rdparty-libs
cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Debug -DBUILD_LIBS=1 ~/Projects/indi-3rdparty
make -j4
sudo make install

Building all the 3rd Party Drivers

You can build all the 3rd Party Drivers at once if you already have all of the requirements for each driver installed. Before you attempt this, please make sure to install all the 3rd Party Libraries first. Please see the section above. After you have all the requirements, you can run the following commands to install all the drivers:

mkdir -p ~/Projects/build/indi-3rdparty
cd ~/Projects/build/indi-3rdparty
cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Debug ~/Projects/indi-3rdparty
make -j4
sudo make install

Support

Development

Code Style

INDI uses Artistic Style to format all the C++ source files. Please make sure to apply the following astyle rules to any code that is submitted to INDI. On Linux, you can create ~/.astylerc file containing the following rules:

--style=allman
--align-reference=name
--indent-switches
--indent-modifiers
--indent-classes
--pad-oper
--indent-col1-comments
--lineend=linux
--max-code-length=124

Some IDEs (e.g. QtCreator) support automatic formatting for the code everytime you save the file to disk.

How to create Github pull request (PR)

How to contribute to INDI full guide

Here is the short version on how to submit a PR:

  1. Login with a Github account and fork the official INDI repository.
  2. Clone the official INDI repository and add the forked INDI repository as a remote (git remote add ...).
  3. Create a local Git branch (git checkout -b my_branch).
  4. Work on the patch and commit the changes.
  5. If it is ready push this branch to your fork repo (git push -f my_fork my_branch:my_branch).
  6. Go to the official repo's github website in a browser, it will popup a message to create a PR. Create it.
  7. Pushing updates to the PR: just update your branch (git push -f my_fork my_branch:my_branch)..

If you would like to make cleaner PR (recommended!) please read this tutorial and follow it. The best way is to keep one logical change per commit and not pollute the history by multiple small fixes to the PR.

Driver Documentation

When submitting a new driver, the driver user documentation is required as part of the submission process.

  • Installation: Driver name, executable name, version, required INDI version.
  • Features: What features does it support exactly?
  • Operation: How to operate the driver? Each sub section should come with a screen shot of the various tabs..etc. Preferably annotated to make it easier for new users to follow.
    • Connecting: How to establish connection? How to set port if any?
    • Main Control: Primary control tab and its functions.
    • Options: Explanation for the various options available.
    • Etc: Any other tabs created by the driver.
  • Issues: Any problems or issues or warnings the users should be aware about when using this driver.

Unit tests

In order to run the unit test suite you must first install the Google Test Framework. You will need to build and install this from source code as Google does not recommend package managers for distributing distros.(This is because each build system is often unique and a one size fits all aproach does not work well).

Once you have the Google Test Framework installed follow this alternative build sequence:-

cd ~/Projects/build/indi-3rdparty
cmake -DINDI_BUILD_UNITTESTS=ON -DCMAKE_BUILD_TYPE=Debug ~/Projects/indi-3rdparty
make -j4
cd test
ctest -V