Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ludiazv/octocitrico
OctoPrint for other fruits
https://github.com/ludiazv/octocitrico
armbian bananapi octoprint orangepi orangepi-zero rock64
Last synced: 9 days ago
JSON representation
OctoPrint for other fruits
- Host: GitHub
- URL: https://github.com/ludiazv/octocitrico
- Owner: ludiazv
- Created: 2020-06-10T21:40:14.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-10-20T16:45:44.000Z (about 1 year ago)
- Last Synced: 2023-11-07T17:33:21.400Z (about 1 year ago)
- Topics: armbian, bananapi, octoprint, orangepi, orangepi-zero, rock64
- Language: Shell
- Homepage:
- Size: 190 KB
- Stars: 136
- Watchers: 12
- Forks: 17
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# OctoPrint for other fruits
A custom distribution based on [Armbian](https://www.armbian.com) for running [OctoPrint](https://octoprint.org) 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](http://github.com/guysoft/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](#Contributing).**
or
xrm:
889Eewy4ZmKanvWEbVAQKSH9imihLN6iXBz2kLR5Eb1mP2nv6fnPCevKk5qqmGGFsw7ao6HkmDyom7H3hk1vCFMLUoFWkaF
## Features
Core (installed and enabled):
* Optimized armbian Debian bullseye.
* Latest stable octoprint version.
* Selection of top octoprint plugins.
* HAProxy with self signed keys for ssl access.
* Avahi service: Bonjur addvertisement (this enable to acces with host-name.local via ssh or http/s)
* SSH console access.
* USB OTG console access (if available in the board)
* Enabled i2c-dev, spidev, uart (if available on the board)
3D printer related software:
* Quick install of Klipper.
* PlatformIo core for building 3D printer firmware.
* Marlin 1.1.x & Marlin 2.x.x firmware (bugfix versions)
Extras (installed but disabled):
* MPGStreamer USB camera support (experimental)
* SMB shares to remote edit configuration files from a remote PC.
## Usage
Prebuilt images:
1. Download & extract disk image (*.xz) from *releases*.
2. Burn the image in a SD card (>8GB recommended) using *usbimager*,*Etcher*, *Win32DiskImager*, *dd* or the image burner of your choice.
3. Plug the SD card on the board and apply power.
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-.local``
Afterboot you can access to octroprint server:
- Access to octoprint via https
- ssh session
- Console on Usb OTG (if the board supports it)
- Console on board's serial interface with a USB-TTL
- Conecting a keyboard and screen (if the board supports it)
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.
## Default users and passwords:
**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.
## Camera configuration
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](https://github.com/jacksonliam/mjpg-streamer) would work. Other cameras might require addtional software installation or configuration steps.
Refer to OctoPi [documentation](https://community.octoprint.org/knowledge-explorer?topic=21149) 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.__
## Customizing
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
Adding boards to the project requires few steps:
1. Create a folder with the name of the board inside ```boards``` directory.
2. Inside the __new board__ directory create the a new file ```config.conf``` using as template the existing board.
3. Optionaly create ```extra.sh``` script to adjust specific board configuration.
**PRs are wellcome with new boards support.**
## Building
From armbian v23.08 Vagrant build is not avaible. To build this repository ``ddocker + docker buildx``` is required.
```bash
$ git clone
$ cd octocitrico
$ ./optocitrico.sh assets
$ ./optocitrico.sh build
```
Build process is slow and verbose it could take up to several hours depending on your hardware. Be patient.
## Cleaning
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.
## Tested boards
- Orange Pi Zero 256 Mb (not recommended due to low memory)
- Orange Pi Zero 512 Mb
- Orange Pi PC
- Orange Pi PC+
- Rock64
- Banana PI M2 Zero
- Orange Pi Zero 2 (no wifi support)
- Orange Pi 3 LTS
WIP:
- Orange Pi One
- Orange Pi Lite
- Orange Pi One Plus
## Contributing
If you like this project and you want support it please consider:
- Send PRs are to fix bugs and add new boards.
- Test bords and provide feeback.
- Make a donation to Armbian, Octoprint & OctoPi projects.
- Make a donation to this project [here](https://www.buymeacoffee.com/boros): This will enable to buy boards for testing and to pay cloud infrastructure to improve the compilation process.
or
xrm:
889Eewy4ZmKanvWEbVAQKSH9imihLN6iXBz2kLR5Eb1mP2nv6fnPCevKk5qqmGGFsw7ao6HkmDyom7H3hk1vCFMLUoFWkaF