A custom distribution based on Armbian for running OctoPrint for other Pi-like single board computers.
Credits of this project are for the awesome Armbian team and the outstanding work of @guysoft creating the custom distribution OctoPi . This port reuse most of OctoPi's code adapting it to the armbian build process and board specs and provide some helper sripts to simplify installation and maintance of the distribution.
If you like this project please consider contributing.
or
xrm:
889Eewy4ZmKanvWEbVAQKSH9imihLN6iXBz2kLR5Eb1mP2nv6fnPCevKk5qqmGGFsw7ao6HkmDyom7H3hk1vCFMLUoFWkaF
Core (installed and enabled):
3D printer related software:
Extras (installed but disabled):
Prebuilt images:
First boot tipically require a few minutes. Once booted octoprint will be available to use. If your computer is able to resolve mDns (macos or linux avahi) the name of the board is preconfigured as
citrico-<board>.local
Afterboot you can access to octroprint server:
Armbian does not activate WiFi by default. Any initial network access requires ethernet connection if available on the board or configuring wifi access using a keyboard and monitor.
octoCitrico create a two users:
root
with default password octoroot
pi
with default password pi
. This user has sudo
rights.It's recommended but not mandatory to change user passwords and disable root access via SSH.
As derivative distribution of OctoPi Octocitrico support camera operation out of the box using the same configuration files of OctPi. Any USB camera/webcams supported by debian in your single board computers and by MJPG-Streamer would work. Other cameras might require addtional software installation or configuration steps.
Refer to OctoPi documentation and online tutorials on how to tune your camera. You can edit camera options using scripts/citrico-config
helper tool.
From version 21.02 experimental support for HLS streaming is included for testing.
Required service activation for camera usage:
By default webcam streaming service is disabled , you need to enable it before is available for octoprint.It can be enabled by running sudo scripts/citrico-config
with the pi
using the following table as reference:
Service | MPGSTREAMER | HLS Streaming |
---|---|---|
haproxy | enabled | enabled |
streamer_select | enabled | enabled |
nginx | disbled | enabled |
webcamd | enabled | disabled |
ffmpeg_hls | disabled | enabled |
Edit /boot/octopi.txt
the variable camera_streamer=mjpeg
for mjpg-streamer and camera_streamer=hls
for HLS mode.
Note: hls mode is still experimental and may require additional manual tweaks in the the configuration. Please refer to octoPi configuration for more details.
For configuring WiFi or customize your instance you need to log into you octocitrico server and configure as you want as in any linux computer. Armbian and octocitrico provides helper scripts to make easy the configuration of the box.
Login with the pi
user:
armbian-config
: Fullfleged configuraion tool.nmtui
: Network configuration.scripts/citrico-config
: Enable or disable octocitrico default services and edit octopi camera configuration.scripts/install-klipper
: Install Klipper 3D printer software.For accessing files via SMB(windows shares) you need to enable Samba service (preconfigured) using scripts/citrico-config
. A default share pi-files
will be avaible using pi
user.
Adding boards to the project requires few steps:
boards
directory.config.conf
using as template the existing board.extra.sh
script to adjust specific board configuration. PRs are wellcome with new boards support.
From armbian v23.08 Vagrant build is not avaible. To build this repository ``ddocker + docker buildx``` is required.
$ git clone <this repository>
$ cd octocitrico
$ ./optocitrico.sh assets
$ ./optocitrico.sh build <board_name>
Build process is slow and verbose it could take up to several hours depending on your hardware. Be patient.
Building process could use a lot of space of your disk. To free this space after building you can execute ./optocitrico.sh clean
. This will clean all files used for the build including virtual machines and vagrant boxes.
WIP:
If you like this project and you want support it please consider:
or
xrm: 889Eewy4ZmKanvWEbVAQKSH9imihLN6iXBz2kLR5Eb1mP2nv6fnPCevKk5qqmGGFsw7ao6HkmDyom7H3hk1vCFMLUoFWkaF