Docs

Documentation

Everything you need to connect your first machine.

GearMind is under active development — some capabilities described here are on our near-term roadmap, not yet live in production. Questions? hello@gearmind.co

On this page

Quickstart

Connect your first machine in about 30 minutes.

Create your free account — 3 machines, no card required.
Choose a connection method — CSV upload is the fastest way to start; OPC-UA, Modbus, and MQTT are better for continuous streaming.
Upload a CSV export or point GearMind at your endpoint — see the CSV format spec below for the exact columns.
Map your columns to GearMind's schema — vibration, temperature, power, pressure, RPM.
Review your first health scores — GearMind needs roughly 2 weeks of history before failure predictions activate.

Supported protocols

Real-time streaming, for when a CSV export isn't enough.

Protocol	Typical use	What you'll need
OPC-UA	Modern SCADA / PLC historians	Endpoint URL, security policy, credentials
Modbus TCP/RTU	Legacy PLCs, industrial controllers	IP/serial address, register map
MQTT	IoT gateways, edge devices	Broker URL, topic structure, credentials
REST API	Custom integrations	API key (see below)

CSV upload format

One row per sensor reading. Column order doesn't matter — headers do.

Column	Type	Notes
timestamp	ISO 8601	UTC recommended
machine_id	string	Must match a machine in your account
sensor_type	string	vibration, temperature, power, pressure, rpm
value	number
unit	string	mm/s, °C, kW, bar, rpm

timestamp,machine_id,sensor_type,value,unit
2026-08-13T09:00:00Z,compressor-c03,vibration,8.2,mm/s
2026-08-13T09:00:00Z,compressor-c03,temperature,89,°C
2026-08-13T09:05:00Z,compressor-c03,vibration,8.4,mm/s

API reference

REST endpoints reflect the current design — subject to change before general availability.

POST /v1/readings
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "machine_id": "compressor-c03",
  "timestamp": "2026-08-13T09:00:00Z",
  "sensor_type": "vibration",
  "value": 8.2,
  "unit": "mm/s"
}

GET /v1/machines/compressor-c03/predictions
Authorization: Bearer YOUR_API_KEY

{
  "machine_id": "compressor-c03",
  "status": "critical",
  "predicted_failure": "bearing_degradation",
  "confidence": 0.94,
  "eta_days": 18
}

Equipment-specific setup

Sensor mapping varies slightly by equipment category — see the full breakdown of sensors and failure modes on the homepage equipment section. Each category maps to a default GearMind schema; override individual sensor mappings per machine from your dashboard.

Troubleshooting

Issue	Likely cause
No data after CSV upload	Column headers don't match the spec above — check spelling and casing
Predictions not showing	Needs 2+ weeks of history before predictions activate
Readings look off	Check units — GearMind expects metric (mm/s, °C, kW)
Machine not recognized	machine_id in your upload must exactly match the ID in your account