- C++ 49.5%
- TypeScript 42.3%
- Rust 3.8%
- Shell 1%
- Python 0.7%
- Other 2.6%
|
Some checks failed
ci / build-app-android (push) Has been skipped
ci / build-app-windows (push) Has been skipped
ci / build-app-appimage (push) Has been skipped
ci / publish-to-google-play (push) Has been skipped
ci / pages (push) Successful in 5m39s
ci / build-mcu (push) Successful in 8m42s
ci / deploy-beta-firmware (push) Failing after 24s
ci / build-update-info (push) Has been skipped
ci / changes (push) Successful in 15s
ci / build-app-debian (push) Successful in 16m21s
ci / upload-to-s3 (push) Has been skipped
ci / publish-to-aur (push) Has been skipped
ci / build-app-macos (push) Has been skipped
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> |
||
|---|---|---|
| .forgejo | ||
| .vscode | ||
| case | ||
| docs | ||
| external | ||
| fastlane | ||
| packaging/aur | ||
| pcb | ||
| software | ||
| .gitignore | ||
| .gitmodules | ||
| Gemfile | ||
| kodus-config.yml | ||
| LICENSE | ||
| Readme.md | ||
| renovate.json | ||
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.
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/*.htmland/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: https://play.google.com/store/apps/details?id=de.jonasled.sfp_tool
- Windows: https://s3.jonasled.de/sfp-tool/windows/x86_64/ (
sfp-tool_<version>_x64-setup.exe) - Linux ( currently only debian ): https://s3.jonasled.de/sfp-tool/linux/x86_64/ (
sfp-tool_<version>_amd64.deb, AppImage also available) - macOS (Apple Silicon and Intel, universal): https://s3.jonasled.de/sfp-tool/macos/universal/sfp-tool.app.tar.gz (extract and move
sfp-tool.appinto/Applications) - Arch Linux: AUR packages
sfptool(source build forx86_64andaarch64) andsfptool-bin(prebuiltx86_64package): https://aur.archlinux.org/packages/sfptool and https://aur.archlinux.org/packages/sfptool-bin
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/
