API & Integration Documentation

Protocol-agnostic output. Any format you need.

📡 Output Formats

Cloud-Scale captures weight data from any source (RS232, TCP/IP, display OCR) and outputs in any format you need:

  • REST API — JSON responses for modern system integration
  • Webhooks — Event-driven notifications to your endpoints
  • MQTT — Real-time streaming for IoT platforms
  • RTSP Video — Weight overlay on video for NVR/VMS
  • Virtual COM Port — Legacy software compatibility via Cloud Scale Transport
  • Raw TCP/IP — Direct socket connection with configurable protocols
  • RS232 Output — Serial output for legacy hardware integration

🔌 REST API Coming with Cloud Platform

The Cloud-Scale REST API provides programmatic access to weight data, device management, and analytics.

Base URL

https://api.cloud-scale.us/v1

Authentication

API requests require a bearer token in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Endpoints

GET /scales

List all scales associated with your account.

GET /scales/{scale_id}/current

Get the current weight reading from a scale.

GET /scales/{scale_id}/history

Get historical weight readings with optional time range filters.

Example Response

{
  "scale_id": "scale-001",
  "weight": 5000.00,
  "unit": "lb",
  "status": "STABLE",
  "timestamp": "2026-02-09T04:30:00Z",
  "confidence": 0.99
}

🔔 Webhooks Coming with Cloud Platform

Receive real-time notifications when weights are captured or status changes.

Webhook Payload

{
  "event": "weight.captured",
  "scale_id": "scale-001",
  "data": {
    "weight": 5000.00,
    "unit": "lb",
    "status": "STABLE",
    "timestamp": "2026-02-09T04:30:00Z"
  }
}

Event Types

EventDescription
weight.capturedA stable weight was captured
weight.changedWeight value changed (motion detected)
scale.onlineScale came online
scale.offlineScale went offline
scale.errorScale reported an error

📺 RTSP Video Stream

Scale Streamer outputs an ONVIF-compliant RTSP video stream with weight overlay.

Stream URL

rtsp://{device_ip}:554/stream

Supported Clients

  • Any ONVIF-compatible NVR (Dahua, Hikvision, etc.)
  • Video Management Systems (Milestone, Genetec, etc.)
  • VLC Media Player
  • ffmpeg / ffplay
  • Any RTSP client library

Stream Parameters

ParameterValue
CodecH.264
Resolution1920x1080 (configurable)
Frame Rate30 fps (configurable)
Bitrate2-4 Mbps (configurable)

🔌 TCP/IP Direct Connection

Connect directly to Cloud-Scale devices over TCP for raw weight data.

Connection

TCP {device_ip}:5000

Output Protocols

Configure the device to output in any protocol your system expects:

  • Fairbanks 6011 — Standard truck scale protocol
  • Rice Lake — Rice Lake indicator format
  • Mettler-Toledo — MT-SICS and Toledo formats
  • Custom — Define your own format string

Example Output (Fairbanks 6011)

    5000 LB G

💻 Virtual COM Port (Cloud Scale Transport)

Cloud Scale Transport creates a virtual COM port on Windows that connects to TCP scales over the network.

How It Works

  1. Install Cloud Scale Transport on your Windows PC
  2. Configure the TCP endpoint (IP:port of your scale/device)
  3. Select a COM port number (e.g., COM10)
  4. Your legacy software sees a local serial port

Use Cases

  • Legacy inventory software that requires COM port input
  • Forklift laptop connecting to floor scales wirelessly
  • Scale ticketing software without TCP support
  • Any RS232-only application

📋 Protocol Support

Cloud-Scale is protocol-agnostic. We read from any source and output in any format.

Input Protocols (What We Read)

ProtocolSource
RS232 SerialDirect connection to scale indicator
TCP/IPNetwork-enabled scales
Display OCRCamera reading (Scale Streamer Vision)

Output Protocols (What We Produce)

FormatUse Case
REST API / JSONModern web applications, ERP integration
WebhooksEvent-driven systems, automation
MQTTIoT platforms, real-time dashboards
RTSP VideoNVR/VMS, security systems
TCP SocketCustom integrations
Virtual COMLegacy software (via Transport)
RS232Legacy hardware

🤖 AI Integration

Structured weight data ready for AI/ML applications.

Data Format

Every weight reading includes structured metadata for AI consumption:

{
  "scale_id": "scale-001",
  "scale_name": "Truck Scale - Main Gate",
  "weight": 45280.5,
  "unit": "lb",
  "status": "STABLE",
  "timestamp": "2026-02-09T04:30:00.123Z",
  "confidence": 0.99,
  "source": "vision_ocr",
  "metadata": {
    "facility_id": "facility-001",
    "location": "Main Gate",
    "tags": ["inbound", "truck"]
  }
}

AI Use Cases

  • Anomaly Detection — Identify unusual weights that may indicate fraud or errors
  • Predictive Maintenance — Detect scale drift before compliance issues
  • Natural Language Queries — "What was the average inbound weight last week?"
  • Throughput Optimization — Analyze patterns to maximize efficiency
  • Automated Reporting — Generate daily/weekly summaries automatically