Skip to content

Add debug mode #NE-1211 State Done #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
loulecrivain wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add debug mode #NE-1211 State Done #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
888ebd6
disable fortify mode to allow for debug + add missing pkgs
loulecrivain May 6, 2026
ca30cc5
switch to slog + add more debug logging
loulecrivain May 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
103 changes: 73 additions & 30 deletions cmd/optic-programmer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,38 @@ package main

import (
"context"
"log"
"fmt"
"log/slog"
"os"
"strconv"
"strings"
"time"

"github.com/urfave/cli/v3"
"github.com/wobcom/rtbrick-optic-programmer/internal/pkg/rtbrick"
connection "github.com/wobcom/rtbrick-optic-programmer/internal/pkg/ssh"
)

func getLoglevel(level string) slog.Level {
switch strings.ToLower(level) {
case "error":
return slog.LevelError
case "warn":
return slog.LevelWarn
case "info":
return slog.LevelInfo
case "debug":
return slog.LevelDebug
}
panic("invalid log level provided")
}

func main() {
slog.SetLogLoggerLevel(slog.LevelInfo)
if level, ok := os.LookupEnv("LOG_LEVEL"); ok {
slog.SetLogLoggerLevel(getLoglevel(level))
}

cmd := &cli.Command{
Flags: []cli.Flag{
&cli.StringFlag{
Expand Down Expand Up @@ -86,33 +107,40 @@ func main() {
resultPage1E := rtbrick.InterpretPage1E(page1E)
resultPage1B := rtbrick.InterpretPageB0(page1B)

log.Printf("Vendor Name: %v", resultPage00.VendorName)
log.Printf("Vendor PN: %v", resultPage00.VendorPN)
log.Printf("Vendor SN: %v", resultPage00.VendorSN)
slog.Info("module_info", slog.String("vendor_name", resultPage00.VendorName))
slog.Info("module_info", slog.String("vendor_phy", resultPage00.VendorPN))
slog.Info("module_info", slog.String("vendor_serial", resultPage00.VendorSN))

log.Printf("Tuning Status: %b", resultPage12.Status)
log.Printf("Grid Spacing: %v", resultPage12.GridDisplay)
log.Printf("Frequency Offset: %v", resultPage12.FrequencyOffset)
log.Printf("Frequency: %v THz", float32(resultPage12.Frequency)/100.0)
slog.Info("module_info", slog.String(
"tuning_status", fmt.Sprintf("%b", resultPage12.Status),
))
slog.Info("module_info", slog.String("grid_spacing", resultPage12.GridDisplay))
slog.Info("module_info", slog.Float64("frequency", float64(resultPage12.Frequency)*1e-12))
slog.Info("module_info", slog.Int("frequency_offset", resultPage12.FrequencyOffset))
if resultPage12.Channel != nil {
log.Printf("Channel: %v", *resultPage12.Channel)
slog.Info("module_info", slog.Int("channel", *resultPage12.Channel))
} else {
log.Printf("No Valid Channel!")
slog.Warn("No Valid Channel found!")
}

log.Printf("Flex Tune Enabled: %v", resultPage1E.FlexTuneEnabled)
log.Printf("Power Class Override: %x", resultPage1E.PowerClassOverride)
log.Printf("Low Power Mode: %v", resultPage00.LowPowerMode)
slog.Info("module_info", slog.Bool("flex_tune_enabled", resultPage1E.FlexTuneEnabled))
slog.Info("module_info", slog.String("power_class_override_status",
fmt.Sprintf("%x", resultPage1E.PowerClassOverride),
))
slog.Info("module_info", slog.Bool("low_pwr_mode_enabled", resultPage00.LowPowerMode))

log.Printf("Nominal Wavelength Control Enabled: %v", resultPage1B.NominalWavelengthControlEnabled)
slog.Info("module_info", slog.Bool(
"nominal_wavelength_control_enabled",
resultPage1B.NominalWavelengthControlEnabled,
))

return nil
},
},
{
Name: "program",
Aliases: []string{"s"},
Usage: "Shows information about an optic in a specific device",
Usage: "Programs an optic in a specific device",
Arguments: []cli.Argument{
&cli.StringArg{
Name: "device",
Expand Down Expand Up @@ -185,11 +213,11 @@ func main() {
resultPage1E := rtbrick.InterpretPage1E(page1E)
resultPage1B := rtbrick.InterpretPageB0(page1B)

log.Printf("Vendor Name: %v", resultPage00.VendorName)
log.Printf("Vendor PN: %v", resultPage00.VendorPN)
log.Printf("Vendor SN: %v", resultPage00.VendorSN)
slog.Info("module_info", slog.String("vendor_name", resultPage00.VendorName))
slog.Info("module_info", slog.String("vendor_phy", resultPage00.VendorPN))
slog.Info("module_info", slog.String("vendor_serial", resultPage00.VendorSN))

log.Printf("Setting Low Power Mode...")
slog.Info("Setting Low Power Mode...")

wPage, wByte, wValue := rtbrick.GetLowPowerProgramming(true)
err = routerConnection.DoI2CSet(i2cBusId, wPage, wByte, wValue)
Expand All @@ -200,7 +228,7 @@ func main() {
time.Sleep(1 * time.Second)

if resultPage1E.PowerClassOverride != 0x01 {
log.Printf("Setting Power Class Override...")
slog.Info("Setting Power Class Override...")

wPage, wByte, wValue = rtbrick.GetPowerClassProgramming()
err = routerConnection.DoI2CSet(i2cBusId, wPage, wByte, wValue)
Expand All @@ -212,7 +240,7 @@ func main() {
}

if resultPage1E.FlexTuneEnabled {
log.Printf("Disabling Flex Tune...")
slog.Info("Disabling Flex Tune...")

wPage, wByte, wValue = rtbrick.GetFlexTuneProgramming()
err = routerConnection.DoI2CSet(i2cBusId, wPage, wByte, wValue)
Expand All @@ -222,26 +250,37 @@ func main() {

time.Sleep(1 * time.Second)
} else {
log.Printf("Flex Tune is already disabled...")
slog.Info("Flex Tune is already disabled...")
}

needsGridProgramming := resultPage12.GridDisplay != strconv.Itoa(gridSpacing)
needsChannelProgramming := resultPage12.Channel == nil || *resultPage12.Channel != channel

if needsGridProgramming {
log.Printf("Grid Spacing must be programmed to %v GHz, currently %v GHz", gridSpacing, resultPage12.GridDisplay)
slog.Info(
"grid spacing mismatch, reprogramming",
slog.Int("target", gridSpacing),
slog.String("current", resultPage12.GridDisplay),
)
wPage, wByte, wValue := rtbrick.GetGridProgramming(gridSpacing)
err := routerConnection.DoI2CSet(i2cBusId, wPage, wByte, wValue)
if err != nil {
return err
}

} else {
log.Printf("Grid Spacing is already programmed at %v GHz, no programming needed...", resultPage12.GridDisplay)
slog.Info(
"grid spacing already matching, will not reprogram",
slog.String("current", resultPage12.GridDisplay),
)
}

if needsGridProgramming || needsChannelProgramming {
log.Printf("Channel must be programmed to %v, currently %v", channel, *resultPage12.Channel)
slog.Info(
"channel mismatch, reprogramming",
slog.Int("target", channel),
slog.Int("current", *resultPage12.Channel),
)

wPage, wByte, wValue, wPage2, wByte2, wValue2 := rtbrick.GetChannelProgramming(gridSpacing, channel)
err := routerConnection.DoI2CSet(i2cBusId, wPage, wByte, wValue)
Expand All @@ -254,13 +293,16 @@ func main() {
}

} else {
log.Printf("Channel is already programmed at %v, no programming needed...", *resultPage12.Channel)
slog.Info(
"channel already matching, will not reprogram",
slog.Int("current", *resultPage12.Channel),
)
}

time.Sleep(1 * time.Second)

if !resultPage1B.NominalWavelengthControlEnabled {
log.Printf("Setting Nominal Wavelength Control Programming...")
slog.Info("Setting Nominal Wavelength Control Programming...")

wPage, wByte, wValue = rtbrick.GetNominalWavelengthControlProgramming()
err = routerConnection.DoI2CSet(i2cBusId, wPage, wByte, wValue)
Expand All @@ -270,10 +312,10 @@ func main() {

time.Sleep(1 * time.Second)
} else {
log.Printf("Nominal Wavelength Control is already enabled...")
slog.Info("Nominal Wavelength Control is already enabled...")
}

log.Printf("Enabling High Power Mode...")
slog.Info("Enabling High Power Mode...")

wPage, wByte, wValue = rtbrick.GetLowPowerProgramming(false)
err = routerConnection.DoI2CSet(i2cBusId, wPage, wByte, wValue)
Expand All @@ -288,6 +330,7 @@ func main() {
}

if err := cmd.Run(context.Background(), os.Args); err != nil {
log.Fatal(err)
slog.Error("fatal error!", "error", err)
os.Exit(1)
}
}
4 changes: 4 additions & 0 deletions flake.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,16 @@
overlays = [ self.overlay ];
};
minimal-dev-pkgs = with pkgs; [
libcap
gcc
gopls
go
delve
];
in {
devShell = pkgs.mkShell {
nativeBuildInputs = minimal-dev-pkgs;
hardeningDisable = [ "fortify" ];
};
}
));
Expand Down
12 changes: 9 additions & 3 deletions internal/pkg/rtbrick/i2c.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,16 @@ import (
"bytes"
"encoding/binary"
"encoding/hex"
"log"
"log/slog"
"math"
"strconv"
"strings"
)

func ParseI2CDump(dump string) ([]byte, error) {
slog.Debug("======== I2C Dump ========")
slog.Debug("\n" + dump)
slog.Debug("======== ======== ========")

lines := strings.Split(dump, "\n")

Expand All @@ -25,14 +28,17 @@ func ParseI2CDump(dump string) ([]byte, error) {
for _, x := range strings.Split(p2, " ") {
b, err := hex.DecodeString(x)
if err != nil {
log.Fatalf("could not parse, %v", err)
slog.Error("could not parse", "code", err)
panic(err)
}
w.Write(b)
}

}

return w.Bytes(), nil
allBytes := w.Bytes()
slog.Debug("raw_decoded_i2c_bytes", slog.String("hex_string", hex.EncodeToString(allBytes)))
return allBytes, nil

}

Expand Down
8 changes: 5 additions & 3 deletions internal/pkg/ssh/connection.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@ package connection

import (
"bytes"
"encoding/hex"
"encoding/json"
"fmt"
"io"
"log"
"log/slog"
"net"
"os"

Expand Down Expand Up @@ -145,7 +146,7 @@ func (r *RouterConnection) RunSSHCommand(command string) (string, error) {
session.Stdout = &stdoutBuffer
session.Stderr = &stderrBuffer

log.Printf("Running command=%v", command)
slog.Info("running_ssh", slog.String("command", command))
err = session.Run(command)
if err != nil {
return "", err
Expand All @@ -154,7 +155,8 @@ func (r *RouterConnection) RunSSHCommand(command string) (string, error) {
return stdoutBuffer.String(), nil
}

func (r *RouterConnection) GetI2CDump(i2cbusId int, page int) ([]byte, error) {
func (r *RouterConnection) GetI2CDump(i2cbusId int, page byte) ([]byte, error) {
slog.Debug("page_dump_cmd", slog.String("hex_page", hex.EncodeToString([]byte{page})))
_, err := r.RunSSHCommand(fmt.Sprintf("sudo i2cset -y %d 0x50 127 %d", i2cbusId, page))
if err != nil {
return nil, err
Expand Down