Optical Transceiver EEPROM Tools

Professional-grade tools for reading, parsing, and coding optical transceivers in SONiC environments

Download Package

Get the latest version of MDSI Transceiver Tools

Python Wheel Package

Version 1.0.0

Pre-built wheel package ready for installation

📦 Download .whl

Source Distribution

Version 1.0.0

Source package with all files and dependencies

📄 Download .tar.gz

Installation Script

For SONiC PMON

Automated installation script for SONiC environments

🚀 Download Script

Installation Methods

pip install
Installation Script
From Source
# Install from wheel
pip install mdsi_transceiver_tools-1.0.0-py3-none-any.whl

# Or install from source
pip install mdsi_transceiver_tools-1.0.0.tar.gz
# For SONiC PMON container
chmod +x install_to_pmon.sh
./install_to_pmon.sh

# The script will:
# - Copy package to PMON container
# - Install dependencies
# - Set up CLI command
# - Verify installation
# Extract and install
tar -xzf mdsi_transceiver_tools-1.0.0.tar.gz
cd mdsi_transceiver_tools-1.0.0
pip install .

Quick Start

1

Install the Package

pip install mdsi_transceiver_tools-1.0.0-py3-none-any.whl
2

Check Connected Modules

mdsi-transceiver info --port Ethernet0
3

View Full Details

mdsi-transceiver show --port Ethernet0
4

Code a Module (Safe Test)

mdsi-transceiver code --port Ethernet0 \
  --profile generic_dac_vendor_update \
  --dry-run

Documentation

📖 Usage Examples

Step-by-step guides and real-world scenarios

⚡ Quick Start Guide

Get started in minutes

💻 CLI Reference

Complete command-line interface documentation

🔧 Installation Guide

Detailed installation instructions

🔌 SONiC Integration

Integrate with SONiC platform

🏗️ Engineering How-To

Advanced engineering topics

Common Use Cases

Check What's Connected

# Quick module check
mdsi-transceiver info --port Ethernet0

# Output:
# Port: Ethernet0
# Module Type: QSFP-DD
# Vendor: MDSI Corporation
# Part Number: DAC-3M-QSFP-DD
# Serial Number: ABC123456
# Temperature: 28.5°C
# Status: Present and operational

Safe Coding Workflow

# Step 1: Backup the EEPROM
mdsi-transceiver dump --port Ethernet0 --page 0 --output backup.bin

# Step 2: Test with dry-run (SAFE - no changes)
mdsi-transceiver code --port Ethernet0 \
  --profile generic_dac_vendor_update \
  --dry-run

# Step 3: Review output, then code for real
mdsi-transceiver code --port Ethernet0 \
  --profile generic_dac_vendor_update

# Step 4: Verify the changes
mdsi-transceiver show --port Ethernet0

List Available Profiles

# See all coding profiles
mdsi-transceiver list-profiles

# Output:
# Available coding profiles:
#   - example_aoc_coding
#   - example_dac_coding
#   - generic_dac_vendor_update

Dump Raw EEPROM Data

# Dump page 0 (lower memory)
mdsi-transceiver dump --port Ethernet0 --page 0 --output page0.bin

# View with hexdump
hexdump -C page0.bin

Key Features

🔍

EEPROM Reading

Read and parse transceiver EEPROM data with full CMIS 5.2 support

✏️

Safe Coding

Code modules with dry-run mode and automatic verification

📋

Profile-Based

Use YAML/JSON profiles for consistent coding operations

🛡️

Production Ready

Comprehensive error handling and logging for production use

🔌

SONiC Compatible

Designed for SONiC platform integration with PMON support

⚙️

CLI & API

Both command-line interface and Python API available