These instructions are not intended to teach you how to use a Pi or Raspbian. Please refer to Octoprint.org on how to install the image.
Please review all of the documentation prior to installing anything.
Here is a video from Thomas Sanladerer regarding how to do the initial installation of Octoprint. Starting with the 0.15 Octopi version, the wifi setup is totally different. After reviewing the video, please follow the directions on how to configure the new method. If you are using any of the previous releases, which I do not recommend, you will use the way that is outlined in Tom’s video. It is recommended to go with the 0.15.1 release or higher.
This is taken directly from the Octoprint site;
Configure your WiFi connection by editing octopi-wpa-supplicant.txt
on the root of the flashed card when using it like a thumb drive. Important: Do not use WordPad (Windows) or TextEdit (MacOS X)for this, those editors are known to mangle the file, making configuration fail. Use something like Notepad++, Atom or VSCode instead or at the very least heed the warnings in the file.
Note: This changed with OctoPi 0.15.0, earlier versions had you edit octopi-network.txt
which has a different format. This old method is no longer supported and the contents of this file will be ignored. Just use octopi-wpa-supplicant.txt
.
Please also refer take a look at the full WiFi setup guide in the FAQ that also includes Troubleshooting tips.
When Octoprint was upgraded to 1.3.7, there was an issue with pip and the installation of plugins and whatnot. This was corrected in 1.3.8 and Octopi 0.15.1. The instructions below fix the problem in older builds of Octopi as well as work with the current release. It is recommended that you start with a clean image of 0.15.1.
Do not install the ATXPiHat Octoprint plugin until you have completed the installation steps below;
- If this is a new installation of Octoprint, download the current Octopi image from Github. Install it using the video from above, and verify that you can putty into a terminal session of the Pi.
- After you backup the memory chip for the PI, (Just do it). If this is a new image, you can skip this step.
- It is always good to update the Raspbian image prior to any upgrade. From a terminal prompt;
cd ~ sudo apt-get update sudo apt-get dist-upgrade sudo apt-get install build-essential python-dev curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py sudo python get-pip.py sudo pip install --upgrade setuptools sudo ~/oprint/bin/pip install --upgrade pip sudo ~/oprint/bin/pip install --upgrade setuptools
- You will need to install the pigpio library and service from
joan@abyz.me.uk - http://abyz.co.uk/rpi/pigpio/python.html
- Currently there is no pip installer for the pigpiod library and service, that I could find, for this library on the PI. Octoprint will not install it automatically or install it as a service. There are several available install scripts to do this, here is one implementation that I recommend;
https://github.com/banichow/pigpioinstall
- After completion, go ahead power down the PI and install the board. Do not just power it off, from a terminal window:
sudo shutdown now
- Plug the ATXPiHat or ATXPiHatZero in and connect the ATX power supply. Make sure that you do not have any other power source plugged into the PI, the board and power supply will take care of this. During the installation of the board to the PI, make sure that the board is plugged in to the pins properly and the board is supported on all of the screw holes. Do not power the board if it is not plugged in properly to the PI. You will destroy the PI. Check it twice.
- After turning on the ATX power supply, and the PI boots, you will need to enable I2C and the one wire interfaces on the PI for the ATXPiHat and ATXPiHat Zero. Adafruit has great instructions on how enable the I2C interface.
- Make sure that there are no other plugins that would conflict with this plugin. PSUControl, LEDStripControl are two. With everything out there, I would review what I already have installed. For the more advanced users, it is truly possible to use both of these plugins to control the ATXPiHat and the just the PSUControl for the ATXPiHatZero. The schematics are available on the release pages and it outlines what pins do what.
- If you are using the ATXPiHat Zero, please follow the instructions on how to install the the Adafruit DHT library.
- Install the ATXPiHat plugin via the Plugin Manager or manually using this URL:
https://github.com/banichow/OctoPrint-Atxpihat/archive/master.zip
- We found during our testing, it is a good idea to restart the Pi after installation or upgrade of the plugin. This will be the first thing that we will ask during any support requests.
- After this, sign into Octoprint and start working with the board.
Here is the standard disclaimer – you must understand and agree to this!
Understand this, this board has not been tested by an independent lab such as UL, or anyone else. You use it at your own risk. Each board is shipped tested and should work properly out of the box. They are designed to work with a Raspberry Pi 3b and Zero. However, all the work has been done on Pi 3b’s. I will work hard with the user to make sure that everything is good, however like anything in the RepRap space, you are responsible if you burn you house down. Never, and I mean never, use this board and or your printer unsupervised. I will not be held accountable for anything that happens while using this board. Again, use it at your own risk.