nocci/open4neptune-new
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
open4neptune-new/README.md
root 1c42d7c2b6 Fix: Clarify installation options and warn about copied files 
- README: Add Option A (direct include) as recommended method
- README: Add Option B (copy) with warning about manual updates
- install.sh: Detect direct include vs copied files
- README: Add troubleshooting for 'Error loading template' after update

The root cause: Moonraker updates the repo, but copied files in
~/printer_data/config/calibration/ don't get updated automatically.

Solution: Use direct include [include open4neptune-new/calibration/*.cfg]
so files are always loaded from the repo.
2026-03-13 11:00:43 +00:00

301 lines
7.6 KiB
Markdown
Raw Permalink Blame History

# 🎯 Neptune 4 Plus - Open4Neptune Configs
Complete Klipper configuration for Elegoo Neptune 4 Plus with Cartographer 3D, optimized for both Original and Bambu Lab hotends.
---
## 🚀 Quick Start
### 1. Clone Repository
```bash
cd ~/printer_data/config
git clone https://git.sky-net.it/nocci/open4neptune-new.git
```
### 2. Install Update Manager (Optional but Recommended!)
Add to your `moonraker.conf`:
```ini
[include open4neptune-new/moonraker/update_manager.cfg]
```
Restart Moonraker, then update directly from Mainsail/Fluidd UI! 🎉
### 3. Install Configs
**⚠️ IMPORTANT: Choose ONE option!**
#### Option A: Direct Include (Recommended!) ✅
Files stay in repo, auto-update via Moonraker:
```ini
# Add to moonraker.conf or printer.cfg:
[include open4neptune-new/calibration/*.cfg]
[include open4neptune-new/user_settings_clean.cfg]
```
**Advantage:** Updates automatically via Moonraker UI!
#### Option B: Copy Files (Legacy)
Files copied to config folder, manual updates:
```bash
# Copy calibration macros
cp -r open4neptune-new/calibration/ ~/printer_data/config/
# Copy user settings (choose one):
cp open4neptune-new/user_settings_clean.cfg ~/printer_data/config/user_settings.cfg
```
**⚠️ Warning:** These copies won't auto-update! You must re-run the copy command after each update, or switch to Option A.
### 4. Restart Klipper
**Mainsail/Fluidd:** Machine → Restart Firmware
---
## ✨ Features
### 🔧 PRINT_START Macro
- ✅ Cartographer Z0 calibration
- ✅ Automatic bed mesh (adaptive)
- ✅ Nozzle cleaning (KNCM)
- ✅ Precise temperature control (±2°C)
- ✅ Smart homing (CG28)
### 🎯 PRINT_END Macro
- ✅ Detailed user feedback
- ✅ Auto park position
- ✅ Disable motors & sensors
- ✅ Completion jingle (END_TUNE)
### 📊 Calibration Suite
- `CALIBRATE_Z_OFFSET` - Cartographer Z0
- `CALIBRATE_INPUT_SHAPER` - ADXL resonance
- `CALIBRATE_PRESSURE_ADVANCE` - PA tuning
- `CALIBRATE_FLOW_RATE` - Flow calibration
- `CALIBRATE_TEMPERATURE` - Temp tower
- `CALIBRATE_RETRACTION` - Retraction test
- `CALIBRATE_BED_MESH` - Bed mesh
- `CALIBRATION_FULL` - Complete suite (~2.5h)
- `CALIBRATION_QUICK` - Essential only (~30min)
### 🎨 Orca Slicer Profiles
- ✅ 10 profiles for both hotends
- ✅ PLA, PETG, ABS, TPU, Carbon Fiber
- ✅ Optimized for 15 mm³/s (Original) & 23 mm³/s (Bambu)
---
## 📁 Repository Structure
```
open4neptune-new/
├── moonraker/
│ ├── update_manager.cfg # Moonraker Update Manager config
│ └── README.md # Setup instructions
├── calibration/
│ ├── CALIBRATION_GUIDE.md # Step-by-step guide
│ ├── calibration_macros.cfg # All calibration macros
│ └── test_patterns.cfg # Printable test patterns
├── orca-profiles/
│ ├── Neptune4Plus-Original/ # 15 mm³/s hotend
│ ├── Neptune4Plus-Bambu/ # 23 mm³/s hotend
│ └── README.md # Profile documentation
├── user_settings_clean.cfg # Production-ready config
├── user_settings_optimized.cfg # Verbose config (with comments)
├── install.sh # Install/update script
├── CHANGES.md # Change log
├── CLEANUP_NOTES.md # Cleanup documentation
└── README.md # This file
```
---
## 🔧 Installation Options
### Option A: Moonraker Update Manager (Recommended!)
**One-time setup:**
```bash
# 1. Clone repo
cd ~/printer_data/config
git clone https://git.sky-net.it/nocci/open4neptune-new.git
# 2. Add to moonraker.conf
echo "[include open4neptune-new/moonraker/update_manager.cfg]" >> ~/printer_data/config/moonraker.conf
# 3. Make install script executable
chmod +x ~/printer_data/config/open4neptune-new/install.sh
# 4. Restart Moonraker
sudo systemctl restart moonraker
```
**Then:** Machine → Update Manager → "open4neptune-configs" → Update
### Option B: Manual Installation
```bash
cd ~/printer_data/config
git clone https://git.sky-net.it/nocci/open4neptune-new.git
cp -r open4neptune-new/calibration/ ~/printer_data/config/
cp open4neptune-new/user_settings_clean.cfg ~/printer_data/config/user_settings.cfg
# Restart Klipper
```
---
## 🎯 Usage
### In Slicer (Orca/PrusaSlicer/Cura):
**Start Gcode:**
```gcode
PRINT_START EXTRUDER_TEMP=[nozzle_temperature] BED_TEMP=[bed_temperature] FILAMENT_TYPE=PLA
```
**End Gcode:**
```gcode
PRINT_END
```
### In Mainsail/Fluidd Console:
```gcode
; Show calibration menu
CALIBRATION_MENU
; Quick Z measurement
QUICK_TOUCH
; Babysteps during print
BABYZ_PLUS ; Z +0.005mm
BABYZ_MINUS ; Z -0.005mm
```
---
## 📊 Orca Profile Installation
1. Open Orca Slicer
2. File → Import → Import Config(s)...
3. Select profiles from `orca-profiles/` folder
4. Choose profile based on your hotend:
- **Original:** `Neptune4Plus-Original/*`
- **Bambu:** `Neptune4Plus-Bambu/*`
---
## 🔍 Troubleshooting
### Calibration Macros Not Found
```bash
# Check if calibration folder exists
ls ~/printer_data/config/calibration/
# Check if included in printer.cfg
grep "calibration" ~/printer_data/config/printer.cfg
```
### ⚠️ Error After Update: "Error loading template"
If you get template errors after updating via Moonraker, you likely have **copied files** that weren't updated:
```bash
# Check for duplicate files
find ~/printer_data -name "test_patterns.cfg"
# If you see multiple files, remove the old copy:
rm ~/printer_data/config/calibration/test_patterns.cfg
# Or switch to direct include (recommended):
# Add to moonraker.conf: [include open4neptune-new/calibration/*.cfg]
# Then remove the copied calibration/ folder
```
### Update Manager Not Showing
```bash
# Check moonraker.conf
grep "open4neptune" ~/printer_data/config/moonraker.conf
# Restart Moonraker
sudo systemctl restart moonraker
# Check logs
journalctl -u moonraker -f
```
### PRINT_START Not Working
```gcode
; Test in console
PRINT_START EXTRUDER_TEMP=200 BED_TEMP=60
; Check for errors in Klipper console
```
---
## 📖 Documentation
- **CALIBRATION_GUIDE.md** - Complete calibration instructions
- **moonraker/README.md** - Update Manager setup
- **orca-profiles/README.md** - Orca profile guide
- **CHANGES.md** - Recent changes
- **CLEANUP_NOTES.md** - Cleanup documentation
---
## 🎉 Features at a Glance
| Feature | Status | Description |
|---------|--------|-------------|
| PRINT_START | ✅ | Cartographer Z0, bed mesh, nozzle clean |
| PRINT_END | ✅ | Auto park, motors off, completion jingle |
| Calibration Suite | ✅ | 7 calibration macros + test patterns |
| Moonraker Update | ✅ | One-click updates from Mainsail UI |
| Orca Profiles | ✅ | 10 profiles for 2 hotends |
| KNCM Integration | ✅ | Nozzle cleaning macros |
| Helper Macros | ✅ | QUICK_TOUCH, BABYZ_±, CALIBRATE_PROBE |
---
## 🚨 Important Notes
⚠️ **Always backup before updates:**
```bash
cp ~/printer_data/config/user_settings.cfg ~/printer_data/config/user_settings.cfg.backup-$(date +%Y%m%d)
```
⚠️ **After installing:**
1. Run `CALIBRATION_QUICK` for essential calibrations
2. Test with a simple print
3. Fine-tune Pressure Advance for your filament
⚠️ **Carbon Fiber Filament:**
- Use **ONLY** with Bambu Lab hotend (steel nozzle)
- Will destroy brass nozzle!
---
## 📞 Support
- **Repo:** https://git.sky-net.it/nocci/open4neptune-new
- **Open4Neptune:** https://github.com/OpenNeptune3D/OpenNept4une
- **Klipper:** https://www.klipper3d.org/
- **Cartographer:** https://cartographer3d.com/
---
**Created:** 2026-03-12
**Printer:** Elegoo Neptune 4 Plus
**Probe:** Cartographer 3D
**Firmware:** Open4Neptune + Klipper
**Hotends:** Original (15 mm³/s) + Bambu Lab (23 mm³/s)
Reference in a new issue View git blame Copy permalink