manualshive.com logo in svg

Metrolab TFM1186, User Manual, Page: 22 / 59

Share
Download
Metrolab TFM1186 User Manual Download Page 22

THM1176/TFM1186 Use

r’s Manual 

v 2.0 r 1.0  

– 02/20 

Copyright © 2020 Metrolab Technology SA 

 

www.metrolab.com 

18

 

EZMag3D manual describing the source code structure. Detailed documentation 

is supplied in Doxygen format. 

Metrolab also plans to supply wrappers for the THM1176 API for other 

development systems, such as LabVIEW and Python. This is still a work in 

progress at the time of this writing; please consult the supplied software source 

code and the Metrolab web site. 

Finally, the first-generation THM1176 API, written entirely in LabVIEW, is no 

longer maintained, but is still functional and available for download as part of the 

“THM1176 Desktop Kit software”. 

4-4  THM1176 INSTRUMENT MANAGER 

EZMag3D includes a layer on top of the THM1176 Instrument Control API, the 

THM1176 Instrument Manager, a 

Qt Object

 abstraction of the instrument. It uses 

none of the user-interface components of the 

Qt framework

, only the core thread 

and synchronization functionality. The benefit of the Instrument Manager is 

simplicity: whereas the API provides access to every single feature of the 

instrument, the Instrument Manager reveals just the minimally required 

functionality, in a simplified form. To get started, again refer to the chapter in the 

EZMag3D manual describing the source code structure and the detailed Doxygen 

documentation in the source. 

Summary of Contents for TFM1186

Page 1: ...Magnetic precision has a name Three axis Magnetometers THM1176 and TFM1186 User s Manual Version 2 0 Revision 1 0 February 2020...

Page 2: ...l documentation Add documentation for THM1176 HFC v 1 3 r 1 1 April 2012 Correct installation procedure v 1 3 r 1 2 April 2014 Add documentation for THM1176 MF TFM1186 Adapt documentation for SoMo 655...

Page 3: ...2 Sensors 9 3 3 Measurement Process 10 3 4 Characteristics and Benefits 11 3 5 Probe Mechanical Design 13 3 6 Host Computer Interface 14 3 7 Host Computer and Software 15 3 8 Calibration Maintenance R...

Page 4: ...8 2 5 151 Invalid string data 52 8 2 6 171 Invalid expression 53 8 3 200 Execution Errors 53 8 3 1 221 Settings conflict 53 8 3 2 222 Data out of range 53 8 3 3 225 Out of memory 54 8 4 400 Query Err...

Page 5: ...sign along with the optional ruggedized tablet makes for a powerful autonomous and portable magnetometer excellent for field use This manual covers the entire THM1176 family including the following mo...

Page 6: ...alibrated at regular intervals The recommended calibration interval is 18 months You can benefit from a discounted price for the calibration if you return your instrument to Metrolab at a time that co...

Page 7: ...e with the software and documentation A carrying case Optionally if you ordered the Handheld Kit a ruggedized Windows tablet In addition to the tablet itself you should receive o a Mini USB to USB A a...

Page 8: ...ollowing the on screen instructions Note that the default installation location is in your personal Applications folder not the system wide Applications folder When the installation is complete you wi...

Page 9: ...User Offset Correction procedure 2 5 USING THE HANDHELD KIT The ruggedized Windows tablet included in the Handheld Kit is like any other Windows computer all the procedures in the previous sections ap...

Page 10: ...Category 9 Monitoring and Control Instruments For proper environment friendly disposal you can return the instrument free of charge to us or our local distributor SPECIAL NOTICE FOR THE TABLET When t...

Page 11: ...ndling even the weight of the instrument cable is sufficient to damage the probe Damage to either the sensor package or signal cable will destroy the sensor We strongly suggest storing the probe in it...

Page 12: ...chnology SA www metrolab com 8 2 7 AXIS ORIENTATIONS The orientation of the axes relative to a THM1176 probe is as follows Relative to the THM1176 MF and HF sensors Similarly for the THM1176 HFC senso...

Page 13: ...0 1 0 3 1 and 3 T THM1176 HF Three axis Hall Magnetometer High Field Single chip 3 axis Hall sensor with ranges of 0 1 0 5 3 and 20 T THM1176 HFC Three axis Hall Magnetometer High Field Compact Single...

Page 14: ...ed by the user The sample rate is as fast as possible in practice just under 10 kHz With this oversampling the signals are sampled in the following order Bx Bx Bx By By By Bz Bz Bz T where T is temper...

Page 15: ...ibration table also contains data concerning the orthogonality of the sensor s axis however this correction is applied not by the P but by the software 3 4 CHARACTERISTICS AND BENEFITS Three axes Simu...

Page 16: ...e for measuring rapidly varying fields The maximum sample rate writing data into the acquisition buffer is approximately 5 3 kSa s where one sample is a triplet Bx By Bz With a simultaneous readout vi...

Page 17: ...an be returned in Tesla mTesla Tesla nTesla Gauss kGauss mGauss equivalent proton NMR frequency or raw ADC values The timestamp in ns and sensor temperature arbitrary units not calibrated can also be...

Page 18: ...e instrument to be connected without installing a custom USB driver All that is required is a generic class driver for test and measurement equipment as provided by suppliers of instrumentation softwa...

Page 19: ...ation procedure The THM1176 family of instruments can only be calibrated by Metrolab This is because special magnets tooling and software are required to calibrate all three axes at multiple fields an...

Page 20: ...irs Due to the highly integrated construction of the THM1176 family Metrolab cannot replace individual electronic components If you send an instrument back for repair we will send you a replacement un...

Page 21: ...pters in the EZMag3D manual concerning the source code and license conditions Even if you plan to develop your own control software from scratch we strongly recommend you install EZMag3D to learn the...

Page 22: ...is still functional and available for download as part of the THM1176 Desktop Kit software 4 4 THM1176 INSTRUMENT MANAGER EZMag3D includes a layer on top of the THM1176 Instrument Control API the THM1...

Page 23: ...www ni com If you are not using NI VISA you will probably need information that is not provided in this chapter USB 2 0 See Universal Serial Bus Specification Revision 2 0 April 27 2000 available from...

Page 24: ...ollowing table provides a summary of the instrument capabilities organized according to the SCPI instrument model The supported commands include IEEE 488 2 Common Commands start with as well as SCPI c...

Page 25: ...ch measurement results previously acquired with MEASure READ or INITiate CALCulate Control averaging Signal Routing Not used INPut Not used SENSe SENSe Select range and auto ranging CALCulate CALibrat...

Page 26: ...rol ineffective since THM1176 TFM1186 has no local controls RST Perform reset TST Perform self test not supported IDN Return Instrument ID SYSTem VERSion Return SCPI version SYSTem HELP Provide comman...

Page 27: ...THM1176 TFM1186 User s Manual v 2 0 r 1 0 02 20 Copyright 2020 Metrolab Technology SA www metrolab com 23 o Status Byte Contains a 1 byte status summary The THM1176 TFM1186 uses the following bits...

Page 28: ...lete 2 Query Error Error in preceding query 3 Device Dependent Error Errors specific to the THM1176 family including internal errors 4 Execution Error Error detected during command execution 5 Command...

Page 29: ...ch makes the amplitude questionable As shown in the figure below taken from the IEEE 488 2 standard each of the registers above is actually a set of three registers o Condition Register Read only regi...

Page 30: ...e an RQS ReQuest for Service 5 4 USBTMC USB488 CONTROLS The following functions are supported directly by the USBTMC USB488 protocol Historically these correspond to dedicated hardware signals in IEEE...

Page 31: ...Response Data see IEEE488 2 standard and cannot be followed by another query in the same command sequence OPC Set operation complete Set the operation complete bit in the standard event register afte...

Page 32: ...ent of flux density measurement According to this table the following commands are legal FETC SCAL FLUX Y FETC same as above omitting optional keywords FETC X fetches x component of flux density measu...

Page 33: ...ger system Aborts acquisition in progress Disables trigger Disables continuous trigger Command Parameters Description CALCulate AVERage COUNt MINimum MAXimum DEFault Query averaging count COUNt count...

Page 34: ...Command Parameters Description FETCh SCALar Fetch data values acquired during last MEASure READ or INITiate The following actions invalidate previously acquired data Reset Continuous trigger initiati...

Page 35: ...during the last MEASure ARRay or READ ARRay size must be no greater than the acquisition size If FORMat is ASCii returns a comma separated list of values The other parameters are as for FETCh SCALar...

Page 36: ...density value containing the 16 bit big endian raw measurement value if calibration correction is disabled or otherwise the flux density value in T THM1176 MF HF HFC mG THM1176 LF or nT TFM1186 PACKe...

Page 37: ...nable the trigger where the trigger source trigger count and trigger period are set with TRIGger commands CONTinuous DEFault Query continuous trigger state CONTinuous boolean DEFault Set continuous tr...

Page 38: ...ts FLUX expected_value min 0T max 20T def 0T digits min 1 max 5 def 3 X expected_value digits Return x component of flux density measurement Y expected_value digits Return y component of flux density...

Page 39: ...nology SA www metrolab com 35 Command Parameters Description MMEMory Read the FLASH memory CATalog Read the file directory Returns Total bytes used Total bytes available File entries consisting of Fil...

Page 40: ...min 0T max 20T def 0T digits min 1 max 5 def 3 X expected_value digits Return x component of flux density measurement Y expected_value digits Return y component of flux density measurement Z expected_...

Page 41: ...lt Set auto ranging ON or OFF ON by default ALL Return a list of all the ranges supported by this instrument in T Command Parameters Description STATus OPERation Query set OPERATION register sets EVEN...

Page 42: ...nd Parameters Description SYSTem ERRor NEXT Query error queue VERSion Query SCPI version e g 1999 0 HELP HEADers List all available commands SYNTax command_header List syntax for a command SLEEp Power...

Page 43: ...er system SOURce DEFault Query trigger source SOURce IMMediate TIMer BUS DEFault Trigger source IMMediate no wait TIMer periodic trigger BUS USB488 TRIGGER IMMediate by default Note resets the trigger...

Page 44: ...ion Explorer part of the full NI VISA package provides a very useful tool to explore the command set Select the THM1176 TFM1186 under System Peripherals Interfaces USB Devices and click the Open VISA...

Page 45: ...tion sequence RST ABORt MEASure READ INITiate CONTinuous is used for TRIGger SOURce TIMer or BUS to avoid losing triggers while data is read out Using the OPC command you can generate a ReQuest for Se...

Page 46: ...tion and QUEStionable Status registers provide a general idea of what went wrong and the status message on the Error Event Queue retrieved by SYSTem ERRor provides a detailed diagnostic See Chapter 8...

Page 47: ...FM1186 T mT T nT G mG Sample rate Immediate trigger default Approx 6 8 kSa s free running until internal buffer is full Timed trigger Into internal buffer 0 36 Sa s to 5 3 kSa s jitter 0 2 s std dev D...

Page 48: ...terface USB 2 0 full speed 12 Mbps Class USB driver USBTMC USB Test Measurement Class USB488 DFU Device Firmware Upgrade Protocol IEEE 488 2 SCPI Standard Commands for Programmable Instruments Connect...

Page 49: ...ectronics 76 x 22 5 x 14 mm3 Probe with housing 113 x 16 x 10 mm3 Probe without housing Cable length THM1176 MF 3 m optionally 6 m THM1176 LF 6 m Notes Includes 1 m of USB cable Weight 160 g 3 m cable...

Page 50: ...Notes marks the centre of the field sensitive volume All dimensions are in mm Tolerances are 0 1mm Notes marks the centre of the field sensitive volume All dimensions are in mm Tolerances are 0 1mm Ce...

Page 51: ...ectronics 76 x 22 5 x 14 mm3 Probe dimensions A 8 0 0 2 mm B 2 0 0 5 mm C 0 5 0 05 0 00 mm D 50 1 mm E 0 8 0 1 mm Field sensitive point 150 m x 150 m x 10 m Cable length 3 m optionally 6 m Notes Inclu...

Page 52: ...mm3 Probe with housing 113 x 16 x 10 mm3 Field sensitive point 6 x 3 4 x 3 mm Cable length 3 m optionally 6 m Notes Includes 1 m of USB cable Weight 160 g 3 m cable 290 g 6 m cable Sensor locations 6...

Page 53: ...and alarms Control of range units trigger acquisition display rates oversampling Auto ranging Hold Max and Alarm functions Zero offset correction Save and replay from memory or disk Save and restore...

Page 54: ...serted vertically into a P type substrate If a current is injected into the center terminal and extracted from the two end terminals the currents in the two halves of the plate flow in opposite direct...

Page 55: ...ect can be modeled with a resistance network where the longer current paths result in higher resistances and vice versa In our example the resulting offset voltage would be negative But if we exchange...

Page 56: ...00xx the former are errors and the latter are warnings These are VISA error codes and are not documented here See the LabVIEW on line help under VISA Error Codes or right click on the error indicator...

Page 57: ...ALL READ or SENSe FLUX RANGe command when triggers were enabled in BUS trigger mode Sending an INITiate CONTinuous command when in IMMediate trigger mode Sending SYSTem SLEEp when trigger is enabled 8...

Page 58: ...esponse to a preceding query 8 4 3 420 Query UNTERMINATED The host is trying to read a response without having sent a complete query 8 4 4 440 Query UNTERMINATED after indefinite response Indicates th...

Page 59: ...an unknown parameter type Please report to Metrolab the circumstances under which you received this error 8 6 2 204 Data buffer was overrun In timed trigger mode data was lost because the read out did...

Reviews:

No comments