Documentation · draft

Documentation

Concepts and guides for PHL AI. Pages marked Conceptual describe intended behaviour; pages marked Guide (draft) describe workflows that will change as the product is built. Nothing here documents a live public API.

Draft documentation

The product is in development. Examples use the fictional demo cell and illustrative values.

Getting started Guide (draft)

The fastest way to understand PHL AI is the public demo, which needs no account. A first workspace then follows six steps:

  • Create a workspace and facility (or load the sample facility).
  • Add assets manually, by CSV or from the sample pack.
  • Choose a data path: sample data, a historical import, or a gateway.
  • Map signals and publish the first twin version.
  • Accept or enter starter rules with their source.
  • Review the first finding and invite a colleague.

Open the demo →

Platform concepts Conceptual

Workspaces isolate data. Every asset has one ID used by every product. Twin versions are immutable once published.

Every derived value carries an output class:

  • OBS reading as received · RULE deterministic rule · STAT deviation check
  • SCEN scenario model output · NOTE human decision · DATA data quality
  • MODEL trained model output — reserved; no trained models exist yet

Asset modelling Conceptual

Hierarchy: Facility › Area › Cell › Asset › Component. Each asset has a tag (unique per workspace), type, criticality (A/B/C) and optional ratings and files.

facility,area,cell,asset_tag,asset_name,asset_type,criticality
Northstar Manufacturing,Machining,Cell 3,PMP-001,Coolant pump,Centrifugal pump,A

Telemetry Conceptual

Readings are stored in UTC with the source timestamp and an ingest timestamp. Each signal has a canonical unit and an expected interval. A signal with no reading for longer than its maximum age is stale (30 minutes in the demo). Gaps are preserved and never interpolated.

Quality codes: good, uncertain, bad, substituted. Readings with unknown units are quarantined with a reason.

Digital twins Conceptual

A twin version holds the signal map, relationships, plan-view layout and rule references. Fidelity is labelled Structural, Visual, Parametric or Validated; only a person can record Validated, with evidence.

Integrations Guide (draft)

  • CSV / Parquet import guide Available in MVP
  • Gateway setup with AWS IoT Greengrass Requires adapter
  • OPC UA read-only adapter configuration Requires adapter
  • CMMS history import (CSV) Available in MVP
  • Webhooks Planned

See the integration catalogue for the status of every connector.

Security Conceptual

Workspace isolation, five roles, append-only audit history, encryption in transit and at rest, and outbound-only gateways with per-device certificates. These are design intentions until verified. Security overview →

Troubleshooting Guide (draft)

  • An asset shows Stale. No reading arrived within the maximum age. Check the gateway status and the source tag; rules are paused on stale data.
  • Readings are missing after import. Open the import’s error file: unknown units, unparsable timestamps and out-of-range values are quarantined.
  • A scenario will not run. Pre-run validation lists missing inputs, such as a station’s rated rate, with a link to set it.
  • Times look shifted. Charts use the workspace time zone; hover a timestamp to see UTC.