The Streaming Data Output feature allows Siteworks to send real-time positioning and measurement data to external applications, devices, or systems through a serial (COM) port connection. This functionality is available with the Advanced Measurement Module and can be used for integrations that require live survey or GNSS positioning data.
Requirements
Before using Streaming Data Output, ensure:
- The Advanced Measurement Module is licensed and activated.
- A valid COM port is available on the device.
- The COM port is recognised by the operating system and displayed in Windows Device Manager under Ports (COM & LPT).
- Android devices are connected using a compatible USB-to-Serial adapter.
Both physical and virtual COM ports can be used, provided they are recognised by the operating system.
Accessing Streaming Output Settings
- Select Home.
- Open Data Management.
- Select Streaming Output.
The Streaming Output Settings screen allows you to configure all streaming parameters.
Streaming Output Options
Streaming Output Mode
Choose how and when data is transmitted.
Streaming Only
Continuously outputs positioning information at the selected output rate.
Best suited for:
- Real-time monitoring applications
- Third-party software integrations
- Machine guidance systems
Streaming + Measured Point
Continuously streams positioning data and additionally outputs data whenever a point is measured and stored.
Note: Stored points are sent using the same output format as continuously streamed positions.
Measured Point Only
Only measured points are transmitted when they are stored.
Suitable for:
- Data logging requirements
- Point-by-point integrations
- Custom survey workflows
Off
Disables all streaming output.
Output Rate
Select how frequently data is transmitted.
Available settings include:
- 3 Hz
- 2 Hz
- 1 Hz
- Every 2 seconds
- Every 3 seconds
- Every 4 seconds
- Every 5 seconds
Higher frequencies provide more frequent position updates, while lower frequencies reduce communication traffic.
COM Port
Select the COM port used for data output.
Only ports recognised by the operating system are available for selection.
Examples include:
- COM1
- COM2
- Virtual Bluetooth COM Ports
- USB-to-Serial Adapters
Baud Rate
Select the communication speed required by the receiving device.
Available options:
- 38400
- 19200
- 9600
- 4800
- 2400
The baud rate must match the settings of the connected device or software.
Encoding Format
Choose the text encoding format for the output stream.
Options include:
- ASCII
- UTF-8
UTF-8 is generally recommended for broader compatibility.
When Streaming Is Available
Streaming occurs only when:
✅ Siteworks is displaying the main measurement screen.
✅ A valid position is available.
✅ A GNSS receiver is connected, or a robotic total station has prism lock.
✅ The main Siteworks window is active.
When Streaming Is Not Available
Streaming is paused when:
- Entering COGO functions
- Selecting workflows
- Entering point codes
- Using workflow selection maps
- Siteworks is not displaying the main measurement screen
Although plan view and 3D view panels do not need to be active, the device must remain on the primary Siteworks measurement screen.
Streaming Status Indicator
A status icon in the top status bar shows the current streaming state.
The icon indicates whether streaming is:
- Active
- Paused
- Interrupted
Tap the icon to quickly access the Streaming Output Settings screen.
Customising the Output Format
Output formats are configured using Streaming Style Guides.
Style guides allow you to customise:
- Output fields
- Field order
- Delimiters
- Prefixes
- Suffixes
This makes it possible to create output formats that meet the requirements of third-party software and custom integrations.
Streaming Configuration Definition
The Streaming Configuration Definition screen provides full control over the output format.
You can configure:
- Which data fields are included
- The sequence of fields
- Delimiters between fields
- Optional prefixes and suffixes for each field
This functionality is similar to the style guides used for point import and export operations.
Available Data Fields
The following data types can be included in a streaming configuration:
- Antenna/Target Height
- Cut/Fill
- Date
- Delta Easting
- Delta Elevation
- Delta Northing
- Easting
- Elevation
- Horizontal Angle (HA)
- Latitude
- Longitude
- Nothing (blank field)
- PDOP Value
- Point Code
- Point Name
- Point Type
- Slope Distance (SD)
- Site Bearing (tilt-enabled GNSS receivers only)
- Tilt Pitch
- Tilt Roll
- Time
- Vertical Angle (VA)
- WGS Height
Understanding Delta Values
The following fields represent stakeout guidance information:
- Delta E
- Delta N
- Delta Elv
These values correspond to the Go distances displayed during stakeout operations and represent the difference between your current location and the selected stakeout point or line station.
Known Issue
When opening the Streaming Output Settings screen, Siteworks may automatically select the lowest available COM port number.
For example:
- On a TSC7 controller, this is typically COM1, which usually causes no issues.
- On other devices, the required COM port may be different.
Recommended Practice
Each time you open the Streaming Output Settings screen:
- Verify the selected COM port.
- Confirm that the correct port is still selected.
- Change the port if required before starting streaming.
This helps prevent communication issues with connected devices and software.
Best Practices
✅ Confirm the correct COM port before starting a survey.
✅ Match baud rate settings with the receiving device.
✅ Test custom streaming formats before field deployment.
✅ Use descriptive style guide names for different integration requirements.
✅ Verify live data reception in the target application before commencing work.
Comments
0 comments
Please sign in to leave a comment.