Equipment

Equipment represents the industrial machinery and assets that IMMUNE monitors. Each piece of equipment can have multiple sensors attached and receives predictive maintenance insights based on collected data.

The equipment model

The equipment model contains all the information about your industrial assets, their configuration, and maintenance history.

Properties

  • Name
    id
    Type
    string
    Description

    Unique identifier for the equipment.

  • Name
    name
    Type
    string
    Description

    Human-readable name for the equipment.

  • Name
    type
    Type
    string
    Description

    Type of equipment (pump, motor, compressor, etc.).

  • Name
    facility_id
    Type
    string
    Description

    ID of the facility where this equipment is located.

  • Name
    status
    Type
    string
    Description

    Current operational status (running, stopped, maintenance).

  • Name
    installation_date
    Type
    string
    Description

    Date when the equipment was installed.

  • Name
    last_maintenance
    Type
    string
    Description

    Date of the last maintenance performed.

  • Name
    sensors
    Type
    array
    Description

    List of sensors attached to this equipment.

Register equipment

Register new equipment

curl -X POST https://api.immune.dev/v1/equipment \
  -H "Authorization: Bearer {token}" \
  -d '{
    "name": "Main Cooling Pump",
    "type": "centrifugal_pump",
    "facility_id": "plant_north",
    "installation_date": "2023-01-15",
    "specifications": {
      "manufacturer": "Industrial Pumps Inc",
      "model": "CP-2000",
      "capacity": "200L/min",
      "motor_power": "75kW"
    }
  }'

List equipment

List all equipment

curl -X GET https://api.immune.dev/v1/equipment \
  -H "Authorization: Bearer {token}"

Get equipment details

Get equipment details with predictions

curl -X GET https://api.immune.dev/v1/equipment/pump_001 \
  -H "Authorization: Bearer {token}" \
  -d "include=predictions,sensors,maintenance_history"

Update equipment

Update equipment details

curl -X PATCH https://api.immune.dev/v1/equipment/pump_001 \
  -H "Authorization: Bearer {token}" \
  -d '{
    "status": "maintenance",
    "last_maintenance": "2024-01-20T08:00:00Z"
  }'

Equipment health score

Each piece of equipment receives a health score based on sensor data and predictive analytics:

Get equipment health score

curl -X GET https://api.immune.dev/v1/equipment/pump_001/health \
  -H "Authorization: Bearer {token}"

Response:

{
  "equipment_id": "pump_001",
  "health_score": 87,
  "risk_level": "low",
  "predictions": {
    "estimated_remaining_life": "3 months",
    "confidence": 0.92,
    "potential_issues": [
      {
        "component": "bearing",
        "probability": 0.15,
        "severity": "medium"
      }
    ]
  }
}

Best practices

  1. Keep equipment specifications up to date
  2. Regularly review health scores
  3. Document maintenance activities
  4. Monitor prediction trends
  5. Configure appropriate sensor coverage

Was this page helpful?