leica.tcl Annotations

Leica TCA1800/RTS1200 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)

::Coords

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

Read coordinates from instrument calculated from last distance measurement

Parameters:

wait - wait time in ms, optional (default 1000)

incl - inclination calculation - 0/1/2 = measure always (slow)/calculate (fast)/automatic, optional (default 0)

Returns:

coordinate list : {{38 Easting} {37 Northing} {39 Height}}

Defined in:

leica.tcl, line 314

::GetAngles

proc  ::GetAngles {  }

Read angles from instrument

Returns:

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

Defined in:

leica.tcl, line 328

::GetAtmCorr

proc  ::GetAtmCorr {  }

Get atmospheric correction settings

Returns:

atmospheric settings as a list {lambda pressure drytemp wettemp}

Defined in:

leica.tcl, line 106

::GetATR

proc  ::GetATR {  }

Get ATR status

Returns:

0/1 - off/on

Defined in:

leica.tcl, line 63

::GetEDMMode

proc  ::GetEDMMode {  }

Get EDM (Electronic Distance Meter) mode

Returns:

mode

Defined in:

leica.tcl, line 185

::GetId

proc  ::GetId {  }

Read instrument id

Returns:

instrument id

Defined in:

leica.tcl, line 350

::GetInstrument

proc  ::GetInstrument {  }

Read instrument name

Returns:

instrument name

Defined in:

leica.tcl, line 340

::GetIntTemp

proc  ::GetIntTemp {  }

Get internal temperature

Returns:

internal temperature in Celsius

Defined in:

leica.tcl, line 373

::GetLock

proc  ::GetLock {  }

Get Lock status

Returns:

0/1 - off/on

Defined in:

leica.tcl, line 91

::GetPc

proc  ::GetPc {  }

Get prism constant

Returns:

pc, mm unit

Defined in:

leica.tcl, line 38

::GetRefCorr

proc  ::GetRefCorr {  }

Get refraction correction setting

Returns:

refraction correction as a list {on earthradius scale}

Defined in:

leica.tcl, line 131

::GetStation

proc  ::GetStation {  }

Get station co-ordinates

Returns:

list {{37 N} {38 E} {39 Z}}

Defined in:

leica.tcl, line 156

::Measure

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

Measure distance

[NOTE: call "Measure 3" to clear previous distance measurement]

Parameters:

prg - measure program 1/2/3/... = default/track/clear..., optional (default 1)

wait - time in ms, optional (default 12000)

incl - inclination calculation - 0/1/2 = measure always (slow)/calculate (fast)/automatic, optional (default 0)

Returns:

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

Defined in:

leica.tcl, line 267

::Measure1

proc  ::Measure1 {  }

Measure distance

Returns:

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

Defined in:

leica.tcl, line 287

::Move

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

Rotate instrument to given direction

Parameters:

hz - horizontal direction

v - zenith angle

units - units for angles, optional (default RAD) see ChangeAngle

atr - 0/1 no atr/with atr, optional (default 0)

Returns:

return 0 or error code

Defined in:

leica.tcl, line 250

::MoveAndMeasure

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

Rotate the instrument and measure distance

Parameters:

hz - horizontal direction

v - zenith angle

units - angle unit, optional (default RAD)

atr - 0/1 atr off/on

Defined in:

leica.tcl, line 304

::Search

proc  ::Search { hzArea vArea {units RAD} }

Search prism in a given area (elliptical)

Parameters:

hzArea - horizontal search region

vArea - vertical search region

units - units for hzArea and vArea

Returns:

0 on success or error code TODO check 17020

Defined in:

leica.tcl, line 364

::SetAtmCorr

proc  ::SetAtmCorr { lambda pres dry wet }

Set atmospheric correction settings

Parameters:

lambda - Constant for the instrument not changeable, use GetAtmCorr to get value

pres - pressure value

dry - dry temperature

wet - wet temperature

Returns:

0 or error code

Defined in:

leica.tcl, line 122

::SetATR

proc  ::SetATR { atr }

Set ATR status on/off

Parameters:

atr - 0/1 = off/on

Returns:

0 or error code

Defined in:

leica.tcl, line 51

::SetEDMMode

proc  ::SetEDMMode { mode }

Set EDM mode

Parameters:

mode - EDM mode to set
0 - 1 - single to tape
2 - single to prism
3 - single fast to prism
4 - single long range
5 - single short range/ reflector less
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 TBD modes are changed

Defined in:

leica.tcl, line 212

::SetLock

proc  ::SetLock { lock }

Set Lock status on/off

Parameters:

lock - 0/1 = off/on

Returns:

0 or error code

Defined in:

leica.tcl, line 79

::SetOri

proc  ::SetOri { ori {units RAD} }

Set orientation angle

Parameters:

ori - whole circle bearing for the actual direction

unit - unit for bearing, optional (default RAD)

Returns:

return 0 or error code

Defined in:

leica.tcl, line 224

::SetPc

proc  ::SetPc { pc }

Set prism constant

Parameters:

pc - prism constant to set, mm unit

Returns:

0 on succes or nonzero error code

Defined in:

leica.tcl, line 27

::SetRCS

proc  ::SetRCS { rcs }

Set RCS searching mode

Defined in:

leica.tcl, line 237

::SetRefCorr

proc  ::SetRefCorr { on r s }

Set refraction correction settings

Parameters:

on - 0/1 off/on

r - earth radius

s - refractice scale

Returns:

0 or error code

Defined in:

leica.tcl, line 146

::SetStation

proc  ::SetStation { e n z }

Set station coordinates

Parameters:

e - easting

n - northing

z - elevation

Returns:

0 or error code

Defined in:

leica.tcl, line 175