Skip to content

sid5432/rbOTDR

Repository files navigation

rbOTDR: Simple OTDR SOR file parse written in Ruby

The SOR ("Standard OTDR Record") data format is used to store OTDR (optical time-domain reflectometer ) fiber data. The format is defined by the Telcordia SR-4731, issue 2 standard. While it is a standard, it is unfortunately not open, in that the specifics of the data format are not openly available. You can buy the standards document from Telcordia for $750 US (as of this writing), but this was beyond my budget. (And likely comes with all sorts of licensing restrictions. I wouldn't know; I have never seen the document!)

There are several freely available OTDR trace readers available for download on the web, but most do not allow exporting the trace curve into, say, a CSV file for further analysis, and only one that I've found that runs natively on Linux (but without source code; although some of these do work in the Wine emulator). There have been requests on various Internet forums asking for information on how to extract the trace data, but I am not aware of anyone providing any answers beyond pointing to the free readers and the Telcordia standard.

Fortunately the data format is not particularly hard to decipher. The table of contents on the Telcordia SR-4731, issue 2 page provides several clues, as does the Wikipedia page on optical time-domain reflectometer.

Using a binary-file editor/viewer and comparing the outputs from some free OTDR SOR file readers, I was able to piece together most of the encoding in the SOR data format and written a simple program (in Ruby) that parses the SOR file and dumps the trace data into a file. (For a more detailed description, other than reading the source code, see my blog post).

Presented here for your entertainment are my findings, in the hope that it will be useful to other people. But be aware that the information provided here is based on guess work from looking at a limited number of sample files. I can not guarantee that there are no mistakes, or that I have uncovered all possible exceptions to the rules that I have deduced from the sample files. use it at your own risk! You have been warned!

The program was ported over from my original pyOTDR written in Python (which was ported over from my earlier pubOTDR written in Perl). To parse an OTDR SOR file, run the program as

rbOTDR.rb myfile.sor

where "myfile.sor" is the name (path) to your SOR file. A OTDR trace file "myfile-trace.dat" and a JSON file "myfile-dump.json" will be produced. There is also a Clojure version, cljotdr; this will be of interest to people looking for a Java version, since Clojure runs on top of a Java Virtual Machine (JVM).

Dependencies

This program requires the crc module. To install this module, run

gem install crc

(Last Revised 2017-12-30)

About

Simple OTDR SOR file parser written in Ruby

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published