Skip to content

Commit d00c675

Browse files
kangbyounggwankangbyounggwan
authored
Create factor_mqtt.md
1 parent f6e2d6e commit d00c675

1 file changed

Lines changed: 153 additions & 0 deletions

File tree

‎_plugins/factor_mqtt.md‎

Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
1+
---
2+
layout: plugin
3+
4+
id: factor_mqtt
5+
title: FACTOR Plugin
6+
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.
7+
authors:
8+
- FACTOR Team
9+
license: AGPLv3
10+
11+
date: 2025-01-28
12+
13+
homepage: https://github.com/kangbyounggwan/octoprint-factor-plugin
14+
source: https://github.com/kangbyounggwan/octoprint-factor-plugin
15+
archive: https://github.com/kangbyounggwan/octoprint-factor-plugin/archive/{target_version}.zip
16+
17+
tags:
18+
- remote access
19+
- monitoring
20+
- mqtt
21+
- camera
22+
- qr code
23+
- notifications
24+
- mobile
25+
- cloud
26+
27+
screenshots:
28+
- url: https://raw.githubusercontent.com/kangbyounggwan/octoprint-factor-plugin/main/docs/screenshot-wizard.png
29+
alt: FACTOR Plugin Setup Wizard
30+
caption: Simple 20-second QR code setup wizard
31+
- url: https://raw.githubusercontent.com/kangbyounggwan/octoprint-factor-plugin/main/docs/screenshot-settings.png
32+
alt: FACTOR Plugin Settings
33+
caption: Clean settings interface with multilingual support
34+
35+
featuredimage: https://raw.githubusercontent.com/kangbyounggwan/octoprint-factor-plugin/main/docs/logo.png
36+
37+
compatibility:
38+
octoprint:
39+
- 1.4.0
40+
41+
os:
42+
- linux
43+
- windows
44+
- macos
45+
- freebsd
46+
47+
python: ">=3.8,<4"
48+
49+
---
50+
51+
# FACTOR Plugin
52+
53+
Remote monitoring and control for OctoPrint via MQTT, featuring instant QR code setup.
54+
55+
## Features
56+
57+
### **Setup**
58+
- Scan QR code with your mobile device
59+
- Complete registration on FACTOR web dashboard
60+
- Start monitoring immediately - no complex configuration needed
61+
62+
### **Remote Access Anywhere**
63+
- Access your full OctoPrint portal from desktop, laptop, tablet, or phone
64+
- Works with your favorite OctoPrint mobile apps
65+
- Secure cloud connection via MQTT
66+
67+
### **Camera Streaming**
68+
- Full framerate webcam streaming
69+
- Multiple format support (MJPEG, WebRTC, RTSP, HLS)
70+
- Real-time monitoring of your prints
71+
72+
### **Instant Notifications**
73+
- Print completion alerts
74+
- Error notifications
75+
- Real-time status updates
76+
- Multiple notification channels (Push, Telegram, Discord, Email)
77+
78+
### **Multilingual Support**
79+
- English and Korean (한국어) built-in
80+
- Automatic language detection
81+
- Easy to add more languages
82+
83+
### **Modern UI**
84+
- Clean, intuitive interface
85+
- Follows OctoPrint design standards
86+
- Responsive design for all screen sizes
87+
- Setup wizard for first-time users
88+
89+
## Setup
90+
91+
### From Plugin Manager (Recommended)
92+
93+
1. Open OctoPrint Settings
94+
2. Go to **Plugin Manager**
95+
3. Click **"Get More..."**
96+
4. Search for **"FACTOR"**
97+
5. Click **"Install"**
98+
6. Restart OctoPrint
99+
100+
### From URL
101+
102+
Install manually via this URL:
103+
```
104+
https://github.com/kangbyounggwan/octoprint-factor-plugin/archive/main.zip
105+
```
106+
107+
### From Command Line
108+
109+
```bash
110+
pip install https://github.com/kangbyounggwan/octoprint-factor-plugin/archive/main.zip
111+
```
112+
113+
## Configuration
114+
115+
After installation, the **Setup Wizard** will guide you through configuration:
116+
117+
1. **Scan QR Code**: Use your mobile device to scan the displayed QR code
118+
2. **Web Registration**: Complete device registration on the FACTOR web dashboard at [factor.io.kr](https://factor.io.kr)
119+
3. **Start Monitoring**: Return to OctoPrint and start using FACTOR
120+
121+
That's it! No MQTT broker configuration, no complex settings - just scan and go! 🎉
122+
123+
## Requirements
124+
125+
- OctoPrint 1.4.0 or higher
126+
- Python 3.8 or higher
127+
- Internet connection for cloud features
128+
- FACTOR account (free registration at [factor.io.kr](https://factor.io.kr))
129+
130+
## Support
131+
132+
- **Website**: [https://factor.io.kr](https://factor.io.kr)
133+
- **GitHub Issues**: [Report a bug](https://github.com/kangbyounggwan/octoprint-factor-plugin/issues)
134+
- **Documentation**: [GitHub README](https://github.com/kangbyounggwan/octoprint-factor-plugin)
135+
136+
## Privacy & Security
137+
138+
- All connections are encrypted via TLS/SSL
139+
- Data is transmitted securely via MQTT protocol
140+
- No credentials stored locally
141+
- AGPLv3 licensed - fully open source
142+
143+
## What's New in v2.0.0
144+
145+
- ✨ **QR Code Setup Wizard** - 20-second setup process
146+
- 🌐 **Full Internationalization** - English and Korean support
147+
- 🎨 **Redesigned UI** - Modern, clean interface
148+
- 📱 **Mobile-First Design** - Optimized for all devices
149+
- 🔧 **Simplified Configuration** - No manual MQTT setup needed
150+
151+
---
152+
153+
**Made with ❤️ by FACTOR Team**

0 commit comments

Comments
 (0)