| gclib 1.35.5 Communications API for Galil controllers and PLCs |

Ubuntu Linux

# Tested versions

See the installation page for supported versions.

# Installation

Note
  Adding the package repository is a prerequisite to continue.

## Install

### Install gclib and gcapsd (recommended)

    # apt install gclib gcapsd

## Uninstall

If gclib is to be removed from the system, the following commands may be used.

    # apt remove gclib gcapsd

## Upgrading

To upgrade gclib to the newest release, use the following command.

    # apt install --only-upgrade gclib gcapsd

## List All Versions

Galil keeps older versions of gclib and gcapsd available for users. To list all versions use the following command.

    $ apt-cache madison gclib gcapsd

## Installing Older Versions

Warning
  When using gcaps, a compatible pairing of gcaps and gclib must be used. Galil maintains this compatibility with installations and upgrades. Installing GDK will also install compatible versions of gclib and gcaps. When installing older versions manually, it is the user's responsibility to ensure compatible versions.

Append the desired version's information after the package name.

    # apt install gclib=<version> gcapsd=<version>

### An Example

On the developer's machine, gclib is installed with the current version.

    $ sudo apt install gclib gcapsd

After installation, the versions can be queried.

    $ apt list --installed gclib gcapsd
    Listing... Done
    gcapsd/unknown,now 205-1 amd64 [installed]
    gclib/unknown,now 517-1 amd64 [installed]

On the deployment machine, the precise versions can now be specified.

    $ sudo apt install gclib=517-1 gcapsd=205-1

# Serial Ports and USB

If access to the serial ports or USB (e.g. DMC-4103) is desired through gclib, the following will provide steps to join the correct access group. If using USB, be sure the controller is powered and the usb is plugged in before beginning.

## Determine group with access

    $ ls -l /dev/ttyUSB* /dev/ttyS*
    crw-rw----. 1 root dialout   4, 64 Mar  3 16:39 /dev/ttyS0
    crw-rw----. 1 root dialout   4, 65 Mar  3 16:39 /dev/ttyS1
    crw-rw----. 1 root dialout   4, 66 Mar  3 16:39 /dev/ttyS2
    crw-rw----. 1 root dialout   4, 67 Mar  3 16:39 /dev/ttyS3
    crw-rw----. 1 root dialout 188,  0 Mar  6 11:08 /dev/ttyUSB0

In the above listing, dialout is the group that needs to be joined. uucp is another common group that may be listed.

## Add the desired username to the group.

    $ sudo gpasswd -a username dialout
    [sudo] password for username:
    Adding user username to group dialout

Log out and back in for change to take effect.

    $ groups
    username wheel dialout

gclib can now connect to serial and usb devices from user username.

# PCI Controllers

If using a Galil PCI controller, the PCI driver must be installed.

## Extract source and build driver

    $ tar -xf /usr/share/doc/gclib/src/gclib_pci.tar.gz
    $ make

## Copy module and add to kernel

    $ sudo cp galilpci.ko /lib/modules/$(uname -r)
    $ sudo depmod
    $ sudo modprobe galilpci

## Add galil group for access to PCI

    $ sudo groupadd -f -K GID_MIN=100 -K GID_MAX=499 galil
    $ sudo cp 90-galilpci.rules /etc/udev/rules.d/
    $ sudo udevadm control --reload-rules
    $ sudo udevadm trigger
    $ sudo usermod -a -G galil username  #exchange "username" with actual user's name

Logout and back in. The PCI hardware is now available for access.

    $ ls -l /dev/galil*
    crw-rw---- 1 root galil 10, 56 Jun  9 11:07 /dev/galilpci0
    $ echo -e "\x12\x16\r" > /dev/galilpci0
    $ cat /dev/galilpci0
    DMC1846 Rev 1.1a
    :

# Documentation

The documentation is left as a tarball to minimize disk usage. The latest release version of the user manual is available at the following link.

- http://www.galil.com/sw/pub/all/doc/gclib/html/

## Offline html

The following allows viewing of the html docs from the installation.

    $ tar -xzf /usr/share/doc/gclib/gclib_doc.tar.gz html
    $ firefox html/index.html