trimble.tcl Annotations

Trimble 550x specific functions

Ulyxes - an open source project to drive total stations and publish observation results

GPL v2.0 license

Copyright (C) 2010-2012 Zoltan Siki

Version:

1.1

Author:

Zoltan Siki

Daniel Moka (TclDoc comments)

::CloseCom

proc  ::CloseCom {  }

Close communication port

Defined in:

trimble.tcl, line 47

::Coords

proc  ::Coords { {wait 100} {incl 0} }

Read coordinates from instrument

Parameters:

wait - (not used only for compatibility)

incl - (not used only for compatibility)

Returns:

coordinates from instrument : {{38 Easting} {37 Northing} {39 Height}}

Defined in:

trimble.tcl, line 381

::GetAngles

proc  ::GetAngles {  }

Read angles from instrument

Returns:

angles in radians in a list : {{7 hz} {8 v}}

Defined in:

trimble.tcl, line 395

::GetAtmCorr

proc  ::GetAtmCorr {  }

Get atmospheric correction settings

Returns:

atmospheric settings as a list {ppm pressure drytemp wettemp}

Defined in:

trimble.tcl, line 186

::GetATR

proc  ::GetATR {  }

Get ATR status -- dummy function for compatibility purposes

Returns:

-1 (always error)

Defined in:

trimble.tcl, line 167

::GetEDMMode

proc  ::GetEDMMode {  }

Get EDM (Electronic Distance Meter) mode

Returns:

mode

Defined in:

trimble.tcl, line 282

::GetId

proc  ::GetId {  }

Read instrument id

Returns:

instrument id or error code

Defined in:

trimble.tcl, line 414

::GetInstrument

proc  ::GetInstrument {  }

Read instrument name

Returns:

instrument name

Defined in:

trimble.tcl, line 407

::GetLock

proc  ::GetLock {  }

Get Lock status

Returns:

-1 (always error)

Defined in:

trimble.tcl, line 180

::GetPc

proc  ::GetPc {  }

Get prism constant

Returns:

pc in mm

Defined in:

trimble.tcl, line 148

::GetRefCorr

proc  ::GetRefCorr {  }

Get refraction correction settings

Returns:

refraction settings as a list {on earthradius scale}

Defined in:

trimble.tcl, line 233

::GetStation

proc  ::GetStation {  }

Get station co-ordinates (dummy proc for compatibility puspose)

Returns:

-1 (always error)

Defined in:

trimble.tcl, line 267

::Measure

proc  ::Measure { {prg 1} {wait 2000} {incl 0} }

Measure distance

Parameters:

prg - measure program 1/2/.. standard/track TBD

wait - not used (only for compability purposes)

incl - not used (only for compability purposes)

Returns:

error code or list of observations: {{7 hz} {8 v} {9 sd}}

Defined in:

trimble.tcl, line 346

::Move

proc  ::Move { hz v {units RAD} {atr 0} }

Rotate instrument to given direction

Parameters:

hz - horizontal direction, pseudo dms (ddd.mmss)

v - zenith angle, pseudo dms (ddd.mmss)

units - DEG/RAD/DMS

atr - not used, only for compability purposes

Returns:

0 or error code

Defined in:

trimble.tcl, line 326

::MoveAndMeasure

proc  ::MoveAndMeasure { hz v {units RAD} {atr 0} }

Rotate the instrument and measure distance

Parameters:

hz - horizontal direction

v - zenith angle

atr - not used only for compability purposes

Returns:

0 in case of error

Defined in:

trimble.tcl, line 370

::OpenCom

proc  ::OpenCom { {par trimble5503.com} }

Open communication port, port number and other parameters are read from a file
(sets global variable com)

Parameters:

par - name of parameter file, optional (default trimble5503.com)

Returns:

0 on success on nonzero error code

Defined in:

trimble.tcl, line 58

::ReadCom

proc  ::ReadCom {  }

Read input from com port.

Input chars are added to global input buffer (buf)

Defined in:

trimble.tcl, line 23

::Send

proc  ::Send { msg }

Send message to the instrument and wait for answer

Parameters:

msg - message to send

Returns:

0 on success or nonzero error status

Defined in:

trimble.tcl, line 85

::SetAtmCorr

proc  ::SetAtmCorr { ppm pres dry wet }

Set atmospheric correction setting

Parameters:

ppm - correction @parampres pressure value @paramd dry dry temperature

wet - wet temperature

Returns:

0 or error code

Defined in:

trimble.tcl, line 218

::SetATR

proc  ::SetATR { atr }

Set ATR status -- dummy function for compatibility purposes

Parameters:

atr - 0/1 = off/on

Returns:

-1 (always error)

Defined in:

trimble.tcl, line 161

::SetEDMMode

proc  ::SetEDMMode { mode }

Set EDM mode

Parameters:

mode - EDM mode to set 1 - single to tape 2 - single to prism 3 - single fast to prism 4 - single long range 5 - single short range 6 - tracking to prism 7 - tracking dynamic 8 - tracking reflector less 9 - tracking fast 10- averaging to prism 11- averaging short range 12- averaging long range

Returns:

0 on success, non zero in case of error

Defined in:

trimble.tcl, line 302

::SetLock

proc  ::SetLock { lock }

Set Lock status -- dummy function for compatibility purposes

Parameters:

lock - - 0/1 = off/on

Returns:

-1 (always error)

Defined in:

trimble.tcl, line 174

::SetOri

proc  ::SetOri { ori {units DEG} }

Set orientation angle

Parameters:

ori - orientation angle

Returns:

0 or error code

Defined in:

trimble.tcl, line 310

::SetPc

proc  ::SetPc { pc }

Set prism constant

Parameters:

pc - prism constant in mm

Returns:

0 on success or nonzero error code

Defined in:

trimble.tcl, line 137

::SetRefCorr

proc  ::SetRefCorr { on r s }

Set refraction correction on/off

Parameters:

on - 0/1 off/on

r - earth radius

s - refractive scale

Returns:

0 or error code

Defined in:

trimble.tcl, line 253

::SetStation

proc  ::SetStation { e n z }

Set station coordinates (dummy proc for compatibility puspose)

Parameters:

e - easting

n - northing

z - elevation

Returns:

-1 (always error)

Defined in:

trimble.tcl, line 276