Leica TM30 Series Reference Manual Download Page 78 | Manualshive

Page: 78 / 207

background image

GeoCOM Reference Manual

Basic Applications – BAP

Leica TPS1200 / TS30 / TM30 – Version 1.50

78

8.3.8

BAP_GetUserPrismDef – getting the user prism definition

BAP_GetUserPrismDef .............................................................................................................................................................................................................................................................................

ismDef

........................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................ 17033

17033...............................................................................................................................................................................................................................................................BAP_GetUserPr

C-Declaration

BAP_GetUserPrismDef (char *szPrismName,
double &rdAddConst,

BAP_REFLTYPE &reReflType,

char *szCreator)

VB-Declaration

VB_BAP_GetUserPrismDef(ByVal szPrismName As String,
rdAddConst As Double,
reReflType As Long,
ByVal szCreator As String)

ASCII-Request

%R1Q,17033:

szPrismName[String]

ASCII-Response

%R1P,0,0:

RC,

rdAddConst[double], reReflType[long], szCreator[String]

Remarks

Gets definition of a defined user prism.

Parameters

szPrismName In

Prism name

dAddConst Out

Prism correction [m]

eReflType Out

Reflector type

szCreator Out

Name of creator

Return-Code Names and Return-Code Values

GRC_OK

0 Execution

successful.

GRC_IVPARAM

2 Invalid

prism

definition

See Also

BAP_SetPrismType()
BAP_SetPrismType2()
BAP_GetPrismDef()
BAP_GetUserPrismDef()

Example

-

«
...
76
77
78
79
80
...
»

Summary of Contents for TM30 Series

Page 1: ...Leica TPS1200 Leica TS30 TM30 GeoCOM Reference Manual Version 1 50 English...

Page 2: ...1 STRUCTURE OF DESCRIPTIONS 19 5 COMMUNICATION SETTINGS 21 5 1 USAGE 21 5 2 CONSTANTS AND TYPES 21 5 3 GENERAL GEOCOM FUNCTIONS 22 5 4 CLIENT SPECIFIC GEOCOM FUNCTIONS 24 6 ALT USER AUS 38 6 1 USAGE...

Page 3: ...CONSTANTS AND TYPES 141 17 4 MEASUREMENT FUNCTIONS 144 17 5 MEASUREMENT CONTROL FUNCTIONS 157 17 6 DATA SETUP FUNCTIONS 160 17 7 INFORMATION FUNCTIONS 177 17 8 CONFIGURATION FUNCTIONS 179 18 PORTING A...

Page 4: ...Contents Microsoft MS MS DOS Windows Windows NT Win32 Visual C and Visual Basic are either registered trademarks or trademarks of Microsoft Corporation in the USA and other countries Leica TPS1200 TS...

Page 5: ...nt It provides a set of functions to access sensors and calculated values These functions are organised as subsystems We will keep this segmentation in this document These functions can be grouped in...

Page 6: ...orms which do not support MS Windows On the high level GeoCOM provides normal function call interfaces for C C and MS VBA to these remote functions These interfaces enable a programmer to implement an...

Page 7: ...n A request reply pair cannot be interrupted by another request reply Instead a communication unit must be completed successfully before a new communication unit may be initiated An indicator for comp...

Page 8: ...0 Parameter 1 These parameters will be valid only if GRC is equal to 0 GRC_OK Term Terminator string default CR LF use COM_SetTerminator to change the terminator Example The following example shows th...

Page 9: ...Chapter 2 4 The only difference between VBA and C C is that VBA has a different type system Hence the defined data types differ slightly in their definition Furthermore because of implementation reaso...

Page 10: ...eading LF to clear the receiver buffer at the server side This will reduce unnecessary error messages of the next RPC 3 2 1Data Types in ASCII Protocol Each parameter of a RPC has its own associated d...

Page 11: ...the declaration of the C data type For clarification we will give always the name and the associated value in the description of an enumeration data type Structures Structure data types will be conver...

Page 12: ...active no support can be given from the TPS1200 instrument The only way to distinguish between modes is to remind the actions an application has initiated and their resulting replies So far no other...

Page 13: ...stem files have been developed using Microsoft Visual C C 6 0 Although this development environment were the basis for the current GeoCOM implementation it has been emphasised that it is independent o...

Page 14: ...BA does not have enumeration data types Therefore Long data types will be used instead The enumeration values will be defined by constants Using the numerical value is also valid Notice that some of t...

Page 15: ...Then bOpenAndRunning True End If End If optionally set up other comm parameters here If RetCode GRC_OK Then functionality of the application we just test if communication is up RetCode VB_COM_NullPro...

Page 16: ...he instrument a single character is sufficient GeoCOM The instrument accepts RPC s To switch into GeoCOM mode start the Configuration menu on the instrument open the submenu Interfaces and enable inte...

Page 17: ...in the server An attempt has been made to call an RPC which does not exist This is usually caused when calling RPC s which have been inserted appended deleted or altered between the differing version...

Page 18: ...llocated to another application GRC_COM_PORT_NOT_OPEN 3104 COM port not opened initialised The application has attempted to use a COM port to which it has no unique rights GRC_COM_NO_PARTNER 3105 No c...

Page 19: ...e subsystems are listed here and described in detail Note To reduce redundancy the VB declarations of data types and constants have been omitted Please refer to chapter 3 3 to get more information abo...

Page 20: ...teAndTime As DATIME ASCII Request R1Q 5008 ASCII Response R1P 0 0 RC Year short Month Day Hour Minute Second all byte Remarks The ASCII response a type DATIME A possible response can look like this R1...

Page 21: ...f the transmission takes place in a readable ASCII data format or in a data size optimised binary data format enum COM_FORMAT COM_ASCII 0 Force ASCII comm COM_BINARY 1 Enable binary comm Baud Rate enu...

Page 22: ...ode Precision is equal in both transmission directions In the case of an ASCII request the precision of the server side will be returned Parameters nDigits Out Number of digits to the right of the dec...

Page 23: ...not needed then transmission of double data ASCII transmission can be speeded up by choosing a lower precision Especially when many double values are transmitted this may enhance the operational speed...

Page 24: ...it initialising GeoCOM COM_Init C Declaration COM_Init void VB Declaration VB_COM_Init ASCII Request ASCII Response Remarks COM_Init has to be called to initialise internal buffers and variables It do...

Page 25: ...Declaration VB_COM_End ASCII Request ASCII Response Remarks COM_End has to be called to finish up all open GeoCOM transactions It closes an open port and does whatever is necessary to shutdown GeoCOM...

Page 26: ...uch a case it may take several retries to establish a connection Since default timeout is three seconds we recommend nRetries to be 1 4 GeoCOM chooses during start up the default transmission data for...

Page 27: ...loseConnection void VB Declaration VB_COM_CloseConnection ASCII Request ASCII Response Remarks This function closes the current open port and releases an established connection It will not change the...

Page 28: ...ne Return Code Names and Return Code Values GRC_OK 0 Execution successful See Also COM_OpenConnection Example void main GRC_TYPE rc COM_BAUD_RATE eRate init GeoCOM get baud rate of active connection r...

Page 29: ...GeoCOM Reference Manual Communication Settings Leica TPS1200 TS30 TM30 Version 1 50 29 shutdown GeoCOM end of main...

Page 30: ...CII Response Remarks This function retrieves the current timeout value for a request in seconds The timeout value is the delay GeoCOM will wait for completion before it signals an error to the calling...

Page 31: ...ue in seconds The timeout value is the delay GeoCOM will wait for completion of the last RPC before it signals an error to the calling application A zero timeout value indicates no wait But be aware o...

Page 32: ...VB_COM_GetComFormat eComFormat As Long ASCII Request ASCII Response Remarks This function gets the actual transmission data format Parameters eComFormat Out COM_ASCII or COM_BINARY Return Code Names a...

Page 33: ...ays replies in the data format that it has received the request Parameters EComFormat Out COM_ASCII or COM_BINARY Return Code Names and Return Code Values GRC_OK 0 Execution successful GRC_COM_PORT_NO...

Page 34: ...that GeoCOM uses when it creates a dialog or message box If this function is not called GeoCOM will use the NULL window as default Note HWND depends on whether the pre processor symbol STRICT is defi...

Page 35: ...unction checks the value of Result and if it is not equal to GRC_OK then it pops up a message box containing the specific error text Note This function yields a valid error text only if GeoCOM has bee...

Page 36: ...ng ASCII Request ASCII Response Remarks This function checks the value of Result and returns an error text if the value is not equal to GRC_OK The function yields an empty string if the value is GRC_O...

Page 37: ...nSubVer As Integer ASCII Request ASCII Response Remarks This function retrieves the actual software Release Release version and subversion of GeoCOM on the client side Parameters nRel Out Software Rel...

Page 38: ...a TPS1200 TS30 TM30 Version 1 50 38 6 ALT USER AUS 6 1 USAGE This subsystem contains functions to switch between the automation modes ATR LOCK and to query the current status 6 2 CONSTANTS AND TYPES O...

Page 39: ...the ATR mode on automated instrument models This command does not indicate whether the ATR has currently acquired a prism Note the difference between GetUserATR and GetUserLOCK state Parameters OnOff...

Page 40: ...ivates the ATR mode Activate ATR mode The ATR mode gets activated If LOCK mode is on and the command is sent then LOCK mode changes to ATR mode Deactivate ATR mode The ATR mode gets deactivated If LOC...

Page 41: ...s to be used Parameters OnOff Out State of the LOCK mode Return Code Names and Return Code Values GRC_OK 0 Execution successful GRC_NOT_IMPL 5 ATR not available no automated instrument See Also AUS_Se...

Page 42: ...he LOCK mode is activated This does not mean that the instrument is locked onto a prism In order to lock and follow a moving target see the function AUT_LockIn Status OFF The LOCK mode is deactivated...

Page 43: ...aborted by sending c Term Note Automation RPC s require valid GeoCOM robotic license key for successful execution 7 3 CONSTANTS AND TYPES Number of axis const short MOT_AXES 2 Positioning Tolerance s...

Page 44: ...ection double dNegativeDetent Detent in negative direction BOOLE bActive Is detent active Search Spiral struct AUT_SEARCH_SPIRAL double dRangeHz width of search area rad double dRangeV maximal height...

Page 45: ...torized instruments only Parameters TolPar out The values for the positioning tolerances in Hz and V direction rad Return Code Names and Return Code Values GRC_OK 0 Execution successful GRC_NA 27 GeoC...

Page 46: ...olerances must be in the range of 1 cc 1 57079 E 06 rad to 100 cc 1 57079 E 04 rad Note The maximum resolution of the angle measurement system depends on the instrument accuracy class If smaller posit...

Page 47: ...tioning time out maximum time to perform positioning Parameters TimeoutPar Out The values for the positioning time out in Hz and V direction sec Return Code Names and Return Code Values GRC_OK 0 Execu...

Page 48: ...Response R1P 0 0 RC Remarks This command set the positioning timeout set maximum time to perform a positioning The timeout is reset on 7 sec after each power on Parameters TimeoutPar in The values for...

Page 49: ...T_TARGET the instrument tries to position onto a target in the destination area If LOCK mode is activated and the ATR mode is set to AUT_TARGET the instrument tries to lock onto a target in the destin...

Page 50: ...See Also AUS_GetUserAtrState AUS_SetUserAtrState AUS_GetUserLockState AUS_SetUserLockState AUT_ReadTol AUT_SetTol AUT_ReadTimeout AUT_SetTimeout COM_GetTimeOut COM_SetTimeOut Example The example prog...

Page 51: ...se GRC_AUT_ANGLE_ERROR error within angle measurement switch inclination correction off hrc TMC_SetInclineSwitch OFF break default precise position not possible TryAgain FALSE if rc GRC_AUT_INCACC Pos...

Page 52: ...target in the destination area Parameters POSMode In Position mode AUT_NORMAL uses the current value of the compensator For positioning distances 25GON AUT_NORMAL might tend to inaccuracy AUT_PRECISE...

Page 53: ...program performs a change face If a measurement error occurs the automatic inclination correction is switched off and the change face starts again GRC_TYPE rc rch BOOL TryAgain TRUE AUT_POSMODE POSMod...

Page 54: ...AUT_GetFineAdjustMode Tolerance settings with AUT_SetTol and AUT_ReadTol have no influence to this operation The tolerance settings as well as the ATR measure precision depends on the instrument s cl...

Page 55: ...ate ON performs a fine position with a max target search range of 0 08rad 5gon in Hz and V direction Result AUT_FineAdjust dHzSearchRange dVSearchRange FALSE switch Result function return code case GR...

Page 56: ...Vertical search region rad bDummy In It s reserved for future use set bDummy always to FALSE Return Code Names and Return Code Values GRC_OK 0 Execution successful GRC_NA 27 GeoCOM Robotic license ke...

Page 57: ...ch area Hz_Area 0 1 V_Area 0 1 if Hz_Area 1 TryAgain FALSE break case GRC_COM_TIMEDOUT communication timeout increase timeout until 30s hrc COM_GetTimeOut nComTimeOut nComTimeOut short __min nComTimeO...

Page 58: ...ode As Long ASCII Request R1Q 9030 ASCII Response R1P 0 0 RC AdjMode integer Remarks This function returns the current activated fine adjust positioning mode This command is valid for all instruments...

Page 59: ...mand is valid for all instruments but has only effects for instruments equipped with ATR If a target is very near or held by hand it s recommended to set the adjust mode to AUT_POINT_MODE Parameters A...

Page 60: ...Return Code Names and Return Code Values GRC_OK 0 Execution successful GRC_NA 27 GeoCOM Robotic license key not available GRC_AUT_MOTOR_ERROR 8707 Instrument has no motorization GRC_AUT_DETECTOR_ERRO...

Page 61: ...II Response R1P 0 0 RC dCenterHz double dCenterV double dRangeHz double dRangeV double bEnabled Boolean Remarks This function returns the current position and size of the PowerSearch Window This comma...

Page 62: ...tion defines the position and dimensions and activates the PowerSearch window This command is valid for all instruments but has only effects for instruments equipped with PowerSearch Parameters Area I...

Page 63: ...RCH_SPIRAL ASCII Request R1Q 9040 ASCII Response R1P 0 0 RC dRangeHz double dRangeV double Remarks This function returns the current dimension of ATR search window This command is valid for all instru...

Page 64: ...double ASCII Response R1P 0 0 RC Remarks This function sets the dimension of the ATR search window This command is valid for all instruments but has only effects for instruments equipped with ATR Par...

Page 65: ...ble As Boolean ASCII Request R1Q 9048 Enable BOOLE ASCII Response R1P 0 0 RC Remarks This command enables disables the predefined PowerSearch window including the predefined PowerSearch range limits s...

Page 66: ...R1P 0 0 RC Remarks This command defines the PowerSearch distance range limits These additional limits additional to the PowerSearch window will be used once the range checking is enabled AUT_PS_Enabl...

Page 67: ...CII Response R1P 0 0 RC Remarks This command starts PowerSearch inside the given PowerSearch window defined by AUT_SetSearchArea and optional by AUT_PS_SetRange Parameters Return Code Names and Return...

Page 68: ...efault PowerSearch and searches for the next target A previously defined PowerSearch window AUT_SetSearchArea is not taken into account Use AUT_PS_SearchWindow to do so Parameters lDirection In Define...

Page 69: ...AP_CONT_RLESS_VISIBLE 6 RL Fast Tracking BAP_AVG_REF_STANDARD 7 IR Average BAP_AVG_REF_VISIBLE 8 LO Average BAP_AVG_RLESS_VISIBLE 9 RL Average BAP_CONT_REF_SYNCHRO 10 IR Synchro Tracking BAP_SINGLE_RE...

Page 70: ...AP_REFL_USE 0 with reflector BAP_REFL_LESS 1 without reflector ATR low vis mode definition typedef enum BAP_ATRSET_NORMAL ATR is using no special flags or modes BAP_ATRSET_LOWVIS_ON ATR low vis mode o...

Page 71: ...getType BAP_TARGET_TYPE eTargetType VB Declaration VB_BAP_GetTargetType eTargetType As Long ASCII Request R1Q 17022 ASCII Response R1Q 0 0 RC eTargetType long Remarks Gets the current EDM type for dis...

Page 72: ...arks Sets the current EDM type for distance measurements Reflector IR or Reflectorless RL For each EDM type the last used EDM mode is remembered and activated if the EDM type is changed If EDM type IR...

Page 73: ...ion BAP_GetPrismType BAP_PRISMTYPE ePrismType VB Declaration VB_BAP_GetPrismType ePrismType As Long ASCII Request R1Q 17009 ASCII Response R1Q 0 0 RC ePrismType long Remarks Gets the current prism typ...

Page 74: ...B Declaration VB_BAP_SetPrismType byVal ePrismType As Long ASCII Request R1Q 17008 ePrismType long ASCII Response R1P 0 0 RC Remarks Sets the prism type for measurements with a reflector It overwrites...

Page 75: ...ePrismType char szPrismName VB Declaration VB_BAP_GetPrismType2 rePrismType As Long ByVal szPrismName As String ASCII Request R1Q 17031 ASCII Response R1Q 0 0 RC ePrismType long szPrismName string Rem...

Page 76: ...rismType long szPrismName string ASCII Response R1P 0 0 RC Remarks Sets the default or user prism type for measurements with a reflector It overwrites the prism constant set by TMC_SetPrismCorr For se...

Page 77: ...VB Declaration VB_BAP_GetPrismDef byval ePrism As Long PrismDef As BAP_PRISMDEF ASCII Request R1Q 17023 ePrismType long ASCII Response R1Q 0 0 RC Name String dAddConst double eReflType long Remarks Ge...

Page 78: ...tring rdAddConst As Double reReflType As Long ByVal szCreator As String ASCII Request R1Q 17033 szPrismName String ASCII Response R1P 0 0 RC rdAddConst double reReflType long szCreator String Remarks...

Page 79: ...ng dAddConst As Double eReflType As Long ByVal szCreator As String ASCII Request R1Q 17032 szPrismName String dAddConst double eReflType long szCreator String ASCII Response R1P 0 0 RC Remarks Defines...

Page 80: ...AP_GetMeasP C Declaration BAP_GetMeasPrg BAP_USER_MEASPRG eMeasPrg VB Declaration VB_BAP_GetMeasPrg eMeasPrg As Long ASCII Request R1Q 17018 ASCII Response R1Q 0 0 RC eMeasPrg long Remarks Gets the cu...

Page 81: ...quest R1Q 17019 eMeasPrg long ASCII Response R1P 0 0 RC Remarks Defines the distance measurement program i e for BAP_MeasDistanceAngle RL EDM type programs are not available on all instrument types Ch...

Page 82: ..._MeasDistanceAngle may additionally return AUT and TMC return codes GRC_OK 0 Execution successful GRC_AUT_ANGLE_ERROR 8706 Angle measurement error GRC_AUT_BAD_ENVIRONMENT 8712 Bad Environment conditio...

Page 83: ...witch rc case GRC_IVPARAM printf Wrong value for DistMode break case GRC_ABORT printf Measurement aborted break case GRC_SHUT_DOWN printf System has been stopped break case GRC_TMC_DIST_PPM printf PPM...

Page 84: ...ers bDummy In It s reserved for future use set bDummy always to FALSE Return Code Names and Return Code Values GRC_OK 0 Execution successful GRC_AUT_BAD_ENVIRONMENT 8712 Bad Environment conditions GRC...

Page 85: ...etting As Long ASCII Request R1Q 17034 ASCII Response R1Q 0 0 RC reATRSetting long Remarks Gets the current low vis mode Parameters reATRSetting Out BAP_LOWVIS_NORMAL ATR is using no special flags mod...

Page 86: ..._GetPrismT C Declaration BAP_SetATRSetting BAP_ATRSETTING eATRSetting VB Declaration VB_ BAP_SetATRSetting ByVal eATRSetting As Long ASCII Request R1Q 17035 eATRSetting long ASCII Response R1Q 0 0 RC...

Page 87: ...tion BAP_GetRedATRFov ON_OFF_TYPE reRedFov VB Declaration VB_BAP_GetRedATRFov reRedFov As Long ASCII Request R1Q 17036 ASCII Response R1Q 0 0 RC reRedFov long Remarks Get reduced ATR field of view mod...

Page 88: ...ion BAP_SetRedATRFov ON_OFF_TYPE eRedFov VB Declaration VB_BAP_SetRedATRFov ByVal eRedFov As Long ASCII Request R1Q 17037 eRedFov long ASCII Response R1Q 0 0 RC Remarks Set reduced ATR field of view m...

Page 89: ...nctions which are relevant for controlling the display keyboard character sets and the beeper signalling device In GeoCOM only the beep control functions are supported The description of the IOS beep...

Page 90: ...11004 BMM_BeepAlarm void VB Declaration VB_BMM_BeepAlarm ASCII Request R1Q 11004 ASCII Response R1P 0 0 RC Remarks This function produces a triple beep with the configured intensity and frequency whi...

Page 91: ...tion BMM_BeepNormal void VB Declaration VB_BMM_BeepNormal ASCII Request R1Q 11003 ASCII Response R1P 0 0 RC Remarks This function produces a single beep with the configured intensity and frequency whi...

Page 92: ...1Q 20001 nIntens short ASCII Response R1P 0 0 RC Remarks This function switches on the beep signal with the intensity nIntens If a continuous signal is active it will be stopped first Turn off the bee...

Page 93: ...BeepOff 20000 20000 IOS_BeepOff C Declaration IOS_BeepOff void VB Declaration VB_IOS_BeepOff ASCII Request R1Q 20000 ASCII Response R1P 0 0 RC Remarks This function switches off the beep signal Parame...

Page 94: ...r and the TPS1200 and also some functions to get and set communication relevant parameters on the server side Furthermore it implements functions to switch on or off sleep mode shut down the TPS1200 i...

Page 95: ...ASCII Response R1P 0 0 RC nRel short nVer short nSubVer short Remarks This function displays the current GeoCOM release release version and subversion of the instrument Parameters nRel Out Software r...

Page 96: ...then R1P 0 0 5 else Nothing Remarks This function switches on the TPS1200 instrument Note The TPS1200 instrument can be switched on by any RPC command or even by sending a single character Parameters...

Page 97: ...eclaration COM_SwitchOffTPS COM_TPS_STOP_MODE eOffMode VB Declaration VB_COM_SwitchOffTPS ByVal eOffMode As Long ASCII Request R1Q 112 eOffMode short ASCII Response R1P 0 0 RC Remarks This function sw...

Page 98: ...COM_NullProc C Declaration COM_NullProc void VB Declaration VB_COM_NullProc ASCII Request R1Q 0 ASCII Response R1P 0 0 RC Remarks This function does not provide any functionality except of checking i...

Page 99: ...bAvailable As Long ASCII Request R1Q 113 ASCII Response R1P 0 0 RC bAvailable Boolean Remarks This function gets the ability information about the server to handle binary communication The client may...

Page 100: ...st R1Q 114 bAvailable Boolean ASCII Response R1P 0 0 RC Remarks This function sets the ability of the server to handle binary communication With this function one can force to communicate in ASCII onl...

Page 101: ...0 family member TPS_CLASS_2003 6 TPS2000 family member TPS_CLASS_5005 7 TPS5000 family member TPS_CLASS_5100 8 TPS5000 family member TPS_CLASS_1102 100 TPS1100 family member 2 TPS_CLASS_1103 101 TPS11...

Page 102: ...eflectorless Class enum TPS_REFLESS_CLASS TPS_REFLESS_NONE 0 TPS_REFLESS_R100 1 Pinpoint R100 TPS_REFLESS_R300 2 Pinpoint R300 TPS_REFLESS_R400 3 Pinpoint R400 TPS_REFLESS_R1000 4 Pinpoint R1000 Gener...

Page 103: ...entNo long SerialNo VB Declaration VB_CSV_GetInstrumentNo SerialNo As Long ASCII Request R1Q 5003 ASCII Response R1P 0 0 RC SerialNo long Remarks Gets the factory defined serial number of the instrume...

Page 104: ...char Name VB Declaration VB_CSV_GetInstrumentName Name As String ASCII Request R1Q 5004 ASCII Response R1P 0 0 RC Name string Remarks Gets the instrument name for example TS30 0 5 Parameters Name Out...

Page 105: ...35 ASCII Response R1P 0 0 RC DevicePrecisionClass long DeviceConfigurationType long Remarks This function returns information about the class and the configuration type of the instrument Parameters De...

Page 106: ...tReflectorlessClass reRefLessClass As TPS_REFLESS_CLASS ASCII Request R1Q 5100 ASCII Response R1P 0 0 RC reRefLessClass long Remarks This function returns information about the reflectorless and long...

Page 107: ...ATIME A possible response can look like this R1P 0 0 0 1996 07 19 10 13 2f see chapter ASCII data type declaration for further information Parameters DateAndTime Out Encoded date and time Return Code...

Page 108: ...E DateAndTime VB Declaration VB_CSV_SetDateTime ByVal DateAndTime As DATIME ASCII Request R1Q 5007 Year short Month Day Hour Minute Second all byte ASCII Response R1P 0 0 RC Remarks Sets the current d...

Page 109: ...nSubVersion As Integer ASCII Request R1Q 5034 ASCII Response R1P 0 0 RC nRelease nVersion nSubVersion all short Remarks Returns the system software version Parameters nRelease Out Release nVersion Ou...

Page 110: ...0 0 RC unCapacity long eActivePower long ePowerSuggest long Remarks This command returns the capacity of the current power source and its source internal or external Parameters unCapacity Out Actual...

Page 111: ...n VB_CSV_GetIntTemp Temp As double ASCII Request R1Q 5011 ASCII Response R1P 0 0 RC Temp long Remarks Get the internal temperature of the instrument measured on the Mainboard side Values are reported...

Page 112: ...Integer nMonth As Integer nDay As Integer nHour As Integer nMinute As Integer nSecond As Integer nCentiSec As Integer ASCII Request R1Q 5117 ASCII Response R1P 0 0 RC Year Month Day Hour Minute Secon...

Page 113: ...pointer and the Electronic Guide Light respectively Additionally it is possible to change the brightness using EDM_SetEGLIntensity 12 2 USAGE In order to use the functions concerning the Laserpointer...

Page 114: ...which support distance measurement without reflector Parameters eOn In ON switch Laserpointer on OFF switch Laserpointer off Return Code Names and Return Code Values GRC_OK 0 Execution successful GRC...

Page 115: ...eIntensity VB Declaration VB_EDM_GetEglIntensity eIntensity As Long ASCII Request R1Q 1058 ASCII Response R1Q 0 0 RC eIntensity long Remarks Displays the intensity of the Electronic Guide Light Parame...

Page 116: ...ode Values GRC_OK 0 Execution successful GRC_SYSBUSY 13 EDM already busy GRC_EDM_DEV_NOT_INSTALLED 778 Electronic Guide Light not implemented GRC_EDM_INVALID_COMMAND 770 When an invalid intensity is e...

Page 117: ...secure transmission of files See also COM_SetComFormat Path Device type ata1a FTR_DEVICE_INTERNAL ata0a FTR_DEVICE_PCPARD Path File type s Extension wildcard s Images FTR_FILE_IMAGES jpg 13 2 CONSTAN...

Page 118: ...ration VB_FTR_SetupList DeviceType As Long FileType As Long ByVal SearchPath As String Request R1Q 23306 eDeviceType eFileType szSearchPath ASCII Response R1P 0 0 RC Remarks This command sets up the d...

Page 119: ...alid if the file name is empty Return Codes GRC_OK 0 Execution successful GRC_FTR_MISSINGSETUP 13060 Missing setup GRC_FTR_INVALIDINPUT 13059 First block is missing or last time was already last block...

Page 120: ...GeoCOM Reference Manual File Transfer FTR Leica TPS1200 Version 1 50 120 while bLast TRUE FTR_AbortList...

Page 121: ...T_ReadTol 9008 9011 AUT_ReadTol C Declaration FTR_AbortList void VB Declaration VB_FTR_AbortList Request R1Q 23308 ASCII Response R1P 0 0 RC Remarks This command aborts or ends file list command Param...

Page 122: ...OfBlocks Remarks This command sets up the download of a file from the instrument It has to be called before command FTR_Download can be used Parameters eDeviceType in Device type eFileType in File typ...

Page 123: ...r is 0 then the download process is aborted rBlock out Block of data Return Codes GRC_OK 0 Execution successful GRC_FTR_MISSINGSETUP 13060 Missing setup GRC_FTR_INVALIDINPUT 13059 First block is missi...

Page 124: ...File Transfer FTR Leica TPS1200 Version 1 50 124 error break write block to file unWritten fwrite Block FTR_BLOCK_val 1 Block FTR_BLOCK_len pFile if unWritten Block FTR_BLOCK_len error break FTR_Abor...

Page 125: ...l 9008 9014 AUT_ReadTol C Declaration FTR_AbortDownload void VB Declaration VB_FTR_AbortDownload Request R1Q 23305 ASCII Response R1P 0 0 RC Remarks This command aborts or ends file download command P...

Page 126: ...rds may be used to delete multiple files If deletion date is valid only files older than deletion date are deleted Parameters eDeviceType in Device type eFileType in File type DelDate in Deletion date...

Page 127: ...fix and a number in the following format prefix jpg e g image024 jpg 14 2 USAGE Imaging functionality applicable for TM30 TS30 only In order to use the imaging functionality make sure that a valid Geo...

Page 128: ...ber long szFileNamePrefix string Remarks Parameters eMemType In Memory device type ulImageNumber Out Actual image number ulQuality Out Jpeg compression quality factor 0 100 ulSubFunctNumber Out Binary...

Page 129: ...szFileNamePrefix string ASCII Response R1P 0 0 RC Remarks Parameters eMemType In Memory device type ulImageNumber In Actual image number ulQuality In Jpeg compression quality factor 0 100 ulSubFunctNu...

Page 130: ...Telescope Firmware GRC_FATAL 4 CF card is not available full GRC_NA 27 Imaging license key not available See Also IMG_GetTccConfig IMG_SetTccConfig Example GRC_TYPE rc IMG_MEM_TYPE eMemType IMG_TCC_CO...

Page 131: ...g These functions manage system parameters Examples are control parameter motion parameter tolerance and system configuration parameters Example MOT_ReadLockStatus 15 3 CONSTANTS AND TYPES Lock Condit...

Page 132: ...021 ASCII Response R1P 0 0 RC Status long Remarks This function returns the current condition of the LockIn control see subsystem AUT for further information This command is valid for automated instru...

Page 133: ...mmand is used to enable remote or user interaction to the motor controller Parameters ControlMode In Controller mode If used together with MOT_SetVelocity the control mode has to be MOT_OCONST Return...

Page 134: ...B_MOT_StopController Mode As Long ASCII Request R1Q 6002 Mode long ASCII Response R1P 0 0 RC Remarks This command is used to stop movement and to stop the motor controller operation Parameters Mode In...

Page 135: ...xecution successful GRC_IVPARAM 2 RefOmega adValue HZ and or RefOmega adValue V values are not within the boundaries GRC_MOT_NOT_CONFIG 1795 System is not in state MOT_CONFIG or MOT_BUSY_OPEN_END e g...

Page 136: ...GeoCOM Reference Manual Motorisation MOT Leica TPS1200 Version 1 50 136 handle error...

Page 137: ...ally status information e g system time battery position Memory Card and inclination measurement icons as well as local remote display It also controls the automatic shutdown mechanism 16 2 CONSTANTS...

Page 138: ...ng ASCII Request R1Q 14001 ASCII Response R1P 0 0 RC Reserved long AutoPower long Timeout long Remarks The returned settings are power off configuration and timing Parameters Reserved Out Reserved Aut...

Page 139: ...erved In Reserved AutoPower In Defines the behaviour of the power off mode Timeout In The timeout in ms After this time the device switches in the mode defined by the value of AutoPower when no user a...

Page 140: ...s result is okay Informative Return code indicates that the function was terminated successfully But some restrictions apply e g it can be reported that the angle values are okay the distance is inval...

Page 141: ...nt program TMC_TRK_DIST Starts the distance measurement in tracking mode TMC_STOP Stops measurement TMC_CLEAR Stops the measurement and clears the data TMC_SIGNAL Help mode for signal intensity measur...

Page 142: ...Coordinate m double dH H Coordinate m SYSTIME CoordTime Timestamp of dist Measurement ms double dE_Cont E Coordinate continuously m double dN_Cont N Coordinate continuously m double dH_Cont H Coordin...

Page 143: ...ure Wet temperature C Refraction Control Data struct TMC_REFRACTION ON_OFF_TYPE eRefOn Refraction correction On Off double dEarthRadius Radius of the earth m double dRefractiveScale Refraction coeffic...

Page 144: ...ian co ordinates Mode In Inclination sensor measurement mode Return Code Names and Return Code Values GRC_OK 0 Execution successful GRC_TMC_ACCURACY_GUARANTEE 1284 Accuracy is not guaranteed because t...

Page 145: ...HUT_DOWN 12 System power off through customer See Also TMC_DoMeasure TMC_IfDataAzeCorrError TMC_IfDataIncCorrError Example GRC_TYPE Result TMC_COORDINATE Coordinate make a single distance measurement...

Page 146: ...e angle measurement rad SlopeDistance Out Result of the distance measurement m Return Code Names and Return Code Values GRC_OK 0 Execution successful GRC_TMC_NO_FULL_CORRECTION 1283 The results are no...

Page 147: ...ement GRC_ABORT 8 Measurement through customer aborted GRC_SHUT_DOWN 12 System power off through customer See Also TMC_DoMeasure TMC_GetAngle5 Example GRC_TYPE rc TMC_HZ_V_ANG OnlyAngle double SlopeDi...

Page 148: ...e system Co ordinates are available GRC_TMC_NO_FULL_CORRECTION 1283 The results are not corrected by all active sensors Co ordinates are available In order to secure which correction is missing use th...

Page 149: ...GeoCOM Reference Manual Theodolite Measurement and Calculation TMC Leica TPS1200 Version 1 50 149 TMC_GetAngle5 TMC_GetSimpleMea Example see TMC_GetAngle5...

Page 150: ...are not corrected by all active sensors Co ordinates are available In order to secure which correction is missing use the both functions TMC_IfDataAzeCorrError and TMC_IfDataIncCorrError GRC_TMC_ANGL...

Page 151: ...tion successful break case GRC_TMC_NO_FULL_CORRECTION TMC_IfDataAzeCorrError bAzeCorrError TMC_IfDataIncCorrError bIncCorrError if bAzeCorrError coordinates are not corrected with the Aze deviation co...

Page 152: ...are available GRC_TMC_NO_FULL_CORRECTION 1283 The results are not corrected by all active sensors Co ordinates are available In order to secure which correction is missing use the both functions TMC_I...

Page 153: ...isCorr ON activated TMC_DoMeasure TMC_CLEAR clear distance first TMC_SetAngSwitch SwCorr before you can set the ANG switches the distance must be cleared CSV_GetDateTime Datime dstart_time Datime Time...

Page 154: ...GRC_OK case GRC_TMC_NO_FULL_CORRECTION break no distance data available case GRC_TMC_ANGLE_OK case GRC_TMC_ANGLE_NOT_FULL_CORR case GRC_TMC_ANGLE_NO_ACC_GUARANTY case GRC_TMC_DIST_ERROR case GRC_TMC_...

Page 155: ...nction ignores WaitTime and returns the results If no valid distance measurement is available and the distance measurement unit is not activated by TMC_DoMeasure before the TMC_GetFullMeas call the an...

Page 156: ...try it again GRC_TMC_DIST_PPM 1291 No distance measurement respectively no distance data because of wrong EDM settings Angle data are available but distance data are not available GRC_TMC_ANGLE_ERROR...

Page 157: ...lt of the distance measurement is kept in the instrument and is valid to the next TMC_DoMeasure command where a new distance is requested or the distance is clear by the measurement program TMC_CLEAR...

Page 158: ...t are consist of measuring data which accuracy could not be verified by the system Co ordinates are available GRC_TMC_NO_FULL_CORRECTION 1283 The results are not corrected by all active sensors Co ord...

Page 159: ...System power off through customer See Also TMC_IfDataAzeCorrError TMC_IfDataIncCorrError Example GRC_TYPE rc TMC_COORDINATE Coordinate rc VB_TMC_SetHandDist 10 1 TMC_AUTO_INC if rc GRC_OK calculate co...

Page 160: ...HT ASCII Request R1Q 2011 ASCII Response R1P 0 0 RC Height double Remarks This function returns the current reflector height Parameters Height Out Current reflector height m Return Code Names and Retu...

Page 161: ...ASCII Request R1Q 2012 Height double ASCII Response R1P 0 0 RC Remarks This function sets a new reflector height Parameters Height In new reflector height m Return Code Names and Return Code Values GR...

Page 162: ...rature VB Declaration VB_TMC_GetAtmCorr AtmTemperature As TMC_ATMOS_TEMPERATURE ASCII Request R1Q 2029 ASCII Response R1P 0 0 RC Lambda double Pressure double DryTemperature double WetTemperature doub...

Page 163: ...TEMPERATURE ASCII Request R1Q 2028 Lambda double Pressure double DryTemperature double WetTemperature double ASCII Response R1P 0 0 RC Remarks This function is used to set the parameters for the atmos...

Page 164: ...l active sensors Co ordinates are available In order to secure which correction is missing use the both functions TMC_IfDataAzeCorrError and TMC_IfDataIncCorrError GRC_TMC_ANGLE_OK 1285 Angle values o...

Page 165: ...Measurement and Calculation TMC Leica TPS1200 Version 1 50 165 Example GRC_TYPE Result clear existing distance first TMC_DoMeasure TMC_CLEAR set orientation to 0 Result TMC_SetOrientation 0 0 if Resul...

Page 166: ...Request R1Q 2023 ASCII Response R1P 0 0 RC PrismCorr double Remarks This function is used to get the prism constant Parameters PrismCorr Out Prism constant m Return Code Names and Return Code Values...

Page 167: ...veScale double Remarks This function is used to get the refraction coefficient for correction of measured height difference Parameters Refractive Out Refraction control data Return Code Names and Retu...

Page 168: ...EarthRadius double RefractiveScale double ASCII Response R1P 0 0 RC Remarks This function is used to set the refraction distortion coefficient for correction of measured height difference Parameters R...

Page 169: ...raction model Note that changing the refraction method is not indicated on the instrument s interface Parameters Method Out Refraction data Method 1 means method 1 for the rest of the world Method 2 m...

Page 170: ...od As Integer ASCII Request R1Q 2090 Method unsigned short ASCII Response R1P 0 0 RC Remarks This function is used to set the refraction model Parameters Method In Refraction data Method 1 means metho...

Page 171: ...Hi double Remarks This function is used to get the station coordinates of the instrument Parameters Station Out Instrument station co ordinates m Return Code Names and Return Code Values GRC_OK 0 Exe...

Page 172: ...Request R1Q 2010 E0 double N0 double H0 double Hi double ASCII Response R1P 0 0 RC Remarks This function is used to set the station coordinates of the instrument Parameters Station In Instrument stati...

Page 173: ...MC_GetAtmPpm double dPpmA VB Declaration VB_TMC_GetAtmPpm dPpmA As Double ASCII Request R1Q 2151 ASCII Response R1P 0 0 RC dPpmA double Remarks This function retrieves the atmospheric ppm value Parame...

Page 174: ...tAtmPpm double dPpmA VB Declaration VB_TMC_SetAtmPpm ByVal dPpmA As Double ASCII Request R1Q 2148 dPpmA double ASCII Response R1P 0 0 RC Remarks This function is used to set the atmospheric ppm value...

Page 175: ...ble ASCII Request R1Q 2154 ASCII Response R1P 0 0 RC unGeomUseAutomatic unsigned short dScaleFactorCentralMeridian double dOffsetCentralMeridian double dHeightReductionPPM double dIndividualPPM double...

Page 176: ...idualPPM as Double ASCII Request R1Q 2153 unGeomUseAutomatic unsigned short dScaleFactorCentralMeridian double dOffsetCentralMeridian double dHeightReductionPPM double dIndividualPPM double ASCII Resp...

Page 177: ...in an active measurement state that means a measurement function was called before the TMC_GetFace call see example Note that the instrument automatically turns into an inactive measurement state afte...

Page 178: ...easurement program is activated Start the signal measurement program with TMC_DoMeasure where Command TMC_SIGNAL After the measurement the EDM must be switched off use TMC_DoMeasure where Command TMC_...

Page 179: ...SCII Request R1Q 2014 ASCII Response R1P 0 0 RC InclineCorr long StandAxisCorr long CollimationCorr long TiltAxisCorr long Remarks This function returns the angular corrections status Parameters SwCor...

Page 180: ...R1P 0 0 RC SwCorr long Remarks This function returns the current dual axis compensator status Parameters SwCorr Out Dual axis compensator status Return Code Names and Return Code Values GRC_OK 0 Execu...

Page 181: ...Switch ByVal SwCorr As Long ASCII Request R1Q 2006 SwCorr long ASCII Response R1P 0 0 RC Remarks This function switches the dual axis compensator on or off Parameters SwCorr In Dual axis compensator s...

Page 182: ...0 0 RC Mode long Remarks This function returns the EDM measurement mode Parameters Mode Out EDM measurement mode Return Code Names and Return Code Values GRC_OK 0 Execution successful See Also TMC_Se...

Page 183: ...Long ASCII Request R1Q 2020 Mode long ASCII Response R1P 0 0 RC Remarks This function sets the current measurement mode The measure function TMC_DoMeasure TMC_DEF_DIST uses this configuration Paramete...

Page 184: ...get a valid distance ms eProg In Inclination sensor measurement mode dCoordE Out Easting dcoordN Out Northing dcoordH Out Orthometric height Return Code Names and Return Code Values GRC_OK 0 Executio...

Page 185: ...eInclineCorr ON be reduced with SwCorr eStandAxisCorr ON angle and incline SwCorr eCollimationCorr ON corrections SwCorr eTiltAxisCorr ON TMC_DoMeasure TMC_CLEAR clear distance first TMC_SetAngSwitch...

Page 186: ...rrection error occurred or not FALSE no error occurred TRUE last data record not corrected with the ATR deviation Return Code Names and Return Code Values GRC_OK 0 Execution successful See Also TMC_If...

Page 187: ...GeoCOM Reference Manual Theodolite Measurement and Calculation TMC Leica TPS1200 Version 1 50 187 break end switch TMC_DoMeasure TMC_CLEAR complete measurement and clear data...

Page 188: ...returns the status of the inclination correction of the last measurement If you get a return code GRC_TMC_ANGLE_NOT_FULL_CORR or GRC_TMC_ NO_FULL_CORRECTION from a measurement function this function i...

Page 189: ...the following angle measurement corrections incline The inclination will be considered for the angle measurement if enabled stand axis The standard axis correction will be considered for the angle me...

Page 190: ...r VB Declaration VB_TMC_GetSlopeDistCorr dPpmCorr As Double dPrismCorr As Double ASCII Request R1Q 2126 ASCII Response R1P 0 0 RC dPpmCorr double dPrismCorr double Remarks This function retrieves the...

Page 191: ...ption in the corresponding subsystem to get further information on how to use the new RPCs 18 2 1 Communication COM TPS1100 GeoCOM RPC Changes in TPS1200 GeoCOM COM_SetSendDelay Deleted COM_EnableSign...

Page 192: ...ror Deleted BAP_SetHzOrientationFlag Deleted New BAP_GetPrismType2 New BAP_SetPrismType2 New BAP_GetUserPrismDef BAP_SetPrismDef Replaced by BAP_SetUserPrismDef New BAP_GetATRSetting New BAP_SetATRSet...

Page 193: ...d if subsystem specific followed by the triple digit subsystem name e g GRC_IVRESULT GRC_TMC_ANGLE_OK Please refer to Appendix A for a detailed listing TPS1100 return code definition Changes in TPS120...

Page 194: ...e 1 0 19 2 RELEASE 1 10 This GeoCOM Release 1 10 was introduced with TPS Firmware Release 4 0 19 3 RELEASE 1 20 This GeoCOM Release 1 20 was introduced with TPS Firmware Release 5 0 19 4 RELEASE 1 50...

Page 195: ...OMPL 7 0x7 Parameter setup for subsystem is incomplete GRC_ABORT 8 0x8 Function execution has been aborted GRC_NOMEMORY 9 0x9 Fatal error not enough memory GRC_NOTINIT 10 0xA Fatal error subsystem not...

Page 196: ...307 0x133 no peak decoding possible GRC_ANG_UNSTABLE_DECOD 308 0x134 peak decoding not stable GRC_ANG_TLESS_FPEAKS 309 0x135 too less valid finepeaks GRC_ANG_INCL_OLD_PLANE 316 0x13C inclination plane...

Page 197: ...FLUKT_ERR 776 0x308 to much turbulences or distractions GRC_EDM_FMOT_ERR 777 0x309 filter motor defective GRC_EDM_DEV_NOT_INSTALLED 778 0x30A Device like EGL DL is not installed GRC_EDM_NOT_FOUND 779...

Page 198: ...ee GRC_TMC_ANGLE_ERROR 1290 0x50A Error no angle measurement GRC_TMC_DIST_PPM 1291 0x50B Error wrong setting of PPM or MM on EDM GRC_TMC_DIST_ERROR 1292 0x50C Error distance measurement not done no ai...

Page 199: ...er GRC_COM_CANT_DECODE_REQ 3080 0xC08 Cannot decode arguments in server GRC_COM_PROC_UNAVAIL 3081 0xC09 Unknown RPC procedure ID invalid GRC_COM_CANT_ENCODE_REP 3082 0xC0A Cannot encode results in ser...

Page 200: ...on not exactly reached GRC_AUT_DIST_STARTED 8717 0x220D Info dist measurement has been started GRC_AUT_SUPPLY_TOO_HIGH 8718 0x220E external Supply voltage is too high GRC_AUT_SUPPLY_TOO_LOW 8719 0x220...

Page 201: ...und Voltage levels Logical 0 3V to 25V Logical 1 3V to 25V Baud rate 2400 4800 9600 19200 Default 38400 57600 115200 Parity None Fixed Data bits 8 Fixed Stop bits 1 Fixed Terminator CR LF Default The...

Page 202: ...en use a leading LF to clear the receiver buffer In the function call protocol you do not need to take care of that When using the ASCII protocol Is your implementation of the protocol flow indeed syn...

Page 203: ...e with the preferred serial port on your personal computer and invoke the executable file Press the Setup button to select the communication parameters Serial Port Baudrate Protocol and start the appl...

Page 204: ...GeoComDllSample resx Resource files SAMPLES TCCImageGrabber GeoComDllSample com_pub hpp Header file for GeoCOM SAMPLES TCCImageGrabber GeoComDllSample release GeoComS2K lib GeoCOM Library SAMPLES TCC...

Page 205: ..._ReadTol 9008 45 AUT_Search 9029 56 AUT_SetFineAdjustMode 9031 59 AUT_SetSearchArea 9043 62 AUT_SetTimeout 9011 48 AUT_SetTol 9007 46 AUT_SetUserSpiral 9041 64 B BAP_GetMeasPrg 17018 80 BAP_GetPrismDe...

Page 206: ...y 1058 115 EDM_Laserpointer 1004 114 EDM_SetEglIntensity 1059 116 I IMG_GetTccConfig 23400 128 IMG_SetTccConfig 23401 129 IMG_TakeTccImage 23402 130 IOS_BeepOff 20000 93 IOS_BeepOn 20001 92 M MOT_Read...

Page 207: ...IfDataAzeCorrError 2114 186 TMC_IfDataIncCorrError 2115 188 TMC_QuickDist 2117 152 TMC_SetAngSwitch 2016 189 TMC_SetAtmCorr 2028 163 TMC_SetEdmMode 2020 183 TMC_SetHandDist 2019 158 TMC_SetHeight 2012...

Reviews:

No comments

Related manuals for TM30 Series

Brand: Leica Pages: 25

Brand: KRESS Pages: 24

SP 17.000 Flat Level Sensor

Brand: Kärcher Pages: 16

Brand: Nedo Pages: 64

Brand: YATO Pages: 40

Brand: Hilti Pages: 96

Brands by name

0 1 2 3 4 5 6 7 8 9 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Popular brands

Load more brands