PigStick™ User Guide

Field guide for monitoring, capturing, reviewing, and exporting pig passages.

Contents

1. Field Quick Start

Connect directly to the PigStick

  1. Set the PigStick upright and turn it on.
  2. On your phone, tablet, or computer, join the WiFi network named PigStick-XXXX. The last four characters identify the unit.
  3. Enter the password pigstick.
  4. Open http://pigstick-XXXX.local. If that address does not open, use http://10.0.0.1.
  5. Wait for the DEVICE light to turn green and the live magnetic trace to appear.
No internet is required. Direct WiFi gives you live monitoring, recording, passage review, jobs, and exports in the field.

Prepare for a run

  1. Confirm the correct device name and battery level at the top of the screen.
  2. Create or load the correct job from the Job menu.
  3. Confirm the magnetic Mode, Sensitivity, and capture settings.
  4. Press START on the Geophone Stream if you want to listen live.
  5. Press ARM. The button changes to DISARM while automatic capture is active.
Records independently: Once armed, the PigStick continues monitoring and saving passages even if the browser disconnects. Reconnect later to see the saved passages and current arm state.

Before leaving the site

2. Understanding the Screen

Top bar

Main cards

Phones, tablets, and multiple viewers

The layout stacks vertically on smaller screens. Up to two viewers can use the live sensor streams at the same time. Close old or duplicate tabs if a new viewer cannot start a stream.

Settings such as magnetic mode, sensitivity, capture controls, and audio amplification are shared device settings. A change made by one viewer can appear in the other. Listening volume, theme, and some display preferences stay with the individual browser.

3. Jobs and Recording Setup

Create or load a job

Check the active job before arming. New passages are stored under the job shown in the top bar.

Startup Behavior

Open Settings > Startup Behavior to choose:

Use Arm on Boot only when the unit will be installed and left ready to record without an operator present.

Time Settings

Use Settings > Time Settings to choose the displayed date format and whether GPS time is shown as local time or UTC. These options change how times are displayed; they do not alter saved passage data.

4. Live Monitoring and Capture

Mag Stream

The magnetic trace starts automatically after connection.

ControlWhat it does
ARM / DISARMStarts or stops automatic passage capture.
ModeMag Only shows the magnetic passage signal, ELF Only shows the transmitter signal, and ELF + Mag shows both.
SensitivitySelects Low, Medium, High, or Max magnetic sensitivity. Start with the normal job setting and increase only when more sensitivity is needed.
WindowChanges how much recent time is visible without changing the recorded data.
Grab Window as PassageImmediately saves the magnetic window visible on screen under the active job, then opens the new passage.

Recording Space shows how much passage storage is in use. A full PigStick will not arm and displays a message asking you to export and delete finished jobs. A PigStick stores roughly 100 passages in total across all of its jobs. If an armed PigStick reaches a storage limit in the field, it makes room by removing the oldest finished job; when only the active job remains, it removes that job's oldest passage.

The Auto job under the device serial number is temporary default storage. Create and use a named job for passages you need to retain. If the PigStick starts with unusably full storage, it may empty Auto first while keeping the Auto job and serial-number client available, then remove the oldest finished jobs only if more space is needed. A warning appears once when automatic cleanup has occurred.

Mag Capture Settings

Expand Mag Capture Settings to choose how automatic passage capture starts:

When the threshold is visible on the chart, use it as the practical setup guide: normal background should remain inside the guide and a wanted signal should cross it.

Capture progress and manual grabs

During a capture, a highlighted passage card and progress indicator appear. The completed passage is saved on the PigStick and becomes available to every connected viewer.

Grab Window as Passage is useful for testing, saving something that already happened while disarmed, or retaining a signal that did not trigger automatically. It saves only the history currently visible in the Mag Stream; it does not record another ten seconds. Aligned geophone audio is included when Record Audio with Passage is on and that complete audio history is available. When saving finishes, the new passage opens automatically.

Geophone Stream

ControlWhat it does
START / STOPStarts or stops live geophone listening and waveform display.
ModeChooses the live visual. Waveform shows signal shape; Spectrum shows how low and high geophone frequencies change over time.
WindowChanges the amount of recent audio shown.
AmpChanges geophone amplification for the live signal and future recordings. It is shared by all viewers.
VolumeChanges listening loudness in this browser only. It does not change saved recordings.
MuteSilences or restores browser playback without stopping the stream.

Raise Amp until useful signals are clear, but lower it if the waveform repeatedly flattens at the top or bottom. Adjust Volume separately for comfortable listening.

Using Spectrum mode

Select Mode > Spectrum to see how the geophone signal's frequency content changes over time. Lower frequencies appear near the bottom and higher frequencies near the top; brighter colors indicate a stronger signal. Use the one-second tick marks to compare when a frequency change occurred with the magnetic trace or passage cursor.

Spectrum covers 0 to 1 kHz and is a visual aid for recognizing changes in signal texture, not a calibrated sound-level measurement. Passages containing recorded geophone audio can also switch between Waveform and Spectrum during review and synchronized playback without using additional recording space. Passages without audio remain in Waveform view.

The capture low-pass filter still determines which frequencies reach the display and recordings. LP 500 Hz removes the upper half of the Spectrum view. LP 2 kHz preserves the useful 0 to 1 kHz geophone band while limiting higher-frequency noise. Use LP off only when the job requires the unfiltered capture path.

Speed display and filters

Advanced Mode can show speed controls. Speed estimation requires Waveform view and is turned off while Spectrum is selected. In Waveform view, enable speed tracking, enter the distance represented by the segment, choose units, and set the threshold above background noise. A low-confidence result is hidden rather than shown as a dependable speed.

Authorized service users may also see capture filters. Filter changes affect both the live geophone signal and future recordings, so leave them at the approved job settings unless support directs otherwise.

Why the live traces sit slightly behind real time

The browser keeps a small reserve of incoming data so both traces move smoothly when WiFi delivery varies. The magnetic and audio views may differ by a fraction of a second. This does not change recorded passage timing.

After a short WiFi pause, a backgrounded tab, or an interrupted delivery, each display automatically moves forward and settles back near live data. Use RECONNECT only if a stream remains disconnected.

5. Reviewing Passages

Passage list

The Passages card lists recordings for the active job. Use the sort control to show newest or oldest first. A card may include:

Open and navigate a passage

Select a passage card to replace the live view with the saved recording. Use Back or press L to return to live monitoring.

Playback

Passages with geophone audio can play the saved waveform and sound together. Use play, pause, resume, the scrubber, or stop. Passages without audio can still be reviewed visually.

Edit, copy, map, and delete

Job Trail

View → Job Trail draws the active job's recording positions on a map: numbered points in passage order, a connecting line, a distance scale, and a north arrow. When the browser has internet access a map background appears automatically, with Map and Satellite buttons to switch the background style; without internet the trail still works with the same positions on a plain background. Passages recorded without a GPS fix are listed below the map instead of being drawn.

The map can be moved and zoomed: drag to move, scroll or pinch to zoom, and double click to zoom in. Zooming in on the Satellite background shows detail down to individual facilities. The map background sharpens a moment after you stop moving. If you lose your place, select Recenter to return to the view of the whole trail.

6. Exports and Backups

Job exports are available from the Job menu and work over the direct connection.

ExportBest use
Export PackageComplete backup of the active job, passages, recordings, and job information, including the PDF report and the run summary numbers in a form spreadsheets and other tools can read.
Merge Leapfrog JobsCombines exported packages from two or more PigSticks into one time-ordered report.
Export as PDFPrintable field report with a trail map, passage summary table, pig speed estimates, and one page per passage.
Export as CSVPassage list and job details for spreadsheets or other office tools.

While a passage is open for review, the Export PNG button above the waveform saves an image of that passage.

Merging runs from two or more PigSticks

When trackers are leapfrogged along a line, each PigStick records its own share of the passages. To build one combined report:

  1. Export a package from each PigStick (Job > Export Package).
  2. From any PigStick screen, select Job > Merge Leapfrog Jobs. A short explanation appears; select Okay, then choose the downloaded package files.
  3. Review the preview. It shows each package, how many passages it holds, and confirms that all passages will be combined in time order; none are removed.
  4. Select Merge. A combined PDF report and a merged package download to the computer. Nothing is changed on any PigStick.

In the merged report each passage keeps its original site name and shows which PigStick recorded it. If two trackers recorded passages close together in time, both passages appear. Review them manually if one looks duplicated.

Export before deleting. A deleted job cannot be restored from the PigStick. Keep the downloaded package in the normal project backup location.

7. Connections and Updates

WiFi modes

Open Settings > WiFi Mode to choose how the PigStick connects. Tap a mode to read about it: the panel below the list shows what it does, a picture of who connects to what, and exactly how to open the app in that mode. Reading around does not change anything.

The mode that is running now is marked Current. Picking a different mode changes the button at the bottom to Apply; nothing changes until you press it. Switching between the two router modes applies immediately. Switching to or from Hotspot only asks for a restart.

Direct connection

Join PigStick-XXXX and open http://pigstick-XXXX.local or http://10.0.0.1. This connection works without internet service. In Router only mode the hotspot is off while the router connection is healthy. Open the app from that network instead.

Starlink or local network connection

Open Settings > WiFi Networks to let the PigStick join a Starlink, office, shop, or home network:

  1. Select Add Network.
  2. Choose the network, enter its password, and select Save & Connect.
  3. Follow any restart message shown by the dialog.

Once connected, other devices on that network can normally open http://pigstick-XXXX.local. To change how the PigStick connects, use Settings > WiFi Mode; each mode there also shows exactly how to open the app.

Each saved network appears as a card showing its name, status, and priority. The PigStick tries saved networks in priority order (1 first). Use the arrow buttons on a card to change the order, and put the network at your current site first so the PigStick reconnects to it quickest. Remove old entries from other sites with the Forget button.

Install an update

  1. Connect the PigStick to an internet-capable saved network.
  2. Use Settings > Check for Updates or select the blue update notice.
  3. Read the warning and confirm only when monitoring can pause.
  4. Keep the PigStick powered while it downloads, restarts, and reconnects.
  5. Open Help > About to confirm the displayed versions afterward.
Do not install during an active run. Live monitoring pauses and the PigStick restarts. Saved passages remain on the device.

8. Settings and Help

Light Mode

Turn on Settings > Light Mode for better visibility in bright outdoor conditions. Waveform colors adjust with the theme.

Advanced Mode

Turn on Settings > Advanced Mode when support information or advanced job controls are needed. It adds system, GPS, WiFi, and log panels plus selected advanced controls. Normal monitoring and capture do not require it.

Passage Chime

Turn on Settings > Passage Chime to hear a short chime in this browser the moment a passage recording starts. While the chime is on, a small green bell appears beside the DEVICE indicator in the menu bar. The chime plays at a fixed volume even when the geophone stream is muted or turned down, and the choice is remembered per browser. The C key also toggles it. Browsers only allow sound after you have interacted with the page, so if nothing has been clicked since the page loaded the first chime can be silent; turning the chime on or pressing ARM in this browser is enough. Only browsers receiving live waveforms (up to two viewers) play the chime.

Language

Settings > Language changes the display language of the PigStick screen for this browser only. Nine languages are available: English, Traditional Chinese, Simplified Chinese, Korean, Japanese, Spanish, Brazilian Portuguese, German, and French. Reports and exports stay in English, and the setting never changes the device itself. If a translation reads wrong, send it through Help > Report Bug.

Help menu

Information to send support

When reporting a problem, include what you were doing, the time it happened, the device serial number, and the copied debug information. Do not edit the copied report before sending it; it helps support see connection and stream health.

9. Keyboard Shortcuts

Press ? or choose Help > Keyboard Shortcuts for the on-screen reference.

KeyAction
SpaceArm or disarm while in live view.
AStart or stop the geophone stream.
MMute or unmute browser audio.
CTurn the passage chime on or off.
GGrab the current window as a passage.
EExpand or collapse the Passages card.
LReturn to live view.
1-6Select the displayed time window from 2 to 60 seconds.
EscClose the open dialog.
?Show shortcuts.
/ Move the cursor in passage view.
/ Zoom in or out in passage view.
Shift + / Move a zoomed passage left or right.

Shortcuts are disabled while you type in a field or while a dialog is open.

10. Troubleshooting

Cannot open the PigStick screen

  1. Confirm you joined the correct PigStick-XXXX WiFi.
  2. Turn off cellular data or any VPN temporarily if the phone keeps using another route.
  3. Try http://10.0.0.1 instead of the name address.
  4. Move closer to the PigStick and refresh once.
  5. If necessary, restart the PigStick and reconnect after its WiFi returns.

DEVICE is red or RECONNECT appears

Select RECONNECT and wait a few seconds. If it remains red, confirm WiFi is still connected to the PigStick, close duplicate tabs, and reload the page.

A live waveform stops or looks delayed

No passages are being captured

Audio is too quiet, too loud, or distorted

GPS is yellow or red

Move the unit where it has a clear view of the sky and allow time to acquire. A passage can still be recorded without GPS, but its map button and location may be unavailable.

An export does not download

An update is not offered

Confirm the WiFi mode is Hotspot + Router or Router only and the router network has internet access, then choose Check for Updates. No notice appears when the installed version is already current or no update has been assigned.

Still need help?

Turn on Advanced Mode, choose Help > Copy Debug Info, and send the copied report with the device serial number, the time of the issue, and a short description of what was visible on screen.

11. Developer API

Every function of this screen is also available to your own software. The PigStick serves a local web API on the same WiFi connection, covering live streams, passages, jobs, exports, and device settings. No internet access is required.

See the PigStick API Reference for the full list of endpoints, request and response formats, and examples.

12. Version History

The version history now has its own page listing every release, with only changes that field operators can see or use.

Open the PigStick Version History. It is also available from Help > About, beneath the version numbers.