-
Notifications
You must be signed in to change notification settings - Fork 347
Add FACTOR Plugin #1401
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.
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
Closed
Closed
Add FACTOR Plugin #1401
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
d00c675
Create factor_mqtt.md
kangbyounggwan 5ff705f
Merge branch 'OctoPrint:gh-pages' into gh-pages
kangbyounggwan ae3b125
refactor: rename plugin ID and update metadata
kangbyounggwan cf42108
Merge branch 'gh-pages' of https://github.com/kangbyounggwan/plugins.…
kangbyounggwan 63570bc
docs: remove QR code references and screenshots
kangbyounggwan 3413feb
Update FACTOR plugin to v2.6.3
kangbyounggwan 0e80adc
docs: update date and replace changelog with key features
kangbyounggwan d0e3cfb
Update FACTOR Plugin: Remove QR code references and update date
kangbyounggwan File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,153 @@ | ||
| --- | ||
| layout: plugin | ||
|
|
||
| id: factor_mqtt | ||
| title: FACTOR Plugin | ||
| description: Remote monitoring and control for OctoPrint via QR code setup. Access your 3D printer from anywhere with real-time monitoring, camera streaming, and instant notifications. | ||
| authors: | ||
| - FACTOR Team | ||
| license: AGPLv3 | ||
|
|
||
| date: 2025-01-28 | ||
|
|
||
| homepage: https://github.com/kangbyounggwan/octoprint-factor-plugin | ||
| source: https://github.com/kangbyounggwan/octoprint-factor-plugin | ||
| archive: https://github.com/kangbyounggwan/octoprint-factor-plugin/archive/{target_version}.zip | ||
|
|
||
| tags: | ||
| - remote access | ||
| - monitoring | ||
| - mqtt | ||
| - camera | ||
| - qr code | ||
| - notifications | ||
| - mobile | ||
| - cloud | ||
|
|
||
| screenshots: | ||
| - url: https://raw.githubusercontent.com/kangbyounggwan/octoprint-factor-plugin/main/docs/screenshot-wizard.png | ||
| alt: FACTOR Plugin Setup Wizard | ||
| caption: Simple 20-second QR code setup wizard | ||
| - url: https://raw.githubusercontent.com/kangbyounggwan/octoprint-factor-plugin/main/docs/screenshot-settings.png | ||
| alt: FACTOR Plugin Settings | ||
| caption: Clean settings interface with multilingual support | ||
|
|
||
| featuredimage: https://raw.githubusercontent.com/kangbyounggwan/octoprint-factor-plugin/main/docs/logo.png | ||
|
|
||
| compatibility: | ||
| octoprint: | ||
| - 1.4.0 | ||
|
|
||
| os: | ||
| - linux | ||
| - windows | ||
| - macos | ||
| - freebsd | ||
|
|
||
| python: ">=3.8,<4" | ||
|
|
||
| --- | ||
|
|
||
| # FACTOR Plugin | ||
|
|
||
| Remote monitoring and control for OctoPrint via MQTT, featuring instant QR code setup. | ||
|
|
||
| ## Features | ||
|
|
||
| ### **Setup** | ||
| - Scan QR code with your mobile device | ||
| - Complete registration on FACTOR web dashboard | ||
| - Start monitoring immediately - no complex configuration needed | ||
|
|
||
| ### **Remote Access Anywhere** | ||
| - Access your full OctoPrint portal from desktop, laptop, tablet, or phone | ||
| - Works with your favorite OctoPrint mobile apps | ||
| - Secure cloud connection via MQTT | ||
|
|
||
| ### **Camera Streaming** | ||
| - Full framerate webcam streaming | ||
| - Multiple format support (MJPEG, WebRTC, RTSP, HLS) | ||
| - Real-time monitoring of your prints | ||
|
|
||
| ### **Instant Notifications** | ||
| - Print completion alerts | ||
| - Error notifications | ||
| - Real-time status updates | ||
| - Multiple notification channels (Push, Telegram, Discord, Email) | ||
|
|
||
| ### **Multilingual Support** | ||
| - English and Korean (한국어) built-in | ||
| - Automatic language detection | ||
| - Easy to add more languages | ||
|
|
||
| ### **Modern UI** | ||
| - Clean, intuitive interface | ||
| - Follows OctoPrint design standards | ||
| - Responsive design for all screen sizes | ||
| - Setup wizard for first-time users | ||
|
|
||
| ## Setup | ||
|
|
||
| ### From Plugin Manager (Recommended) | ||
|
|
||
| 1. Open OctoPrint Settings | ||
| 2. Go to **Plugin Manager** | ||
| 3. Click **"Get More..."** | ||
| 4. Search for **"FACTOR"** | ||
| 5. Click **"Install"** | ||
| 6. Restart OctoPrint | ||
|
|
||
| ### From URL | ||
|
|
||
| Install manually via this URL: | ||
| ``` | ||
| https://github.com/kangbyounggwan/octoprint-factor-plugin/archive/main.zip | ||
| ``` | ||
|
|
||
| ### From Command Line | ||
|
|
||
| ```bash | ||
| pip install https://github.com/kangbyounggwan/octoprint-factor-plugin/archive/main.zip | ||
| ``` | ||
|
|
||
| ## Configuration | ||
|
|
||
| After installation, the **Setup Wizard** will guide you through configuration: | ||
|
|
||
| 1. **Scan QR Code**: Use your mobile device to scan the displayed QR code | ||
| 2. **Web Registration**: Complete device registration on the FACTOR web dashboard at [factor.io.kr](https://factor.io.kr) | ||
| 3. **Start Monitoring**: Return to OctoPrint and start using FACTOR | ||
|
|
||
| That's it! No MQTT broker configuration, no complex settings - just scan and go! 🎉 | ||
|
|
||
| ## Requirements | ||
|
|
||
| - OctoPrint 1.4.0 or higher | ||
| - Python 3.8 or higher | ||
| - Internet connection for cloud features | ||
| - FACTOR account (free registration at [factor.io.kr](https://factor.io.kr)) | ||
|
|
||
| ## Support | ||
|
|
||
| - **Website**: [https://factor.io.kr](https://factor.io.kr) | ||
| - **GitHub Issues**: [Report a bug](https://github.com/kangbyounggwan/octoprint-factor-plugin/issues) | ||
| - **Documentation**: [GitHub README](https://github.com/kangbyounggwan/octoprint-factor-plugin) | ||
|
|
||
| ## Privacy & Security | ||
|
|
||
| - All connections are encrypted via TLS/SSL | ||
| - Data is transmitted securely via MQTT protocol | ||
| - No credentials stored locally | ||
| - AGPLv3 licensed - fully open source | ||
|
|
||
| ## What's New in v2.0.0 | ||
|
|
||
| - ✨ **QR Code Setup Wizard** - 20-second setup process | ||
| - 🌐 **Full Internationalization** - English and Korean support | ||
| - 🎨 **Redesigned UI** - Modern, clean interface | ||
| - 📱 **Mobile-First Design** - Optimized for all devices | ||
| - 🔧 **Simplified Configuration** - No manual MQTT setup needed | ||
|
|
||
| --- | ||
|
|
||
| **Made with ❤️ by FACTOR Team** | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.