Each PigStick creates its own WiFi network for direct connection from phones, tablets, or laptops:
Look for a WiFi network named PigStick-XXXX (where XXXX matches the last 4 characters of the device serial number)
Connect using the password: pigstick (all lowercase)
Open your web browser and navigate to: http://pigstick-XXXX.local/ or http://10.0.0.1/
No Internet Required: The PigStick works on its own. No cellular signal or internet connection is needed. When you connect to the PigStick-XXXX network, your phone or laptop connects directly to the device over its own private WiFi network. Everything works offline in the field.
Startup Note: If saved internet WiFi networks are configured, the PigStick may spend a few seconds at boot checking whether an update is available before it starts its own WiFi network. This check does not install updates and does not require any action from you.
Tip: If the .local address doesn't resolve on your device, use http://10.0.0.1/ instead. This is the device's fixed IP address on its own network.
Interface Overview
The PigStick interface consists of several main sections:
Header: Device name, serial number, battery gauge, local time, job indicator, and uptime (Advanced Mode)
Menu Bar: Job menu, Settings, Help, status LEDs, reconnect control, and update notice when available
Magnetic Stream: Real-time magnetic field visualization and passage capture controls
Geophone Stream: Audio waveform visualization and speed estimation
Passages: List of captured pig passages with playback and export options
System Cards: GPS, WiFi, System, and Log panels (visible in Advanced Mode)
Status LEDs
The menu bar displays status LEDs indicating device and sensor states:
DEVICE IS NOT UPRIGHT: Appears when the unit is tilted more than 45° from vertical
Pulsing Red - Reposition the device upright. Both the geophone and magnetic sensors require vertical orientation for proper operation.
DEVICE: Connection status to the PigStick
Green - Connected and communicating
Red - Connection lost or communication error
GPS: GPS receiver status
Green - 3D fix acquired (accurate position and time)
Yellow - 2D fix or acquiring satellites
Red - No GPS fix
Update Notice
When the device sees an available software update during its startup check, a blue update link appears in the menu bar. The link text includes the update message and available version numbers, such as "Update available: fw v2.0.33, app v2.0.46". Click the link only when you are ready for the PigStick WiFi network to disconnect briefly while the device checks for and installs the update.
Reconnect Button
If WiFi connectivity is interrupted and the streams fail to reconnect automatically, a red "RECONNECT" button appears next to the DEVICE LED. Click this button to manually restart the connections without refreshing the entire page.
Device Change Detection
When you connect to a different PigStick than your previous session, a confirmation dialog appears asking whether to clear cached data from the previous device. This prevents mixing passages and settings between devices.
Click "OK" to clear the cache and start fresh with the new device
Click "Cancel" to keep existing cached data (not recommended when switching devices)
The dialog identifies each device by the last 4 characters of its serial number (shown as "Previously" and "Now") so you can confirm which device is which.
Connection Limits
Up to 2 devices (phones, tablets, or computers) can connect to a single PigStick simultaneously. If a third device attempts to connect, it will be unable to connect until one of the existing connections closes.
Tip: Enable Advanced Mode in Settings to access technical controls and system information panels.
Mobile Display
On narrow screens (phones and small tablets), the interface adapts for better usability:
The header splits into separate branding and info tiles
Serial number is hidden to save space
Passage list icons are positioned in the top-right corner of each card
Dialog layouts adjust for touch-friendly interaction
2. Magnetic Stream
Overview
The magnetic waveform streams automatically when you connect to the device. The display shows real-time magnetic field data from the sensor, allowing you to monitor for MFL (Magnetic Flux Leakage) and ELF transmitter signals.
Arming the System
Click the "ARM" button to enable automatic passage capture. When armed, the system monitors for trigger conditions and automatically records passages when detected. The button changes to "DISARM" when active.
When viewing a saved passage, the ARM/DISARM button is hidden and a "Back" button appears to return to live view.
Records on Its Own: Once armed, the PigStick keeps monitoring and capturing passages by itself, even if your phone or tablet loses its WiFi connection. Nothing is missed while you are disconnected. When you reconnect, the ARM/DISARM button updates to show the device's current state.
After a Power Cycle: If the device is switched off and back on, it starts disarmed unless "Arm on Boot" is enabled (see Startup Behavior). After a restart, reconnect and press ARM again, or enable Arm on Boot for unattended use.
Display Modes
The magnetic stream supports three display modes, selectable via the Mode dropdown:
Mag Only: Displays only the MFL signal from pig passages. Best for standard magnetic pig detection.
ELF Only: Displays only the ELF transmitter signal. When a capture threshold is set, dashed amber threshold lines show the trigger levels.
ELF + Mag: Displays both signals overlaid, with the MAG signal highlighted. Useful when tracking pigs with both MFL characteristics and ELF transmitters.
Field Sensitivity
The Sensitivity dropdown in the magnetic controls selects the calibrated magnetic gain preset used by the device:
Low: Least sensitive field preset for stronger signals
Medium: Middle field preset for general use
High: More sensitive field preset for weaker signals
Max: Maximum sensitivity preset
The available presets are loaded from the device. If a preset is not available, it is disabled in the dropdown.
Select field sensitivity: Low, Medium, High, or Max
Window
Time window displayed on screen (2s, 5s, 10s, 20s, 30s, 60s)
Scale
Vertical scale adjustment for viewing larger or smaller amplitude signals (Advanced Mode only)
Capture Settings
Click the "Mag Capture Settings" header to expand capture configuration options:
Zero Crossing Mode
Recommended for MFL detection. Triggers when the magnetic signal crosses the zero (center) line, which is characteristic of a pig passing the sensor.
Threshold Mode
Recommended for ELF transmitter detection. Triggers when the signal amplitude exceeds a configured level.
Threshold: Signal level (0% to 100% of full scale) that triggers capture. In ELF or ELF+Mag display modes, dashed amber lines show the threshold levels on the waveform.
Built-in Hold-off: After each capture the device automatically waits a short hold-off period before it can trigger again, which prevents multiple captures of the same passage. This timing is set in firmware and is not adjustable from the interface.
Both Mode
Combines both trigger methods for dual-detection scenarios:
Mag signal: Uses zero crossing detection
ELF signal: Uses threshold detection
This mode allows simultaneous detection of MFL passages and ELF transmitter signals without cross-triggering.
Note: Captured passages are automatically saved on the PigStick and appear in the Passages section for the active job. Capture mode, threshold settings, display preferences, and other app preferences are saved automatically.
Audio Capture: If the geophone stream is running when a passage is captured, the audio is automatically recorded and synchronized with the magnetic waveform. Passages with audio show a play button in the passage list.
Browser Cache: The PigStick stores the job recordings on the device. Your browser may also cache recent display state and preferences, so after switching devices or addresses you may be asked whether to clear cached data from the previous device.
Capture Progress
When a passage is triggered, a capturing card appears at the top of the passage list showing:
An orange border indicating active capture
Trigger timestamp showing when the passage was detected
A circular progress ring showing capture completion
After 10 seconds of post-trigger data is captured, the card transforms into a completed passage with full controls.
Grab Window as Passage
The "Grab Window as Passage" button (visible in live view only) captures the current waveform display and saves it as a passage. This is useful for:
Manually capturing passages that weren't automatically detected
Recording events that occurred when the system wasn't armed
Saving waveforms of interest for later analysis
3. Geophone Stream
Starting the Stream
Click "START" to begin streaming geophone audio. The waveform displays in real-time and audio plays through your device's speakers or headphones. Click "STOP" to end the stream.
Display Controls
Control
Function
Window
Time window displayed (2s, 5s, 10s, 20s, 30s, 60s)
Volume
Audio playback volume (0% to 100%)
Zooming the Waveform
You can zoom the audio waveform using several methods:
Window dropdown: Select a time window from 2s to 60s
Mouse wheel: Hover over the canvas and scroll to zoom in/out
Pinch gesture: On touch devices, use two-finger pinch to zoom
Speed Estimation
Click "Geophone Speed Estimation" to expand speed tracking options. The PigStick can estimate pig velocity by analyzing geophone signal patterns.
Gain: Software gain multiplier (1x to 100x). Fine-tune signal visibility.
Speed Display: The readout shows calculated speed, interval between detections, and confidence level. When confidence drops below 50%, the speed value is hidden (shown as "--") to prevent displaying unreliable estimates.
Accuracy Note: Speed estimates are approximate and depend on pipeline conditions, geophone placement, ambient noise, and signal quality. Use as a reference rather than a precise measurement.
4. Passage Management
Passage List
The "Passages" section displays all captured magnetic passages for the current job. The header shows the job name and passage count (e.g., "Job: Pipeline-A (12)").
Sorting
Click the sort indicator in the header (e.g., "Newest First ↓") to toggle between ascending and descending chronological order. Your preference is saved between sessions.
Passage Information
Each passage card displays:
Trigger Time: When the passage was captured (green text)
Cursor Time: The time at your cursor position (yellow/orange), or "None" if no cursor is set
Play Button (): Play back the passage with synchronized audio (if audio was captured)
Edit Button (): Edit passage metadata
Map Button (): Open location in Google Maps (if GPS coordinates are available)
Delete Button (): Delete the passage
Viewing Passages
Click any passage to load it into the main waveform display. The view includes:
Full 20-second waveform (10s pre-trigger, 10s post-trigger)
Zero crossing indicator (red vertical line at trigger point)
Cursor for precise time measurement
Zoom and scroll controls
The passage title displays in yellow/orange to indicate you're viewing a saved passage rather than live data. Click "Back" to return to live view.
Using the Cursor
Click and drag on the waveform to position a cursor at a specific time. The cursor appears as a yellow vertical line. This is useful for:
Marking the exact moment of pig passage (vs. the automatic trigger time)
Measuring time intervals within the passage
Setting the reference time for exports
The cursor time is displayed in the passage card and included in exports. Click the × next to the cursor time to clear it.
Zooming and Scrolling
When viewing a passage, you can zoom in for detail:
Window dropdown: Select from 2s to 20s views
Mouse wheel: Scroll to zoom in/out
Pinch gesture: Two-finger pinch on touch devices
When zoomed closer than the full 20-second capture:
Shift+drag: Pan left/right through the passage
Shift+Arrow keys: Scroll incrementally
Scroll indicators (◀ ▶) appear at the edges when more data is available in that direction.
Passage Playback
Passages captured with audio can be played back with synchronized sound:
Play: Click the play button on the passage card. The waveform scrolls through the data with synchronized audio.
Pause/Resume: Click the pause button during playback.
Scrubber: Click or drag the progress bar to jump to a specific position.
Stop: Click stop or the play button again to end playback.
Passages without audio can still be played back visually.
Editing Passages
Click the edit button to open the passage edit dialog:
Description: Brief location description (up to 256 characters)
Passage-Specific Notes: Additional notes specific to this passage
Deleting Passages
Click the trash icon to delete a passage. A notification appears with:
An "Undo" button to restore the deleted passage
A progress bar showing remaining undo time (10 seconds)
If you're viewing the deleted passage, you'll automatically return to live view.
Passage View Tools
When viewing a passage, the toolbar provides:
Copy Time/Date: Copies trigger time and cursor time (if set) to clipboard
Copy Image: Copies a screenshot of the waveform with annotations to clipboard
Export PNG: Downloads the waveform as a PNG image file
5. Export Features
Export options are available from the Job menu and apply to all passages in the current job. All exports work offline. No internet connection is required.
CSV Export
Select Job > Export as CSV to create a spreadsheet file with one row per passage and these columns:
Site Name (AGM/Site number)
Date and Time (cursor time if set, otherwise trigger time)
Select Job > Export as PDF to generate a report including:
Title Page: Company logo, job information, device serial, date range, and passage count
Passage Pages: One landscape page per passage with:
Waveform visualization
Trigger and cursor time annotations
GPS coordinates
Site number, description, and notes
File naming: {Client}_{Job}_YYYY-MM-DD_report.pdf
PNG Export
When viewing a passage, click Export PNG to download the waveform as an image file with trigger and cursor time annotations. File naming: pigstickPassage_YYYYMMDD_HHMMSS.png
Job Package Export
Select Job > Export Job Package to create a complete ZIP archive containing:
All job settings and metadata
All passages with waveform data
All captured audio
PDF report
Use this for backing up completed jobs or archiving before deletion. File naming: {Client}_{Job}_YYYY-MM-DD.pigstick.zip
Important: Always export a job before deleting it. Deleted jobs cannot be recovered.
6. Settings & Configuration
Job Management
The Job menu provides complete job lifecycle management:
New Job
Create a new job by entering the client name and job name. The new job becomes active immediately.
Edit Job
Configure the current job's settings:
Client: Client or company name
Job Name: Project or run identifier
Operator/Technician: Name of the operator
Pipeline Segment: Segment identifier
Passage Name Template: Auto-generate site numbers for new passages
Use {n} for plain numbers: Site-{n} → Site-1, Site-2
Use {n:3} for zero-padded: AGM-{n:3} → AGM-001, AGM-002
Use # as shorthand for {n}
Next #: The next number used for auto-generation. Edit this field directly to change where numbering resumes.
Notes: Job-level notes that apply to all passages
Load Job
Switch to a previously created job. Jobs are organized by client in a tree view. The active job is highlighted with a blue border and checkmark.
Delete Job
Permanently delete a job and all its passages. You cannot delete the active job; switch to a different job first.
Warning: Always export before deleting. Deletion is permanent and cannot be undone.
Job Indicator
The header displays the current job name. Click it to quickly open the Load Job dialog. When no job is configured, it shows "(No Job)".
WiFi Configuration (Optional)
Access Settings > WiFi Configuration to save one or more WiFi networks that have internet access. This is mainly used for software update checks and downloads. All normal PigStick features work without an internet connection.
Internet is Optional: You never need to configure this setting to use PigStick in the field. The device's own PigStick-XXXX network provides everything needed for passage capture, viewing, and export. Save an internet WiFi network only if you want the device to check for update availability at startup or download an update when you choose to install it.
The connection status banner shows whether the device is currently using a saved internet network:
Green dot - Connected, showing the network name
Red dot - Not connected
To connect to a network:
Click Scan to search for available networks
Select a network from the list (signal strength shown as colored bars)
Enter the WiFi password
Click Save Network
The device can store up to 5 WiFi networks. Saved networks persist across reboots.
Update Checks: At startup, the PigStick can briefly use a saved internet WiFi network to check whether an update is available. It then returns to its normal PigStick-XXXX WiFi network. The startup check only controls the update notice; it does not install anything by itself.
Note: During normal operation, connect your phone, tablet, or laptop to the PigStick-XXXX network. When the device is actively checking for or installing an update, that network may disappear temporarily and come back when the update check is finished.
Startup Behavior
Access Settings > Startup Behavior to configure how the device behaves at power-on:
Arm on Boot: When enabled, the device automatically starts monitoring for pig passages immediately at power-on without user interaction. Best used when the device is powered off between sites. Use with caution. Default: off.
Record Audio with Passage: Captures geophone audio with every passage, whether or not the geophone stream is open. Audio is still recorded when the device runs on its own with no browser connected. Default: on.
These settings are saved to the device and persist through power cycles. Use the Reset to Defaults button to restore both settings to their factory defaults.
Tip: For unattended field deployments where the device will be powered on and off at each site, enable "Arm on Boot" so the device is ready to capture passages immediately without needing to connect and manually arm.
Time Settings
Access Settings > Time Settings to configure time and date display:
Date Format:
YYYY-MM-DD (ISO format)
YYYY/MM/DD
DD/MM/YYYY (European)
MM/DD/YYYY (US)
Time Display:
Local (default)
UTC
The default date format is YYYY-MM-DD. The default time display is Local. These choices affect displayed event times, cursor times, GPS time display, CSV exports, and PDF reports.
Light Mode
Toggle Settings > Light Mode to switch between dark and light color themes:
Dark Mode (default): Dark background with light text. Easier on the eyes in low light.
Light Mode: Light background with dark text. Easier to read in bright sunlight.
Your theme preference is saved between sessions. Waveform colors adjust automatically so they stay readable in either theme.
Advanced Mode
Toggle Settings > Advanced Mode to show or hide technical controls and information:
When OFF (default):
Simplified interface for routine operation
System information panels hidden
Technical controls (scale, hold-off, gain) hidden
Canvas labels (voltage readings) hidden
When ON:
Uptime display visible in header
GPS, WiFi, System, and Log panels visible
All technical controls available
Detailed canvas labels showing voltage scales and settings
Copy Debug Info available in Help menu
Help Menu
User Guide: Opens this documentation
Keyboard Shortcuts: Quick reference for keyboard controls
Copy Debug Info: Copies diagnostic information to clipboard for support (Advanced Mode only)
About: Firmware version, app version, and contact information
GlobalTrack Link
The footer includes a "Live-Track your runs for free with GlobalTrack" link. It opens globaltrack.pigging.com in a new tab.
7. Connectivity & Software Updates
Two Different WiFi Uses
The PigStick uses WiFi in two different ways:
PigStick WiFi: The direct PigStick-XXXX network you connect to for normal use. This is used for live waveforms, passage capture, job management, exports, and settings.
Internet WiFi: A saved site, shop, phone hotspot, or office network used only when the PigStick needs to check for or download software updates.
Normal Field Use: Stay connected to PigStick-XXXX. You do not need internet access for monitoring, recording, viewing passages, editing jobs, or exporting data.
Startup Update Check
If an internet WiFi network has been saved, the PigStick does a quick update availability check during boot. It scans for a saved network, briefly connects if one is available, reads the update information, and then starts the normal PigStick-XXXX network.
If an update is available, a blue update link appears in the menu bar after you connect to the PigStick. The message comes from the update information and includes the available firmware and app versions when present.
If no saved internet network is nearby, the check is skipped and the device starts normally. If the check fails, normal field operation still starts.
Installing an Update
Updates are installed only when you choose to start the update process. Click the blue update link when you are ready. The browser will warn you that the PigStick WiFi network will disconnect briefly.
You can also start this process at any time from Settings > Check for Firmware Updates, even when no update link is showing. This behaves the same as clicking the blue update link: the PigStick restarts into update mode, briefly leaves its own WiFi network to check the saved internet network, installs any available update, and then returns to normal operation.
The PigStick saves the update request and restarts into update mode.
The PigStick-XXXX network goes offline while the device connects to the saved internet WiFi network.
The device checks for its assigned update job, downloads the files, installs them, and reports the result.
The PigStick restarts and brings PigStick-XXXX back for normal use.
Leave the browser page open during this process if practical. Some phones and laptops reconnect automatically when PigStick WiFi returns. Others may need you to manually reconnect to PigStick-XXXX and refresh or return to the page.
What Can Be Updated
A PigStick update can include firmware, the web application, or both:
Firmware: The software running on the device hardware.
App: The web interface files served by the device.
The About dialog and System panel show both version numbers. After an app update, refreshing the browser once may be needed if the old page was already open before the update completed.
Update Notice Messages
The update notice may use wording such as "Update available" or "Critical update available". The message is controlled by the update information published for the fleet, so important updates can be called out clearly.
When Updates Are Not Available
If no update is available, no update link is shown. In Advanced Mode, the System panel may show the last update-check result. The absence of an update link means the device does not currently see a newer version for itself.
8. Keyboard Shortcuts
Press ? at any time to display the shortcuts reference, or access it from Help > Keyboard Shortcuts.
General Controls
Key
Action
Space
Toggle ARM/DISARM (disabled when viewing a passage)
A
Toggle audio stream on/off
M
Toggle audio mute
G
Grab current window as passage (live view only)
E
Toggle Passages panel expand/collapse
L
Return to live view (exit passage viewer)
1-6
Set time window: 1=2s, 2=5s, 3=10s, 4=20s, 5=30s, 6=60s
Esc
Close dialog
?
Show keyboard shortcuts
Passage View Controls
Key
Action
← / →
Move cursor left/right
↑ / ↓
Zoom in/out
Shift + ← / →
Scroll view when zoomed in
Scroll wheel
Zoom in/out
Note: Keyboard shortcuts are disabled when typing in input fields or when a dialog is open.
9. System Information
These panels are visible when Advanced Mode is enabled.
Accelerometer: X, Y, Z axis readings. The DEVICE IS NOT UPRIGHT warning appears when tilt exceeds 45° from vertical.
GPS Panel
Displays GPS receiver status and position. The GPS receiver is rated for approximately ±2.5m CEP (Circular Error Probable) accuracy under typical conditions with a clear sky view.
Location: Latitude and longitude with copy/map buttons
Time: GPS time shown in your selected Time Display setting: Local or UTC
Satellites: Number of satellites in view
HDOP: Horizontal Dilution of Precision, shown as a number where lower is better. As a rough guide:
<1.0 = Excellent
1-2 = Good
2-5 = Moderate
>5 = Poor
WiFi Panel
Displays network connection details:
Internet WiFi: Whether the device is currently using a saved internet network
Network Name: Name of the connected internet network, when available
PigStick WiFi: Status of the device's own PigStick-XXXX network, including the number of phones, tablets, or computers connected directly to it
TX Audio / TX Magnetic: Data transfer statistics for the audio and magnetic streams
System Log
Displays system events including connections, errors, and status changes. Click "Clear Log" to clear entries.
Copy Debug Info
Available in the Help menu when Advanced Mode is enabled. Collects diagnostic information for troubleshooting:
PigStick receives periodic software updates that add new features, improve performance, and fix issues. When a saved internet WiFi network is available, the device can check for updates at startup and notify you when one is available. Installation starts only when you choose to run the update.
Recent Updates
Version 2.0.46 (June 2026)
Added startup update checks that show an update notice without requiring manual polling
Improved the update notice so it uses the published update message and shows available firmware/app versions
Updated app delivery so both compressed and uncompressed web files are included in app update jobs
Connected the Time Display setting to live displays, event timestamps, exports, and reports
Removed the manual Check Updates button from the System panel
Updated magnetic capture threshold controls to match the geophone threshold control style
Version 2.0.18 (June 2026)
Added the Max magnetic sensitivity preset to the live magnetic controls
Removed the separate Settings > Sensitivity dialog; use the live Sensitivity dropdown instead
Updated Help and footer links to open GlobalTrack in a new browser tab
About and System panels now show both firmware and web app versions
Version 2.0.2 (February 2026)
Added Light Mode theme option in Settings menu for improved visibility in bright conditions
Toggle switches now used consistently throughout Settings menu
Waveform colors automatically adjust for optimal contrast in each theme
Version 2.0.1 (January 2026)
Improved OTA update experience with download progress display
Browser now handles connecting mid-update gracefully
Simplified job indicator in title bar
Updated user guide with clearer explanations
Version 2.0.0 (January 2026)
New job management system with client/job hierarchy
Job Package export for complete data backup
Site name templates for automatic numbering
Passage playback with synchronized audio
Firmware updates over saved internet WiFi
Copy Debug Info for support troubleshooting
Version 1.5.0 (November 2025)
ELF transmitter detection with threshold triggering
Combined MFL + ELF capture mode
Geophone speed estimation
Configurable hold-off time (1-30 seconds)
12. Open API Reference
The PigStick exposes a full REST API and WebSocket interface for programmatic access. This allows custom integrations, automated data collection, and third-party tools to interact directly with the device over its WiFi network.
The API requires no authentication. Access is controlled by who can connect to the device's PigStick-XXXX network. All endpoints are served from http://10.0.0.1/api/v1/.
Full documentation: See the PigStick API Reference for complete endpoint details, request/response formats, WebSocket protocols, and example payloads.