Octobalena
Remotely control your 3d-printer with [octoprint](https://github.com/foosel/OctoPrint) + [octodash](https://github.com/UnchartedBull/OctoDash) via balena.io !
**octoprint can be exposed on port 80 which can be remotely accessible via balena.io [public URL](https://docs.balena.io/management/devices/#enable-public-device-url) feature**
By default, the device can be reached at `octobalena.local` if mDNS is working on your device.
## Getting started
### Via [Balena Deploy](https://www.balena.io/docs/learn/deploy/deploy-with-balena-button/)
You can deploy this project to a new balenaCloud application in one click using the button below:
[](https://dashboard.balena-cloud.com/deploy?repoUrl=https://github.com/MatthewCroughan/octobalena/)
### Via [Balena-Cli](https://www.balena.io/docs/reference/balena-cli/)
- Sign up on [balena.io](https://dashboard.balena.io/signup)
- go through the [getting started guide](https://balena.io/docs/learn/getting-started) and create a new application
- clone this repository to your local workspace
- Using [Balena CLI](https://www.balena.io/docs/reference/cli/), push the code with `balena push
`
- See the magic happening, your device is getting updated 🌟Over-The-Air🌟!
### Via Git
- Sign up on [balena.io](https://dashboard.balena.io/signup)
- go through the [getting started guide](https://balena.io/docs/learn/getting-started) and create a new application
- clone this repository to your local workspace
- add the _balena remote_ to your local workspace using the useful shortcut in the dashboard UI
- `git push balena master`
- see the magic happening, your device is getting updated Over-The-Air!
# Configure via [environment variables](https://docs.resin.io/management/env-vars/)
## Octoprint Service Variables
Variable Name | Value | Description | Default
------------ | ------------- | ------------- | -------------
**`CAMERA_DEV`** | `STRING` | The camera device node | /dev/video0
**`MJPEG_STREAMER_AUTOSTART`** | `BOOLEAN` | Start the camera automatically | true
**`MJPEG_STREAMER_INPUT`** | `STRING` | Flags to pass to mjpg_streamer | -y -n -r 640x480
**`MQTT_BROKER`** | `STRING` | Ip address of mqtt broker to use |
**`MQTT_BROKER_PORT`** | `STRING` | Port the mqtt broker is running on |
**`ESPURNA_RELAY_NAME`** | `STRING` | Relay name (hostname) used by espurna at the root of topic. E.G ESPURNA-123456, [see documentation](https://github.com/xoseperez/espurna/wiki/Configuration#direct-http-settings-api) |
## Octodash Service Variables
Variable Name | Value | Description | Default
------------ | ------------- | ------------- | -------------
**`OCTOPRINT_APIKEY`** | `STRING` | Needed for OctoDash to interact with Octoprint |
**`PRINTER_NAME`** | `STRING` | Name of the printer, as shows up in the bottom left of OctoDash | Octobalena
## mdns-publisher Service Variables
Variable Name | Value | Description | Default
------------ | ------------- | ------------- | -------------
**`OCTOPRINT_HOSTNAME`** | `STRING` | Adds CNAME for mDNS so device is reachable at string.local | octobalena
## Octoprint Version
v1.5.3
## Plugin versions
Plugin Name | Version
--------------------------------------| -------
OctoPrint Preheat | v0.6.0
OctoPrint-DisplayLayerProgress | v1.25.4
OctoPrint-PSUControl | v0.1.11
OctoPrint-MQTT | v0.8.7
OctoPrint-FilamentManager | v1.7.2
OctoPrint-PrintTimeGenius | v2.2.7
OctoPrint-UltimakerFormatPackage | v0.2.2
OctoPrint-BLTouch | v0.3.4
OctoPrint-BedLevelVisualizer | v1.0.0
Octolapse | v0.4.1
OctoPrint-OctoVox | v0.1.6
MarlinGcodeDocumentation | v0.12.0
OctoPrint-FirmwareUpdater-1.11.0 | v1.11.0
## Attribution
# **Octoprint by [Foosel](https://github.com/foosel/)**
https://github.com/OctoPrint/OctoPrint
[GNU Affero General Public License V3](https://www.gnu.org/licenses/agpl-3.0.html)
OctoPrint provides a snappy web interface for controlling consumer 3D printers.
# **OctoDash by [UnchartedBull](https://github.com/UnchartedBull)**
https://github.com/UnchartedBull/OctoDash
[Apache 2.0](https://github.com/UnchartedBull/OctoDash/blob/master/LICENSE.md)
OctoDash is a User Interface for OctoPrint, it utilizes the OctoPrint API but tries to use modern design principles in order to fully enable the power of your Raspberry Pi attached to your 3D Printer. OctoDash works best with a Touchscreen and will support almost all functions that OctoPrint offers just in a nicer format. Give it a try!
# Balena-io-playground
This project is in part based on excellent work done by the Balena.io team
https://github.com/balena-io-playground/balena-octoprint