├── klipper(MKS SGEN-L V1.0).bin ├── klipper(MKS Monster8 v2.0).bin ├── moonraker.conf ├── homing_override.cfg ├── fluidd.cfg ├── printer.cfg ├── configuration_klipper_family.sh ├── configuration_klipper_family_V1.0.sh ├── README.md ├── README_en.md └── LICENSE /klipper(MKS SGEN-L V1.0).bin: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/gaifeng8864/klipper-on-android/HEAD/klipper(MKS SGEN-L V1.0).bin -------------------------------------------------------------------------------- /klipper(MKS Monster8 v2.0).bin: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/gaifeng8864/klipper-on-android/HEAD/klipper(MKS Monster8 v2.0).bin -------------------------------------------------------------------------------- /moonraker.conf: -------------------------------------------------------------------------------- 1 | [server] 2 | host: 0.0.0.0 3 | port: 7125 4 | klippy_uds_address: /home/print3D/printer_data/comms/klippy.sock 5 | 6 | [machine] 7 | validate_service: False 8 | validate_config: False 9 | provider: none 10 | 11 | [authorization] 12 | trusted_clients: 13 | 10.0.0.0/8 14 | 127.0.0.0/8 15 | 169.254.0.0/16 16 | 172.16.0.0/12 17 | 192.168.0.0/16 18 | FE80::/10 19 | ::1/128 20 | cors_domains: 21 | http://*.lan 22 | http://*.local 23 | https://my.mainsail.xyz 24 | http://my.mainsail.xyz 25 | https://app.fluidd.xyz 26 | http://app.fluidd.xyz 27 | 28 | [octoprint_compat] 29 | 30 | [history] 31 | 32 | [update_manager] 33 | channel: dev 34 | refresh_interval: 168 35 | 36 | [update_manager fluidd] 37 | type: web 38 | channel: stable 39 | repo: fluidd-core/fluidd 40 | path: ~/fluidd 41 | 42 | [update_manager KlipperScreen] 43 | type: git_repo 44 | path: ~/KlipperScreen 45 | origin: https://github.com/jordanruthe/KlipperScreen.git 46 | env: ~/.KlipperScreen-env/bin/python 47 | requirements: scripts/KlipperScreen-requirements.txt 48 | install_script: scripts/KlipperScreen-install.sh 49 | managed_services: KlipperScreen 50 | -------------------------------------------------------------------------------- /homing_override.cfg: -------------------------------------------------------------------------------- 1 | [homing_override] 2 | gcode: 3 | # A list of G-Code commands to execute in place of G28 commands 4 | # found in the normal g-code input. See docs/Command_Templates.md 5 | # for G-Code format. If a G28 is contained in this list of commands 6 | # then it will invoke the normal homing procedure for the printer. 7 | # The commands listed here must home all axes. This parameter must 8 | # be provided. 9 | 10 | 11 | 12 | {% set do_x = false %} 13 | 14 | {% set do_y = false %} 15 | 16 | {% set do_z = false %} 17 | 18 | {% if params.X is defined %} 19 | {% set do_x = true %} 20 | {% endif %} 21 | 22 | {% if params.Y is defined %} 23 | {% set do_y = true %} 24 | {% endif %} 25 | 26 | {% if params.Z is defined %} 27 | {% set do_z = true %} 28 | {% endif %} 29 | 30 | 31 | 32 | {% if do_x == true and do_y == false and do_z == false %} 33 | # Home 34 | G28 X0 35 | # Move away 36 | G90 37 | G1 X30 F1200 38 | {% endif %} 39 | 40 | {% if do_y == true and do_x == false and do_z == false %} 41 | # Home 42 | G28 Y0 43 | # Move away 44 | G90 45 | G1 Y30 F1200 46 | {% endif %} 47 | 48 | {% if do_z == true and do_x == false and do_y == false %} 49 | G28 Z0 50 | {% endif %} 51 | 52 | {% if do_x == true and do_y == true and do_z == false %} 53 | # Home 54 | G28 X0 55 | # Move away 56 | G90 57 | G1 X30 F1200 58 | 59 | G4 P2000 60 | 61 | # Home 62 | G28 Y0 63 | # Move away 64 | G90 65 | G1 Y30 F1200 66 | {% endif %} 67 | 68 | {% if do_x == false and do_y == false and do_z == false %} 69 | # Home 70 | G28 X0 71 | # Move away 72 | G90 73 | G1 X30 F1200 74 | 75 | G4 P2000 76 | 77 | # Home 78 | G28 Y0 79 | # Move away 80 | G90 81 | G1 Y30 F1200 82 | 83 | G4 P1000 84 | 85 | G28 Z0 86 | 87 | {% endif %} 88 | 89 | 90 | axes: xyz 91 | # The axes to override. For example, if this is set to "z" then the 92 | # override script will only be run when the z axis is homed (eg, via 93 | # a "G28" or "G28 Z0" command). Note, the override script should 94 | # still home all axes. The default is "xyz" which causes the 95 | # override script to be run in place of all G28 commands. 96 | #set_position_x: 97 | #set_position_y: 98 | #set_position_z: 99 | # If specified, the printer will assume the axis is at the specified 100 | # position prior to running the above g-code commands. Setting this 101 | # disables homing checks for that axis. This may be useful if the 102 | # head must move prior to invoking the normal G28 mechanism for an 103 | # axis. The default is to not force a position for an axis. 104 | -------------------------------------------------------------------------------- /fluidd.cfg: -------------------------------------------------------------------------------- 1 | [virtual_sdcard] 2 | path: /home/print3D/printer_data/gcodes 3 | 4 | [pause_resume] 5 | 6 | [display_status] 7 | 8 | [gcode_macro CANCEL_PRINT] 9 | description: Cancel the actual running print 10 | rename_existing: CANCEL_PRINT_BASE 11 | gcode: 12 | TURN_OFF_HEATERS 13 | M107 #turn off fan 14 | CANCEL_PRINT_BASE 15 | 16 | 17 | ##### set park positon for x and y ##### 18 | # default is your max posion from your printer.cfg 19 | {% set x_park = printer.toolhead.axis_maximum.x|float - 30 %} 20 | {% set y_park = printer.toolhead.axis_maximum.y|float - 30 %} 21 | ##### calculate save lift position ##### 22 | {% set max_z = printer.toolhead.axis_maximum.z|float %} 23 | {% set act_z = printer.toolhead.position.z|float %} 24 | {% if act_z < (max_z - 30) %} 25 | {% set z_safe = 30 %} 26 | {% else %} 27 | {% set z_safe = max_z - act_z %} 28 | {% endif %} 29 | 30 | {% if "xyz" in printer.toolhead.homed_axes %} 31 | G90 32 | G1 Z{act_z + z_safe} F360 33 | G1 X{x_park} Y{y_park} F3000 34 | {% else %} 35 | {action_respond_info("Printer not homed")} 36 | {% endif %} 37 | 38 | 39 | 40 | 41 | [gcode_macro PAUSE] 42 | description: Pause the actual running print 43 | rename_existing: PAUSE_BASE 44 | # change this if you need more or less extrusion 45 | variable_extrude: 1.0 46 | gcode: 47 | 48 | #turn off fan 49 | M107 50 | 51 | ##### read E from pause macro ##### 52 | {% set E = printer["gcode_macro PAUSE"].extrude|float %} 53 | ##### set park positon for x and y ##### 54 | # default is your max posion from your printer.cfg 55 | {% set x_park = printer.toolhead.axis_maximum.x|float - 30 %} 56 | {% set y_park = printer.toolhead.axis_maximum.y|float - 30 %} 57 | ##### calculate save lift position ##### 58 | {% set max_z = printer.toolhead.axis_maximum.z|float %} 59 | {% set act_z = printer.toolhead.position.z|float %} 60 | {% if act_z < (max_z - 30) %} 61 | {% set z_safe = 30 %} 62 | {% else %} 63 | {% set z_safe = max_z - act_z %} 64 | {% endif %} 65 | ##### end of definitions ##### 66 | PAUSE_BASE 67 | {% if printer.extruder.can_extrude|lower == 'true' %} 68 | G91 69 | G1 E-{E} F2400 70 | {% else %} 71 | {action_respond_info("Extruder not hot enough")} 72 | {% endif %} 73 | {% if "xyz" in printer.toolhead.homed_axes %} 74 | G90 75 | G1 Z{act_z + z_safe} F360 76 | G1 X{x_park} Y{y_park} F3000 77 | {% else %} 78 | {action_respond_info("Printer not homed")} 79 | {% endif %} 80 | 81 | 82 | 83 | [gcode_macro RESUME] 84 | description: Resume the actual running print 85 | rename_existing: RESUME_BASE 86 | gcode: 87 | ##### read E from pause macro ##### 88 | {% set E = printer["gcode_macro PAUSE"].extrude|float %} 89 | #### get VELOCITY parameter if specified #### 90 | {% if 'VELOCITY' in params|upper %} 91 | {% set get_params = ('VELOCITY=' + params.VELOCITY) %} 92 | {%else %} 93 | {% set get_params = "" %} 94 | {% endif %} 95 | ##### end of definitions ##### 96 | {% if printer.extruder.can_extrude|lower == 'true' %} 97 | G91 98 | G1 E{E} F2400 99 | {% else %} 100 | {action_respond_info("Extruder not hot enough")} 101 | {% endif %} 102 | RESUME_BASE {get_params} 103 | -------------------------------------------------------------------------------- /printer.cfg: -------------------------------------------------------------------------------- 1 | # This configuration file is only available for MKS SGEN_L V1.0 2 | # This file contains common pin mappings for the MKS SGEN_L board. To 3 | # use this config, the firmware should be compiled for the LPC1768. 4 | 5 | # See docs/Config_Reference.md for a description of parameters. 6 | 7 | [stepper_x] 8 | step_pin: P2.2 9 | dir_pin: P2.3 10 | enable_pin: !P2.1 11 | microsteps: 16 12 | rotation_distance: 32 13 | endstop_pin: !P1.29 # ^P1.28 for X-max 14 | #endstop_pin: tmc2209_stepper_x:virtual_endstop 15 | #homing_retract_dist: 0 16 | second_homing_speed: 2 17 | position_endstop: 0 18 | position_max: 270 19 | homing_speed: 16 20 | 21 | [stepper_y] 22 | step_pin: P0.19 23 | dir_pin: P0.20 24 | enable_pin: !P2.8 25 | microsteps: 16 26 | rotation_distance: 32 27 | endstop_pin: !P1.27 # ^P1.26 for Y-max 28 | #endstop_pin: tmc2209_stepper_y:virtual_endstop 29 | #homing_retract_dist: 0 30 | second_homing_speed: 2 31 | position_endstop: 0 32 | position_max: 270 33 | homing_speed: 16 34 | 35 | [stepper_z] 36 | step_pin: P0.22 37 | dir_pin: !P2.11 38 | enable_pin: !P0.21 39 | microsteps: 16 40 | rotation_distance: 4 41 | endstop_pin: ^P1.25 # ^P1.24 for Z-max 42 | position_endstop: 0 43 | position_max: 230 44 | 45 | [stepper_z1] 46 | step_pin: P0.1 47 | dir_pin: !P0.0 48 | enable_pin: !P0.10 49 | microsteps: 16 50 | rotation_distance: 4 51 | endstop_pin: ^P1.24 # ^P1.24 for Z-max 52 | 53 | 54 | [extruder] 55 | step_pin: P2.13 56 | dir_pin: !P0.11 57 | enable_pin: !P2.12 58 | rotation_distance: 4.682 59 | microsteps: 16 60 | full_steps_per_rotation: 200 61 | max_extrude_only_distance: 500 62 | max_extrude_only_velocity: 60 63 | max_extrude_only_accel: 600 64 | pressure_advance_smooth_time: 0.04 65 | pressure_advance: 0.09 66 | nozzle_diameter: 0.400 67 | filament_diameter: 1.750 68 | heater_pin: P2.7 69 | sensor_type: Generic 3950 70 | sensor_pin: P0.23 71 | min_temp: 0 72 | max_temp: 260 73 | 74 | #[extruder1] 75 | #step_pin: P0.1 76 | #dir_pin: P0.0 77 | #enable_pin: !P0.10 78 | #heater_pin: P2.6 79 | #sensor_pin: P0.25 80 | #... 81 | 82 | [heater_bed] 83 | heater_pin: P2.5 84 | sensor_type: Generic 3950 85 | sensor_pin: P0.24 86 | min_temp: 0 87 | max_temp: 100 88 | 89 | [fan] 90 | pin: P2.4 91 | cycle_time: 0.05 92 | 93 | [heater_fan my_nozzle_fan] 94 | pin: P2.6 95 | cycle_time: 0.05 96 | fan_speed: 1 97 | heater_temp: 50.0 98 | heater: extruder,heater_bed 99 | 100 | #[controller_fan my_controller_fan] 101 | #pin: P2.6 102 | #cycle_time: 0.05 103 | #fan_speed: 1 104 | #idle_timeout: 30 105 | #stepper:stepper_x,stepper_y,stepper_z,stepper_z1 106 | 107 | 108 | 109 | 110 | [printer] 111 | kinematics: corexy 112 | max_velocity: 200 113 | max_accel: 3000 114 | #max_accel_to_decel: 3000 115 | max_z_velocity: 6 116 | max_z_accel: 80 117 | 118 | #[force_move] 119 | #enable_force_move: True 120 | # Set to true to enable FORCE_MOVE and SET_KINEMATIC_POSITION 121 | # extended G-Code commands. The default is false. 122 | 123 | 124 | ######################################## 125 | # TMC2209 configuration 126 | ######################################## 127 | 128 | [tmc2209 stepper_x] 129 | uart_pin: P1.1 130 | run_current: 1.2 131 | interpolate: True 132 | #hold_current: 0.500 133 | #driver_PWM_FREQ: 3 134 | stealthchop_threshold: 0 135 | #diag_pin: ^P1.29 # Set to MCU pin connected to TMC DIAG pin 136 | #driver_SGTHRS: 62 # 255 is most sensitive value, 0 is least sensitive 137 | 138 | 139 | [tmc2209 stepper_y] 140 | uart_pin: P1.8 141 | run_current: 1.2 142 | interpolate: True 143 | #hold_current: 0.500 144 | #driver_PWM_FREQ: 3 145 | stealthchop_threshold: 0 146 | #diag_pin: ^P1.27 # Set to MCU pin connected to TMC DIAG pin 147 | #driver_SGTHRS: 63 # 255 is most sensitive value, 0 is least sensitive 148 | 149 | [tmc2209 stepper_z] 150 | uart_pin: P1.10 151 | run_current: 0.6 152 | #hold_current: 0.8 153 | interpolate: True 154 | stealthchop_threshold: 999999 155 | 156 | [tmc2209 stepper_z1] 157 | uart_pin: P1.17 158 | run_current: 0.6 159 | #hold_current: 0.8 160 | interpolate: True 161 | stealthchop_threshold: 999999 162 | 163 | 164 | [tmc2209 extruder] 165 | uart_pin: P1.15 166 | run_current: 0.350 167 | interpolate: True 168 | #hold_current: 0 169 | stealthchop_threshold: 999999 170 | 171 | 172 | #[tmc2209 extruder1] 173 | #uart_pin: P1.17 174 | #run_current: 0.800 175 | #hold_current: 0.500 176 | #stealthchop_threshold: 999999 177 | 178 | 179 | [mcu] 180 | serial: /dev/ttyACM0 181 | 182 | 183 | [temperature_sensor phone] 184 | sensor_path: /sys/class/thermal/thermal_zone11/temp 185 | sensor_type: temperature_host 186 | min_temp: 10 187 | max_temp: 80 188 | 189 | 190 | ### SDcard use the motherboard EXP_2 interface 191 | ### The bus number is ssp1 192 | ### SCK=P0.7，CS=P0.6，MISO=0.8，MOSI=0.9 193 | 194 | ### ADXL345 use the motherboard EXP_1 interface 195 | ### The bus number is ssp0 196 | ### SCK=P0.15，CS=P0.16，MISO=0.17，MOSI=0.18 197 | 198 | [adxl345] 199 | cs_pin: P0.16 200 | spi_bus: ssp0 201 | axes_map: x,z,-y 202 | 203 | [resonance_tester] 204 | accel_chip: adxl345 205 | probe_points: 206 | 135,135,10 # an example 207 | 208 | 209 | [include fluidd.cfg] 210 | 211 | 212 | [include homing_override.cfg] 213 | 214 | 215 | #*# <---------------------- SAVE_CONFIG ----------------------> 216 | #*# DO NOT EDIT THIS BLOCK OR BELOW. The contents are auto-generated. 217 | #*# 218 | #*# [heater_bed] 219 | #*# control = pid 220 | #*# pid_kp = 75.166 221 | #*# pid_ki = 1.190 222 | #*# pid_kd = 1186.691 223 | #*# 224 | #*# [extruder] 225 | #*# control = pid 226 | #*# pid_kp = 21.152 227 | #*# pid_ki = 0.993 228 | #*# pid_kd = 112.633 229 | #*# 230 | #*# [input_shaper] 231 | #*# shaper_type_x = mzv 232 | #*# shaper_freq_x = 70.0 233 | #*# shaper_type_y = mzv 234 | #*# shaper_freq_y = 51.2 235 | -------------------------------------------------------------------------------- /configuration_klipper_family.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | serial_port="/dev/ttyACM0" 4 | while getopts p: flag 5 | do 6 | case "${flag}" in 7 | p) serial_port=${OPTARG};; 8 | esac 9 | done 10 | 11 | echo "Using serial port ${serial_port}" 12 | 13 | if [ "$(id -u)" = "0" ] 14 | then 15 | echo "Start script as user!" 16 | exit 1 17 | fi 18 | 19 | if ! [[ -e "./klippy-env" && -e "./moonraker-env" && -e "./fluidd" && -e "./.KlipperScreen-env" ]] 20 | then 21 | echo "First use kiauh to install the klipper family!" 22 | exit 1 23 | fi 24 | 25 | if [ ! -c "$serial_port" ] 26 | then 27 | echo "Please connect your phone to the printer " 28 | exit 1 29 | fi 30 | 31 | ### environment 32 | echo "Initializing environment variables" 33 | 34 | KLIPPER_USER=$USER 35 | 36 | ETC_DEFAULT_KLIPPER=/etc/default/klipper 37 | ETC_DEFAULT_MOONRAKER=/etc/default/moonraker 38 | 39 | ETC_INIT_KLIPPER=/etc/init.d/klipper 40 | ETC_INIT_MOONRAKER=/etc/init.d/moonraker 41 | 42 | USR_LOCAL_BIN_XTERM=/usr/local/bin/xterm 43 | 44 | POWERFIX="/usr/bin/powerfix" 45 | POWERFIX_START="/etc/init.d/powerfix" 46 | 47 | ### packages 48 | echo "Installing required packages" 49 | 50 | sudo apt install -y inotify-tools fonts-wqy-zenhei iw 51 | 52 | ### Configuration for power 53 | sudo tee "$POWERFIX" </dev/null 2>&1 58 | sudo iw wlan0 set power_save off 59 | sudo unchroot settings put global auto_time 0 60 | sleep 1 61 | sudo unchroot settings put global auto_time 1 62 | EOF 63 | sudo chmod +x "$POWERFIX" 64 | 65 | sudo tee "$POWERFIX_START" </dev/null 2>&1 90 | sleep 10 91 | /home/$KLIPPER_USER/.KlipperScreen-env/bin/python /home/$KLIPPER_USER/KlipperScreen/screen.py -c \$KLIPPERSCREEN_CONFIG -l \$KLIPPERSCREEN_LOG 92 | EOF 93 | sudo chmod +x $USR_LOCAL_BIN_XTERM 94 | 95 | ### Configuration for /etc/init.d/klipper 96 | sudo tee "$ETC_DEFAULT_KLIPPER" </dev/null 2>&1 61 | sudo iw wlan0 set power_save off 62 | sudo unchroot settings put global auto_time 0 63 | sleep 1 64 | sudo unchroot settings put global auto_time 1 65 | EOF 66 | sudo chmod +x "$POWERFIX" 67 | 68 | sudo tee "$POWERFIX_START" </dev/null 2>&1 93 | sleep 10 94 | /home/$KLIPPER_USER/.KlipperScreen-env/bin/python /home/$KLIPPER_USER/KlipperScreen/screen.py -c \$KLIPPERSCREEN_CONFIG -l \$KLIPPERSCREEN_LOG 95 | EOF 96 | sudo chmod +x $USR_LOCAL_BIN_XTERM 97 | 98 | ### Configuration for ttyACM0 99 | sudo tee "$TTYFIX" <&2 155 | exit 1 156 | ;; 157 | esac 158 | 159 | exit 0 160 | EOF 161 | sudo chmod +x "$TTYFIX_START" 162 | 163 | ### Configuration for /etc/init.d/klipper 164 | sudo tee "$ETC_DEFAULT_KLIPPER" < 402 | 403 | 或 404 | 405 | dmesg | grep klipper 406 | 407 | 仔细查找以上命令的输出信息，以找到正确的串口设备名称。 408 | 409 | 410 | 411 | ***祝大家每一次3D打印都能成功！！！*** 412 | 413 | 414 | **备注：** 415 | 416 | **构建和刷写SD卡固件请参考：https://www.klipper3d.org/Installation.html** 417 | 418 | **SD卡固件在线更新请参考：https://www.klipper3d.org/SDCard_Updates.html** 419 | 420 | 421 | 422 | 423 | -------------------------------------------------------------------------------- /README_en.md: -------------------------------------------------------------------------------- 1 | # klipper-on-android 2 | 3 | 4 | **Run klipper, moonraker, fluidd, KlipperScreen on android , one-click script for quick configuration.** 5 | 6 | 7 | ***Standing on the shoulders of giants!!!*** 8 | 9 | ***grateful:*** 10 | 11 | ***Original klipper, moonraker and xterm init scripts by @d4rk50ul1 (https://github.com/d4rk50ul1/klipper-on-android)*** 12 | 13 | ***Original ttyACM0 initialization script by @CODERUS (https://gist.github.com/CODERUS/a5ec4a456f5b58186cbebb66a8542a2e)*** 14 | 15 | 16 | **video tutorial: https://youtu.be/s1tdqg6ke4w** 17 | 18 | **Foreword:** 19 | 20 | **Special Note:** 21 | The installation scheme in this tutorial uses Android 5 or above. If the system is lower than Android 5, you need to use a lower version of linuxdeploy. There may be compatibility issues related to permissions for systems higher than Android 9, but this is not always the case. It is still worth a try. In addition, if openssh fails to start automatically (as shown by being unable to use ssh to connect to the debian system), this is generally a compatibility issue between the Android kernel and linuxdeploy. You need to change to an Android system with a different kernel version (note, a different kernel version). It is recommended to use AOSP or other native Android systems. 22 | 23 | 0. Although the steps in this tutorial are as comprehensive and detailed as possible, 24 | it is not suitable for complete novice users because it involves basic linux usage and klipper configuration. 25 | 26 | 1. The AndroidOS in this tutorial must be rooted. Because the root method of each mobile phone hardware and OS is different, 27 | there are many tutorials on the Internet, so I won't repeat them here. 28 | 29 | 2. The software and hardware environment of this tutorial: 30 | 31 | Xiaomi 2S(aries) 32 | 33 | 16G ROM, 2G RAM 34 | 35 | Run MOKEE9.0 OS based on android9.0 36 | 37 | The OS has used MOKEE's official patch to obtain root privileges 38 | 39 | flash and root refer to the official tutorial: 40 | 41 | ROM download and flash: https://download.mokeedev.com/aries.html 42 | 43 | Get root permissions: https://bbs.mokeedev.com/t/topic/6577 44 | 45 | 3. In theory, this tutorial can be applied to any rooted Android phone, to be tested. 46 | 47 | 4. In theory, the debian installed after installing the proroot container in termux can also be used, to be tested. 48 | 49 | 5. The printer control motherboard model: MKS SGEN-L V1.0, the klipper firmware has been flashed in the SD card in the motherboard. 50 | 51 | 52 | **Features of this tutorial:** 53 | 54 | 1. Use a separate APP to install the linux under the graphical interface, configure the OS to automatically restart, etc. Easy to manage and use. 55 | 56 | 2. klipper still uses the popular kiauh script to install, upgrade or uninstall. The KlipperScreen interface of the mobile phone or the web interface can be used to upgrade each module. 57 | 58 | 3. Use a one-click script to quickly configure the klipper family bucket, which is convenient and fast. 59 | 60 | 4. Based on my own experience, I modified and customized the basic configuration files of the klipper family bucket, and some key configurations are more practical. 61 | 62 | 5. After installation, no error is reported, and services such as klipper and moonraker can be individually controlled to start, restart, and close. 63 | 64 | 6. The user experience is basically the same as that of the Raspberry Pi, including input shaping and pressure compensation, mobile phone CPU temperature display, and online upgrade of printer motherboard firmware SD card. 65 | 66 | ################################################## ################################################## ### 67 | 68 | ***The installation process is long and the phone needs to be connected to the charger! ! ! ! ! !*** 69 | 70 | ***This tutorial assumes:*** 71 | 72 | ***Android phone is rooted! ! ! ! ! !*** 73 | 74 | ***The klipper firmware has been flashed in the SD card in the motherboard: [klipper(MKS SGEN-L V1.0).bin](https://github.com/gaifeng8864/klipper-on-android/blob/main/klipper(MKS%20SGEN-L%20V1.0).bin?raw=true)*** 75 | 76 | ***(The klipper firmware in SD card needs to be compiled according to the motherboard model, the firmware in this link is only for MKS SGEN-L V1.0)*** 77 | 78 | Required software: 79 | 80 | mobile phone: 81 | 82 | XServer-XSDL-1.20.51.apk (required) Download link: https://sourceforge.net/projects/libsdl-android/files/apk/XServer-XSDL/ 83 | 84 | linuxdeploy-2.6.0-259.apk (required) Download link: https://github.com/meefik/linuxdeploy/releases/download/2.6.0/linuxdeploy-2.6.0-259.apk 85 | 86 | kerneladiutor_248.apk (Enable all CPU cores. If the Debian system in linuxdeploy cannot recognize all CPU cores, it is recommended to install) Download link: https://f-droid.org/en/packages/com.nhellfire.kerneladiutor/ 87 | 88 | termux_118.apk (optional, install when needed) download link: https://github.com/termux/termux-app/releases/tag/v0.118.0 89 | 90 | computer: 91 | 92 | Xshell (required) official website address: https://www.netsarang.com/en/xshell/ 93 | 94 | Xftp (optional, recommended installation): https://www.netsarang.com/en/xftp/ 95 | 96 | ## 0. Install XServer-XSDL ## 97 | 98 | The installation of XServer-XSDL is relatively simple, just follow the OS prompt and go directly to the next step. 99 | 100 | Note: After the installation is complete, you need to click the "Change Device Settings" button at the top of the screen on the first startup interface to enter the setting interface, and then click "Mouse Simulation" --- "Mouse Simulation Mode" --- "Desktop version, no simulation" , then scroll down to the bottom and click Done. Otherwise the touch cannot be used. 101 | 102 | If you miss the interface for the first startup, just close XServer-XSDL running in the background and start XServer-XSDL again. 103 | 104 | ## 1. Install kerneladiutor ## 105 | 106 | Qualcomm processors have an MPD power consumption control scheme by default. By default, some CPU cores are turned off to control power consumption. 107 | The biggest problem caused by this is that in the debian , it will be found that the processor with 4 cores only recognizes 2 cores in most cases. 108 | kerneladiutor is a simple and easy-to-use Android kernel management software, used to adjust the frequency and performance of CPU and GPU. All CPU cores can be forcibly turned on to make full use of the performance of the phone.After actual testing, it was found that newer Android phones can be automatically recognized by Debian installed in LinuxDeploy for all CPU cores. Therefore, it is recommended not to install it initially, and install it later if necessary. 109 | 110 | ## 2. Install linuxdeploy ## 111 | 112 | Install the apk file according to the OS prompts. After the installation is complete, open the software and click on the upper left corner of the main interface " 113 | ![三横杠](https://user-images.githubusercontent.com/16047447/202127479-5174b558-7677-4cb6-8b69-dfbd6ef8e11b.png)"Open the software settings: 114 | 115 | Lock screen (no) 116 | 117 | Lock Wi-Fi (yes) 118 | 119 | Wake lock (yes) 120 | 121 | Autostart (yes) 122 | 123 | Autostart delay (5) (set as needed, increase the number if you want to start later) 124 | 125 | Track network changes (yes) 126 | 127 | Other options remain default! ! ! ! ! ! ! ! ! ! 128 | 129 | ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! 130 | 131 | 132 | ## 3. Install debian ## 133 | 134 | After setting, return to the main interface, click on the lower right corner "![滑动开关](https://user-images.githubusercontent.com/16047447/202127702-f66eca3e-0300-40f5-a1f0-43e42236b7fc.png)"Open the Linux installation configuration. 135 | 136 | Distribution (Debian) 137 | 138 | Architecture (armhf) (Check your mobile phone processor model by yourself, if it supports 64 bits, choose arm64) 139 | 140 | Distribution suite (oldstable) 141 | 142 | Installation type (Directory) 143 | 144 | Installation path (/data/debian11) 145 | 146 | Username (print3D) (because it involves the path of the klipper configuration file, it is recommended to use this username) 147 | 148 | User password: (123456) (set whatever you want, as long as you can remember it) 149 | 150 | INIT (enable) 151 | 152 | Init system (sysV) 153 | 154 | SSH (enabled) (must be enabled, otherwise it will not be able to connect to the linux) 155 | 156 | GUI (enabled) 157 | 158 | Graphics subsystem (X11) 159 | 160 | Desktop environment (XTerm) 161 | 162 | Other options remain default! ! ! ! ! ! ! ! ! ! 163 | 164 | ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! 165 | 166 | 167 | After the configuration is complete, return to the main interface 168 | 169 | Click on the upper right corner "![三竖点](https://user-images.githubusercontent.com/16047447/202128541-77af60ad-6f61-4c7d-8e40-4b020f144e1f.png) 170 | " Click "Install" (The installation process is relatively long, about 5-15 minutes depending on the network situation) 171 | 172 | When "<<< deploy" appears at the bottom of the interface, the installation is complete 173 | 174 | Click "STOP" at the bottom of the main interface, "<<< stop" will appear, and then click "START" (this step is necessary, otherwise the debian will not start) 175 | 176 | After the OS is started, use Xshell to connect to the debian (the IP address is displayed at the top of the main interface of the linuxdeploy software, the login name and password are set in the above steps, port 22, protocol ssh) 177 | 178 | At this point, the debian installation is complete! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! 179 | 180 | ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! 181 | 182 | ## 4.klipper installation environment configuration ## 183 | 184 | After logging in to the debian with ssh, execute the following command: 185 | 186 | sudo usermod -a -G aid_inet,aid_net_raw root 187 | 188 | ###Because of the chroot container permission problem on the Android , except for the initial login user, other users have no network permission by default, including the root user. This command can solve the problem that the root user cannot connect to the Internet when using the sudo command. 189 | 190 | sudo apt update 191 | 192 | ###Update packages 193 | 194 | sudo apt install -y git vim wget 195 | 196 | ###Install the necessary tools and software 197 | 198 | ## 5. Install klipper using kiauh ## 199 | 200 | cd ~ 201 | 202 | ###Enter the login user's home directory 203 | 204 | 205 | git clone https://github.com/th33xitus/kiauh.git 206 | 207 | ###Official kiauh script address 208 | 209 | 210 | ./kiauh/kiauh.sh 211 | 212 | ###Start the script to start installing the klipper family bucket 213 | 214 | 215 | ### Need to install klipper, moonraker, fluidd (one-click script does not support Mainsail configuration), KlipperScreen these 4 components. 216 | Every time a component is installed, it will prompt that the service cannot be started. This is the reason why the Android initialization system is not compatible with the klipper family bucket service startup method. Don’t worry about it. If it can be started, there is no need to configure it with a one-click script. 217 | Component installation involves part of the compilation process, which takes a long time, so wait patiently. As long as each script can be automatically installed to the end, there is basically no problem. 218 | 219 | ## 6. klipper family bucket configuration ## 220 | 221 | Use Xftp or the command line to enter the following path: 222 | 223 | /home/print3D/printer_data/config/ 224 | 225 | 226 | Backup the fluidd.cfg, moonraker.conf, printer.cfg inside and delete the original files. 227 | 228 | cd ~ 229 | 230 | 231 | ### Enter the login user's home directory 232 | 233 | Download the four files fluidd.cfg, homing_override.cfg, moonraker.conf, printer.cfg in this warehouse and put them in the /home/print3D/printer_data/config/ path. 234 | 235 | Or if you want to save trouble, execute the following command directly: 236 | 237 | sudo wget -P /home/print3D/printer_data/config/ https://raw.githubusercontent.com/gaifeng8864/klipper-on-android/main/fluidd.cfg 238 | 239 | sudo wget -P /home/print3D/printer_data/config/ https://raw.githubusercontent.com/gaifeng8864/klipper-on-android/main/homing_override.cfg 240 | 241 | sudo wget -P /home/print3D/printer_data/config/ https://raw.githubusercontent.com/gaifeng8864/klipper-on-android/main/moonraker.conf 242 | 243 | sudo wget -P /home/print3D/printer_data/config/ https://raw.githubusercontent.com/gaifeng8864/klipper-on-android/main/printer.cfg 244 | 245 | 246 | ***Note:*** printer.cfg This configuration file needs to be changed according to the model of the printer control board. For details, please refer to the configuration instructions of each motherboard. 247 | 248 | 249 | 250 | ***! ! ! ! ! ! Power on the main board of the printer, and connect the mobile phone and the main board of the printer with an OTG cable! ! ! ! ! !*** 251 | 252 | Run the following command to find the serial device path and user group of the printer motherboard identified in the Android phone: 253 | 254 | ls -al /dev/ 255 | 256 | The output information is generally like this: 257 | 258 | crw-rw----. 1 aid_radio aid_radio 166, 0 6 29 11:57 ttyACM0 259 | 260 | In the above output information, the second aid_radio is the user group of the serial device, and ttyACM0 is the name of the serial device. The complete serial device path is /dev/ttyACM0 261 | 262 | ***Note! ! ! Different printer motherboards may have different names and user groups in different Android phones, please confirm carefully! ! !*** 263 | 264 | ***If the information output after running the command " ls -al /dev/ " is similar to the following:*** 265 | 266 | crw-rw----. 1 root root 166, 0 6 29 11:57 ttyACM0 267 | 268 | ***This means that " ttyACM0 " belongs to the root user group. The following operations in step 6 will no longer apply. Please jump directly to step 7. What to do if " ttyACM0 " belongs to the root user group*** 269 | 270 | If ttyACM0 is confirmed to belong to the non-root user group, run the following command to add user print3D to the user group of the serial device, so that user print3D obtains read and write permissions to the serial device. 271 | 272 | sudo usermod -a -G aid_radio print3D 273 | 274 | Continue to execute the following command: 275 | 276 | cd ~ 277 | 278 | ###Enter the login user's home directory 279 | 280 | sudo wget https://raw.githubusercontent.com/gaifeng8864/klipper-on-android/main/configuration_klipper_family.sh 281 | 282 | bash configuration_klipper_family.sh 283 | 284 | ***Note! ! ! If your serial port device path is not the default /dev/ttyACM0*** 285 | 286 | Please execute the following command: 287 | 288 | bash configuration_klipper_family.sh -p "identified serial port device path" 289 | 290 | After the execution is completed, restart the phone. If there is no problem, the klipper family bucket and XServer-XSDL will automatically start and connect to the printer, and the KlipperScreen classic interface will be displayed on the screen. 291 | 292 | ## 7. What to do if " ttyACM0 " belongs to the root user group 293 | 294 | Execute the following command: 295 | 296 | cd ~ 297 | 298 | ###Enter the home directory of the logged-in user 299 | 300 | sudo wget https://raw.githubusercontent.com/gaifeng8864/klipper-on-android/main/configuration_klipper_family_V1.0.sh 301 | 302 | bash configuration_klipper_family_V1.0.sh 303 | 304 | ***Note! ! ! If your serial port device path is not the default /dev/ttyACM0*** 305 | 306 | Please execute the following command: 307 | 308 | bash configuration_klipper_family_V1.0.sh -p "identified serial port device path" 309 | 310 | After the execution is completed, restart the phone. If there is no problem, the klipper family bucket and XServer-XSDL will automatically start and connect to the printer, and the KlipperScreen classic interface will be displayed on the screen. 311 | 312 | 313 | ## Tips!!! 314 | 315 | If it is difficult to confirm the name of the serial device, you can use the following method: 316 | 317 | 1.Disconnect the printer motherboard from the Android phone, restart the phone, enter debian, run the following command and save the output: 318 | 319 | ls -a /dev/ 320 | 321 | 2.Connect the printer motherboard to the Android phone, restart the phone, enter debian, run the following command and save the output: 322 | 323 | ls -a /dev/ 324 | 325 | 3.Compare the results of step 1 and step 2 to easily confirm whether the device is correctly identified and the device name. 326 | 327 | You can also use the following command to confirm whether the device is correctly connected to the Android phone: 328 | 329 | dmesg | grep usb 330 | 331 | or 332 | 333 | dmesg | grep acm 334 | 335 | or 336 | 337 | dmesg | grep 338 | 339 | or 340 | 341 | dmesg | grep klipper 342 | 343 | Carefully look for the output information of the above command to find the correct serial device name. 344 | 345 | 346 | I wish you every success in 3D printing! ! ! 347 | 348 | 349 | 350 | **Remark:** 351 | 352 | **For building and flashing SD card firmware, please refer to: https://www.klipper3d.org/Installation.html** 353 | 354 | **For online update of SD card firmware, please refer to: https://www.klipper3d.org/SDCard_Updates.html** 355 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------