ClusterDuck_Automator_for_Linux

The script will validate if you have all the Linux binaries installed to work on the Project Owl Cluster Ducks with the Arduino IDE. Once you have all the necessary binaries installed, you can then use the script to install the ClusterDuck libraries (CDP) needed for development.

This guide will help you successfully get a Linux development environment up and running for Project Owl ClusterDucks. Please note the author of the document and the script knows how to use Debian and Ubuntu and some of the derivatives. So the code sections are by default appropriate for the "apt" tool set. If you use a different distribution please send patches with the correct methods for other distributions and they will get included in future versions of this document and script. Hopefully this helps make developing for Project Owl Ducks easier. Thank you for your support.

Preferred method of setup (Script Install):

Install the Arduino IDE

First please get Arduino IDE Installed. We recommend the tar-ball installation method, please follow the instructions provided by the Arduino folks, they are pretty good. They have two scripts to be run that will pretty much install the Arduino IDE on almost every version of Linux. We do recommend installing into:

/opt/Arduino-(version number)

and then adding a symlink:

ln -s /opt/Arduino-(version number) /opt/arduino.

That way you will not have to change anything beyond the symlink for upgrades in the future.
Now that you have installed the Arduino IDE, please open and run it one time and close it out. This populates some required folders and files.
Once you have run the Arduino IDE once please continue with step 1 Install Python3 and tools below.

Install Python3 and tools

You will need Python 3 and some tools. Some earlier versions of Linux are still using Python 2.7 which is now obsolete, so you may need to upgrade. You will also have to make python3 your default python on your machine. If you are running Debian or Ubuntu or one of the derivities you can do this by running the following in your terminal:

sudo apt-get install python3 python3-pip python3-setuptools git
You will need to install the pySerial module, a dependency for CDP. If you are running Debian or Ubuntu or one of the derivatives. you can do this by running the following in your terminal:

pip3 install pyserial
Now make Python 3 the default interpreter is possible by running:sudo

update-alternatives --install /usr/bin/python python /usr/bin/python3 10

Note: You must logout of your account and back in for this to take effect, however wait until you run the next command as it also requires logging out and back in to take effect.
You may need to add your user to dialout on Linux

The currently logged user should have read and write access the serial port over USB. On most Linux distributions, this is done by adding the user to dialout group with the following commands:

sudo usermod -a -G dialout $USER

On Arch Linux this is done slightly differently by adding the user to uucp group with the following command:

sudo usermod -a -G uucp $USER

Note: You must logout of your account and back in for this to take effect, you should do so now before proceeding with the rest of the instructions.

Install and run ClusterDuck_Automator_for_Linux

Next install the ClusterDuck_Automator_for_Linux script. The git clone will install the check_ClusterDuck_dependencies bash script. The first time it's run it will create the install_ClusterDuck_libraries bash script. Just some script magic to make it clear what to run to check things and to install things. Eventually it might even have a update_ClusterDuck_libraries script but not today. Eventually the script will exist somewhere within the Project Owl repositories but for now.

git clone git@github.com:dmandala/ClusterDuck_Automator_for_Linux.git
Now you need to run the script. It should be executable, but it it's not you can solve this by doing:

chmod u+x check_ClusterDuck_dependencies

Once you have done that run the script in a terminal by:

./check_ClusterDuck_dependencies

The output will tell you if you have a clean environment with all the necessary pieces in place. Resolve any missing software errors by installing them using your distro's tools. Once that is done you can now proceed to the install of the ClusterDuck-Protocol libraries.

Install ClusterDuck-Protocol libraries

To install run the script install_ClusterDuck_libraries like this:

./install_ClusterDuck_libraries
The script will clone the latest CDP down and set up all necessary libraries in the proper places. Once that has completed you are now ready to use the Clusterduck Protocol libraries and flash some ducks.