openFTTH
GitHub Download
FeaturesHow it worksDocsChangelogGitHub

Docs/Crew and tools

Exports and deliverables

The GeoPackage, BOQ, splice schedule, validation report and the versioned design bundle.

1 min read

Every deliverable saves out of File → Export. Inside the project folder they live under deliverables/.

Deliverables

FileWhat it holds
design.gpkgGeoPackage: one layer per element type, openFTTH attributes as an extra_json column, the splice tables and the metadata as attribute tables. Opens in QGIS.
boq.csv, boq.jsonThe bill of quantities, priced from the rulebook. With build phases, one BOQ per phase (the trench is dug once).
splice_schedule.csvThe splice schedule from the fibre assignment.
validation.jsonThe result of the rule checks.
summary.jsonA summary of the design.
map.pngA map of the design.

What the BOQ covers

  • Equipment and cable from the rulebook's units prices, and labour from labour.
  • Trench and reinstatement per metre by surface.
  • Aerial spans, facade metres, pole attachments and pole/wall-to-ground transitions where those route types are used.
  • Crossings used, as permit-and-pits and drilling lines.
  • Risers, floor boxes and flat cabling in blocks of flats.
  • Warnings the engineer must accept at sign-off show in the BOQ tab as "exceptions to accept".

The design bundle

A project is a folder and a git repository; no git.exe is needed. Its design/ folder holds the canonical GeoJSON design bundle, one feature per line, and decisions.ndjson records every decision with its reason and values.

text
<project>/
  project.json          id, stage, created_at
  rulebook.yaml         the rulebook used
  design/               GeoJSON design bundle (canonical, one feature per line)
  twin/streets.geojson  street graph with surfaces, for the renderer
  deliverables/         boq.json  boq.csv  map.png  summary.json  validation.json
  decisions.ndjson      every decision with its reason and values

Versions

Every tool call commits once. You can list the versions, diff two of them by element id, and tag a version as approved. Rewinding is a risky tool that needs approval, and it is itself a new commit. The same inputs give the same bundle bytes, apart from the timestamp.

Exporting for construction

export_for_construction is a risky tool: whether the crew or an outside AI app calls it, it opens an approval card in the app and waits for the engineer. A licensed engineer signs the final package.

From other AI apps

Over the MCP link, list_deliverables returns the files, and openftth://deliverables/{name} serves the BOQ, splice schedule, validation, summary, map and GeoPackage, up to 20 MB each. See MCP link.