From d00c675613a88904a0eaf98a897d89b100aa499f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=EA=B0=95=EB=B3=91=EA=B4=80?= <67137431+kangbyounggwan@users.noreply.github.com> Date: Thu, 13 Nov 2025 13:56:43 +0900 Subject: [PATCH 1/6] Create factor_mqtt.md --- _plugins/factor_mqtt.md | 153 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 153 insertions(+) create mode 100644 _plugins/factor_mqtt.md diff --git a/_plugins/factor_mqtt.md b/_plugins/factor_mqtt.md new file mode 100644 index 00000000000..a36d6430123 --- /dev/null +++ b/_plugins/factor_mqtt.md @@ -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** From ae3b12561cbc44585d29bf44e3479acd18c833ad Mon Sep 17 00:00:00 2001 From: kbg Date: Mon, 17 Nov 2025 12:52:21 +0900 Subject: [PATCH 2/6] refactor: rename plugin ID and update metadata MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Changes based on maintainer review feedback: Plugin ID Changes: - ID: factor_mqtt → octoprint_factor - Filename: factor_mqtt.md → octoprint_factor.md Metadata Updates: - Added cloud service attributes (cloud, commercial, free-tier) - Added privacy policy link (https://factor.io.kr/privacy) - Fixed release date to 2024-11-17 These changes resolve naming conflicts with the existing MQTT plugin and comply with OctoPrint plugin repository requirements. --- .../{factor_mqtt.md => octoprint_factor.md} | 23 ++++++++++++------- 1 file changed, 15 insertions(+), 8 deletions(-) rename _plugins/{factor_mqtt.md => octoprint_factor.md} (92%) diff --git a/_plugins/factor_mqtt.md b/_plugins/octoprint_factor.md similarity index 92% rename from _plugins/factor_mqtt.md rename to _plugins/octoprint_factor.md index a36d6430123..d255dd74f54 100644 --- a/_plugins/factor_mqtt.md +++ b/_plugins/octoprint_factor.md @@ -1,19 +1,26 @@ --- layout: plugin -id: factor_mqtt +id: octoprint_factor 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 +date: 2024-11-17 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 +privacypolicy: https://factor.io.kr/privacy + +attributes: +- cloud +- commercial +- free-tier + tags: - remote access - monitoring @@ -54,33 +61,33 @@ Remote monitoring and control for OctoPrint via MQTT, featuring instant QR code ## Features -### **Setup** +### 🚀 **20-Second Setup** - Scan QR code with your mobile device - Complete registration on FACTOR web dashboard - Start monitoring immediately - no complex configuration needed -### **Remote Access Anywhere** +### 📱 **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** +### 📹 **Camera Streaming** - Full framerate webcam streaming - Multiple format support (MJPEG, WebRTC, RTSP, HLS) - Real-time monitoring of your prints -### **Instant Notifications** +### 🔔 **Instant Notifications** - Print completion alerts - Error notifications - Real-time status updates - Multiple notification channels (Push, Telegram, Discord, Email) -### **Multilingual Support** +### 🌐 **Multilingual Support** - English and Korean (한국어) built-in - Automatic language detection - Easy to add more languages -### **Modern UI** +### 🎨 **Modern UI** - Clean, intuitive interface - Follows OctoPrint design standards - Responsive design for all screen sizes From 63570bc2a8e4fb4c61fbd29ea2aad6dbcb358214 Mon Sep 17 00:00:00 2001 From: kbg Date: Mon, 17 Nov 2025 12:58:51 +0900 Subject: [PATCH 3/6] docs: remove QR code references and screenshots Removed deprecated QR code setup feature references: - Removed QR code from tags - Removed screenshots section (images referenced non-existent files) - Removed featuredimage (logo.png reference) - Updated description to reflect current cloud-based setup - Updated feature list to describe actual setup process - Updated version info to v2.6.2 The plugin no longer includes QR code setup functionality, so all marketing materials and documentation have been updated to reflect the current web-based registration flow. --- _plugins/octoprint_factor.md | 35 ++++++++++++----------------------- 1 file changed, 12 insertions(+), 23 deletions(-) diff --git a/_plugins/octoprint_factor.md b/_plugins/octoprint_factor.md index d255dd74f54..9c9977408c2 100644 --- a/_plugins/octoprint_factor.md +++ b/_plugins/octoprint_factor.md @@ -3,7 +3,7 @@ layout: plugin id: octoprint_factor 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. +description: Remote monitoring and control for OctoPrint. Access your 3D printer from anywhere with real-time monitoring, camera streaming, and instant notifications via cloud connection. authors: - FACTOR Team license: AGPLv3 @@ -26,21 +26,10 @@ tags: - 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 @@ -57,14 +46,14 @@ compatibility: # FACTOR Plugin -Remote monitoring and control for OctoPrint via MQTT, featuring instant QR code setup. +Remote monitoring and control for OctoPrint via cloud-based MQTT connection. ## Features -### 🚀 **20-Second Setup** -- Scan QR code with your mobile device -- Complete registration on FACTOR web dashboard -- Start monitoring immediately - no complex configuration needed +### 🚀 **Easy Setup** +- Simple web-based registration +- Automatic MQTT connection configuration +- Start monitoring immediately - no complex broker setup needed ### 📱 **Remote Access Anywhere** - Access your full OctoPrint portal from desktop, laptop, tablet, or phone @@ -147,13 +136,13 @@ That's it! No MQTT broker configuration, no complex settings - just scan and go! - No credentials stored locally - AGPLv3 licensed - fully open source -## What's New in v2.0.0 +## What's New in v2.6.2 -- ✨ **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 +- 🔒 **Secure MQTT Connection** - TLS/SSL encryption enabled by default +- 🌐 **Cloud Integration** - Pre-configured broker connection to FACTOR cloud +- 🔧 **Simplified Setup** - No manual MQTT broker configuration needed +- 📱 **Multi-language Support** - English and Korean interfaces +- 🎨 **Clean Modern UI** - Intuitive settings and monitoring interface --- From 3413feb8fe3c8f0c9bafb72d534d4e7666795bb1 Mon Sep 17 00:00:00 2001 From: kbg Date: Mon, 17 Nov 2025 13:19:24 +0900 Subject: [PATCH 4/6] Update FACTOR plugin to v2.6.3 - Translated all Korean logging statements to English - Improved code readability for international users - Updated What's New section to highlight English logging feature --- _plugins/octoprint_factor.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/_plugins/octoprint_factor.md b/_plugins/octoprint_factor.md index 9c9977408c2..dd5e1346b7a 100644 --- a/_plugins/octoprint_factor.md +++ b/_plugins/octoprint_factor.md @@ -136,8 +136,9 @@ That's it! No MQTT broker configuration, no complex settings - just scan and go! - No credentials stored locally - AGPLv3 licensed - fully open source -## What's New in v2.6.2 +## What's New in v2.6.3 +- 🌍 **English Logging** - All logging statements now in English for international users - 🔒 **Secure MQTT Connection** - TLS/SSL encryption enabled by default - 🌐 **Cloud Integration** - Pre-configured broker connection to FACTOR cloud - 🔧 **Simplified Setup** - No manual MQTT broker configuration needed From 0e80adc0ad658ff1a9b26c2767591b212849003d Mon Sep 17 00:00:00 2001 From: kbg Date: Tue, 18 Nov 2025 07:04:48 +0900 Subject: [PATCH 5/6] docs: update date and replace changelog with key features - Update date to 2025-11-18 - Replace version-specific 'What's New in v2.6.3' with 'Key Features' - Address review feedback: avoid requiring PR for every release - Focus on high-level overview of main functionality --- _plugins/octoprint_factor.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/_plugins/octoprint_factor.md b/_plugins/octoprint_factor.md index dd5e1346b7a..56ba5af1043 100644 --- a/_plugins/octoprint_factor.md +++ b/_plugins/octoprint_factor.md @@ -8,7 +8,7 @@ authors: - FACTOR Team license: AGPLv3 -date: 2024-11-17 +date: 2025-11-18 homepage: https://github.com/kangbyounggwan/octoprint-factor-plugin source: https://github.com/kangbyounggwan/octoprint-factor-plugin @@ -129,6 +129,15 @@ That's it! No MQTT broker configuration, no complex settings - just scan and go! - **GitHub Issues**: [Report a bug](https://github.com/kangbyounggwan/octoprint-factor-plugin/issues) - **Documentation**: [GitHub README](https://github.com/kangbyounggwan/octoprint-factor-plugin) +## Key Features + +- 🔒 **Secure Connection** - TLS/SSL encryption enabled by default for all MQTT communications +- 🌐 **Cloud Integration** - Pre-configured broker connection to FACTOR cloud service +- 📱 **Multi-language Support** - English and Korean user interfaces +- 🎥 **Camera Streaming** - WebRTC-based real-time camera streaming via MediaMTX +- 🔧 **Easy Setup** - Simple wizard-based configuration with no manual broker setup needed +- 🌍 **Remote Access** - Access your OctoPrint instance from anywhere securely + ## Privacy & Security - All connections are encrypted via TLS/SSL @@ -136,15 +145,6 @@ That's it! No MQTT broker configuration, no complex settings - just scan and go! - No credentials stored locally - AGPLv3 licensed - fully open source -## What's New in v2.6.3 - -- 🌍 **English Logging** - All logging statements now in English for international users -- 🔒 **Secure MQTT Connection** - TLS/SSL encryption enabled by default -- 🌐 **Cloud Integration** - Pre-configured broker connection to FACTOR cloud -- 🔧 **Simplified Setup** - No manual MQTT broker configuration needed -- 📱 **Multi-language Support** - English and Korean interfaces -- 🎨 **Clean Modern UI** - Intuitive settings and monitoring interface - --- **Made with ❤️ by FACTOR Team** From d0e3cfb5ae27dadea33983ab902212380b5d84b9 Mon Sep 17 00:00:00 2001 From: kbg Date: Thu, 20 Nov 2025 22:43:46 +0900 Subject: [PATCH 6/6] Update FACTOR Plugin: Remove QR code references and update date --- _plugins/octoprint_factor.md | 16 ++++------------ 1 file changed, 4 insertions(+), 12 deletions(-) diff --git a/_plugins/octoprint_factor.md b/_plugins/octoprint_factor.md index 56ba5af1043..9ede3f098e6 100644 --- a/_plugins/octoprint_factor.md +++ b/_plugins/octoprint_factor.md @@ -8,7 +8,7 @@ authors: - FACTOR Team license: AGPLv3 -date: 2025-11-18 +date: 2025-11-20 homepage: https://github.com/kangbyounggwan/octoprint-factor-plugin source: https://github.com/kangbyounggwan/octoprint-factor-plugin @@ -110,11 +110,11 @@ pip install https://github.com/kangbyounggwan/octoprint-factor-plugin/archive/ma 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) +1. **Open Setup Page**: Click the button to open the FACTOR web dashboard +2. **Web Registration**: Complete device registration 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! 🎉 +That's it! No MQTT broker configuration, no complex settings - just click and go! 🎉 ## Requirements @@ -129,14 +129,6 @@ That's it! No MQTT broker configuration, no complex settings - just scan and go! - **GitHub Issues**: [Report a bug](https://github.com/kangbyounggwan/octoprint-factor-plugin/issues) - **Documentation**: [GitHub README](https://github.com/kangbyounggwan/octoprint-factor-plugin) -## Key Features - -- 🔒 **Secure Connection** - TLS/SSL encryption enabled by default for all MQTT communications -- 🌐 **Cloud Integration** - Pre-configured broker connection to FACTOR cloud service -- 📱 **Multi-language Support** - English and Korean user interfaces -- 🎥 **Camera Streaming** - WebRTC-based real-time camera streaming via MediaMTX -- 🔧 **Easy Setup** - Simple wizard-based configuration with no manual broker setup needed -- 🌍 **Remote Access** - Access your OctoPrint instance from anywhere securely ## Privacy & Security