# BeamKlipper

**Repository Path**: tutu0718/BeamKlipper

## Basic Information

- **Project Name**: BeamKlipper
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-10-06
- **Last Updated**: 2024-10-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Beam Klipper - Klipper for vanilla Android!

Beam Klipper allows you to run [Klipper](https://github.com/KevinOConnor/klipper) host software (Klippy) on any Android 5.0+ device with OTG support.

Telegram: https://t.me/ytkab0bp_channel

Boosty (Patreon alternative): https://boosty.to/ytkab0bp

K3D Chat for discussion & support (Russian language only): https://t.me/K_3_D

# Quick start

1. Download & install firmware.bin from [here](https://github.com/utkabobr/klipper/tree/prebuilt-v0.12.0) (or build your own from [this repo](https://github.com/utkabobr/klipper) to ensure versions compatibility)
2. Install APK from [Releases tab](https://github.com/utkabobr/BeamKlipper/releases/latest)
3. Allow all the permissions required
4. Add printer instance (Click generic-***.cfg if your printer is not available)
5. Click start
6. Go to web server's url `http://IP:8888/`
7. Configure serial port from "Devices" tab in web editor (1.0.1+ configures automatically if you use single printer setup)
8. You're awesome!

# Can I use device as regular after I install Beam Klipper to it?

**Yes!** You definitely can!

Beam Klipper does not do **anything** to your Android system, it runs in user-space as a regular Android app

# What's IP:port?

It's displayed on main page when any of the instances are running.

Web server URL is: `http://IP:8888/`

Camera URL's are:
- /webcam/?action=stream => `http://IP:8889/`
- /webcam/?action=snapshot => `http://IP:8889/snapshot`

Recommended camera config is mjpeg-**stream** (Not adaptive mjpeg) for Fluidd and UV4L-MJPEG for Mainsail

# What's inside?

Beam Klipper bundles:
- [Klipper](https://github.com/KevinOConnor/klipper)
- [Moonraker](https://github.com/Arksine/moonraker)
- [Fluidd](https://github.com/fluidd-core/fluidd)
- [Mainsail](https://github.com/mainsail-crew/mainsail)
- [Happy Hare](https://github.com/moggieuk/Happy-Hare)
- [Klipper TMC Autotune](https://github.com/andrewmcgr/klipper_tmc_autotune)
- [Moonraker-timelapse](https://github.com/mainsail-crew/moonraker-timelapse)

# Beam extensions

Beam Klipper provides additional extensions to control some built-in features.

### Camera

Include `[beam_camera]` into your printer.cfg

`SET_CAMERA_FLASHLIGHT ENABLED=true/false` - Toggles flashlight

`SET_CAMERA_FOCUS AUTOFOCUS=true/false FOCUS_DISTANCE=0...?` - Sets camera autofocus state and focus distance if autofocus is disabled. `FOCUS_DISTANCE` is expressed in dioptres, it may vary from device to device

### Beeper

Include `[include beam_beeper.cfg]` into your printer.cfg

Use `M300` macro [as defined in docs](https://marlinfw.org/docs/gcode/M300.html)

# Autostart

You can put the app to autostart by setting needed printers to autostart **AND** setting app as default launcher.

You **must** remove lockscreen pincode if your device is encrypted (Enabled by default on most devices)

# Background activity notice

Some manufacturers may restrict app's performance or background process.
You can circumvent this by setting app as default launcher and allowing all the background tasks

# Android TV support?

It *should* be supported, but it's not tested yet. There might be interface bugs

# What USB hub to use?

I'm using UGREEN Type-c hub (Not affiliated, but I'm waiting for your request UGREEN :D), but any should be fine if it works with your device and provides charging at the same time

# Restrictions

- Web server can't run on default port because Android/linux doesn't allow user-space apps to bind to ports less than 1024 and we want 80 for default `http://IP`
- Only up to 4 instances can be running at the same time because Android requires developer to declare each service with different process individually. Idk if someone will use more than that anyway ¯\\\_(ツ)\_/¯
- Some devices may reset device path on firmware restart, you should use VID/PID naming in that case
- No SSH (You won't be able to build firmware or run additional autorun services anyway)
- Some devices doesn't support OTG and charging at the same time, you must solder directly to the battery pins in that case (Or use different device, it's up to you)
- Only 250000 baud rate is supported (I don't want to forward this setting into Android USB driver, almost all configurations use 250000 anyway)

# Building

- Fetch all of the submodules first! (`git clone --recursive`, do NOT download project as archive)
- Import project into Android Studio & click run

# Contributing

Pull requests are welcome, but I will **NOT** approve Kotlin source code as I don't use it in my projects