Skip to content

Latest commit

 

History

History
83 lines (50 loc) · 4.46 KB

README.md

File metadata and controls

83 lines (50 loc) · 4.46 KB
Raw

octo4a - Run OctoPrint on Android

Donate GitHub Sponsors IzzySoft

A banner visually expaining how the app works

You don't have a Raspberry Pi, but you want to control your 3D printer remotely? Use your phone as an octoprint host! With the Octo4a app you can install Octoprint on your android phone in minutes, without any special Linux knowledge.

Important note about charging and using OTG

Some phones do not support simultaneous charging and USB on the go (OTG). Please consult this community contributed list of phones our users use, If you wish to buy a phone for the purpose of running octo4a:

https://docs.google.com/spreadsheets/d/1pbKAELzvTrMVm6NpDpK8TfQR33w3QHQEgqkcGdbPFI0/edit?usp=sharing

If you have a phone that is not on the list, please add it and let us know if it works or not:

https://forms.gle/cnTtdDqG3UcwTgnW9

Download

Newest .apk files are available in the releases page.

Usage

  1. Enable installing 3rd-party .apk in your phone's settings.
  2. Install the apk file downloaded from the releases page.
  3. Open the app.
  4. Click "Install OctoPrint" to download and install OctoPrint (needs working connection to internet & querries Google DNS servers 8.8.8.8 and 8.8.4.4)
  5. Allow the app to access the storage, if asked for permission.
  6. Wait for the installation to complete. This may take a long time, depending on your internet speed.
  7. Click "Continue" when the installation finishes.
  8. Optionally start the camera server to enable watching your printer from octoprint.
  9. Navigate to the IP address shown at the top in your browser to access and set-up OctoPrint.
  10. Happy printing!

Features

  • Quick and easy octoprint installation.
  • Printer connection via USB OTG. Thanks to our custom USB driver you can use octoprint even on phones without root access.
  • Built-in camera support. You can use the built-in camera in your phone to see the progress of your 3D prints, instead of buying a separate module. The app also supports octolapse.
  • SSH support. You can easily log-in via ssh and customize your octoprint installation.

Wiki

FAQ and many different topics are described in the project's wiki

Video tutorials

Here are some video tutorials made by the octo4a community that will help you with setting everything up:

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Donating

If you like this project, feel free to donate on PayPal or sponsor me on GitHub. This project heavily relies on great work done on OctoPrint so please consider donating to them if you like this app. Thank you for your support :)

Disclaimer

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

TL;DR: If your house burns down because this app malfunctioned, you cannot sue me.

License

This project is licensed under the AGPL license.