====== AFT fiber tracer ======
---- dataentry projects ----
status_ : active
oneline : a tool for tracing fiber optic lines
----
I have on occasion required a tool for identifying fiber optic lines at work. While it isn't often enough to justify the expense of a proper fiber test device, it might be within my capabilities to construct a basic fiber "toner" set.
The project's working title is AFT (Arduino Fiber Tracer or Adequate Fiber Tracer or AFT Fiber Tracer).
===== Background =====
==== Necessity ====
==== SFP modules ====
SFPs (small form-factor pluggable) are compact IR transceivers designed for fiber optic networking. There are two major advantages to using an SFP in this device. First, it puts the tester on equal footing with the devices in the live environment. We don't have to worry about propagation distances; if the SFP-equipped tester can't transmit over the entire fiber run, then neither will a switch be able to. Second, it allows the tester to check the SFP itself using DDM/DOM [(ddm_dom)] or I2C [(sfp_i2c)]. In the future, we may also be able to program the tester to talk to live network devices to help determine where the other end of the cable goes((It seems likely that an Arduino Uno is not fast enough to process Ethernet frames. One of the beefier boards may, but this feature is not essential for the tester as described.)).
The electrical pinout is shown in {{ref>tab_sfp_pinout}}.
SFP pinout
^ Pin ^ Name ^ Function ^
| 1 | VeeT | Transmitter ground |
| 2 | Tx_Fault | Transmitter fault indication |
| 3 | Tx_Disable | Optical output disabled when high |
| 4 | SDA | 2-wire serial interface data line (using the CMOS EEPROM protocol defined for the ATMEL AT24C01A/02/04 family [(twi_protocol)]) |
| 5 | SCL | 2-wire serial interface clock |
| 6 | Mod_ABS | Module absent, connection to VeeT or VeeR in the module indicates module presence to host ((This is a prime target for connecting to a falling interrupt.)) |
| 7 | RS0 | Rate select 0 |
| 8 | Rx_LOS | Receiver loss of signal indication |
| 9 | RS1 | Rate select 1 |
| 10 | VeeR | Receiver ground |
| 11 | VeeR | Receiver ground |
| 12 | RD- | Inverted received data |
| 13 | RD+ | Received data |
| 14 | VeeR | Receiver ground |
| 15 | VccR | Receiver power (3.3 V, max. 300 mA) |
| 16 | VccT | Transmitter power (3.3 V, max. 300 mA) |
| 17 | VeeT | Transmitter ground |
| 18 | TD+ | Transmit data |
| 19 | TD- | Inverted transmit data |
| 20 | VeeT | Transmitter ground |
The ''Tx_disable'' pin is connected to an internal pull-up resistor inside the module. This pin must be pulled low to enable the transmit laser.
==== Osmocom SPF experimenter ====
For the prototypes, we will be using the Osmocom SFP Experimenter board. This breakout contains all support circuitry required to send single-ended signals through an SFP. No restriction is made on the input data, so we need not send valid Ethernet frames. That opens up the question of how we are to encode the data for transmission [(data_encoding)]. Of course, instead of sending arbitrary bits, we could instead transmit a clock. There's no need to encode the data ourselves---just use hardware UART pins.
For whatever reason, the SFP Experimenter board is designed to accept I/O connections through SMA connectors (one per stream). The units ship without the connectors soldered to the board, so we can add whatever kind of interface we want---simple wires will do.
The I2C bus on the board already includes pull-up resistors, so no external pull-ups are required.
==== SFP data registers ====
SFP modules expose a great deal of data detailing their internal status, all accessible through I2C at one of two addresses (''0xA0'', ''0xA2''). Before data can be read, the EEPROM address must be loaded in by performing a dummy write containing the 8-bit EEPROM address to retrieve. For example, the device vendor name is stored in 16 bytes at I2C address ''0xA0'', EEPROM address 20. The following snippet demonstrates this procedure.
// load in the EEPROM address
Wire.beginTransmission(0x50);
Wire.write(20);
Wire.endTransmission();
// request the data
Wire.requestFrom(0x50, 16);
// data is now ready for read(), see docs
After each read, the internal address register is incremented so it points to the next byte. Given the way we're most likely to access this table, this fact is of relatively little use to us.
==== Serial data transmission ====
===== Design =====
The idea is to have a pair of Arduino-based devices. For a given test session, one (designated the toner) is connected the the line under test and begins transmitting a particular signal. The other (designated the probe) watches for this signal. Once it finds the signal, it can send a reply back to confirm that the toner is indeed on the other end. Each device should be equipped with a display and some kind of controls for communicating with the user.
==== User interface ====
User I/O can be provided over I2C with an Adafruit RGB LCD shield. The LCD color can be used to indicate status (e.g., red = no SFP, green = paired, yellow = sending) to free up screen space. The shield also includes a four-way directional keypad and select button((Alternatively, since we only need a single button and bidirectional motion controls, a rotary encoder with pushbutton would suffice.)).
Operation is split into two primary modes: SFP diagnostic and tone. SFP diagnostic mode gets a subset of device parameters from the SFP over I2C [(sfp_i2c)] and displays it on the screen. Each page indicates the parameter name on the top row and the value (with units) on the bottom row. Tone mode transmits a signal through the SFP and watches for a return signal. If the partner device is detected, the screen lights green and a success message appears. The ''SELECT'' button cycles through modes.
If space permits, a serial debug mode would be handy. This mode would accept commands (possibly binary data for efficiency) over USB and offer direct read/write access to the hardware. It should probably be accessible only through a key combination.
==== Firmware ====
On startup, the tester initializes I/O devices, prints a splash screen, and drops into SFP diagnostic mode.
At the beginning of the main loop, the tester verifies that an SFP is present. If not, we call a function to display a warning message, turn the screen red, and busy wait. Once an SFP is inserted, the tester gets button status, setting the appropriate action flags (on arrow buttons) or updating the mode byte (on ''SELECT'' button). That mode byte then determines what happens for the rest of the loop.
^ Value ^ Mode ^
| ''0x00'' | SFP diagnostic |
| ''0x01'' | Tone |
| ''0x02'' | Probe |
| ''0xFF'' | USB debug |
SFP diagnostic mode uses an offset into a table to determine which parameter to load from the SFP. If the user pressed ''UP'' or ''DOWN'', then that offset is adjusted accordingly before the read. Once read, the parameter name is printed to the top row, and the parameter value is scaled as necessary and written to the bottom row (with units if applicable).
The tone functionality is bisected into two modes. We call these "tone" and "probe" by analogy to a copper tone and probe set. The unit in tone mode continuously transmits a signal((Currently thinking either PWM [(pwm_read)] or ''tone()''/''pulseIn()'' for this signal. The probe calculates the parameters and generates its own signal, and the toner measures the incoming signal to see if it matches the outgoing. We could cycle through parameter values using the arrow keys, in theory allowing us to use multiple toners and have the probe tell us which it's connected to.)) on the wire and awaits a return. The unit in probe mode watches for the toner's signal and transmits its own in return. Once a tester is both transmitting and receiving, the LCD lights green and indicates a connection.
In USB debug mode, the user can send commands to the tester and inspect its internal state. This mode should only be accessible by holding the mode select button to prevent accidental activation.
===== Prototyping =====
* 2x [[https://store-usa.arduino.cc/collections/boards/products/arduino-uno-rev3|Arduino Uno Rev3 (\$28)]] Arduino Leonardo
* 2x [[https://shop.sysmocom.de/SFP-experimenter-board-v2-kit/sfp-exp-v2-kit|Osmocom SFP experimenter (€65.45)]]
* 2x [[https://www.adafruit.com/product/498|20x4 LCD with RGB backlight (\$25)]]
* 2x [[https://www.adafruit.com/product/781|LCD serial+USB backpack (\$13)]]
* 2x [[https://www.adafruit.com/product/377|rotary encoder with push button (\$4.50)]]
* [[https://www.amazon.com/EDGELEC-Breadboard-Optional-Assorted-Multicolored/dp/B07GD25V8D/ref=sr_1_3?crid=1VZ5G237VAZER&keywords=breadboard%2Bjumper%2Bwires&qid=1671261503&s=industrial&sprefix=breadboard%2Bjumper%2Bwir%2Cindustrial%2C211&sr=1-3&th=1|15cm jumper wire assortment (\$8)]]
We don't want to rely on the Osmocom SFP Experimenter board for the final product, but it has the major advantage of a built-in differential transmitter and receiver((If sending differential signals, must they be of the same magnitude? Can I send a clock into one side and the actual data into the other? Need to read more and possibly simulate this.)).
{{ref>tab_pin_usage}} indicates proposed pin connections. Underlined items are ideally suited for interrupts((Since the controls will be operated at human speed, interrupts probably aren't necessary for the encoder.)).
==== Communication ====
UART transmission is not looking terribly promising at this time.
Different SFP models appear to produce different signals when the output is open. The SMF unit (unknown vendor) outputs nothing, while the Veloso units send (noisy) pulse trains (see {{ref>fig_idle}}). They also respond differently to inputs, with the former producing an inverted replica of the input and the latter outputting what might be PWM ({{ref>fig_k}}).
{{ :rnd:projects:smf-idle.png?400 |}}
SMF
{{ :rnd:projects:veloso-idle.png?400 |}}
Veloso
Idle responses from signal loopback
{{ :rnd:projects:smf-k.png?400 |}}
SMF
{{ :rnd:projects:veloso-k.png?400 |}}
Veloso
Responses to UART ''k'' at 115200 baud, 8N1
==== Power considerations ====
Portable operation is a must for this tester.
===== Relevant links =====
* [[https://www.adafruit.com/product/714|I2C LCD shield kit with keypad]] (LCD not included)
* [[https://osmocom.org/projects/misc-hardware/wiki/Sfp-experimenter|Osmocom SFP experimenter]]
* [[https://cotsworks.com/support-documents/single-ended-vs-differential/|single-ended vs differential signals]]
* [[https://hackaday.io/project/21599-optical-power-meter-with-sfp-and-ddm-protocol|Arduino optical power meter]]
* [[https://www.mouser.com/ProductDetail/TE-Connectivity/5-5530843-0?qs=sGAEpiMZZMtWxQ3D3EXBN0Ey9L8xlYZ5WRp665TwrBg%3D|a card edge connector that might actually work]]; [[https://edac.net/series/395|the EDAC 395 series]] (specifically 395-020-558-xxx models or 395-020-520-201) are also promising
* [[https://www.adafruit.com/product/781|Adafruit Serial+USB LCD backpack]]
* the [[https://learn.adafruit.com/adafruit-feather/overview|Feather]] platform might also be a viable brain for this project; the [[https://www.adafruit.com/product/2771|32u4 model]] is software/pin compatible with Arduino and features built-in battery connections and monitoring
* the [[https://www.pjrc.com/store/teensy41.html|Teensy 4.1]] may also be a good production brain; it's also compatible with Arduino, has many more interrupt pins; if we use the model with Ethernet header and connect [[https://www.pjrc.com/store/ethernet_kit.html|a matching jack]], we might be able to use it to tone out copper lines as well (as long as they're **not** energized)
* [[https://www.adafruit.com/product/2078|Adafruit PowerBoost 500 rechargeable shield]]
* [[https://www.adafruit.com/product/326|Adafruit 0.96" 128x64 monochrome OLED display]]
* [[https://lastminuteengineers.com/rotary-encoder-arduino-tutorial/]]
* [[https://www.instructables.com/Improved-Arduino-Rotary-Encoder-Reading/]]
* [[https://github.com/Stutchbury/EncoderButton]]
* [[https://www.instructables.com/Manchester-Code-Library-for-Arduino/]], [[https://github.com/mdeudon/Manchester]], [[wp>manchester code]]
* https://www.ti.com/lit/ug/tidu366/tidu366.pdf
* https://cdn.hackaday.io/files/21599924091616/AN_2030_DDMI_for_SFP_Rev_E2.pdf
* https://gitea.osmocom.org/electronics/osmo-small-hardware/raw/branch/master/sfp-breakout/sfp-experimenter.pdf
* https://www.ti.com/lit/ds/symlink/sn65lvds1.pdf?ts=1672100269172&ref_url=https%253A%252F%252Fwww.ti.com%252Fproduct%252FSN65LVDS1%252Fpart-details%252FSN65LVDS1D%253Futm_source%253Dgoogle%2526utm_medium%253Dcpc%2526utm_campaign%253Docb-tistore-promo-asc_opn_en-cpc-storeic-google-wwe%2526utm_content%253DDevice%2526ds_k%253DSN65LVDS1D%2526DCM%253Dyes%2526%2526utm_source%253Dgoogle%2526utm_medium%253Dcpc%2526utm_campaign%253D%2526utm_content%253D%2526ds_k%253Dsn65lvds1d%2526DCM%253Dyes%2526gclid%253DCjwKCAiAqaWdBhAvEiwAGAQltruYrSedpQ0uALxXlAq5xiuhmzbVhkdHlCKyi0L3cz9s1VCdN4uf8xoCVpwQAvD_BwE%2526gclsrc%253Daw.ds
* https://hackaday.com/2020/05/11/new-teensy-4-1-arrives-with-100-mbps-ethernet-high-speed-usb-8-mb-flash/
* https://twitter.com/PA4DAN/status/1108517564005695491/photo/1
* https://www.fluxlight.com/content/Tech-Docs/AdTran%2012004800%20Datasheet.pdf
* https://hackaday.com/2021/02/13/experiment-with-sfp-modules-with-this-handy-breakout/
===== References =====
[(data_encoding>https://www.section.io/engineering-education/different-techniques-of-encoding-data-for-transmission/)]
[(ddm_dom>[[https://www.gigabit-wireless.com/technology/what-is-ddm-and-dom-used-in-optical-sfp-sfp-transceivers/]])]
[(sfp_eeprom>[[https://ohwr.org/projects/sfp-plus-i2c/wiki/user-eeprom]])]
[(sfp_i2c>[[https://members.snia.org/document/dl/25916|SFF-8472]])]
[(pwm_read>[[https://www.benripley.com/diy/arduino/three-ways-to-read-a-pwm-signal-with-arduino/]], [[https://create.arduino.cc/projecthub/kelvineyeone/read-pwm-decode-rc-receiver-input-and-apply-fail-safe-6b90eb]])]
[(sparkfun_serialcomm>https://learn.sparkfun.com/tutorials/serial-communication)]
[(twi_protocol>https://ww1.microchip.com/downloads/en/devicedoc/doc0180.pdf)]
{{tag>electronics}}