ruumica documentation

Ingest OTDR traces

Store an OTDR trace on its fibre, get its verdict, and pair it with the measurement from the other end.

Ingesting a .sor file judges it against the project’s limits, places its events on the cable route and keeps the file as evidence. When the same fibre has been measured from the other end, the two are judged together.

Before you start

  • The project, the cable and its route (the spans it runs through) are recorded, and so are the nodes at both ends.
  • You have the .sor file and know which fibre it is, from which node it was measured, and which node is the far end.
  • DATABASE_URL and ASBUILT_BLOB_DIR are set.

Direction: A_TO_B means the OTDR was connected at the start of the cable’s route and measured along it; B_TO_A means it was connected at the far end and measured back.

Steps

  1. Look at the file first. This reads it without storing anything:

    $ asbuilt sor inspect fixtures/projects/ee-demo/traces/c2_f05_1310_ba.sor
    …
    2 events, end-to-end loss 0.052 dB, ORL 31.2 dB
    …
    

    Check the wavelength, the group index (n = …) and that the events look as expected.

  2. Ingest it, naming the cable, fibre, direction and both nodes:

    $ asbuilt sor ingest --project ee-demo --cable FO-12-002 --fiber 5 --direction B_TO_A --from-node CAB-3 --to-node SC-1 fixtures/projects/ee-demo/traces/c2_f05_1310_ba.sor
    927a492ce30d7f78  PROVISIONAL  end 152.408 m  factor 1.0215
      Warning OPTICAL_UNIDIRECTIONAL: one direction only: the verdict stays PROVISIONAL until the opposite direction is paired
    

    The line gives the file’s fingerprint, the verdict, the measured fibre end and the length factor fitted to the route.

  3. When the measurement from the other end arrives, ingest it the same way, with the opposite direction and the nodes swapped. ruumica finds its partner and judges the pair:

    $ asbuilt sor ingest --project ee-demo --cable FO-48-001 --fiber 1 --direction A_TO_B --from-node CAB-1 --to-node CAB-2 fixtures/projects/ee-demo/traces/c1_f01_1550_ab.sor
    f136aa34ebf72b37  PASS  end 649.006 m  factor 1.0215  paired with ff72264655a24af0
    

    paired with names the fingerprint of the partner trace. The order does not matter: the second trace of a pair, whichever it is, completes the pair.

Check

The verdict is PASS or FAIL once both directions are in, PROVISIONAL while only one is. Ingesting the same file again changes nothing and prints the same line.

What can go wrong

You see Meaning Do
SOR_BAD_GROUP_INDEX The file’s group index is missing or implausible. Give it from the cable data sheet: Correct the group index.
SLACK_NO_GEOMETRY The cable’s route has no span lengths. Record the route first.
SLACK_FACTOR_OUT_OF_RANGE The fibre is too long or too short for its route. Record the missing slack loop, or correct the route.
BIDIR_LENGTH_MISMATCH or BIDIR_WAVELENGTH_MISMATCH The two traces are not two directions of one fibre. Check fibre numbers and wavelengths.
SOR_NO_KEYEVENTS The file carries no event table. Export it again from the OTDR software.

Last changed 2026-11-15