No description
  • C++ 49.5%
  • TypeScript 42.3%
  • Rust 3.8%
  • Shell 1%
  • Python 0.7%
  • Other 2.6%
Find a file
Jonas Leder 9dda0fc052
Some checks are pending
ci / upload-to-s3 (push) Blocked by required conditions
ci / publish-to-google-play (push) Blocked by required conditions
ci / publish-to-aur (push) Blocked by required conditions
ci / deploy-beta-firmware (push) Blocked by required conditions
ci / build-update-info (push) Has been skipped
ci / changes (push) Successful in 14s
ci / build-app-macos (push) Has been skipped
ci / build-mcu (push) Waiting to run
ci / build-app-windows (push) Waiting to run
ci / build-app-debian (push) Waiting to run
ci / build-app-appimage (push) Waiting to run
ci / build-app-android (push) Waiting to run
ci / pages (push) Successful in 3m3s
Merge pull request 'chore(deps): update dependency @material/web to v2.5.0' (#391) from renovate/material-web-2.x into master
Reviewed-on: #391
2026-11-18 23:04:35 +00:00
.forgejo Publish docs and updater to git-pages 2026-11-18 15:25:50 +01:00
.vscode fix permissions on aur build 2026-03-15 12:01:42 +01:00
case add 3D files for case 2026-11-10 12:45:19 +01:00
docs Publish docs and updater to git-pages 2026-11-18 15:25:50 +01:00
external Update external/TransceiverTool digest to 811da32 2026-10-07 18:11:41 +00:00
fastlane configure fastplane for publishing android app 2025-12-15 11:15:23 +01:00
packaging/aur Port CI from GitLab CI to Forgejo Actions 2026-11-18 14:21:34 +01:00
pcb add some 100nf capacitors 2026-03-01 12:14:28 +01:00
software Merge pull request 'chore(deps): update dependency @material/web to v2.5.0' (#391) from renovate/material-web-2.x into master 2026-11-18 23:04:35 +00:00
.gitignore Integrate TransceiverTool 2025-12-25 00:00:48 +01:00
.gitmodules Integrate TransceiverTool 2025-12-25 00:00:48 +01:00
Gemfile fix fastlane deploy 2026-06-05 12:45:30 +02:00
kodus-config.yml add kodus config 2026-11-09 22:49:12 +01:00
LICENSE Add License 2026-03-26 21:36:36 +01:00
Readme.md Publish docs and updater to git-pages 2026-11-18 15:25:50 +01:00
renovate.json fix too new python 2026-10-20 21:57:44 +02:00

SFP-Tool

SFP-Tool is a small handy devices for managing SFP transceivers on the field. It can either be used for testing transceivers or for reprogramming programmable ones. If the transceiver is password protected, you can use the bruteforce feature for cracking the password.

3D render of the SFP-Tool

Documentation

The repository now contains a CI-built documentation set under docs/.

  • User manual source: docs/user-manual.md
  • Hardware and software reference source: docs/hardware-software-reference.md
  • Forgejo (git-pages) landing page: https://jonasled.jonasled.dev/sfp-tool/
  • Published manuals: /docs/*.html and /docs/*.pdf
  • Firmware recovery updater: /updater/

Hardware

The brain of the hardware is a ESP-32 S3 chip. This chip was choosen, as is has more than enough power and all required interfaces, including Bluetooth for remote controlling the device. The hardware is based on a custom PCB with a SFP and a QSFP connector for transceivers. Aditionally to the PCB a 1.3" 128x64px OLED is required, both SH1106 and SSD1306 are supported. In the app settings can the display type set.

Software

ESP32

The Software for the ESP is written using Arduino an PlatformIO, the plan is to run as many features as possible directly on the ESP and not via the App, to reduce the need of a always connected phone or PC.

App

There is a mobile and a desktop version available for the following Plattforms:

Android APK/AAB builds and the latest CI artifacts are also available from the Forgejo Actions runs: https://forgejo.jonasled.dev/jonasled/sfp-tool/actions

In theory the app can be build for all major platforms. The macOS build is not signed with an Apple developer license (that requires a yearly subscription), so Gatekeeper may block the first launch; open it via right-click, Open. The application itself is a React app, which runs on Tauri for cross compiling. It connects via BLE to the ESP ans allows controlling the device. There is no difference in features between the desktop and the mobile version.

Firmware Upload

If the firmware on the ESP breaks, or a update is required you can either download the latest firmware from the artifacts and do a manual upgrade using esptool ( required for crash-looping and brand new devices ) or use the Web based updater. Please note, this works only in Chronium based browsers, like Google Chrome or MS Edge.

Web based Updater: https://jonasled.jonasled.dev/sfp-tool/updater/