Skip to main content
As-Built As-Built - Revit As-Built - AutoCAD VirtuSurv - VirtuSurv 2018 As-Built - Modeler VirtuSurv - VirtuSurv 2019          
BuildIT BuildIT - Projector BuildIT - Construction BuildIT - Metrology              
CAM2 CAM2 - SmartInspect CAM2 - 2024 CAM2 - 2023 CAM2 - 2018 CAM2 - Measure 10 CAM2 - Measure Q CAM2 - Measure X CAM2 - Measure 3/4 CAM2 - AnthroCAM CAM2 - 2019
CAM2 CAM2 - 2020 CAM2 - 2021                
Cobalt 3D Imager 3D Imager - Cobalt                  
Cobalt Design Cobalt Design - M Cobalt Design - S Cobalt Design - Dual              
Computers Computers - All Computers                  
FARO Aras 360 & CAD Zone FARO CAD Zone - Fire & Insurance FARO CAD Zone - Crime & Crash FARO CAD Zone - CZ Point Cloud FARO CAD Zone - First Look Pro FARO 360 - Reality FARO 360 - HD FARO 360 - Blitz FARO 360 - Genius    
FARO Connect FARO Connect - Connect                  
FARO Zone present4D - present4D                  
FARO Zone 2D FARO Zone 2D - 2018 FARO Zone 2D - 2019 FARO Zone 2D - 2020 FARO Zone 2D - 2021 FARO Zone 2D - 2022 FARO Zone 2D - 2023        
FARO Zone 3D FARO Zone 3D - 2018 FARO Zone 3D - 2019 FARO Zone 3D - 2020 FARO Zone 3D - 2021 FARO Zone 3D - 2022 FARO Zone 3D - 2023 FARO Zone 3D - 2024      
FARO Zone 3D Advanced FARO Zone 3D Advanced - 2018 FARO Zone 3D Advanced - 2019 FARO Zone 3D Advanced - 2020 FARO Zone 3D Advanced - 2021 FARO Zone 3D Advanced - 2022          
FaroArm/ScanArm FaroArm/ScanArm - Quantum S FaroArm/ScanArm - Quantum M FaroArm/ScanArm - Quantum E FaroArm/ScanArm - Edge FaroArm/ScanArm - Fusion FaroArm/ScanArm - Prime FaroArm/ScanArm - Platinum FaroArm/ScanArm - Legacy Quantum FaroArm/ScanArm - Titanium FaroArm/ScanArm - Advantage
FaroArm/ScanArm FaroArm/ScanArm - Digital Template FaroArm/ScanArm - Gage FaroArm/ScanArm - Quantum S Max FaroArm/ScanArm - Quantum M Max FaroArm/ScanArm - Quantum E Max FaroArm/ScanArm - Gage Max        
GeoSLAM Software GeoSLAM Software - Connect GeoSLAM Software - Draw GeoSLAM Software - Hub GeoSLAM Software - Volumes            
GeoSLAM ZEB GeoSLAM ZEB - Horizon GeoSLAM ZEB - Horizon RT GeoSLAM ZEB - Revo GeoSLAM ZEB - Revo RT GeoSLAM ZEB - Go          
Hand Held Scanner 2D Hand Held Scanner - ScanPlan 3D Hand Held Scanner - Freestyle3D 3D Hand Held Scanner - Freestyle3D X 3D Hand Held Scanner - Freestyle3D Objects 3D Hand Held Scanner - Freestyle 2          
Language Quality HT MT AT NT INT - Internal Sales - Internal Resources Sales - Order and Quote Sales - Product Info Sales - Sales Readiness Sales - Training
Language Quality Sales - Product Launch Sales - Promotions CS - Quote to Invoice CS - Phone System CS - New Hire Training CS - General CS - Product Info CS - Licensing CS - Onboarding CS - Procedures General
Language Quality CS - Procedures Salesforce CS - Procedures Loaner CS - Procedures SAP              
Languages Language - English Language - Japanese Language - German Language - Chinese Language - Spanish Language - Italian Language - Portuguese Language - French Language - Korean  
Laser Projector RayTracer - RayTracer Laser Projector - Tracer M Laser Projector - Tracer SI              
Laser Radar Imaging Laser Radar - VectorRI                  
Laser Scanner 3D Laser Scanner - Focus S 3D Laser Scanner - Focus M 3D Laser Scanner - Focus3D 3D Laser Scanner - Focus3D X 3D Laser Scanner - Focus3D X HDR 3D Laser Scanner - Focus3D S 3D Laser Scanner - Photon 3D Laser Scanner - Focus S Plus 3D Laser Scanner - Swift 3D Laser Scanner - Focus Premium
Laser Scanner 3D Laser Scanner - Focus Core                  
Laser Tracker Laser Tracker - Vantage Laser Tracker - ION Laser Tracker - Vantage S Laser Tracker - Si Laser Tracker - X Laser Tracker - Xi Laser Tracker - Vantage E Laser Tracker - Vantage S6 Laser Tracker - Vantage E6  
Legacy Gage Legacy Gage - Bluetooth Legacy Gage - Plus Legacy Gage - Standard Legacy Gage - Power            
Legacy Software Legacy Software - CAM2 Gage Legacy Software - Gage Software Legacy Software - Insight              
Mobile Scanner Mobile Scanner - Orbis                  
PointSense PointSense - Basic PointSense - Pro PointSense - Building PointSense - Plant PointSense - Heritage PointSense - Revit CAD Plugin - TachyCAD Building CAD Plugin - TachyCAD Archeology CAD Plugin - TachyCAD Interior CAD Plugin - PhoToPlan Basic
PointSense CAD Plugin - PhoToPlan CAD Plugin - PhoToPlan Pro CAD Plugin - PhoToPlan Ultimate CAD Plugin - DisToPlan CAD Plugin - MonuMap CAD Plugin - hylasFM CAD Plugin - VirtuSurv      
RevEng RevEng - RevEng                  
ScanArm ScanArm - Design ScanArm 2.0 ScanArm - Design ScanArm ScanArm - Forensic ScanArm ScanArm - Design ScanArm 2.5C            
SCENE SCENE - Capture and Process SCENE - WebShare Server and 2Go SCENE - WebShare 2Go App SCENE - 2018 SCENE - 7.x SCENE - 6.x SCENE - 5.x SCENE - 4.x SCENE - LT SCENE - 2019
SCENE SCENE - 2go App SCENE - 2020 SCENE - 2021 SCENE - 2022 SCENE - 2023          
Serial FaroArm Serial FaroArm - Silver Serial FaroArm - Gold Serial FaroArm - Bronze              
Sphere FARO Sphere - Sphere                  
Visual Inspect Visual Inspect - App Visual Inspect - CAD Translator                
WebShare WebShare - Enterprise WebShare - WebShare Cloud                



FARO® Knowledge Base

Using the Record Auto-Cloud in BuildIT Metrology



For recording individual points or clouds in an interactive or semi-automated way, "Measure > Record Cloud" command can be used.

This command can be automated but it doesn't provide a feedback mechanism to programmatically confirm when a measurement has started and does not provide a convenient mechanism to programmatically stop a measurement.

The Record Auto-Cloud command allows performing the same measurement as Record Cloud, in addition to running a Python script in parallel in a secondary thread while the command is open. The Python environment is preserved, so that all the Python objects created prior to launching the command can be accessed while the command is open.

In addition to the Python script running in parallel, the Record Auto-Cloud offers an addition option: Wait for data before accept.

  • If True, the command will return once both the Python script has returned and the number of Samples defined in the Triggering section have been reached.
  • If False, the command will return as soon as the Python script has returned.
    • The command will still stop recording new measurements once the Samples limit has been reached, but it will not return until the script has returned as well.

Use cases:

  • An external application or system can send events with precise timing for starting and stopping measurements
  • Performing handshakes with external applications or systems while BuildIT is performing a measurement

A current limitation with the Record Auto-Cloud command is that the UI is not available to the Python script running in the secondary thread, meaning that functions such as buildit.ui.messagebar.message() will be ignored. To output messages to a console while the command is running, buildit.util.open_console() can be used.

Performing a Measurement Using Record Auto-Cloud

You'll learn how to:

  • Create a Process with Record Auto-Cloud command
  • Run a Process with Record Auto-Cloud command

Tutorial Download

If you would like to download the file used in this article, download the accompanying Training Data and extract its contents to a folder on your PC.

Training Data Download

Create a Process with Record Auto-Cloud Command

  1. Select "Automate > Edit". BuildIT-AutomateEditIcon.png
  2. Click New Process. BuildIT-NewProcessIcon.png
  3. Click Add Command. BuildIT-AddCommandIcon.png
  4. Select "Device > Record: Auto Cloud" and click Add Command.
  5. Set the parameters accordingly to your specific need:
    • For Triggering, use Time Trigger or Distance Trigger as the Record Type with the maximum number of samples needed and the Distance or Time between measurement, respectively.
    • For Python Script, use Inline or External and write the program on the Script field or attach it on the Filename field, respectively.
    • Keep Wait For Data Before Accept set to True to auto-accept the measurements.
  6. Click Save Process BuildIT-SaveProcessIcon.png to save the file at the desired location.

Run a Process with Record Auto-Cloud

This section shows how to trigger an event with precise timing to stop the measurements. In the example below, the Python script waits for an external signal to stop the measurement. In this case, the external signal is sent by opening a web browser and trying to reach the address http://localhost:65432/

This example uses socket messaging.

  1. Launch BuildIT
  2. Go to "Automate > Play Process" or press F5 and play "Record Auto Cloud Example.process". This process will:
    1. Add and connect to a simulated tracker.
    2. Instantiate a socket messaging object.
    3. Run the Record Auto-Cloud command while listening the external application's signal through the Python script to stop the measurements.
  3. Open a browser at address http://localhost:65432/ to interrupt measurement as indicated in the instructions. The measurements will stop and auto-accept.

The same concept may be use for starting the measurement and handshakes with the external application.

 If the Python Script section in the parameter is empty, the command will:

  • Close immediately if Wait for data before accept is False
  • Close or as soon as the number of Samples has been reached, if Wait for data before accept is True



  • Was this article helpful?