API Reference — PPE Analytics

const ws = new WebSocket(
  'ws://localhost:4004/event_channel/0/<stream_id>/NFV4-PPE'
);

ws.onmessage = (msg) => {
  const event = JSON.parse(msg.data);
  console.log(event.primary_text, event.pipeline_data);
};

ws.onerror = (err) => console.error('WebSocket error', err);
ws.onclose = () => console.log('Disconnected');

import asyncio
import json
import websockets

async def listen():
    url = "ws://localhost:4004/event_channel/0/<stream_id>/NFV4-PPE"
    async with websockets.connect(url) as ws:
        async for msg in ws:
            event = json.loads(msg)
            print(event["primary_text"], event["pipeline_data"])

asyncio.run(listen())

{
  "analytic_id": "NFV4-PPE",
  "primary_text": "person",
  "secondary_text": "in",
  "pipeline_data": {
    "confidence": 0.86,
    "label": "person",
    "area_name": "Site Entrance",
    "direction": "in",
    "tracker_id": 5,
    "group_id": 0,
    "logic": "counting",
    "attributes": {
      "personal": { "label": "person", "confidence": 0.86 },
      "head_protection": { "label": "Hard helmet", "confidence": 0.92 },
      "protective_clothing": { "label": "Safety vest", "confidence": 0.88 }
    },
    "event_id": "1705314600-3a1f9d4c"
  }
}

{
  "analytic_id": "NFV4-PPE",
  "primary_text": "person",
  "secondary_text": "in",
  "pipeline_data": {
    "confidence": 0.82,
    "label": "person",
    "area_name": "Welding Bay",
    "direction": "in",
    "tracker_id": 9,
    "group_id": 0,
    "logic": "roi_counting",
    "attributes": {
      "personal": { "label": "person", "confidence": 0.82 },
      "face_shield": { "label": "Yes", "confidence": 0.89 },
      "gloves": { "label": "Yes", "confidence": 0.81 },
      "protective_clothing": { "label": "Coverall", "confidence": 0.84 }
    },
    "event_id": "1705314601-8b2c7e1a"
  }
}

{
  "analytic_id": "NFV4-PPE",
  "primary_text": "Restricted Area",
  "secondary_text": "120.000 s",
  "pipeline_data": {
    "confidence": 0.78,
    "label": "person",
    "area_name": "Restricted Area",
    "tracker_id": 12,
    "group_id": 0,
    "time_in": 1705314480000,
    "time_out": null,
    "time_alert": 1705314600000,
    "duration": 120.0,
    "logic": "dwelling",
    "attributes": {
      "personal": { "label": "person", "confidence": 0.78 },
      "head_protection": { "label": "Unknown", "confidence": 0.34 },
      "protective_clothing": { "label": "Safety vest", "confidence": 0.82 }
    },
    "event_id": "1705314600-1a2b3c4d"
  }
}

{
  "analytic_id": "NFV4-PPE",
  "primary_text": "Loading Dock",
  "secondary_text": "8",
  "pipeline_data": {
    "interval": 10,
    "area": "Loading Dock",
    "estimation": 8,
    "logic": "density",
    "detected": [
      {
        "tracker_id": 7,
        "group_id": 0,
        "bbox": { "top": 150, "left": 100, "width": 80, "height": 220 },
        "label": "person",
        "confidence": 0.84,
        "attributes": {
          "personal": { "label": "person", "confidence": 0.84 },
          "head_protection": { "label": "Hard helmet", "confidence": 0.9 },
          "protective_clothing": { "label": "Safety vest", "confidence": 0.86 }
        }
      }
    ],
    "event_id": "1705314600-9f4e2b7c"
  }
}