GeoCOM API

The DMPACK library provides Leica GeoCOM abstraction layers for Fortran and Lua, to write distinct programs for TPS control or to load evaluable configuration files into dmserial.

DMPACK does not follow the Leica GeoCOM API for C/C++ and Visual Basic. Instead, the API is entirely object-oriented, and methods are given more memorable names without any sub-system prefix. Structured types have been removed altogether. Named parameters start with prefix GEOCOM_ and return codes with prefix GRC_. See the source code documentation for an overview of the API.

The following example in Fortran 2018 opens the TTY /dev/ttyUSB0, calls the null procedure of the instrument (COM_NullProc), and then prints return code, associated error message, and last request to standard output:

! geocom.f90
program main
    use :: dmpack
    implicit none (type, external)
    integer            :: rc      ! DMPACK return code.
    type(geocom_class) :: geocom  ! GeoCOM object.
    type(request_type) :: request ! Last request.

    ! Initialise DMPACK.
    call dm_init()

    ! Open connection to instrument, quit on error.
    call geocom%open('/dev/ttyUSB0', GEOCOM_COM_BAUD_115200, verbose=.true., error=rc)
    call dm_error_out(rc, fatal=.true.)

    ! Call remote procedure COM_NullProc and output result.
    call geocom%null()
    print '(i0, ": ", a)', geocom%code(), geocom%message()

    ! Output last request.
    call geocom%last_request(request)
    call dm_request_out(request)

    ! Close connection.
    call geocom%close()
end program main

Make sure that the instrument is configured to 115200 baud. Invalid parameters passed to the GeoCOM methods will be replaced with their default values, and an error message is printed in verbose mode.

If the DMPACK library and module files are installed to /opt, build, link, and run the example program with:

$ gfortran -I/opt/include/dmpack -o geocom geocom.f90 /opt/lib/libdmpack.a -lpcre2-8
$ ./geocom

Enumerators

All GeoCOM named types and enumerators supported by DMPACK start with prefix GEOCOM_.

Return Codes

All GeoCOM return codes start with prefix GRC_.