5953685ffb
Includes: README explaining purpose / scope / temporary-location framing / format decision, CONTRIBUTING.md with proposed workflow + per-class semver versioning policy + validation commands, format/equipment-class.schema.json defining the shape of a class template (classId, version, displayName, applicability, signals, alarms, optional stateModel), format/tag-definition.schema.json defining the shape of a single canonical signal (name, dataType, category, unit, isArray, accessLevel, writeIdempotent, isHistorized, scaling), format/uns-subtree.schema.json defining the shape of a per-site UNS subtree (enterprise + site + areas + lines), classes/fanuc-cnc.json as the worked pilot class with 16 signals + 3 alarms + suggested state-derivation notes (per OtOpcUa corrections doc D1), uns/example-warsaw-west.json as a worked UNS subtree example, docs/overview.md (what / why / lifecycle / what's NOT in this repo), docs/format-decisions.md (8 numbered decisions covering JSON Schema choice per corrections D2, per-class semver, additive-only minor bumps, _default placeholder reservation, signal-name vs UNS-segment regex distinction, stateModel-as-informational, no per-equipment overrides at this layer, applicability.drivers as OtOpcUa driver enumeration), docs/consumer-integration.md (how OtOpcUa / Redpanda / dbt each integrate). $id URLs in the JSON schemas resolve at the actual current path so validators don't 404. Top-level README adds a row to the Component Detail Files table pointing to schemas/. Corrections doc B2 (schemas-repo dependencies) marked partially RESOLVED with the seed location and a list of what still needs the plan team or cross-team owner to decide (owner team naming, dedicated repo migration, format-decision ratification, FANUC CNC pilot confirmation, CI gate setup, Redpanda + dbt consumer integration plumbing). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
94 lines
3.8 KiB
JSON
94 lines
3.8 KiB
JSON
{
|
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
"$id": "https://gitea.dohertylan.com/dohertj2/3yearplan/raw/branch/main/schemas/format/equipment-class.schema.json",
|
|
"title": "Equipment-Class Template",
|
|
"description": "Declares the canonical raw signal vocabulary for an equipment class. Consumed by OtOpcUa (validates per-equipment tag config), Redpanda (derives Protobuf event schemas), and dbt (derives column definitions for the curated layer).",
|
|
"type": "object",
|
|
"required": ["classId", "version", "displayName", "signals"],
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"classId": {
|
|
"type": "string",
|
|
"pattern": "^[a-z0-9-]{1,64}$",
|
|
"description": "Stable logical ID for the class. Lowercase, hyphens allowed. Once published, never changes — clients pin to it."
|
|
},
|
|
"version": {
|
|
"type": "string",
|
|
"pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+$",
|
|
"description": "Semver. Major bump = breaking change; minor = additive non-breaking; patch = doc/clarification only."
|
|
},
|
|
"displayName": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"maxLength": 128,
|
|
"description": "Human-readable name (e.g. 'FANUC CNC')."
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 1024,
|
|
"description": "Optional longer description."
|
|
},
|
|
"vendor": {
|
|
"type": "string",
|
|
"maxLength": 64,
|
|
"description": "Vendor or family (e.g. 'FANUC', 'Allen-Bradley', 'Siemens')."
|
|
},
|
|
"applicability": {
|
|
"type": "object",
|
|
"description": "When this class applies. Optional; omit for vendor-agnostic classes.",
|
|
"properties": {
|
|
"drivers": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"enum": ["Galaxy", "ModbusTcp", "AbCip", "AbLegacy", "S7", "TwinCat", "Focas", "OpcUaClient"]
|
|
},
|
|
"description": "Which OtOpcUa drivers can populate equipment of this class."
|
|
},
|
|
"models": {
|
|
"type": "array",
|
|
"items": { "type": "string" },
|
|
"description": "Free-text model identifiers (e.g. '0i-F', '30i-B' for FANUC; '1756-L84E' for Logix)."
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"signals": {
|
|
"type": "array",
|
|
"minItems": 1,
|
|
"items": { "$ref": "tag-definition.schema.json" },
|
|
"description": "Required signals every equipment of this class must expose. Operator-configured tags in OtOpcUa are validated against this list — missing required signals = config error; extra signals are allowed (operator-extensible)."
|
|
},
|
|
"alarms": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"required": ["alarmId", "displayName", "severity"],
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"alarmId": { "type": "string", "pattern": "^[a-z0-9-]{1,64}$" },
|
|
"displayName": { "type": "string", "minLength": 1, "maxLength": 128 },
|
|
"severity": { "type": "string", "enum": ["Low", "Medium", "High", "Critical"] },
|
|
"description": { "type": "string", "maxLength": 1024 }
|
|
}
|
|
},
|
|
"description": "Optional canonical alarm definitions for this class."
|
|
},
|
|
"stateModel": {
|
|
"type": "object",
|
|
"description": "Optional declaration of how this class's raw signals derive into the canonical machine-state vocabulary at Layer 3 (System Platform / Ignition). Informational — derivation lives at Layer 3, not in OtOpcUa.",
|
|
"properties": {
|
|
"states": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"enum": ["Running", "Idle", "Faulted", "Starved", "Blocked", "Changeover", "Maintenance", "Setup"]
|
|
}
|
|
},
|
|
"derivationNotes": { "type": "string", "maxLength": 2048 }
|
|
},
|
|
"additionalProperties": false
|
|
}
|
|
}
|
|
}
|