# OctoPrint - Open Source Host Software

## OctoPrint and 3D Printer "Host Software"

![](https://cdn-learn.adafruit.com/assets/assets/000/020/922/medium800/raspberry_pi_OctoPrint_org.jpg?1415146635)

## Untether Your Desktop 3D Printer!

What is OctoPrint? It describes itself as desktop 3D printer "host software" -- a utlity that receives job files (gcode) from your "slicer" (the CAM tool that builds fabrication instructions from your digital model) and then delivers this code to the printer itself, typically via USB. A snappier way to say this: OctoPrint is a "nanny cam" for your printer. ;-)

Sure,&nbsp;setting up&nbsp;host software to run your printer from your desktop or laptop sounds like&nbsp;nothing new. Since the first RepRaps, the MakerBot CupCake CNC, Ultimakers, and Printrbots, there have been apps like [ReplicatorG](http://replicat.org/), [PrintRun](https://github.com/kliment/Printrun), and [Repetier Host](http://www.repetier.com/documentation/repetier-host/)&nbsp;that hobbyist and competing printer vendors shared together as what is&nbsp;used to run your printer. (The slick proprietary, vendor-specific utilities came later...)

But guess what, you can run this new breed of&nbsp;host software on a Raspberry Pi, a BeagleBone Black, or other lightweight, affordable embedded Linux system. And these platforms bring with them opportunities to customize with the software and hardware accessories.

Third party host software is coming back into style!

![](https://cdn-learn.adafruit.com/assets/assets/000/020/907/medium800/raspberry_pi_HostSoftwareDiagram_scap.jpg?1415040614)

## 3D Printer Host Software 2.0: Your Software/Hardware Automation Playground

The last few years have seen an explosion of printer tool development -- with open, innovative tools like [Cura](https://www.ultimaker.com/pages/support/manuals)&nbsp;and [MatterControl](http://www.mattercontrol.com/)&nbsp;continuing the tradition of the open platform while&nbsp;machine-specific tools such as [MakerBot Desktop](https://www.makerbot.com/desktop),&nbsp;[Formlabs PreForm](http://formlabs.com/en/products/preform/), and [3D Systems Cubify](http://cubify.com/)&nbsp;hone in on hyper-machine-specific and marketplace-tie-in features. And on the horizon are universal printer platform tools&nbsp;such&nbsp;[Autodesk's Spark](http://spark.autodesk.com/) and direct printer-driver style integration into operating systems and&nbsp;design packages&nbsp;themselves.

The game changed this past year with the newfound popularity for a new type of host software -- lean, clever web/cloud&nbsp;savvy software packages such as [OctoPrint](http://octoprint.org/), [AstroPrint](https://www.astroprint.com/), [PrintToPeer](http://www.printtopeer.com/sculpture), [BotQueue](https://www.botqueue.com/),&nbsp;and [3DPrinterOS](http://www.3dprinteros.com/)&nbsp;that can be deployed on affordable&nbsp;embeddable solutions&nbsp;such as a Raspberry Pi or BeagleBone Black, operating from clients as lightweight as webpages and custom mobile apps, bringing to any given printer (if resources exist for interfacing with the firmware!) highend features as:

- wireless printing
- remote job start/kill from mobile phones
- queue management that automatically logs&nbsp;print success data
- real-time gcode visualization
- custom automation/event hooks
- smart and port-hole machine vision
- automatic&nbsp;timelapse production...
- and anything else you can dream up that a featherweight Linux system&nbsp;can tackle.

At the heart of this rise in popularity is the open source project [OctoPrint](http://octoprint.org/), created by software engineer Gina Häußge, and its community-distributed, easy-to-install OctoPi image.

![](https://cdn-learn.adafruit.com/assets/assets/000/020/590/medium800/raspberry_pi_OctoPrint.jpg?1414074890)

### OctoPrint + Adafruit Hardware = \<3 \<3 \<3

Here are a few of the features bundled into OctoPrint out of the gate:

- Untether your laptop from your printer and put it on a network.
- Control your printer as if you were sitting right next to it.
- Monitor your prints from across town, or across the ocean.
- Free as in beer and speech.
- Visualize your gcode before you run your job, with realtime gcode simulation.
- Compatible with a wide range of desktop 3D printers.

Leveraging simple python scripts shared by an active community developers and any number of easy-to-use webtools, 3D printer hobbyists have more opportunities to experiment with adhoc hardware and software tweaks for their (working) 3D printer than ever before! And after you get your feet wet, the RepRap community and custom building your own printer and printer accessories await. ;-)

For this introductory guide, we will start with the easiest way to get into OctoPrint -- downloading a [pre-loaded "OctoPi" SD Card image](http://docstech.net/OctoPiMirror/)&nbsp;from the project maintained by Guy Sheffer, with source located [here](https://github.com/guysoft/OctoPi). And proceed from there to share resources to help you setup OctoPrint and configure for&nbsp;the desktop 3D printers currently offered at Adafruit!

![](https://cdn-learn.adafruit.com/assets/assets/000/020/948/medium800/raspberry_pi_Adafruit_Learning_System.jpg?1415205216)

## Prerequisite Guides

Before you continue further, make sure you have some basic experience setting up a Raspberry Pi, including a modest amount of command line comfort.

These steps are intended to be easy to follow for a Pi novice. However, if you get stumped we suggest diving right into the excellent OctoPrint Google Group to find solutions or post your experiences for help from seasoned Linux users / command line jockeys to get you back in the game.

We recommend walking-through the following tutorials below before starting this project. These guides will help you get familiar with the components and get setup and configured with your Raspberry Pi:

- [Introducing Raspberry Pi Model B+](../../../../introducing-the-raspberry-pi-model-b-plus-plus-differences-vs-model-b)
- [Adafruit's Raspberry Pi Lesson 3. Network Setup](../../../../adafruits-raspberry-pi-lesson-3-network-setup)
- [Adafruit's Raspberry Pi Lesson 6. Using SSH](../../../../adafruits-raspberry-pi-lesson-6-using-ssh)

- [Next Page](https://learn.adafruit.com/octoprint-open-source-host-software/octopi-pre-loaded-sd-card-image.md)

## Featured Products

### HDMI 4 Pi - 7" Display 1280x800 (720p) IPS - HDMI/VGA/PAL/NTSC

[HDMI 4 Pi - 7" Display 1280x800 (720p) IPS - HDMI/VGA/PAL/NTSC](https://www.adafruit.com/product/1033)
Yes, this is an adorable small HDMI television with incredibly high resolution! We tried to get the smallest possible HDMI/VGA display with high-res, high-contrast visibility. The visible display measures only 7" (17.8cm) diagonal, and the TFT comes in an enclosure with HDMI, VGA and...

No Longer Stocked
[Buy Now](https://www.adafruit.com/product/1033)
[Related Guides to the Product](https://learn.adafruit.com/products/1033/guides)
### 5V 2.5A Switching Power Supply with 20AWG MicroUSB Cable

[5V 2.5A Switching Power Supply with 20AWG MicroUSB Cable](https://www.adafruit.com/product/1995)
Our all-in-one 5V 2.5 Amp + MicroUSB cable power adapter is the perfect choice for powering single-board computers like Raspberry Pi, BeagleBone, or anything else that's power-hungry!

This adapter was specifically designed to provide 5.25V, not 5V, but we still call it a 5V USB...

In Stock
[Buy Now](https://www.adafruit.com/product/1995)
[Related Guides to the Product](https://learn.adafruit.com/products/1995/guides)
### Raspberry Pi Model B+ 512MB RAM

[Raspberry Pi Model B+ 512MB RAM](https://www.adafruit.com/product/1914)
OMG OMG OMG, did you hear? There's a Raspberry Pi&nbsp;called the Model B+ and check it out...more USB ports, more GPIO, better power supply, four mounting holes, less sticky-out SD card! Yep, that's right, the fantastic engineers at Raspberry Pi HQ have blessed us with a new design....

In Stock
[Buy Now](https://www.adafruit.com/product/1914)
[Related Guides to the Product](https://learn.adafruit.com/products/1914/guides)
### Wireless Keyboard and Mouse Combo - One USB Port!

[Wireless Keyboard and Mouse Combo - One USB Port!](https://www.adafruit.com/product/1738)
Add a good quality, slim chiclet keyboard as well as an optical mouse to your Raspberry Pi, Beagle Bone Black or other mini-computer with this wireless combo set. **Best of all, it only uses a single USB port!** This combo comes with a sleek black chiclet keyboard and mouse both...

In Stock
[Buy Now](https://www.adafruit.com/product/1738)
[Related Guides to the Product](https://learn.adafruit.com/products/1738/guides)
### SD/MicroSD Memory Card (8 GB SDHC)

[SD/MicroSD Memory Card (8 GB SDHC)](https://www.adafruit.com/product/1294)
Add mega-storage in a jiffy using this 8 GB class 4 micro-SD card. It comes with a SD adapter so you can use it with any of our shields or adapters. Preformatted to FAT so it works out of the box with our projects. Tested and works great with our <a...></a...>

In Stock
[Buy Now](https://www.adafruit.com/product/1294)
[Related Guides to the Product](https://learn.adafruit.com/products/1294/guides)
### HDMI Cable - 1 meter

[HDMI Cable - 1 meter](https://www.adafruit.com/product/608)
Connect two HDMI devices together with this basic HDMI cable. It has nice molded grips for easy installation, and is 1 meter long (about 3 feet). This is a HDMI 1.3 cable.

We're now stocking a very fancy Official Raspberry Pi cable with overmolding and a Pi logo. Please note...

In Stock
[Buy Now](https://www.adafruit.com/product/608)
[Related Guides to the Product](https://learn.adafruit.com/products/608/guides)
### Ethernet Cable - 10 ft long

[Ethernet Cable - 10 ft long](https://www.adafruit.com/product/730)
We have so many Internet-connected goodies in the shop, we figured it's time to carry a cable so you can easily connect them up! This cable is 10 feet long, black and has all 8 wires installed. Perfect for use with the [BeagleBone](http://www.adafruit.com/products/513), <a...></a...>

No Longer Stocked
[Buy Now](https://www.adafruit.com/product/730)
[Related Guides to the Product](https://learn.adafruit.com/products/730/guides)
### USB WiFi (802.11b/g/n) Module: For Raspberry Pi and more

[USB WiFi (802.11b/g/n) Module: For Raspberry Pi and more](https://www.adafruit.com/product/1012)
Make your Internet of Things device cable-free by adding WiFi. Take advantage of the Raspberry Pi and Beagle Bone's USB port to add a low cost, but high-reliability wireless link. We tried half a dozen modules to find one that works well with the Pi and Bone without the need of recompiling...

In Stock
[Buy Now](https://www.adafruit.com/product/1012)
[Related Guides to the Product](https://learn.adafruit.com/products/1012/guides)

## Related Guides

- [Raspberry Pi as a Media Center](https://learn.adafruit.com/raspberry-pi-as-a-media-center.md)
- [Arm-based IoT Kit for Cloud IoT Core - Getting Started](https://learn.adafruit.com/raspberry-pi-3-and-sensor-kit-for-google-cloud-iot-core.md)
- [10" Raspberry Pi Desktop](https://learn.adafruit.com/10-raspberry-pi-desktop.md)
- [Run an X-Carve CNC Machine Wirelessly with a Raspberry Pi](https://learn.adafruit.com/control-an-xcarve-cnc-machine-wirelessly-with-a-raspberry-pi.md)
- [Adafruit 2.2" PiTFT HAT - 320x240 Display](https://learn.adafruit.com/adafruit-2-2-pitft-hat-320-240-primary-display-for-raspberry-pi.md)
- [Minecraft GPS Compass](https://learn.adafruit.com/minecraft-gps-compass.md)
- [Monster Mask Case](https://learn.adafruit.com/monster-mask-case.md)
- [Crickit Lab Shaker](https://learn.adafruit.com/crickit-lab-shaker.md)
- [Raspberry Pi LED Spectrum Analyzer](https://learn.adafruit.com/raspberry-pi-spectrum-analyzer-display-on-rgb-led-strip.md)
- [MIT Green Building NeoPixel Tetris](https://learn.adafruit.com/tetris-building.md)
- [Custom Bluetooth Cherry MX Gamepad](https://learn.adafruit.com/custom-wireless-bluetooth-cherry-mx-gamepad.md)
- [Fix-It Felix Jr. Hammer with Sound FX](https://learn.adafruit.com/fix-it-felix-jr-hammer.md)
- [LED Noodle Snowflake](https://learn.adafruit.com/led-noodle-snowflake.md)
- [Ultrasonic Ruler](https://learn.adafruit.com/ultrasonic-ruler.md)
- [LED Emerald with Circuit Playground Bluefruit](https://learn.adafruit.com/led-emerald-with-circuit-playground.md)
