Octoprint

OctoPrint 3D Printer Management

A comprehensive skill for managing OctoPrint on Raspberry Pi connected to Creality Ender 3D printers. Supports full print lifecycle management, monitoring, timelapse creation, bed leveling visualization, and system maintenance.

Session Configuration

CRITICAL: Connection Setup

When the user first requests an OctoPrint operation, collect the necessary connection details:

I need OctoPrint connection details. Please provide:

**Required for API Access:**
1. **OctoPrint URL**: (e.g., http://192.168.1.100 or http://octopi.local)
2. **API Key**: (Found in OctoPrint Settings > API > Global API Key)

**Optional for SSH/Pi Maintenance:**
3. **SSH Access**: user@host (default: pi@octopi.local)
4. **SSH Auth**: SSH Key (recommended) or password

Example response:
- URL: http://192.168.1.50
- API Key: ABCDEF123456789...
- SSH: pi@192.168.1.50 (key auth)

After receiving details:

• Store them in working memory for the session
• Use for ALL subsequent OctoPrint operations without re-prompting
• NEVER write API keys or credentials to files or logs

Printer Profiles - Creality Ender 3 Series

Default OctoPrint Settings for Ender 3 V2:

• Origin: Lower Left
• Heated Bed: Yes
• Heated Chamber: No
• Default Baudrate: 115200
• Print Volume: X=220, Y=220, Z=250

Quick Reference

REST API Base

Base URL: http://<OCTOPRINT_HOST>/api/
Auth Header: X-Api-Key: <API_KEY>
Content-Type: application/json

Common Endpoints

Connection Management

Check Connection Status

curl -s "http://OCTOPRINT_HOST/api/connection" \
  -H "X-Api-Key: API_KEY" | jq '.'

Response includes:

• current.state: Operational, Printing, Paused, Closed, Error
• current.port: /dev/ttyUSB0, /dev/ttyACM0, etc.
• current.baudrate: 115200 (typical for Ender 3)
• options: Available ports, baudrates, profiles

Connect to Printer

curl -X POST "http://OCTOPRINT_HOST/api/connection" \
  -H "X-Api-Key: API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"command": "connect", "port": "/dev/ttyUSB0", "baudrate": 115200}'

Disconnect Printer

curl -X POST "http://OCTOPRINT_HOST/api/connection" \
  -H "X-Api-Key: API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"command": "disconnect"}'

Auto-Connect (Use Saved Settings)

curl -X POST "http://OCTOPRINT_HOST/api/connection" \
  -H "X-Api-Key: API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"command": "connect"}'

Print Job Management

Get Current Job Status

curl -s "http://OCTOPRINT_HOST/api/job" \
  -H "X-Api-Key: API_KEY" | jq '.'

Response includes:

• state: Printing, Paused, Operational, etc.
• job.file.name: Current file name
• progress.completion: Percentage (0-100)
• progress.printTime: Elapsed seconds
• progress.printTimeLeft: Remaining seconds

Start Print

# Select and start a file
curl -X POST "http://OCTOPRINT_HOST/api/files/local/myfile.gcode" \
  -H "X-Api-Key: API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"command": "select", "print": true}'

Pause Print

curl -X POST "http://OCTOPRINT_HOST/api/job" \
  -H "X-Api-Key: API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"command": "pause", "action": "pause"}'

Resume Print

curl -X POST "http://OCTOPRINT_HOST/api/job" \
  -H "X-Api-Key: API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"command": "pause", "action": "resume"}'

Cancel Print

curl -X POST "http://OCTOPRINT_HOST/api/job" \
  -H "X-Api-Key: API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"command": "cancel"}'

Temperature Control

Get Current Temperatures

# All temperatures
curl -s "http://OCTOPRINT_HOST/api/printer" \
  -H "X-Api-Key: API_KEY" | jq '.temperature'

# Tool (hotend) only
curl -s "http://OCTOPRINT_HOST/api/printer/tool" \
  -H "X-Api-Key: API_KEY" | jq '.'

# Bed only
curl -s "http://OCTOPRINT_HOST/api/printer/bed" \
  -H "X-Api-Key: API_KEY" | jq '.'

Set Hotend Temperature

# Heat to 200°C (PLA)
curl -X POST "http://OCTOPRINT_HOST/api/printer/tool" \
  -H "X-Api-Key: API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"command": "target", "targets": {"tool0": 200}}'

# Cool down (set to 0)
curl -X POST "http://OCTOPRINT_HOST/api/printer/tool" \
  -H "X-Api-Key: API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"command": "target", "targets": {"tool0": 0}}'

Set Bed Temperature

# Heat bed to 60°C (PLA)
curl -X POST "http://OCTOPRINT_HOST/api/printer/bed" \
  -H "X-Api-Key: API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"command": "target", "target": 60}'

# Cool down bed
curl -X POST "http://OCTOPRINT_HOST/api/printer/bed" \
  -H "X-Api-Key: API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"command": "target", "target": 0}'

Common Temperature Presets

File Management

List Files

# All files
curl -s "http://OCTOPRINT_HOST/api/files" \
  -H "X-Api-Key: API_KEY" | jq '.files[].name'

# With details
curl -s "http://OCTOPRINT_HOST/api/files?recursive=true" \
  -H "X-Api-Key: API_KEY" | jq '.'

Upload File

# Upload G-code file
curl -X POST "http://OCTOPRINT_HOST/api/files/local" \
  -H "X-Api-Key: API_KEY" \
  -F "file=@/path/to/file.gcode"

# Upload and start printing immediately
curl -X POST "http://OCTOPRINT_HOST/api/files/local" \
  -H "X-Api-Key: API_KEY" \
  -F "file=@/path/to/file.gcode" \
  -F "print=true"

# Upload to specific folder
curl -X POST "http://OCTOPRINT_HOST/api/files/local" \
  -H "X-Api-Key: API_KEY" \
  -F "file=@/path/to/file.gcode" \
  -F "path=myfolder"

Delete File

curl -X DELETE "http://OCTOPRINT_HOST/api/files/local/filename.gcode" \
  -H "X-Api-Key: API_KEY"

Get File Info

curl -s "http://OCTOPRINT_HOST/api/files/local/filename.gcode" \
  -H "X-Api-Key: API_KEY" | jq '.'

Print Head & Axis Control

Home Axes

# Home all axes
curl -X POST "http://OCTOPRINT_HOST/api/printer/printhead" \
  -H "X-Api-Key: API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"command": "home", "axes": ["x", "y", "z"]}'

# Home X and Y only
curl -X POST "http://OCTOPRINT_HOST/api/printer/printhead" \
  -H "X-Api-Key: API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"command": "home", "axes": ["x", "y"]}'

Jog Print Head

# Move X +10mm
curl -X POST "http://OCTOPRINT_HOST/api/printer/printhead" \
  -H "X-Api-Key: API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"command": "jog", "x": 10}'

# Move Y -20mm, Z +5mm
curl -X POST "http://OCTOPRINT_HOST/api/printer/printhead" \
  -H "X-Api-Key: API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"command": "jog", "y": -20, "z": 5}'

# Move with specific feedrate (mm/min)
curl -X POST "http://OCTOPRINT_HOST/api/printer/printhead" \
  -H "X-Api-Key: API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"command": "jog", "x": 10, "speed": 3000}'

Extrude/Retract Filament

# Extrude 10mm
curl -X POST "http://OCTOPRINT_HOST/api/printer/tool" \
  -H "X-Api-Key: API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"command": "extrude", "amount": 10}'

# Retract 5mm (negative value)
curl -X POST "http://OCTOPRINT_HOST/api/printer/tool" \
  -H "X-Api-Key: API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"command": "extrude", "amount": -5}'

G-code Commands

Send Single Command

curl -X POST "http://OCTOPRINT_HOST/api/printer/command" \
  -H "X-Api-Key: API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"command": "G28"}'

Send Multiple Commands

curl -X POST "http://OCTOPRINT_HOST/api/printer/command" \
  -H "X-Api-Key: API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"commands": ["G28", "G1 Z10 F300", "M104 S200"]}'

Common G-code Commands for Ender 3

Bed Leveling (with Bed Level Visualizer Plugin)

Trigger Bed Mesh Probe

# Run auto bed level probe (G29)
curl -X POST "http://OCTOPRINT_HOST/api/printer/command" \
  -H "X-Api-Key: API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"command": "G29"}'

View Current Mesh (via G-code)

# Report mesh values
curl -X POST "http://OCTOPRINT_HOST/api/printer/command" \
  -H "X-Api-Key: API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"command": "M420 V"}'

Plugin API (Bed Level Visualizer)

# Trigger mesh update (plugin-specific)
curl -X POST "http://OCTOPRINT_HOST/api/plugin/bedlevelvisualizer" \
  -H "X-Api-Key: API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"command": "mesh"}'

Manual Bed Leveling Procedure

For printers without auto bed leveling:

1. Preheat bed to printing temperature (60°C for PLA)
2. Home all axes: G28
3. Move to corners and adjust:
   • Front Left: G1 X30 Y30 F3000
   • Front Right: G1 X190 Y30 F3000
   • Back Right: G1 X190 Y190 F3000
   • Back Left: G1 X30 Y190 F3000
   • Center: G1 X110 Y110 F3000
4. Paper test: Adjust knobs for slight friction
5. Repeat until consistent

Timelapse (Octolapse Plugin)

Octolapse API Endpoints

# Get Octolapse status
curl -s "http://OCTOPRINT_HOST/plugin/octolapse/status" \
  -H "X-Api-Key: API_KEY" | jq '.'

# Get available profiles
curl -s "http://OCTOPRINT_HOST/plugin/octolapse/settings" \
  -H "X-Api-Key: API_KEY" | jq '.'

Octolapse Configuration Tips

Recommended settings for Ender 3 V2:

1. Printer Profile: Select "Creality Ender 3" or create custom
2. Stabilization:
   • Type: "Smart - Layer Change Only"
   • Position: Back-left corner (X=0, Y=220)
3. Snapshot Trigger:
   • Layer change (smoothest results)
   • Timer-based for quick prints
4. Camera Settings:
   • USB webcam: Use mjpg-streamer
   • Pi Camera: Use raspistill or libcamera

Octolapse Start/Stop via API

# Check if Octolapse is active
curl -s "http://OCTOPRINT_HOST/plugin/octolapse/status" \
  -H "X-Api-Key: API_KEY" | jq '.is_timelapse_active'

Download Timelapses

# List completed timelapses
curl -s "http://OCTOPRINT_HOST/api/timelapse" \
  -H "X-Api-Key: API_KEY" | jq '.files[].name'

# Download specific timelapse
curl -O "http://OCTOPRINT_HOST/downloads/timelapse/filename.mp4" \
  -H "X-Api-Key: API_KEY"

Webcam & Monitoring

Webcam Stream URLs

# MJPG Stream (default)
http://OCTOPRINT_HOST/webcam/?action=stream

# Snapshot
http://OCTOPRINT_HOST/webcam/?action=snapshot

Get Webcam Settings

curl -s "http://OCTOPRINT_HOST/api/settings" \
  -H "X-Api-Key: API_KEY" | jq '.webcam'

Raspberry Pi Camera Setup

# SSH to Pi, then check camera
ssh pi@octopi.local

# Test camera (legacy raspistill)
raspistill -o test.jpg

# Test camera (libcamera - newer)
libcamera-still -o test.jpg

# Restart webcam service
sudo systemctl restart webcamd

OctoEverywhere / Obico Integration

Remote Access Setup

If you have OctoEverywhere or Obico installed:

# Check plugin status
curl -s "http://OCTOPRINT_HOST/api/plugin/octoeverywhere" \
  -H "X-Api-Key: API_KEY" | jq '.'

# Or for Obico
curl -s "http://OCTOPRINT_HOST/api/plugin/obico" \
  -H "X-Api-Key: API_KEY" | jq '.'

Features Available

• Remote access from anywhere (no port forwarding)
• AI-powered print failure detection
• Mobile notifications
• Gadget integration (smart speakers, etc.)

System Management (SSH)

OctoPi Service Control

# SSH to OctoPi
ssh pi@octopi.local

# Restart OctoPrint
sudo systemctl restart octoprint

# Check OctoPrint status
sudo systemctl status octoprint

# View OctoPrint logs
sudo journalctl -u octoprint -f

# View webcam logs
sudo journalctl -u webcamd -f

System Health

# Check disk space
ssh pi@octopi.local "df -h"

# Check memory
ssh pi@octopi.local "free -h"

# Check CPU temperature (important for Pi!)
ssh pi@octopi.local "vcgencmd measure_temp"

# Check if throttled (power issues)
ssh pi@octopi.local "vcgencmd get_throttled"
# 0x0 = OK, anything else = issues

Update OctoPrint

# Via SSH
ssh pi@octopi.local
~/oprint/bin/pip install --upgrade octoprint

# Or via OctoPrint UI: Settings > Software Update

Backup OctoPrint

# Create backup
ssh pi@octopi.local "tar -czvf ~/octoprint-backup-$(date +%Y%m%d).tar.gz ~/.octoprint"

# Download backup
scp pi@octopi.local:~/octoprint-backup-*.tar.gz ./

Troubleshooting

Common Issues

Check OctoPrint Logs

# Via API
curl -s "http://OCTOPRINT_HOST/api/logs" \
  -H "X-Api-Key: API_KEY" | jq '.logs'

# Via SSH
ssh pi@octopi.local "tail -100 ~/.octoprint/logs/octoprint.log"

Serial Connection Debug

# Check available ports
ssh pi@octopi.local "ls -la /dev/ttyUSB* /dev/ttyACM* 2>/dev/null"

# Check permissions
ssh pi@octopi.local "groups pi"  # Should include 'dialout'

# Test serial manually
ssh pi@octopi.local "screen /dev/ttyUSB0 115200"  # Ctrl-A, K to exit

Power Issues (Raspberry Pi)

# Check for undervoltage
ssh pi@octopi.local "dmesg | grep -i voltage"

# Check throttling status
ssh pi@octopi.local "vcgencmd get_throttled"
# Decode: https://github.com/raspberrypi/documentation/blob/master/hardware/raspberrypi/frequency-management.md

Safety & Best Practices

Before Printing

1. Ensure bed is clean (IPA wipe)
2. Check filament path is clear
3. Verify temperatures match material
4. Confirm first layer adhesion

During Printing

1. Monitor first few layers
2. Watch for thermal runaway
3. Keep camera running for remote monitoring
4. Set up failure detection (Obico AI)

Emergency Commands

# Emergency stop (via G-code)
curl -X POST "http://OCTOPRINT_HOST/api/printer/command" \
  -H "X-Api-Key: API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"command": "M112"}'

# Cancel current print
curl -X POST "http://OCTOPRINT_HOST/api/job" \
  -H "X-Api-Key: API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"command": "cancel"}'

# Disable heaters immediately
curl -X POST "http://OCTOPRINT_HOST/api/printer/command" \
  -H "X-Api-Key: API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"commands": ["M104 S0", "M140 S0"]}'

When to Use This Skill

• "Check my 3D printer status"
• "What's the temperature of my printer?"
• "Upload this G-code file to OctoPrint"
• "Start/pause/cancel the print"
• "Heat the bed to 60 degrees"
• "Home the printer"
• "Create a timelapse of my print"
• "Check my bed level mesh"
• "Troubleshoot why my print failed"
• "Connect to my Ender 3"
• "Extrude some filament"
• "Move the print head"
• "Check OctoPrint logs"
• "Restart OctoPrint service"

When NOT to Use This Skill

• Slicing STL files (use slicer software: Cura, PrusaSlicer)
• CAD design (use Fusion 360, TinkerCAD, etc.)
• Klipper-based printers (different API)
• Printers not connected to OctoPrint

Cross-Platform SSH Notes

For SSH access to the Raspberry Pi, follow the same platform-specific approaches as the SSH Server Admin skill:

With SSH Keys (All Platforms):

ssh -o StrictHostKeyChecking=accept-new pi@octopi.local "command"

With Password - Windows:

# Use Python helper
python scripts/ssh_helper.py --host octopi.local --user pi --password "raspberry" --command "vcgencmd measure_temp"

With Password - macOS/Linux:

sshpass -p 'raspberry' ssh pi@octopi.local "vcgencmd measure_temp"

Version History

• v1.0.0 (2025-12-20): Initial release with full API support, Ender 3 profiles, Octolapse, Bed Level Visualizer, and OctoEverywhere integration

Converted and distributed by TomeVault — claim your Tome and manage your conversions.