Octoprint is a free open source platform to control your 3D Printer remotely from any web browser. In this guide we will go over step by step what it takes to install OctoPrint. Octoprint has many features and plug-ins including webcam, slicer, an easy to navigate GUI and much more! If you are still controlling your printer through a USB cable and PC you’re missing out. Get unplugged with OctoPrint and control your 3D Printer from anywhere without a PC attached.
What hardware do I need to install octoprint?
You need a couple of things in order to get Octoprint installed.
The SBC (Single Board Computer). Octoprint works on a number of these boards. Directly compatible boards to install octoprint on are Raspberry Pi A, B, A+, B+, B2, 3, Zero and Zero W. In this example we are going to use a Raspberry Pi 3 as it is an “out of the box” SBC.
- Raspberry Pi Camera Module or Supported USB WebCAM
- Raspberry Pi 3 Starter Kit or Print this THING
- USB Cable – Printer Main Board to Raspberry Pi Port. (if you don’t already have one)
- USB Micro SDHC Card reader (if you don’t already have one)
That’s it you are now ready to install Octoprint on your raspberry pi!
OctoPrint is the snappy web interface for your 3D printer that allows you to control and monitor all aspects of your printer and print jobs, right from your browser.
Go to http://octoprint.org/download/ and download the current version of Octoprint
This will download a .zip file that will look something like this.
Unzip the files using your preferred archiver. I recommend winrar.
This will extract an .img file into your specified directory.
Ok now we need to burn the .img file to your Micro SDHC Card. To do this we will use a free program called Etcher.
Download Etcher at https://etcher.io/ and install the software.
Using etcher is really easy and happens in 3 steps
- Select the .img file from the directory you extracted it to
- Select your Micro SDHC card
That’s it! You’ll see the progress of the img burn to your sd card.
Or you could use WIN32DiskImager
Download Win32DiskImager from the Raspberry Pi Downloads Page or from http://sourceforge.net/projects/win32diskimager/files/latest/download
Insert your SD Card and then run Win32DiskImager.exe. It may give an error message on startup, but you can often ignore it. It should find your SD Card drive or if not select it. Select the file '#.img' image file you wish to use and then press write. Once it completes you are ready to go, insert your SD card into the Raspberry Pi.
Writing Your Own Custom SD Card Setup To A File
Ensure the Device drop down box has the drive your card is inserted into.
Press the folder button and select the folder and filename you want to use to write your image file to.
Press the Read button.
Example Instructions To Email To Someone
Here's the instructions to install your SD card ready for the Raspberry Pi.
1. Download and install Win32 Disk Imager from this link:
2. Download the following file to a computer with at least <<<#>>>GB of free disk space.
<<<<LINK TO YOUR FILE >>>>>
Unzip it (this may take a while as its a large file to match the size of the SD card)
3. Plug the SD card into a SD card slot or adaptor for your PC.
4. Run the unzipped Win32DiskImager.exe application (may just be shown as Win32DiskImager depending on your windows settings)
Ensure the correct driver letter is selected for the SD card – double check this is right in Windows Explorer as Win32DiskImager will overwrite the entire drive without warning if the wrong drive is selected!
Select the unzipped <<<<YOUR FILE NAME>>>.img file
Press Write and wait for the program to write the operating system onto the SD card.
5. Once the writing is done plug the SD card into the Raspberry Pi and power it up.
"Not enough space on disk" error
You created an image file from a 8GB SD card and when you try and write it to a new 8GB SD card you get this message. Yep, SD cards are not always identical in size and Win32 Disk Imager currently has no way to solve this.
Image file: 15564800 sectors x 512 bytes per sector = 7,969,177,600 bytes
SD card: 15523840 sectors x 512 bytes per sector = 7,948,206,080 bytes
So we need to limit the space used on the card to fit within the number of sectors available. If you want pick a smaller size to give you an bit of unused space for possibly smaller future cards.
Then follow the guide here.
If you have issues with USB drivers for the ☒IP01, then go here ☒IP01, and install the driver from the drivers folder.
Flashing on Non-Windows Operating Systems
These instructions are provided AS IS. If you encounter difficulty, use the instructions above before reporting an issue.
- You will need to install the avrdude command. On several linux systems this is provided as a package through your package manager (e.g. sudo apt install avrdude).
- Execute the following command if ☒IP01 is connected at /dev/ttyUSB0: avrdude -p m328p -b 57600 -P /dev/ttyUSB0 -c stk500v1 -U flash:w:CR03_BootCamp_Firmware_V1.200_20170812.hex
There is really not much you need to do to get OctoPrint configured. To install octoprint all we need to do now is setup your internet connection.
Open your Micro SDHC card on your pc and you’ll see a file list from when the .img file was burned to the disk.
Find and open the file with notepad++ or another free advanced text editor.
Once you have this open you will see lines of code all starting with “#”. This # comments out the lines and tells the board to ignore that line.
Most commonly you will be setting up at line 26 WPA/WPA2 secured.
To set this up simply remove the # from the 3 lines and provide your SSID Information (wifi name and password).
Save the file and then close the notepad editor.
Insert the Micro SDHC Card in the slot of your Raspberry Pi. Connect your Raspberry Pi to your 3D Printer with the USB cable and any other additional components.
OctoPrint First Boot Screens
Power up your raspberry pi and wait about 1-2 minutes. It needs some time to boot up for the first time.
Finding your OctoPrint IP Address
Login to your router and view your wireless connected devices.
Copy and Paste your IP Address into your browser and you’ll see the Octoprint setup screen;
If you plan to use the Cura Slicer on Octoprint make sure you set your 3D Printers parameters on the printer profile screen. If you are just going to upload .gcode files then you don’t need to set that up but it’s good practice to enter in that info just in case you need it later.
Congratulations you have now learned how to install OctoPrint!
Accessing OctoPrint outside your network
If you want to access your 3D Printer outside of your home network you will need to access the port forwarding settings of you internet router.
Now locate the advanced settings and find where your router has the port forwarding settings…
Make a new entry with your OctoPrint information with External Port set to 80 and useboth protocols;
Once saved and enabled you can now enter your public IP address in any browser and control your 3D Printer.
You can find your public IP by going to http://www.whatsmyip.org/ and it will be displayed near the top of the screen.
Enter this public ip address and OctoPrint should appear if it doesn’t or you have other ports open enter you ip address followed by the port number like this: http://XXX.XX.XXX.XX:80
OctoPrint has two modes Guest and Admin;
Guest access: allows users to view each tab but they cannot execute commands.
Admin access: has full privileges.
Be aware that anyone with your public IP can view your OctoPrint with guest access and even the webcam! So make sure you have a strong password and look into securing your OctoPrint even further.
That should get you started on OctoPrint and you’ll soon find how freakin awesome it is! It’s totally worth the time and efforts. It’s free, open source and had a ton of customizable plug-ins. So if you really like throw the developers a donation: http://octoprint.org/support-octoprint/ they’ll sure appreciate it!
Please post any Errors, Comments or Questions you have and please share. Happy printing!
Users may also find XLoader useful too!
Microsoft Windows Tool for Flashing ☒CC01 and ☒CR03 using ☒IP01
No tools available at this point for other Operating Systems!
- Download xLoader.zip file.
- Virus Check the xLoader.zip file
- Unzip the xLoader.zip file
- Connect ☒IP01 and ☒CC01/☒CR03 together
- Insert ☒IP01 and ☒CC01/☒CR03 into an available USB port
- Wait for eventual drivers to be installed, if driver installation fail, goto USB Driver
- Execute the xLoader.exe file
- Choose Firmware. There is a .hex file included in the install folder. You can also download a specific radio ID pairs.
- Choose your COM port. If no COM port is available, goto USB Driver
- Click Upload
- Wait for the text Uploading... to be replaced by <nnnn> bytes uploaded
- Unplug ☒IP01 and ☒CC01/☒CR03