mirror of
https://github.com/dw-0/kiauh.git
synced 2026-05-11 03:38:18 +05:00
Compare commits
1 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
 github-actions[bot]
|
f7acd6d142 |
@@ -1,15 +0,0 @@
|
|||||||
root = true
|
|
||||||
|
|
||||||
[*]
|
|
||||||
indent_style = space
|
|
||||||
indent_size = 4
|
|
||||||
insert_final_newline = true
|
|
||||||
trim_trailing_whitespace = true
|
|
||||||
charset = utf-8
|
|
||||||
end_of_line = lf
|
|
||||||
|
|
||||||
[*.py]
|
|
||||||
max_line_length = 88
|
|
||||||
|
|
||||||
[*.{sh,yml,yaml,json}]
|
|
||||||
indent_size = 2
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
# These are supported funding model platforms
|
|
||||||
|
|
||||||
github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
|
|
||||||
patreon: # Replace with a single Patreon username
|
|
||||||
open_collective: # Replace with a single Open Collective username
|
|
||||||
ko_fi: dw__0
|
|
||||||
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
|
|
||||||
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
|
|
||||||
liberapay: # Replace with a single Liberapay username
|
|
||||||
issuehunt: # Replace with a single IssueHunt username
|
|
||||||
otechie: # Replace with a single Otechie username
|
|
||||||
custom: https://paypal.me/dwillner0
|
|
||||||
@@ -1,50 +0,0 @@
|
|||||||
name: Bug report
|
|
||||||
description: Create a report to help us improve
|
|
||||||
labels: ["bug"]
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
This issue form is for reporting bugs only!
|
|
||||||
If you have a feature request, please use [feature_request](/new?template=feature_request.yml)
|
|
||||||
- type: textarea
|
|
||||||
id: distro
|
|
||||||
attributes:
|
|
||||||
label: Linux Distribution
|
|
||||||
description: >-
|
|
||||||
The linux distribution the issue occured on
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: what-happened
|
|
||||||
attributes:
|
|
||||||
label: What happened
|
|
||||||
description: >-
|
|
||||||
A clear and concise description of what the bug is.
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: expected-behavior
|
|
||||||
attributes:
|
|
||||||
label: What did you expect to happen
|
|
||||||
description: >-
|
|
||||||
A clear and concise description of what you expected to happen.
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: repro-steps
|
|
||||||
attributes:
|
|
||||||
label: How to reproduce
|
|
||||||
description: >-
|
|
||||||
Minimal and precise steps to reproduce this bug.
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: additional-info
|
|
||||||
attributes:
|
|
||||||
label: Additional information
|
|
||||||
description: |
|
|
||||||
If you have any additional information for us, use the field below.
|
|
||||||
|
|
||||||
Please note, you can attach screenshots or screen recordings here, by
|
|
||||||
dragging and dropping files in the field below.
|
|
||||||
@@ -1,5 +0,0 @@
|
|||||||
blank_issues_enabled: false
|
|
||||||
contact_links:
|
|
||||||
- name: Klipper Discord
|
|
||||||
url: https://discord.klipper3d.org/
|
|
||||||
about: Quickest way to get in contact
|
|
||||||
@@ -1,40 +0,0 @@
|
|||||||
name: Feature request
|
|
||||||
description: Suggest an idea for this project
|
|
||||||
labels: ["feature request"]
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
This issue form is for feature requests only!
|
|
||||||
If you've found a bug, please use [bug_report](/new?template=bug_report.yml)
|
|
||||||
- type: textarea
|
|
||||||
id: problem-description
|
|
||||||
attributes:
|
|
||||||
label: Is your feature request related to a problem? Please describe
|
|
||||||
description: >-
|
|
||||||
A clear and concise description of what the problem is.
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: solution-description
|
|
||||||
attributes:
|
|
||||||
label: Describe the solution you'd like
|
|
||||||
description: >-
|
|
||||||
A clear and concise description of what you want to happen.
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: possible-alternatives
|
|
||||||
attributes:
|
|
||||||
label: Describe alternatives you've considered
|
|
||||||
description: >-
|
|
||||||
A clear and concise description of any alternative solutions or features you've considered.
|
|
||||||
- type: textarea
|
|
||||||
id: additional-info
|
|
||||||
attributes:
|
|
||||||
label: Additional information
|
|
||||||
description: |
|
|
||||||
If you have any additional information for us, use the field below.
|
|
||||||
|
|
||||||
Please note, you can attach screenshots or screen recordings here, by
|
|
||||||
dragging and dropping files in the field below.
|
|
||||||
@@ -1,33 +0,0 @@
|
|||||||
name: Release - Fast-Forward and Tag
|
|
||||||
on:
|
|
||||||
workflow_dispatch:
|
|
||||||
inputs:
|
|
||||||
tag_name:
|
|
||||||
description: 'Provide a tag name (e.g. v1.0.0)'
|
|
||||||
required: true
|
|
||||||
type: string
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
ff-and-tag:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
permissions:
|
|
||||||
contents: write
|
|
||||||
steps:
|
|
||||||
- name: Checkout
|
|
||||||
uses: actions/checkout@v4
|
|
||||||
with:
|
|
||||||
fetch-depth: 0
|
|
||||||
ref: 'master'
|
|
||||||
- name: Merge Fast Forward
|
|
||||||
uses: MaximeHeckel/github-action-merge-fast-forward@v1.1.0
|
|
||||||
with:
|
|
||||||
branchtomerge: origin/develop
|
|
||||||
branch: master
|
|
||||||
env:
|
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
- name: Create and Push Tag
|
|
||||||
run: |
|
|
||||||
git tag ${{ inputs.tag_name }}
|
|
||||||
git push origin ${{ inputs.tag_name }}
|
|
||||||
env:
|
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
-13
@@ -1,13 +0,0 @@
|
|||||||
.idea
|
|
||||||
.vscode
|
|
||||||
.pytest_cache
|
|
||||||
.jupyter
|
|
||||||
*.ipynb
|
|
||||||
*.ipynb_checkpoints
|
|
||||||
*.tmp
|
|
||||||
__pycache__
|
|
||||||
.kiauh-env
|
|
||||||
*.code-workspace
|
|
||||||
*.iml
|
|
||||||
kiauh.cfg
|
|
||||||
klipper_repos.txt
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
source=scripts
|
|
||||||
|
|
||||||
enable=avoid-nullary-conditions
|
|
||||||
enable=deprecate-which
|
|
||||||
enable=quote-safe-variables
|
|
||||||
enable=require-variable-braces
|
|
||||||
enable=require-double-brackets
|
|
||||||
|
|
||||||
# SC2162: `read` without `-r` will mangle backslashes.
|
|
||||||
# https://github.com/koalaman/shellcheck/wiki/SC2162
|
|
||||||
disable=SC2162
|
|
||||||
|
|
||||||
# SC2164: Use `cd ... || exit` in case `cd` fails
|
|
||||||
# https://github.com/koalaman/shellcheck/wiki/SC2164
|
|
||||||
disable=SC2164
|
|
||||||
@@ -0,0 +1,707 @@
|
|||||||
|
|
||||||
|
<!doctype html>
|
||||||
|
<html lang="en" class="no-js">
|
||||||
|
<head>
|
||||||
|
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||||
|
|
||||||
|
<meta name="description" content="Documentation for the Klipper Installation And Update Helper">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="icon" href="/assets/logo.png">
|
||||||
|
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.18">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<title>KIAUH Documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="/assets/stylesheets/main.7e37652d.min.css">
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="/assets/stylesheets/palette.06af60db.min.css">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
|
||||||
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
|
||||||
|
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="/assets/_mkdocstrings.css">
|
||||||
|
|
||||||
|
<script>__md_scope=new URL("/",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</head>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="blue-grey" data-md-color-accent="cyan">
|
||||||
|
|
||||||
|
|
||||||
|
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
|
||||||
|
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
|
||||||
|
<label class="md-overlay" for="__drawer"></label>
|
||||||
|
<div data-md-component="skip">
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<div data-md-component="announce">
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<header class="md-header md-header--shadow" data-md-component="header">
|
||||||
|
<nav class="md-header__inner md-grid" aria-label="Header">
|
||||||
|
<a href="/." title="KIAUH Documentation" class="md-header__button md-logo" aria-label="KIAUH Documentation" data-md-component="logo">
|
||||||
|
|
||||||
|
<img src="/assets/logo.png" alt="logo">
|
||||||
|
|
||||||
|
</a>
|
||||||
|
<label class="md-header__button md-icon" for="__drawer">
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
|
||||||
|
</label>
|
||||||
|
<div class="md-header__title" data-md-component="header-title">
|
||||||
|
<div class="md-header__ellipsis">
|
||||||
|
<div class="md-header__topic">
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
KIAUH Documentation
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
<div class="md-header__topic" data-md-component="header-topic">
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
<form class="md-header__option" data-md-component="palette">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="blue-grey" data-md-color-accent="cyan" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
|
||||||
|
|
||||||
|
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3zm3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95zm-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31"/></svg>
|
||||||
|
</label>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="blue-grey" data-md-color-accent="cyan" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
|
||||||
|
|
||||||
|
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 7a5 5 0 0 1 5 5 5 5 0 0 1-5 5 5 5 0 0 1-5-5 5 5 0 0 1 5-5m0 2a3 3 0 0 0-3 3 3 3 0 0 0 3 3 3 3 0 0 0 3-3 3 3 0 0 0-3-3m0-7 2.39 3.42C13.65 5.15 12.84 5 12 5s-1.65.15-2.39.42zM3.34 7l4.16-.35A7.2 7.2 0 0 0 5.94 8.5c-.44.74-.69 1.5-.83 2.29zm.02 10 1.76-3.77a7.131 7.131 0 0 0 2.38 4.14zM20.65 7l-1.77 3.79a7.02 7.02 0 0 0-2.38-4.15zm-.01 10-4.14.36c.59-.51 1.12-1.14 1.54-1.86.42-.73.69-1.5.83-2.29zM12 22l-2.41-3.44c.74.27 1.55.44 2.41.44.82 0 1.63-.17 2.37-.44z"/></svg>
|
||||||
|
</label>
|
||||||
|
|
||||||
|
|
||||||
|
</form>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<label class="md-header__button md-icon" for="__search">
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
|
||||||
|
</label>
|
||||||
|
<div class="md-search" data-md-component="search" role="dialog">
|
||||||
|
<label class="md-search__overlay" for="__search"></label>
|
||||||
|
<div class="md-search__inner" role="search">
|
||||||
|
<form class="md-search__form" name="search">
|
||||||
|
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
|
||||||
|
<label class="md-search__icon md-icon" for="__search">
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
|
||||||
|
</label>
|
||||||
|
<nav class="md-search__options" aria-label="Search">
|
||||||
|
|
||||||
|
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
|
||||||
|
</button>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
</form>
|
||||||
|
<div class="md-search__output">
|
||||||
|
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
|
||||||
|
<div class="md-search-result" data-md-component="search-result">
|
||||||
|
<div class="md-search-result__meta">
|
||||||
|
Initializing search
|
||||||
|
</div>
|
||||||
|
<ol class="md-search-result__list" role="presentation"></ol>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div class="md-header__source">
|
||||||
|
<a href="https://github.com/dw-0/kiauh" title="Go to repository" class="md-source" data-md-component="source">
|
||||||
|
<div class="md-source__icon md-icon">
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path fill="currentColor" d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
|
||||||
|
</div>
|
||||||
|
<div class="md-source__repository">
|
||||||
|
dw-0/kiauh
|
||||||
|
</div>
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
</header>
|
||||||
|
|
||||||
|
<div class="md-container" data-md-component="container">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<main class="md-main" data-md-component="main">
|
||||||
|
<div class="md-main__inner md-grid">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
|
||||||
|
<div class="md-sidebar__scrollwrap">
|
||||||
|
<div class="md-sidebar__inner">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
|
||||||
|
<label class="md-nav__title" for="__drawer">
|
||||||
|
<a href="/." title="KIAUH Documentation" class="md-nav__button md-logo" aria-label="KIAUH Documentation" data-md-component="logo">
|
||||||
|
|
||||||
|
<img src="/assets/logo.png" alt="logo">
|
||||||
|
|
||||||
|
</a>
|
||||||
|
KIAUH Documentation
|
||||||
|
</label>
|
||||||
|
|
||||||
|
<div class="md-nav__source">
|
||||||
|
<a href="https://github.com/dw-0/kiauh" title="Go to repository" class="md-source" data-md-component="source">
|
||||||
|
<div class="md-source__icon md-icon">
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path fill="currentColor" d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
|
||||||
|
</div>
|
||||||
|
<div class="md-source__repository">
|
||||||
|
dw-0/kiauh
|
||||||
|
</div>
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<ul class="md-nav__list" data-md-scrollfix>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="/." class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Home
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
|
||||||
|
|
||||||
|
|
||||||
|
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Installation
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-nav__icon md-icon"></span>
|
||||||
|
</label>
|
||||||
|
|
||||||
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
|
||||||
|
<label class="md-nav__title" for="__nav_2">
|
||||||
|
<span class="md-nav__icon md-icon"></span>
|
||||||
|
Installation
|
||||||
|
</label>
|
||||||
|
<ul class="md-nav__list" data-md-scrollfix>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="/setup/raspberry-pi-setup/" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Raspberry Pi Setup
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="/setup/installation/" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Installing KIAUH
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="/configuration.md" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Configuration
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
|
||||||
|
|
||||||
|
|
||||||
|
<div class="md-nav__link md-nav__container">
|
||||||
|
<a href="/extensions/" class="md-nav__link ">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Extensions
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
|
||||||
|
|
||||||
|
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
|
||||||
|
<span class="md-nav__icon md-icon"></span>
|
||||||
|
</label>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
|
||||||
|
<label class="md-nav__title" for="__nav_4">
|
||||||
|
<span class="md-nav__icon md-icon"></span>
|
||||||
|
Extensions
|
||||||
|
</label>
|
||||||
|
<ul class="md-nav__list" data-md-scrollfix>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="/extensions/gcode-shell-command/" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
G-Code Shell Command Extension
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
|
||||||
|
|
||||||
|
|
||||||
|
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Development
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-nav__icon md-icon"></span>
|
||||||
|
</label>
|
||||||
|
|
||||||
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
||||||
|
<label class="md-nav__title" for="__nav_5">
|
||||||
|
<span class="md-nav__icon md-icon"></span>
|
||||||
|
Development
|
||||||
|
</label>
|
||||||
|
<ul class="md-nav__list" data-md-scrollfix>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="/development/contributing/" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Contributing
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="/development/changelog/" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Changelog
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
|
||||||
|
<div class="md-sidebar__scrollwrap">
|
||||||
|
<div class="md-sidebar__inner">
|
||||||
|
|
||||||
|
|
||||||
|
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div class="md-content" data-md-component="content">
|
||||||
|
<article class="md-content__inner md-typeset">
|
||||||
|
|
||||||
|
<h1>404 - Not found</h1>
|
||||||
|
|
||||||
|
</article>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
|
||||||
|
Back to top
|
||||||
|
</button>
|
||||||
|
|
||||||
|
</main>
|
||||||
|
|
||||||
|
<footer class="md-footer">
|
||||||
|
|
||||||
|
<div class="md-footer-meta md-typeset">
|
||||||
|
<div class="md-footer-meta__inner md-grid">
|
||||||
|
<div class="md-copyright">
|
||||||
|
|
||||||
|
<div class="md-copyright__highlight">
|
||||||
|
Copyright © 2025 Dominik Willner
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
Made with
|
||||||
|
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
|
||||||
|
Material for MkDocs
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="md-social">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a href="https://github.com/dw-0" target="_blank" rel="noopener" title="github.com" class="md-social__link">
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12"/></svg>
|
||||||
|
</a>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a href="https://ko-fi.com/dw__0" target="_blank" rel="noopener" title="ko-fi.com" class="md-social__link">
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M11.351 2.715c-2.7 0-4.986.025-6.83.26C2.078 3.285 0 5.154 0 8.61c0 3.506.182 6.13 1.585 8.493 1.584 2.701 4.233 4.182 7.662 4.182h.83c4.209 0 6.494-2.234 7.637-4a9.5 9.5 0 0 0 1.091-2.338C21.792 14.688 24 12.22 24 9.208v-.415c0-3.247-2.13-5.507-5.792-5.87-1.558-.156-2.65-.208-6.857-.208m0 1.947c4.208 0 5.09.052 6.571.182 2.624.311 4.13 1.584 4.13 4v.39c0 2.156-1.792 3.844-3.87 3.844h-.935l-.156.649c-.208 1.013-.597 1.818-1.039 2.546-.909 1.428-2.545 3.064-5.922 3.064h-.805c-2.571 0-4.831-.883-6.078-3.195-1.09-2-1.298-4.155-1.298-7.506 0-2.181.857-3.402 3.012-3.714 1.533-.233 3.559-.26 6.39-.26m6.547 2.287c-.416 0-.65.234-.65.546v2.935c0 .311.234.545.65.545 1.324 0 2.051-.754 2.051-2s-.727-2.026-2.052-2.026m-10.39.182c-1.818 0-3.013 1.48-3.013 3.142 0 1.533.858 2.857 1.949 3.897.727.701 1.87 1.429 2.649 1.896a1.47 1.47 0 0 0 1.507 0c.78-.467 1.922-1.195 2.623-1.896 1.117-1.039 1.974-2.364 1.974-3.897 0-1.662-1.247-3.142-3.039-3.142-1.065 0-1.792.545-2.338 1.298-.493-.753-1.246-1.298-2.312-1.298"/></svg>
|
||||||
|
</a>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a href="https://www.paypal.com/paypalme/dwillner0" target="_blank" rel="noopener" title="www.paypal.com" class="md-social__link">
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M15.607 4.653H8.941L6.645 19.251H1.82L4.862 0h7.995c3.754 0 6.375 2.294 6.473 5.513-.648-.478-2.105-.86-3.722-.86m6.57 5.546c0 3.41-3.01 6.853-6.958 6.853h-2.493L11.595 24H6.74l1.845-11.538h3.592c4.208 0 7.346-3.634 7.153-6.949a5.24 5.24 0 0 1 2.848 4.686M9.653 5.546h6.408c.907 0 1.942.222 2.363.541-.195 2.741-2.655 5.483-6.441 5.483H8.714Z"/></svg>
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</footer>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<div class="md-dialog" data-md-component="dialog">
|
||||||
|
<div class="md-dialog__inner md-typeset"></div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script id="__config" type="application/json">{"base": "/", "features": ["navigation.instant", "navigation.tracking", "navigation.sections", "navigation.expand", "navigation.indexes", "navigation.top", "toc.follow", "content.code.copy"], "search": "/assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
|
||||||
|
|
||||||
|
|
||||||
|
<script src="/assets/javascripts/bundle.92b07e13.min.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
@@ -1,674 +0,0 @@
|
|||||||
GNU GENERAL PUBLIC LICENSE
|
|
||||||
Version 3, 29 June 2007
|
|
||||||
|
|
||||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
|
||||||
Everyone is permitted to copy and distribute verbatim copies
|
|
||||||
of this license document, but changing it is not allowed.
|
|
||||||
|
|
||||||
Preamble
|
|
||||||
|
|
||||||
The GNU General Public License is a free, copyleft license for
|
|
||||||
software and other kinds of works.
|
|
||||||
|
|
||||||
The licenses for most software and other practical works are designed
|
|
||||||
to take away your freedom to share and change the works. By contrast,
|
|
||||||
the GNU General Public License is intended to guarantee your freedom to
|
|
||||||
share and change all versions of a program--to make sure it remains free
|
|
||||||
software for all its users. We, the Free Software Foundation, use the
|
|
||||||
GNU General Public License for most of our software; it applies also to
|
|
||||||
any other work released this way by its authors. You can apply it to
|
|
||||||
your programs, too.
|
|
||||||
|
|
||||||
When we speak of free software, we are referring to freedom, not
|
|
||||||
price. Our General Public Licenses are designed to make sure that you
|
|
||||||
have the freedom to distribute copies of free software (and charge for
|
|
||||||
them if you wish), that you receive source code or can get it if you
|
|
||||||
want it, that you can change the software or use pieces of it in new
|
|
||||||
free programs, and that you know you can do these things.
|
|
||||||
|
|
||||||
To protect your rights, we need to prevent others from denying you
|
|
||||||
these rights or asking you to surrender the rights. Therefore, you have
|
|
||||||
certain responsibilities if you distribute copies of the software, or if
|
|
||||||
you modify it: responsibilities to respect the freedom of others.
|
|
||||||
|
|
||||||
For example, if you distribute copies of such a program, whether
|
|
||||||
gratis or for a fee, you must pass on to the recipients the same
|
|
||||||
freedoms that you received. You must make sure that they, too, receive
|
|
||||||
or can get the source code. And you must show them these terms so they
|
|
||||||
know their rights.
|
|
||||||
|
|
||||||
Developers that use the GNU GPL protect your rights with two steps:
|
|
||||||
(1) assert copyright on the software, and (2) offer you this License
|
|
||||||
giving you legal permission to copy, distribute and/or modify it.
|
|
||||||
|
|
||||||
For the developers' and authors' protection, the GPL clearly explains
|
|
||||||
that there is no warranty for this free software. For both users' and
|
|
||||||
authors' sake, the GPL requires that modified versions be marked as
|
|
||||||
changed, so that their problems will not be attributed erroneously to
|
|
||||||
authors of previous versions.
|
|
||||||
|
|
||||||
Some devices are designed to deny users access to install or run
|
|
||||||
modified versions of the software inside them, although the manufacturer
|
|
||||||
can do so. This is fundamentally incompatible with the aim of
|
|
||||||
protecting users' freedom to change the software. The systematic
|
|
||||||
pattern of such abuse occurs in the area of products for individuals to
|
|
||||||
use, which is precisely where it is most unacceptable. Therefore, we
|
|
||||||
have designed this version of the GPL to prohibit the practice for those
|
|
||||||
products. If such problems arise substantially in other domains, we
|
|
||||||
stand ready to extend this provision to those domains in future versions
|
|
||||||
of the GPL, as needed to protect the freedom of users.
|
|
||||||
|
|
||||||
Finally, every program is threatened constantly by software patents.
|
|
||||||
States should not allow patents to restrict development and use of
|
|
||||||
software on general-purpose computers, but in those that do, we wish to
|
|
||||||
avoid the special danger that patents applied to a free program could
|
|
||||||
make it effectively proprietary. To prevent this, the GPL assures that
|
|
||||||
patents cannot be used to render the program non-free.
|
|
||||||
|
|
||||||
The precise terms and conditions for copying, distribution and
|
|
||||||
modification follow.
|
|
||||||
|
|
||||||
TERMS AND CONDITIONS
|
|
||||||
|
|
||||||
0. Definitions.
|
|
||||||
|
|
||||||
"This License" refers to version 3 of the GNU General Public License.
|
|
||||||
|
|
||||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
|
||||||
works, such as semiconductor masks.
|
|
||||||
|
|
||||||
"The Program" refers to any copyrightable work licensed under this
|
|
||||||
License. Each licensee is addressed as "you". "Licensees" and
|
|
||||||
"recipients" may be individuals or organizations.
|
|
||||||
|
|
||||||
To "modify" a work means to copy from or adapt all or part of the work
|
|
||||||
in a fashion requiring copyright permission, other than the making of an
|
|
||||||
exact copy. The resulting work is called a "modified version" of the
|
|
||||||
earlier work or a work "based on" the earlier work.
|
|
||||||
|
|
||||||
A "covered work" means either the unmodified Program or a work based
|
|
||||||
on the Program.
|
|
||||||
|
|
||||||
To "propagate" a work means to do anything with it that, without
|
|
||||||
permission, would make you directly or secondarily liable for
|
|
||||||
infringement under applicable copyright law, except executing it on a
|
|
||||||
computer or modifying a private copy. Propagation includes copying,
|
|
||||||
distribution (with or without modification), making available to the
|
|
||||||
public, and in some countries other activities as well.
|
|
||||||
|
|
||||||
To "convey" a work means any kind of propagation that enables other
|
|
||||||
parties to make or receive copies. Mere interaction with a user through
|
|
||||||
a computer network, with no transfer of a copy, is not conveying.
|
|
||||||
|
|
||||||
An interactive user interface displays "Appropriate Legal Notices"
|
|
||||||
to the extent that it includes a convenient and prominently visible
|
|
||||||
feature that (1) displays an appropriate copyright notice, and (2)
|
|
||||||
tells the user that there is no warranty for the work (except to the
|
|
||||||
extent that warranties are provided), that licensees may convey the
|
|
||||||
work under this License, and how to view a copy of this License. If
|
|
||||||
the interface presents a list of user commands or options, such as a
|
|
||||||
menu, a prominent item in the list meets this criterion.
|
|
||||||
|
|
||||||
1. Source Code.
|
|
||||||
|
|
||||||
The "source code" for a work means the preferred form of the work
|
|
||||||
for making modifications to it. "Object code" means any non-source
|
|
||||||
form of a work.
|
|
||||||
|
|
||||||
A "Standard Interface" means an interface that either is an official
|
|
||||||
standard defined by a recognized standards body, or, in the case of
|
|
||||||
interfaces specified for a particular programming language, one that
|
|
||||||
is widely used among developers working in that language.
|
|
||||||
|
|
||||||
The "System Libraries" of an executable work include anything, other
|
|
||||||
than the work as a whole, that (a) is included in the normal form of
|
|
||||||
packaging a Major Component, but which is not part of that Major
|
|
||||||
Component, and (b) serves only to enable use of the work with that
|
|
||||||
Major Component, or to implement a Standard Interface for which an
|
|
||||||
implementation is available to the public in source code form. A
|
|
||||||
"Major Component", in this context, means a major essential component
|
|
||||||
(kernel, window system, and so on) of the specific operating system
|
|
||||||
(if any) on which the executable work runs, or a compiler used to
|
|
||||||
produce the work, or an object code interpreter used to run it.
|
|
||||||
|
|
||||||
The "Corresponding Source" for a work in object code form means all
|
|
||||||
the source code needed to generate, install, and (for an executable
|
|
||||||
work) run the object code and to modify the work, including scripts to
|
|
||||||
control those activities. However, it does not include the work's
|
|
||||||
System Libraries, or general-purpose tools or generally available free
|
|
||||||
programs which are used unmodified in performing those activities but
|
|
||||||
which are not part of the work. For example, Corresponding Source
|
|
||||||
includes interface definition files associated with source files for
|
|
||||||
the work, and the source code for shared libraries and dynamically
|
|
||||||
linked subprograms that the work is specifically designed to require,
|
|
||||||
such as by intimate data communication or control flow between those
|
|
||||||
subprograms and other parts of the work.
|
|
||||||
|
|
||||||
The Corresponding Source need not include anything that users
|
|
||||||
can regenerate automatically from other parts of the Corresponding
|
|
||||||
Source.
|
|
||||||
|
|
||||||
The Corresponding Source for a work in source code form is that
|
|
||||||
same work.
|
|
||||||
|
|
||||||
2. Basic Permissions.
|
|
||||||
|
|
||||||
All rights granted under this License are granted for the term of
|
|
||||||
copyright on the Program, and are irrevocable provided the stated
|
|
||||||
conditions are met. This License explicitly affirms your unlimited
|
|
||||||
permission to run the unmodified Program. The output from running a
|
|
||||||
covered work is covered by this License only if the output, given its
|
|
||||||
content, constitutes a covered work. This License acknowledges your
|
|
||||||
rights of fair use or other equivalent, as provided by copyright law.
|
|
||||||
|
|
||||||
You may make, run and propagate covered works that you do not
|
|
||||||
convey, without conditions so long as your license otherwise remains
|
|
||||||
in force. You may convey covered works to others for the sole purpose
|
|
||||||
of having them make modifications exclusively for you, or provide you
|
|
||||||
with facilities for running those works, provided that you comply with
|
|
||||||
the terms of this License in conveying all material for which you do
|
|
||||||
not control copyright. Those thus making or running the covered works
|
|
||||||
for you must do so exclusively on your behalf, under your direction
|
|
||||||
and control, on terms that prohibit them from making any copies of
|
|
||||||
your copyrighted material outside their relationship with you.
|
|
||||||
|
|
||||||
Conveying under any other circumstances is permitted solely under
|
|
||||||
the conditions stated below. Sublicensing is not allowed; section 10
|
|
||||||
makes it unnecessary.
|
|
||||||
|
|
||||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
|
||||||
|
|
||||||
No covered work shall be deemed part of an effective technological
|
|
||||||
measure under any applicable law fulfilling obligations under article
|
|
||||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
|
||||||
similar laws prohibiting or restricting circumvention of such
|
|
||||||
measures.
|
|
||||||
|
|
||||||
When you convey a covered work, you waive any legal power to forbid
|
|
||||||
circumvention of technological measures to the extent such circumvention
|
|
||||||
is effected by exercising rights under this License with respect to
|
|
||||||
the covered work, and you disclaim any intention to limit operation or
|
|
||||||
modification of the work as a means of enforcing, against the work's
|
|
||||||
users, your or third parties' legal rights to forbid circumvention of
|
|
||||||
technological measures.
|
|
||||||
|
|
||||||
4. Conveying Verbatim Copies.
|
|
||||||
|
|
||||||
You may convey verbatim copies of the Program's source code as you
|
|
||||||
receive it, in any medium, provided that you conspicuously and
|
|
||||||
appropriately publish on each copy an appropriate copyright notice;
|
|
||||||
keep intact all notices stating that this License and any
|
|
||||||
non-permissive terms added in accord with section 7 apply to the code;
|
|
||||||
keep intact all notices of the absence of any warranty; and give all
|
|
||||||
recipients a copy of this License along with the Program.
|
|
||||||
|
|
||||||
You may charge any price or no price for each copy that you convey,
|
|
||||||
and you may offer support or warranty protection for a fee.
|
|
||||||
|
|
||||||
5. Conveying Modified Source Versions.
|
|
||||||
|
|
||||||
You may convey a work based on the Program, or the modifications to
|
|
||||||
produce it from the Program, in the form of source code under the
|
|
||||||
terms of section 4, provided that you also meet all of these conditions:
|
|
||||||
|
|
||||||
a) The work must carry prominent notices stating that you modified
|
|
||||||
it, and giving a relevant date.
|
|
||||||
|
|
||||||
b) The work must carry prominent notices stating that it is
|
|
||||||
released under this License and any conditions added under section
|
|
||||||
7. This requirement modifies the requirement in section 4 to
|
|
||||||
"keep intact all notices".
|
|
||||||
|
|
||||||
c) You must license the entire work, as a whole, under this
|
|
||||||
License to anyone who comes into possession of a copy. This
|
|
||||||
License will therefore apply, along with any applicable section 7
|
|
||||||
additional terms, to the whole of the work, and all its parts,
|
|
||||||
regardless of how they are packaged. This License gives no
|
|
||||||
permission to license the work in any other way, but it does not
|
|
||||||
invalidate such permission if you have separately received it.
|
|
||||||
|
|
||||||
d) If the work has interactive user interfaces, each must display
|
|
||||||
Appropriate Legal Notices; however, if the Program has interactive
|
|
||||||
interfaces that do not display Appropriate Legal Notices, your
|
|
||||||
work need not make them do so.
|
|
||||||
|
|
||||||
A compilation of a covered work with other separate and independent
|
|
||||||
works, which are not by their nature extensions of the covered work,
|
|
||||||
and which are not combined with it such as to form a larger program,
|
|
||||||
in or on a volume of a storage or distribution medium, is called an
|
|
||||||
"aggregate" if the compilation and its resulting copyright are not
|
|
||||||
used to limit the access or legal rights of the compilation's users
|
|
||||||
beyond what the individual works permit. Inclusion of a covered work
|
|
||||||
in an aggregate does not cause this License to apply to the other
|
|
||||||
parts of the aggregate.
|
|
||||||
|
|
||||||
6. Conveying Non-Source Forms.
|
|
||||||
|
|
||||||
You may convey a covered work in object code form under the terms
|
|
||||||
of sections 4 and 5, provided that you also convey the
|
|
||||||
machine-readable Corresponding Source under the terms of this License,
|
|
||||||
in one of these ways:
|
|
||||||
|
|
||||||
a) Convey the object code in, or embodied in, a physical product
|
|
||||||
(including a physical distribution medium), accompanied by the
|
|
||||||
Corresponding Source fixed on a durable physical medium
|
|
||||||
customarily used for software interchange.
|
|
||||||
|
|
||||||
b) Convey the object code in, or embodied in, a physical product
|
|
||||||
(including a physical distribution medium), accompanied by a
|
|
||||||
written offer, valid for at least three years and valid for as
|
|
||||||
long as you offer spare parts or customer support for that product
|
|
||||||
model, to give anyone who possesses the object code either (1) a
|
|
||||||
copy of the Corresponding Source for all the software in the
|
|
||||||
product that is covered by this License, on a durable physical
|
|
||||||
medium customarily used for software interchange, for a price no
|
|
||||||
more than your reasonable cost of physically performing this
|
|
||||||
conveying of source, or (2) access to copy the
|
|
||||||
Corresponding Source from a network server at no charge.
|
|
||||||
|
|
||||||
c) Convey individual copies of the object code with a copy of the
|
|
||||||
written offer to provide the Corresponding Source. This
|
|
||||||
alternative is allowed only occasionally and noncommercially, and
|
|
||||||
only if you received the object code with such an offer, in accord
|
|
||||||
with subsection 6b.
|
|
||||||
|
|
||||||
d) Convey the object code by offering access from a designated
|
|
||||||
place (gratis or for a charge), and offer equivalent access to the
|
|
||||||
Corresponding Source in the same way through the same place at no
|
|
||||||
further charge. You need not require recipients to copy the
|
|
||||||
Corresponding Source along with the object code. If the place to
|
|
||||||
copy the object code is a network server, the Corresponding Source
|
|
||||||
may be on a different server (operated by you or a third party)
|
|
||||||
that supports equivalent copying facilities, provided you maintain
|
|
||||||
clear directions next to the object code saying where to find the
|
|
||||||
Corresponding Source. Regardless of what server hosts the
|
|
||||||
Corresponding Source, you remain obligated to ensure that it is
|
|
||||||
available for as long as needed to satisfy these requirements.
|
|
||||||
|
|
||||||
e) Convey the object code using peer-to-peer transmission, provided
|
|
||||||
you inform other peers where the object code and Corresponding
|
|
||||||
Source of the work are being offered to the general public at no
|
|
||||||
charge under subsection 6d.
|
|
||||||
|
|
||||||
A separable portion of the object code, whose source code is excluded
|
|
||||||
from the Corresponding Source as a System Library, need not be
|
|
||||||
included in conveying the object code work.
|
|
||||||
|
|
||||||
A "User Product" is either (1) a "consumer product", which means any
|
|
||||||
tangible personal property which is normally used for personal, family,
|
|
||||||
or household purposes, or (2) anything designed or sold for incorporation
|
|
||||||
into a dwelling. In determining whether a product is a consumer product,
|
|
||||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
|
||||||
product received by a particular user, "normally used" refers to a
|
|
||||||
typical or common use of that class of product, regardless of the status
|
|
||||||
of the particular user or of the way in which the particular user
|
|
||||||
actually uses, or expects or is expected to use, the product. A product
|
|
||||||
is a consumer product regardless of whether the product has substantial
|
|
||||||
commercial, industrial or non-consumer uses, unless such uses represent
|
|
||||||
the only significant mode of use of the product.
|
|
||||||
|
|
||||||
"Installation Information" for a User Product means any methods,
|
|
||||||
procedures, authorization keys, or other information required to install
|
|
||||||
and execute modified versions of a covered work in that User Product from
|
|
||||||
a modified version of its Corresponding Source. The information must
|
|
||||||
suffice to ensure that the continued functioning of the modified object
|
|
||||||
code is in no case prevented or interfered with solely because
|
|
||||||
modification has been made.
|
|
||||||
|
|
||||||
If you convey an object code work under this section in, or with, or
|
|
||||||
specifically for use in, a User Product, and the conveying occurs as
|
|
||||||
part of a transaction in which the right of possession and use of the
|
|
||||||
User Product is transferred to the recipient in perpetuity or for a
|
|
||||||
fixed term (regardless of how the transaction is characterized), the
|
|
||||||
Corresponding Source conveyed under this section must be accompanied
|
|
||||||
by the Installation Information. But this requirement does not apply
|
|
||||||
if neither you nor any third party retains the ability to install
|
|
||||||
modified object code on the User Product (for example, the work has
|
|
||||||
been installed in ROM).
|
|
||||||
|
|
||||||
The requirement to provide Installation Information does not include a
|
|
||||||
requirement to continue to provide support service, warranty, or updates
|
|
||||||
for a work that has been modified or installed by the recipient, or for
|
|
||||||
the User Product in which it has been modified or installed. Access to a
|
|
||||||
network may be denied when the modification itself materially and
|
|
||||||
adversely affects the operation of the network or violates the rules and
|
|
||||||
protocols for communication across the network.
|
|
||||||
|
|
||||||
Corresponding Source conveyed, and Installation Information provided,
|
|
||||||
in accord with this section must be in a format that is publicly
|
|
||||||
documented (and with an implementation available to the public in
|
|
||||||
source code form), and must require no special password or key for
|
|
||||||
unpacking, reading or copying.
|
|
||||||
|
|
||||||
7. Additional Terms.
|
|
||||||
|
|
||||||
"Additional permissions" are terms that supplement the terms of this
|
|
||||||
License by making exceptions from one or more of its conditions.
|
|
||||||
Additional permissions that are applicable to the entire Program shall
|
|
||||||
be treated as though they were included in this License, to the extent
|
|
||||||
that they are valid under applicable law. If additional permissions
|
|
||||||
apply only to part of the Program, that part may be used separately
|
|
||||||
under those permissions, but the entire Program remains governed by
|
|
||||||
this License without regard to the additional permissions.
|
|
||||||
|
|
||||||
When you convey a copy of a covered work, you may at your option
|
|
||||||
remove any additional permissions from that copy, or from any part of
|
|
||||||
it. (Additional permissions may be written to require their own
|
|
||||||
removal in certain cases when you modify the work.) You may place
|
|
||||||
additional permissions on material, added by you to a covered work,
|
|
||||||
for which you have or can give appropriate copyright permission.
|
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, for material you
|
|
||||||
add to a covered work, you may (if authorized by the copyright holders of
|
|
||||||
that material) supplement the terms of this License with terms:
|
|
||||||
|
|
||||||
a) Disclaiming warranty or limiting liability differently from the
|
|
||||||
terms of sections 15 and 16 of this License; or
|
|
||||||
|
|
||||||
b) Requiring preservation of specified reasonable legal notices or
|
|
||||||
author attributions in that material or in the Appropriate Legal
|
|
||||||
Notices displayed by works containing it; or
|
|
||||||
|
|
||||||
c) Prohibiting misrepresentation of the origin of that material, or
|
|
||||||
requiring that modified versions of such material be marked in
|
|
||||||
reasonable ways as different from the original version; or
|
|
||||||
|
|
||||||
d) Limiting the use for publicity purposes of names of licensors or
|
|
||||||
authors of the material; or
|
|
||||||
|
|
||||||
e) Declining to grant rights under trademark law for use of some
|
|
||||||
trade names, trademarks, or service marks; or
|
|
||||||
|
|
||||||
f) Requiring indemnification of licensors and authors of that
|
|
||||||
material by anyone who conveys the material (or modified versions of
|
|
||||||
it) with contractual assumptions of liability to the recipient, for
|
|
||||||
any liability that these contractual assumptions directly impose on
|
|
||||||
those licensors and authors.
|
|
||||||
|
|
||||||
All other non-permissive additional terms are considered "further
|
|
||||||
restrictions" within the meaning of section 10. If the Program as you
|
|
||||||
received it, or any part of it, contains a notice stating that it is
|
|
||||||
governed by this License along with a term that is a further
|
|
||||||
restriction, you may remove that term. If a license document contains
|
|
||||||
a further restriction but permits relicensing or conveying under this
|
|
||||||
License, you may add to a covered work material governed by the terms
|
|
||||||
of that license document, provided that the further restriction does
|
|
||||||
not survive such relicensing or conveying.
|
|
||||||
|
|
||||||
If you add terms to a covered work in accord with this section, you
|
|
||||||
must place, in the relevant source files, a statement of the
|
|
||||||
additional terms that apply to those files, or a notice indicating
|
|
||||||
where to find the applicable terms.
|
|
||||||
|
|
||||||
Additional terms, permissive or non-permissive, may be stated in the
|
|
||||||
form of a separately written license, or stated as exceptions;
|
|
||||||
the above requirements apply either way.
|
|
||||||
|
|
||||||
8. Termination.
|
|
||||||
|
|
||||||
You may not propagate or modify a covered work except as expressly
|
|
||||||
provided under this License. Any attempt otherwise to propagate or
|
|
||||||
modify it is void, and will automatically terminate your rights under
|
|
||||||
this License (including any patent licenses granted under the third
|
|
||||||
paragraph of section 11).
|
|
||||||
|
|
||||||
However, if you cease all violation of this License, then your
|
|
||||||
license from a particular copyright holder is reinstated (a)
|
|
||||||
provisionally, unless and until the copyright holder explicitly and
|
|
||||||
finally terminates your license, and (b) permanently, if the copyright
|
|
||||||
holder fails to notify you of the violation by some reasonable means
|
|
||||||
prior to 60 days after the cessation.
|
|
||||||
|
|
||||||
Moreover, your license from a particular copyright holder is
|
|
||||||
reinstated permanently if the copyright holder notifies you of the
|
|
||||||
violation by some reasonable means, this is the first time you have
|
|
||||||
received notice of violation of this License (for any work) from that
|
|
||||||
copyright holder, and you cure the violation prior to 30 days after
|
|
||||||
your receipt of the notice.
|
|
||||||
|
|
||||||
Termination of your rights under this section does not terminate the
|
|
||||||
licenses of parties who have received copies or rights from you under
|
|
||||||
this License. If your rights have been terminated and not permanently
|
|
||||||
reinstated, you do not qualify to receive new licenses for the same
|
|
||||||
material under section 10.
|
|
||||||
|
|
||||||
9. Acceptance Not Required for Having Copies.
|
|
||||||
|
|
||||||
You are not required to accept this License in order to receive or
|
|
||||||
run a copy of the Program. Ancillary propagation of a covered work
|
|
||||||
occurring solely as a consequence of using peer-to-peer transmission
|
|
||||||
to receive a copy likewise does not require acceptance. However,
|
|
||||||
nothing other than this License grants you permission to propagate or
|
|
||||||
modify any covered work. These actions infringe copyright if you do
|
|
||||||
not accept this License. Therefore, by modifying or propagating a
|
|
||||||
covered work, you indicate your acceptance of this License to do so.
|
|
||||||
|
|
||||||
10. Automatic Licensing of Downstream Recipients.
|
|
||||||
|
|
||||||
Each time you convey a covered work, the recipient automatically
|
|
||||||
receives a license from the original licensors, to run, modify and
|
|
||||||
propagate that work, subject to this License. You are not responsible
|
|
||||||
for enforcing compliance by third parties with this License.
|
|
||||||
|
|
||||||
An "entity transaction" is a transaction transferring control of an
|
|
||||||
organization, or substantially all assets of one, or subdividing an
|
|
||||||
organization, or merging organizations. If propagation of a covered
|
|
||||||
work results from an entity transaction, each party to that
|
|
||||||
transaction who receives a copy of the work also receives whatever
|
|
||||||
licenses to the work the party's predecessor in interest had or could
|
|
||||||
give under the previous paragraph, plus a right to possession of the
|
|
||||||
Corresponding Source of the work from the predecessor in interest, if
|
|
||||||
the predecessor has it or can get it with reasonable efforts.
|
|
||||||
|
|
||||||
You may not impose any further restrictions on the exercise of the
|
|
||||||
rights granted or affirmed under this License. For example, you may
|
|
||||||
not impose a license fee, royalty, or other charge for exercise of
|
|
||||||
rights granted under this License, and you may not initiate litigation
|
|
||||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
|
||||||
any patent claim is infringed by making, using, selling, offering for
|
|
||||||
sale, or importing the Program or any portion of it.
|
|
||||||
|
|
||||||
11. Patents.
|
|
||||||
|
|
||||||
A "contributor" is a copyright holder who authorizes use under this
|
|
||||||
License of the Program or a work on which the Program is based. The
|
|
||||||
work thus licensed is called the contributor's "contributor version".
|
|
||||||
|
|
||||||
A contributor's "essential patent claims" are all patent claims
|
|
||||||
owned or controlled by the contributor, whether already acquired or
|
|
||||||
hereafter acquired, that would be infringed by some manner, permitted
|
|
||||||
by this License, of making, using, or selling its contributor version,
|
|
||||||
but do not include claims that would be infringed only as a
|
|
||||||
consequence of further modification of the contributor version. For
|
|
||||||
purposes of this definition, "control" includes the right to grant
|
|
||||||
patent sublicenses in a manner consistent with the requirements of
|
|
||||||
this License.
|
|
||||||
|
|
||||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
|
||||||
patent license under the contributor's essential patent claims, to
|
|
||||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
|
||||||
propagate the contents of its contributor version.
|
|
||||||
|
|
||||||
In the following three paragraphs, a "patent license" is any express
|
|
||||||
agreement or commitment, however denominated, not to enforce a patent
|
|
||||||
(such as an express permission to practice a patent or covenant not to
|
|
||||||
sue for patent infringement). To "grant" such a patent license to a
|
|
||||||
party means to make such an agreement or commitment not to enforce a
|
|
||||||
patent against the party.
|
|
||||||
|
|
||||||
If you convey a covered work, knowingly relying on a patent license,
|
|
||||||
and the Corresponding Source of the work is not available for anyone
|
|
||||||
to copy, free of charge and under the terms of this License, through a
|
|
||||||
publicly available network server or other readily accessible means,
|
|
||||||
then you must either (1) cause the Corresponding Source to be so
|
|
||||||
available, or (2) arrange to deprive yourself of the benefit of the
|
|
||||||
patent license for this particular work, or (3) arrange, in a manner
|
|
||||||
consistent with the requirements of this License, to extend the patent
|
|
||||||
license to downstream recipients. "Knowingly relying" means you have
|
|
||||||
actual knowledge that, but for the patent license, your conveying the
|
|
||||||
covered work in a country, or your recipient's use of the covered work
|
|
||||||
in a country, would infringe one or more identifiable patents in that
|
|
||||||
country that you have reason to believe are valid.
|
|
||||||
|
|
||||||
If, pursuant to or in connection with a single transaction or
|
|
||||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
|
||||||
covered work, and grant a patent license to some of the parties
|
|
||||||
receiving the covered work authorizing them to use, propagate, modify
|
|
||||||
or convey a specific copy of the covered work, then the patent license
|
|
||||||
you grant is automatically extended to all recipients of the covered
|
|
||||||
work and works based on it.
|
|
||||||
|
|
||||||
A patent license is "discriminatory" if it does not include within
|
|
||||||
the scope of its coverage, prohibits the exercise of, or is
|
|
||||||
conditioned on the non-exercise of one or more of the rights that are
|
|
||||||
specifically granted under this License. You may not convey a covered
|
|
||||||
work if you are a party to an arrangement with a third party that is
|
|
||||||
in the business of distributing software, under which you make payment
|
|
||||||
to the third party based on the extent of your activity of conveying
|
|
||||||
the work, and under which the third party grants, to any of the
|
|
||||||
parties who would receive the covered work from you, a discriminatory
|
|
||||||
patent license (a) in connection with copies of the covered work
|
|
||||||
conveyed by you (or copies made from those copies), or (b) primarily
|
|
||||||
for and in connection with specific products or compilations that
|
|
||||||
contain the covered work, unless you entered into that arrangement,
|
|
||||||
or that patent license was granted, prior to 28 March 2007.
|
|
||||||
|
|
||||||
Nothing in this License shall be construed as excluding or limiting
|
|
||||||
any implied license or other defenses to infringement that may
|
|
||||||
otherwise be available to you under applicable patent law.
|
|
||||||
|
|
||||||
12. No Surrender of Others' Freedom.
|
|
||||||
|
|
||||||
If conditions are imposed on you (whether by court order, agreement or
|
|
||||||
otherwise) that contradict the conditions of this License, they do not
|
|
||||||
excuse you from the conditions of this License. If you cannot convey a
|
|
||||||
covered work so as to satisfy simultaneously your obligations under this
|
|
||||||
License and any other pertinent obligations, then as a consequence you may
|
|
||||||
not convey it at all. For example, if you agree to terms that obligate you
|
|
||||||
to collect a royalty for further conveying from those to whom you convey
|
|
||||||
the Program, the only way you could satisfy both those terms and this
|
|
||||||
License would be to refrain entirely from conveying the Program.
|
|
||||||
|
|
||||||
13. Use with the GNU Affero General Public License.
|
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, you have
|
|
||||||
permission to link or combine any covered work with a work licensed
|
|
||||||
under version 3 of the GNU Affero General Public License into a single
|
|
||||||
combined work, and to convey the resulting work. The terms of this
|
|
||||||
License will continue to apply to the part which is the covered work,
|
|
||||||
but the special requirements of the GNU Affero General Public License,
|
|
||||||
section 13, concerning interaction through a network will apply to the
|
|
||||||
combination as such.
|
|
||||||
|
|
||||||
14. Revised Versions of this License.
|
|
||||||
|
|
||||||
The Free Software Foundation may publish revised and/or new versions of
|
|
||||||
the GNU General Public License from time to time. Such new versions will
|
|
||||||
be similar in spirit to the present version, but may differ in detail to
|
|
||||||
address new problems or concerns.
|
|
||||||
|
|
||||||
Each version is given a distinguishing version number. If the
|
|
||||||
Program specifies that a certain numbered version of the GNU General
|
|
||||||
Public License "or any later version" applies to it, you have the
|
|
||||||
option of following the terms and conditions either of that numbered
|
|
||||||
version or of any later version published by the Free Software
|
|
||||||
Foundation. If the Program does not specify a version number of the
|
|
||||||
GNU General Public License, you may choose any version ever published
|
|
||||||
by the Free Software Foundation.
|
|
||||||
|
|
||||||
If the Program specifies that a proxy can decide which future
|
|
||||||
versions of the GNU General Public License can be used, that proxy's
|
|
||||||
public statement of acceptance of a version permanently authorizes you
|
|
||||||
to choose that version for the Program.
|
|
||||||
|
|
||||||
Later license versions may give you additional or different
|
|
||||||
permissions. However, no additional obligations are imposed on any
|
|
||||||
author or copyright holder as a result of your choosing to follow a
|
|
||||||
later version.
|
|
||||||
|
|
||||||
15. Disclaimer of Warranty.
|
|
||||||
|
|
||||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
|
||||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
|
||||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
|
||||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
|
||||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
||||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
|
||||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
|
||||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
|
||||||
|
|
||||||
16. Limitation of Liability.
|
|
||||||
|
|
||||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
|
||||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
|
||||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
|
||||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
|
||||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
|
||||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
|
||||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
|
||||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
|
||||||
SUCH DAMAGES.
|
|
||||||
|
|
||||||
17. Interpretation of Sections 15 and 16.
|
|
||||||
|
|
||||||
If the disclaimer of warranty and limitation of liability provided
|
|
||||||
above cannot be given local legal effect according to their terms,
|
|
||||||
reviewing courts shall apply local law that most closely approximates
|
|
||||||
an absolute waiver of all civil liability in connection with the
|
|
||||||
Program, unless a warranty or assumption of liability accompanies a
|
|
||||||
copy of the Program in return for a fee.
|
|
||||||
|
|
||||||
END OF TERMS AND CONDITIONS
|
|
||||||
|
|
||||||
How to Apply These Terms to Your New Programs
|
|
||||||
|
|
||||||
If you develop a new program, and you want it to be of the greatest
|
|
||||||
possible use to the public, the best way to achieve this is to make it
|
|
||||||
free software which everyone can redistribute and change under these terms.
|
|
||||||
|
|
||||||
To do so, attach the following notices to the program. It is safest
|
|
||||||
to attach them to the start of each source file to most effectively
|
|
||||||
state the exclusion of warranty; and each file should have at least
|
|
||||||
the "copyright" line and a pointer to where the full notice is found.
|
|
||||||
|
|
||||||
<one line to give the program's name and a brief idea of what it does.>
|
|
||||||
Copyright (C) <year> <name of author>
|
|
||||||
|
|
||||||
This program is free software: you can redistribute it and/or modify
|
|
||||||
it under the terms of the GNU General Public License as published by
|
|
||||||
the Free Software Foundation, either version 3 of the License, or
|
|
||||||
(at your option) any later version.
|
|
||||||
|
|
||||||
This program is distributed in the hope that it will be useful,
|
|
||||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
||||||
GNU General Public License for more details.
|
|
||||||
|
|
||||||
You should have received a copy of the GNU General Public License
|
|
||||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
Also add information on how to contact you by electronic and paper mail.
|
|
||||||
|
|
||||||
If the program does terminal interaction, make it output a short
|
|
||||||
notice like this when it starts in an interactive mode:
|
|
||||||
|
|
||||||
<program> Copyright (C) <year> <name of author>
|
|
||||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
|
||||||
This is free software, and you are welcome to redistribute it
|
|
||||||
under certain conditions; type `show c' for details.
|
|
||||||
|
|
||||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
|
||||||
parts of the General Public License. Of course, your program's commands
|
|
||||||
might be different; for a GUI interface, you would use an "about box".
|
|
||||||
|
|
||||||
You should also get your employer (if you work as a programmer) or school,
|
|
||||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
|
||||||
For more information on this, and how to apply and follow the GNU GPL, see
|
|
||||||
<https://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
The GNU General Public License does not permit incorporating your program
|
|
||||||
into proprietary programs. If your program is a subroutine library, you
|
|
||||||
may consider it more useful to permit linking proprietary applications with
|
|
||||||
the library. If this is what you want to do, use the GNU Lesser General
|
|
||||||
Public License instead of this License. But first, please read
|
|
||||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
|
||||||
@@ -1,214 +0,0 @@
|
|||||||
<p align="center">
|
|
||||||
<a>
|
|
||||||
<img src="https://raw.githubusercontent.com/dw-0/kiauh/master/resources/screenshots/kiauh.png" alt="KIAUH logo" height="181">
|
|
||||||
<h1 align="center">Klipper Installation And Update Helper</h1>
|
|
||||||
</a>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<p align="center">
|
|
||||||
A handy installation script that makes installing Klipper (and more) a breeze!
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<p align="center">
|
|
||||||
<a><img src="https://img.shields.io/github/license/dw-0/kiauh"></a>
|
|
||||||
<a><img src="https://img.shields.io/github/stars/dw-0/kiauh"></a>
|
|
||||||
<a><img src="https://img.shields.io/github/forks/dw-0/kiauh"></a>
|
|
||||||
<a><img src="https://img.shields.io/github/languages/top/dw-0/kiauh?logo=gnubash&logoColor=white"></a>
|
|
||||||
<a><img src="https://img.shields.io/github/v/tag/dw-0/kiauh"></a>
|
|
||||||
<br />
|
|
||||||
<a><img src="https://img.shields.io/github/last-commit/dw-0/kiauh"></a>
|
|
||||||
<a><img src="https://img.shields.io/github/contributors/dw-0/kiauh"></a>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<hr>
|
|
||||||
|
|
||||||
<h2 align="center">
|
|
||||||
📄️ Instructions 📄
|
|
||||||
</h2>
|
|
||||||
|
|
||||||
### 📋 Prerequisites
|
|
||||||
KIAUH is a script that assists you in installing Klipper on a Linux operating system that has
|
|
||||||
already been flashed to your Raspberry Pi's (or other SBC's) SD card. As a result, you must ensure
|
|
||||||
that you have a functional Linux system on hand. `Raspberry Pi OS Lite (either 32bit or 64bit)` is a recommended Linux image
|
|
||||||
if you are using a Raspberry Pi. The [official Raspberry Pi Imager](https://www.raspberrypi.com/software/)
|
|
||||||
is the simplest way to flash an image like this to an SD card.
|
|
||||||
|
|
||||||
* Once you have downloaded, installed and launched the Raspberry Pi Imager,
|
|
||||||
select `Choose OS -> Raspberry Pi OS (other)`: \
|
|
||||||
<p align="center">
|
|
||||||
<img src="https://raw.githubusercontent.com/dw-0/kiauh/master/resources/screenshots/rpi_imager1.png" alt="KIAUH logo" height="350">
|
|
||||||
</p>
|
|
||||||
|
|
||||||
* Then select `Raspberry Pi OS Lite (32bit)` (or 64bit if you want to use that instead):
|
|
||||||
<p align="center">
|
|
||||||
<img src="https://raw.githubusercontent.com/dw-0/kiauh/master/resources/screenshots/rpi_imager2.png" alt="KIAUH logo" height="350">
|
|
||||||
</p>
|
|
||||||
|
|
||||||
* Back in the Raspberry Pi Imager's main menu, select the corresponding SD card to which
|
|
||||||
you want to flash the image.
|
|
||||||
|
|
||||||
* Make sure to go into the Advanced Option (the cog icon in the lower left corner of the main menu)
|
|
||||||
and enable SSH and configure Wi-Fi.
|
|
||||||
|
|
||||||
* If you need more help for using the Raspberry Pi Imager, please visit the [official documentation](https://www.raspberrypi.com/documentation/computers/getting-started.html).
|
|
||||||
|
|
||||||
These steps **only** apply if you are actually using a Raspberry Pi. In case you want
|
|
||||||
to use a different SBC (like an Orange Pi or any other Pi derivates), please look up on how to get an appropriate Linux image flashed
|
|
||||||
to the SD card before proceeding further (usually done with Balena Etcher in those cases). Also make sure that KIAUH will be able to run
|
|
||||||
and operate on the Linux Distribution you are going to flash. You likely will have the most success with
|
|
||||||
distributions based on Debian 11 Bullseye. Read the notes further down below in this document.
|
|
||||||
|
|
||||||
### 💾 Download and use KIAUH
|
|
||||||
**📢 Disclaimer: Usage of this script happens at your own risk!**
|
|
||||||
|
|
||||||
* **Step 1:** \
|
|
||||||
To download this script, it is necessary to have git installed. If you don't have git already installed, or if you are unsure, run the following command:
|
|
||||||
```shell
|
|
||||||
sudo apt-get update && sudo apt-get install git -y
|
|
||||||
```
|
|
||||||
|
|
||||||
* **Step 2:** \
|
|
||||||
Once git is installed, use the following command to download KIAUH into your home-directory:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
cd ~ && git clone https://github.com/dw-0/kiauh.git
|
|
||||||
```
|
|
||||||
|
|
||||||
* **Step 3:** \
|
|
||||||
Finally, start KIAUH by running the next command:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
./kiauh/kiauh.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
* **Step 4:** \
|
|
||||||
You should now find yourself in the main menu of KIAUH. You will see several actions to choose from depending
|
|
||||||
on what you want to do. To choose an action, simply type the corresponding number into the "Perform action"
|
|
||||||
prompt and confirm by hitting ENTER.
|
|
||||||
|
|
||||||
<hr>
|
|
||||||
|
|
||||||
<h2 align="center">❗ Notes ❗</h2>
|
|
||||||
|
|
||||||
### **📋 Please see the [Changelog](docs/changelog.md) for possible important changes!**
|
|
||||||
|
|
||||||
- Mainly tested on Raspberry Pi OS Lite (Debian 10 Buster / Debian 11 Bullseye)
|
|
||||||
- Other Debian based distributions (like Ubuntu 20 to 22) likely work too
|
|
||||||
- Reported to work on Armbian as well but not tested in detail
|
|
||||||
- During the use of this script you will be asked for your sudo password. There are several functions involved which need sudo privileges.
|
|
||||||
|
|
||||||
<hr>
|
|
||||||
|
|
||||||
<h2 align="center">🌐 Sources & Further Information</h2>
|
|
||||||
|
|
||||||
<table align="center">
|
|
||||||
<tr>
|
|
||||||
<th><h3><a href="https://github.com/Klipper3d/klipper">Klipper</a></h3></th>
|
|
||||||
<th><h3><a href="https://github.com/Arksine/moonraker">Moonraker</a></h3></th>
|
|
||||||
<th><h3><a href="https://github.com/mainsail-crew/mainsail">Mainsail</a></h3></th>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<th><img src="https://raw.githubusercontent.com/Klipper3d/klipper/master/docs/img/klipper-logo.png" alt="Klipper Logo" height="64"></th>
|
|
||||||
<th><img src="https://avatars.githubusercontent.com/u/9563098?v=4" alt="Arksine avatar" height="64"></th>
|
|
||||||
<th><img src="https://raw.githubusercontent.com/mainsail-crew/docs/master/assets/img/logo.png" alt="Mainsail Logo" height="64"></th>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<th>by <a href="https://github.com/KevinOConnor">KevinOConnor</a></th>
|
|
||||||
<th>by <a href="https://github.com/Arksine">Arksine</a></th>
|
|
||||||
<th>by <a href="https://github.com/mainsail-crew">mainsail-crew</a></th>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
<tr>
|
|
||||||
<th><h3><a href="https://github.com/fluidd-core/fluidd">Fluidd</a></h3></th>
|
|
||||||
<th><h3><a href="https://github.com/jordanruthe/KlipperScreen">KlipperScreen</a></h3></th>
|
|
||||||
<th><h3><a href="https://github.com/OctoPrint/OctoPrint">OctoPrint</a></h3></th>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<th><img src="https://raw.githubusercontent.com/fluidd-core/fluidd/master/docs/assets/images/logo.svg" alt="Fluidd Logo" height="64"></th>
|
|
||||||
<th><img src="https://avatars.githubusercontent.com/u/31575189?v=4" alt="jordanruthe avatar" height="64"></th>
|
|
||||||
<th><img src="https://raw.githubusercontent.com/OctoPrint/OctoPrint/master/docs/images/octoprint-logo.png" alt="OctoPrint Logo" height="64"></th>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<th>by <a href="https://github.com/fluidd-core">fluidd-core</a></th>
|
|
||||||
<th>by <a href="https://github.com/jordanruthe">jordanruthe</a></th>
|
|
||||||
<th>by <a href="https://github.com/OctoPrint">OctoPrint</a></th>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
<tr>
|
|
||||||
<th><h3><a href="https://github.com/nlef/moonraker-telegram-bot">Moonraker-Telegram-Bot</a></h3></th>
|
|
||||||
<th><h3><a href="https://github.com/Kragrathea/pgcode">PrettyGCode for Klipper</a></h3></th>
|
|
||||||
<th><h3><a href="https://github.com/TheSpaghettiDetective/moonraker-obico">Obico for Klipper</a></h3></th>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<th><img src="https://avatars.githubusercontent.com/u/52351624?v=4" alt="nlef avatar" height="64"></th>
|
|
||||||
<th><img src="https://avatars.githubusercontent.com/u/5917231?v=4" alt="Kragrathea avatar" height="64"></th>
|
|
||||||
<th><img src="https://avatars.githubusercontent.com/u/46323662?s=200&v=4" alt="Obico logo" height="64"></th>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<th>by <a href="https://github.com/nlef">nlef</a></th>
|
|
||||||
<th>by <a href="https://github.com/Kragrathea">Kragrathea</a></th>
|
|
||||||
<th>by <a href="https://github.com/TheSpaghettiDetective">Obico</a></th>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
<tr>
|
|
||||||
<th><h3><a href="https://github.com/Clon1998/mobileraker_companion">Mobileraker's Companion</a></h3></th>
|
|
||||||
<th><h3><a href="https://octoeverywhere.com/?source=kiauh_readme">OctoEverywhere For Klipper</a></h3></th>
|
|
||||||
<th><h3><a href="https://github.com/crysxd/OctoApp-Plugin">OctoApp For Klipper</a></h3></th>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<th><a href="https://github.com/Clon1998/mobileraker_companion"><img src="https://raw.githubusercontent.com/Clon1998/mobileraker/master/assets/icon/mr_appicon.png" alt="Mobileraker Logo" height="64"></a></th>
|
|
||||||
<th><a href="https://octoeverywhere.com/?source=kiauh_readme"><img src="https://octoeverywhere.com/img/logo.svg" alt="OctoEverywhere Logo" height="64"></a></th>
|
|
||||||
<th><a href="https://octoapp.eu/?source=kiauh_readme"><img src="https://octoapp.eu/octoapp.webp" alt="OctoApp Logo" height="64"></a></th>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<th>by <a href="https://github.com/Clon1998">Patrick Schmidt</a></th>
|
|
||||||
<th>by <a href="https://github.com/QuinnDamerell">Quinn Damerell</a></th>
|
|
||||||
<th>by <a href="https://github.com/crysxd">Christian Würthner</a></th>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
<tr>
|
|
||||||
<th><h3><a href="https://github.com/staubgeborener/klipper-backup">Klipper-Backup</a></h3></th>
|
|
||||||
<th><h3><a href="https://simplyprint.io/">SimplyPrint for Klipper</a></h3></th>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<th><a href="https://github.com/staubgeborener/klipper-backup"><img src="https://avatars.githubusercontent.com/u/28908603?v=4" alt="Staubgeroner Avatar" height="64"></a></th>
|
|
||||||
<th><a href="https://github.com/SimplyPrint"><img src="https://avatars.githubusercontent.com/u/64896552?s=200&v=4" alt="" height="64"></a></th>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<th>by <a href="https://github.com/Staubgeborener">Staubgeborener</a></th>
|
|
||||||
<th>by <a href="https://github.com/SimplyPrint">SimplyPrint</a></th>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
<hr>
|
|
||||||
|
|
||||||
<h2 align="center">🎖️ Contributors 🎖️</h2>
|
|
||||||
|
|
||||||
<div align="center">
|
|
||||||
<a href="https://github.com/dw-0/kiauh/graphs/contributors">
|
|
||||||
<img src="https://contrib.rocks/image?repo=dw-0/kiauh" alt=""/>
|
|
||||||
</a>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<hr>
|
|
||||||
|
|
||||||
<div align="center">
|
|
||||||
<img src="https://repobeats.axiom.co/api/embed/a1afbda9190c04a90cf4bd3061e5573bc836cb05.svg" alt="Repobeats analytics image"/>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<hr>
|
|
||||||
|
|
||||||
<h2 align="center">✨ Credits ✨</h2>
|
|
||||||
|
|
||||||
* A big thank you to [lixxbox](https://github.com/lixxbox) for that awesome KIAUH-Logo!
|
|
||||||
* Also, a big thank you to everyone who supported my work with a [Ko-fi](https://ko-fi.com/dw__0) !
|
|
||||||
* Last but not least: Thank you to all contributors and members of the Klipper Community who like and share this project!
|
|
||||||
|
|
||||||
<hr>
|
|
||||||
|
|
||||||
<h4 align="center">A special thank you to JetBrains for sponsoring this project with their incredible software!</h4>
|
|
||||||
<p align="center">
|
|
||||||
<a href="https://www.jetbrains.com/community/opensource/#support" target="_blank">
|
|
||||||
<img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png" alt="JetBrains Logo (Main) logo." height="128">
|
|
||||||
</a>
|
|
||||||
</p>
|
|
||||||
-206
@@ -1,206 +0,0 @@
|
|||||||
# KIAUH - Klipper 安装与更新助手
|
|
||||||
|
|
||||||
<p align="center">
|
|
||||||
<a>
|
|
||||||
<img src="https://raw.githubusercontent.com/dw-0/kiauh/master/resources/screenshots/kiauh.png" alt="KIAUH logo" height="181">
|
|
||||||
<h1 align="center">Klipper Installation And Update Helper</h1>
|
|
||||||
</a>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<p align="center">
|
|
||||||
一个方便的安装脚本，让安装Klipper（以及更多组件）变得轻松！
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<p align="center">
|
|
||||||
<a><img src="https://img.shields.io/github/license/dw-0/kiauh"></a>
|
|
||||||
<a><img src="https://img.shields.io/github/stars/dw-0/kiauh"></a>
|
|
||||||
<a><img src="https://img.shields.io/github/forks/dw-0/kiauh"></a>
|
|
||||||
<a><img src="https://img.shields.io/github/languages/top/dw-0/kiauh?logo=gnubash&logoColor=white"></a>
|
|
||||||
<a><img src="https://img.shields.io/github/v/tag/dw-0/kiauh"></a>
|
|
||||||
<br />
|
|
||||||
<a><img src="https://img.shields.io/github/last-commit/dw-0/kiauh"></a>
|
|
||||||
<a><img src="https://img.shields.io/github/contributors/dw-0/kiauh"></a>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
## 📄 使用说明
|
|
||||||
|
|
||||||
### 📋 系统要求
|
|
||||||
KIAUH 是一个帮助您在 Linux 系统上安装 Klipper 的脚本工具，
|
|
||||||
它需要一个已经写入树莓派（或其他单板计算机）SD 卡的 Linux 系统。
|
|
||||||
如果您使用树莓派，推荐使用 `Raspberry Pi OS Lite (32位或64位)` 系统镜像。
|
|
||||||
[官方 Raspberry Pi Imager](https://www.raspberrypi.com/software/) 是将此类镜像写入 SD 卡的最简单方式。
|
|
||||||
|
|
||||||
* 下载、安装并启动 Raspberry Pi Imager 后，
|
|
||||||
选择 `Choose OS -> Raspberry Pi OS (other)`:
|
|
||||||
|
|
||||||
<p align="center">
|
|
||||||
<img src="https://raw.githubusercontent.com/dw-0/kiauh/master/resources/screenshots/rpi_imager1.png" alt="KIAUH logo" height="350">
|
|
||||||
</p>
|
|
||||||
|
|
||||||
* 然后选择 `Raspberry Pi OS Lite (32位)` (或如果您想使用64位版本):
|
|
||||||
|
|
||||||
<p align="center">
|
|
||||||
<img src="https://raw.githubusercontent.com/dw-0/kiauh/master/resources/screenshots/rpi_imager2.png" alt="KIAUH logo" height="350">
|
|
||||||
</p>
|
|
||||||
|
|
||||||
* 返回 Raspberry Pi Imager 主界面，选择对应的 SD 卡作为写入目标。
|
|
||||||
|
|
||||||
* 确保点击左下角的齿轮图标（在主菜单中）
|
|
||||||
启用 SSH 并配置 Wi-Fi。
|
|
||||||
|
|
||||||
* 如果您需要更多关于使用 Raspberry Pi Imager 的帮助，请访问 [官方文档](https://www.raspberrypi.com/documentation/computers/getting-started.html)。
|
|
||||||
|
|
||||||
这些步骤**仅适用于**您实际使用树莓派的情况。如果您想使用其他单板计算机（如香橙派或其他 Pi 衍生产品），
|
|
||||||
请查找如何将合适的 Linux 镜像写入 SD 卡（通常使用 Balena Etcher）。
|
|
||||||
同时确保 KIAUH 能够在您要安装的 Linux 发行版上运行。
|
|
||||||
您在使用基于 Debian 11 Bullseye 的系统时可能会获得最佳体验。
|
|
||||||
请阅读本文档下方的注意事项。
|
|
||||||
|
|
||||||
### 💾 下载并使用 KIAUH
|
|
||||||
|
|
||||||
**📢 免责声明：使用此脚本的风险由您自行承担！**
|
|
||||||
|
|
||||||
* **第一步：**
|
|
||||||
要下载此脚本，需要先安装 git。
|
|
||||||
如果您不确定是否已安装 git，请运行以下命令：
|
|
||||||
```shell
|
|
||||||
sudo apt-get update && sudo apt-get install git -y
|
|
||||||
```
|
|
||||||
|
|
||||||
* **第二步：**
|
|
||||||
安装完 git 后，
|
|
||||||
使用以下命令将 KIAUH 下载到您的主目录：
|
|
||||||
|
|
||||||
```shell
|
|
||||||
cd ~ && git clone https://github.com/dw-0/kiauh.git
|
|
||||||
```
|
|
||||||
|
|
||||||
* **第三步：**
|
|
||||||
最后，通过运行以下命令启动 KIAUH：
|
|
||||||
|
|
||||||
```shell
|
|
||||||
./kiauh/kiauh.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
* **第四步：**
|
|
||||||
您现在应该会看到 KIAUH 的主菜单。
|
|
||||||
根据您的选择，
|
|
||||||
您会看到几个可选操作。
|
|
||||||
要选择某个操作，只需在 "Perform action" 提示后输入对应的数字并按回车键确认。
|
|
||||||
|
|
||||||
## ❗ 注意事项
|
|
||||||
|
|
||||||
### **📋 请查看 [更新日志](docs/changelog.md) 以了解可能的重要更新！**
|
|
||||||
|
|
||||||
- 主要在 Raspberry Pi OS Lite (Debian 10 Buster / Debian 11 Bullseye) 上测试
|
|
||||||
- 其他基于 Debian 的发行版（如 Ubuntu 20 到 22）也可能正常工作
|
|
||||||
- 据报告在 Armbian 上也可用，但未进行详细测试
|
|
||||||
- 在使用此脚本的过程中，
|
|
||||||
您会被要求输入 sudo 密码。
|
|
||||||
因为有几个功能需要 sudo 权限。
|
|
||||||
|
|
||||||
## 🌐 相关资源与更多信息
|
|
||||||
|
|
||||||
<table align="center">
|
|
||||||
<tr>
|
|
||||||
<th><h3><a href="https://github.com/Klipper3d/klipper">Klipper</a></h3></th>
|
|
||||||
<th><h3><a href="https://github.com/Arksine/moonraker">Moonraker</a></h3></th>
|
|
||||||
<th><h3><a href="https://github.com/mainsail-crew/mainsail">Mainsail</a></h3></th>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<th><img src="https://raw.githubusercontent.com/Klipper3d/klipper/master/docs/img/klipper-logo.png" alt="Klipper Logo" height="64"></th>
|
|
||||||
<th><img src="https://avatars.githubusercontent.com/u/9563098?v=4" alt="Arksine avatar" height="64"></th>
|
|
||||||
<th><img src="https://raw.githubusercontent.com/mainsail-crew/docs/master/assets/img/logo.png" alt="Mainsail Logo" height="64"></th>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<th>由 <a href="https://github.com/KevinOConnor">KevinOConnor</a></th>
|
|
||||||
<th>由 <a href="https://github.com/Arksine">Arksine</a></th>
|
|
||||||
<th>由 <a href="https://github.com/mainsail-crew">mainsail-crew</a></th>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
<tr>
|
|
||||||
<th><h3><a href="https://github.com/fluidd-core/fluidd">Fluidd</a></h3></th>
|
|
||||||
<th><h3><a href="https://github.com/jordanruthe/KlipperScreen">KlipperScreen</a></h3></th>
|
|
||||||
<th><h3><a href="https://github.com/OctoPrint/OctoPrint">OctoPrint</a></h3></th>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<th><img src="https://raw.githubusercontent.com/fluidd-core/fluidd/master/docs/assets/images/logo.svg" alt="Fluidd Logo" height="64"></th>
|
|
||||||
<th><img src="https://avatars.githubusercontent.com/u/31575189?v=4" alt="jordanruthe avatar" height="64"></th>
|
|
||||||
<th><img src="https://raw.githubusercontent.com/OctoPrint/OctoPrint/master/docs/images/octoprint-logo.png" alt="OctoPrint Logo" height="64"></th>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<th>由 <a href="https://github.com/fluidd-core">fluidd-core</a></th>
|
|
||||||
<th>由 <a href="https://github.com/jordanruthe">jordanruthe</a></th>
|
|
||||||
<th>由 <a href="https://github.com/OctoPrint">OctoPrint</a></th>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
<tr>
|
|
||||||
<th><h3><a href="https://github.com/nlef/moonraker-telegram-bot">Moonraker-Telegram-Bot</a></h3></th>
|
|
||||||
<th><h3><a href="https://github.com/Kragrathea/pgcode">PrettyGCode for Klipper</a></h3></th>
|
|
||||||
<th><h3><a href="https://github.com/TheSpaghettiDetective/moonraker-obico">Obico for Klipper</a></h3></th>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<th><img src="https://avatars.githubusercontent.com/u/52351624?v=4" alt="nlef avatar" height="64"></th>
|
|
||||||
<th><img src="https://avatars.githubusercontent.com/u/5917231?v=4" alt="Kragrathea avatar" height="64"></th>
|
|
||||||
<th><img src="https://avatars.githubusercontent.com/u/46323662?s=200&v=4" alt="Obico logo" height="64"></th>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<th>由 <a href="https://github.com/nlef">nlef</a></th>
|
|
||||||
<th>由 <a href="https://github.com/Kragrathea">Kragrathea</a></th>
|
|
||||||
<th>由 <a href="https://github.com/TheSpaghettiDetective">Obico</a></th>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
<tr>
|
|
||||||
<th><h3><a href="https://github.com/Clon1998/mobileraker_companion">Mobileraker's Companion</a></h3></th>
|
|
||||||
<th><h3><a href="https://octoeverywhere.com/?source=kiauh_readme">OctoEverywhere For Klipper</a></h3></th>
|
|
||||||
<th><h3><a href="https://github.com/crysxd/OctoApp-Plugin">OctoApp For Klipper</a></h3></th>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<th><a href="https://github.com/Clon1998/mobileraker_companion"><img src="https://raw.githubusercontent.com/Clon1998/mobileraker/master/assets/icon/mr_appicon.png" alt="Mobileraker Logo" height="64"></a></th>
|
|
||||||
<th><a href="https://octoeverywhere.com/?source=kiauh_readme"><img src="https://octoeverywhere.com/img/logo.svg" alt="OctoEverywhere Logo" height="64"></a></th>
|
|
||||||
<th><a href="https://octoapp.eu/?source=kiauh_readme"><img src="https://octoapp.eu/octoapp.webp" alt="OctoApp Logo" height="64"></a></th>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<th>由 <a href="https://github.com/Clon1998">Patrick Schmidt</a></th>
|
|
||||||
<th>由 <a href="https://github.com/QuinnDamerell">Quinn Damerell</a></th>
|
|
||||||
<th>由 <a href="https://github.com/crysxd">Christian Würthner</a></th>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
<tr>
|
|
||||||
<th><h3><a href="https://github.com/staubgeborener/klipper-backup">Klipper-Backup</a></h3></th>
|
|
||||||
<th><h3><a href="https://simplyprint.io/">SimplyPrint for Klipper</a></h3></th>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<th><a href="https://github.com/staubgeborener/klipper-backup"><img src="https://avatars.githubusercontent.com/u/28908603?v=4" alt="Staubgeroner Avatar" height="64"></a></th>
|
|
||||||
<th><a href="https://github.com/SimplyPrint"><img src="https://avatars.githubusercontent.com/u/64896552?s=200&v=4" alt="" height="64"></a></th>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<th>由 <a href="https://github.com/Staubgeborener">Staubgeborener</a></th>
|
|
||||||
<th>由 <a href="https://github.com/SimplyPrint">SimplyPrint</a></th>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
## 🎖️ 贡献者
|
|
||||||
|
|
||||||
<div align="center">
|
|
||||||
<a href="https://github.com/dw-0/kiauh/graphs/contributors">
|
|
||||||
<img src="https://contrib.rocks/image?repo=dw-0/kiauh" alt=""/>
|
|
||||||
</a>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div align="center">
|
|
||||||
<img src="https://repobeats.axiom.co/api/embed/a1afbda9190c04a90cf4bd3061e5573bc836cb05.svg" alt="Repobeats analytics image"/>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
## ✨ 特别感谢
|
|
||||||
|
|
||||||
* 非常感谢 [lixxbox](https://github.com/lixxbox) 设计了如此出色的 KIAUH 标志！
|
|
||||||
* 同时，非常感谢所有通过 [Ko-fi](https://ko-fi.com/dw__0) 支持我的工作的人！
|
|
||||||
* 最后但同样重要的是：感谢所有为 Klipper 社区做出贡献的成员，以及喜欢和分享这个项目的朋友们！
|
|
||||||
|
|
||||||
<h4 align="center">特别感谢 JetBrains 为本项目提供其出色的软件赞助！</h4>
|
|
||||||
<p align="center">
|
|
||||||
<a href="https://www.jetbrains.com/community/opensource/#support" target="_blank">
|
|
||||||
<img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png" alt="JetBrains Logo (Main) logo." height="128">
|
|
||||||
</a>
|
|
||||||
</p>
|
|
||||||
@@ -0,0 +1,213 @@
|
|||||||
|
|
||||||
|
/* Avoid breaking parameter names, etc. in table cells. */
|
||||||
|
.doc-contents td code {
|
||||||
|
word-break: normal !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* No line break before first paragraph of descriptions. */
|
||||||
|
.doc-md-description,
|
||||||
|
.doc-md-description>p:first-child {
|
||||||
|
display: inline;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* No text transformation from Material for MkDocs for H5 headings. */
|
||||||
|
.md-typeset h5 .doc-object-name {
|
||||||
|
text-transform: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Max width for docstring sections tables. */
|
||||||
|
.doc .md-typeset__table,
|
||||||
|
.doc .md-typeset__table table {
|
||||||
|
display: table !important;
|
||||||
|
width: 100%;
|
||||||
|
}
|
||||||
|
|
||||||
|
.doc .md-typeset__table tr {
|
||||||
|
display: table-row;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Defaults in Spacy table style. */
|
||||||
|
.doc-param-default,
|
||||||
|
.doc-type_param-default {
|
||||||
|
float: right;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Parameter headings must be inline, not blocks. */
|
||||||
|
.doc-heading-parameter,
|
||||||
|
.doc-heading-type_parameter {
|
||||||
|
display: inline;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Default font size for parameter headings. */
|
||||||
|
.md-typeset .doc-heading-parameter {
|
||||||
|
font-size: inherit;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Prefer space on the right, not the left of parameter permalinks. */
|
||||||
|
.doc-heading-parameter .headerlink,
|
||||||
|
.doc-heading-type_parameter .headerlink {
|
||||||
|
margin-left: 0 !important;
|
||||||
|
margin-right: 0.2rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Backward-compatibility: docstring section titles in bold. */
|
||||||
|
.doc-section-title {
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Backlinks crumb separator. */
|
||||||
|
.doc-backlink-crumb {
|
||||||
|
display: inline-flex;
|
||||||
|
gap: .2rem;
|
||||||
|
white-space: nowrap;
|
||||||
|
align-items: center;
|
||||||
|
vertical-align: middle;
|
||||||
|
}
|
||||||
|
.doc-backlink-crumb:not(:first-child)::before {
|
||||||
|
background-color: var(--md-default-fg-color--lighter);
|
||||||
|
content: "";
|
||||||
|
display: inline;
|
||||||
|
height: 1rem;
|
||||||
|
--md-path-icon: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M8.59 16.58 13.17 12 8.59 7.41 10 6l6 6-6 6z"/></svg>');
|
||||||
|
-webkit-mask-image: var(--md-path-icon);
|
||||||
|
mask-image: var(--md-path-icon);
|
||||||
|
width: 1rem;
|
||||||
|
}
|
||||||
|
.doc-backlink-crumb.last {
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Symbols in Navigation and ToC. */
|
||||||
|
:root, :host,
|
||||||
|
[data-md-color-scheme="default"] {
|
||||||
|
--doc-symbol-parameter-fg-color: #df50af;
|
||||||
|
--doc-symbol-type_parameter-fg-color: #df50af;
|
||||||
|
--doc-symbol-attribute-fg-color: #953800;
|
||||||
|
--doc-symbol-function-fg-color: #8250df;
|
||||||
|
--doc-symbol-method-fg-color: #8250df;
|
||||||
|
--doc-symbol-class-fg-color: #0550ae;
|
||||||
|
--doc-symbol-type_alias-fg-color: #0550ae;
|
||||||
|
--doc-symbol-module-fg-color: #5cad0f;
|
||||||
|
|
||||||
|
--doc-symbol-parameter-bg-color: #df50af1a;
|
||||||
|
--doc-symbol-type_parameter-bg-color: #df50af1a;
|
||||||
|
--doc-symbol-attribute-bg-color: #9538001a;
|
||||||
|
--doc-symbol-function-bg-color: #8250df1a;
|
||||||
|
--doc-symbol-method-bg-color: #8250df1a;
|
||||||
|
--doc-symbol-class-bg-color: #0550ae1a;
|
||||||
|
--doc-symbol-type_alias-bg-color: #0550ae1a;
|
||||||
|
--doc-symbol-module-bg-color: #5cad0f1a;
|
||||||
|
}
|
||||||
|
|
||||||
|
[data-md-color-scheme="slate"] {
|
||||||
|
--doc-symbol-parameter-fg-color: #ffa8cc;
|
||||||
|
--doc-symbol-type_parameter-fg-color: #ffa8cc;
|
||||||
|
--doc-symbol-attribute-fg-color: #ffa657;
|
||||||
|
--doc-symbol-function-fg-color: #d2a8ff;
|
||||||
|
--doc-symbol-method-fg-color: #d2a8ff;
|
||||||
|
--doc-symbol-class-fg-color: #79c0ff;
|
||||||
|
--doc-symbol-type_alias-fg-color: #79c0ff;
|
||||||
|
--doc-symbol-module-fg-color: #baff79;
|
||||||
|
|
||||||
|
--doc-symbol-parameter-bg-color: #ffa8cc1a;
|
||||||
|
--doc-symbol-type_parameter-bg-color: #ffa8cc1a;
|
||||||
|
--doc-symbol-attribute-bg-color: #ffa6571a;
|
||||||
|
--doc-symbol-function-bg-color: #d2a8ff1a;
|
||||||
|
--doc-symbol-method-bg-color: #d2a8ff1a;
|
||||||
|
--doc-symbol-class-bg-color: #79c0ff1a;
|
||||||
|
--doc-symbol-type_alias-bg-color: #79c0ff1a;
|
||||||
|
--doc-symbol-module-bg-color: #baff791a;
|
||||||
|
}
|
||||||
|
|
||||||
|
code.doc-symbol {
|
||||||
|
border-radius: .1rem;
|
||||||
|
font-size: .85em;
|
||||||
|
padding: 0 .3em;
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
code.doc-symbol-parameter,
|
||||||
|
a code.doc-symbol-parameter {
|
||||||
|
color: var(--doc-symbol-parameter-fg-color);
|
||||||
|
background-color: var(--doc-symbol-parameter-bg-color);
|
||||||
|
}
|
||||||
|
|
||||||
|
code.doc-symbol-parameter::after {
|
||||||
|
content: "param";
|
||||||
|
}
|
||||||
|
|
||||||
|
code.doc-symbol-type_parameter,
|
||||||
|
a code.doc-symbol-type_parameter {
|
||||||
|
color: var(--doc-symbol-type_parameter-fg-color);
|
||||||
|
background-color: var(--doc-symbol-type_parameter-bg-color);
|
||||||
|
}
|
||||||
|
|
||||||
|
code.doc-symbol-type_parameter::after {
|
||||||
|
content: "type-param";
|
||||||
|
}
|
||||||
|
|
||||||
|
code.doc-symbol-attribute,
|
||||||
|
a code.doc-symbol-attribute {
|
||||||
|
color: var(--doc-symbol-attribute-fg-color);
|
||||||
|
background-color: var(--doc-symbol-attribute-bg-color);
|
||||||
|
}
|
||||||
|
|
||||||
|
code.doc-symbol-attribute::after {
|
||||||
|
content: "attr";
|
||||||
|
}
|
||||||
|
|
||||||
|
code.doc-symbol-function,
|
||||||
|
a code.doc-symbol-function {
|
||||||
|
color: var(--doc-symbol-function-fg-color);
|
||||||
|
background-color: var(--doc-symbol-function-bg-color);
|
||||||
|
}
|
||||||
|
|
||||||
|
code.doc-symbol-function::after {
|
||||||
|
content: "func";
|
||||||
|
}
|
||||||
|
|
||||||
|
code.doc-symbol-method,
|
||||||
|
a code.doc-symbol-method {
|
||||||
|
color: var(--doc-symbol-method-fg-color);
|
||||||
|
background-color: var(--doc-symbol-method-bg-color);
|
||||||
|
}
|
||||||
|
|
||||||
|
code.doc-symbol-method::after {
|
||||||
|
content: "meth";
|
||||||
|
}
|
||||||
|
|
||||||
|
code.doc-symbol-class,
|
||||||
|
a code.doc-symbol-class {
|
||||||
|
color: var(--doc-symbol-class-fg-color);
|
||||||
|
background-color: var(--doc-symbol-class-bg-color);
|
||||||
|
}
|
||||||
|
|
||||||
|
code.doc-symbol-class::after {
|
||||||
|
content: "class";
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
code.doc-symbol-type_alias,
|
||||||
|
a code.doc-symbol-type_alias {
|
||||||
|
color: var(--doc-symbol-type_alias-fg-color);
|
||||||
|
background-color: var(--doc-symbol-type_alias-bg-color);
|
||||||
|
}
|
||||||
|
|
||||||
|
code.doc-symbol-type_alias::after {
|
||||||
|
content: "type";
|
||||||
|
}
|
||||||
|
|
||||||
|
code.doc-symbol-module,
|
||||||
|
a code.doc-symbol-module {
|
||||||
|
color: var(--doc-symbol-module-fg-color);
|
||||||
|
background-color: var(--doc-symbol-module-bg-color);
|
||||||
|
}
|
||||||
|
|
||||||
|
code.doc-symbol-module::after {
|
||||||
|
content: "mod";
|
||||||
|
}
|
||||||
|
|
||||||
|
.doc-signature .autorefs {
|
||||||
|
color: inherit;
|
||||||
|
border-bottom: 1px dotted currentcolor;
|
||||||
|
}
|
||||||
@@ -0,0 +1,760 @@
|
|||||||
|
|
||||||
|
<!doctype html>
|
||||||
|
<html lang="en" class="no-js">
|
||||||
|
<head>
|
||||||
|
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||||
|
|
||||||
|
<meta name="description" content="Documentation for the Klipper Installation And Update Helper">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="icon" href="../logo.png">
|
||||||
|
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.18">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<title>Configuration - KIAUH Documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="../stylesheets/main.7e37652d.min.css">
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="../stylesheets/palette.06af60db.min.css">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
|
||||||
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
|
||||||
|
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="../_mkdocstrings.css">
|
||||||
|
|
||||||
|
<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</head>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="blue-grey" data-md-color-accent="cyan">
|
||||||
|
|
||||||
|
|
||||||
|
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
|
||||||
|
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
|
||||||
|
<label class="md-overlay" for="__drawer"></label>
|
||||||
|
<div data-md-component="skip">
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<div data-md-component="announce">
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<header class="md-header md-header--shadow" data-md-component="header">
|
||||||
|
<nav class="md-header__inner md-grid" aria-label="Header">
|
||||||
|
<a href="../.." title="KIAUH Documentation" class="md-header__button md-logo" aria-label="KIAUH Documentation" data-md-component="logo">
|
||||||
|
|
||||||
|
<img src="../logo.png" alt="logo">
|
||||||
|
|
||||||
|
</a>
|
||||||
|
<label class="md-header__button md-icon" for="__drawer">
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
|
||||||
|
</label>
|
||||||
|
<div class="md-header__title" data-md-component="header-title">
|
||||||
|
<div class="md-header__ellipsis">
|
||||||
|
<div class="md-header__topic">
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
KIAUH Documentation
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
<div class="md-header__topic" data-md-component="header-topic">
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
|
||||||
|
Configuration
|
||||||
|
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
<form class="md-header__option" data-md-component="palette">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="blue-grey" data-md-color-accent="cyan" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
|
||||||
|
|
||||||
|
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3zm3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95zm-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31"/></svg>
|
||||||
|
</label>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="blue-grey" data-md-color-accent="cyan" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
|
||||||
|
|
||||||
|
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 7a5 5 0 0 1 5 5 5 5 0 0 1-5 5 5 5 0 0 1-5-5 5 5 0 0 1 5-5m0 2a3 3 0 0 0-3 3 3 3 0 0 0 3 3 3 3 0 0 0 3-3 3 3 0 0 0-3-3m0-7 2.39 3.42C13.65 5.15 12.84 5 12 5s-1.65.15-2.39.42zM3.34 7l4.16-.35A7.2 7.2 0 0 0 5.94 8.5c-.44.74-.69 1.5-.83 2.29zm.02 10 1.76-3.77a7.131 7.131 0 0 0 2.38 4.14zM20.65 7l-1.77 3.79a7.02 7.02 0 0 0-2.38-4.15zm-.01 10-4.14.36c.59-.51 1.12-1.14 1.54-1.86.42-.73.69-1.5.83-2.29zM12 22l-2.41-3.44c.74.27 1.55.44 2.41.44.82 0 1.63-.17 2.37-.44z"/></svg>
|
||||||
|
</label>
|
||||||
|
|
||||||
|
|
||||||
|
</form>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<label class="md-header__button md-icon" for="__search">
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
|
||||||
|
</label>
|
||||||
|
<div class="md-search" data-md-component="search" role="dialog">
|
||||||
|
<label class="md-search__overlay" for="__search"></label>
|
||||||
|
<div class="md-search__inner" role="search">
|
||||||
|
<form class="md-search__form" name="search">
|
||||||
|
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
|
||||||
|
<label class="md-search__icon md-icon" for="__search">
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
|
||||||
|
</label>
|
||||||
|
<nav class="md-search__options" aria-label="Search">
|
||||||
|
|
||||||
|
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
|
||||||
|
</button>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
</form>
|
||||||
|
<div class="md-search__output">
|
||||||
|
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
|
||||||
|
<div class="md-search-result" data-md-component="search-result">
|
||||||
|
<div class="md-search-result__meta">
|
||||||
|
Initializing search
|
||||||
|
</div>
|
||||||
|
<ol class="md-search-result__list" role="presentation"></ol>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div class="md-header__source">
|
||||||
|
<a href="https://github.com/dw-0/kiauh" title="Go to repository" class="md-source" data-md-component="source">
|
||||||
|
<div class="md-source__icon md-icon">
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path fill="currentColor" d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
|
||||||
|
</div>
|
||||||
|
<div class="md-source__repository">
|
||||||
|
dw-0/kiauh
|
||||||
|
</div>
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
</header>
|
||||||
|
|
||||||
|
<div class="md-container" data-md-component="container">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<main class="md-main" data-md-component="main">
|
||||||
|
<div class="md-main__inner md-grid">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
|
||||||
|
<div class="md-sidebar__scrollwrap">
|
||||||
|
<div class="md-sidebar__inner">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
|
||||||
|
<label class="md-nav__title" for="__drawer">
|
||||||
|
<a href="../.." title="KIAUH Documentation" class="md-nav__button md-logo" aria-label="KIAUH Documentation" data-md-component="logo">
|
||||||
|
|
||||||
|
<img src="../logo.png" alt="logo">
|
||||||
|
|
||||||
|
</a>
|
||||||
|
KIAUH Documentation
|
||||||
|
</label>
|
||||||
|
|
||||||
|
<div class="md-nav__source">
|
||||||
|
<a href="https://github.com/dw-0/kiauh" title="Go to repository" class="md-source" data-md-component="source">
|
||||||
|
<div class="md-source__icon md-icon">
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path fill="currentColor" d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
|
||||||
|
</div>
|
||||||
|
<div class="md-source__repository">
|
||||||
|
dw-0/kiauh
|
||||||
|
</div>
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<ul class="md-nav__list" data-md-scrollfix>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="../.." class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Home
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
|
||||||
|
|
||||||
|
|
||||||
|
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Installation
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-nav__icon md-icon"></span>
|
||||||
|
</label>
|
||||||
|
|
||||||
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
|
||||||
|
<label class="md-nav__title" for="__nav_2">
|
||||||
|
<span class="md-nav__icon md-icon"></span>
|
||||||
|
Installation
|
||||||
|
</label>
|
||||||
|
<ul class="md-nav__list" data-md-scrollfix>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="../../setup/raspberry-pi-setup/" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Raspberry Pi Setup
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="../../setup/installation/" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Installing KIAUH
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="../../configuration.md" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Configuration
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
|
||||||
|
|
||||||
|
|
||||||
|
<div class="md-nav__link md-nav__container">
|
||||||
|
<a href="../../extensions/" class="md-nav__link ">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Extensions
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
|
||||||
|
|
||||||
|
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
|
||||||
|
<span class="md-nav__icon md-icon"></span>
|
||||||
|
</label>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
|
||||||
|
<label class="md-nav__title" for="__nav_4">
|
||||||
|
<span class="md-nav__icon md-icon"></span>
|
||||||
|
Extensions
|
||||||
|
</label>
|
||||||
|
<ul class="md-nav__list" data-md-scrollfix>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="../../extensions/gcode-shell-command/" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
G-Code Shell Command Extension
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
|
||||||
|
|
||||||
|
|
||||||
|
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Development
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-nav__icon md-icon"></span>
|
||||||
|
</label>
|
||||||
|
|
||||||
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
||||||
|
<label class="md-nav__title" for="__nav_5">
|
||||||
|
<span class="md-nav__icon md-icon"></span>
|
||||||
|
Development
|
||||||
|
</label>
|
||||||
|
<ul class="md-nav__list" data-md-scrollfix>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="../../development/contributing/" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Contributing
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="../../development/changelog/" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Changelog
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
|
||||||
|
<div class="md-sidebar__scrollwrap">
|
||||||
|
<div class="md-sidebar__inner">
|
||||||
|
|
||||||
|
|
||||||
|
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div class="md-content" data-md-component="content">
|
||||||
|
<article class="md-content__inner md-typeset">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h1>Configuration</h1>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<aside class="md-source-file">
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-source-file__fact">
|
||||||
|
<span class="md-icon" title="Last update">
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
|
||||||
|
</span>
|
||||||
|
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="August 29, 2025 18:23:31 UTC">August 29, 2025</span>
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-source-file__fact">
|
||||||
|
<span class="md-icon" title="Created">
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M14.47 15.08 11 13V7h1.5v5.25l3.08 1.83c-.41.28-.79.62-1.11 1m-1.39 4.84c-.36.05-.71.08-1.08.08-4.42 0-8-3.58-8-8s3.58-8 8-8 8 3.58 8 8c0 .37-.03.72-.08 1.08.69.1 1.33.32 1.92.64.1-.56.16-1.13.16-1.72 0-5.5-4.5-10-10-10S2 6.5 2 12s4.47 10 10 10c.59 0 1.16-.06 1.72-.16-.32-.59-.54-1.23-.64-1.92M18 15v3h-3v2h3v3h2v-3h3v-2h-3v-3z"/></svg>
|
||||||
|
</span>
|
||||||
|
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="August 29, 2025 18:23:31 UTC">August 29, 2025</span>
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</aside>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</article>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
|
||||||
|
Back to top
|
||||||
|
</button>
|
||||||
|
|
||||||
|
</main>
|
||||||
|
|
||||||
|
<footer class="md-footer">
|
||||||
|
|
||||||
|
<div class="md-footer-meta md-typeset">
|
||||||
|
<div class="md-footer-meta__inner md-grid">
|
||||||
|
<div class="md-copyright">
|
||||||
|
|
||||||
|
<div class="md-copyright__highlight">
|
||||||
|
Copyright © 2025 Dominik Willner
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
Made with
|
||||||
|
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
|
||||||
|
Material for MkDocs
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="md-social">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a href="https://github.com/dw-0" target="_blank" rel="noopener" title="github.com" class="md-social__link">
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12"/></svg>
|
||||||
|
</a>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a href="https://ko-fi.com/dw__0" target="_blank" rel="noopener" title="ko-fi.com" class="md-social__link">
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M11.351 2.715c-2.7 0-4.986.025-6.83.26C2.078 3.285 0 5.154 0 8.61c0 3.506.182 6.13 1.585 8.493 1.584 2.701 4.233 4.182 7.662 4.182h.83c4.209 0 6.494-2.234 7.637-4a9.5 9.5 0 0 0 1.091-2.338C21.792 14.688 24 12.22 24 9.208v-.415c0-3.247-2.13-5.507-5.792-5.87-1.558-.156-2.65-.208-6.857-.208m0 1.947c4.208 0 5.09.052 6.571.182 2.624.311 4.13 1.584 4.13 4v.39c0 2.156-1.792 3.844-3.87 3.844h-.935l-.156.649c-.208 1.013-.597 1.818-1.039 2.546-.909 1.428-2.545 3.064-5.922 3.064h-.805c-2.571 0-4.831-.883-6.078-3.195-1.09-2-1.298-4.155-1.298-7.506 0-2.181.857-3.402 3.012-3.714 1.533-.233 3.559-.26 6.39-.26m6.547 2.287c-.416 0-.65.234-.65.546v2.935c0 .311.234.545.65.545 1.324 0 2.051-.754 2.051-2s-.727-2.026-2.052-2.026m-10.39.182c-1.818 0-3.013 1.48-3.013 3.142 0 1.533.858 2.857 1.949 3.897.727.701 1.87 1.429 2.649 1.896a1.47 1.47 0 0 0 1.507 0c.78-.467 1.922-1.195 2.623-1.896 1.117-1.039 1.974-2.364 1.974-3.897 0-1.662-1.247-3.142-3.039-3.142-1.065 0-1.792.545-2.338 1.298-.493-.753-1.246-1.298-2.312-1.298"/></svg>
|
||||||
|
</a>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a href="https://www.paypal.com/paypalme/dwillner0" target="_blank" rel="noopener" title="www.paypal.com" class="md-social__link">
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M15.607 4.653H8.941L6.645 19.251H1.82L4.862 0h7.995c3.754 0 6.375 2.294 6.473 5.513-.648-.478-2.105-.86-3.722-.86m6.57 5.546c0 3.41-3.01 6.853-6.958 6.853h-2.493L11.595 24H6.74l1.845-11.538h3.592c4.208 0 7.346-3.634 7.153-6.949a5.24 5.24 0 0 1 2.848 4.686M9.653 5.546h6.408c.907 0 1.942.222 2.363.541-.195 2.741-2.655 5.483-6.441 5.483H8.714Z"/></svg>
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</footer>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<div class="md-dialog" data-md-component="dialog">
|
||||||
|
<div class="md-dialog__inner md-typeset"></div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script id="__config" type="application/json">{"base": "../..", "features": ["navigation.instant", "navigation.tracking", "navigation.sections", "navigation.expand", "navigation.indexes", "navigation.top", "toc.follow", "content.code.copy"], "search": "../javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
|
||||||
|
|
||||||
|
|
||||||
|
<script src="../javascripts/bundle.92b07e13.min.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 1.8 KiB |
+16
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
+1
File diff suppressed because one or more lines are too long
+18
@@ -0,0 +1,18 @@
|
|||||||
|
/*!
|
||||||
|
* Lunr languages, `Danish` language
|
||||||
|
* https://github.com/MihaiValentin/lunr-languages
|
||||||
|
*
|
||||||
|
* Copyright 2014, Mihai Valentin
|
||||||
|
* http://www.mozilla.org/MPL/
|
||||||
|
*/
|
||||||
|
/*!
|
||||||
|
* based on
|
||||||
|
* Snowball JavaScript Library v0.3
|
||||||
|
* http://code.google.com/p/urim/
|
||||||
|
* http://snowball.tartarus.org/
|
||||||
|
*
|
||||||
|
* Copyright 2010, Oleg Mazko
|
||||||
|
* http://www.mozilla.org/MPL/
|
||||||
|
*/
|
||||||
|
|
||||||
|
!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");e.da=function(){this.pipeline.reset(),this.pipeline.add(e.da.trimmer,e.da.stopWordFilter,e.da.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.da.stemmer))},e.da.wordCharacters="A-Za-zªºÀ-ÖØ-öø-ʸˠ-ˤᴀ-ᴥᴬ-ᵜᵢ-ᵥᵫ-ᵷᵹ-ᶾḀ-ỿⁱⁿₐ-ₜKÅℲⅎⅠ-ↈⱠ-ⱿꜢ-ꞇꞋ-ꞭꞰ-ꞷꟷ-ꟿꬰ-ꭚꭜ-ꭤff-stＡ-Ｚａ-ｚ",e.da.trimmer=e.trimmerSupport.generateTrimmer(e.da.wordCharacters),e.Pipeline.registerFunction(e.da.trimmer,"trimmer-da"),e.da.stemmer=function(){var r=e.stemmerSupport.Among,i=e.stemmerSupport.SnowballProgram,n=new function(){function e(){var e,r=f.cursor+3;if(d=f.limit,0<=r&&r<=f.limit){for(a=r;;){if(e=f.cursor,f.in_grouping(w,97,248)){f.cursor=e;break}if(f.cursor=e,e>=f.limit)return;f.cursor++}for(;!f.out_grouping(w,97,248);){if(f.cursor>=f.limit)return;f.cursor++}d=f.cursor,d<a&&(d=a)}}function n(){var e,r;if(f.cursor>=d&&(r=f.limit_backward,f.limit_backward=d,f.ket=f.cursor,e=f.find_among_b(c,32),f.limit_backward=r,e))switch(f.bra=f.cursor,e){case 1:f.slice_del();break;case 2:f.in_grouping_b(p,97,229)&&f.slice_del()}}function t(){var e,r=f.limit-f.cursor;f.cursor>=d&&(e=f.limit_backward,f.limit_backward=d,f.ket=f.cursor,f.find_among_b(l,4)?(f.bra=f.cursor,f.limit_backward=e,f.cursor=f.limit-r,f.cursor>f.limit_backward&&(f.cursor--,f.bra=f.cursor,f.slice_del())):f.limit_backward=e)}function s(){var e,r,i,n=f.limit-f.cursor;if(f.ket=f.cursor,f.eq_s_b(2,"st")&&(f.bra=f.cursor,f.eq_s_b(2,"ig")&&f.slice_del()),f.cursor=f.limit-n,f.cursor>=d&&(r=f.limit_backward,f.limit_backward=d,f.ket=f.cursor,e=f.find_among_b(m,5),f.limit_backward=r,e))switch(f.bra=f.cursor,e){case 1:f.slice_del(),i=f.limit-f.cursor,t(),f.cursor=f.limit-i;break;case 2:f.slice_from("løs")}}function o(){var e;f.cursor>=d&&(e=f.limit_backward,f.limit_backward=d,f.ket=f.cursor,f.out_grouping_b(w,97,248)?(f.bra=f.cursor,u=f.slice_to(u),f.limit_backward=e,f.eq_v_b(u)&&f.slice_del()):f.limit_backward=e)}var a,d,u,c=[new r("hed",-1,1),new r("ethed",0,1),new r("ered",-1,1),new r("e",-1,1),new r("erede",3,1),new r("ende",3,1),new r("erende",5,1),new r("ene",3,1),new r("erne",3,1),new r("ere",3,1),new r("en",-1,1),new r("heden",10,1),new r("eren",10,1),new r("er",-1,1),new r("heder",13,1),new r("erer",13,1),new r("s",-1,2),new r("heds",16,1),new r("es",16,1),new r("endes",18,1),new r("erendes",19,1),new r("enes",18,1),new r("ernes",18,1),new r("eres",18,1),new r("ens",16,1),new r("hedens",24,1),new r("erens",24,1),new r("ers",16,1),new r("ets",16,1),new r("erets",28,1),new r("et",-1,1),new r("eret",30,1)],l=[new r("gd",-1,-1),new r("dt",-1,-1),new r("gt",-1,-1),new r("kt",-1,-1)],m=[new r("ig",-1,1),new r("lig",0,1),new r("elig",1,1),new r("els",-1,1),new r("løst",-1,2)],w=[17,65,16,1,0,0,0,0,0,0,0,0,0,0,0,0,48,0,128],p=[239,254,42,3,0,0,0,0,0,0,0,0,0,0,0,0,16],f=new i;this.setCurrent=function(e){f.setCurrent(e)},this.getCurrent=function(){return f.getCurrent()},this.stem=function(){var r=f.cursor;return e(),f.limit_backward=r,f.cursor=f.limit,n(),f.cursor=f.limit,t(),f.cursor=f.limit,s(),f.cursor=f.limit,o(),!0}};return function(e){return"function"==typeof e.update?e.update(function(e){return n.setCurrent(e),n.stem(),n.getCurrent()}):(n.setCurrent(e),n.stem(),n.getCurrent())}}(),e.Pipeline.registerFunction(e.da.stemmer,"stemmer-da"),e.da.stopWordFilter=e.generateStopWordFilter("ad af alle alt anden at blev blive bliver da de dem den denne der deres det dette dig din disse dog du efter eller en end er et for fra ham han hans har havde have hende hendes her hos hun hvad hvis hvor i ikke ind jeg jer jo kunne man mange med meget men mig min mine mit mod ned noget nogle nu når og også om op os over på selv sig sin sine sit skal skulle som sådan thi til ud under var vi vil ville vor være været".split(" ")),e.Pipeline.registerFunction(e.da.stopWordFilter,"stopWordFilter-da")}});
|
||||||
+18
File diff suppressed because one or more lines are too long
+18
File diff suppressed because one or more lines are too long
+1
File diff suppressed because one or more lines are too long
+18
File diff suppressed because one or more lines are too long
+18
File diff suppressed because one or more lines are too long
+18
File diff suppressed because one or more lines are too long
+1
File diff suppressed because one or more lines are too long
+1
@@ -0,0 +1 @@
|
|||||||
|
!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");e.hi=function(){this.pipeline.reset(),this.pipeline.add(e.hi.trimmer,e.hi.stopWordFilter,e.hi.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.hi.stemmer))},e.hi.wordCharacters="ऀ-ःऄ-एऐ-टठ-यर-िी-ॏॐ-य़ॠ-९॰-ॿa-zA-Zａ-ｚＡ-Ｚ0-9０-９",e.hi.trimmer=e.trimmerSupport.generateTrimmer(e.hi.wordCharacters),e.Pipeline.registerFunction(e.hi.trimmer,"trimmer-hi"),e.hi.stopWordFilter=e.generateStopWordFilter("अत अपना अपनी अपने अभी अंदर आदि आप इत्यादि इन इनका इन्हीं इन्हें इन्हों इस इसका इसकी इसके इसमें इसी इसे उन उनका उनकी उनके उनको उन्हीं उन्हें उन्हों उस उसके उसी उसे एक एवं एस ऐसे और कई कर करता करते करना करने करें कहते कहा का काफ़ी कि कितना किन्हें किन्हों किया किर किस किसी किसे की कुछ कुल के को कोई कौन कौनसा गया घर जब जहाँ जा जितना जिन जिन्हें जिन्हों जिस जिसे जीधर जैसा जैसे जो तक तब तरह तिन तिन्हें तिन्हों तिस तिसे तो था थी थे दबारा दिया दुसरा दूसरे दो द्वारा न नके नहीं ना निहायत नीचे ने पर पहले पूरा पे फिर बनी बही बहुत बाद बाला बिलकुल भी भीतर मगर मानो मे में यदि यह यहाँ यही या यिह ये रखें रहा रहे ऱ्वासा लिए लिये लेकिन व वग़ैरह वर्ग वह वहाँ वहीं वाले वुह वे वो सकता सकते सबसे सभी साथ साबुत साभ सारा से सो संग ही हुआ हुई हुए है हैं हो होता होती होते होना होने".split(" ")),e.hi.stemmer=function(){return function(e){return"function"==typeof e.update?e.update(function(e){return e}):e}}();var r=e.wordcut;r.init(),e.hi.tokenizer=function(i){if(!arguments.length||null==i||void 0==i)return[];if(Array.isArray(i))return i.map(function(r){return isLunr2?new e.Token(r.toLowerCase()):r.toLowerCase()});var t=i.toString().toLowerCase().replace(/^\s+/,"");return r.cut(t).split("|")},e.Pipeline.registerFunction(e.hi.stemmer,"stemmer-hi"),e.Pipeline.registerFunction(e.hi.stopWordFilter,"stopWordFilter-hi")}});
|
||||||
+18
File diff suppressed because one or more lines are too long
+1
@@ -0,0 +1 @@
|
|||||||
|
!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");e.hy=function(){this.pipeline.reset(),this.pipeline.add(e.hy.trimmer,e.hy.stopWordFilter)},e.hy.wordCharacters="[A-Za-z-֏ff-ﭏ]",e.hy.trimmer=e.trimmerSupport.generateTrimmer(e.hy.wordCharacters),e.Pipeline.registerFunction(e.hy.trimmer,"trimmer-hy"),e.hy.stopWordFilter=e.generateStopWordFilter("դու և եք էիր էիք հետո նաև նրանք որը վրա է որ պիտի են այս մեջ ն իր ու ի այդ որոնք այն կամ էր մի ես համար այլ իսկ էին ենք հետ ին թ էինք մենք նրա նա դուք եմ էի ըստ որպես ում".split(" ")),e.Pipeline.registerFunction(e.hy.stopWordFilter,"stopWordFilter-hy"),e.hy.stemmer=function(){return function(e){return"function"==typeof e.update?e.update(function(e){return e}):e}}(),e.Pipeline.registerFunction(e.hy.stemmer,"stemmer-hy")}});
|
||||||
+18
File diff suppressed because one or more lines are too long
+1
@@ -0,0 +1 @@
|
|||||||
|
!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");var r="2"==e.version[0];e.ja=function(){this.pipeline.reset(),this.pipeline.add(e.ja.trimmer,e.ja.stopWordFilter,e.ja.stemmer),r?this.tokenizer=e.ja.tokenizer:(e.tokenizer&&(e.tokenizer=e.ja.tokenizer),this.tokenizerFn&&(this.tokenizerFn=e.ja.tokenizer))};var t=new e.TinySegmenter;e.ja.tokenizer=function(i){var n,o,s,p,a,u,m,l,c,f;if(!arguments.length||null==i||void 0==i)return[];if(Array.isArray(i))return i.map(function(t){return r?new e.Token(t.toLowerCase()):t.toLowerCase()});for(o=i.toString().toLowerCase().replace(/^\s+/,""),n=o.length-1;n>=0;n--)if(/\S/.test(o.charAt(n))){o=o.substring(0,n+1);break}for(a=[],s=o.length,c=0,l=0;c<=s;c++)if(u=o.charAt(c),m=c-l,u.match(/\s/)||c==s){if(m>0)for(p=t.segment(o.slice(l,c)).filter(function(e){return!!e}),f=l,n=0;n<p.length;n++)r?a.push(new e.Token(p[n],{position:[f,p[n].length],index:a.length})):a.push(p[n]),f+=p[n].length;l=c+1}return a},e.ja.stemmer=function(){return function(e){return e}}(),e.Pipeline.registerFunction(e.ja.stemmer,"stemmer-ja"),e.ja.wordCharacters="一二三四五六七八九十百千万億兆一-龠々〆ヵヶぁ-んァ-ヴーｱ-ﾝﾞa-zA-Zａ-ｚＡ-Ｚ0-9０-９",e.ja.trimmer=e.trimmerSupport.generateTrimmer(e.ja.wordCharacters),e.Pipeline.registerFunction(e.ja.trimmer,"trimmer-ja"),e.ja.stopWordFilter=e.generateStopWordFilter("これ それ あれ この その あの ここ そこ あそこ こちら どこ だれ なに なん 何 私 貴方 貴方方 我々 私達 あの人 あのかた 彼女 彼 です あります おります います は が の に を で え から まで より も どの と し それで しかし".split(" ")),e.Pipeline.registerFunction(e.ja.stopWordFilter,"stopWordFilter-ja"),e.jp=e.ja,e.Pipeline.registerFunction(e.jp.stemmer,"stemmer-jp"),e.Pipeline.registerFunction(e.jp.trimmer,"trimmer-jp"),e.Pipeline.registerFunction(e.jp.stopWordFilter,"stopWordFilter-jp")}});
|
||||||
+1
@@ -0,0 +1 @@
|
|||||||
|
module.exports=require("./lunr.ja");
|
||||||
+1
@@ -0,0 +1 @@
|
|||||||
|
!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");e.kn=function(){this.pipeline.reset(),this.pipeline.add(e.kn.trimmer,e.kn.stopWordFilter,e.kn.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.kn.stemmer))},e.kn.wordCharacters="ಀ-಄ಅ-ಔಕ-ಹಾ-ೌ಼-ಽೕ-ೖೝ-ೞೠ-ೡೢ-ೣ೦-೯ೱ-ೳ",e.kn.trimmer=e.trimmerSupport.generateTrimmer(e.kn.wordCharacters),e.Pipeline.registerFunction(e.kn.trimmer,"trimmer-kn"),e.kn.stopWordFilter=e.generateStopWordFilter("ಮತ್ತು ಈ ಒಂದು ರಲ್ಲಿ ಹಾಗೂ ಎಂದು ಅಥವಾ ಇದು ರ ಅವರು ಎಂಬ ಮೇಲೆ ಅವರ ತನ್ನ ಆದರೆ ತಮ್ಮ ನಂತರ ಮೂಲಕ ಹೆಚ್ಚು ನ ಆ ಕೆಲವು ಅನೇಕ ಎರಡು ಹಾಗು ಪ್ರಮುಖ ಇದನ್ನು ಇದರ ಸುಮಾರು ಅದರ ಅದು ಮೊದಲ ಬಗ್ಗೆ ನಲ್ಲಿ ರಂದು ಇತರ ಅತ್ಯಂತ ಹೆಚ್ಚಿನ ಸಹ ಸಾಮಾನ್ಯವಾಗಿ ನೇ ಹಲವಾರು ಹೊಸ ದಿ ಕಡಿಮೆ ಯಾವುದೇ ಹೊಂದಿದೆ ದೊಡ್ಡ ಅನ್ನು ಇವರು ಪ್ರಕಾರ ಇದೆ ಮಾತ್ರ ಕೂಡ ಇಲ್ಲಿ ಎಲ್ಲಾ ವಿವಿಧ ಅದನ್ನು ಹಲವು ರಿಂದ ಕೇವಲ ದ ದಕ್ಷಿಣ ಗೆ ಅವನ ಅತಿ ನೆಯ ಬಹಳ ಕೆಲಸ ಎಲ್ಲ ಪ್ರತಿ ಇತ್ಯಾದಿ ಇವು ಬೇರೆ ಹೀಗೆ ನಡುವೆ ಇದಕ್ಕೆ ಎಸ್ ಇವರ ಮೊದಲು ಶ್ರೀ ಮಾಡುವ ಇದರಲ್ಲಿ ರೀತಿಯ ಮಾಡಿದ ಕಾಲ ಅಲ್ಲಿ ಮಾಡಲು ಅದೇ ಈಗ ಅವು ಗಳು ಎ ಎಂಬುದು ಅವನು ಅಂದರೆ ಅವರಿಗೆ ಇರುವ ವಿಶೇಷ ಮುಂದೆ ಅವುಗಳ ಮುಂತಾದ ಮೂಲ ಬಿ ಮೀ ಒಂದೇ ಇನ್ನೂ ಹೆಚ್ಚಾಗಿ ಮಾಡಿ ಅವರನ್ನು ಇದೇ ಯ ರೀತಿಯಲ್ಲಿ ಜೊತೆ ಅದರಲ್ಲಿ ಮಾಡಿದರು ನಡೆದ ಆಗ ಮತ್ತೆ ಪೂರ್ವ ಆತ ಬಂದ ಯಾವ ಒಟ್ಟು ಇತರೆ ಹಿಂದೆ ಪ್ರಮಾಣದ ಗಳನ್ನು ಕುರಿತು ಯು ಆದ್ದರಿಂದ ಅಲ್ಲದೆ ನಗರದ ಮೇಲಿನ ಏಕೆಂದರೆ ರಷ್ಟು ಎಂಬುದನ್ನು ಬಾರಿ ಎಂದರೆ ಹಿಂದಿನ ಆದರೂ ಆದ ಸಂಬಂಧಿಸಿದ ಮತ್ತೊಂದು ಸಿ ಆತನ ".split(" ")),e.kn.stemmer=function(){return function(e){return"function"==typeof e.update?e.update(function(e){return e}):e}}();var r=e.wordcut;r.init(),e.kn.tokenizer=function(t){if(!arguments.length||null==t||void 0==t)return[];if(Array.isArray(t))return t.map(function(r){return isLunr2?new e.Token(r.toLowerCase()):r.toLowerCase()});var n=t.toString().toLowerCase().replace(/^\s+/,"");return r.cut(n).split("|")},e.Pipeline.registerFunction(e.kn.stemmer,"stemmer-kn"),e.Pipeline.registerFunction(e.kn.stopWordFilter,"stopWordFilter-kn")}});
|
||||||
+1
File diff suppressed because one or more lines are too long
@@ -0,0 +1 @@
|
|||||||
|
!function(e,t){"function"==typeof define&&define.amd?define(t):"object"==typeof exports?module.exports=t():t()(e.lunr)}(this,function(){return function(e){e.multiLanguage=function(){for(var t=Array.prototype.slice.call(arguments),i=t.join("-"),r="",n=[],s=[],p=0;p<t.length;++p)"en"==t[p]?(r+="\\w",n.unshift(e.stopWordFilter),n.push(e.stemmer),s.push(e.stemmer)):(r+=e[t[p]].wordCharacters,e[t[p]].stopWordFilter&&n.unshift(e[t[p]].stopWordFilter),e[t[p]].stemmer&&(n.push(e[t[p]].stemmer),s.push(e[t[p]].stemmer)));var o=e.trimmerSupport.generateTrimmer(r);return e.Pipeline.registerFunction(o,"lunr-multi-trimmer-"+i),n.unshift(o),function(){this.pipeline.reset(),this.pipeline.add.apply(this.pipeline,n),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add.apply(this.searchPipeline,s))}}}});
|
||||||
+18
File diff suppressed because one or more lines are too long
+18
@@ -0,0 +1,18 @@
|
|||||||
|
/*!
|
||||||
|
* Lunr languages, `Norwegian` language
|
||||||
|
* https://github.com/MihaiValentin/lunr-languages
|
||||||
|
*
|
||||||
|
* Copyright 2014, Mihai Valentin
|
||||||
|
* http://www.mozilla.org/MPL/
|
||||||
|
*/
|
||||||
|
/*!
|
||||||
|
* based on
|
||||||
|
* Snowball JavaScript Library v0.3
|
||||||
|
* http://code.google.com/p/urim/
|
||||||
|
* http://snowball.tartarus.org/
|
||||||
|
*
|
||||||
|
* Copyright 2010, Oleg Mazko
|
||||||
|
* http://www.mozilla.org/MPL/
|
||||||
|
*/
|
||||||
|
|
||||||
|
!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");e.no=function(){this.pipeline.reset(),this.pipeline.add(e.no.trimmer,e.no.stopWordFilter,e.no.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.no.stemmer))},e.no.wordCharacters="A-Za-zªºÀ-ÖØ-öø-ʸˠ-ˤᴀ-ᴥᴬ-ᵜᵢ-ᵥᵫ-ᵷᵹ-ᶾḀ-ỿⁱⁿₐ-ₜKÅℲⅎⅠ-ↈⱠ-ⱿꜢ-ꞇꞋ-ꞭꞰ-ꞷꟷ-ꟿꬰ-ꭚꭜ-ꭤff-stＡ-Ｚａ-ｚ",e.no.trimmer=e.trimmerSupport.generateTrimmer(e.no.wordCharacters),e.Pipeline.registerFunction(e.no.trimmer,"trimmer-no"),e.no.stemmer=function(){var r=e.stemmerSupport.Among,n=e.stemmerSupport.SnowballProgram,i=new function(){function e(){var e,r=w.cursor+3;if(a=w.limit,0<=r||r<=w.limit){for(s=r;;){if(e=w.cursor,w.in_grouping(d,97,248)){w.cursor=e;break}if(e>=w.limit)return;w.cursor=e+1}for(;!w.out_grouping(d,97,248);){if(w.cursor>=w.limit)return;w.cursor++}a=w.cursor,a<s&&(a=s)}}function i(){var e,r,n;if(w.cursor>=a&&(r=w.limit_backward,w.limit_backward=a,w.ket=w.cursor,e=w.find_among_b(m,29),w.limit_backward=r,e))switch(w.bra=w.cursor,e){case 1:w.slice_del();break;case 2:n=w.limit-w.cursor,w.in_grouping_b(c,98,122)?w.slice_del():(w.cursor=w.limit-n,w.eq_s_b(1,"k")&&w.out_grouping_b(d,97,248)&&w.slice_del());break;case 3:w.slice_from("er")}}function t(){var e,r=w.limit-w.cursor;w.cursor>=a&&(e=w.limit_backward,w.limit_backward=a,w.ket=w.cursor,w.find_among_b(u,2)?(w.bra=w.cursor,w.limit_backward=e,w.cursor=w.limit-r,w.cursor>w.limit_backward&&(w.cursor--,w.bra=w.cursor,w.slice_del())):w.limit_backward=e)}function o(){var e,r;w.cursor>=a&&(r=w.limit_backward,w.limit_backward=a,w.ket=w.cursor,e=w.find_among_b(l,11),e?(w.bra=w.cursor,w.limit_backward=r,1==e&&w.slice_del()):w.limit_backward=r)}var s,a,m=[new r("a",-1,1),new r("e",-1,1),new r("ede",1,1),new r("ande",1,1),new r("ende",1,1),new r("ane",1,1),new r("ene",1,1),new r("hetene",6,1),new r("erte",1,3),new r("en",-1,1),new r("heten",9,1),new r("ar",-1,1),new r("er",-1,1),new r("heter",12,1),new r("s",-1,2),new r("as",14,1),new r("es",14,1),new r("edes",16,1),new r("endes",16,1),new r("enes",16,1),new r("hetenes",19,1),new r("ens",14,1),new r("hetens",21,1),new r("ers",14,1),new r("ets",14,1),new r("et",-1,1),new r("het",25,1),new r("ert",-1,3),new r("ast",-1,1)],u=[new r("dt",-1,-1),new r("vt",-1,-1)],l=[new r("leg",-1,1),new r("eleg",0,1),new r("ig",-1,1),new r("eig",2,1),new r("lig",2,1),new r("elig",4,1),new r("els",-1,1),new r("lov",-1,1),new r("elov",7,1),new r("slov",7,1),new r("hetslov",9,1)],d=[17,65,16,1,0,0,0,0,0,0,0,0,0,0,0,0,48,0,128],c=[119,125,149,1],w=new n;this.setCurrent=function(e){w.setCurrent(e)},this.getCurrent=function(){return w.getCurrent()},this.stem=function(){var r=w.cursor;return e(),w.limit_backward=r,w.cursor=w.limit,i(),w.cursor=w.limit,t(),w.cursor=w.limit,o(),!0}};return function(e){return"function"==typeof e.update?e.update(function(e){return i.setCurrent(e),i.stem(),i.getCurrent()}):(i.setCurrent(e),i.stem(),i.getCurrent())}}(),e.Pipeline.registerFunction(e.no.stemmer,"stemmer-no"),e.no.stopWordFilter=e.generateStopWordFilter("alle at av bare begge ble blei bli blir blitt både båe da de deg dei deim deira deires dem den denne der dere deres det dette di din disse ditt du dykk dykkar då eg ein eit eitt eller elles en enn er et ett etter for fordi fra før ha hadde han hans har hennar henne hennes her hjå ho hoe honom hoss hossen hun hva hvem hver hvilke hvilken hvis hvor hvordan hvorfor i ikke ikkje ikkje ingen ingi inkje inn inni ja jeg kan kom korleis korso kun kunne kva kvar kvarhelst kven kvi kvifor man mange me med medan meg meget mellom men mi min mine mitt mot mykje ned no noe noen noka noko nokon nokor nokre nå når og også om opp oss over på samme seg selv si si sia sidan siden sin sine sitt sjøl skal skulle slik so som som somme somt så sånn til um upp ut uten var vart varte ved vere verte vi vil ville vore vors vort vår være være vært å".split(" ")),e.Pipeline.registerFunction(e.no.stopWordFilter,"stopWordFilter-no")}});
|
||||||
+18
File diff suppressed because one or more lines are too long
+18
File diff suppressed because one or more lines are too long
+18
File diff suppressed because one or more lines are too long
+1
@@ -0,0 +1 @@
|
|||||||
|
!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");e.sa=function(){this.pipeline.reset(),this.pipeline.add(e.sa.trimmer,e.sa.stopWordFilter,e.sa.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.sa.stemmer))},e.sa.wordCharacters="ऀ-ःऄ-एऐ-टठ-यर-िी-ॏॐ-य़ॠ-९॰-ॿ꣠-꣱ꣲ-ꣷ꣸-ꣻ꣼-ꣽꣾ-ꣿᆰ0-ᆰ9",e.sa.trimmer=e.trimmerSupport.generateTrimmer(e.sa.wordCharacters),e.Pipeline.registerFunction(e.sa.trimmer,"trimmer-sa"),e.sa.stopWordFilter=e.generateStopWordFilter('तथा अयम् एकम् इत्यस्मिन् तथा तत् वा अयम् इत्यस्य ते आहूत उपरि तेषाम् किन्तु तेषाम् तदा इत्यनेन अधिकः इत्यस्य तत् केचन बहवः द्वि तथा महत्वपूर्णः अयम् अस्य विषये अयं अस्ति तत् प्रथमः विषये इत्युपरि इत्युपरि इतर अधिकतमः अधिकः अपि सामान्यतया ठ इतरेतर नूतनम् द न्यूनम् कश्चित् वा विशालः द सः अस्ति तदनुसारम् तत्र अस्ति केवलम् अपि अत्र सर्वे विविधाः तत् बहवः यतः इदानीम् द दक्षिण इत्यस्मै तस्य उपरि नथ अतीव कार्यम् सर्वे एकैकम् इत्यादि। एते सन्ति उत इत्थम् मध्ये एतदर्थं . स कस्य प्रथमः श्री. करोति अस्मिन् प्रकारः निर्मिता कालः तत्र कर्तुं समान अधुना ते सन्ति स एकः अस्ति सः अर्थात् तेषां कृते . स्थितम् विशेषः अग्रिम तेषाम् समान स्रोतः ख म समान इदानीमपि अधिकतया करोतु ते समान इत्यस्य वीथी सह यस्मिन् कृतवान् धृतः तदा पुनः पूर्वं सः आगतः किम् कुल इतर पुरा मात्रा स विषये उ अतएव अपि नगरस्य उपरि यतः प्रतिशतं कतरः कालः साधनानि भूत तथापि जात सम्बन्धि अन्यत् ग अतः अस्माकं स्वकीयाः अस्माकं इदानीं अन्तः इत्यादयः भवन्तः इत्यादयः एते एताः तस्य अस्य इदम् एते तेषां तेषां तेषां तान् तेषां तेषां तेषां समानः सः एकः च तादृशाः बहवः अन्ये च वदन्ति यत् कियत् कस्मै कस्मै यस्मै यस्मै यस्मै यस्मै न अतिनीचः किन्तु प्रथमं सम्पूर्णतया ततः चिरकालानन्तरं पुस्तकं सम्पूर्णतया अन्तः किन्तु अत्र वा इह इव श्रद्धाय अवशिष्यते परन्तु अन्ये वर्गाः सन्ति ते सन्ति शक्नुवन्ति सर्वे मिलित्वा सर्वे एकत्र"'.split(" ")),e.sa.stemmer=function(){return function(e){return"function"==typeof e.update?e.update(function(e){return e}):e}}();var r=e.wordcut;r.init(),e.sa.tokenizer=function(t){if(!arguments.length||null==t||void 0==t)return[];if(Array.isArray(t))return t.map(function(r){return isLunr2?new e.Token(r.toLowerCase()):r.toLowerCase()});var i=t.toString().toLowerCase().replace(/^\s+/,"");return r.cut(i).split("|")},e.Pipeline.registerFunction(e.sa.stemmer,"stemmer-sa"),e.Pipeline.registerFunction(e.sa.stopWordFilter,"stopWordFilter-sa")}});
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
!function(r,t){"function"==typeof define&&define.amd?define(t):"object"==typeof exports?module.exports=t():t()(r.lunr)}(this,function(){return function(r){r.stemmerSupport={Among:function(r,t,i,s){if(this.toCharArray=function(r){for(var t=r.length,i=new Array(t),s=0;s<t;s++)i[s]=r.charCodeAt(s);return i},!r&&""!=r||!t&&0!=t||!i)throw"Bad Among initialisation: s:"+r+", substring_i: "+t+", result: "+i;this.s_size=r.length,this.s=this.toCharArray(r),this.substring_i=t,this.result=i,this.method=s},SnowballProgram:function(){var r;return{bra:0,ket:0,limit:0,cursor:0,limit_backward:0,setCurrent:function(t){r=t,this.cursor=0,this.limit=t.length,this.limit_backward=0,this.bra=this.cursor,this.ket=this.limit},getCurrent:function(){var t=r;return r=null,t},in_grouping:function(t,i,s){if(this.cursor<this.limit){var e=r.charCodeAt(this.cursor);if(e<=s&&e>=i&&(e-=i,t[e>>3]&1<<(7&e)))return this.cursor++,!0}return!1},in_grouping_b:function(t,i,s){if(this.cursor>this.limit_backward){var e=r.charCodeAt(this.cursor-1);if(e<=s&&e>=i&&(e-=i,t[e>>3]&1<<(7&e)))return this.cursor--,!0}return!1},out_grouping:function(t,i,s){if(this.cursor<this.limit){var e=r.charCodeAt(this.cursor);if(e>s||e<i)return this.cursor++,!0;if(e-=i,!(t[e>>3]&1<<(7&e)))return this.cursor++,!0}return!1},out_grouping_b:function(t,i,s){if(this.cursor>this.limit_backward){var e=r.charCodeAt(this.cursor-1);if(e>s||e<i)return this.cursor--,!0;if(e-=i,!(t[e>>3]&1<<(7&e)))return this.cursor--,!0}return!1},eq_s:function(t,i){if(this.limit-this.cursor<t)return!1;for(var s=0;s<t;s++)if(r.charCodeAt(this.cursor+s)!=i.charCodeAt(s))return!1;return this.cursor+=t,!0},eq_s_b:function(t,i){if(this.cursor-this.limit_backward<t)return!1;for(var s=0;s<t;s++)if(r.charCodeAt(this.cursor-t+s)!=i.charCodeAt(s))return!1;return this.cursor-=t,!0},find_among:function(t,i){for(var s=0,e=i,n=this.cursor,u=this.limit,o=0,h=0,c=!1;;){for(var a=s+(e-s>>1),f=0,l=o<h?o:h,_=t[a],m=l;m<_.s_size;m++){if(n+l==u){f=-1;break}if(f=r.charCodeAt(n+l)-_.s[m])break;l++}if(f<0?(e=a,h=l):(s=a,o=l),e-s<=1){if(s>0||e==s||c)break;c=!0}}for(;;){var _=t[s];if(o>=_.s_size){if(this.cursor=n+_.s_size,!_.method)return _.result;var b=_.method();if(this.cursor=n+_.s_size,b)return _.result}if((s=_.substring_i)<0)return 0}},find_among_b:function(t,i){for(var s=0,e=i,n=this.cursor,u=this.limit_backward,o=0,h=0,c=!1;;){for(var a=s+(e-s>>1),f=0,l=o<h?o:h,_=t[a],m=_.s_size-1-l;m>=0;m--){if(n-l==u){f=-1;break}if(f=r.charCodeAt(n-1-l)-_.s[m])break;l++}if(f<0?(e=a,h=l):(s=a,o=l),e-s<=1){if(s>0||e==s||c)break;c=!0}}for(;;){var _=t[s];if(o>=_.s_size){if(this.cursor=n-_.s_size,!_.method)return _.result;var b=_.method();if(this.cursor=n-_.s_size,b)return _.result}if((s=_.substring_i)<0)return 0}},replace_s:function(t,i,s){var e=s.length-(i-t),n=r.substring(0,t),u=r.substring(i);return r=n+s+u,this.limit+=e,this.cursor>=i?this.cursor+=e:this.cursor>t&&(this.cursor=t),e},slice_check:function(){if(this.bra<0||this.bra>this.ket||this.ket>this.limit||this.limit>r.length)throw"faulty slice operation"},slice_from:function(r){this.slice_check(),this.replace_s(this.bra,this.ket,r)},slice_del:function(){this.slice_from("")},insert:function(r,t,i){var s=this.replace_s(r,t,i);r<=this.bra&&(this.bra+=s),r<=this.ket&&(this.ket+=s)},slice_to:function(){return this.slice_check(),r.substring(this.bra,this.ket)},eq_v_b:function(r){return this.eq_s_b(r.length,r)}}}},r.trimmerSupport={generateTrimmer:function(r){var t=new RegExp("^[^"+r+"]+"),i=new RegExp("[^"+r+"]+$");return function(r){return"function"==typeof r.update?r.update(function(r){return r.replace(t,"").replace(i,"")}):r.replace(t,"").replace(i,"")}}}}});
|
||||||
+18
@@ -0,0 +1,18 @@
|
|||||||
|
/*!
|
||||||
|
* Lunr languages, `Swedish` language
|
||||||
|
* https://github.com/MihaiValentin/lunr-languages
|
||||||
|
*
|
||||||
|
* Copyright 2014, Mihai Valentin
|
||||||
|
* http://www.mozilla.org/MPL/
|
||||||
|
*/
|
||||||
|
/*!
|
||||||
|
* based on
|
||||||
|
* Snowball JavaScript Library v0.3
|
||||||
|
* http://code.google.com/p/urim/
|
||||||
|
* http://snowball.tartarus.org/
|
||||||
|
*
|
||||||
|
* Copyright 2010, Oleg Mazko
|
||||||
|
* http://www.mozilla.org/MPL/
|
||||||
|
*/
|
||||||
|
|
||||||
|
!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");e.sv=function(){this.pipeline.reset(),this.pipeline.add(e.sv.trimmer,e.sv.stopWordFilter,e.sv.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.sv.stemmer))},e.sv.wordCharacters="A-Za-zªºÀ-ÖØ-öø-ʸˠ-ˤᴀ-ᴥᴬ-ᵜᵢ-ᵥᵫ-ᵷᵹ-ᶾḀ-ỿⁱⁿₐ-ₜKÅℲⅎⅠ-ↈⱠ-ⱿꜢ-ꞇꞋ-ꞭꞰ-ꞷꟷ-ꟿꬰ-ꭚꭜ-ꭤff-stＡ-Ｚａ-ｚ",e.sv.trimmer=e.trimmerSupport.generateTrimmer(e.sv.wordCharacters),e.Pipeline.registerFunction(e.sv.trimmer,"trimmer-sv"),e.sv.stemmer=function(){var r=e.stemmerSupport.Among,n=e.stemmerSupport.SnowballProgram,t=new function(){function e(){var e,r=w.cursor+3;if(o=w.limit,0<=r||r<=w.limit){for(a=r;;){if(e=w.cursor,w.in_grouping(l,97,246)){w.cursor=e;break}if(w.cursor=e,w.cursor>=w.limit)return;w.cursor++}for(;!w.out_grouping(l,97,246);){if(w.cursor>=w.limit)return;w.cursor++}o=w.cursor,o<a&&(o=a)}}function t(){var e,r=w.limit_backward;if(w.cursor>=o&&(w.limit_backward=o,w.cursor=w.limit,w.ket=w.cursor,e=w.find_among_b(u,37),w.limit_backward=r,e))switch(w.bra=w.cursor,e){case 1:w.slice_del();break;case 2:w.in_grouping_b(d,98,121)&&w.slice_del()}}function i(){var e=w.limit_backward;w.cursor>=o&&(w.limit_backward=o,w.cursor=w.limit,w.find_among_b(c,7)&&(w.cursor=w.limit,w.ket=w.cursor,w.cursor>w.limit_backward&&(w.bra=--w.cursor,w.slice_del())),w.limit_backward=e)}function s(){var e,r;if(w.cursor>=o){if(r=w.limit_backward,w.limit_backward=o,w.cursor=w.limit,w.ket=w.cursor,e=w.find_among_b(m,5))switch(w.bra=w.cursor,e){case 1:w.slice_del();break;case 2:w.slice_from("lös");break;case 3:w.slice_from("full")}w.limit_backward=r}}var a,o,u=[new r("a",-1,1),new r("arna",0,1),new r("erna",0,1),new r("heterna",2,1),new r("orna",0,1),new r("ad",-1,1),new r("e",-1,1),new r("ade",6,1),new r("ande",6,1),new r("arne",6,1),new r("are",6,1),new r("aste",6,1),new r("en",-1,1),new r("anden",12,1),new r("aren",12,1),new r("heten",12,1),new r("ern",-1,1),new r("ar",-1,1),new r("er",-1,1),new r("heter",18,1),new r("or",-1,1),new r("s",-1,2),new r("as",21,1),new r("arnas",22,1),new r("ernas",22,1),new r("ornas",22,1),new r("es",21,1),new r("ades",26,1),new r("andes",26,1),new r("ens",21,1),new r("arens",29,1),new r("hetens",29,1),new r("erns",21,1),new r("at",-1,1),new r("andet",-1,1),new r("het",-1,1),new r("ast",-1,1)],c=[new r("dd",-1,-1),new r("gd",-1,-1),new r("nn",-1,-1),new r("dt",-1,-1),new r("gt",-1,-1),new r("kt",-1,-1),new r("tt",-1,-1)],m=[new r("ig",-1,1),new r("lig",0,1),new r("els",-1,1),new r("fullt",-1,3),new r("löst",-1,2)],l=[17,65,16,1,0,0,0,0,0,0,0,0,0,0,0,0,24,0,32],d=[119,127,149],w=new n;this.setCurrent=function(e){w.setCurrent(e)},this.getCurrent=function(){return w.getCurrent()},this.stem=function(){var r=w.cursor;return e(),w.limit_backward=r,w.cursor=w.limit,t(),w.cursor=w.limit,i(),w.cursor=w.limit,s(),!0}};return function(e){return"function"==typeof e.update?e.update(function(e){return t.setCurrent(e),t.stem(),t.getCurrent()}):(t.setCurrent(e),t.stem(),t.getCurrent())}}(),e.Pipeline.registerFunction(e.sv.stemmer,"stemmer-sv"),e.sv.stopWordFilter=e.generateStopWordFilter("alla allt att av blev bli blir blivit de dem den denna deras dess dessa det detta dig din dina ditt du där då efter ej eller en er era ert ett från för ha hade han hans har henne hennes hon honom hur här i icke ingen inom inte jag ju kan kunde man med mellan men mig min mina mitt mot mycket ni nu när någon något några och om oss på samma sedan sig sin sina sitta själv skulle som så sådan sådana sådant till under upp ut utan vad var vara varför varit varje vars vart vem vi vid vilka vilkas vilken vilket vår våra vårt än är åt över".split(" ")),e.Pipeline.registerFunction(e.sv.stopWordFilter,"stopWordFilter-sv")}});
|
||||||
+1
@@ -0,0 +1 @@
|
|||||||
|
!function(e,t){"function"==typeof define&&define.amd?define(t):"object"==typeof exports?module.exports=t():t()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");e.ta=function(){this.pipeline.reset(),this.pipeline.add(e.ta.trimmer,e.ta.stopWordFilter,e.ta.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.ta.stemmer))},e.ta.wordCharacters="-உஊ-ஏஐ-ஙச-ட-னப-யர-ஹ-ிீ-ொ-ௐ---௩௪-௯௰-௹௺-a-zA-Zａ-ｚＡ-Ｚ0-9０-９",e.ta.trimmer=e.trimmerSupport.generateTrimmer(e.ta.wordCharacters),e.Pipeline.registerFunction(e.ta.trimmer,"trimmer-ta"),e.ta.stopWordFilter=e.generateStopWordFilter("அங்கு அங்கே அது அதை அந்த அவர் அவர்கள் அவள் அவன் அவை ஆக ஆகவே ஆகையால் ஆதலால் ஆதலினால் ஆனாலும் ஆனால் இங்கு இங்கே இது இதை இந்த இப்படி இவர் இவர்கள் இவள் இவன் இவை இவ்வளவு உனக்கு உனது உன் உன்னால் எங்கு எங்கே எது எதை எந்த எப்படி எவர் எவர்கள் எவள் எவன் எவை எவ்வளவு எனக்கு எனது எனவே என் என்ன என்னால் ஏது ஏன் தனது தன்னால் தானே தான் நாங்கள் நாம் நான் நீ நீங்கள்".split(" ")),e.ta.stemmer=function(){return function(e){return"function"==typeof e.update?e.update(function(e){return e}):e}}();var t=e.wordcut;t.init(),e.ta.tokenizer=function(r){if(!arguments.length||null==r||void 0==r)return[];if(Array.isArray(r))return r.map(function(t){return isLunr2?new e.Token(t.toLowerCase()):t.toLowerCase()});var i=r.toString().toLowerCase().replace(/^\s+/,"");return t.cut(i).split("|")},e.Pipeline.registerFunction(e.ta.stemmer,"stemmer-ta"),e.Pipeline.registerFunction(e.ta.stopWordFilter,"stopWordFilter-ta")}});
|
||||||
+1
@@ -0,0 +1 @@
|
|||||||
|
!function(e,t){"function"==typeof define&&define.amd?define(t):"object"==typeof exports?module.exports=t():t()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");e.te=function(){this.pipeline.reset(),this.pipeline.add(e.te.trimmer,e.te.stopWordFilter,e.te.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.te.stemmer))},e.te.wordCharacters="ఀ-ఄఅ-ఔక-హా-ౌౕ-ౖౘ-ౚౠ-ౡౢ-ౣ౦-౯౸-౿఼ఽ్ౝ౷",e.te.trimmer=e.trimmerSupport.generateTrimmer(e.te.wordCharacters),e.Pipeline.registerFunction(e.te.trimmer,"trimmer-te"),e.te.stopWordFilter=e.generateStopWordFilter("అందరూ అందుబాటులో అడగండి అడగడం అడ్డంగా అనుగుణంగా అనుమతించు అనుమతిస్తుంది అయితే ఇప్పటికే ఉన్నారు ఎక్కడైనా ఎప్పుడు ఎవరైనా ఎవరో ఏ ఏదైనా ఏమైనప్పటికి ఒక ఒకరు కనిపిస్తాయి కాదు కూడా గా గురించి చుట్టూ చేయగలిగింది తగిన తర్వాత దాదాపు దూరంగా నిజంగా పై ప్రకారం ప్రక్కన మధ్య మరియు మరొక మళ్ళీ మాత్రమే మెచ్చుకో వద్ద వెంట వేరుగా వ్యతిరేకంగా సంబంధం".split(" ")),e.te.stemmer=function(){return function(e){return"function"==typeof e.update?e.update(function(e){return e}):e}}();var t=e.wordcut;t.init(),e.te.tokenizer=function(r){if(!arguments.length||null==r||void 0==r)return[];if(Array.isArray(r))return r.map(function(t){return isLunr2?new e.Token(t.toLowerCase()):t.toLowerCase()});var i=r.toString().toLowerCase().replace(/^\s+/,"");return t.cut(i).split("|")},e.Pipeline.registerFunction(e.te.stemmer,"stemmer-te"),e.Pipeline.registerFunction(e.te.stopWordFilter,"stopWordFilter-te")}});
|
||||||
+1
@@ -0,0 +1 @@
|
|||||||
|
!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");var r="2"==e.version[0];e.th=function(){this.pipeline.reset(),this.pipeline.add(e.th.trimmer),r?this.tokenizer=e.th.tokenizer:(e.tokenizer&&(e.tokenizer=e.th.tokenizer),this.tokenizerFn&&(this.tokenizerFn=e.th.tokenizer))},e.th.wordCharacters="[-]",e.th.trimmer=e.trimmerSupport.generateTrimmer(e.th.wordCharacters),e.Pipeline.registerFunction(e.th.trimmer,"trimmer-th");var t=e.wordcut;t.init(),e.th.tokenizer=function(i){if(!arguments.length||null==i||void 0==i)return[];if(Array.isArray(i))return i.map(function(t){return r?new e.Token(t):t});var n=i.toString().replace(/^\s+/,"");return t.cut(n).split("|")}}});
|
||||||
+18
File diff suppressed because one or more lines are too long
+1
@@ -0,0 +1 @@
|
|||||||
|
!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");e.vi=function(){this.pipeline.reset(),this.pipeline.add(e.vi.stopWordFilter,e.vi.trimmer)},e.vi.wordCharacters="[A-Za-ẓ̀͐́͑̉̃̓ÂâÊêÔôĂ-ăĐ-đƠ-ơƯ-ư]",e.vi.trimmer=e.trimmerSupport.generateTrimmer(e.vi.wordCharacters),e.Pipeline.registerFunction(e.vi.trimmer,"trimmer-vi"),e.vi.stopWordFilter=e.generateStopWordFilter("là cái nhưng mà".split(" "))}});
|
||||||
+1
@@ -0,0 +1 @@
|
|||||||
|
!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r(require("@node-rs/jieba")):r()(e.lunr)}(this,function(e){return function(r,t){if(void 0===r)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===r.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");var i="2"==r.version[0];r.zh=function(){this.pipeline.reset(),this.pipeline.add(r.zh.trimmer,r.zh.stopWordFilter,r.zh.stemmer),i?this.tokenizer=r.zh.tokenizer:(r.tokenizer&&(r.tokenizer=r.zh.tokenizer),this.tokenizerFn&&(this.tokenizerFn=r.zh.tokenizer))},r.zh.tokenizer=function(n){if(!arguments.length||null==n||void 0==n)return[];if(Array.isArray(n))return n.map(function(e){return i?new r.Token(e.toLowerCase()):e.toLowerCase()});t&&e.load(t);var o=n.toString().trim().toLowerCase(),s=[];e.cut(o,!0).forEach(function(e){s=s.concat(e.split(" "))}),s=s.filter(function(e){return!!e});var u=0;return s.map(function(e,t){if(i){var n=o.indexOf(e,u),s={};return s.position=[n,e.length],s.index=t,u=n,new r.Token(e,s)}return e})},r.zh.wordCharacters="\\w一-龥",r.zh.trimmer=r.trimmerSupport.generateTrimmer(r.zh.wordCharacters),r.Pipeline.registerFunction(r.zh.trimmer,"trimmer-zh"),r.zh.stemmer=function(){return function(e){return e}}(),r.Pipeline.registerFunction(r.zh.stemmer,"stemmer-zh"),r.zh.stopWordFilter=r.generateStopWordFilter("的 一 不 在 人 有 是 为 為 以 于 於 上 他 而 后 後 之 来 來 及 了 因 下 可 到 由 这 這 与 與 也 此 但 并 並 个 個 其 已 无 無 小 我 们 們 起 最 再 今 去 好 只 又 或 很 亦 某 把 那 你 乃 它 吧 被 比 别 趁 当 當 从 從 得 打 凡 儿 兒 尔 爾 该 該 各 给 給 跟 和 何 还 還 即 几 幾 既 看 据 據 距 靠 啦 另 么 麽 每 嘛 拿 哪 您 凭 憑 且 却 卻 让 讓 仍 啥 如 若 使 谁 誰 虽 雖 随 隨 同 所 她 哇 嗡 往 些 向 沿 哟 喲 用 咱 则 則 怎 曾 至 致 着 著 诸 諸 自".split(" ")),r.Pipeline.registerFunction(r.zh.stopWordFilter,"stopWordFilter-zh")}});
|
||||||
@@ -0,0 +1,206 @@
|
|||||||
|
/**
|
||||||
|
* export the module via AMD, CommonJS or as a browser global
|
||||||
|
* Export code from https://github.com/umdjs/umd/blob/master/returnExports.js
|
||||||
|
*/
|
||||||
|
;(function (root, factory) {
|
||||||
|
if (typeof define === 'function' && define.amd) {
|
||||||
|
// AMD. Register as an anonymous module.
|
||||||
|
define(factory)
|
||||||
|
} else if (typeof exports === 'object') {
|
||||||
|
/**
|
||||||
|
* Node. Does not work with strict CommonJS, but
|
||||||
|
* only CommonJS-like environments that support module.exports,
|
||||||
|
* like Node.
|
||||||
|
*/
|
||||||
|
module.exports = factory()
|
||||||
|
} else {
|
||||||
|
// Browser globals (root is window)
|
||||||
|
factory()(root.lunr);
|
||||||
|
}
|
||||||
|
}(this, function () {
|
||||||
|
/**
|
||||||
|
* Just return a value to define the module export.
|
||||||
|
* This example returns an object, but the module
|
||||||
|
* can return a function as the exported value.
|
||||||
|
*/
|
||||||
|
|
||||||
|
return function(lunr) {
|
||||||
|
// TinySegmenter 0.1 -- Super compact Japanese tokenizer in Javascript
|
||||||
|
// (c) 2008 Taku Kudo <taku@chasen.org>
|
||||||
|
// TinySegmenter is freely distributable under the terms of a new BSD licence.
|
||||||
|
// For details, see http://chasen.org/~taku/software/TinySegmenter/LICENCE.txt
|
||||||
|
|
||||||
|
function TinySegmenter() {
|
||||||
|
var patterns = {
|
||||||
|
"[一二三四五六七八九十百千万億兆]":"M",
|
||||||
|
"[一-龠々〆ヵヶ]":"H",
|
||||||
|
"[ぁ-ん]":"I",
|
||||||
|
"[ァ-ヴーｱ-ﾝﾞｰ]":"K",
|
||||||
|
"[a-zA-Zａ-ｚＡ-Ｚ]":"A",
|
||||||
|
"[0-9０-９]":"N"
|
||||||
|
}
|
||||||
|
this.chartype_ = [];
|
||||||
|
for (var i in patterns) {
|
||||||
|
var regexp = new RegExp(i);
|
||||||
|
this.chartype_.push([regexp, patterns[i]]);
|
||||||
|
}
|
||||||
|
|
||||||
|
this.BIAS__ = -332
|
||||||
|
this.BC1__ = {"HH":6,"II":2461,"KH":406,"OH":-1378};
|
||||||
|
this.BC2__ = {"AA":-3267,"AI":2744,"AN":-878,"HH":-4070,"HM":-1711,"HN":4012,"HO":3761,"IA":1327,"IH":-1184,"II":-1332,"IK":1721,"IO":5492,"KI":3831,"KK":-8741,"MH":-3132,"MK":3334,"OO":-2920};
|
||||||
|
this.BC3__ = {"HH":996,"HI":626,"HK":-721,"HN":-1307,"HO":-836,"IH":-301,"KK":2762,"MK":1079,"MM":4034,"OA":-1652,"OH":266};
|
||||||
|
this.BP1__ = {"BB":295,"OB":304,"OO":-125,"UB":352};
|
||||||
|
this.BP2__ = {"BO":60,"OO":-1762};
|
||||||
|
this.BQ1__ = {"BHH":1150,"BHM":1521,"BII":-1158,"BIM":886,"BMH":1208,"BNH":449,"BOH":-91,"BOO":-2597,"OHI":451,"OIH":-296,"OKA":1851,"OKH":-1020,"OKK":904,"OOO":2965};
|
||||||
|
this.BQ2__ = {"BHH":118,"BHI":-1159,"BHM":466,"BIH":-919,"BKK":-1720,"BKO":864,"OHH":-1139,"OHM":-181,"OIH":153,"UHI":-1146};
|
||||||
|
this.BQ3__ = {"BHH":-792,"BHI":2664,"BII":-299,"BKI":419,"BMH":937,"BMM":8335,"BNN":998,"BOH":775,"OHH":2174,"OHM":439,"OII":280,"OKH":1798,"OKI":-793,"OKO":-2242,"OMH":-2402,"OOO":11699};
|
||||||
|
this.BQ4__ = {"BHH":-3895,"BIH":3761,"BII":-4654,"BIK":1348,"BKK":-1806,"BMI":-3385,"BOO":-12396,"OAH":926,"OHH":266,"OHK":-2036,"ONN":-973};
|
||||||
|
this.BW1__ = {",と":660,",同":727,"B1あ":1404,"B1同":542,"、と":660,"、同":727,"」と":1682,"あっ":1505,"いう":1743,"いっ":-2055,"いる":672,"うし":-4817,"うん":665,"から":3472,"がら":600,"こう":-790,"こと":2083,"こん":-1262,"さら":-4143,"さん":4573,"した":2641,"して":1104,"すで":-3399,"そこ":1977,"それ":-871,"たち":1122,"ため":601,"った":3463,"つい":-802,"てい":805,"てき":1249,"でき":1127,"です":3445,"では":844,"とい":-4915,"とみ":1922,"どこ":3887,"ない":5713,"なっ":3015,"など":7379,"なん":-1113,"にし":2468,"には":1498,"にも":1671,"に対":-912,"の一":-501,"の中":741,"ませ":2448,"まで":1711,"まま":2600,"まる":-2155,"やむ":-1947,"よっ":-2565,"れた":2369,"れで":-913,"をし":1860,"を見":731,"亡く":-1886,"京都":2558,"取り":-2784,"大き":-2604,"大阪":1497,"平方":-2314,"引き":-1336,"日本":-195,"本当":-2423,"毎日":-2113,"目指":-724,"Ｂ１あ":1404,"Ｂ１同":542,"｣と":1682};
|
||||||
|
this.BW2__ = {"..":-11822,"11":-669,"――":-5730,"−−":-13175,"いう":-1609,"うか":2490,"かし":-1350,"かも":-602,"から":-7194,"かれ":4612,"がい":853,"がら":-3198,"きた":1941,"くな":-1597,"こと":-8392,"この":-4193,"させ":4533,"され":13168,"さん":-3977,"しい":-1819,"しか":-545,"した":5078,"して":972,"しな":939,"その":-3744,"たい":-1253,"たた":-662,"ただ":-3857,"たち":-786,"たと":1224,"たは":-939,"った":4589,"って":1647,"っと":-2094,"てい":6144,"てき":3640,"てく":2551,"ては":-3110,"ても":-3065,"でい":2666,"でき":-1528,"でし":-3828,"です":-4761,"でも":-4203,"とい":1890,"とこ":-1746,"とと":-2279,"との":720,"とみ":5168,"とも":-3941,"ない":-2488,"なが":-1313,"など":-6509,"なの":2614,"なん":3099,"にお":-1615,"にし":2748,"にな":2454,"によ":-7236,"に対":-14943,"に従":-4688,"に関":-11388,"のか":2093,"ので":-7059,"のに":-6041,"のの":-6125,"はい":1073,"はが":-1033,"はず":-2532,"ばれ":1813,"まし":-1316,"まで":-6621,"まれ":5409,"めて":-3153,"もい":2230,"もの":-10713,"らか":-944,"らし":-1611,"らに":-1897,"りし":651,"りま":1620,"れた":4270,"れて":849,"れば":4114,"ろう":6067,"われ":7901,"を通":-11877,"んだ":728,"んな":-4115,"一人":602,"一方":-1375,"一日":970,"一部":-1051,"上が":-4479,"会社":-1116,"出て":2163,"分の":-7758,"同党":970,"同日":-913,"大阪":-2471,"委員":-1250,"少な":-1050,"年度":-8669,"年間":-1626,"府県":-2363,"手権":-1982,"新聞":-4066,"日新":-722,"日本":-7068,"日米":3372,"曜日":-601,"朝鮮":-2355,"本人":-2697,"東京":-1543,"然と":-1384,"社会":-1276,"立て":-990,"第に":-1612,"米国":-4268,"１１":-669};
|
||||||
|
this.BW3__ = {"あた":-2194,"あり":719,"ある":3846,"い.":-1185,"い。":-1185,"いい":5308,"いえ":2079,"いく":3029,"いた":2056,"いっ":1883,"いる":5600,"いわ":1527,"うち":1117,"うと":4798,"えと":1454,"か.":2857,"か。":2857,"かけ":-743,"かっ":-4098,"かに":-669,"から":6520,"かり":-2670,"が,":1816,"が、":1816,"がき":-4855,"がけ":-1127,"がっ":-913,"がら":-4977,"がり":-2064,"きた":1645,"けど":1374,"こと":7397,"この":1542,"ころ":-2757,"さい":-714,"さを":976,"し,":1557,"し、":1557,"しい":-3714,"した":3562,"して":1449,"しな":2608,"しま":1200,"す.":-1310,"す。":-1310,"する":6521,"ず,":3426,"ず、":3426,"ずに":841,"そう":428,"た.":8875,"た。":8875,"たい":-594,"たの":812,"たり":-1183,"たる":-853,"だ.":4098,"だ。":4098,"だっ":1004,"った":-4748,"って":300,"てい":6240,"てお":855,"ても":302,"です":1437,"でに":-1482,"では":2295,"とう":-1387,"とし":2266,"との":541,"とも":-3543,"どう":4664,"ない":1796,"なく":-903,"など":2135,"に,":-1021,"に、":-1021,"にし":1771,"にな":1906,"には":2644,"の,":-724,"の、":-724,"の子":-1000,"は,":1337,"は、":1337,"べき":2181,"まし":1113,"ます":6943,"まっ":-1549,"まで":6154,"まれ":-793,"らし":1479,"られ":6820,"るる":3818,"れ,":854,"れ、":854,"れた":1850,"れて":1375,"れば":-3246,"れる":1091,"われ":-605,"んだ":606,"んで":798,"カ月":990,"会議":860,"入り":1232,"大会":2217,"始め":1681,"市":965,"新聞":-5055,"日,":974,"日、":974,"社会":2024,"ｶ月":990};
|
||||||
|
this.TC1__ = {"AAA":1093,"HHH":1029,"HHM":580,"HII":998,"HOH":-390,"HOM":-331,"IHI":1169,"IOH":-142,"IOI":-1015,"IOM":467,"MMH":187,"OOI":-1832};
|
||||||
|
this.TC2__ = {"HHO":2088,"HII":-1023,"HMM":-1154,"IHI":-1965,"KKH":703,"OII":-2649};
|
||||||
|
this.TC3__ = {"AAA":-294,"HHH":346,"HHI":-341,"HII":-1088,"HIK":731,"HOH":-1486,"IHH":128,"IHI":-3041,"IHO":-1935,"IIH":-825,"IIM":-1035,"IOI":-542,"KHH":-1216,"KKA":491,"KKH":-1217,"KOK":-1009,"MHH":-2694,"MHM":-457,"MHO":123,"MMH":-471,"NNH":-1689,"NNO":662,"OHO":-3393};
|
||||||
|
this.TC4__ = {"HHH":-203,"HHI":1344,"HHK":365,"HHM":-122,"HHN":182,"HHO":669,"HIH":804,"HII":679,"HOH":446,"IHH":695,"IHO":-2324,"IIH":321,"III":1497,"IIO":656,"IOO":54,"KAK":4845,"KKA":3386,"KKK":3065,"MHH":-405,"MHI":201,"MMH":-241,"MMM":661,"MOM":841};
|
||||||
|
this.TQ1__ = {"BHHH":-227,"BHHI":316,"BHIH":-132,"BIHH":60,"BIII":1595,"BNHH":-744,"BOHH":225,"BOOO":-908,"OAKK":482,"OHHH":281,"OHIH":249,"OIHI":200,"OIIH":-68};
|
||||||
|
this.TQ2__ = {"BIHH":-1401,"BIII":-1033,"BKAK":-543,"BOOO":-5591};
|
||||||
|
this.TQ3__ = {"BHHH":478,"BHHM":-1073,"BHIH":222,"BHII":-504,"BIIH":-116,"BIII":-105,"BMHI":-863,"BMHM":-464,"BOMH":620,"OHHH":346,"OHHI":1729,"OHII":997,"OHMH":481,"OIHH":623,"OIIH":1344,"OKAK":2792,"OKHH":587,"OKKA":679,"OOHH":110,"OOII":-685};
|
||||||
|
this.TQ4__ = {"BHHH":-721,"BHHM":-3604,"BHII":-966,"BIIH":-607,"BIII":-2181,"OAAA":-2763,"OAKK":180,"OHHH":-294,"OHHI":2446,"OHHO":480,"OHIH":-1573,"OIHH":1935,"OIHI":-493,"OIIH":626,"OIII":-4007,"OKAK":-8156};
|
||||||
|
this.TW1__ = {"につい":-4681,"東京都":2026};
|
||||||
|
this.TW2__ = {"ある程":-2049,"いった":-1256,"ころが":-2434,"しょう":3873,"その後":-4430,"だって":-1049,"ていた":1833,"として":-4657,"ともに":-4517,"もので":1882,"一気に":-792,"初めて":-1512,"同時に":-8097,"大きな":-1255,"対して":-2721,"社会党":-3216};
|
||||||
|
this.TW3__ = {"いただ":-1734,"してい":1314,"として":-4314,"につい":-5483,"にとっ":-5989,"に当た":-6247,"ので,":-727,"ので、":-727,"のもの":-600,"れから":-3752,"十二月":-2287};
|
||||||
|
this.TW4__ = {"いう.":8576,"いう。":8576,"からな":-2348,"してい":2958,"たが,":1516,"たが、":1516,"ている":1538,"という":1349,"ました":5543,"ません":1097,"ようと":-4258,"よると":5865};
|
||||||
|
this.UC1__ = {"A":484,"K":93,"M":645,"O":-505};
|
||||||
|
this.UC2__ = {"A":819,"H":1059,"I":409,"M":3987,"N":5775,"O":646};
|
||||||
|
this.UC3__ = {"A":-1370,"I":2311};
|
||||||
|
this.UC4__ = {"A":-2643,"H":1809,"I":-1032,"K":-3450,"M":3565,"N":3876,"O":6646};
|
||||||
|
this.UC5__ = {"H":313,"I":-1238,"K":-799,"M":539,"O":-831};
|
||||||
|
this.UC6__ = {"H":-506,"I":-253,"K":87,"M":247,"O":-387};
|
||||||
|
this.UP1__ = {"O":-214};
|
||||||
|
this.UP2__ = {"B":69,"O":935};
|
||||||
|
this.UP3__ = {"B":189};
|
||||||
|
this.UQ1__ = {"BH":21,"BI":-12,"BK":-99,"BN":142,"BO":-56,"OH":-95,"OI":477,"OK":410,"OO":-2422};
|
||||||
|
this.UQ2__ = {"BH":216,"BI":113,"OK":1759};
|
||||||
|
this.UQ3__ = {"BA":-479,"BH":42,"BI":1913,"BK":-7198,"BM":3160,"BN":6427,"BO":14761,"OI":-827,"ON":-3212};
|
||||||
|
this.UW1__ = {",":156,"、":156,"「":-463,"あ":-941,"う":-127,"が":-553,"き":121,"こ":505,"で":-201,"と":-547,"ど":-123,"に":-789,"の":-185,"は":-847,"も":-466,"や":-470,"よ":182,"ら":-292,"り":208,"れ":169,"を":-446,"ん":-137,"・":-135,"主":-402,"京":-268,"区":-912,"午":871,"国":-460,"大":561,"委":729,"市":-411,"日":-141,"理":361,"生":-408,"県":-386,"都":-718,"｢":-463,"･":-135};
|
||||||
|
this.UW2__ = {",":-829,"、":-829,"〇":892,"「":-645,"」":3145,"あ":-538,"い":505,"う":134,"お":-502,"か":1454,"が":-856,"く":-412,"こ":1141,"さ":878,"ざ":540,"し":1529,"す":-675,"せ":300,"そ":-1011,"た":188,"だ":1837,"つ":-949,"て":-291,"で":-268,"と":-981,"ど":1273,"な":1063,"に":-1764,"の":130,"は":-409,"ひ":-1273,"べ":1261,"ま":600,"も":-1263,"や":-402,"よ":1639,"り":-579,"る":-694,"れ":571,"を":-2516,"ん":2095,"ア":-587,"カ":306,"キ":568,"ッ":831,"三":-758,"不":-2150,"世":-302,"中":-968,"主":-861,"事":492,"人":-123,"会":978,"保":362,"入":548,"初":-3025,"副":-1566,"北":-3414,"区":-422,"大":-1769,"天":-865,"太":-483,"子":-1519,"学":760,"実":1023,"小":-2009,"市":-813,"年":-1060,"強":1067,"手":-1519,"揺":-1033,"政":1522,"文":-1355,"新":-1682,"日":-1815,"明":-1462,"最":-630,"朝":-1843,"本":-1650,"東":-931,"果":-665,"次":-2378,"民":-180,"気":-1740,"理":752,"発":529,"目":-1584,"相":-242,"県":-1165,"立":-763,"第":810,"米":509,"自":-1353,"行":838,"西":-744,"見":-3874,"調":1010,"議":1198,"込":3041,"開":1758,"間":-1257,"｢":-645,"｣":3145,"ｯ":831,"ｱ":-587,"ｶ":306,"ｷ":568};
|
||||||
|
this.UW3__ = {",":4889,"1":-800,"−":-1723,"、":4889,"々":-2311,"〇":5827,"」":2670,"〓":-3573,"あ":-2696,"い":1006,"う":2342,"え":1983,"お":-4864,"か":-1163,"が":3271,"く":1004,"け":388,"げ":401,"こ":-3552,"ご":-3116,"さ":-1058,"し":-395,"す":584,"せ":3685,"そ":-5228,"た":842,"ち":-521,"っ":-1444,"つ":-1081,"て":6167,"で":2318,"と":1691,"ど":-899,"な":-2788,"に":2745,"の":4056,"は":4555,"ひ":-2171,"ふ":-1798,"へ":1199,"ほ":-5516,"ま":-4384,"み":-120,"め":1205,"も":2323,"や":-788,"よ":-202,"ら":727,"り":649,"る":5905,"れ":2773,"わ":-1207,"を":6620,"ん":-518,"ア":551,"グ":1319,"ス":874,"ッ":-1350,"ト":521,"ム":1109,"ル":1591,"ロ":2201,"ン":278,"・":-3794,"一":-1619,"下":-1759,"世":-2087,"両":3815,"中":653,"主":-758,"予":-1193,"二":974,"人":2742,"今":792,"他":1889,"以":-1368,"低":811,"何":4265,"作":-361,"保":-2439,"元":4858,"党":3593,"全":1574,"公":-3030,"六":755,"共":-1880,"円":5807,"再":3095,"分":457,"初":2475,"別":1129,"前":2286,"副":4437,"力":365,"動":-949,"務":-1872,"化":1327,"北":-1038,"区":4646,"千":-2309,"午":-783,"協":-1006,"口":483,"右":1233,"各":3588,"合":-241,"同":3906,"和":-837,"員":4513,"国":642,"型":1389,"場":1219,"外":-241,"妻":2016,"学":-1356,"安":-423,"実":-1008,"家":1078,"小":-513,"少":-3102,"州":1155,"市":3197,"平":-1804,"年":2416,"広":-1030,"府":1605,"度":1452,"建":-2352,"当":-3885,"得":1905,"思":-1291,"性":1822,"戸":-488,"指":-3973,"政":-2013,"教":-1479,"数":3222,"文":-1489,"新":1764,"日":2099,"旧":5792,"昨":-661,"時":-1248,"曜":-951,"最":-937,"月":4125,"期":360,"李":3094,"村":364,"東":-805,"核":5156,"森":2438,"業":484,"氏":2613,"民":-1694,"決":-1073,"法":1868,"海":-495,"無":979,"物":461,"特":-3850,"生":-273,"用":914,"町":1215,"的":7313,"直":-1835,"省":792,"県":6293,"知":-1528,"私":4231,"税":401,"立":-960,"第":1201,"米":7767,"系":3066,"約":3663,"級":1384,"統":-4229,"総":1163,"線":1255,"者":6457,"能":725,"自":-2869,"英":785,"見":1044,"調":-562,"財":-733,"費":1777,"車":1835,"軍":1375,"込":-1504,"通":-1136,"選":-681,"郎":1026,"郡":4404,"部":1200,"金":2163,"長":421,"開":-1432,"間":1302,"関":-1282,"雨":2009,"電":-1045,"非":2066,"駅":1620,"１":-800,"｣":2670,"･":-3794,"ｯ":-1350,"ｱ":551,"ｸﾞ":1319,"ｽ":874,"ﾄ":521,"ﾑ":1109,"ﾙ":1591,"ﾛ":2201,"ﾝ":278};
|
||||||
|
this.UW4__ = {",":3930,".":3508,"―":-4841,"、":3930,"。":3508,"〇":4999,"「":1895,"」":3798,"〓":-5156,"あ":4752,"い":-3435,"う":-640,"え":-2514,"お":2405,"か":530,"が":6006,"き":-4482,"ぎ":-3821,"く":-3788,"け":-4376,"げ":-4734,"こ":2255,"ご":1979,"さ":2864,"し":-843,"じ":-2506,"す":-731,"ず":1251,"せ":181,"そ":4091,"た":5034,"だ":5408,"ち":-3654,"っ":-5882,"つ":-1659,"て":3994,"で":7410,"と":4547,"な":5433,"に":6499,"ぬ":1853,"ね":1413,"の":7396,"は":8578,"ば":1940,"ひ":4249,"び":-4134,"ふ":1345,"へ":6665,"べ":-744,"ほ":1464,"ま":1051,"み":-2082,"む":-882,"め":-5046,"も":4169,"ゃ":-2666,"や":2795,"ょ":-1544,"よ":3351,"ら":-2922,"り":-9726,"る":-14896,"れ":-2613,"ろ":-4570,"わ":-1783,"を":13150,"ん":-2352,"カ":2145,"コ":1789,"セ":1287,"ッ":-724,"ト":-403,"メ":-1635,"ラ":-881,"リ":-541,"ル":-856,"ン":-3637,"・":-4371,"ー":-11870,"一":-2069,"中":2210,"予":782,"事":-190,"井":-1768,"人":1036,"以":544,"会":950,"体":-1286,"作":530,"側":4292,"先":601,"党":-2006,"共":-1212,"内":584,"円":788,"初":1347,"前":1623,"副":3879,"力":-302,"動":-740,"務":-2715,"化":776,"区":4517,"協":1013,"参":1555,"合":-1834,"和":-681,"員":-910,"器":-851,"回":1500,"国":-619,"園":-1200,"地":866,"場":-1410,"塁":-2094,"士":-1413,"多":1067,"大":571,"子":-4802,"学":-1397,"定":-1057,"寺":-809,"小":1910,"屋":-1328,"山":-1500,"島":-2056,"川":-2667,"市":2771,"年":374,"庁":-4556,"後":456,"性":553,"感":916,"所":-1566,"支":856,"改":787,"政":2182,"教":704,"文":522,"方":-856,"日":1798,"時":1829,"最":845,"月":-9066,"木":-485,"来":-442,"校":-360,"業":-1043,"氏":5388,"民":-2716,"気":-910,"沢":-939,"済":-543,"物":-735,"率":672,"球":-1267,"生":-1286,"産":-1101,"田":-2900,"町":1826,"的":2586,"目":922,"省":-3485,"県":2997,"空":-867,"立":-2112,"第":788,"米":2937,"系":786,"約":2171,"経":1146,"統":-1169,"総":940,"線":-994,"署":749,"者":2145,"能":-730,"般":-852,"行":-792,"規":792,"警":-1184,"議":-244,"谷":-1000,"賞":730,"車":-1481,"軍":1158,"輪":-1433,"込":-3370,"近":929,"道":-1291,"選":2596,"郎":-4866,"都":1192,"野":-1100,"銀":-2213,"長":357,"間":-2344,"院":-2297,"際":-2604,"電":-878,"領":-1659,"題":-792,"館":-1984,"首":1749,"高":2120,"｢":1895,"｣":3798,"･":-4371,"ｯ":-724,"ｰ":-11870,"ｶ":2145,"ｺ":1789,"ｾ":1287,"ﾄ":-403,"ﾒ":-1635,"ﾗ":-881,"ﾘ":-541,"ﾙ":-856,"ﾝ":-3637};
|
||||||
|
this.UW5__ = {",":465,".":-299,"1":-514,"E2":-32768,"]":-2762,"、":465,"。":-299,"「":363,"あ":1655,"い":331,"う":-503,"え":1199,"お":527,"か":647,"が":-421,"き":1624,"ぎ":1971,"く":312,"げ":-983,"さ":-1537,"し":-1371,"す":-852,"だ":-1186,"ち":1093,"っ":52,"つ":921,"て":-18,"で":-850,"と":-127,"ど":1682,"な":-787,"に":-1224,"の":-635,"は":-578,"べ":1001,"み":502,"め":865,"ゃ":3350,"ょ":854,"り":-208,"る":429,"れ":504,"わ":419,"を":-1264,"ん":327,"イ":241,"ル":451,"ン":-343,"中":-871,"京":722,"会":-1153,"党":-654,"務":3519,"区":-901,"告":848,"員":2104,"大":-1296,"学":-548,"定":1785,"嵐":-1304,"市":-2991,"席":921,"年":1763,"思":872,"所":-814,"挙":1618,"新":-1682,"日":218,"月":-4353,"査":932,"格":1356,"機":-1508,"氏":-1347,"田":240,"町":-3912,"的":-3149,"相":1319,"省":-1052,"県":-4003,"研":-997,"社":-278,"空":-813,"統":1955,"者":-2233,"表":663,"語":-1073,"議":1219,"選":-1018,"郎":-368,"長":786,"間":1191,"題":2368,"館":-689,"１":-514,"Ｅ２":-32768,"｢":363,"ｲ":241,"ﾙ":451,"ﾝ":-343};
|
||||||
|
this.UW6__ = {",":227,".":808,"1":-270,"E1":306,"、":227,"。":808,"あ":-307,"う":189,"か":241,"が":-73,"く":-121,"こ":-200,"じ":1782,"す":383,"た":-428,"っ":573,"て":-1014,"で":101,"と":-105,"な":-253,"に":-149,"の":-417,"は":-236,"も":-206,"り":187,"る":-135,"を":195,"ル":-673,"ン":-496,"一":-277,"中":201,"件":-800,"会":624,"前":302,"区":1792,"員":-1212,"委":798,"学":-960,"市":887,"広":-695,"後":535,"業":-697,"相":753,"社":-507,"福":974,"空":-822,"者":1811,"連":463,"郎":1082,"１":-270,"Ｅ１":306,"ﾙ":-673,"ﾝ":-496};
|
||||||
|
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
TinySegmenter.prototype.ctype_ = function(str) {
|
||||||
|
for (var i in this.chartype_) {
|
||||||
|
if (str.match(this.chartype_[i][0])) {
|
||||||
|
return this.chartype_[i][1];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return "O";
|
||||||
|
}
|
||||||
|
|
||||||
|
TinySegmenter.prototype.ts_ = function(v) {
|
||||||
|
if (v) { return v; }
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
TinySegmenter.prototype.segment = function(input) {
|
||||||
|
if (input == null || input == undefined || input == "") {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
var result = [];
|
||||||
|
var seg = ["B3","B2","B1"];
|
||||||
|
var ctype = ["O","O","O"];
|
||||||
|
var o = input.split("");
|
||||||
|
for (i = 0; i < o.length; ++i) {
|
||||||
|
seg.push(o[i]);
|
||||||
|
ctype.push(this.ctype_(o[i]))
|
||||||
|
}
|
||||||
|
seg.push("E1");
|
||||||
|
seg.push("E2");
|
||||||
|
seg.push("E3");
|
||||||
|
ctype.push("O");
|
||||||
|
ctype.push("O");
|
||||||
|
ctype.push("O");
|
||||||
|
var word = seg[3];
|
||||||
|
var p1 = "U";
|
||||||
|
var p2 = "U";
|
||||||
|
var p3 = "U";
|
||||||
|
for (var i = 4; i < seg.length - 3; ++i) {
|
||||||
|
var score = this.BIAS__;
|
||||||
|
var w1 = seg[i-3];
|
||||||
|
var w2 = seg[i-2];
|
||||||
|
var w3 = seg[i-1];
|
||||||
|
var w4 = seg[i];
|
||||||
|
var w5 = seg[i+1];
|
||||||
|
var w6 = seg[i+2];
|
||||||
|
var c1 = ctype[i-3];
|
||||||
|
var c2 = ctype[i-2];
|
||||||
|
var c3 = ctype[i-1];
|
||||||
|
var c4 = ctype[i];
|
||||||
|
var c5 = ctype[i+1];
|
||||||
|
var c6 = ctype[i+2];
|
||||||
|
score += this.ts_(this.UP1__[p1]);
|
||||||
|
score += this.ts_(this.UP2__[p2]);
|
||||||
|
score += this.ts_(this.UP3__[p3]);
|
||||||
|
score += this.ts_(this.BP1__[p1 + p2]);
|
||||||
|
score += this.ts_(this.BP2__[p2 + p3]);
|
||||||
|
score += this.ts_(this.UW1__[w1]);
|
||||||
|
score += this.ts_(this.UW2__[w2]);
|
||||||
|
score += this.ts_(this.UW3__[w3]);
|
||||||
|
score += this.ts_(this.UW4__[w4]);
|
||||||
|
score += this.ts_(this.UW5__[w5]);
|
||||||
|
score += this.ts_(this.UW6__[w6]);
|
||||||
|
score += this.ts_(this.BW1__[w2 + w3]);
|
||||||
|
score += this.ts_(this.BW2__[w3 + w4]);
|
||||||
|
score += this.ts_(this.BW3__[w4 + w5]);
|
||||||
|
score += this.ts_(this.TW1__[w1 + w2 + w3]);
|
||||||
|
score += this.ts_(this.TW2__[w2 + w3 + w4]);
|
||||||
|
score += this.ts_(this.TW3__[w3 + w4 + w5]);
|
||||||
|
score += this.ts_(this.TW4__[w4 + w5 + w6]);
|
||||||
|
score += this.ts_(this.UC1__[c1]);
|
||||||
|
score += this.ts_(this.UC2__[c2]);
|
||||||
|
score += this.ts_(this.UC3__[c3]);
|
||||||
|
score += this.ts_(this.UC4__[c4]);
|
||||||
|
score += this.ts_(this.UC5__[c5]);
|
||||||
|
score += this.ts_(this.UC6__[c6]);
|
||||||
|
score += this.ts_(this.BC1__[c2 + c3]);
|
||||||
|
score += this.ts_(this.BC2__[c3 + c4]);
|
||||||
|
score += this.ts_(this.BC3__[c4 + c5]);
|
||||||
|
score += this.ts_(this.TC1__[c1 + c2 + c3]);
|
||||||
|
score += this.ts_(this.TC2__[c2 + c3 + c4]);
|
||||||
|
score += this.ts_(this.TC3__[c3 + c4 + c5]);
|
||||||
|
score += this.ts_(this.TC4__[c4 + c5 + c6]);
|
||||||
|
// score += this.ts_(this.TC5__[c4 + c5 + c6]);
|
||||||
|
score += this.ts_(this.UQ1__[p1 + c1]);
|
||||||
|
score += this.ts_(this.UQ2__[p2 + c2]);
|
||||||
|
score += this.ts_(this.UQ3__[p3 + c3]);
|
||||||
|
score += this.ts_(this.BQ1__[p2 + c2 + c3]);
|
||||||
|
score += this.ts_(this.BQ2__[p2 + c3 + c4]);
|
||||||
|
score += this.ts_(this.BQ3__[p3 + c2 + c3]);
|
||||||
|
score += this.ts_(this.BQ4__[p3 + c3 + c4]);
|
||||||
|
score += this.ts_(this.TQ1__[p2 + c1 + c2 + c3]);
|
||||||
|
score += this.ts_(this.TQ2__[p2 + c2 + c3 + c4]);
|
||||||
|
score += this.ts_(this.TQ3__[p3 + c1 + c2 + c3]);
|
||||||
|
score += this.ts_(this.TQ4__[p3 + c2 + c3 + c4]);
|
||||||
|
var p = "O";
|
||||||
|
if (score > 0) {
|
||||||
|
result.push(word);
|
||||||
|
word = "";
|
||||||
|
p = "B";
|
||||||
|
}
|
||||||
|
p1 = p2;
|
||||||
|
p2 = p3;
|
||||||
|
p3 = p;
|
||||||
|
word += seg[i];
|
||||||
|
}
|
||||||
|
result.push(word);
|
||||||
|
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
lunr.TinySegmenter = TinySegmenter;
|
||||||
|
};
|
||||||
|
|
||||||
|
}));
|
||||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
Binary file not shown.
|
After Width: | Height: | Size: 22 KiB |
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 18 KiB |
|
Before Width: | Height: | Size: 49 KiB After Width: | Height: | Size: 49 KiB |
|
Before Width: | Height: | Size: 58 KiB After Width: | Height: | Size: 58 KiB |
+1
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
+1
File diff suppressed because one or more lines are too long
@@ -0,0 +1 @@
|
|||||||
|
{"version":3,"sources":["src/templates/assets/stylesheets/palette/_scheme.scss","../../../../src/templates/assets/stylesheets/palette.scss","src/templates/assets/stylesheets/palette/_accent.scss","src/templates/assets/stylesheets/palette/_primary.scss","src/templates/assets/stylesheets/utilities/_break.scss"],"names":[],"mappings":"AA2BA,cAGE,6BAME,sDAAA,CACA,6DAAA,CACA,+DAAA,CACA,gEAAA,CACA,mDAAA,CACA,6DAAA,CACA,+DAAA,CACA,gEAAA,CAGA,mDAAA,CACA,gDAAA,CAGA,0BAAA,CACA,mCAAA,CAGA,iCAAA,CACA,kCAAA,CACA,mCAAA,CACA,mCAAA,CACA,kCAAA,CACA,iCAAA,CACA,+CAAA,CACA,6DAAA,CACA,gEAAA,CACA,4DAAA,CACA,4DAAA,CACA,6DAAA,CAGA,6CAAA,CAGA,+CAAA,CAGA,uDAAA,CACA,6DAAA,CACA,2DAAA,CAGA,iCAAA,CAGA,yDAAA,CACA,iEAAA,CAGA,mDAAA,CACA,mDAAA,CAGA,qDAAA,CACA,uDAAA,CAGA,8DAAA,CAKA,8DAAA,CAKA,0DAAA,CAvEA,iBCeF,CD6DE,kHAEE,YC3DJ,CDkFE,yDACE,4BChFJ,CD+EE,2DACE,4BC7EJ,CD4EE,gEACE,4BC1EJ,CDyEE,2DACE,4BCvEJ,CDsEE,yDACE,4BCpEJ,CDmEE,0DACE,4BCjEJ,CDgEE,gEACE,4BC9DJ,CD6DE,0DACE,4BC3DJ,CD0DE,2OACE,4BC/CJ,CDsDA,+FAGE,iCCpDF,CACF,CC/CE,2BACE,4BAAA,CACA,2CAAA,CAOE,yBAAA,CACA,qCD2CN,CCrDE,4BACE,4BAAA,CACA,2CAAA,CAOE,yBAAA,CACA,qCDkDN,CC5DE,8BACE,4BAAA,CACA,2CAAA,CAOE,yBAAA,CACA,qCDyDN,CCnEE,mCACE,4BAAA,CACA,2CAAA,CAOE,yBAAA,CACA,qCDgEN,CC1EE,8BACE,4BAAA,CACA,2CAAA,CAOE,yBAAA,CACA,qCDuEN,CCjFE,4BACE,4BAAA,CACA,2CAAA,CAOE,yBAAA,CACA,qCD8EN,CCxFE,kCACE,4BAAA,CACA,2CAAA,CAOE,yBAAA,CACA,qCDqFN,CC/FE,4BACE,4BAAA,CACA,2CAAA,CAOE,yBAAA,CACA,qCD4FN,CCtGE,4BACE,4BAAA,CACA,2CAAA,CAOE,yBAAA,CACA,qCDmGN,CC7GE,6BACE,4BAAA,CACA,2CAAA,CAOE,yBAAA,CACA,qCD0GN,CCpHE,mCACE,4BAAA,CACA,2CAAA,CAOE,yBAAA,CACA,qCDiHN,CC3HE,4BACE,4BAAA,CACA,2CAAA,CAIE,8BAAA,CACA,qCD2HN,CClIE,8BACE,4BAAA,CACA,2CAAA,CAIE,8BAAA,CACA,qCDkIN,CCzIE,6BACE,yBAAA,CACA,2CAAA,CAIE,8BAAA,CACA,qCDyIN,CChJE,8BACE,4BAAA,CACA,2CAAA,CAIE,8BAAA,CACA,qCDgJN,CCvJE,mCACE,4BAAA,CACA,2CAAA,CAOE,yBAAA,CACA,qCDoJN,CEzJE,4BACE,6BAAA,CACA,oCAAA,CACA,mCAAA,CAOE,0BAAA,CACA,sCFsJN,CEjKE,6BACE,6BAAA,CACA,oCAAA,CACA,mCAAA,CAOE,0BAAA,CACA,sCF8JN,CEzKE,+BACE,6BAAA,CACA,oCAAA,CACA,mCAAA,CAOE,0BAAA,CACA,sCFsKN,CEjLE,oCACE,6BAAA,CACA,oCAAA,CACA,mCAAA,CAOE,0BAAA,CACA,sCF8KN,CEzLE,+BACE,6BAAA,CACA,oCAAA,CACA,mCAAA,CAOE,0BAAA,CACA,sCFsLN,CEjME,6BACE,6BAAA,CACA,oCAAA,CACA,mCAAA,CAOE,0BAAA,CACA,sCF8LN,CEzME,mCACE,6BAAA,CACA,oCAAA,CACA,mCAAA,CAOE,0BAAA,CACA,sCFsMN,CEjNE,6BACE,6BAAA,CACA,oCAAA,CACA,mCAAA,CAOE,0BAAA,CACA,sCF8MN,CEzNE,6BACE,6BAAA,CACA,oCAAA,CACA,mCAAA,CAOE,0BAAA,CACA,sCFsNN,CEjOE,8BACE,6BAAA,CACA,oCAAA,CACA,mCAAA,CAOE,0BAAA,CACA,sCF8NN,CEzOE,oCACE,6BAAA,CACA,oCAAA,CACA,mCAAA,CAOE,0BAAA,CACA,sCFsON,CEjPE,6BACE,6BAAA,CACA,oCAAA,CACA,mCAAA,CAIE,+BAAA,CACA,sCFiPN,CEzPE,+BACE,6BAAA,CACA,oCAAA,CACA,mCAAA,CAIE,+BAAA,CACA,sCFyPN,CEjQE,8BACE,6BAAA,CACA,oCAAA,CACA,mCAAA,CAIE,+BAAA,CACA,sCFiQN,CEzQE,+BACE,6BAAA,CACA,oCAAA,CACA,mCAAA,CAIE,+BAAA,CACA,sCFyQN,CEjRE,oCACE,6BAAA,CACA,oCAAA,CACA,mCAAA,CAOE,0BAAA,CACA,sCF8QN,CEzRE,8BACE,6BAAA,CACA,oCAAA,CACA,mCAAA,CAOE,0BAAA,CACA,sCFsRN,CEjSE,6BACE,6BAAA,CACA,oCAAA,CACA,mCAAA,CAOE,0BAAA,CACA,sCAAA,CAKA,4BF0RN,CE1SE,kCACE,6BAAA,CACA,oCAAA,CACA,mCAAA,CAOE,0BAAA,CACA,sCAAA,CAKA,4BFmSN,CEpRE,sEACE,4BFuRJ,CExRE,+DACE,4BF2RJ,CE5RE,iEACE,4BF+RJ,CEhSE,gEACE,4BFmSJ,CEpSE,iEACE,4BFuSJ,CE9RA,8BACE,mDAAA,CACA,4DAAA,CACA,0DAAA,CACA,oDAAA,CACA,2DAAA,CAGA,4BF+RF,CE5RE,yCACE,+BF8RJ,CE3RI,kDAEE,0CAAA,CACA,sCAAA,CAFA,mCF+RN,CG3MI,mCD1EA,+CACE,8CFwRJ,CErRI,qDACE,8CFuRN,CElRE,iEACE,mCFoRJ,CACF,CGtNI,sCDvDA,uCACE,oCFgRJ,CACF,CEvQA,8BACE,kDAAA,CACA,4DAAA,CACA,wDAAA,CACA,oDAAA,CACA,6DAAA,CAGA,4BFwQF,CErQE,yCACE,+BFuQJ,CEpQI,kDAEE,0CAAA,CACA,sCAAA,CAFA,mCFwQN,CEjQE,yCACE,6CFmQJ,CG5NI,0CDhCA,8CACE,gDF+PJ,CACF,CGjOI,0CDvBA,iFACE,6CF2PJ,CACF,CGzPI,sCDKA,uCACE,6CFuPJ,CACF","file":"palette.css"}
|
||||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,772 @@
|
|||||||
|
|
||||||
|
<!doctype html>
|
||||||
|
<html lang="en" class="no-js">
|
||||||
|
<head>
|
||||||
|
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||||
|
|
||||||
|
<meta name="description" content="Documentation for the Klipper Installation And Update Helper">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="prev" href="../../extensions/gcode-shell-command/">
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="next" href="../changelog/">
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="icon" href="../../assets/logo.png">
|
||||||
|
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.18">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<title>Contributing - KIAUH Documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="../../assets/stylesheets/main.7e37652d.min.css">
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
|
||||||
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
|
||||||
|
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="../../assets/_mkdocstrings.css">
|
||||||
|
|
||||||
|
<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</head>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="blue-grey" data-md-color-accent="cyan">
|
||||||
|
|
||||||
|
|
||||||
|
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
|
||||||
|
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
|
||||||
|
<label class="md-overlay" for="__drawer"></label>
|
||||||
|
<div data-md-component="skip">
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<div data-md-component="announce">
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<header class="md-header md-header--shadow" data-md-component="header">
|
||||||
|
<nav class="md-header__inner md-grid" aria-label="Header">
|
||||||
|
<a href="../.." title="KIAUH Documentation" class="md-header__button md-logo" aria-label="KIAUH Documentation" data-md-component="logo">
|
||||||
|
|
||||||
|
<img src="../../assets/logo.png" alt="logo">
|
||||||
|
|
||||||
|
</a>
|
||||||
|
<label class="md-header__button md-icon" for="__drawer">
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
|
||||||
|
</label>
|
||||||
|
<div class="md-header__title" data-md-component="header-title">
|
||||||
|
<div class="md-header__ellipsis">
|
||||||
|
<div class="md-header__topic">
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
KIAUH Documentation
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
<div class="md-header__topic" data-md-component="header-topic">
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
|
||||||
|
Contributing
|
||||||
|
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
<form class="md-header__option" data-md-component="palette">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="blue-grey" data-md-color-accent="cyan" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
|
||||||
|
|
||||||
|
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3zm3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95zm-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31"/></svg>
|
||||||
|
</label>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="blue-grey" data-md-color-accent="cyan" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
|
||||||
|
|
||||||
|
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 7a5 5 0 0 1 5 5 5 5 0 0 1-5 5 5 5 0 0 1-5-5 5 5 0 0 1 5-5m0 2a3 3 0 0 0-3 3 3 3 0 0 0 3 3 3 3 0 0 0 3-3 3 3 0 0 0-3-3m0-7 2.39 3.42C13.65 5.15 12.84 5 12 5s-1.65.15-2.39.42zM3.34 7l4.16-.35A7.2 7.2 0 0 0 5.94 8.5c-.44.74-.69 1.5-.83 2.29zm.02 10 1.76-3.77a7.131 7.131 0 0 0 2.38 4.14zM20.65 7l-1.77 3.79a7.02 7.02 0 0 0-2.38-4.15zm-.01 10-4.14.36c.59-.51 1.12-1.14 1.54-1.86.42-.73.69-1.5.83-2.29zM12 22l-2.41-3.44c.74.27 1.55.44 2.41.44.82 0 1.63-.17 2.37-.44z"/></svg>
|
||||||
|
</label>
|
||||||
|
|
||||||
|
|
||||||
|
</form>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<label class="md-header__button md-icon" for="__search">
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
|
||||||
|
</label>
|
||||||
|
<div class="md-search" data-md-component="search" role="dialog">
|
||||||
|
<label class="md-search__overlay" for="__search"></label>
|
||||||
|
<div class="md-search__inner" role="search">
|
||||||
|
<form class="md-search__form" name="search">
|
||||||
|
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
|
||||||
|
<label class="md-search__icon md-icon" for="__search">
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
|
||||||
|
</label>
|
||||||
|
<nav class="md-search__options" aria-label="Search">
|
||||||
|
|
||||||
|
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
|
||||||
|
</button>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
</form>
|
||||||
|
<div class="md-search__output">
|
||||||
|
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
|
||||||
|
<div class="md-search-result" data-md-component="search-result">
|
||||||
|
<div class="md-search-result__meta">
|
||||||
|
Initializing search
|
||||||
|
</div>
|
||||||
|
<ol class="md-search-result__list" role="presentation"></ol>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div class="md-header__source">
|
||||||
|
<a href="https://github.com/dw-0/kiauh" title="Go to repository" class="md-source" data-md-component="source">
|
||||||
|
<div class="md-source__icon md-icon">
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path fill="currentColor" d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
|
||||||
|
</div>
|
||||||
|
<div class="md-source__repository">
|
||||||
|
dw-0/kiauh
|
||||||
|
</div>
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
</header>
|
||||||
|
|
||||||
|
<div class="md-container" data-md-component="container">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<main class="md-main" data-md-component="main">
|
||||||
|
<div class="md-main__inner md-grid">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
|
||||||
|
<div class="md-sidebar__scrollwrap">
|
||||||
|
<div class="md-sidebar__inner">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
|
||||||
|
<label class="md-nav__title" for="__drawer">
|
||||||
|
<a href="../.." title="KIAUH Documentation" class="md-nav__button md-logo" aria-label="KIAUH Documentation" data-md-component="logo">
|
||||||
|
|
||||||
|
<img src="../../assets/logo.png" alt="logo">
|
||||||
|
|
||||||
|
</a>
|
||||||
|
KIAUH Documentation
|
||||||
|
</label>
|
||||||
|
|
||||||
|
<div class="md-nav__source">
|
||||||
|
<a href="https://github.com/dw-0/kiauh" title="Go to repository" class="md-source" data-md-component="source">
|
||||||
|
<div class="md-source__icon md-icon">
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path fill="currentColor" d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
|
||||||
|
</div>
|
||||||
|
<div class="md-source__repository">
|
||||||
|
dw-0/kiauh
|
||||||
|
</div>
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<ul class="md-nav__list" data-md-scrollfix>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="../.." class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Home
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
|
||||||
|
|
||||||
|
|
||||||
|
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Installation
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-nav__icon md-icon"></span>
|
||||||
|
</label>
|
||||||
|
|
||||||
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
|
||||||
|
<label class="md-nav__title" for="__nav_2">
|
||||||
|
<span class="md-nav__icon md-icon"></span>
|
||||||
|
Installation
|
||||||
|
</label>
|
||||||
|
<ul class="md-nav__list" data-md-scrollfix>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="../../setup/raspberry-pi-setup/" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Raspberry Pi Setup
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="../../setup/installation/" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Installing KIAUH
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="../../configuration.md" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Configuration
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
|
||||||
|
|
||||||
|
|
||||||
|
<div class="md-nav__link md-nav__container">
|
||||||
|
<a href="../../extensions/" class="md-nav__link ">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Extensions
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
|
||||||
|
|
||||||
|
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
|
||||||
|
<span class="md-nav__icon md-icon"></span>
|
||||||
|
</label>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
|
||||||
|
<label class="md-nav__title" for="__nav_4">
|
||||||
|
<span class="md-nav__icon md-icon"></span>
|
||||||
|
Extensions
|
||||||
|
</label>
|
||||||
|
<ul class="md-nav__list" data-md-scrollfix>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="../../extensions/gcode-shell-command/" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
G-Code Shell Command Extension
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
|
||||||
|
|
||||||
|
|
||||||
|
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Development
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-nav__icon md-icon"></span>
|
||||||
|
</label>
|
||||||
|
|
||||||
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
|
||||||
|
<label class="md-nav__title" for="__nav_5">
|
||||||
|
<span class="md-nav__icon md-icon"></span>
|
||||||
|
Development
|
||||||
|
</label>
|
||||||
|
<ul class="md-nav__list" data-md-scrollfix>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item md-nav__item--active">
|
||||||
|
|
||||||
|
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a href="./" class="md-nav__link md-nav__link--active">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Contributing
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="../changelog/" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Changelog
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
|
||||||
|
<div class="md-sidebar__scrollwrap">
|
||||||
|
<div class="md-sidebar__inner">
|
||||||
|
|
||||||
|
|
||||||
|
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div class="md-content" data-md-component="content">
|
||||||
|
<article class="md-content__inner md-typeset">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h1>Contributing</h1>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<aside class="md-source-file">
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-source-file__fact">
|
||||||
|
<span class="md-icon" title="Last update">
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
|
||||||
|
</span>
|
||||||
|
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="August 29, 2025 18:23:31 UTC">August 29, 2025</span>
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-source-file__fact">
|
||||||
|
<span class="md-icon" title="Created">
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M14.47 15.08 11 13V7h1.5v5.25l3.08 1.83c-.41.28-.79.62-1.11 1m-1.39 4.84c-.36.05-.71.08-1.08.08-4.42 0-8-3.58-8-8s3.58-8 8-8 8 3.58 8 8c0 .37-.03.72-.08 1.08.69.1 1.33.32 1.92.64.1-.56.16-1.13.16-1.72 0-5.5-4.5-10-10-10S2 6.5 2 12s4.47 10 10 10c.59 0 1.16-.06 1.72-.16-.32-.59-.54-1.23-.64-1.92M18 15v3h-3v2h3v3h2v-3h3v-2h-3v-3z"/></svg>
|
||||||
|
</span>
|
||||||
|
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="August 29, 2025 18:23:31 UTC">August 29, 2025</span>
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</aside>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</article>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
|
||||||
|
Back to top
|
||||||
|
</button>
|
||||||
|
|
||||||
|
</main>
|
||||||
|
|
||||||
|
<footer class="md-footer">
|
||||||
|
|
||||||
|
<div class="md-footer-meta md-typeset">
|
||||||
|
<div class="md-footer-meta__inner md-grid">
|
||||||
|
<div class="md-copyright">
|
||||||
|
|
||||||
|
<div class="md-copyright__highlight">
|
||||||
|
Copyright © 2025 Dominik Willner
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
Made with
|
||||||
|
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
|
||||||
|
Material for MkDocs
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="md-social">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a href="https://github.com/dw-0" target="_blank" rel="noopener" title="github.com" class="md-social__link">
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12"/></svg>
|
||||||
|
</a>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a href="https://ko-fi.com/dw__0" target="_blank" rel="noopener" title="ko-fi.com" class="md-social__link">
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M11.351 2.715c-2.7 0-4.986.025-6.83.26C2.078 3.285 0 5.154 0 8.61c0 3.506.182 6.13 1.585 8.493 1.584 2.701 4.233 4.182 7.662 4.182h.83c4.209 0 6.494-2.234 7.637-4a9.5 9.5 0 0 0 1.091-2.338C21.792 14.688 24 12.22 24 9.208v-.415c0-3.247-2.13-5.507-5.792-5.87-1.558-.156-2.65-.208-6.857-.208m0 1.947c4.208 0 5.09.052 6.571.182 2.624.311 4.13 1.584 4.13 4v.39c0 2.156-1.792 3.844-3.87 3.844h-.935l-.156.649c-.208 1.013-.597 1.818-1.039 2.546-.909 1.428-2.545 3.064-5.922 3.064h-.805c-2.571 0-4.831-.883-6.078-3.195-1.09-2-1.298-4.155-1.298-7.506 0-2.181.857-3.402 3.012-3.714 1.533-.233 3.559-.26 6.39-.26m6.547 2.287c-.416 0-.65.234-.65.546v2.935c0 .311.234.545.65.545 1.324 0 2.051-.754 2.051-2s-.727-2.026-2.052-2.026m-10.39.182c-1.818 0-3.013 1.48-3.013 3.142 0 1.533.858 2.857 1.949 3.897.727.701 1.87 1.429 2.649 1.896a1.47 1.47 0 0 0 1.507 0c.78-.467 1.922-1.195 2.623-1.896 1.117-1.039 1.974-2.364 1.974-3.897 0-1.662-1.247-3.142-3.039-3.142-1.065 0-1.792.545-2.338 1.298-.493-.753-1.246-1.298-2.312-1.298"/></svg>
|
||||||
|
</a>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a href="https://www.paypal.com/paypalme/dwillner0" target="_blank" rel="noopener" title="www.paypal.com" class="md-social__link">
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M15.607 4.653H8.941L6.645 19.251H1.82L4.862 0h7.995c3.754 0 6.375 2.294 6.473 5.513-.648-.478-2.105-.86-3.722-.86m6.57 5.546c0 3.41-3.01 6.853-6.958 6.853h-2.493L11.595 24H6.74l1.845-11.538h3.592c4.208 0 7.346-3.634 7.153-6.949a5.24 5.24 0 0 1 2.848 4.686M9.653 5.546h6.408c.907 0 1.942.222 2.363.541-.195 2.741-2.655 5.483-6.441 5.483H8.714Z"/></svg>
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</footer>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<div class="md-dialog" data-md-component="dialog">
|
||||||
|
<div class="md-dialog__inner md-typeset"></div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script id="__config" type="application/json">{"base": "../..", "features": ["navigation.instant", "navigation.tracking", "navigation.sections", "navigation.expand", "navigation.indexes", "navigation.top", "toc.follow", "content.code.copy"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
|
||||||
|
|
||||||
|
|
||||||
|
<script src="../../assets/javascripts/bundle.92b07e13.min.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
@@ -1,305 +0,0 @@
|
|||||||
## Changelog
|
|
||||||
|
|
||||||
This document covers possible important changes to KIAUH.
|
|
||||||
|
|
||||||
### 2024-08-31 (v6.0.0-alpha.1)
|
|
||||||
Long time no see, but here we are again!
|
|
||||||
A lot has happened in the background, but now it is time to take it out into the wild.
|
|
||||||
|
|
||||||
#### KIAUH has now reached version 6! Well, at least in an alpha state...
|
|
||||||
|
|
||||||
The project has seen a complete rewrite of the script from scratch in Python.
|
|
||||||
It requires Python 3.8 or newer to run. Because this update is still in an alpha state, bugs may or will occur.
|
|
||||||
During startup, you will be asked if you want to start the new version 6 or the old version 5.
|
|
||||||
As long as version 6 is in a pre-release state, version 5 will still be available. If there are any critical issues
|
|
||||||
with the new version that were overlooked, you can always switch back to the old version.
|
|
||||||
|
|
||||||
In case you selected not to get asked about which version to start (option 3 or 4 in the startup dialog) and you want to
|
|
||||||
revert that decision, you will find a line called `version_to_launch=` within the `.kiauh.ini` file in your home directory.
|
|
||||||
Just delete that line, save the file and restart KIAUH. KIAUH will then ask you again which version you want to start.
|
|
||||||
|
|
||||||
Here is a list of the most important changes to KIAUH in regard to version 6:
|
|
||||||
- The majority of features available in KIAUH v5 are still available; they just got migrated from Bash to Python.
|
|
||||||
- It is now possible to add new/remove instances to/from existing multi-instance installations of Klipper and Moonraker
|
|
||||||
- KIAUH now has an Extension-System. This allows contributors to add new installers to KIAUH without having to modify the main script.
|
|
||||||
- You will now find some of the features that were previously available in the Installer-Menu in the Extensions-Menu.
|
|
||||||
- The current extensions are:
|
|
||||||
- G-Code Shell Command (previously found in the Advanced-Menu)
|
|
||||||
- Mainsail Theme Installer (previously found in the Advanced-Menu)
|
|
||||||
- Klipper-Backup (new in v6!)
|
|
||||||
- Moonraker Telegram Bot (previously found in the Installer-Menu)
|
|
||||||
- PrettyGCode for Klipper (previously found in the Installer-Menu)
|
|
||||||
- Obico for Klipper (previously found in the Installer-Menu)
|
|
||||||
- The following additional extensions are planned, but not yet available:
|
|
||||||
- Spoolman (available in v5 in the Installer-Menu)
|
|
||||||
- OctoApp (available in v5 in the Installer-Menu)
|
|
||||||
- KIAUH has its own config file now
|
|
||||||
- The file has some default values for the currently supported options
|
|
||||||
- There might be more options in the future
|
|
||||||
- It is located in KIAUH's root directory and is called `default.kiauh.cfg`
|
|
||||||
- DO NOT EDIT the default file directly, instead make a copy of it and call it `kiauh.cfg`
|
|
||||||
- Settings changed via the Advanced-Menu will be written to the `kiauh.cfg`
|
|
||||||
- Support for OctoPrint was removed
|
|
||||||
|
|
||||||
Feel free to give version 6 a try and report any bugs or issues you encounter! Every feedback is appreciated.
|
|
||||||
|
|
||||||
### 2023-06-17
|
|
||||||
KIAUH has now added support for installing Mobileraker's companion!
|
|
||||||
Mobileraker is a free and Open Source Android and iOS App for Klipper, utilizing the Moonraker API, allowing you
|
|
||||||
to control your printer. Thank you to [Clon1998](https://github.com/Clon1998) for adding this feature!
|
|
||||||
|
|
||||||
### 2023-02-03
|
|
||||||
The installer for MJPG-Streamer got replaced by crowsnest. It is an improved webcam service, utilizing ustreamer.
|
|
||||||
Please have a look here for additional info about crowsnest and how to configure it: https://github.com/mainsail-crew/crowsnest \
|
|
||||||
It's unsure if the previous MJPG-Streamer installer will be updated and make its way back into KIAUH.
|
|
||||||
A big thanks to [KwadFan](https://github.com/KwadFan) for writing the crowsnest implementation.
|
|
||||||
|
|
||||||
### 2022-10-31
|
|
||||||
Some functions got updated, though not all of them.
|
|
||||||
|
|
||||||
The following functions are still currently unavailable:
|
|
||||||
- Installation of: MJPG-Streamer
|
|
||||||
- All backup functions and the Log-Upload
|
|
||||||
|
|
||||||
### 2022-10-20
|
|
||||||
KIAUH has now reached major version 5 !
|
|
||||||
|
|
||||||
Recently Moonraker introduced some changes which makes it necessary to change the folder structure of printer setups.
|
|
||||||
If you are interested in the details, check out this PR: https://github.com/Arksine/moonraker/pull/491 \
|
|
||||||
Although Moonraker has some mechanics available to migrate existing setups to the new file structure with the use of symlinks, fresh and clean installs
|
|
||||||
should be considered.
|
|
||||||
|
|
||||||
The version jump of KIAUH to v5 is a breaking change due to those major changes! That means v4 and v5 are not compatible with each other!
|
|
||||||
This is also the reason why you will currently be greeted by a yellow notification in the main menu of KIAUH leading to this changelog.
|
|
||||||
I decided to disable a few functions of the script and focus on releasing the required changes to the core components of this script.
|
|
||||||
I will work on updating the other parts of the script piece by piece during the next days/weeks.
|
|
||||||
So I am already sorry in advance if one of your desired components you wanted to install or use temporarily cannot be installed or used right now.
|
|
||||||
|
|
||||||
The following functions are currently unavailable:
|
|
||||||
- Installation of: KlipperScreen, Obico, Octoprint, MJPG-Streamer, Telegram Bot and PrettyGCode
|
|
||||||
- All backup functions and the Log-Upload
|
|
||||||
|
|
||||||
**So what is working?**\
|
|
||||||
Installation of Klipper, Moonraker, Mainsail and Fluidd. Both, single and multi-instance setups work!\
|
|
||||||
As already said, the rest will follow in the near future. Updating and removal of already installed components should continue to work.
|
|
||||||
|
|
||||||
**What was removed?**\
|
|
||||||
The option to change Klippers configuration directory got removed. From now on it will not be possible anymore to change
|
|
||||||
the configuration directory from within KIAUH and the new filestructure is enforced.
|
|
||||||
|
|
||||||
**What if I don't have an existing Klipper/Moonraker install right now?**\
|
|
||||||
Nothing important to think about, install Klipper and Moonraker. KIAUH will install both of them with the new filestructure.
|
|
||||||
|
|
||||||
**What if I have an existing Klipper/Moonraker install?**\
|
|
||||||
First of all: Backups! Please copy all of your config files and the Moonraker database (it is a hidden folder, usually `~/.moonraker_database`) to a safe location.
|
|
||||||
After that, uninstall Klipper and Moonraker with KIAUH. You can then proceed and re-install both of them with KIAUH again. It is important that you are on KIAUH v5 for that!
|
|
||||||
Once everything is installed again, you need to manually copy your configuration files from the old `~/klipper_config` folder to the new `~/printer_data/config` folder.
|
|
||||||
Previous, by Moonraker created symlinks to folder of the old filestructure will not work anymore, you need to move the files to their new location now!
|
|
||||||
Do the same with the two files inside of `~/.moonraker_database`. Move/copy them into `~/printer_data/database`. If `~/printer_data/database` is already populated with a `data.mdb` and `lock.mdb`
|
|
||||||
delete them or simply overwrite them. Nothing should be lost as those should be empty database files. Anyway, you made backups, right?
|
|
||||||
You can now proceed and restart Moonraker. Either from within Mainsail or Fluidd, or use SSH and execute `sudo systemctl restart moonraker`.
|
|
||||||
If everything went smooth, you should be good to go again. If you see some Moonraker warnings about deprecated options in the `moonraker.conf`, go ahead and resolve them.
|
|
||||||
I will not cover them in detail here. A good source is the Moonraker documentation: https://moonraker.readthedocs.io/en/latest/configuration/
|
|
||||||
|
|
||||||
**What if I have an existing Klipper/Moonraker multi-instance install?**\
|
|
||||||
Pretty much the same steps that are required for single instance installs apply to multi-instance setups. So please go ahead and read the previous paragraph if you didn't already.
|
|
||||||
Make backups of everything first. Then remove and install the desired amount of Klipper and Moonraker instances again.
|
|
||||||
Now you need to move all config and database files to their new locations.\
|
|
||||||
Example with an instance called `printer_1`:\
|
|
||||||
The config files go from `~/klipper_config/printer_1` to `~/printer_1_data/config`.
|
|
||||||
The database files go from `~/.moonraker_database_1` to `~/printer_1_data/database`.
|
|
||||||
Now restart all Moonraker services. You can restart all of them at once if you launch KIAUH, and in the main menu type `restart moonraker` and hit Enter.
|
|
||||||
|
|
||||||
I hope I have covered the most important things. In case you need further support, the official Klipper Discord is a good place to ask for help.
|
|
||||||
|
|
||||||
### 2022-08-15
|
|
||||||
Support for "Obico for Klipper" was added! Huge thanks to [kennethjiang](https://github.com/kennethjiang) for helping me with the implementation!
|
|
||||||
|
|
||||||
### 2022-05-29
|
|
||||||
KIAUH has now reached major version 4 !
|
|
||||||
* feat: Klipper can be installed under Python3 (still considered as experimental)
|
|
||||||
* feat: Klipper can be installed from custom repositories / inofficial forks
|
|
||||||
* feat: Custom instance name for multi instance installations of Klipper
|
|
||||||
* Any other multi instance will share the same name given to the corresponding Klipper instance
|
|
||||||
* E.g. klipper-voron2 -> moonraker-voron2 -> moonraker-telegram-bot-voron2
|
|
||||||
* feat: Option to allow installation of / updating to unstable Mainsail and Fluidd versions
|
|
||||||
* by default only stable versions get installed/updated
|
|
||||||
* feat: Multi-Instance OctoPrint installations now each have their own virtual python environment
|
|
||||||
* allows independent installation of plugins for each instance
|
|
||||||
* feat: Implementing the use of shellcheck during development
|
|
||||||
* feat: Implementing a simple logging mechanic
|
|
||||||
* feat: Log-upload function now also allows uploading other logfiles (kiauh.log, webcamd.log etc.)
|
|
||||||
* feat: added several new help dialogs which try to explain various functions
|
|
||||||
* fix: During Klipper installation, checks for group membership of `tty` and `dialout` are made
|
|
||||||
* refactor: rework of the settings menu for better control the new KIAUH features
|
|
||||||
* refactor: Support for DWC and DWC-for-Klipper has been removed
|
|
||||||
* refactor: The backup before update settings were moved to the KIAUH settings menu
|
|
||||||
* refactor: Switch branch function has been removed (was replaced by the custom Klipper repo feature)
|
|
||||||
* refactor: The update manager sections for Mainsail, Fluidd and KlipperScreen were removed from the moonraker.conf template
|
|
||||||
* They will now be individually added during installation of the corresponding interface
|
|
||||||
* refactor: The rollback function was reworked and now also allows rollbacks of Moonraker
|
|
||||||
* It now takes numerical inputs and reverts the corresponding repository by the given amount instead
|
|
||||||
* KIAUH does not save previous states to its config anymore like it did with the previous approach
|
|
||||||
|
|
||||||
|
|
||||||
### 2022-01-29
|
|
||||||
* Starting from the 28th of January, Moonraker can make use of PackageKit and PolicyKit.\
|
|
||||||
More details on that can be found [here](
|
|
||||||
https://github.com/Arksine/moonraker/issues/349) and [here](https://github.com/Arksine/moonraker/pull/346)
|
|
||||||
* KIAUH will install Moonrakers PolicyKit rules by default when __installing__ Moonraker
|
|
||||||
* KIAUH will also install Moonrakers PolicyKit rules when __updating__ Moonraker __via KIAUH__ as of now
|
|
||||||
|
|
||||||
### 2021-12-30
|
|
||||||
* Updated the doc for the usage of the [G-Code Shell Command Extension](docs/gcode_shell_command.md)
|
|
||||||
* It became apparent, that some user groups are missing on some systems. A missing video group \
|
|
||||||
membership for example caused issues when installing mjpg-streamer while not using the default pi user. \
|
|
||||||
Other issues could occur when trying to flash an MCU on Debian or Ubuntu distributions where a user might not be part
|
|
||||||
of the dialout group by default. A check for the tty group is also done. The tty group is needed for setting
|
|
||||||
up a linux MCU (currently not yet supported by KIAUH).
|
|
||||||
* There is an issue when trying to install Mainsail or Fluidd on Ubuntu 21.10. Permissions on that distro seem to have seen a rework
|
|
||||||
in comparison to 20.04 and users will be greeted with an "Error 403 - Permission denied" message after installing one of Klippers webinterfaces.
|
|
||||||
I still have to figure out a viable solution for that.
|
|
||||||
|
|
||||||
### 2021-09-28
|
|
||||||
* New Feature! Added an installer for the Telegram Bot for Moonraker by [nlef](https://github.com/nlef).
|
|
||||||
Checkout his project! Remember to report all issues and/or bugs regarding that project in its corresponding repo and not here 😛.\
|
|
||||||
You can find it here: https://github.com/nlef/moonraker-telegram-bot
|
|
||||||
|
|
||||||
### 2021-09-24
|
|
||||||
* The flashing function got adjusted a bit. It is now possible to also flash controllers which are connected over UART and thus accessible via `/dev/ttyAMA0`. You now have to select a connection methop prior flashing which is either USB or UART.
|
|
||||||
* Due to several requests over time I have now created a Ko-fi account for those who want to support this project and my work with a small donation. Many thanks in advance to all future donors. You can support me on Ko-fi with this link: https://ko-fi.com/th33xitus
|
|
||||||
* As usual, if you find any bugs or issues please report them. I tested the little rework i did with the hardware i have available and haven't encountered any malfunctions of flashing them yet.
|
|
||||||
|
|
||||||
### 2021-08-10
|
|
||||||
* KIAUH now supports the installation of the "PrettyGCode for Klipper" GCode-Viewer created by [Kragrathea](https://github.com/Kragrathea)! Installation, updating and removal are possible with KIAUH. For more details to this cool piece of software, please have a look here: https://github.com/Kragrathea/pgcode
|
|
||||||
|
|
||||||
### 2021-07-10
|
|
||||||
* The NGINX configuration files got updated to be in sync with MainsailOS and FluiddPi. Issues with the NGINX service not starting up due to wrong configuration should be resolved now. To get the updated configuration files, please remove Moonraker and Mainsail / Fluidd with KIAUH first and then re-install it. An automated file check for those configuration files might follow in the future which then automates updating those files if there were important changes.
|
|
||||||
|
|
||||||
* The default `moonraker.conf` was updated to reflect the recent changes to the update manager section. The update channel is set to `dev`.
|
|
||||||
|
|
||||||
### 2021-06-29
|
|
||||||
* KIAUH will now patch the new `log_path` to existing moonraker.conf files when updating Moonraker and the entry is missing. Before that, it was necessary that the user provided that path manually to make Fluidd display the logfiles in its interface. This issue should be resolved now.
|
|
||||||
|
|
||||||
### 2021-06-15
|
|
||||||
|
|
||||||
* Moonraker introduced an optional `log_path` which clients can make use of to show log files located in that folder to their users. More info here: https://github.com/Arksine/moonraker/commit/829b3a4ee80579af35dd64a37ccc092a1f67682a \
|
|
||||||
Client developers agreed upon using `~/klipper_logs` as the new default log path.\
|
|
||||||
That means, from now on, Klipper and Moonraker services installed with KIAUH will place their logfiles in that mentioned folder.
|
|
||||||
* Additionally, KIAUH will now detect Klipper and Moonraker systemd services that still use the old default location of `/tmp/<service>.log` and will update them next time the user updates Klipper and/or Moonraker with the KIAUH update function.
|
|
||||||
* Additional symlinks for the following logfiles will get created along those update procedures to make them accessible through the webinterface once its supported:
|
|
||||||
- webcamd.log
|
|
||||||
- mainsail-access.log
|
|
||||||
- mainsail-error.log
|
|
||||||
- fluidd-access.log
|
|
||||||
- fluidd-error.log
|
|
||||||
* For MainsailOS and FluiddPi users:\
|
|
||||||
MainsailOS and FluiddPi will switch the shipped Klipper service from SysVinit to systemd probably with their next release. KIAUH can already help migrate older MainsailOS (0.4.0 and below) and FluiddPi (v1.13.0) releases to match their new service-, file- and folder-structure so you don't have to re-flash the SD-Card of your Raspberry Pi.\
|
|
||||||
In detail here is what is going to happen when you use the new "CustomPiOS Migration Helper" from the Advanced Menu\
|
|
||||||
`(Main Menu -> 4 -> Enter -> 10 -> Enter)` in a short summary:
|
|
||||||
* The Klipper SysVinit service will get replaced by a Klipper systemd service
|
|
||||||
* Klipper and Moonraker will use the new log-directory `~/klipper_logs`
|
|
||||||
* The webcamd service gets updated
|
|
||||||
* The webcamd script gets updated and moved from `/root/bin/webcamd` to `/usr/local/bin/webcamd`
|
|
||||||
* The NGINX `upstreams.conf` gets updated to be able to configure up to 4 webcams
|
|
||||||
* The `mainsail.txt` / `fluiddpi.txt` gets moved from `/boot` to `~/klipper_config` and renamed to `webcam.txt`
|
|
||||||
* Symlinks for the webcamd.log and various NGINX logs get created in `~/klipper_config`
|
|
||||||
* Configuration files for Klipper, Moonraker and webcamd get added to `/etc/logrotate.d`
|
|
||||||
* If they still exist, two lines will be removed from the mainsail.cfg or client_macros.cfg macro configurations:\
|
|
||||||
`SAVE_GCODE_STATE NAME=PAUSE_state` and `RESTORE_GCODE_STATE NAME=PAUSE_state`
|
|
||||||
* **Please note:**\
|
|
||||||
The "CustomPiOS Migration Helper" is intended to only work on "vanilla" MainsailOS and FluiddPi systems. Do not try to migrate a modified MainsailOS or FluiddPi system (for example if you already used KIAUH to re-install services or to set up a multi-instance installation for Klipper / Moonraker). This won't work.
|
|
||||||
|
|
||||||
### 2021-01-31
|
|
||||||
|
|
||||||
* **This is a big one... KIAUH v3.0 is out.**\
|
|
||||||
With this update you can now install multiple instances of Klipper, Moonraker, Duet Web Control or Octoprint on the same Pi. This was quite a big rework of the whole script. So bugs can appear but with the help of some testers, i think there shouldn't be any critical ones anymore. In this regards thanks to @lixxbox and @zellneralex for testing.
|
|
||||||
|
|
||||||
* Important changes to how installations are set up now: All components get installed as systemd services. Installation via init.d was dropped completely! This shouldn't affect you at all, since the common linux distributions like RaspberryPi OS or custom distributions like MainsailOS, FluiddPi or OctoPi support both ways of installing services. I just wanted to mention it here.
|
|
||||||
|
|
||||||
* Now with KIAUH v3.0 and multi-instance installation capabilities, there are some things to point out. You will now need to tell KIAUH where your printers configurations are located when installing Klipper for the first time. Even though it is not recommended, you can change this location with the help of KIAUH and rewrite Klipper and Moonraker to use the new location.
|
|
||||||
|
|
||||||
* When setting up a multi-instance system, the folder structure will only change slightly. The goal was to keep it as compatible as possible with the custom distributions like mainsailOS and FluiddPi. This should help converting a single-instance setup of mainsailOS/FluiddPi to a multi-instance setup in no time, but keeping single-instance backwards compatibility if needed at a later point in time.
|
|
||||||
|
|
||||||
* The folder structure is as follows when setting up multi-instances:\
|
|
||||||
Each printer instance will get its own folder within your configuration location. The decision to this specific structure was made to make it as painless and easy as possible to convert to a multi-instance setup.
|
|
||||||
Here is an example:
|
|
||||||
```shell
|
|
||||||
/home/<username>
|
|
||||||
└── klipper_config
|
|
||||||
├── printer_1
|
|
||||||
│ ├── printer.cfg
|
|
||||||
│ └── moonraker.conf
|
|
||||||
├── printer_2
|
|
||||||
│ ├── printer.cfg
|
|
||||||
│ └── moonraker.conf
|
|
||||||
└── printer_n
|
|
||||||
├── printer.cfg
|
|
||||||
└── moonraker.conf
|
|
||||||
```
|
|
||||||
* Also when setting up multi-instances of each service, the name of each service slightly changes.
|
|
||||||
Each service gets its corresponding instance added to the service filename.
|
|
||||||
|
|
||||||
**This only applies to multi-instances! Single instance installations with KIAUH will keep their original names!**
|
|
||||||
|
|
||||||
Corresponding to the filetree example from above that would mean:
|
|
||||||
```
|
|
||||||
Klipper services:
|
|
||||||
--> klipper-1.service
|
|
||||||
--> klipper-2.service
|
|
||||||
--> klipper-n.service
|
|
||||||
|
|
||||||
Moonraker services:
|
|
||||||
--> moonraker-1.service
|
|
||||||
--> moonraker-2.service
|
|
||||||
--> moonraker-n.service
|
|
||||||
```
|
|
||||||
* The same service file rules from above apply to OctoPrint even though only Klipper and Moonraker are shown in this example.
|
|
||||||
|
|
||||||
* You can start, stop and restart all Klipper, Moonraker and OctoPrint instances from the KIAUH main menu. For doing this, just type "stop klipper", "start moonraker", "restart octoprint" and so on.
|
|
||||||
|
|
||||||
* KIAUH v3.0 relocated its ini-file. It is now a hidden file in the users home-directory calles `.kiauh.ini`. This has the benefit of keeping all values in that file between possible re-installations of KIAUH. Otherwise that file would be lost.
|
|
||||||
|
|
||||||
* The option of adding more trusted clients to the moonraker.conf file was dropped. Since you can edit this file right inside of Mainsail or Fluidd, only some basic entries are made which get you running.
|
|
||||||
|
|
||||||
* I bet i have missed mentioning other stuff as well because it took me quite some time to re-write many functions. So i just hope you like the new version 😄
|
|
||||||
|
|
||||||
### 2020-11-28
|
|
||||||
|
|
||||||
* KIAUH now supports the installation, update and removal of [KlipperScreen](https://github.com/jordanruthe/KlipperScreen). This feature was was provided by [jordanruthe](https://github.com/jordanruthe)! Thank you!
|
|
||||||
|
|
||||||
### 2020-11-18
|
|
||||||
|
|
||||||
* Some changes to Fluidd caused a little rework on how KIAUH will install/update Fluidd from now on. Please see the [fluidd v1.0.0-rc0 release notes](https://github.com/cadriel/fluidd/releases/tag/v1.0.0-rc.0) for further information about what modifications to the moonraker.conf file exactly had to be done. In a nutshell, KIAUH will now always patch the required entries to the moonraker.conf if not already there.
|
|
||||||
|
|
||||||
### 2020-10-30:
|
|
||||||
|
|
||||||
* The user can now choose to install Klipper as a systemd service.
|
|
||||||
|
|
||||||
* The Shell Command extension and `shell_command.py` got renamed to G-Code Shell Command extension and `gcode_shell_command.py`. In case the [pending PR](https://github.com/KevinOConnor/klipper/pull/2173) will be merged in the future, this was an early attempt to dodge possible incompatibilities. The [G-Code Shell Command docs](gcode_shell_command.md) has been updated accordingly.
|
|
||||||
|
|
||||||
* The way how KIAUH interacts and writes to the users printer.cfg got changed. Usually KIAUH wrote everything directly into the printer.cfg. The way it will work from now on is, that a new file called `kiauh.cfg` will be created if there is something that needs to be written to the printer.cfg and everything gets written to `kiauh.cfg` instead. The only thing which then gets written to the users printer.cfg is `[include kiauh.cfg]`. This line will be located at the very top of the existing printer.cfg with a little comment as a note. The user can then decide to either keep the `kiauh.cfg` or take its content, places it into the printer.cfg directly and remove the `[include kiauh.cfg]`.
|
|
||||||
|
|
||||||
* The `mainsail_macros.cfg` got renamed to `webui_macros.cfg`. Since Mainsail and Fluidd both use the same kind of pause, cancel and resume macros, a more generic name was chosen for the file containing the example macros one can choose to install when installing those webinterfaces.
|
|
||||||
|
|
||||||
### 2020-10-10:
|
|
||||||
|
|
||||||
* Support for changing the Klipper branch to the moonraker-dev branch from @Arksine has been dropped. Support for Moonraker has been merged into Klipper mainline a long time ago.
|
|
||||||
|
|
||||||
* A new function is available from the main menu. You can now upload your log files to http://paste.c-net.org/ to share them for debugging purposes.
|
|
||||||
|
|
||||||
### 2020-10-06:
|
|
||||||
|
|
||||||
* Fluidd, a new Klipper interface got added to the list of available installers. At the same time some installation routines have changed or have seen some rework. Changes were made to the installation of NGINX configurations. A method was introduced to change the listen port of a webinterface configuration if there is already another webinterface listening on the default port (80).
|
|
||||||
|
|
||||||
* At the moment, the Moonraker installer no longer asks you whether you want to install a web interface too. For now you therefore have to install them with their respective installers. Please report any bugs or issues you encounter.
|
|
||||||
|
|
||||||
### 2020-09-17:
|
|
||||||
|
|
||||||
* The dev-2.0 branch will be abandoned as of today. If you did a checkout to that branch in the past, you have to checkout back to master to receive updates.
|
|
||||||
|
|
||||||
### 2020-09-12:
|
|
||||||
|
|
||||||
* The old [dwc2-for-klipper](https://github.com/Stephan3/dwc2-for-klipper) won't be supported anymore!\
|
|
||||||
The is a new, fully rewritten project available: [dwc2-for-klipper-socket](https://github.com/Stephan3/dwc2-for-klipper-socket).\
|
|
||||||
The installer of this script also got rewritten to make use of that new project. You will not be able to install or remove the old [dwc2-for-klipper](https://github.com/Stephan3/dwc2-for-klipper) with KIAUH anymore if you updated KIAUH to the newest version.
|
|
||||||
@@ -1,74 +0,0 @@
|
|||||||
# G-Code Shell Command Extension
|
|
||||||
|
|
||||||
### Creator of this extension is [Arksine](https://github.com/Arksine).
|
|
||||||
|
|
||||||
This is a brief explanation of how to use the shell command extension for Klipper, which you can install with KIAUH.
|
|
||||||
|
|
||||||
After installing the extension you can execute linux commands or even scripts from within Klipper with custom commands defined in your printer.cfg.
|
|
||||||
|
|
||||||
#### How to configure a shell command:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
# Runs a linux command or script from within klipper. Note that sudo commands
|
|
||||||
# that require password authentication are disallowed. All executable scripts
|
|
||||||
# should include a shebang.
|
|
||||||
# [gcode_shell_command my_shell_cmd]
|
|
||||||
#command:
|
|
||||||
# The linux shell command/script to be executed. This parameter must be
|
|
||||||
# provided
|
|
||||||
#timeout: 2.
|
|
||||||
# The timeout in seconds until the command is forcably terminated. Default
|
|
||||||
# is 2 seconds.
|
|
||||||
#verbose: True
|
|
||||||
# If enabled, the command's output will be forwarded to the terminal. Its
|
|
||||||
# recommended to set this to false for commands that my run in quick
|
|
||||||
# succession. Default is True.
|
|
||||||
```
|
|
||||||
|
|
||||||
Once you have set up a shell command with the given parameters from above in your printer.cfg you can run the command as follows:
|
|
||||||
`RUN_SHELL_COMMAND CMD=name`
|
|
||||||
|
|
||||||
Example:
|
|
||||||
|
|
||||||
```
|
|
||||||
[gcode_shell_command hello_world]
|
|
||||||
command: echo hello world
|
|
||||||
timeout: 2.
|
|
||||||
verbose: True
|
|
||||||
```
|
|
||||||
|
|
||||||
Execute with:
|
|
||||||
`RUN_SHELL_COMMAND CMD=hello_world`
|
|
||||||
|
|
||||||
### Passing parameters:
|
|
||||||
As of commit [f231fa9](https://github.com/dw-0/kiauh/commit/f231fa9c69191f23277b4e3319f6b675bfa0ee42) it is also possible to pass optional parameters to a `gcode_shell_command`.
|
|
||||||
The following short example shows storing the extruder temperature into a variable, passing that value with a parameter to a `gcode_shell_command`, which then,
|
|
||||||
once the gcode_macro runs and the gcode_shell_command gets called, executes the `script.sh`. The script then echoes a message to the console (if `verbose: True`)
|
|
||||||
and writes the value of the parameter into a textfile called `test.txt` located in the home directory.
|
|
||||||
|
|
||||||
Content of the `gcode_shell_command` and the `gcode_macro`:
|
|
||||||
```
|
|
||||||
[gcode_shell_command print_to_file]
|
|
||||||
command: sh /home/pi/klipper_config/script.sh
|
|
||||||
timeout: 30.
|
|
||||||
verbose: True
|
|
||||||
|
|
||||||
[gcode_macro GET_TEMP]
|
|
||||||
gcode:
|
|
||||||
{% set temp = printer.extruder.temperature %}
|
|
||||||
{ action_respond_info("%s" % (temp)) }
|
|
||||||
RUN_SHELL_COMMAND CMD=print_to_file PARAMS={temp}
|
|
||||||
```
|
|
||||||
|
|
||||||
Content of `script.sh`:
|
|
||||||
```shell
|
|
||||||
#!/bin/sh
|
|
||||||
|
|
||||||
echo "temp is: $1"
|
|
||||||
echo "$1" >> "${HOME}/test.txt"
|
|
||||||
```
|
|
||||||
|
|
||||||
## Warning
|
|
||||||
|
|
||||||
This extension may have a high potential for abuse if not used carefully! Also, depending on the command you execute, high system loads may occur and can cause system instabilities.
|
|
||||||
Use this extension at your own risk and only if you know what you are doing!
|
|
||||||
@@ -0,0 +1,958 @@
|
|||||||
|
|
||||||
|
<!doctype html>
|
||||||
|
<html lang="en" class="no-js">
|
||||||
|
<head>
|
||||||
|
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||||
|
|
||||||
|
<meta name="description" content="Documentation for the Klipper Installation And Update Helper">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="prev" href="../">
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="next" href="../../development/contributing/">
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="icon" href="../../assets/logo.png">
|
||||||
|
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.18">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<title>G-Code Shell Command Extension - KIAUH Documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="../../assets/stylesheets/main.7e37652d.min.css">
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
|
||||||
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
|
||||||
|
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="../../assets/_mkdocstrings.css">
|
||||||
|
|
||||||
|
<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</head>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="blue-grey" data-md-color-accent="cyan">
|
||||||
|
|
||||||
|
|
||||||
|
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
|
||||||
|
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
|
||||||
|
<label class="md-overlay" for="__drawer"></label>
|
||||||
|
<div data-md-component="skip">
|
||||||
|
|
||||||
|
|
||||||
|
<a href="#g-code-shell-command-extension" class="md-skip">
|
||||||
|
Skip to content
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<div data-md-component="announce">
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<header class="md-header md-header--shadow" data-md-component="header">
|
||||||
|
<nav class="md-header__inner md-grid" aria-label="Header">
|
||||||
|
<a href="../.." title="KIAUH Documentation" class="md-header__button md-logo" aria-label="KIAUH Documentation" data-md-component="logo">
|
||||||
|
|
||||||
|
<img src="../../assets/logo.png" alt="logo">
|
||||||
|
|
||||||
|
</a>
|
||||||
|
<label class="md-header__button md-icon" for="__drawer">
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
|
||||||
|
</label>
|
||||||
|
<div class="md-header__title" data-md-component="header-title">
|
||||||
|
<div class="md-header__ellipsis">
|
||||||
|
<div class="md-header__topic">
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
KIAUH Documentation
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
<div class="md-header__topic" data-md-component="header-topic">
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
|
||||||
|
G-Code Shell Command Extension
|
||||||
|
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
<form class="md-header__option" data-md-component="palette">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="blue-grey" data-md-color-accent="cyan" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
|
||||||
|
|
||||||
|
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3zm3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95zm-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31"/></svg>
|
||||||
|
</label>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="blue-grey" data-md-color-accent="cyan" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
|
||||||
|
|
||||||
|
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 7a5 5 0 0 1 5 5 5 5 0 0 1-5 5 5 5 0 0 1-5-5 5 5 0 0 1 5-5m0 2a3 3 0 0 0-3 3 3 3 0 0 0 3 3 3 3 0 0 0 3-3 3 3 0 0 0-3-3m0-7 2.39 3.42C13.65 5.15 12.84 5 12 5s-1.65.15-2.39.42zM3.34 7l4.16-.35A7.2 7.2 0 0 0 5.94 8.5c-.44.74-.69 1.5-.83 2.29zm.02 10 1.76-3.77a7.131 7.131 0 0 0 2.38 4.14zM20.65 7l-1.77 3.79a7.02 7.02 0 0 0-2.38-4.15zm-.01 10-4.14.36c.59-.51 1.12-1.14 1.54-1.86.42-.73.69-1.5.83-2.29zM12 22l-2.41-3.44c.74.27 1.55.44 2.41.44.82 0 1.63-.17 2.37-.44z"/></svg>
|
||||||
|
</label>
|
||||||
|
|
||||||
|
|
||||||
|
</form>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<label class="md-header__button md-icon" for="__search">
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
|
||||||
|
</label>
|
||||||
|
<div class="md-search" data-md-component="search" role="dialog">
|
||||||
|
<label class="md-search__overlay" for="__search"></label>
|
||||||
|
<div class="md-search__inner" role="search">
|
||||||
|
<form class="md-search__form" name="search">
|
||||||
|
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
|
||||||
|
<label class="md-search__icon md-icon" for="__search">
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
|
||||||
|
</label>
|
||||||
|
<nav class="md-search__options" aria-label="Search">
|
||||||
|
|
||||||
|
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
|
||||||
|
</button>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
</form>
|
||||||
|
<div class="md-search__output">
|
||||||
|
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
|
||||||
|
<div class="md-search-result" data-md-component="search-result">
|
||||||
|
<div class="md-search-result__meta">
|
||||||
|
Initializing search
|
||||||
|
</div>
|
||||||
|
<ol class="md-search-result__list" role="presentation"></ol>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div class="md-header__source">
|
||||||
|
<a href="https://github.com/dw-0/kiauh" title="Go to repository" class="md-source" data-md-component="source">
|
||||||
|
<div class="md-source__icon md-icon">
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path fill="currentColor" d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
|
||||||
|
</div>
|
||||||
|
<div class="md-source__repository">
|
||||||
|
dw-0/kiauh
|
||||||
|
</div>
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
</header>
|
||||||
|
|
||||||
|
<div class="md-container" data-md-component="container">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<main class="md-main" data-md-component="main">
|
||||||
|
<div class="md-main__inner md-grid">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
|
||||||
|
<div class="md-sidebar__scrollwrap">
|
||||||
|
<div class="md-sidebar__inner">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
|
||||||
|
<label class="md-nav__title" for="__drawer">
|
||||||
|
<a href="../.." title="KIAUH Documentation" class="md-nav__button md-logo" aria-label="KIAUH Documentation" data-md-component="logo">
|
||||||
|
|
||||||
|
<img src="../../assets/logo.png" alt="logo">
|
||||||
|
|
||||||
|
</a>
|
||||||
|
KIAUH Documentation
|
||||||
|
</label>
|
||||||
|
|
||||||
|
<div class="md-nav__source">
|
||||||
|
<a href="https://github.com/dw-0/kiauh" title="Go to repository" class="md-source" data-md-component="source">
|
||||||
|
<div class="md-source__icon md-icon">
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path fill="currentColor" d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
|
||||||
|
</div>
|
||||||
|
<div class="md-source__repository">
|
||||||
|
dw-0/kiauh
|
||||||
|
</div>
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<ul class="md-nav__list" data-md-scrollfix>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="../.." class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Home
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
|
||||||
|
|
||||||
|
|
||||||
|
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Installation
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-nav__icon md-icon"></span>
|
||||||
|
</label>
|
||||||
|
|
||||||
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
|
||||||
|
<label class="md-nav__title" for="__nav_2">
|
||||||
|
<span class="md-nav__icon md-icon"></span>
|
||||||
|
Installation
|
||||||
|
</label>
|
||||||
|
<ul class="md-nav__list" data-md-scrollfix>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="../../setup/raspberry-pi-setup/" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Raspberry Pi Setup
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="../../setup/installation/" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Installing KIAUH
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="../../configuration.md" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Configuration
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="md-nav__link md-nav__container">
|
||||||
|
<a href="../" class="md-nav__link ">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Extensions
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
|
||||||
|
|
||||||
|
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
|
||||||
|
<span class="md-nav__icon md-icon"></span>
|
||||||
|
</label>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
|
||||||
|
<label class="md-nav__title" for="__nav_4">
|
||||||
|
<span class="md-nav__icon md-icon"></span>
|
||||||
|
Extensions
|
||||||
|
</label>
|
||||||
|
<ul class="md-nav__list" data-md-scrollfix>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item md-nav__item--active">
|
||||||
|
|
||||||
|
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<label class="md-nav__link md-nav__link--active" for="__toc">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
G-Code Shell Command Extension
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-nav__icon md-icon"></span>
|
||||||
|
</label>
|
||||||
|
|
||||||
|
<a href="./" class="md-nav__link md-nav__link--active">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
G-Code Shell Command Extension
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<label class="md-nav__title" for="__toc">
|
||||||
|
<span class="md-nav__icon md-icon"></span>
|
||||||
|
Table of contents
|
||||||
|
</label>
|
||||||
|
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#creator-of-this-extension-is-arksine" class="md-nav__link">
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Creator of this extension is Arksine.
|
||||||
|
</span>
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<nav class="md-nav" aria-label="Creator of this extension is Arksine.">
|
||||||
|
<ul class="md-nav__list">
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#how-to-configure-a-shell-command" class="md-nav__link">
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
How to configure a shell command:
|
||||||
|
</span>
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#passing-parameters" class="md-nav__link">
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Passing parameters:
|
||||||
|
</span>
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#warning" class="md-nav__link">
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Warning
|
||||||
|
</span>
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
|
||||||
|
|
||||||
|
|
||||||
|
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Development
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-nav__icon md-icon"></span>
|
||||||
|
</label>
|
||||||
|
|
||||||
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
||||||
|
<label class="md-nav__title" for="__nav_5">
|
||||||
|
<span class="md-nav__icon md-icon"></span>
|
||||||
|
Development
|
||||||
|
</label>
|
||||||
|
<ul class="md-nav__list" data-md-scrollfix>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="../../development/contributing/" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Contributing
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="../../development/changelog/" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Changelog
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
|
||||||
|
<div class="md-sidebar__scrollwrap">
|
||||||
|
<div class="md-sidebar__inner">
|
||||||
|
|
||||||
|
|
||||||
|
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<label class="md-nav__title" for="__toc">
|
||||||
|
<span class="md-nav__icon md-icon"></span>
|
||||||
|
Table of contents
|
||||||
|
</label>
|
||||||
|
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#creator-of-this-extension-is-arksine" class="md-nav__link">
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Creator of this extension is Arksine.
|
||||||
|
</span>
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<nav class="md-nav" aria-label="Creator of this extension is Arksine.">
|
||||||
|
<ul class="md-nav__list">
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#how-to-configure-a-shell-command" class="md-nav__link">
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
How to configure a shell command:
|
||||||
|
</span>
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#passing-parameters" class="md-nav__link">
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Passing parameters:
|
||||||
|
</span>
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#warning" class="md-nav__link">
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Warning
|
||||||
|
</span>
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div class="md-content" data-md-component="content">
|
||||||
|
<article class="md-content__inner md-typeset">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h1 id="g-code-shell-command-extension">G-Code Shell Command Extension</h1>
|
||||||
|
<h3 id="creator-of-this-extension-is-arksine">Creator of this extension is <a href="https://github.com/Arksine">Arksine</a>.</h3>
|
||||||
|
<p>This is a brief explanation of how to use the shell command extension for Klipper, which you can install with KIAUH.</p>
|
||||||
|
<p>After installing the extension you can execute linux commands or even scripts from within Klipper with custom commands defined in your printer.cfg.</p>
|
||||||
|
<h4 id="how-to-configure-a-shell-command">How to configure a shell command:</h4>
|
||||||
|
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="c1"># Runs a linux command or script from within klipper. Note that sudo commands</span>
|
||||||
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="c1"># that require password authentication are disallowed. All executable scripts</span>
|
||||||
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="c1"># should include a shebang.</span>
|
||||||
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="c1"># [gcode_shell_command my_shell_cmd]</span>
|
||||||
|
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="c1">#command:</span>
|
||||||
|
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a><span class="c1"># The linux shell command/script to be executed. This parameter must be</span>
|
||||||
|
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="c1"># provided</span>
|
||||||
|
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a><span class="c1">#timeout: 2.</span>
|
||||||
|
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a><span class="c1"># The timeout in seconds until the command is forcably terminated. Default</span>
|
||||||
|
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a><span class="c1"># is 2 seconds.</span>
|
||||||
|
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a><span class="c1">#verbose: True</span>
|
||||||
|
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a><span class="c1"># If enabled, the command's output will be forwarded to the terminal. Its</span>
|
||||||
|
<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a><span class="c1"># recommended to set this to false for commands that my run in quick</span>
|
||||||
|
<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a><span class="c1"># succession. Default is True.</span>
|
||||||
|
</code></pre></div>
|
||||||
|
<p>Once you have set up a shell command with the given parameters from above in your printer.cfg you can run the command as follows:
|
||||||
|
<code>RUN_SHELL_COMMAND CMD=name</code></p>
|
||||||
|
<p>Example:</p>
|
||||||
|
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>[gcode_shell_command hello_world]
|
||||||
|
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a>command: echo hello world
|
||||||
|
<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a>timeout: 2.
|
||||||
|
<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a>verbose: True
|
||||||
|
</code></pre></div>
|
||||||
|
<p>Execute with:
|
||||||
|
<code>RUN_SHELL_COMMAND CMD=hello_world</code></p>
|
||||||
|
<h3 id="passing-parameters">Passing parameters:</h3>
|
||||||
|
<p>As of commit <a href="https://github.com/dw-0/kiauh/commit/f231fa9c69191f23277b4e3319f6b675bfa0ee42">f231fa9</a> it is also possible to pass optional parameters to a <code>gcode_shell_command</code>.
|
||||||
|
The following short example shows storing the extruder temperature into a variable, passing that value with a parameter to a <code>gcode_shell_command</code>, which then,
|
||||||
|
once the gcode_macro runs and the gcode_shell_command gets called, executes the <code>script.sh</code>. The script then echoes a message to the console (if <code>verbose: True</code>)
|
||||||
|
and writes the value of the parameter into a textfile called <code>test.txt</code> located in the home directory.</p>
|
||||||
|
<p>Content of the <code>gcode_shell_command</code> and the <code>gcode_macro</code>:
|
||||||
|
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>[gcode_shell_command print_to_file]
|
||||||
|
<a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a>command: sh /home/pi/klipper_config/script.sh
|
||||||
|
<a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a>timeout: 30.
|
||||||
|
<a id="__codelineno-2-4" name="__codelineno-2-4" href="#__codelineno-2-4"></a>verbose: True
|
||||||
|
<a id="__codelineno-2-5" name="__codelineno-2-5" href="#__codelineno-2-5"></a>
|
||||||
|
<a id="__codelineno-2-6" name="__codelineno-2-6" href="#__codelineno-2-6"></a>[gcode_macro GET_TEMP]
|
||||||
|
<a id="__codelineno-2-7" name="__codelineno-2-7" href="#__codelineno-2-7"></a>gcode:
|
||||||
|
<a id="__codelineno-2-8" name="__codelineno-2-8" href="#__codelineno-2-8"></a> {% set temp = printer.extruder.temperature %}
|
||||||
|
<a id="__codelineno-2-9" name="__codelineno-2-9" href="#__codelineno-2-9"></a> { action_respond_info("%s" % (temp)) }
|
||||||
|
<a id="__codelineno-2-10" name="__codelineno-2-10" href="#__codelineno-2-10"></a> RUN_SHELL_COMMAND CMD=print_to_file PARAMS={temp}
|
||||||
|
</code></pre></div></p>
|
||||||
|
<p>Content of <code>script.sh</code>:
|
||||||
|
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="ch">#!/bin/sh</span>
|
||||||
|
<a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a>
|
||||||
|
<a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a><span class="nb">echo</span><span class="w"> </span><span class="s2">"temp is: </span><span class="nv">$1</span><span class="s2">"</span>
|
||||||
|
<a id="__codelineno-3-4" name="__codelineno-3-4" href="#__codelineno-3-4"></a><span class="nb">echo</span><span class="w"> </span><span class="s2">"</span><span class="nv">$1</span><span class="s2">"</span><span class="w"> </span>>><span class="w"> </span><span class="s2">"</span><span class="si">${</span><span class="nv">HOME</span><span class="si">}</span><span class="s2">/test.txt"</span>
|
||||||
|
</code></pre></div></p>
|
||||||
|
<h2 id="warning">Warning</h2>
|
||||||
|
<p>This extension may have a high potential for abuse if not used carefully! Also, depending on the command you execute, high system loads may occur and can cause system instabilities.
|
||||||
|
Use this extension at your own risk and only if you know what you are doing!</p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<aside class="md-source-file">
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-source-file__fact">
|
||||||
|
<span class="md-icon" title="Last update">
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
|
||||||
|
</span>
|
||||||
|
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="August 29, 2025 18:23:31 UTC">August 29, 2025</span>
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-source-file__fact">
|
||||||
|
<span class="md-icon" title="Created">
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M14.47 15.08 11 13V7h1.5v5.25l3.08 1.83c-.41.28-.79.62-1.11 1m-1.39 4.84c-.36.05-.71.08-1.08.08-4.42 0-8-3.58-8-8s3.58-8 8-8 8 3.58 8 8c0 .37-.03.72-.08 1.08.69.1 1.33.32 1.92.64.1-.56.16-1.13.16-1.72 0-5.5-4.5-10-10-10S2 6.5 2 12s4.47 10 10 10c.59 0 1.16-.06 1.72-.16-.32-.59-.54-1.23-.64-1.92M18 15v3h-3v2h3v3h2v-3h3v-2h-3v-3z"/></svg>
|
||||||
|
</span>
|
||||||
|
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="August 29, 2025 18:23:31 UTC">August 29, 2025</span>
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</aside>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</article>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
|
||||||
|
Back to top
|
||||||
|
</button>
|
||||||
|
|
||||||
|
</main>
|
||||||
|
|
||||||
|
<footer class="md-footer">
|
||||||
|
|
||||||
|
<div class="md-footer-meta md-typeset">
|
||||||
|
<div class="md-footer-meta__inner md-grid">
|
||||||
|
<div class="md-copyright">
|
||||||
|
|
||||||
|
<div class="md-copyright__highlight">
|
||||||
|
Copyright © 2025 Dominik Willner
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
Made with
|
||||||
|
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
|
||||||
|
Material for MkDocs
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="md-social">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a href="https://github.com/dw-0" target="_blank" rel="noopener" title="github.com" class="md-social__link">
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12"/></svg>
|
||||||
|
</a>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a href="https://ko-fi.com/dw__0" target="_blank" rel="noopener" title="ko-fi.com" class="md-social__link">
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M11.351 2.715c-2.7 0-4.986.025-6.83.26C2.078 3.285 0 5.154 0 8.61c0 3.506.182 6.13 1.585 8.493 1.584 2.701 4.233 4.182 7.662 4.182h.83c4.209 0 6.494-2.234 7.637-4a9.5 9.5 0 0 0 1.091-2.338C21.792 14.688 24 12.22 24 9.208v-.415c0-3.247-2.13-5.507-5.792-5.87-1.558-.156-2.65-.208-6.857-.208m0 1.947c4.208 0 5.09.052 6.571.182 2.624.311 4.13 1.584 4.13 4v.39c0 2.156-1.792 3.844-3.87 3.844h-.935l-.156.649c-.208 1.013-.597 1.818-1.039 2.546-.909 1.428-2.545 3.064-5.922 3.064h-.805c-2.571 0-4.831-.883-6.078-3.195-1.09-2-1.298-4.155-1.298-7.506 0-2.181.857-3.402 3.012-3.714 1.533-.233 3.559-.26 6.39-.26m6.547 2.287c-.416 0-.65.234-.65.546v2.935c0 .311.234.545.65.545 1.324 0 2.051-.754 2.051-2s-.727-2.026-2.052-2.026m-10.39.182c-1.818 0-3.013 1.48-3.013 3.142 0 1.533.858 2.857 1.949 3.897.727.701 1.87 1.429 2.649 1.896a1.47 1.47 0 0 0 1.507 0c.78-.467 1.922-1.195 2.623-1.896 1.117-1.039 1.974-2.364 1.974-3.897 0-1.662-1.247-3.142-3.039-3.142-1.065 0-1.792.545-2.338 1.298-.493-.753-1.246-1.298-2.312-1.298"/></svg>
|
||||||
|
</a>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a href="https://www.paypal.com/paypalme/dwillner0" target="_blank" rel="noopener" title="www.paypal.com" class="md-social__link">
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M15.607 4.653H8.941L6.645 19.251H1.82L4.862 0h7.995c3.754 0 6.375 2.294 6.473 5.513-.648-.478-2.105-.86-3.722-.86m6.57 5.546c0 3.41-3.01 6.853-6.958 6.853h-2.493L11.595 24H6.74l1.845-11.538h3.592c4.208 0 7.346-3.634 7.153-6.949a5.24 5.24 0 0 1 2.848 4.686M9.653 5.546h6.408c.907 0 1.942.222 2.363.541-.195 2.741-2.655 5.483-6.441 5.483H8.714Z"/></svg>
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</footer>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<div class="md-dialog" data-md-component="dialog">
|
||||||
|
<div class="md-dialog__inner md-typeset"></div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script id="__config" type="application/json">{"base": "../..", "features": ["navigation.instant", "navigation.tracking", "navigation.sections", "navigation.expand", "navigation.indexes", "navigation.top", "toc.follow", "content.code.copy"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
|
||||||
|
|
||||||
|
|
||||||
|
<script src="../../assets/javascripts/bundle.92b07e13.min.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
@@ -0,0 +1,769 @@
|
|||||||
|
|
||||||
|
<!doctype html>
|
||||||
|
<html lang="en" class="no-js">
|
||||||
|
<head>
|
||||||
|
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||||
|
|
||||||
|
<meta name="description" content="Documentation for the Klipper Installation And Update Helper">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="prev" href="../setup/installation/">
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="next" href="gcode-shell-command/">
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="icon" href="../assets/logo.png">
|
||||||
|
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.18">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<title>Community Extensions - KIAUH Documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
|
||||||
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
|
||||||
|
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="../assets/_mkdocstrings.css">
|
||||||
|
|
||||||
|
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</head>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="blue-grey" data-md-color-accent="cyan">
|
||||||
|
|
||||||
|
|
||||||
|
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
|
||||||
|
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
|
||||||
|
<label class="md-overlay" for="__drawer"></label>
|
||||||
|
<div data-md-component="skip">
|
||||||
|
|
||||||
|
|
||||||
|
<a href="#community-extensions" class="md-skip">
|
||||||
|
Skip to content
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<div data-md-component="announce">
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<header class="md-header md-header--shadow" data-md-component="header">
|
||||||
|
<nav class="md-header__inner md-grid" aria-label="Header">
|
||||||
|
<a href=".." title="KIAUH Documentation" class="md-header__button md-logo" aria-label="KIAUH Documentation" data-md-component="logo">
|
||||||
|
|
||||||
|
<img src="../assets/logo.png" alt="logo">
|
||||||
|
|
||||||
|
</a>
|
||||||
|
<label class="md-header__button md-icon" for="__drawer">
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
|
||||||
|
</label>
|
||||||
|
<div class="md-header__title" data-md-component="header-title">
|
||||||
|
<div class="md-header__ellipsis">
|
||||||
|
<div class="md-header__topic">
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
KIAUH Documentation
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
<div class="md-header__topic" data-md-component="header-topic">
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
|
||||||
|
Community Extensions
|
||||||
|
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
<form class="md-header__option" data-md-component="palette">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="blue-grey" data-md-color-accent="cyan" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
|
||||||
|
|
||||||
|
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3zm3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95zm-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31"/></svg>
|
||||||
|
</label>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="blue-grey" data-md-color-accent="cyan" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
|
||||||
|
|
||||||
|
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 7a5 5 0 0 1 5 5 5 5 0 0 1-5 5 5 5 0 0 1-5-5 5 5 0 0 1 5-5m0 2a3 3 0 0 0-3 3 3 3 0 0 0 3 3 3 3 0 0 0 3-3 3 3 0 0 0-3-3m0-7 2.39 3.42C13.65 5.15 12.84 5 12 5s-1.65.15-2.39.42zM3.34 7l4.16-.35A7.2 7.2 0 0 0 5.94 8.5c-.44.74-.69 1.5-.83 2.29zm.02 10 1.76-3.77a7.131 7.131 0 0 0 2.38 4.14zM20.65 7l-1.77 3.79a7.02 7.02 0 0 0-2.38-4.15zm-.01 10-4.14.36c.59-.51 1.12-1.14 1.54-1.86.42-.73.69-1.5.83-2.29zM12 22l-2.41-3.44c.74.27 1.55.44 2.41.44.82 0 1.63-.17 2.37-.44z"/></svg>
|
||||||
|
</label>
|
||||||
|
|
||||||
|
|
||||||
|
</form>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<label class="md-header__button md-icon" for="__search">
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
|
||||||
|
</label>
|
||||||
|
<div class="md-search" data-md-component="search" role="dialog">
|
||||||
|
<label class="md-search__overlay" for="__search"></label>
|
||||||
|
<div class="md-search__inner" role="search">
|
||||||
|
<form class="md-search__form" name="search">
|
||||||
|
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
|
||||||
|
<label class="md-search__icon md-icon" for="__search">
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
|
||||||
|
</label>
|
||||||
|
<nav class="md-search__options" aria-label="Search">
|
||||||
|
|
||||||
|
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
|
||||||
|
</button>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
</form>
|
||||||
|
<div class="md-search__output">
|
||||||
|
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
|
||||||
|
<div class="md-search-result" data-md-component="search-result">
|
||||||
|
<div class="md-search-result__meta">
|
||||||
|
Initializing search
|
||||||
|
</div>
|
||||||
|
<ol class="md-search-result__list" role="presentation"></ol>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div class="md-header__source">
|
||||||
|
<a href="https://github.com/dw-0/kiauh" title="Go to repository" class="md-source" data-md-component="source">
|
||||||
|
<div class="md-source__icon md-icon">
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path fill="currentColor" d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
|
||||||
|
</div>
|
||||||
|
<div class="md-source__repository">
|
||||||
|
dw-0/kiauh
|
||||||
|
</div>
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
</header>
|
||||||
|
|
||||||
|
<div class="md-container" data-md-component="container">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<main class="md-main" data-md-component="main">
|
||||||
|
<div class="md-main__inner md-grid">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
|
||||||
|
<div class="md-sidebar__scrollwrap">
|
||||||
|
<div class="md-sidebar__inner">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
|
||||||
|
<label class="md-nav__title" for="__drawer">
|
||||||
|
<a href=".." title="KIAUH Documentation" class="md-nav__button md-logo" aria-label="KIAUH Documentation" data-md-component="logo">
|
||||||
|
|
||||||
|
<img src="../assets/logo.png" alt="logo">
|
||||||
|
|
||||||
|
</a>
|
||||||
|
KIAUH Documentation
|
||||||
|
</label>
|
||||||
|
|
||||||
|
<div class="md-nav__source">
|
||||||
|
<a href="https://github.com/dw-0/kiauh" title="Go to repository" class="md-source" data-md-component="source">
|
||||||
|
<div class="md-source__icon md-icon">
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path fill="currentColor" d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
|
||||||
|
</div>
|
||||||
|
<div class="md-source__repository">
|
||||||
|
dw-0/kiauh
|
||||||
|
</div>
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<ul class="md-nav__list" data-md-scrollfix>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href=".." class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Home
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
|
||||||
|
|
||||||
|
|
||||||
|
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Installation
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-nav__icon md-icon"></span>
|
||||||
|
</label>
|
||||||
|
|
||||||
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
|
||||||
|
<label class="md-nav__title" for="__nav_2">
|
||||||
|
<span class="md-nav__icon md-icon"></span>
|
||||||
|
Installation
|
||||||
|
</label>
|
||||||
|
<ul class="md-nav__list" data-md-scrollfix>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="../setup/raspberry-pi-setup/" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Raspberry Pi Setup
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="../setup/installation/" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Installing KIAUH
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="../configuration.md" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Configuration
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="md-nav__link md-nav__container">
|
||||||
|
<a href="./" class="md-nav__link md-nav__link--active">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Extensions
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
|
||||||
|
|
||||||
|
<label class="md-nav__link md-nav__link--active" for="__nav_4" id="__nav_4_label" tabindex="">
|
||||||
|
<span class="md-nav__icon md-icon"></span>
|
||||||
|
</label>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
|
||||||
|
<label class="md-nav__title" for="__nav_4">
|
||||||
|
<span class="md-nav__icon md-icon"></span>
|
||||||
|
Extensions
|
||||||
|
</label>
|
||||||
|
<ul class="md-nav__list" data-md-scrollfix>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="gcode-shell-command/" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
G-Code Shell Command Extension
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
|
||||||
|
|
||||||
|
|
||||||
|
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Development
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-nav__icon md-icon"></span>
|
||||||
|
</label>
|
||||||
|
|
||||||
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
||||||
|
<label class="md-nav__title" for="__nav_5">
|
||||||
|
<span class="md-nav__icon md-icon"></span>
|
||||||
|
Development
|
||||||
|
</label>
|
||||||
|
<ul class="md-nav__list" data-md-scrollfix>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="../development/contributing/" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Contributing
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="../development/changelog/" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Changelog
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
|
||||||
|
<div class="md-sidebar__scrollwrap">
|
||||||
|
<div class="md-sidebar__inner">
|
||||||
|
|
||||||
|
|
||||||
|
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div class="md-content" data-md-component="content">
|
||||||
|
<article class="md-content__inner md-typeset">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h1 id="community-extensions">Community Extensions</h1>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<aside class="md-source-file">
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-source-file__fact">
|
||||||
|
<span class="md-icon" title="Last update">
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
|
||||||
|
</span>
|
||||||
|
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="August 29, 2025 18:23:31 UTC">August 29, 2025</span>
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-source-file__fact">
|
||||||
|
<span class="md-icon" title="Created">
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M14.47 15.08 11 13V7h1.5v5.25l3.08 1.83c-.41.28-.79.62-1.11 1m-1.39 4.84c-.36.05-.71.08-1.08.08-4.42 0-8-3.58-8-8s3.58-8 8-8 8 3.58 8 8c0 .37-.03.72-.08 1.08.69.1 1.33.32 1.92.64.1-.56.16-1.13.16-1.72 0-5.5-4.5-10-10-10S2 6.5 2 12s4.47 10 10 10c.59 0 1.16-.06 1.72-.16-.32-.59-.54-1.23-.64-1.92M18 15v3h-3v2h3v3h2v-3h3v-2h-3v-3z"/></svg>
|
||||||
|
</span>
|
||||||
|
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="August 29, 2025 18:23:31 UTC">August 29, 2025</span>
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</aside>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</article>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
|
||||||
|
Back to top
|
||||||
|
</button>
|
||||||
|
|
||||||
|
</main>
|
||||||
|
|
||||||
|
<footer class="md-footer">
|
||||||
|
|
||||||
|
<div class="md-footer-meta md-typeset">
|
||||||
|
<div class="md-footer-meta__inner md-grid">
|
||||||
|
<div class="md-copyright">
|
||||||
|
|
||||||
|
<div class="md-copyright__highlight">
|
||||||
|
Copyright © 2025 Dominik Willner
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
Made with
|
||||||
|
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
|
||||||
|
Material for MkDocs
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="md-social">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a href="https://github.com/dw-0" target="_blank" rel="noopener" title="github.com" class="md-social__link">
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12"/></svg>
|
||||||
|
</a>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a href="https://ko-fi.com/dw__0" target="_blank" rel="noopener" title="ko-fi.com" class="md-social__link">
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M11.351 2.715c-2.7 0-4.986.025-6.83.26C2.078 3.285 0 5.154 0 8.61c0 3.506.182 6.13 1.585 8.493 1.584 2.701 4.233 4.182 7.662 4.182h.83c4.209 0 6.494-2.234 7.637-4a9.5 9.5 0 0 0 1.091-2.338C21.792 14.688 24 12.22 24 9.208v-.415c0-3.247-2.13-5.507-5.792-5.87-1.558-.156-2.65-.208-6.857-.208m0 1.947c4.208 0 5.09.052 6.571.182 2.624.311 4.13 1.584 4.13 4v.39c0 2.156-1.792 3.844-3.87 3.844h-.935l-.156.649c-.208 1.013-.597 1.818-1.039 2.546-.909 1.428-2.545 3.064-5.922 3.064h-.805c-2.571 0-4.831-.883-6.078-3.195-1.09-2-1.298-4.155-1.298-7.506 0-2.181.857-3.402 3.012-3.714 1.533-.233 3.559-.26 6.39-.26m6.547 2.287c-.416 0-.65.234-.65.546v2.935c0 .311.234.545.65.545 1.324 0 2.051-.754 2.051-2s-.727-2.026-2.052-2.026m-10.39.182c-1.818 0-3.013 1.48-3.013 3.142 0 1.533.858 2.857 1.949 3.897.727.701 1.87 1.429 2.649 1.896a1.47 1.47 0 0 0 1.507 0c.78-.467 1.922-1.195 2.623-1.896 1.117-1.039 1.974-2.364 1.974-3.897 0-1.662-1.247-3.142-3.039-3.142-1.065 0-1.792.545-2.338 1.298-.493-.753-1.246-1.298-2.312-1.298"/></svg>
|
||||||
|
</a>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a href="https://www.paypal.com/paypalme/dwillner0" target="_blank" rel="noopener" title="www.paypal.com" class="md-social__link">
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M15.607 4.653H8.941L6.645 19.251H1.82L4.862 0h7.995c3.754 0 6.375 2.294 6.473 5.513-.648-.478-2.105-.86-3.722-.86m6.57 5.546c0 3.41-3.01 6.853-6.958 6.853h-2.493L11.595 24H6.74l1.845-11.538h3.592c4.208 0 7.346-3.634 7.153-6.949a5.24 5.24 0 0 1 2.848 4.686M9.653 5.546h6.408c.907 0 1.942.222 2.363.541-.195 2.741-2.655 5.483-6.441 5.483H8.714Z"/></svg>
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</footer>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<div class="md-dialog" data-md-component="dialog">
|
||||||
|
<div class="md-dialog__inner md-typeset"></div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script id="__config" type="application/json">{"base": "..", "features": ["navigation.instant", "navigation.tracking", "navigation.sections", "navigation.expand", "navigation.indexes", "navigation.top", "toc.follow", "content.code.copy"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
|
||||||
|
|
||||||
|
|
||||||
|
<script src="../assets/javascripts/bundle.92b07e13.min.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
+851
@@ -0,0 +1,851 @@
|
|||||||
|
|
||||||
|
<!doctype html>
|
||||||
|
<html lang="en" class="no-js">
|
||||||
|
<head>
|
||||||
|
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||||
|
|
||||||
|
<meta name="description" content="Documentation for the Klipper Installation And Update Helper">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="next" href="setup/raspberry-pi-setup/">
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="icon" href="assets/logo.png">
|
||||||
|
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.18">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<title>KIAUH Documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
|
||||||
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
|
||||||
|
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="assets/_mkdocstrings.css">
|
||||||
|
|
||||||
|
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</head>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="blue-grey" data-md-color-accent="cyan">
|
||||||
|
|
||||||
|
|
||||||
|
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
|
||||||
|
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
|
||||||
|
<label class="md-overlay" for="__drawer"></label>
|
||||||
|
<div data-md-component="skip">
|
||||||
|
|
||||||
|
|
||||||
|
<a href="#features" class="md-skip">
|
||||||
|
Skip to content
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<div data-md-component="announce">
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<header class="md-header md-header--shadow" data-md-component="header">
|
||||||
|
<nav class="md-header__inner md-grid" aria-label="Header">
|
||||||
|
<a href="." title="KIAUH Documentation" class="md-header__button md-logo" aria-label="KIAUH Documentation" data-md-component="logo">
|
||||||
|
|
||||||
|
<img src="assets/logo.png" alt="logo">
|
||||||
|
|
||||||
|
</a>
|
||||||
|
<label class="md-header__button md-icon" for="__drawer">
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
|
||||||
|
</label>
|
||||||
|
<div class="md-header__title" data-md-component="header-title">
|
||||||
|
<div class="md-header__ellipsis">
|
||||||
|
<div class="md-header__topic">
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
KIAUH Documentation
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
<div class="md-header__topic" data-md-component="header-topic">
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
|
||||||
|
Home
|
||||||
|
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
<form class="md-header__option" data-md-component="palette">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="blue-grey" data-md-color-accent="cyan" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
|
||||||
|
|
||||||
|
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3zm3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95zm-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31"/></svg>
|
||||||
|
</label>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="blue-grey" data-md-color-accent="cyan" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
|
||||||
|
|
||||||
|
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 7a5 5 0 0 1 5 5 5 5 0 0 1-5 5 5 5 0 0 1-5-5 5 5 0 0 1 5-5m0 2a3 3 0 0 0-3 3 3 3 0 0 0 3 3 3 3 0 0 0 3-3 3 3 0 0 0-3-3m0-7 2.39 3.42C13.65 5.15 12.84 5 12 5s-1.65.15-2.39.42zM3.34 7l4.16-.35A7.2 7.2 0 0 0 5.94 8.5c-.44.74-.69 1.5-.83 2.29zm.02 10 1.76-3.77a7.131 7.131 0 0 0 2.38 4.14zM20.65 7l-1.77 3.79a7.02 7.02 0 0 0-2.38-4.15zm-.01 10-4.14.36c.59-.51 1.12-1.14 1.54-1.86.42-.73.69-1.5.83-2.29zM12 22l-2.41-3.44c.74.27 1.55.44 2.41.44.82 0 1.63-.17 2.37-.44z"/></svg>
|
||||||
|
</label>
|
||||||
|
|
||||||
|
|
||||||
|
</form>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<label class="md-header__button md-icon" for="__search">
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
|
||||||
|
</label>
|
||||||
|
<div class="md-search" data-md-component="search" role="dialog">
|
||||||
|
<label class="md-search__overlay" for="__search"></label>
|
||||||
|
<div class="md-search__inner" role="search">
|
||||||
|
<form class="md-search__form" name="search">
|
||||||
|
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
|
||||||
|
<label class="md-search__icon md-icon" for="__search">
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
|
||||||
|
</label>
|
||||||
|
<nav class="md-search__options" aria-label="Search">
|
||||||
|
|
||||||
|
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
|
||||||
|
</button>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
</form>
|
||||||
|
<div class="md-search__output">
|
||||||
|
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
|
||||||
|
<div class="md-search-result" data-md-component="search-result">
|
||||||
|
<div class="md-search-result__meta">
|
||||||
|
Initializing search
|
||||||
|
</div>
|
||||||
|
<ol class="md-search-result__list" role="presentation"></ol>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div class="md-header__source">
|
||||||
|
<a href="https://github.com/dw-0/kiauh" title="Go to repository" class="md-source" data-md-component="source">
|
||||||
|
<div class="md-source__icon md-icon">
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path fill="currentColor" d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
|
||||||
|
</div>
|
||||||
|
<div class="md-source__repository">
|
||||||
|
dw-0/kiauh
|
||||||
|
</div>
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
</header>
|
||||||
|
|
||||||
|
<div class="md-container" data-md-component="container">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<main class="md-main" data-md-component="main">
|
||||||
|
<div class="md-main__inner md-grid">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
|
||||||
|
<div class="md-sidebar__scrollwrap">
|
||||||
|
<div class="md-sidebar__inner">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
|
||||||
|
<label class="md-nav__title" for="__drawer">
|
||||||
|
<a href="." title="KIAUH Documentation" class="md-nav__button md-logo" aria-label="KIAUH Documentation" data-md-component="logo">
|
||||||
|
|
||||||
|
<img src="assets/logo.png" alt="logo">
|
||||||
|
|
||||||
|
</a>
|
||||||
|
KIAUH Documentation
|
||||||
|
</label>
|
||||||
|
|
||||||
|
<div class="md-nav__source">
|
||||||
|
<a href="https://github.com/dw-0/kiauh" title="Go to repository" class="md-source" data-md-component="source">
|
||||||
|
<div class="md-source__icon md-icon">
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path fill="currentColor" d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
|
||||||
|
</div>
|
||||||
|
<div class="md-source__repository">
|
||||||
|
dw-0/kiauh
|
||||||
|
</div>
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<ul class="md-nav__list" data-md-scrollfix>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item md-nav__item--active">
|
||||||
|
|
||||||
|
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<label class="md-nav__link md-nav__link--active" for="__toc">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Home
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-nav__icon md-icon"></span>
|
||||||
|
</label>
|
||||||
|
|
||||||
|
<a href="." class="md-nav__link md-nav__link--active">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Home
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<label class="md-nav__title" for="__toc">
|
||||||
|
<span class="md-nav__icon md-icon"></span>
|
||||||
|
Table of contents
|
||||||
|
</label>
|
||||||
|
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#features" class="md-nav__link">
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Features
|
||||||
|
</span>
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
|
||||||
|
|
||||||
|
|
||||||
|
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Installation
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-nav__icon md-icon"></span>
|
||||||
|
</label>
|
||||||
|
|
||||||
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
|
||||||
|
<label class="md-nav__title" for="__nav_2">
|
||||||
|
<span class="md-nav__icon md-icon"></span>
|
||||||
|
Installation
|
||||||
|
</label>
|
||||||
|
<ul class="md-nav__list" data-md-scrollfix>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="setup/raspberry-pi-setup/" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Raspberry Pi Setup
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="setup/installation/" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Installing KIAUH
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="configuration.md" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Configuration
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
|
||||||
|
|
||||||
|
|
||||||
|
<div class="md-nav__link md-nav__container">
|
||||||
|
<a href="extensions/" class="md-nav__link ">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Extensions
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
|
||||||
|
|
||||||
|
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
|
||||||
|
<span class="md-nav__icon md-icon"></span>
|
||||||
|
</label>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
|
||||||
|
<label class="md-nav__title" for="__nav_4">
|
||||||
|
<span class="md-nav__icon md-icon"></span>
|
||||||
|
Extensions
|
||||||
|
</label>
|
||||||
|
<ul class="md-nav__list" data-md-scrollfix>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="extensions/gcode-shell-command/" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
G-Code Shell Command Extension
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
|
||||||
|
|
||||||
|
|
||||||
|
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Development
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-nav__icon md-icon"></span>
|
||||||
|
</label>
|
||||||
|
|
||||||
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
||||||
|
<label class="md-nav__title" for="__nav_5">
|
||||||
|
<span class="md-nav__icon md-icon"></span>
|
||||||
|
Development
|
||||||
|
</label>
|
||||||
|
<ul class="md-nav__list" data-md-scrollfix>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="development/contributing/" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Contributing
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="development/changelog/" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Changelog
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
|
||||||
|
<div class="md-sidebar__scrollwrap">
|
||||||
|
<div class="md-sidebar__inner">
|
||||||
|
|
||||||
|
|
||||||
|
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<label class="md-nav__title" for="__toc">
|
||||||
|
<span class="md-nav__icon md-icon"></span>
|
||||||
|
Table of contents
|
||||||
|
</label>
|
||||||
|
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#features" class="md-nav__link">
|
||||||
|
<span class="md-ellipsis">
|
||||||
|
Features
|
||||||
|
</span>
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div class="md-content" data-md-component="content">
|
||||||
|
<article class="md-content__inner md-typeset">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div class="admonition tip">
|
||||||
|
<p class="admonition-title">Important</p>
|
||||||
|
<p>This documentation is for KIAUH version 6 and still work in progress!</p>
|
||||||
|
</div>
|
||||||
|
<h1 align="center">
|
||||||
|
KIAUH - Klipper Installation And Update Helper
|
||||||
|
</h1>
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
<img src="assets/logo-large.png" alt="KIAUH logo" width="400"/>
|
||||||
|
</p>
|
||||||
|
<p align="center" style="font-size: 1.2em; font-weight: bold;">
|
||||||
|
A handy installation script that makes installing Klipper (and more) a breeze!
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<h2 id="features">Features</h2>
|
||||||
|
<ul>
|
||||||
|
<li>Easy installation of Klipper and related components</li>
|
||||||
|
<li>Support for multiple instances</li>
|
||||||
|
<li>Extension system for additional functionality</li>
|
||||||
|
<li>Configuration management</li>
|
||||||
|
<li>And more!</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<aside class="md-source-file">
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-source-file__fact">
|
||||||
|
<span class="md-icon" title="Last update">
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
|
||||||
|
</span>
|
||||||
|
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="August 29, 2025 18:23:31 UTC">August 29, 2025</span>
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span class="md-source-file__fact">
|
||||||
|
<span class="md-icon" title="Created">
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M14.47 15.08 11 13V7h1.5v5.25l3.08 1.83c-.41.28-.79.62-1.11 1m-1.39 4.84c-.36.05-.71.08-1.08.08-4.42 0-8-3.58-8-8s3.58-8 8-8 8 3.58 8 8c0 .37-.03.72-.08 1.08.69.1 1.33.32 1.92.64.1-.56.16-1.13.16-1.72 0-5.5-4.5-10-10-10S2 6.5 2 12s4.47 10 10 10c.59 0 1.16-.06 1.72-.16-.32-.59-.54-1.23-.64-1.92M18 15v3h-3v2h3v3h2v-3h3v-2h-3v-3z"/></svg>
|
||||||
|
</span>
|
||||||
|
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="August 29, 2025 18:23:31 UTC">August 29, 2025</span>
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</aside>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</article>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
|
||||||
|
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
|
||||||
|
Back to top
|
||||||
|
</button>
|
||||||
|
|
||||||
|
</main>
|
||||||
|
|
||||||
|
<footer class="md-footer">
|
||||||
|
|
||||||
|
<div class="md-footer-meta md-typeset">
|
||||||
|
<div class="md-footer-meta__inner md-grid">
|
||||||
|
<div class="md-copyright">
|
||||||
|
|
||||||
|
<div class="md-copyright__highlight">
|
||||||
|
Copyright © 2025 Dominik Willner
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
Made with
|
||||||
|
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
|
||||||
|
Material for MkDocs
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="md-social">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a href="https://github.com/dw-0" target="_blank" rel="noopener" title="github.com" class="md-social__link">
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12"/></svg>
|
||||||
|
</a>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a href="https://ko-fi.com/dw__0" target="_blank" rel="noopener" title="ko-fi.com" class="md-social__link">
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M11.351 2.715c-2.7 0-4.986.025-6.83.26C2.078 3.285 0 5.154 0 8.61c0 3.506.182 6.13 1.585 8.493 1.584 2.701 4.233 4.182 7.662 4.182h.83c4.209 0 6.494-2.234 7.637-4a9.5 9.5 0 0 0 1.091-2.338C21.792 14.688 24 12.22 24 9.208v-.415c0-3.247-2.13-5.507-5.792-5.87-1.558-.156-2.65-.208-6.857-.208m0 1.947c4.208 0 5.09.052 6.571.182 2.624.311 4.13 1.584 4.13 4v.39c0 2.156-1.792 3.844-3.87 3.844h-.935l-.156.649c-.208 1.013-.597 1.818-1.039 2.546-.909 1.428-2.545 3.064-5.922 3.064h-.805c-2.571 0-4.831-.883-6.078-3.195-1.09-2-1.298-4.155-1.298-7.506 0-2.181.857-3.402 3.012-3.714 1.533-.233 3.559-.26 6.39-.26m6.547 2.287c-.416 0-.65.234-.65.546v2.935c0 .311.234.545.65.545 1.324 0 2.051-.754 2.051-2s-.727-2.026-2.052-2.026m-10.39.182c-1.818 0-3.013 1.48-3.013 3.142 0 1.533.858 2.857 1.949 3.897.727.701 1.87 1.429 2.649 1.896a1.47 1.47 0 0 0 1.507 0c.78-.467 1.922-1.195 2.623-1.896 1.117-1.039 1.974-2.364 1.974-3.897 0-1.662-1.247-3.142-3.039-3.142-1.065 0-1.792.545-2.338 1.298-.493-.753-1.246-1.298-2.312-1.298"/></svg>
|
||||||
|
</a>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a href="https://www.paypal.com/paypalme/dwillner0" target="_blank" rel="noopener" title="www.paypal.com" class="md-social__link">
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M15.607 4.653H8.941L6.645 19.251H1.82L4.862 0h7.995c3.754 0 6.375 2.294 6.473 5.513-.648-.478-2.105-.86-3.722-.86m6.57 5.546c0 3.41-3.01 6.853-6.958 6.853h-2.493L11.595 24H6.74l1.845-11.538h3.592c4.208 0 7.346-3.634 7.153-6.949a5.24 5.24 0 0 1 2.848 4.686M9.653 5.546h6.408c.907 0 1.942.222 2.363.541-.195 2.741-2.655 5.483-6.441 5.483H8.714Z"/></svg>
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</footer>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<div class="md-dialog" data-md-component="dialog">
|
||||||
|
<div class="md-dialog__inner md-typeset"></div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script id="__config" type="application/json">{"base": ".", "features": ["navigation.instant", "navigation.tracking", "navigation.sections", "navigation.expand", "navigation.indexes", "navigation.top", "toc.follow", "content.code.copy"], "search": "assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
|
||||||
|
|
||||||
|
|
||||||
|
<script src="assets/javascripts/bundle.92b07e13.min.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
@@ -1,71 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
|
|
||||||
#=======================================================================#
|
|
||||||
# Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com> #
|
|
||||||
# #
|
|
||||||
# This file is part of KIAUH - Klipper Installation And Update Helper #
|
|
||||||
# https://github.com/dw-0/kiauh #
|
|
||||||
# #
|
|
||||||
# This file may be distributed under the terms of the GNU GPLv3 license #
|
|
||||||
#=======================================================================#
|
|
||||||
|
|
||||||
set -e
|
|
||||||
clear -x
|
|
||||||
|
|
||||||
# make sure we have the correct permissions while running the script
|
|
||||||
umask 022
|
|
||||||
|
|
||||||
### sourcing all additional scripts
|
|
||||||
KIAUH_SRCDIR="$(dirname -- "$(readlink -f "${BASH_SOURCE[0]}")")"
|
|
||||||
for script in "${KIAUH_SRCDIR}/scripts/"*.sh; do . "${script}"; done
|
|
||||||
for script in "${KIAUH_SRCDIR}/scripts/ui/"*.sh; do . "${script}"; done
|
|
||||||
|
|
||||||
#===================================================#
|
|
||||||
#=================== UPDATE KIAUH ==================#
|
|
||||||
#===================================================#
|
|
||||||
|
|
||||||
function update_kiauh() {
|
|
||||||
status_msg "Updating KIAUH ..."
|
|
||||||
|
|
||||||
cd "${KIAUH_SRCDIR}"
|
|
||||||
git reset --hard && git pull
|
|
||||||
|
|
||||||
ok_msg "Update complete! Please restart KIAUH."
|
|
||||||
exit 0
|
|
||||||
}
|
|
||||||
|
|
||||||
#===================================================#
|
|
||||||
#=================== KIAUH STATUS ==================#
|
|
||||||
#===================================================#
|
|
||||||
|
|
||||||
function kiauh_update_avail() {
|
|
||||||
[[ ! -d "${KIAUH_SRCDIR}/.git" ]] && return
|
|
||||||
local origin head
|
|
||||||
|
|
||||||
cd "${KIAUH_SRCDIR}"
|
|
||||||
|
|
||||||
### abort if not on master branch
|
|
||||||
! git branch -a | grep -q "\* master" && return
|
|
||||||
|
|
||||||
### compare commit hash
|
|
||||||
git fetch -q
|
|
||||||
origin=$(git rev-parse --short=8 origin/master)
|
|
||||||
head=$(git rev-parse --short=8 HEAD)
|
|
||||||
|
|
||||||
if [[ ${origin} != "${head}" ]]; then
|
|
||||||
echo "true"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
function main() {
|
|
||||||
read_kiauh_ini "${FUNCNAME[0]}"
|
|
||||||
main_menu
|
|
||||||
}
|
|
||||||
|
|
||||||
check_if_ratos
|
|
||||||
check_euid
|
|
||||||
init_logfile
|
|
||||||
set_globals
|
|
||||||
read_kiauh_ini
|
|
||||||
init_ini
|
|
||||||
main
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
# This file acts as an example file.
|
|
||||||
#
|
|
||||||
# 1) Make a copy of this file and rename it to 'klipper_repos.txt'
|
|
||||||
# 2) Add your custom Klipper repository to the bottom of that copy
|
|
||||||
# 3) Save the file
|
|
||||||
#
|
|
||||||
# Back in KIAUH you can now go into -> [Settings] and use action '2' to set a different Klipper repository
|
|
||||||
#
|
|
||||||
# Make sure to always separate the repository and the branch with a ','.
|
|
||||||
# <repository>,<branch> -> https://github.com/Klipper3d/klipper,master
|
|
||||||
# If you omit a branch, it will always default to 'master'
|
|
||||||
#
|
|
||||||
# You are allowed to omit the 'https://github.com/' part of the repository URL
|
|
||||||
# Down below are now a few examples of what is considered as valid:
|
|
||||||
https://github.com/Klipper3d/klipper,master
|
|
||||||
https://github.com/Klipper3d/klipper
|
|
||||||
Klipper3d/klipper,master
|
|
||||||
Klipper3d/klipper
|
|
||||||
BIN
Binary file not shown.
@@ -1,65 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
|
|
||||||
#####################################################################
|
|
||||||
### Please set the paths accordingly. In case you don't have all ###
|
|
||||||
### the listed folders, just keep that line commented out. ###
|
|
||||||
#####################################################################
|
|
||||||
### Path to your config folder you want to back up
|
|
||||||
#config_folder=~/klipper_config
|
|
||||||
|
|
||||||
### Path to your Klipper folder, by default that is '~/klipper'
|
|
||||||
#klipper_folder=~/klipper
|
|
||||||
|
|
||||||
### Path to your Moonraker folder, by default that is '~/moonraker'
|
|
||||||
#moonraker_folder=~/moonraker
|
|
||||||
|
|
||||||
### Path to your Mainsail folder, by default that is '~/mainsail'
|
|
||||||
#mainsail_folder=~/mainsail
|
|
||||||
|
|
||||||
### Path to your Fluidd folder, by default that is '~/fluidd'
|
|
||||||
#fluidd_folder=~/fluidd
|
|
||||||
|
|
||||||
#####################################################################
|
|
||||||
#####################################################################
|
|
||||||
|
|
||||||
|
|
||||||
#####################################################################
|
|
||||||
################ !!! DO NOT EDIT BELOW THIS LINE !!! ################
|
|
||||||
#####################################################################
|
|
||||||
grab_version() {
|
|
||||||
local klipper_commit moonraker_commit
|
|
||||||
local mainsail_ver fluidd_ver
|
|
||||||
|
|
||||||
if [[ -n ${klipper_folder} ]]; then
|
|
||||||
cd "${klipper_folder}"
|
|
||||||
klipper_commit=$(git rev-parse --short=7 HEAD)
|
|
||||||
m1="Klipper on commit: ${klipper_commit}"
|
|
||||||
fi
|
|
||||||
if [[ -n ${moonraker_folder} ]]; then
|
|
||||||
cd "${moonraker_folder}"
|
|
||||||
moonraker_commit=$(git rev-parse --short=7 HEAD)
|
|
||||||
m2="Moonraker on commit: ${moonraker_commit}"
|
|
||||||
fi
|
|
||||||
if [[ -n ${mainsail_folder} ]]; then
|
|
||||||
mainsail_ver=$(head -n 1 "${mainsail_folder}/.version")
|
|
||||||
m3="Mainsail version: ${mainsail_ver}"
|
|
||||||
fi
|
|
||||||
if [[ -n ${fluidd_folder} ]]; then
|
|
||||||
fluidd_ver=$(head -n 1 "${fluidd_folder}/.version")
|
|
||||||
m4="Fluidd version: ${fluidd_ver}"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
push_config() {
|
|
||||||
local current_date
|
|
||||||
|
|
||||||
cd "${config_folder}" || exit 1
|
|
||||||
git pull
|
|
||||||
git add .
|
|
||||||
current_date=$(date +"%Y-%m-%d %T")
|
|
||||||
git commit -m "Autocommit from ${current_date}" -m "${m1}" -m "${m2}" -m "${m3}" -m "${m4}"
|
|
||||||
git push
|
|
||||||
}
|
|
||||||
|
|
||||||
grab_version
|
|
||||||
push_config
|
|
||||||
@@ -1,6 +0,0 @@
|
|||||||
# /etc/nginx/conf.d/common_vars.conf
|
|
||||||
|
|
||||||
map $http_upgrade $connection_upgrade {
|
|
||||||
default upgrade;
|
|
||||||
'' close;
|
|
||||||
}
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
[mcu]
|
|
||||||
serial: /dev/serial/by-id/<your-mcu-id>
|
|
||||||
|
|
||||||
[virtual_sdcard]
|
|
||||||
path: %GCODES_DIR%
|
|
||||||
on_error_gcode: CANCEL_PRINT
|
|
||||||
|
|
||||||
[printer]
|
|
||||||
kinematics: none
|
|
||||||
max_velocity: 1000
|
|
||||||
max_accel: 1000
|
|
||||||
@@ -1,96 +0,0 @@
|
|||||||
# /etc/nginx/sites-available/fluidd
|
|
||||||
|
|
||||||
server {
|
|
||||||
listen 80;
|
|
||||||
|
|
||||||
access_log /var/log/nginx/fluidd-access.log;
|
|
||||||
error_log /var/log/nginx/fluidd-error.log;
|
|
||||||
|
|
||||||
# disable this section on smaller hardware like a pi zero
|
|
||||||
gzip on;
|
|
||||||
gzip_vary on;
|
|
||||||
gzip_proxied any;
|
|
||||||
gzip_proxied expired no-cache no-store private auth;
|
|
||||||
gzip_comp_level 4;
|
|
||||||
gzip_buffers 16 8k;
|
|
||||||
gzip_http_version 1.1;
|
|
||||||
gzip_types text/plain text/css text/xml text/javascript application/javascript application/x-javascript application/json application/xml;
|
|
||||||
|
|
||||||
# web_path from fluidd static files
|
|
||||||
root /home/pi/fluidd;
|
|
||||||
|
|
||||||
index index.html;
|
|
||||||
server_name _;
|
|
||||||
|
|
||||||
# disable max upload size checks
|
|
||||||
client_max_body_size 0;
|
|
||||||
|
|
||||||
# disable proxy request buffering
|
|
||||||
proxy_request_buffering off;
|
|
||||||
|
|
||||||
location / {
|
|
||||||
try_files $uri $uri/ /index.html;
|
|
||||||
}
|
|
||||||
|
|
||||||
location = /index.html {
|
|
||||||
add_header Cache-Control "no-store, no-cache, must-revalidate";
|
|
||||||
}
|
|
||||||
|
|
||||||
location /websocket {
|
|
||||||
proxy_pass http://apiserver/websocket;
|
|
||||||
proxy_http_version 1.1;
|
|
||||||
proxy_set_header Upgrade $http_upgrade;
|
|
||||||
proxy_set_header Connection $connection_upgrade;
|
|
||||||
proxy_set_header Host $http_host;
|
|
||||||
proxy_set_header X-Real-IP $remote_addr;
|
|
||||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
|
||||||
proxy_read_timeout 86400;
|
|
||||||
}
|
|
||||||
|
|
||||||
location ~ ^/(printer|api|access|machine|server)/ {
|
|
||||||
proxy_pass http://apiserver$request_uri;
|
|
||||||
proxy_http_version 1.1;
|
|
||||||
proxy_set_header Upgrade $http_upgrade;
|
|
||||||
proxy_set_header Host $http_host;
|
|
||||||
proxy_set_header X-Real-IP $remote_addr;
|
|
||||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
|
||||||
proxy_set_header X-Scheme $scheme;
|
|
||||||
proxy_read_timeout 600;
|
|
||||||
}
|
|
||||||
|
|
||||||
location /webcam/ {
|
|
||||||
postpone_output 0;
|
|
||||||
proxy_buffering off;
|
|
||||||
proxy_ignore_headers X-Accel-Buffering;
|
|
||||||
access_log off;
|
|
||||||
error_log off;
|
|
||||||
proxy_pass http://mjpgstreamer1/;
|
|
||||||
}
|
|
||||||
|
|
||||||
location /webcam2/ {
|
|
||||||
postpone_output 0;
|
|
||||||
proxy_buffering off;
|
|
||||||
proxy_ignore_headers X-Accel-Buffering;
|
|
||||||
access_log off;
|
|
||||||
error_log off;
|
|
||||||
proxy_pass http://mjpgstreamer2/;
|
|
||||||
}
|
|
||||||
|
|
||||||
location /webcam3/ {
|
|
||||||
postpone_output 0;
|
|
||||||
proxy_buffering off;
|
|
||||||
proxy_ignore_headers X-Accel-Buffering;
|
|
||||||
access_log off;
|
|
||||||
error_log off;
|
|
||||||
proxy_pass http://mjpgstreamer3/;
|
|
||||||
}
|
|
||||||
|
|
||||||
location /webcam4/ {
|
|
||||||
postpone_output 0;
|
|
||||||
proxy_buffering off;
|
|
||||||
proxy_ignore_headers X-Accel-Buffering;
|
|
||||||
access_log off;
|
|
||||||
error_log off;
|
|
||||||
proxy_pass http://mjpgstreamer4/;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,94 +0,0 @@
|
|||||||
# Run a shell command via gcode
|
|
||||||
#
|
|
||||||
# Copyright (C) 2019 Eric Callahan <arksine.code@gmail.com>
|
|
||||||
#
|
|
||||||
# This file may be distributed under the terms of the GNU GPLv3 license.
|
|
||||||
import os
|
|
||||||
import shlex
|
|
||||||
import subprocess
|
|
||||||
import logging
|
|
||||||
|
|
||||||
|
|
||||||
class ShellCommand:
|
|
||||||
def __init__(self, config):
|
|
||||||
self.name = config.get_name().split()[-1]
|
|
||||||
self.printer = config.get_printer()
|
|
||||||
self.gcode = self.printer.lookup_object("gcode")
|
|
||||||
cmd = config.get("command")
|
|
||||||
cmd = os.path.expanduser(cmd)
|
|
||||||
self.command = shlex.split(cmd)
|
|
||||||
self.timeout = config.getfloat("timeout", 2.0, above=0.0)
|
|
||||||
self.verbose = config.getboolean("verbose", True)
|
|
||||||
self.proc_fd = None
|
|
||||||
self.partial_output = ""
|
|
||||||
self.gcode.register_mux_command(
|
|
||||||
"RUN_SHELL_COMMAND",
|
|
||||||
"CMD",
|
|
||||||
self.name,
|
|
||||||
self.cmd_RUN_SHELL_COMMAND,
|
|
||||||
desc=self.cmd_RUN_SHELL_COMMAND_help,
|
|
||||||
)
|
|
||||||
|
|
||||||
def _process_output(self, eventime):
|
|
||||||
if self.proc_fd is None:
|
|
||||||
return
|
|
||||||
try:
|
|
||||||
data = os.read(self.proc_fd, 4096)
|
|
||||||
except Exception:
|
|
||||||
pass
|
|
||||||
data = self.partial_output + data.decode()
|
|
||||||
if "\n" not in data:
|
|
||||||
self.partial_output = data
|
|
||||||
return
|
|
||||||
elif data[-1] != "\n":
|
|
||||||
split = data.rfind("\n") + 1
|
|
||||||
self.partial_output = data[split:]
|
|
||||||
data = data[:split]
|
|
||||||
else:
|
|
||||||
self.partial_output = ""
|
|
||||||
self.gcode.respond_info(data)
|
|
||||||
|
|
||||||
cmd_RUN_SHELL_COMMAND_help = "Run a linux shell command"
|
|
||||||
|
|
||||||
def cmd_RUN_SHELL_COMMAND(self, params):
|
|
||||||
gcode_params = params.get("PARAMS", "")
|
|
||||||
gcode_params = shlex.split(gcode_params)
|
|
||||||
reactor = self.printer.get_reactor()
|
|
||||||
try:
|
|
||||||
proc = subprocess.Popen(
|
|
||||||
self.command + gcode_params,
|
|
||||||
stdout=subprocess.PIPE,
|
|
||||||
stderr=subprocess.STDOUT,
|
|
||||||
)
|
|
||||||
except Exception:
|
|
||||||
logging.exception("shell_command: Command {%s} failed" % (self.name))
|
|
||||||
raise self.gcode.error("Error running command {%s}" % (self.name))
|
|
||||||
if self.verbose:
|
|
||||||
self.proc_fd = proc.stdout.fileno()
|
|
||||||
self.gcode.respond_info("Running Command {%s}...:" % (self.name))
|
|
||||||
hdl = reactor.register_fd(self.proc_fd, self._process_output)
|
|
||||||
eventtime = reactor.monotonic()
|
|
||||||
endtime = eventtime + self.timeout
|
|
||||||
complete = False
|
|
||||||
while eventtime < endtime:
|
|
||||||
eventtime = reactor.pause(eventtime + 0.05)
|
|
||||||
if proc.poll() is not None:
|
|
||||||
complete = True
|
|
||||||
break
|
|
||||||
if not complete:
|
|
||||||
proc.terminate()
|
|
||||||
if self.verbose:
|
|
||||||
if self.partial_output:
|
|
||||||
self.gcode.respond_info(self.partial_output)
|
|
||||||
self.partial_output = ""
|
|
||||||
if complete:
|
|
||||||
msg = "Command {%s} finished\n" % (self.name)
|
|
||||||
else:
|
|
||||||
msg = "Command {%s} timed out" % (self.name)
|
|
||||||
self.gcode.respond_info(msg)
|
|
||||||
reactor.unregister_fd(hdl)
|
|
||||||
self.proc_fd = None
|
|
||||||
|
|
||||||
|
|
||||||
def load_config_prefix(config):
|
|
||||||
return ShellCommand(config)
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
KLIPPER_ARGS="%KLIPPER_DIR%/klippy/klippy.py %CFG% -I %PRINTER% -l %LOG% -a %UDS%"
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
[Unit]
|
|
||||||
Description=Klipper 3D Printer Firmware SV1
|
|
||||||
Documentation=https://www.klipper3d.org/
|
|
||||||
After=network-online.target
|
|
||||||
Wants=udev.target
|
|
||||||
|
|
||||||
[Install]
|
|
||||||
WantedBy=multi-user.target
|
|
||||||
|
|
||||||
[Service]
|
|
||||||
Type=simple
|
|
||||||
User=%USER%
|
|
||||||
RemainAfterExit=yes
|
|
||||||
WorkingDirectory=%KLIPPER_DIR%
|
|
||||||
EnvironmentFile=%ENV_FILE%
|
|
||||||
ExecStart=%ENV%/bin/python $KLIPPER_ARGS
|
|
||||||
Restart=always
|
|
||||||
RestartSec=10
|
|
||||||
@@ -1,96 +0,0 @@
|
|||||||
# /etc/nginx/sites-available/mainsail
|
|
||||||
|
|
||||||
server {
|
|
||||||
listen 80;
|
|
||||||
|
|
||||||
access_log /var/log/nginx/mainsail-access.log;
|
|
||||||
error_log /var/log/nginx/mainsail-error.log;
|
|
||||||
|
|
||||||
# disable this section on smaller hardware like a pi zero
|
|
||||||
gzip on;
|
|
||||||
gzip_vary on;
|
|
||||||
gzip_proxied any;
|
|
||||||
gzip_proxied expired no-cache no-store private auth;
|
|
||||||
gzip_comp_level 4;
|
|
||||||
gzip_buffers 16 8k;
|
|
||||||
gzip_http_version 1.1;
|
|
||||||
gzip_types text/plain text/css text/xml text/javascript application/javascript application/x-javascript application/json application/xml;
|
|
||||||
|
|
||||||
# web_path from mainsail static files
|
|
||||||
root /home/pi/mainsail;
|
|
||||||
|
|
||||||
index index.html;
|
|
||||||
server_name _;
|
|
||||||
|
|
||||||
# disable max upload size checks
|
|
||||||
client_max_body_size 0;
|
|
||||||
|
|
||||||
# disable proxy request buffering
|
|
||||||
proxy_request_buffering off;
|
|
||||||
|
|
||||||
location / {
|
|
||||||
try_files $uri $uri/ /index.html;
|
|
||||||
}
|
|
||||||
|
|
||||||
location = /index.html {
|
|
||||||
add_header Cache-Control "no-store, no-cache, must-revalidate";
|
|
||||||
}
|
|
||||||
|
|
||||||
location /websocket {
|
|
||||||
proxy_pass http://apiserver/websocket;
|
|
||||||
proxy_http_version 1.1;
|
|
||||||
proxy_set_header Upgrade $http_upgrade;
|
|
||||||
proxy_set_header Connection $connection_upgrade;
|
|
||||||
proxy_set_header Host $http_host;
|
|
||||||
proxy_set_header X-Real-IP $remote_addr;
|
|
||||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
|
||||||
proxy_read_timeout 86400;
|
|
||||||
}
|
|
||||||
|
|
||||||
location ~ ^/(printer|api|access|machine|server)/ {
|
|
||||||
proxy_pass http://apiserver$request_uri;
|
|
||||||
proxy_http_version 1.1;
|
|
||||||
proxy_set_header Upgrade $http_upgrade;
|
|
||||||
proxy_set_header Host $http_host;
|
|
||||||
proxy_set_header X-Real-IP $remote_addr;
|
|
||||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
|
||||||
proxy_set_header X-Scheme $scheme;
|
|
||||||
proxy_read_timeout 600;
|
|
||||||
}
|
|
||||||
|
|
||||||
location /webcam/ {
|
|
||||||
postpone_output 0;
|
|
||||||
proxy_buffering off;
|
|
||||||
proxy_ignore_headers X-Accel-Buffering;
|
|
||||||
access_log off;
|
|
||||||
error_log off;
|
|
||||||
proxy_pass http://mjpgstreamer1/;
|
|
||||||
}
|
|
||||||
|
|
||||||
location /webcam2/ {
|
|
||||||
postpone_output 0;
|
|
||||||
proxy_buffering off;
|
|
||||||
proxy_ignore_headers X-Accel-Buffering;
|
|
||||||
access_log off;
|
|
||||||
error_log off;
|
|
||||||
proxy_pass http://mjpgstreamer2/;
|
|
||||||
}
|
|
||||||
|
|
||||||
location /webcam3/ {
|
|
||||||
postpone_output 0;
|
|
||||||
proxy_buffering off;
|
|
||||||
proxy_ignore_headers X-Accel-Buffering;
|
|
||||||
access_log off;
|
|
||||||
error_log off;
|
|
||||||
proxy_pass http://mjpgstreamer3/;
|
|
||||||
}
|
|
||||||
|
|
||||||
location /webcam4/ {
|
|
||||||
postpone_output 0;
|
|
||||||
proxy_buffering off;
|
|
||||||
proxy_ignore_headers X-Accel-Buffering;
|
|
||||||
access_log off;
|
|
||||||
error_log off;
|
|
||||||
proxy_pass http://mjpgstreamer4/;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,79 +0,0 @@
|
|||||||
### Windows users: To edit this file use Notepad++, VSCode, Atom or SublimeText.
|
|
||||||
### Do not use Notepad or WordPad.
|
|
||||||
|
|
||||||
### MacOSX users: If you use Textedit to edit this file make sure to use
|
|
||||||
### "plain text format" and "disable smart quotes" in "Textedit > Preferences"
|
|
||||||
|
|
||||||
### Configure which camera to use
|
|
||||||
#
|
|
||||||
# Available options are:
|
|
||||||
# - auto: tries first usb webcam, if that's not available tries raspi cam
|
|
||||||
# - usb: only tries usb webcam
|
|
||||||
# - raspi: only tries raspi cam
|
|
||||||
#
|
|
||||||
# Defaults to auto
|
|
||||||
#
|
|
||||||
#camera="auto"
|
|
||||||
|
|
||||||
### Additional options to supply to MJPG Streamer for the USB camera
|
|
||||||
#
|
|
||||||
# See https://faq.octoprint.org/mjpg-streamer-config for available options
|
|
||||||
#
|
|
||||||
# Defaults to a resolution of 640x480 px and a framerate of 10 fps
|
|
||||||
#
|
|
||||||
#camera_usb_options="-r 640x480 -f 10"
|
|
||||||
|
|
||||||
### Additional webcam devices known to cause problems with -f
|
|
||||||
#
|
|
||||||
# Apparently there a some devices out there that with the current
|
|
||||||
# mjpg_streamer release do not support the -f parameter (for specifying
|
|
||||||
# the capturing framerate) and will just refuse to output an image if it
|
|
||||||
# is supplied.
|
|
||||||
#
|
|
||||||
# The webcam daemon will detect those devices by their USB Vendor and Product
|
|
||||||
# ID and remove the -f parameter from the options provided to mjpg_streamer.
|
|
||||||
#
|
|
||||||
# By default, this is done for the following devices:
|
|
||||||
# Logitech C170 (046d:082b)
|
|
||||||
# GEMBIRD (1908:2310)
|
|
||||||
# Genius F100 (0458:708c)
|
|
||||||
# Cubeternet GL-UPC822 UVC WebCam (1e4e:0102)
|
|
||||||
#
|
|
||||||
# Using the following option it is possible to add additional devices. If
|
|
||||||
# your webcam happens to show above symptoms, try determining your cam's
|
|
||||||
# vendor and product id via lsusb, activating the line below by removing # and
|
|
||||||
# adding it, e.g. for two broken cameras "aabb:ccdd" and "aabb:eeff"
|
|
||||||
#
|
|
||||||
# additional_brokenfps_usb_devices=("aabb:ccdd" "aabb:eeff")
|
|
||||||
#
|
|
||||||
#
|
|
||||||
#additional_brokenfps_usb_devices=()
|
|
||||||
|
|
||||||
### Additional options to supply to MJPG Streamer for the RasPi Cam
|
|
||||||
#
|
|
||||||
# See https://faq.octoprint.org/mjpg-streamer-config for available options
|
|
||||||
#
|
|
||||||
# Defaults to 10fps
|
|
||||||
#
|
|
||||||
#camera_raspi_options="-fps 10"
|
|
||||||
|
|
||||||
### Configuration of camera HTTP output
|
|
||||||
#
|
|
||||||
# Usually you should NOT need to change this at all! Only touch if you
|
|
||||||
# know what you are doing and what the parameters mean.
|
|
||||||
#
|
|
||||||
# Below settings are used in the mjpg-streamer call like this:
|
|
||||||
#
|
|
||||||
# -o "output_http.so -w $camera_http_webroot $camera_http_options"
|
|
||||||
#
|
|
||||||
# Current working directory is the mjpg-streamer base directory.
|
|
||||||
#
|
|
||||||
#camera_http_webroot="./www-mainsail"
|
|
||||||
#camera_http_options="-n"
|
|
||||||
|
|
||||||
### EXPERIMENTAL
|
|
||||||
# Support for different streamer types.
|
|
||||||
#
|
|
||||||
# Available options:
|
|
||||||
# mjpeg [default] - stable MJPG-streamer
|
|
||||||
#camera_streamer=mjpeg
|
|
||||||
@@ -1,303 +0,0 @@
|
|||||||
#!/bin/bash
|
|
||||||
|
|
||||||
########################################################################
|
|
||||||
### DO NOT EDIT THIS FILE TO CHANGE THE CONFIG!!! ###
|
|
||||||
### ---------------------------------------------------------------- ###
|
|
||||||
### There is no need to edit this file for changing resolution, ###
|
|
||||||
### frame rates or any other mjpg-streamer parameters. Please edit ###
|
|
||||||
### /home/pi/klipper_config/webcam.txt instead - that's what it's ###
|
|
||||||
### there for! You can even do this with your Pi powered down by ###
|
|
||||||
### directly accessing the file when using the SD card as thumb ###
|
|
||||||
### drive in your regular computer. ###
|
|
||||||
########################################################################
|
|
||||||
|
|
||||||
MJPGSTREAMER_HOME=/home/pi/mjpg-streamer
|
|
||||||
MJPGSTREAMER_INPUT_USB="input_uvc.so"
|
|
||||||
MJPGSTREAMER_INPUT_RASPICAM="input_raspicam.so"
|
|
||||||
|
|
||||||
brokenfps_usb_devices=("046d:082b" "1908:2310" "0458:708c" "1e4e:0102" "0471:0311" "038f:6001" "046d:0804" "046d:0825" "046d:0994" "0ac8:3450")
|
|
||||||
|
|
||||||
config_dir="/home/pi/klipper_config"
|
|
||||||
|
|
||||||
echo "Starting up webcamDaemon..."
|
|
||||||
echo ""
|
|
||||||
|
|
||||||
cfg_files=()
|
|
||||||
#cfg_files+=/boot/mainsail.txt
|
|
||||||
if [[ -d ${config_dir} ]]; then
|
|
||||||
cfg_files+=( `ls ${config_dir}/webcam*.txt` )
|
|
||||||
fi
|
|
||||||
|
|
||||||
array_camera_config=()
|
|
||||||
array_camera=()
|
|
||||||
array_camera_usb_options=()
|
|
||||||
array_camera_usb_device=()
|
|
||||||
array_camera_raspi_options=()
|
|
||||||
array_camera_http_webroot=()
|
|
||||||
array_camera_http_options=()
|
|
||||||
array_additional_brokenfps_usb_devices=()
|
|
||||||
array_camera_device=()
|
|
||||||
array_assigned_device=()
|
|
||||||
|
|
||||||
echo "--- Configuration: ----------------------------"
|
|
||||||
for cfg_file in ${cfg_files[@]}; do
|
|
||||||
# init configuration - DO NOT EDIT, USE /home/pi/klipper_config/webcam*.txt INSTEAD!
|
|
||||||
camera="auto"
|
|
||||||
camera_usb_options="-r 640x480 -f 10"
|
|
||||||
camera_raspi_options="-fps 10"
|
|
||||||
camera_http_webroot="./www-mjpgstreamer"
|
|
||||||
camera_http_options="-n"
|
|
||||||
additional_brokenfps_usb_devices=()
|
|
||||||
|
|
||||||
if [[ -e ${cfg_file} ]]; then
|
|
||||||
source "$cfg_file"
|
|
||||||
fi
|
|
||||||
usb_options="$camera_usb_options"
|
|
||||||
|
|
||||||
# if webcam device is explicitly given in /home/pi/klipper_config/webcam*.txt, save the path of the device
|
|
||||||
# to a variable and remove its parameter from usb_options
|
|
||||||
extracted_device=`echo $usb_options | sed 's@.*-d \(/dev/\(video[0-9]\+\|v4l/[^ ]*\)\).*@\1@'`
|
|
||||||
if [ "$extracted_device" != "$usb_options" ]
|
|
||||||
then
|
|
||||||
# the camera options refer to a device, save it in a variable
|
|
||||||
# replace video device parameter with empty string and strip extra whitespace
|
|
||||||
usb_options=`echo $usb_options | sed 's/\-d \/dev\/\(video[0-9]\+\|v4l\/[^ ]*\)//g' | awk '$1=$1'`
|
|
||||||
else
|
|
||||||
extracted_device=""
|
|
||||||
fi
|
|
||||||
|
|
||||||
# echo configuration
|
|
||||||
echo "cfg_file: $cfg_file"
|
|
||||||
echo "camera: $camera"
|
|
||||||
echo "usb options: $camera_usb_options"
|
|
||||||
echo "raspi options: $camera_raspi_options"
|
|
||||||
echo "http options: -w $camera_http_webroot $camera_http_options"
|
|
||||||
echo ""
|
|
||||||
echo "Explicitly USB device: $extracted_device"
|
|
||||||
echo "-----------------------------------------------"
|
|
||||||
echo ""
|
|
||||||
|
|
||||||
array_camera_config+=( $cfg_file )
|
|
||||||
array_camera+=( $camera )
|
|
||||||
array_camera_usb_options+=("$usb_options")
|
|
||||||
array_camera_usb_device+=("$extracted_device")
|
|
||||||
array_camera_raspi_options+=("$camera_raspi_options")
|
|
||||||
array_camera_http_webroot+=("$camera_http_webroot")
|
|
||||||
array_camera_http_options+=("$camera_http_options")
|
|
||||||
array_camera_brokenfps_usb_devices+=("${brokenfps_usb_devices[*]} ${additional_brokenfps_usb_devices[*]}")
|
|
||||||
array_camera_device+=("")
|
|
||||||
done
|
|
||||||
|
|
||||||
# check if array contains a string
|
|
||||||
function containsString() {
|
|
||||||
local e match="$1"
|
|
||||||
shift
|
|
||||||
for e; do [[ "$e" == "$match" ]] && return 0; done
|
|
||||||
return 1
|
|
||||||
}
|
|
||||||
|
|
||||||
# cleans up when the script receives a SIGINT or SIGTERM
|
|
||||||
function cleanup() {
|
|
||||||
# make sure that all child processed die when we die
|
|
||||||
local pids=$(jobs -pr)
|
|
||||||
[ -n "$pids" ] && kill $pids
|
|
||||||
exit 0
|
|
||||||
}
|
|
||||||
|
|
||||||
# says goodbye when the script shuts down
|
|
||||||
function goodbye() {
|
|
||||||
# say goodbye
|
|
||||||
echo ""
|
|
||||||
echo "Goodbye..."
|
|
||||||
echo ""
|
|
||||||
}
|
|
||||||
|
|
||||||
# runs MJPG Streamer, using the provided input plugin + configuration
|
|
||||||
function runMjpgStreamer {
|
|
||||||
input=$1
|
|
||||||
|
|
||||||
# There are problems with 0x000137ab firmware on VL805 (Raspberry Pi 4}).
|
|
||||||
# Try to autodetect offending firmware and temporarily fix the issue
|
|
||||||
# by changing power management mode
|
|
||||||
echo "Checking for VL805 (Raspberry Pi 4)..."
|
|
||||||
if [[ -f /usr/bin/vl805 ]]; then
|
|
||||||
VL805_VERSION=$(/usr/bin/vl805)
|
|
||||||
VL805_VERSION=${VL805_VERSION#*: }
|
|
||||||
echo " - version 0x${VL805_VERSION} detected"
|
|
||||||
case "$VL805_VERSION" in
|
|
||||||
00013701)
|
|
||||||
echo " - nothing to be done. It shouldn't cause USB problems."
|
|
||||||
;;
|
|
||||||
000137ab)
|
|
||||||
echo -e " - \e[31mThis version is known to cause problems with USB cameras.\e[39m"
|
|
||||||
echo -e " You may want to downgrade to 0x0013701."
|
|
||||||
echo -e " - [FIXING] Trying the setpci -s 01:00.0 0xD4.B=0x41 hack to mitigate the"
|
|
||||||
echo -e " issue. It disables ASPM L1 on the VL805. Your board may (or may not) get"
|
|
||||||
echo -e " slightly hotter. For details see:"
|
|
||||||
echo -e " https://www.raspberrypi.org/forums/viewtopic.php?f=28&t=244421"
|
|
||||||
setpci -s 01:00.0 0xD4.B=0x41
|
|
||||||
;;
|
|
||||||
*)
|
|
||||||
echo " - unknown firmware version. Doing nothing."
|
|
||||||
;;
|
|
||||||
esac
|
|
||||||
else
|
|
||||||
echo " - It seems that you don't have VL805 (Raspberry Pi 4)."
|
|
||||||
echo " There should be no problems with USB (a.k.a. select() timeout)"
|
|
||||||
fi
|
|
||||||
|
|
||||||
pushd $MJPGSTREAMER_HOME > /dev/null 2>&1
|
|
||||||
echo Running ./mjpg_streamer -o "output_http.so -w $camera_http_webroot $camera_http_options" -i "$input"
|
|
||||||
LD_LIBRARY_PATH=. ./mjpg_streamer -o "output_http.so -w $camera_http_webroot $camera_http_options" -i "$input" &
|
|
||||||
sleep 1 &
|
|
||||||
sleep_pid=$!
|
|
||||||
wait ${sleep_pid}
|
|
||||||
popd > /dev/null 2>&1
|
|
||||||
}
|
|
||||||
|
|
||||||
# starts up the RasPiCam
|
|
||||||
function startRaspi {
|
|
||||||
logger -s "Starting Raspberry Pi camera"
|
|
||||||
runMjpgStreamer "$MJPGSTREAMER_INPUT_RASPICAM $camera_raspi_options"
|
|
||||||
}
|
|
||||||
|
|
||||||
# starts up the USB webcam
|
|
||||||
function startUsb {
|
|
||||||
options="$usb_options"
|
|
||||||
device="video0"
|
|
||||||
|
|
||||||
# check for parameter and set the device if it is given as a parameter
|
|
||||||
input=$1
|
|
||||||
if [[ -n $input ]]; then
|
|
||||||
device=`basename "$input"`
|
|
||||||
fi
|
|
||||||
|
|
||||||
# add video device into options
|
|
||||||
options="$options -d /dev/$device"
|
|
||||||
|
|
||||||
uevent_file="/sys/class/video4linux/$device/device/uevent"
|
|
||||||
if [ -e $uevent_file ]; then
|
|
||||||
# let's see what kind of webcam we have here, fetch vid and pid...
|
|
||||||
product=`cat $uevent_file | grep PRODUCT | cut -d"=" -f2`
|
|
||||||
vid=`echo $product | cut -d"/" -f1`
|
|
||||||
pid=`echo $product | cut -d"/" -f2`
|
|
||||||
vidpid=`printf "%04x:%04x" "0x$vid" "0x$pid"`
|
|
||||||
|
|
||||||
# ... then look if it is in our list of known broken-fps-devices and if so remove
|
|
||||||
# the -f parameter from the options (if it's in there, else that's just a no-op)
|
|
||||||
for identifier in ${brokenfps_usb_devices[@]};
|
|
||||||
do
|
|
||||||
if [ "$vidpid" = "$identifier" ]; then
|
|
||||||
echo
|
|
||||||
echo "Camera model $vidpid is known to not work with -f parameter, stripping it out"
|
|
||||||
echo
|
|
||||||
options=`echo $options | sed -e "s/\(\s\+\|^\)-f\s\+[0-9]\+//g"`
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
fi
|
|
||||||
|
|
||||||
logger -s "Starting USB webcam"
|
|
||||||
runMjpgStreamer "$MJPGSTREAMER_INPUT_USB $options"
|
|
||||||
}
|
|
||||||
|
|
||||||
# make sure our cleanup function gets called when we receive SIGINT, SIGTERM
|
|
||||||
trap "cleanup" SIGINT SIGTERM
|
|
||||||
# say goodbye when we EXIT
|
|
||||||
trap "goodbye" EXIT
|
|
||||||
|
|
||||||
# we need this to prevent the later calls to vcgencmd from blocking
|
|
||||||
# I have no idea why, but that's how it is...
|
|
||||||
vcgencmd version > /dev/null 2>&1
|
|
||||||
|
|
||||||
# keep mjpg streamer running if some camera is attached
|
|
||||||
while true; do
|
|
||||||
|
|
||||||
# get list of usb video devices into an array
|
|
||||||
video_devices=($(find /dev -regextype sed -regex '\/dev/video[0-9]\+' | sort -nk1.11 2> /dev/null))
|
|
||||||
|
|
||||||
# add list of raspi camera into an array
|
|
||||||
if [ "`vcgencmd get_camera`" = "supported=1 detected=1" ]; then
|
|
||||||
video_devices+=( "raspi" )
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo "Found video devices:"
|
|
||||||
printf '%s\n' "${video_devices[@]}"
|
|
||||||
|
|
||||||
for scan_mode in "usb" "usb-auto" "raspi" "auto"; do
|
|
||||||
camera=$scan_mode
|
|
||||||
if [[ "usb-auto" == "$scan_mode" ]]; then
|
|
||||||
camera="usb"
|
|
||||||
fi
|
|
||||||
for ((i=0;i<${#array_camera[@]};i++)); do
|
|
||||||
if [[ -z ${array_camera_device[${i}]} ]] && [[ $camera == ${array_camera[${i}]} ]]; then
|
|
||||||
camera_config="${array_camera_config[${i}]}"
|
|
||||||
usb_options="${array_camera_usb_options[${i}]}"
|
|
||||||
camera_usb_device="${array_camera_usb_device[${i}]}"
|
|
||||||
camera_raspi_options="${array_camera_raspi_options[${i}]}"
|
|
||||||
camera_http_webroot="${array_camera_http_webroot[${i}]}"
|
|
||||||
camera_http_options="${array_camera_http_options[${i}]}"
|
|
||||||
brokenfps_usb_devices="${array_camera_brokenfps_usb_devices[${i}]}"
|
|
||||||
if [[ ${camera_usb_device} ]] && { [[ "usb" == ${scan_mode} ]] || [[ "auto" == ${scan_mode} ]]; }; then
|
|
||||||
# usb device is explicitly set in options
|
|
||||||
usb_device_path=`readlink -f ${camera_usb_device}`
|
|
||||||
if containsString "$usb_device_path" "${array_camera_device[@]}"; then
|
|
||||||
if [[ "auto" != ${scan_mode} ]]; then
|
|
||||||
array_camera_device[${i}]="alredy_in_use"
|
|
||||||
echo "config file='$camera_config':Video device already in use."
|
|
||||||
continue
|
|
||||||
fi
|
|
||||||
elif containsString "$usb_device_path" "${video_devices[@]}"; then
|
|
||||||
array_camera_device[${i}]="$usb_device_path"
|
|
||||||
# explicitly set usb device was found in video_devices array, start usb with the found device
|
|
||||||
echo "config file='$camera_config':USB device was set in options and found in devices, start MJPG-streamer with the configured USB video device: $usb_device_path"
|
|
||||||
startUsb "$usb_device_path"
|
|
||||||
continue
|
|
||||||
fi
|
|
||||||
elif [[ -z ${camera_usb_device} ]] && { [[ "usb-auto" == ${scan_mode} ]] || [[ "auto" == ${scan_mode} ]]; }; then
|
|
||||||
for video_device in "${video_devices[@]}"; do
|
|
||||||
if [[ "raspi" != "$video_device" ]]; then
|
|
||||||
if containsString "$video_device" "${array_camera_device[@]}"; then
|
|
||||||
: #already in use
|
|
||||||
else
|
|
||||||
array_camera_device[${i}]="$video_device"
|
|
||||||
# device is not set explicitly in options, start usb with first found usb camera as the device
|
|
||||||
echo "config file='$camera_config':USB device was not set in options, start MJPG-streamer with the first found video device: ${video_device}"
|
|
||||||
startUsb "${video_device}"
|
|
||||||
break
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
if [[ -n ${array_camera_device[${i}]} ]]; then
|
|
||||||
continue
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
if [[ "raspi" == ${scan_mode} ]] || [[ "auto" == ${scan_mode} ]]; then
|
|
||||||
video_device="raspi"
|
|
||||||
if containsString "$video_device" "${array_camera_device[@]}"; then
|
|
||||||
if [[ "auto" != ${scan_mode} ]]; then
|
|
||||||
array_camera_device[${i}]="alredy_in_use"
|
|
||||||
echo "config file='$camera_config':RasPiCam device already in use."
|
|
||||||
fi
|
|
||||||
elif containsString "$video_device" "${video_devices[@]}"; then
|
|
||||||
array_camera_device[${i}]="$video_device"
|
|
||||||
echo "config file='$camera_config':Start MJPG-streamer with video device: ${video_device}"
|
|
||||||
startRaspi
|
|
||||||
sleep 30 &
|
|
||||||
sleep_pid=$!
|
|
||||||
wait ${sleep_pid}
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
done
|
|
||||||
array_assigned_device=( ${array_camera_device[*]} )
|
|
||||||
if [[ ${#array_camera[@]} -eq ${#array_assigned_device[@]} ]]; then
|
|
||||||
echo "Done bring up all configured video device"
|
|
||||||
exit 0
|
|
||||||
else
|
|
||||||
echo "Scan again in two minutes"
|
|
||||||
sleep 120 &
|
|
||||||
sleep_pid=$!
|
|
||||||
wait ${sleep_pid}
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
[Unit]
|
|
||||||
Description=Starts mjpg-streamer on startup
|
|
||||||
After=network.target
|
|
||||||
|
|
||||||
[Install]
|
|
||||||
WantedBy=multi-user.target
|
|
||||||
|
|
||||||
[Service]
|
|
||||||
Type=forking
|
|
||||||
User=%USER%
|
|
||||||
WorkingDirectory=/usr/local/bin
|
|
||||||
StandardOutput=append:/var/log/webcamd.log
|
|
||||||
StandardError=append:/var/log/webcamd.log
|
|
||||||
ExecStart=/usr/local/bin/webcamd
|
|
||||||
Restart=always
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
TELEGRAM_BOT_ARGS="%TELEGRAM_BOT_DIR%/bot/main.py -c %CFG% -l %LOG%"
|
|
||||||
@@ -1,16 +0,0 @@
|
|||||||
[Unit]
|
|
||||||
Description=Moonraker Telegram Bot SV1 %INST%
|
|
||||||
Documentation=https://github.com/nlef/moonraker-telegram-bot/wiki
|
|
||||||
After=network-online.target
|
|
||||||
|
|
||||||
[Install]
|
|
||||||
WantedBy=multi-user.target
|
|
||||||
|
|
||||||
[Service]
|
|
||||||
Type=simple
|
|
||||||
User=%USER%
|
|
||||||
WorkingDirectory=%TELEGRAM_BOT_DIR%
|
|
||||||
EnvironmentFile=%ENV_FILE%
|
|
||||||
ExecStart=%ENV%/bin/python $TELEGRAM_BOT_ARGS
|
|
||||||
Restart=always
|
|
||||||
RestartSec=10
|
|
||||||
@@ -1,31 +0,0 @@
|
|||||||
[server]
|
|
||||||
host: 0.0.0.0
|
|
||||||
port: %PORT%
|
|
||||||
klippy_uds_address: %UDS%
|
|
||||||
|
|
||||||
[authorization]
|
|
||||||
trusted_clients:
|
|
||||||
%LAN%
|
|
||||||
10.0.0.0/8
|
|
||||||
127.0.0.0/8
|
|
||||||
169.254.0.0/16
|
|
||||||
172.16.0.0/12
|
|
||||||
192.168.0.0/16
|
|
||||||
FE80::/10
|
|
||||||
::1/128
|
|
||||||
cors_domains:
|
|
||||||
*.lan
|
|
||||||
*.local
|
|
||||||
*.internal
|
|
||||||
*://localhost
|
|
||||||
*://localhost:*
|
|
||||||
*://my.mainsail.xyz
|
|
||||||
*://app.fluidd.xyz
|
|
||||||
|
|
||||||
[octoprint_compat]
|
|
||||||
|
|
||||||
[history]
|
|
||||||
|
|
||||||
[update_manager]
|
|
||||||
channel: dev
|
|
||||||
refresh_interval: 168
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
MOONRAKER_ARGS="%MOONRAKER_DIR%/moonraker/moonraker.py -d %PRINTER_DATA%"
|
|
||||||
@@ -1,19 +0,0 @@
|
|||||||
[Unit]
|
|
||||||
Description=API Server for Klipper SV1 %INST%
|
|
||||||
Documentation=https://moonraker.readthedocs.io/
|
|
||||||
Requires=network-online.target
|
|
||||||
After=network-online.target
|
|
||||||
|
|
||||||
[Install]
|
|
||||||
WantedBy=multi-user.target
|
|
||||||
|
|
||||||
[Service]
|
|
||||||
Type=simple
|
|
||||||
User=%USER%
|
|
||||||
SupplementaryGroups=moonraker-admin
|
|
||||||
RemainAfterExit=yes
|
|
||||||
WorkingDirectory=%MOONRAKER_DIR%
|
|
||||||
EnvironmentFile=%ENV_FILE%
|
|
||||||
ExecStart=%ENV%/bin/python $MOONRAKER_ARGS
|
|
||||||
Restart=always
|
|
||||||
RestartSec=10
|
|
||||||
@@ -1,7 +0,0 @@
|
|||||||
[gcode_shell_command hello_world]
|
|
||||||
command: echo hello world
|
|
||||||
timeout: 2.
|
|
||||||
verbose: True
|
|
||||||
[gcode_macro HELLO_WORLD]
|
|
||||||
gcode:
|
|
||||||
RUN_SHELL_COMMAND CMD=hello_world
|
|
||||||
@@ -1,25 +0,0 @@
|
|||||||
# /etc/nginx/conf.d/upstreams.conf
|
|
||||||
upstream apiserver {
|
|
||||||
ip_hash;
|
|
||||||
server 127.0.0.1:7125;
|
|
||||||
}
|
|
||||||
|
|
||||||
upstream mjpgstreamer1 {
|
|
||||||
ip_hash;
|
|
||||||
server 127.0.0.1:8080;
|
|
||||||
}
|
|
||||||
|
|
||||||
upstream mjpgstreamer2 {
|
|
||||||
ip_hash;
|
|
||||||
server 127.0.0.1:8081;
|
|
||||||
}
|
|
||||||
|
|
||||||
upstream mjpgstreamer3 {
|
|
||||||
ip_hash;
|
|
||||||
server 127.0.0.1:8082;
|
|
||||||
}
|
|
||||||
|
|
||||||
upstream mjpgstreamer4 {
|
|
||||||
ip_hash;
|
|
||||||
server 127.0.0.1:8083;
|
|
||||||
}
|
|
||||||
@@ -1,231 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
|
|
||||||
#=======================================================================#
|
|
||||||
# Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com> #
|
|
||||||
# #
|
|
||||||
# This file is part of KIAUH - Klipper Installation And Update Helper #
|
|
||||||
# https://github.com/dw-0/kiauh #
|
|
||||||
# #
|
|
||||||
# This file may be distributed under the terms of the GNU GPLv3 license #
|
|
||||||
#=======================================================================#
|
|
||||||
|
|
||||||
set -e
|
|
||||||
|
|
||||||
function get_date() {
|
|
||||||
local current_date
|
|
||||||
current_date=$(date +"%y%m%d-%H%M")
|
|
||||||
echo "${current_date}"
|
|
||||||
}
|
|
||||||
|
|
||||||
function check_for_backup_dir() {
|
|
||||||
[[ -d ${BACKUP_DIR} ]] && return
|
|
||||||
|
|
||||||
status_msg "Create KIAUH backup directory ..."
|
|
||||||
mkdir -p "${BACKUP_DIR}" && ok_msg "Directory created!"
|
|
||||||
}
|
|
||||||
|
|
||||||
function backup_before_update() {
|
|
||||||
read_kiauh_ini "${FUNCNAME[0]}"
|
|
||||||
local state="${backup_before_update}"
|
|
||||||
[[ ${state} = "false" ]] && return
|
|
||||||
backup_"${1}"
|
|
||||||
}
|
|
||||||
|
|
||||||
function backup_config_dir() {
|
|
||||||
check_for_backup_dir
|
|
||||||
local current_date config_pathes
|
|
||||||
|
|
||||||
config_pathes=$(get_config_folders)
|
|
||||||
|
|
||||||
if [[ -n "${config_pathes}" ]]; then
|
|
||||||
current_date=$(get_date)
|
|
||||||
status_msg "Timestamp: ${current_date}"
|
|
||||||
|
|
||||||
local i=0 folder folder_name target_dir
|
|
||||||
for folder in ${config_pathes}; do
|
|
||||||
if [[ -d ${folder} ]]; then
|
|
||||||
status_msg "Create backup of ${folder} ..."
|
|
||||||
|
|
||||||
folder_name=$(echo "${folder}" | rev | cut -d"/" -f2 | rev)
|
|
||||||
target_dir="${BACKUP_DIR}/configs/${current_date}/${folder_name}"
|
|
||||||
mkdir -p "${target_dir}"
|
|
||||||
cp -r "${folder}" "${target_dir}"
|
|
||||||
i=$(( i + 1 ))
|
|
||||||
|
|
||||||
ok_msg "Backup created in:\n${target_dir}"
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
else
|
|
||||||
ok_msg "No config directory found! Skipping backup ..."
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
function backup_moonraker_database() {
|
|
||||||
check_for_backup_dir
|
|
||||||
local current_date db_pathes
|
|
||||||
|
|
||||||
db_pathes=$(get_instance_folder_path "database")
|
|
||||||
|
|
||||||
if [[ -n ${db_pathes} ]]; then
|
|
||||||
current_date=$(get_date)
|
|
||||||
status_msg "Timestamp: ${current_date}"
|
|
||||||
|
|
||||||
local i=0 database folder_name target_dir
|
|
||||||
for database in ${db_pathes}; do
|
|
||||||
status_msg "Create backup of ${database} ..."
|
|
||||||
|
|
||||||
folder_name=$(echo "${database}" | rev | cut -d"/" -f2 | rev)
|
|
||||||
target_dir="${BACKUP_DIR}/moonraker_databases/${current_date}/${folder_name}"
|
|
||||||
mkdir -p "${target_dir}"
|
|
||||||
cp -r "${database}" "${target_dir}"
|
|
||||||
i=$(( i + 1 ))
|
|
||||||
|
|
||||||
ok_msg "Backup created in:\n${target_dir}"
|
|
||||||
done
|
|
||||||
else
|
|
||||||
print_error "No Moonraker database found! Skipping backup ..."
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
function backup_klipper() {
|
|
||||||
local current_date
|
|
||||||
|
|
||||||
if [[ -d ${KLIPPER_DIR} && -d ${KLIPPY_ENV} ]]; then
|
|
||||||
status_msg "Creating Klipper backup ..."
|
|
||||||
check_for_backup_dir
|
|
||||||
current_date=$(get_date)
|
|
||||||
status_msg "Timestamp: ${current_date}"
|
|
||||||
mkdir -p "${BACKUP_DIR}/klipper-backups/${current_date}"
|
|
||||||
cp -r "${KLIPPER_DIR}" "${_}" && cp -r "${KLIPPY_ENV}" "${_}"
|
|
||||||
print_confirm "Klipper backup complete!"
|
|
||||||
else
|
|
||||||
print_error "Can't back up 'klipper' and/or 'klipper-env' directory! Not found!"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
function backup_mainsail() {
|
|
||||||
local current_date
|
|
||||||
|
|
||||||
if [[ -d ${MAINSAIL_DIR} ]]; then
|
|
||||||
status_msg "Creating Mainsail backup ..."
|
|
||||||
check_for_backup_dir
|
|
||||||
current_date=$(get_date)
|
|
||||||
status_msg "Timestamp: ${current_date}"
|
|
||||||
mkdir -p "${BACKUP_DIR}/mainsail-backups/${current_date}"
|
|
||||||
cp -r "${MAINSAIL_DIR}" "${_}"
|
|
||||||
print_confirm "Mainsail backup complete!"
|
|
||||||
else
|
|
||||||
print_error "Can't back up 'mainsail' directory! Not found!"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
function backup_fluidd() {
|
|
||||||
local current_date
|
|
||||||
|
|
||||||
if [[ -d ${FLUIDD_DIR} ]]; then
|
|
||||||
status_msg "Creating Fluidd backup ..."
|
|
||||||
check_for_backup_dir
|
|
||||||
current_date=$(get_date)
|
|
||||||
status_msg "Timestamp: ${current_date}"
|
|
||||||
mkdir -p "${BACKUP_DIR}/fluidd-backups/${current_date}"
|
|
||||||
cp -r "${FLUIDD_DIR}" "${_}"
|
|
||||||
print_confirm "Fluidd backup complete!"
|
|
||||||
else
|
|
||||||
print_error "Can't back up 'fluidd' directory! Not found!"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
function backup_moonraker() {
|
|
||||||
local current_date
|
|
||||||
|
|
||||||
if [[ -d ${MOONRAKER_DIR} && -d ${MOONRAKER_ENV} ]]; then
|
|
||||||
status_msg "Creating Moonraker backup ..."
|
|
||||||
check_for_backup_dir
|
|
||||||
current_date=$(get_date)
|
|
||||||
status_msg "Timestamp: ${current_date}"
|
|
||||||
mkdir -p "${BACKUP_DIR}/moonraker-backups/${current_date}"
|
|
||||||
cp -r "${MOONRAKER_DIR}" "${_}" && cp -r "${MOONRAKER_ENV}" "${_}"
|
|
||||||
print_confirm "Moonraker backup complete!"
|
|
||||||
else
|
|
||||||
print_error "Can't back up moonraker and/or moonraker-env directory! Not found!"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
function backup_octoprint() {
|
|
||||||
local current_date
|
|
||||||
|
|
||||||
if [[ -d ${OCTOPRINT_DIR} && -d ${OCTOPRINT_CFG_DIR} ]]; then
|
|
||||||
status_msg "Creating OctoPrint backup ..."
|
|
||||||
check_for_backup_dir
|
|
||||||
current_date=$(get_date)
|
|
||||||
status_msg "Timestamp: ${current_date}"
|
|
||||||
mkdir -p "${BACKUP_DIR}/octoprint-backups/${current_date}"
|
|
||||||
cp -r "${OCTOPRINT_DIR}" "${_}" && cp -r "${OCTOPRINT_CFG_DIR}" "${_}"
|
|
||||||
print_confirm " OctoPrint backup complete!"
|
|
||||||
else
|
|
||||||
print_error "Can't back up OctoPrint and/or .octoprint directory!\n Not found!"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
function backup_klipperscreen() {
|
|
||||||
local current_date
|
|
||||||
if [[ -d ${KLIPPERSCREEN_DIR} ]] ; then
|
|
||||||
status_msg "Creating KlipperScreen backup ..."
|
|
||||||
check_for_backup_dir
|
|
||||||
current_date=$(get_date)
|
|
||||||
status_msg "Timestamp: ${current_date}"
|
|
||||||
mkdir -p "${BACKUP_DIR}/klipperscreen-backups/${current_date}"
|
|
||||||
cp -r "${KLIPPERSCREEN_DIR}" "${_}"
|
|
||||||
print_confirm "KlipperScreen backup complete!"
|
|
||||||
else
|
|
||||||
print_error "Can't back up KlipperScreen directory!\n Not found!"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
function backup_telegram_bot() {
|
|
||||||
local current_date
|
|
||||||
|
|
||||||
if [[ -d ${TELEGRAM_BOT_DIR} ]] ; then
|
|
||||||
status_msg "Creating MoonrakerTelegramBot backup ..."
|
|
||||||
check_for_backup_dir
|
|
||||||
current_date=$(get_date)
|
|
||||||
status_msg "Timestamp: ${current_date}"
|
|
||||||
mkdir -p "${BACKUP_DIR}/MoonrakerTelegramBot-backups/${current_date}"
|
|
||||||
cp -r "${TELEGRAM_BOT_DIR}" "${_}"
|
|
||||||
print_confirm "MoonrakerTelegramBot backup complete!"
|
|
||||||
else
|
|
||||||
print_error "Can't back up MoonrakerTelegramBot directory!\n Not found!"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
function backup_octoeverywhere() {
|
|
||||||
local current_date
|
|
||||||
|
|
||||||
if [[ -d ${OCTOEVERYWHERE_DIR} ]] ; then
|
|
||||||
status_msg "Creating OctoEverywhere backup ..."
|
|
||||||
check_for_backup_dir
|
|
||||||
current_date=$(get_date)
|
|
||||||
status_msg "Timestamp: ${current_date}"
|
|
||||||
mkdir -p "${BACKUP_DIR}/OctoEverywhere-backups/${current_date}"
|
|
||||||
cp -r "${OCTOEVERYWHERE_DIR}" "${_}" && cp -r "${OCTOEVERYWHERE_ENV}" "${_}"
|
|
||||||
print_confirm "OctoEverywhere backup complete!"
|
|
||||||
else
|
|
||||||
print_error "Can't back up OctoEverywhere directory!\n Not found!"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
function backup_spoolman() {
|
|
||||||
local current_date
|
|
||||||
|
|
||||||
if [[ -d ${SPOOLMAN_DIR} ]] ; then
|
|
||||||
status_msg "Creating Spoolman backup ..."
|
|
||||||
check_for_backup_dir
|
|
||||||
current_date=$(get_date)
|
|
||||||
status_msg "Timestamp: ${current_date}"
|
|
||||||
mkdir -p "${BACKUP_DIR}/Spoolman-backups/${current_date}"
|
|
||||||
cp -r "${SPOOLMAN_DIR}" "${_}" && cp -r "${SPOOLMAN_DB_DIR}/spoolman.db" "${_}"
|
|
||||||
print_confirm "Spoolman backup complete!"
|
|
||||||
else
|
|
||||||
print_error "Can't back up Spoolman directory!\n Not found!"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
@@ -1,235 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
|
|
||||||
#=======================================================================#
|
|
||||||
# Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com> #
|
|
||||||
# #
|
|
||||||
# This file is part of KIAUH - Klipper Installation And Update Helper #
|
|
||||||
# https://github.com/dw-0/kiauh #
|
|
||||||
# #
|
|
||||||
# This file may be distributed under the terms of the GNU GPLv3 license #
|
|
||||||
#=======================================================================#
|
|
||||||
|
|
||||||
#=======================================================================#
|
|
||||||
# Crowsnest Installer brought to you by KwadFan <me@stephanwe.de> #
|
|
||||||
# Copyright (C) 2022 KwadFan <me@stephanwe.de> #
|
|
||||||
# https://github.com/KwadFan/crowsnest #
|
|
||||||
#=======================================================================#
|
|
||||||
|
|
||||||
# Error Handling
|
|
||||||
set -e
|
|
||||||
|
|
||||||
# Helper messages
|
|
||||||
|
|
||||||
function multi_instance_message(){
|
|
||||||
echo -e "Crowsnest is NOT designed to support multi instances."
|
|
||||||
echo -e "A workaround for this is to choose the most used instance as a 'master'"
|
|
||||||
echo -e "Use this instance to set up your 'crowsnest.conf' and steering it's service.\n"
|
|
||||||
echo -e "Found the following instances:\n"
|
|
||||||
for i in ${1}; do
|
|
||||||
select_msg "${i}"
|
|
||||||
done
|
|
||||||
echo -e "\nLaunching crowsnest's configuration tool ..."
|
|
||||||
continue_config
|
|
||||||
}
|
|
||||||
|
|
||||||
# Helper funcs
|
|
||||||
function clone_crowsnest(){
|
|
||||||
$(command -v git) clone "${CROWSNEST_REPO}" -b master "${CROWSNEST_DIR}"
|
|
||||||
}
|
|
||||||
|
|
||||||
function check_multi_instance(){
|
|
||||||
local -a instances
|
|
||||||
readarray -t instances < <(find "${HOME}" -regex "${HOME}/[a-zA-Z0-9_]+_data/*" -printf "%P\n" 2> /dev/null | sort)
|
|
||||||
if [[ "${#instances[@]}" -gt 1 ]]; then
|
|
||||||
status_msg "Multi instance install detected ..."
|
|
||||||
multi_instance_message "${instances[*]}"
|
|
||||||
if [[ -d "${HOME}/crowsnest" ]]; then
|
|
||||||
pushd "${HOME}/crowsnest" &> /dev/null || exit 1
|
|
||||||
if ! make config ;then
|
|
||||||
error_msg "Something went wrong! Please try again..."
|
|
||||||
if [[ -f "tools/.config" ]]; then
|
|
||||||
rm -f tools/.config
|
|
||||||
fi
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
if [[ ! -f "tools/.config" ]]; then
|
|
||||||
log_error "failure while generating .config"
|
|
||||||
error_msg "Generating .config failed, installation aborted"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
popd &> /dev/null || exit 1
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
function continue_config() {
|
|
||||||
local reply
|
|
||||||
while true; do
|
|
||||||
read -erp "${cyan}###### Continue with configuration? (y/N):${white} " reply
|
|
||||||
case "${reply}" in
|
|
||||||
Y|y|Yes|yes)
|
|
||||||
select_msg "Yes"
|
|
||||||
break;;
|
|
||||||
N|n|No|no|"")
|
|
||||||
select_msg "No"
|
|
||||||
warn_msg "Installation aborted by user ... Exiting!"
|
|
||||||
exit 1;;
|
|
||||||
*)
|
|
||||||
error_msg "Invalid Input!\n";;
|
|
||||||
esac
|
|
||||||
done
|
|
||||||
return 0
|
|
||||||
}
|
|
||||||
|
|
||||||
# Install func
|
|
||||||
function install_crowsnest(){
|
|
||||||
|
|
||||||
# Step 1: jump to home directory
|
|
||||||
pushd "${HOME}" &> /dev/null || exit 1
|
|
||||||
|
|
||||||
# Step 2: Clone crowsnest repo
|
|
||||||
status_msg "Cloning 'crowsnest' repository ..."
|
|
||||||
if [[ ! -d "${HOME}/crowsnest" && -z "$(ls -A "${HOME}/crowsnest" 2> /dev/null)" ]]; then
|
|
||||||
clone_crowsnest
|
|
||||||
else
|
|
||||||
ok_msg "crowsnest repository already exists ..."
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Step 3: Install dependencies
|
|
||||||
dependency_check git make
|
|
||||||
|
|
||||||
# Step 4: Check for Multi Instance
|
|
||||||
check_multi_instance
|
|
||||||
|
|
||||||
# Step 5: Launch crowsnest installer
|
|
||||||
pushd "${HOME}/crowsnest" &> /dev/null || exit 1
|
|
||||||
title_msg "Installer will prompt you for sudo password!"
|
|
||||||
status_msg "Launching crowsnest installer ..."
|
|
||||||
if ! sudo make install; then
|
|
||||||
error_msg "Something went wrong! Please try again..."
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Step 5: Leave directory (twice due two pushd)
|
|
||||||
popd &> /dev/null || exit 1
|
|
||||||
popd &> /dev/null || exit 1
|
|
||||||
}
|
|
||||||
|
|
||||||
# Remove func
|
|
||||||
function remove_crowsnest(){
|
|
||||||
if [[ -d "${CROWSNEST_DIR}" ]]; then
|
|
||||||
pushd "${HOME}/crowsnest" &> /dev/null || exit 1
|
|
||||||
title_msg "Uninstaller will prompt you for sudo password!"
|
|
||||||
status_msg "Launching crowsnest uninstaller ..."
|
|
||||||
|
|
||||||
if ! make uninstall; then
|
|
||||||
error_msg "Something went wrong! Please try again..."
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
status_msg "Removing crowsnest directory ..."
|
|
||||||
rm -rf "${CROWSNEST_DIR}"
|
|
||||||
ok_msg "Directory removed!"
|
|
||||||
fi
|
|
||||||
|
|
||||||
print_confirm "Crowsnest successfully removed!"
|
|
||||||
}
|
|
||||||
|
|
||||||
# Status funcs
|
|
||||||
get_crowsnest_status(){
|
|
||||||
local -a files
|
|
||||||
local env_file
|
|
||||||
env_file="$(grep "EnvironmentFile" /etc/systemd/system/crowsnest.service 2>/dev/null | cut -d "=" -f2)"
|
|
||||||
files=(
|
|
||||||
"${CROWSNEST_DIR}"
|
|
||||||
"/usr/local/bin/crowsnest"
|
|
||||||
"/etc/logrotate.d/crowsnest"
|
|
||||||
"/etc/systemd/system/crowsnest.service"
|
|
||||||
"${env_file}"
|
|
||||||
)
|
|
||||||
local count
|
|
||||||
count=0
|
|
||||||
|
|
||||||
for file in "${files[@]}"; do
|
|
||||||
[[ -e "${file}" ]] && count=$(( count +1 ))
|
|
||||||
done
|
|
||||||
if [[ "${count}" -eq "${#files[*]}" ]]; then
|
|
||||||
echo "Installed"
|
|
||||||
elif [[ "${count}" -gt 0 ]]; then
|
|
||||||
echo "Incomplete!"
|
|
||||||
else
|
|
||||||
echo "Not installed!"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
# Update funcs
|
|
||||||
# Shameless stolen from KlipperScreen.sh
|
|
||||||
function get_local_crowsnest_commit() {
|
|
||||||
[[ ! -d ${CROWSNEST_DIR} || ! -d "${CROWSNEST_DIR}/.git" ]] && return
|
|
||||||
|
|
||||||
local commit
|
|
||||||
cd "${CROWSNEST_DIR}"
|
|
||||||
commit="$(git describe HEAD --always --tags | cut -d "-" -f 1,2)"
|
|
||||||
echo "${commit}"
|
|
||||||
}
|
|
||||||
|
|
||||||
function get_remote_crowsnest_commit() {
|
|
||||||
[[ ! -d ${CROWSNEST_DIR} || ! -d "${CROWSNEST_DIR}/.git" ]] && return
|
|
||||||
|
|
||||||
local commit
|
|
||||||
cd "${CROWSNEST_DIR}" && git fetch origin -q
|
|
||||||
commit=$(git describe origin/master --always --tags | cut -d "-" -f 1,2)
|
|
||||||
echo "${commit}"
|
|
||||||
}
|
|
||||||
|
|
||||||
function compare_crowsnest_versions() {
|
|
||||||
local versions local_ver remote_ver
|
|
||||||
local_ver="$(get_local_crowsnest_commit)"
|
|
||||||
remote_ver="$(get_remote_crowsnest_commit)"
|
|
||||||
|
|
||||||
if [[ ${local_ver} != "${remote_ver}" ]]; then
|
|
||||||
versions="${yellow}$(printf " %-14s" "${local_ver}")${white}"
|
|
||||||
versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
|
|
||||||
# add moonraker to application_updates_available in kiauh.ini
|
|
||||||
add_to_application_updates "crowsnest"
|
|
||||||
else
|
|
||||||
versions="${green}$(printf " %-14s" "${local_ver}")${white}"
|
|
||||||
versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo "${versions}"
|
|
||||||
}
|
|
||||||
|
|
||||||
function install_crowsnest_dependencies() {
|
|
||||||
local packages log_name="Crowsnest"
|
|
||||||
local install_script="${CROWSNEST_DIR}/tools/install.sh"
|
|
||||||
|
|
||||||
### read PKGLIST from official install-script
|
|
||||||
status_msg "Reading dependencies..."
|
|
||||||
# shellcheck disable=SC2016
|
|
||||||
packages="$(grep "PKGLIST=" "${install_script}" | cut -d'"' -f2 | sed 's/\${PKGLIST}//g' | tr -d '\n')"
|
|
||||||
|
|
||||||
echo "${cyan}${packages}${white}" | tr '[:space:]' '\n'
|
|
||||||
read -r -a packages <<< "${packages}"
|
|
||||||
|
|
||||||
### Update system package lists if stale
|
|
||||||
update_system_package_lists
|
|
||||||
|
|
||||||
### Install required packages
|
|
||||||
install_system_packages "${log_name}" "packages[@]"
|
|
||||||
}
|
|
||||||
|
|
||||||
function update_crowsnest() {
|
|
||||||
do_action_service "stop" "crowsnest"
|
|
||||||
|
|
||||||
if [[ ! -d ${CROWSNEST_DIR} ]]; then
|
|
||||||
clone_crowsnest
|
|
||||||
else
|
|
||||||
status_msg "Updating Crowsnest ..."
|
|
||||||
cd "${CROWSNEST_DIR}" && git pull
|
|
||||||
### read PKGLIST and install possible new dependencies
|
|
||||||
install_crowsnest_dependencies
|
|
||||||
fi
|
|
||||||
ok_msg "Update complete!"
|
|
||||||
do_action_service "restart" "crowsnest"
|
|
||||||
}
|
|
||||||
@@ -1,494 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
|
|
||||||
#=======================================================================#
|
|
||||||
# Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com> #
|
|
||||||
# #
|
|
||||||
# This file is part of KIAUH - Klipper Installation And Update Helper #
|
|
||||||
# https://github.com/dw-0/kiauh #
|
|
||||||
# #
|
|
||||||
# This file may be distributed under the terms of the GNU GPLv3 license #
|
|
||||||
#=======================================================================#
|
|
||||||
|
|
||||||
set -e
|
|
||||||
|
|
||||||
function init_flash_process() {
|
|
||||||
### step 1: check for required userhgroups (tty & dialout)
|
|
||||||
check_usergroups
|
|
||||||
|
|
||||||
top_border
|
|
||||||
echo -e "| ~~~~~~~~~~~~ [ Flash MCU ] ~~~~~~~~~~~~ |"
|
|
||||||
hr
|
|
||||||
echo -e "| Please select the flashing method to flash your MCU. |"
|
|
||||||
echo -e "| Make sure to only select a method your MCU supports. |"
|
|
||||||
echo -e "| Not all MCUs support both methods! |"
|
|
||||||
hr
|
|
||||||
blank_line
|
|
||||||
echo -e "| 1) Regular flashing method |"
|
|
||||||
echo -e "| 2) Updating via SD-Card Update |"
|
|
||||||
blank_line
|
|
||||||
back_help_footer
|
|
||||||
|
|
||||||
local choice method
|
|
||||||
while true; do
|
|
||||||
read -p "${cyan}###### Please select:${white} " choice
|
|
||||||
case "${choice}" in
|
|
||||||
1)
|
|
||||||
select_msg "Regular flashing method"
|
|
||||||
method="regular"
|
|
||||||
break;;
|
|
||||||
2)
|
|
||||||
select_msg "SD-Card Update"
|
|
||||||
method="sdcard"
|
|
||||||
break;;
|
|
||||||
B|b)
|
|
||||||
advanced_menu
|
|
||||||
break;;
|
|
||||||
H|h)
|
|
||||||
clear && print_header
|
|
||||||
show_flash_method_help
|
|
||||||
break;;
|
|
||||||
*)
|
|
||||||
error_msg "Invalid command!";;
|
|
||||||
esac
|
|
||||||
done
|
|
||||||
|
|
||||||
### step 2: select how the mcu is flashed (flash/serialflash)
|
|
||||||
select_flash_command
|
|
||||||
|
|
||||||
### step 3: select how the mcu is connected to the host
|
|
||||||
select_mcu_connection
|
|
||||||
|
|
||||||
### step 4: select which detected mcu should be flashed
|
|
||||||
select_mcu_id "${method}"
|
|
||||||
}
|
|
||||||
|
|
||||||
#================================================#
|
|
||||||
#=================== STEP 2 =====================#
|
|
||||||
#================================================#
|
|
||||||
function select_flash_command() {
|
|
||||||
unset flash_command
|
|
||||||
|
|
||||||
top_border
|
|
||||||
echo -e "| How to flash MCU? |"
|
|
||||||
echo -e "| 1) make flash (default) |"
|
|
||||||
echo -e "| 2) make serialflash (stm32flash) |"
|
|
||||||
blank_line
|
|
||||||
back_help_footer
|
|
||||||
|
|
||||||
local choice
|
|
||||||
while true; do
|
|
||||||
read -p "${cyan}###### Flashing command:${white} " -i "1" -e choice
|
|
||||||
case "${choice}" in
|
|
||||||
1)
|
|
||||||
select_msg "Selected 'make flash' command"
|
|
||||||
flash_command="flash"
|
|
||||||
break;;
|
|
||||||
2)
|
|
||||||
select_msg "Selected 'make serialflash' command"
|
|
||||||
flash_command="serialflash"
|
|
||||||
break;;
|
|
||||||
B|b)
|
|
||||||
advanced_menu
|
|
||||||
break;;
|
|
||||||
H|h)
|
|
||||||
clear && print_header
|
|
||||||
show_mcu_flash_command_help
|
|
||||||
break;;
|
|
||||||
*)
|
|
||||||
error_msg "Invalid command!";;
|
|
||||||
esac
|
|
||||||
done
|
|
||||||
}
|
|
||||||
|
|
||||||
#================================================#
|
|
||||||
#=================== STEP 3 =====================#
|
|
||||||
#================================================#
|
|
||||||
function select_mcu_connection() {
|
|
||||||
top_border
|
|
||||||
echo -e "| ${yellow}Make sure that the controller board is connected now!${white} |"
|
|
||||||
hr
|
|
||||||
blank_line
|
|
||||||
echo -e "| How is the controller board connected to the host? |"
|
|
||||||
echo -e "| 1) USB |"
|
|
||||||
echo -e "| 2) UART |"
|
|
||||||
echo -e "| 3) USB (DFU mode) |"
|
|
||||||
blank_line
|
|
||||||
back_help_footer
|
|
||||||
|
|
||||||
local choice
|
|
||||||
while true; do
|
|
||||||
read -p "${cyan}###### Connection method:${white} " choice
|
|
||||||
case "${choice}" in
|
|
||||||
1)
|
|
||||||
status_msg "Identifying MCU connected via USB ...\n"
|
|
||||||
get_usb_id || true # continue even after exit code 1
|
|
||||||
break;;
|
|
||||||
2)
|
|
||||||
status_msg "Identifying MCU possibly connected via UART ...\n"
|
|
||||||
get_uart_id || true # continue even after exit code 1
|
|
||||||
break;;
|
|
||||||
3)
|
|
||||||
status_msg "Identifying MCU connected via USB in DFU mode ...\n"
|
|
||||||
get_dfu_id || true # continue even after exit code 1
|
|
||||||
break;;
|
|
||||||
B|b)
|
|
||||||
advanced_menu
|
|
||||||
break;;
|
|
||||||
H|h)
|
|
||||||
clear && print_header
|
|
||||||
show_mcu_connection_help
|
|
||||||
break;;
|
|
||||||
*)
|
|
||||||
error_msg "Invalid command!";;
|
|
||||||
esac
|
|
||||||
done
|
|
||||||
}
|
|
||||||
|
|
||||||
function print_detected_mcu_to_screen() {
|
|
||||||
local i=1
|
|
||||||
|
|
||||||
if (( ${#mcu_list[@]} < 1 )); then
|
|
||||||
print_error "No MCU found!\n MCU either not connected or not detected!"
|
|
||||||
return
|
|
||||||
fi
|
|
||||||
|
|
||||||
for mcu in "${mcu_list[@]}"; do
|
|
||||||
echo -e " ● MCU #${i}: ${cyan}${mcu}${white}"
|
|
||||||
i=$(( i + 1 ))
|
|
||||||
done
|
|
||||||
echo
|
|
||||||
}
|
|
||||||
|
|
||||||
#================================================#
|
|
||||||
#=================== STEP 4 =====================#
|
|
||||||
#================================================#
|
|
||||||
function select_mcu_id() {
|
|
||||||
local i=0 sel_index=0 method=${1}
|
|
||||||
|
|
||||||
if (( ${#mcu_list[@]} < 1 )); then
|
|
||||||
print_error "No MCU found!\n MCU either not connected or not detected!"
|
|
||||||
return
|
|
||||||
fi
|
|
||||||
|
|
||||||
top_border
|
|
||||||
echo -e "| ${red}!!! ATTENTION !!!${white} |"
|
|
||||||
hr
|
|
||||||
echo -e "| Make sure, to select the correct MCU! |"
|
|
||||||
echo -e "| ${red}ONLY flash a firmware created for the respective MCU!${white} |"
|
|
||||||
bottom_border
|
|
||||||
echo -e "${cyan}###### List of available MCU:${white}"
|
|
||||||
|
|
||||||
### list all mcus
|
|
||||||
for mcu in "${mcu_list[@]}"; do
|
|
||||||
i=$(( i + 1 ))
|
|
||||||
mcu=$(echo "${mcu}" | rev | cut -d"/" -f1 | rev)
|
|
||||||
echo -e " ● MCU #${i}: ${cyan}${mcu}${white}"
|
|
||||||
done
|
|
||||||
|
|
||||||
### verify user input
|
|
||||||
local regex="^[1-9]+$"
|
|
||||||
while [[ ! ${sel_index} =~ ${regex} ]] || [[ ${sel_index} -gt ${i} ]]; do
|
|
||||||
echo
|
|
||||||
read -p "${cyan}###### Select MCU to flash:${white} " sel_index
|
|
||||||
|
|
||||||
if [[ ! ${sel_index} =~ ${regex} ]]; then
|
|
||||||
error_msg "Invalid input!"
|
|
||||||
elif [[ ${sel_index} -lt 1 ]] || [[ ${sel_index} -gt ${i} ]]; then
|
|
||||||
error_msg "Please select a number between 1 and ${i}!"
|
|
||||||
fi
|
|
||||||
|
|
||||||
local mcu_index=$(( sel_index - 1 ))
|
|
||||||
local selected_mcu_id="${mcu_list[${mcu_index}]}"
|
|
||||||
done
|
|
||||||
|
|
||||||
### confirm selection
|
|
||||||
local yn
|
|
||||||
while true; do
|
|
||||||
echo -e "\n###### You selected:\n ● MCU #${sel_index}: ${selected_mcu_id}\n"
|
|
||||||
read -p "${cyan}###### Continue? (Y/n):${white} " yn
|
|
||||||
case "${yn}" in
|
|
||||||
Y|y|Yes|yes|"")
|
|
||||||
select_msg "Yes"
|
|
||||||
status_msg "Flashing ${selected_mcu_id} ..."
|
|
||||||
if [[ ${method} == "regular" ]]; then
|
|
||||||
log_info "Flashing device '${selected_mcu_id}' with method '${method}'"
|
|
||||||
start_flash_mcu "${selected_mcu_id}"
|
|
||||||
elif [[ ${method} == "sdcard" ]]; then
|
|
||||||
log_info "Flashing device '${selected_mcu_id}' with method '${method}'"
|
|
||||||
start_flash_sd "${selected_mcu_id}"
|
|
||||||
else
|
|
||||||
print_error "No flash method set! Aborting..."
|
|
||||||
log_error "No flash method set!"
|
|
||||||
return
|
|
||||||
fi
|
|
||||||
break;;
|
|
||||||
N|n|No|no)
|
|
||||||
select_msg "No"
|
|
||||||
break;;
|
|
||||||
*)
|
|
||||||
error_msg "Invalid command!";;
|
|
||||||
esac
|
|
||||||
done
|
|
||||||
}
|
|
||||||
|
|
||||||
function start_flash_mcu() {
|
|
||||||
local device=${1}
|
|
||||||
do_action_service "stop" "klipper"
|
|
||||||
|
|
||||||
if make ${flash_command} FLASH_DEVICE="${device}"; then
|
|
||||||
ok_msg "Flashing successfull!"
|
|
||||||
else
|
|
||||||
warn_msg "Flashing failed!"
|
|
||||||
warn_msg "Please read the console output above!"
|
|
||||||
fi
|
|
||||||
|
|
||||||
do_action_service "start" "klipper"
|
|
||||||
}
|
|
||||||
|
|
||||||
function start_flash_sd() {
|
|
||||||
local i=0 board_list=() device=${1}
|
|
||||||
local flash_script="${KLIPPER_DIR}/scripts/flash-sdcard.sh"
|
|
||||||
|
|
||||||
### write each supported board to the array to make it selectable
|
|
||||||
for board in $("${flash_script}" -l | tail -n +2); do
|
|
||||||
board_list+=("${board}")
|
|
||||||
done
|
|
||||||
|
|
||||||
top_border
|
|
||||||
echo -e "| Please select the type of board that corresponds to |"
|
|
||||||
echo -e "| the currently selected MCU ID you chose before. |"
|
|
||||||
blank_line
|
|
||||||
echo -e "| The following boards are currently supported: |"
|
|
||||||
hr
|
|
||||||
### display all supported boards to the user
|
|
||||||
for board in "${board_list[@]}"; do
|
|
||||||
if [[ ${i} -lt 10 ]]; then
|
|
||||||
printf "| ${i}) %-50s|\n" "${board_list[${i}]}"
|
|
||||||
else
|
|
||||||
printf "| ${i}) %-49s|\n" "${board_list[${i}]}"
|
|
||||||
fi
|
|
||||||
i=$(( i + 1 ))
|
|
||||||
done
|
|
||||||
quit_footer
|
|
||||||
|
|
||||||
### make the user select one of the boards
|
|
||||||
local choice
|
|
||||||
while true; do
|
|
||||||
read -p "${cyan}###### Please select board type:${white} " choice
|
|
||||||
if [[ ${choice} = "q" || ${choice} = "Q" ]]; then
|
|
||||||
clear && advanced_menu && break
|
|
||||||
elif [[ ${choice} -le ${#board_list[@]} ]]; then
|
|
||||||
local selected_board="${board_list[${choice}]}"
|
|
||||||
break
|
|
||||||
else
|
|
||||||
clear && print_header
|
|
||||||
error_msg "Invalid choice!"
|
|
||||||
flash_mcu_sd
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
|
|
||||||
while true; do
|
|
||||||
echo
|
|
||||||
top_border
|
|
||||||
echo -e "| If your board is flashed with firmware that connects |"
|
|
||||||
echo -e "| at a custom baud rate, please change it now. |"
|
|
||||||
blank_line
|
|
||||||
echo -e "| If you are unsure, stick to the default 250000! |"
|
|
||||||
bottom_border
|
|
||||||
|
|
||||||
local baud_rate regex="^[0-9]+$"
|
|
||||||
echo -e "${cyan}###### Please set the baud rate:${white} "
|
|
||||||
while [[ ! ${baud_rate} =~ ${regex} ]]; do
|
|
||||||
read -e -i "250000" -e baud_rate
|
|
||||||
local selected_baud_rate=${baud_rate}
|
|
||||||
break
|
|
||||||
done
|
|
||||||
break
|
|
||||||
done
|
|
||||||
|
|
||||||
###flash process
|
|
||||||
do_action_service "stop" "klipper"
|
|
||||||
if "${flash_script}" -b "${selected_baud_rate}" "${device}" "${selected_board}"; then
|
|
||||||
print_confirm "Flashing successfull!"
|
|
||||||
log_info "Flash successfull!"
|
|
||||||
else
|
|
||||||
print_error "Flashing failed!\n Please read the console output above!"
|
|
||||||
log_error "Flash failed!"
|
|
||||||
fi
|
|
||||||
do_action_service "start" "klipper"
|
|
||||||
}
|
|
||||||
|
|
||||||
function build_fw() {
|
|
||||||
local python_version
|
|
||||||
|
|
||||||
if [[ ! -d ${KLIPPER_DIR} || ! -d ${KLIPPY_ENV} ]]; then
|
|
||||||
print_error "Klipper not found!\n Cannot build firmware without Klipper!"
|
|
||||||
return
|
|
||||||
fi
|
|
||||||
|
|
||||||
python_version=$(get_klipper_python_ver)
|
|
||||||
|
|
||||||
cd "${KLIPPER_DIR}"
|
|
||||||
status_msg "Initializing firmware build ..."
|
|
||||||
local dep=(build-essential dpkg-dev make)
|
|
||||||
dependency_check "${dep[@]}"
|
|
||||||
|
|
||||||
make clean
|
|
||||||
|
|
||||||
status_msg "Building firmware ..."
|
|
||||||
if (( python_version == 3 )); then
|
|
||||||
make PYTHON=python3 menuconfig
|
|
||||||
make PYTHON=python3
|
|
||||||
elif (( python_version == 2 )); then
|
|
||||||
make PYTHON=python2 menuconfig
|
|
||||||
make PYTHON=python2
|
|
||||||
else
|
|
||||||
warn_msg "Error reading Python version!"
|
|
||||||
return 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
ok_msg "Firmware built!"
|
|
||||||
}
|
|
||||||
|
|
||||||
#================================================#
|
|
||||||
#=================== HELPERS ====================#
|
|
||||||
#================================================#
|
|
||||||
|
|
||||||
function get_usb_id() {
|
|
||||||
unset mcu_list
|
|
||||||
sleep 1
|
|
||||||
mcus=$(find /dev/serial/by-id/* 2>/dev/null)
|
|
||||||
|
|
||||||
for mcu in ${mcus}; do
|
|
||||||
mcu_list+=("${mcu}")
|
|
||||||
done
|
|
||||||
}
|
|
||||||
|
|
||||||
function get_uart_id() {
|
|
||||||
unset mcu_list
|
|
||||||
sleep 1
|
|
||||||
mcus=$(find /dev -maxdepth 1 -regextype posix-extended -regex "^\/dev\/tty(AMA0|S0)$" 2>/dev/null)
|
|
||||||
|
|
||||||
for mcu in ${mcus}; do
|
|
||||||
mcu_list+=("${mcu}")
|
|
||||||
done
|
|
||||||
}
|
|
||||||
|
|
||||||
function get_dfu_id() {
|
|
||||||
unset mcu_list
|
|
||||||
sleep 1
|
|
||||||
mcus=$(lsusb | grep "DFU" | cut -d " " -f 6 2>/dev/null)
|
|
||||||
|
|
||||||
for mcu in ${mcus}; do
|
|
||||||
mcu_list+=("${mcu}")
|
|
||||||
done
|
|
||||||
}
|
|
||||||
|
|
||||||
function show_flash_method_help() {
|
|
||||||
top_border
|
|
||||||
echo -e "| ~~~~~~~~ < ? > Help: Flash MCU < ? > ~~~~~~~~ |"
|
|
||||||
hr
|
|
||||||
echo -e "| ${cyan}Regular flashing method:${white} |"
|
|
||||||
echo -e "| The default method to flash controller boards which |"
|
|
||||||
echo -e "| are connected and updated over USB and not by placing |"
|
|
||||||
echo -e "| a compiled firmware file onto an internal SD-Card. |"
|
|
||||||
blank_line
|
|
||||||
echo -e "| Common controllers that get flashed that way are: |"
|
|
||||||
echo -e "| - Arduino Mega 2560 |"
|
|
||||||
echo -e "| - Fysetc F6 / S6 (used without a Display + SD-Slot) |"
|
|
||||||
blank_line
|
|
||||||
echo -e "| ${cyan}Updating via SD-Card Update:${white} |"
|
|
||||||
echo -e "| Many popular controller boards ship with a bootloader |"
|
|
||||||
echo -e "| capable of updating the firmware via SD-Card. |"
|
|
||||||
echo -e "| Choose this method if your controller board supports |"
|
|
||||||
echo -e "| this way of updating. This method ONLY works for up- |"
|
|
||||||
echo -e "| grading firmware. The initial flashing procedure must |"
|
|
||||||
echo -e "| be done manually per the instructions that apply to |"
|
|
||||||
echo -e "| your controller board. |"
|
|
||||||
blank_line
|
|
||||||
echo -e "| Common controllers that can be flashed that way are: |"
|
|
||||||
echo -e "| - BigTreeTech SKR 1.3 / 1.4 (Turbo) / E3 / Mini E3 |"
|
|
||||||
echo -e "| - Fysetc F6 / S6 (used with a Display + SD-Slot) |"
|
|
||||||
echo -e "| - Fysetc Spider |"
|
|
||||||
blank_line
|
|
||||||
back_footer
|
|
||||||
|
|
||||||
local choice
|
|
||||||
while true; do
|
|
||||||
read -p "${cyan}###### Please select:${white} " choice
|
|
||||||
case "${choice}" in
|
|
||||||
B|b)
|
|
||||||
clear && print_header
|
|
||||||
init_flash_process
|
|
||||||
break;;
|
|
||||||
*)
|
|
||||||
error_msg "Invalid command!";;
|
|
||||||
esac
|
|
||||||
done
|
|
||||||
}
|
|
||||||
|
|
||||||
function show_mcu_flash_command_help() {
|
|
||||||
top_border
|
|
||||||
echo -e "| ~~~~~~~~ < ? > Help: Flash MCU < ? > ~~~~~~~~ |"
|
|
||||||
hr
|
|
||||||
echo -e "| ${cyan}make flash:${white} |"
|
|
||||||
echo -e "| The default command to flash controller board, it |"
|
|
||||||
echo -e "| will detect selected microcontroller and use suitable |"
|
|
||||||
echo -e "| tool for flashing it. |"
|
|
||||||
blank_line
|
|
||||||
echo -e "| ${cyan}make serialflash:${white} |"
|
|
||||||
echo -e "| Special command to flash STM32 microcontrollers in |"
|
|
||||||
echo -e "| DFU mode but connected via serial. stm32flash command |"
|
|
||||||
echo -e "| will be used internally. |"
|
|
||||||
blank_line
|
|
||||||
back_footer
|
|
||||||
|
|
||||||
local choice
|
|
||||||
while true; do
|
|
||||||
read -p "${cyan}###### Please select:${white} " choice
|
|
||||||
case "${choice}" in
|
|
||||||
B|b)
|
|
||||||
clear && print_header
|
|
||||||
select_flash_command
|
|
||||||
break;;
|
|
||||||
*)
|
|
||||||
error_msg "Invalid command!";;
|
|
||||||
esac
|
|
||||||
done
|
|
||||||
}
|
|
||||||
|
|
||||||
function show_mcu_connection_help() {
|
|
||||||
top_border
|
|
||||||
echo -e "| ~~~~~~~~ < ? > Help: Flash MCU < ? > ~~~~~~~~ |"
|
|
||||||
hr
|
|
||||||
echo -e "| ${cyan}USB:${white} |"
|
|
||||||
echo -e "| Selecting USB as the connection method will scan the |"
|
|
||||||
echo -e "| USB ports for connected controller boards. This will |"
|
|
||||||
echo -e "| be similar to the 'ls /dev/serial/by-id/*' command |"
|
|
||||||
echo -e "| suggested by the official Klipper documentation for |"
|
|
||||||
echo -e "| determining successfull USB connections! |"
|
|
||||||
blank_line
|
|
||||||
echo -e "| ${cyan}UART:${white} |"
|
|
||||||
echo -e "| Selecting UART as the connection method will list all |"
|
|
||||||
echo -e "| possible UART serial ports. Note: This method ALWAYS |"
|
|
||||||
echo -e "| returns something as it seems impossible to determine |"
|
|
||||||
echo -e "| if a valid Klipper controller board is connected or |"
|
|
||||||
echo -e "| not. Because of that, you ${red}MUST${white} know which UART serial |"
|
|
||||||
echo -e "| port your controller board is connected to when using |"
|
|
||||||
echo -e "| this connection method. |"
|
|
||||||
blank_line
|
|
||||||
back_footer
|
|
||||||
|
|
||||||
local choice
|
|
||||||
while true; do
|
|
||||||
read -p "${cyan}###### Please select:${white} " choice
|
|
||||||
case "${choice}" in
|
|
||||||
B|b)
|
|
||||||
clear && print_header
|
|
||||||
select_mcu_connection
|
|
||||||
break;;
|
|
||||||
*)
|
|
||||||
error_msg "Invalid command!";;
|
|
||||||
esac
|
|
||||||
done
|
|
||||||
}
|
|
||||||
@@ -1,510 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
|
|
||||||
#=======================================================================#
|
|
||||||
# Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com> #
|
|
||||||
# #
|
|
||||||
# This file is part of KIAUH - Klipper Installation And Update Helper #
|
|
||||||
# https://github.com/dw-0/kiauh #
|
|
||||||
# #
|
|
||||||
# This file may be distributed under the terms of the GNU GPLv3 license #
|
|
||||||
#=======================================================================#
|
|
||||||
|
|
||||||
set -e
|
|
||||||
|
|
||||||
#===================================================#
|
|
||||||
#================== INSTALL FLUIDD =================#
|
|
||||||
#===================================================#
|
|
||||||
|
|
||||||
function install_fluidd() {
|
|
||||||
if [[ -z $(moonraker_systemd) ]]; then
|
|
||||||
local error="Moonraker not installed! It's recommended to install Moonraker first!"
|
|
||||||
print_error "${error}"
|
|
||||||
while true; do
|
|
||||||
local yn
|
|
||||||
read -p "${cyan}###### Proceed to install Fluidd without installing Moonraker? (y/N):${white} " yn
|
|
||||||
case "${yn}" in
|
|
||||||
Y|y|Yes|yes)
|
|
||||||
select_msg "Yes"
|
|
||||||
break;;
|
|
||||||
N|n|No|no|"")
|
|
||||||
select_msg "No"
|
|
||||||
abort_msg "Exiting Fluidd setup ...\n"
|
|
||||||
return;;
|
|
||||||
*)
|
|
||||||
error_msg "Invalid Input!";;
|
|
||||||
esac
|
|
||||||
done
|
|
||||||
fi
|
|
||||||
|
|
||||||
### checking dependencies
|
|
||||||
local dep=(wget nginx unzip)
|
|
||||||
dependency_check "${dep[@]}"
|
|
||||||
### detect conflicting Haproxy and Apache2 installations
|
|
||||||
detect_conflicting_packages
|
|
||||||
|
|
||||||
status_msg "Initializing Fluidd installation ..."
|
|
||||||
### first, we create a backup of the full klipper_config dir - safety first!
|
|
||||||
backup_config_dir
|
|
||||||
|
|
||||||
### check for other enabled web interfaces
|
|
||||||
unset SET_LISTEN_PORT
|
|
||||||
detect_enabled_sites
|
|
||||||
|
|
||||||
### check if another site already listens to port 80
|
|
||||||
fluidd_port_check
|
|
||||||
|
|
||||||
### download fluidd
|
|
||||||
download_fluidd
|
|
||||||
|
|
||||||
### ask user to install the recommended webinterface macros
|
|
||||||
install_fluidd_macros
|
|
||||||
|
|
||||||
### create /etc/nginx/conf.d/upstreams.conf
|
|
||||||
set_upstream_nginx_cfg
|
|
||||||
### create /etc/nginx/sites-available/<interface config>
|
|
||||||
set_nginx_cfg "fluidd"
|
|
||||||
### nginx on ubuntu 21 and above needs special permissions to access the files
|
|
||||||
set_nginx_permissions
|
|
||||||
|
|
||||||
### symlink nginx log
|
|
||||||
symlink_webui_nginx_log "fluidd"
|
|
||||||
|
|
||||||
### add fluidd to the update manager in moonraker.conf
|
|
||||||
patch_fluidd_update_manager
|
|
||||||
|
|
||||||
fetch_webui_ports #WIP
|
|
||||||
|
|
||||||
### confirm message
|
|
||||||
print_confirm "Fluidd has been set up!"
|
|
||||||
}
|
|
||||||
|
|
||||||
function install_fluidd_macros() {
|
|
||||||
local yn
|
|
||||||
while true; do
|
|
||||||
echo
|
|
||||||
top_border
|
|
||||||
echo -e "| It is recommended to use special macros in order to |"
|
|
||||||
echo -e "| have Fluidd fully functional and working. |"
|
|
||||||
blank_line
|
|
||||||
echo -e "| The recommended macros for Fluidd can be found here: |"
|
|
||||||
echo -e "| https://github.com/fluidd-core/fluidd-config |"
|
|
||||||
blank_line
|
|
||||||
echo -e "| If you already use these macros skip this step. |"
|
|
||||||
echo -e "| Otherwise you should consider to answer with 'yes' to |"
|
|
||||||
echo -e "| download the recommended macros. |"
|
|
||||||
bottom_border
|
|
||||||
read -p "${cyan}###### Download the recommended macros? (Y/n):${white} " yn
|
|
||||||
case "${yn}" in
|
|
||||||
Y|y|Yes|yes|"")
|
|
||||||
select_msg "Yes"
|
|
||||||
download_fluidd_macros
|
|
||||||
break;;
|
|
||||||
N|n|No|no)
|
|
||||||
select_msg "No"
|
|
||||||
break;;
|
|
||||||
*)
|
|
||||||
print_error "Invalid command!";;
|
|
||||||
esac
|
|
||||||
done
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
function download_fluidd_macros() {
|
|
||||||
local ms_cfg_repo path configs regex line gcode_dir
|
|
||||||
|
|
||||||
ms_cfg_repo="https://github.com/fluidd-core/fluidd-config.git"
|
|
||||||
regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/config\/printer\.cfg"
|
|
||||||
configs=$(find "${HOME}" -maxdepth 3 -regextype posix-extended -regex "${regex}" | sort)
|
|
||||||
|
|
||||||
if [[ -z ${configs} ]]; then
|
|
||||||
print_error "No printer.cfg found! Installation of Macros will be skipped ..."
|
|
||||||
log_error "execution stopped! reason: no printer.cfg found"
|
|
||||||
return
|
|
||||||
fi
|
|
||||||
|
|
||||||
status_msg "Cloning fluidd-config ..."
|
|
||||||
[[ -d "${HOME}/fluidd-config" ]] && rm -rf "${HOME}/fluidd-config"
|
|
||||||
if git clone --recurse-submodules "${ms_cfg_repo}" "${HOME}/fluidd-config"; then
|
|
||||||
for config in ${configs}; do
|
|
||||||
path=$(echo "${config}" | rev | cut -d"/" -f2- | rev)
|
|
||||||
|
|
||||||
if [[ -e "${path}/fluidd.cfg" && ! -h "${path}/fluidd.cfg" ]]; then
|
|
||||||
warn_msg "Attention! Existing fluidd.cfg detected!"
|
|
||||||
warn_msg "The file will be renamed to 'fluidd.bak.cfg' to be able to continue with the installation."
|
|
||||||
if ! mv "${path}/fluidd.cfg" "${path}/fluidd.bak.cfg"; then
|
|
||||||
error_msg "Renaming fluidd.cfg failed! Aborting installation ..."
|
|
||||||
return
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [[ -h "${path}/fluidd.cfg" ]]; then
|
|
||||||
warn_msg "Recreating symlink in ${path} ..."
|
|
||||||
rm -rf "${path}/fluidd.cfg"
|
|
||||||
fi
|
|
||||||
|
|
||||||
if ! ln -sf "${HOME}/fluidd-config/client.cfg" "${path}/fluidd.cfg"; then
|
|
||||||
error_msg "Creating symlink failed! Aborting installation ..."
|
|
||||||
return
|
|
||||||
fi
|
|
||||||
|
|
||||||
if ! grep -Eq "^\[include fluidd.cfg\]$" "${path}/printer.cfg"; then
|
|
||||||
log_info "${path}/printer.cfg"
|
|
||||||
sed -i "1 i [include fluidd.cfg]" "${path}/printer.cfg"
|
|
||||||
fi
|
|
||||||
|
|
||||||
line=$(($(grep -n "\[include fluidd.cfg\]" "${path}/printer.cfg" | tail -1 | cut -d: -f1) + 1))
|
|
||||||
gcode_dir=${path/config/gcodes}
|
|
||||||
if ! grep -Eq "^\[virtual_sdcard\]$" "${path}/printer.cfg"; then
|
|
||||||
log_info "${path}/printer.cfg"
|
|
||||||
sed -i "${line} i \[virtual_sdcard]\npath: ${gcode_dir}\non_error_gcode: CANCEL_PRINT\n" "${path}/printer.cfg"
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
else
|
|
||||||
print_error "Cloning failed! Aborting installation ..."
|
|
||||||
log_error "execution stopped! reason: cloning failed"
|
|
||||||
return
|
|
||||||
fi
|
|
||||||
|
|
||||||
patch_fluidd_config_update_manager
|
|
||||||
|
|
||||||
ok_msg "Done!"
|
|
||||||
}
|
|
||||||
|
|
||||||
function download_fluidd() {
|
|
||||||
local url
|
|
||||||
url=$(get_fluidd_download_url)
|
|
||||||
|
|
||||||
status_msg "Downloading Fluidd from ${url} ..."
|
|
||||||
|
|
||||||
if [[ -d ${FLUIDD_DIR} ]]; then
|
|
||||||
rm -rf "${FLUIDD_DIR}"
|
|
||||||
fi
|
|
||||||
|
|
||||||
mkdir "${FLUIDD_DIR}" && cd "${FLUIDD_DIR}"
|
|
||||||
|
|
||||||
if wget "${url}"; then
|
|
||||||
ok_msg "Download complete!"
|
|
||||||
status_msg "Extracting archive ..."
|
|
||||||
unzip -q -o ./*.zip && ok_msg "Done!"
|
|
||||||
status_msg "Remove downloaded archive ..."
|
|
||||||
rm -rf ./*.zip && ok_msg "Done!"
|
|
||||||
else
|
|
||||||
print_error "Downloading Fluidd from\n ${url}\n failed!"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
#===================================================#
|
|
||||||
#================== REMOVE FLUIDD ==================#
|
|
||||||
#===================================================#
|
|
||||||
|
|
||||||
function remove_fluidd_dir() {
|
|
||||||
[[ ! -d ${FLUIDD_DIR} ]] && return
|
|
||||||
|
|
||||||
status_msg "Removing Fluidd directory ..."
|
|
||||||
rm -rf "${FLUIDD_DIR}" && ok_msg "Directory removed!"
|
|
||||||
}
|
|
||||||
|
|
||||||
function remove_fluidd_nginx_config() {
|
|
||||||
if [[ -e "/etc/nginx/sites-available/fluidd" ]]; then
|
|
||||||
status_msg "Removing Fluidd configuration for Nginx ..."
|
|
||||||
sudo rm "/etc/nginx/sites-available/fluidd" && ok_msg "File removed!"
|
|
||||||
fi
|
|
||||||
if [[ -L "/etc/nginx/sites-enabled/fluidd" ]]; then
|
|
||||||
status_msg "Removing Fluidd Symlink for Nginx ..."
|
|
||||||
sudo rm "/etc/nginx/sites-enabled/fluidd" && ok_msg "File removed!"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
function remove_fluidd_logs() {
|
|
||||||
local files
|
|
||||||
files=$(find /var/log/nginx -name "fluidd*" 2> /dev/null | sort)
|
|
||||||
|
|
||||||
if [[ -n ${files} ]]; then
|
|
||||||
for file in ${files}; do
|
|
||||||
status_msg "Removing ${file} ..."
|
|
||||||
sudo rm -f "${file}"
|
|
||||||
ok_msg "${file} removed!"
|
|
||||||
done
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
function remove_fluidd_log_symlinks() {
|
|
||||||
local files regex
|
|
||||||
|
|
||||||
regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/logs\/fluidd-.*"
|
|
||||||
files=$(find "${HOME}" -maxdepth 3 -regextype posix-extended -regex "${regex}" 2> /dev/null | sort)
|
|
||||||
|
|
||||||
if [[ -n ${files} ]]; then
|
|
||||||
for file in ${files}; do
|
|
||||||
status_msg "Removing ${file} ..."
|
|
||||||
rm -f "${file}"
|
|
||||||
ok_msg "${file} removed!"
|
|
||||||
done
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
function remove_legacy_fluidd_log_symlinks() {
|
|
||||||
local files
|
|
||||||
files=$(find "${HOME}/klipper_logs" -name "fluidd*" 2> /dev/null | sort)
|
|
||||||
|
|
||||||
if [[ -n ${files} ]]; then
|
|
||||||
for file in ${files}; do
|
|
||||||
status_msg "Removing ${file} ..."
|
|
||||||
rm -f "${file}"
|
|
||||||
ok_msg "${file} removed!"
|
|
||||||
done
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
function remove_fluidd_config() {
|
|
||||||
if [[ -d "${HOME}/fluidd-config" ]]; then
|
|
||||||
status_msg "Removing ${HOME}/fluidd-config ..."
|
|
||||||
rm -rf "${HOME}/fluidd-config"
|
|
||||||
ok_msg "${HOME}/fluidd-config removed!"
|
|
||||||
print_confirm "Fluidd-Config successfully removed!"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
function remove_fluidd() {
|
|
||||||
remove_fluidd_dir
|
|
||||||
remove_fluidd_nginx_config
|
|
||||||
remove_fluidd_logs
|
|
||||||
remove_fluidd_log_symlinks
|
|
||||||
remove_legacy_fluidd_log_symlinks
|
|
||||||
|
|
||||||
### remove fluidd_port from ~/.kiauh.ini
|
|
||||||
sed -i "/^fluidd_port=/d" "${INI_FILE}"
|
|
||||||
|
|
||||||
print_confirm "Fluidd successfully removed!"
|
|
||||||
}
|
|
||||||
|
|
||||||
#===================================================#
|
|
||||||
#================== UPDATE FLUIDD ==================#
|
|
||||||
#===================================================#
|
|
||||||
|
|
||||||
function update_fluidd() {
|
|
||||||
backup_before_update "fluidd"
|
|
||||||
status_msg "Updating Fluidd ..."
|
|
||||||
download_fluidd
|
|
||||||
match_nginx_configs
|
|
||||||
symlink_webui_nginx_log "fluidd"
|
|
||||||
print_confirm "Fluidd successfully updated!"
|
|
||||||
}
|
|
||||||
|
|
||||||
#===================================================#
|
|
||||||
#================== FLUIDD STATUS ==================#
|
|
||||||
#===================================================#
|
|
||||||
|
|
||||||
function get_fluidd_status() {
|
|
||||||
local status
|
|
||||||
local data_arr=("${FLUIDD_DIR}" "${NGINX_SA}/fluidd" "${NGINX_SE}/fluidd")
|
|
||||||
|
|
||||||
### count+1 for each found data-item from array
|
|
||||||
local filecount=0
|
|
||||||
for data in "${data_arr[@]}"; do
|
|
||||||
[[ -e ${data} ]] && filecount=$(( filecount + 1 ))
|
|
||||||
done
|
|
||||||
|
|
||||||
if (( filecount == ${#data_arr[*]} )); then
|
|
||||||
status="Installed!"
|
|
||||||
elif (( filecount == 0 )); then
|
|
||||||
status="Not installed!"
|
|
||||||
else
|
|
||||||
status="Incomplete!"
|
|
||||||
fi
|
|
||||||
echo "${status}"
|
|
||||||
}
|
|
||||||
|
|
||||||
function get_local_fluidd_version() {
|
|
||||||
local versionfile="${FLUIDD_DIR}/.version"
|
|
||||||
local relinfofile="${FLUIDD_DIR}/release_info.json"
|
|
||||||
local version
|
|
||||||
|
|
||||||
if [[ -f ${relinfofile} ]]; then
|
|
||||||
version=$(grep -o '"version":"[^"]*' "${relinfofile}" | grep -o '[^"]*$')
|
|
||||||
elif [[ -f ${versionfile} ]]; then
|
|
||||||
version=$(head -n 1 "${versionfile}")
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo "${version}"
|
|
||||||
}
|
|
||||||
|
|
||||||
function get_remote_fluidd_version() {
|
|
||||||
[[ ! $(dpkg-query -f'${Status}' --show curl 2>/dev/null) = *\ installed ]] && return
|
|
||||||
|
|
||||||
local tags
|
|
||||||
tags=$(curl -s "https://api.github.com/repos/fluidd-core/fluidd/tags" | grep "name" | cut -d'"' -f4)
|
|
||||||
echo "${tags}" | head -1
|
|
||||||
}
|
|
||||||
|
|
||||||
function compare_fluidd_versions() {
|
|
||||||
local versions local_ver remote_ver
|
|
||||||
local_ver="$(get_local_fluidd_version)"
|
|
||||||
remote_ver="$(get_remote_fluidd_version)"
|
|
||||||
|
|
||||||
if [[ ${local_ver} != "${remote_ver}" && ${local_ver} != "" ]]; then
|
|
||||||
versions="${yellow}$(printf " %-14s" "${local_ver}")${white}"
|
|
||||||
versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
|
|
||||||
# add moonraker to application_updates_available in kiauh.ini
|
|
||||||
add_to_application_updates "fluidd"
|
|
||||||
else
|
|
||||||
versions="${green}$(printf " %-14s" "${local_ver}")${white}"
|
|
||||||
versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo "${versions}"
|
|
||||||
}
|
|
||||||
|
|
||||||
#================================================#
|
|
||||||
#=================== HELPERS ====================#
|
|
||||||
#================================================#
|
|
||||||
|
|
||||||
function get_fluidd_download_url() {
|
|
||||||
local releases_by_tag tags tag unstable_url url
|
|
||||||
|
|
||||||
### latest stable download url
|
|
||||||
url="https://github.com/fluidd-core/fluidd/releases/latest/download/fluidd.zip"
|
|
||||||
|
|
||||||
read_kiauh_ini "${FUNCNAME[0]}"
|
|
||||||
if [[ ${fluidd_install_unstable} == "true" ]]; then
|
|
||||||
releases_by_tag="https://api.github.com/repos/fluidd-core/fluidd/tags"
|
|
||||||
tags=$(curl -s "${releases_by_tag}" | grep "name" | cut -d'"' -f4)
|
|
||||||
tag=$(echo "${tags}" | head -1)
|
|
||||||
|
|
||||||
### latest unstable download url including pre-releases (alpha, beta, rc)
|
|
||||||
unstable_url="https://github.com/fluidd-core/fluidd/releases/download/${tag}/fluidd.zip"
|
|
||||||
|
|
||||||
if [[ ${unstable_url} == *"download//"* ]]; then
|
|
||||||
warn_msg "Download URL broken! Falling back to URL of latest stable release!"
|
|
||||||
else
|
|
||||||
url=${unstable_url}
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo "${url}"
|
|
||||||
}
|
|
||||||
|
|
||||||
function fluidd_port_check() {
|
|
||||||
if [[ ${FLUIDD_ENABLED} == "false" ]]; then
|
|
||||||
|
|
||||||
if [[ ${SITE_ENABLED} == "true" ]]; then
|
|
||||||
status_msg "Detected other enabled interfaces:"
|
|
||||||
|
|
||||||
[[ ${MAINSAIL_ENABLED} == "true" ]] && \
|
|
||||||
echo " ${cyan}● Mainsail - Port: ${MAINSAIL_PORT}${white}"
|
|
||||||
|
|
||||||
if [[ ${MAINSAIL_PORT} == "80" ]]; then
|
|
||||||
PORT_80_BLOCKED="true"
|
|
||||||
select_fluidd_port
|
|
||||||
fi
|
|
||||||
else
|
|
||||||
DEFAULT_PORT=$(grep listen "${KIAUH_SRCDIR}/resources/fluidd" | head -1 | sed 's/^\s*//' | cut -d" " -f2 | cut -d";" -f1)
|
|
||||||
SET_LISTEN_PORT=${DEFAULT_PORT}
|
|
||||||
fi
|
|
||||||
SET_NGINX_CFG="true"
|
|
||||||
|
|
||||||
else
|
|
||||||
SET_NGINX_CFG="false"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
function select_fluidd_port() {
|
|
||||||
if [[ ${PORT_80_BLOCKED} == "true" ]]; then
|
|
||||||
echo
|
|
||||||
top_border
|
|
||||||
echo -e "| ${red}!!!WARNING!!!${white} |"
|
|
||||||
echo -e "| ${red}You need to choose a different port for Fluidd!${white} |"
|
|
||||||
echo -e "| ${red}The following web interface is listening at port 80:${white} |"
|
|
||||||
blank_line
|
|
||||||
[[ ${MAINSAIL_PORT} == "80" ]] && echo "| ● Mainsail |"
|
|
||||||
blank_line
|
|
||||||
echo -e "| Make sure you don't choose a port which was already |"
|
|
||||||
echo -e "| assigned to another webinterface! |"
|
|
||||||
blank_line
|
|
||||||
echo -e "| Be aware: there is ${red}NO${white} sanity check for the following |"
|
|
||||||
echo -e "| input. So make sure to choose a valid port! |"
|
|
||||||
bottom_border
|
|
||||||
|
|
||||||
local new_port re="^[0-9]+$"
|
|
||||||
while true; do
|
|
||||||
read -p "${cyan}Please enter a new Port:${white} " new_port
|
|
||||||
if [[ ${new_port} =~ ${re} && ${new_port} != "${MAINSAIL_PORT}" ]]; then
|
|
||||||
select_msg "Setting port ${new_port} for Fluidd!"
|
|
||||||
SET_LISTEN_PORT=${new_port}
|
|
||||||
break
|
|
||||||
else
|
|
||||||
if [[ ! ${new_port} =~ ${re} ]]; then
|
|
||||||
error_msg "Invalid input!"
|
|
||||||
else
|
|
||||||
error_msg "Port already taken! Select a different one!"
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
function patch_fluidd_update_manager() {
|
|
||||||
local patched moonraker_configs regex
|
|
||||||
regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/config\/moonraker\.conf"
|
|
||||||
moonraker_configs=$(find "${HOME}" -maxdepth 3 -type f -regextype posix-extended -regex "${regex}" | sort)
|
|
||||||
|
|
||||||
patched="false"
|
|
||||||
for conf in ${moonraker_configs}; do
|
|
||||||
if ! grep -Eq "^\[update_manager fluidd\]\s*$" "${conf}"; then
|
|
||||||
### add new line to conf if it doesn't end with one
|
|
||||||
[[ $(tail -c1 "${conf}" | wc -l) -eq 0 ]] && echo "" >> "${conf}"
|
|
||||||
|
|
||||||
### add Fluidds update manager section to moonraker.conf
|
|
||||||
status_msg "Adding Fluidd to update manager in file:\n ${conf}"
|
|
||||||
/bin/sh -c "cat >> ${conf}" << MOONRAKER_CONF
|
|
||||||
|
|
||||||
[update_manager fluidd]
|
|
||||||
type: web
|
|
||||||
channel: stable
|
|
||||||
repo: fluidd-core/fluidd
|
|
||||||
path: ~/fluidd
|
|
||||||
MOONRAKER_CONF
|
|
||||||
|
|
||||||
fi
|
|
||||||
|
|
||||||
patched="true"
|
|
||||||
done
|
|
||||||
|
|
||||||
if [[ ${patched} == "true" ]]; then
|
|
||||||
do_action_service "restart" "moonraker"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
function patch_fluidd_config_update_manager() {
|
|
||||||
local patched moonraker_configs regex
|
|
||||||
regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/config\/moonraker\.conf"
|
|
||||||
moonraker_configs=$(find "${HOME}" -maxdepth 3 -type f -regextype posix-extended -regex "${regex}" | sort)
|
|
||||||
|
|
||||||
patched="false"
|
|
||||||
for conf in ${moonraker_configs}; do
|
|
||||||
if ! grep -Eq "^\[update_manager fluidd-config\]\s*$" "${conf}"; then
|
|
||||||
### add new line to conf if it doesn't end with one
|
|
||||||
[[ $(tail -c1 "${conf}" | wc -l) -eq 0 ]] && echo "" >> "${conf}"
|
|
||||||
|
|
||||||
### add Fluidds update manager section to moonraker.conf
|
|
||||||
status_msg "Adding Fluidd-Config to update manager in file:\n ${conf}"
|
|
||||||
/bin/sh -c "cat >> ${conf}" << MOONRAKER_CONF
|
|
||||||
|
|
||||||
[update_manager fluidd-config]
|
|
||||||
type: git_repo
|
|
||||||
primary_branch: master
|
|
||||||
path: ~/fluidd-config
|
|
||||||
origin: https://github.com/fluidd-core/fluidd-config.git
|
|
||||||
managed_services: klipper
|
|
||||||
MOONRAKER_CONF
|
|
||||||
|
|
||||||
fi
|
|
||||||
|
|
||||||
patched="true"
|
|
||||||
done
|
|
||||||
|
|
||||||
if [[ ${patched} == "true" ]]; then
|
|
||||||
do_action_service "restart" "moonraker"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
@@ -1,123 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
|
|
||||||
#=======================================================================#
|
|
||||||
# Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com> #
|
|
||||||
# #
|
|
||||||
# This file is part of KIAUH - Klipper Installation And Update Helper #
|
|
||||||
# https://github.com/dw-0/kiauh #
|
|
||||||
# #
|
|
||||||
# This file may be distributed under the terms of the GNU GPLv3 license #
|
|
||||||
#=======================================================================#
|
|
||||||
|
|
||||||
set -e
|
|
||||||
|
|
||||||
#=================================================#
|
|
||||||
#======== INSTALL GCODE_SHELL_COMMAND.PY =========#
|
|
||||||
#=================================================#
|
|
||||||
|
|
||||||
function setup_gcode_shell_command() {
|
|
||||||
top_border
|
|
||||||
echo -e "| You are about to install the 'G-Code Shell Command' |"
|
|
||||||
echo -e "| extension. Please make sure to read the instructions |"
|
|
||||||
echo -e "| before you continue and remember that potential risks |"
|
|
||||||
echo -e "| can be involved after installing this extension! |"
|
|
||||||
blank_line
|
|
||||||
echo -e "| ${red}You accept that you are doing this on your own risk!${white} |"
|
|
||||||
bottom_border
|
|
||||||
|
|
||||||
local yn
|
|
||||||
while true; do
|
|
||||||
read -p "${cyan}###### Do you want to continue? (Y/n):${white} " yn
|
|
||||||
case "${yn}" in
|
|
||||||
Y|y|Yes|yes|"")
|
|
||||||
select_msg "Yes"
|
|
||||||
|
|
||||||
if [[ ! -d "${KLIPPER_DIR}/klippy/extras" ]]; then
|
|
||||||
print_error "Folder ~/klipper/klippy/extras not found!\n Klipper not installed yet?"
|
|
||||||
return
|
|
||||||
fi
|
|
||||||
|
|
||||||
status_msg "Installing gcode shell command extension ..."
|
|
||||||
|
|
||||||
if [[ ! -f "${KLIPPER_DIR}/klippy/extras/gcode_shell_command.py" ]]; then
|
|
||||||
install_gcode_shell_command
|
|
||||||
else
|
|
||||||
echo; warn_msg "File 'gcode_shell_command.py' already exists in the destination location!"
|
|
||||||
|
|
||||||
while true; do
|
|
||||||
read -p "${cyan}###### Do you want to overwrite it? (Y/n):${white} " yn
|
|
||||||
case "${yn}" in
|
|
||||||
Y|y|Yes|yes|"")
|
|
||||||
select_msg "Yes"
|
|
||||||
rm -f "${KLIPPER_DIR}/klippy/extras/gcode_shell_command.py"
|
|
||||||
install_gcode_shell_command
|
|
||||||
break;;
|
|
||||||
N|n|No|no)
|
|
||||||
select_msg "No"
|
|
||||||
break;;
|
|
||||||
*)
|
|
||||||
error_msg "Invalid Input!";;
|
|
||||||
esac
|
|
||||||
done
|
|
||||||
fi
|
|
||||||
return;;
|
|
||||||
N|n|No|no)
|
|
||||||
select_msg "No"
|
|
||||||
return;;
|
|
||||||
*)
|
|
||||||
error_msg "Invalid Input!";;
|
|
||||||
esac
|
|
||||||
done
|
|
||||||
}
|
|
||||||
|
|
||||||
function install_gcode_shell_command() {
|
|
||||||
do_action_service "stop" "klipper"
|
|
||||||
status_msg "Copy 'gcode_shell_command.py' to '${KLIPPER_DIR}/klippy/extras' ..."
|
|
||||||
|
|
||||||
if cp "${KIAUH_SRCDIR}/resources/gcode_shell_command.py" "${KLIPPER_DIR}/klippy/extras"; then
|
|
||||||
ok_msg "Done!"
|
|
||||||
else
|
|
||||||
error_msg "Cannot copy file to target destination...Exiting!"
|
|
||||||
return 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
local yn
|
|
||||||
while true; do
|
|
||||||
echo
|
|
||||||
read -p "${cyan}###### Create an example shell command? (Y/n):${white} " yn
|
|
||||||
case "${yn}" in
|
|
||||||
Y|y|Yes|yes|"")
|
|
||||||
select_msg "Yes"
|
|
||||||
create_example_shell_command
|
|
||||||
break;;
|
|
||||||
N|n|No|no)
|
|
||||||
select_msg "No"
|
|
||||||
break;;
|
|
||||||
esac
|
|
||||||
done
|
|
||||||
|
|
||||||
do_action_service "restart" "klipper"
|
|
||||||
print_confirm "Shell command extension installed!"
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
function create_example_shell_command() {
|
|
||||||
### create a backup of the config folder
|
|
||||||
backup_config_dir
|
|
||||||
|
|
||||||
local configs regex path
|
|
||||||
regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/config\/printer\.cfg"
|
|
||||||
configs=$(find "${HOME}" -maxdepth 3 -regextype posix-extended -regex "${regex}" | sort)
|
|
||||||
|
|
||||||
for cfg in ${configs}; do
|
|
||||||
path=$(echo "${cfg}" | rev | cut -d"/" -f2- | rev)
|
|
||||||
|
|
||||||
if [[ ! -f "${path}/shell_command.cfg" ]]; then
|
|
||||||
status_msg "Copy shell_command.cfg to ${path} ..."
|
|
||||||
cp "${KIAUH_SRCDIR}/resources/shell_command.cfg" "${path}"
|
|
||||||
ok_msg "${path}/shell_command.cfg created!"
|
|
||||||
### write include to the very first line of the printer.cfg
|
|
||||||
sed -i "1 i [include shell_command.cfg]" "${cfg}"
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
}
|
|
||||||
@@ -1,95 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
|
|
||||||
#=======================================================================#
|
|
||||||
# Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com> #
|
|
||||||
# #
|
|
||||||
# This file is part of KIAUH - Klipper Installation And Update Helper #
|
|
||||||
# https://github.com/dw-0/kiauh #
|
|
||||||
# #
|
|
||||||
# This file may be distributed under the terms of the GNU GPLv3 license #
|
|
||||||
#=======================================================================#
|
|
||||||
|
|
||||||
# shellcheck disable=SC2034
|
|
||||||
set -e
|
|
||||||
|
|
||||||
function set_globals() {
|
|
||||||
#=================== SYSTEM ===================#
|
|
||||||
SYSTEMD="/etc/systemd/system"
|
|
||||||
INITD="/etc/init.d"
|
|
||||||
ETCDEF="/etc/default"
|
|
||||||
|
|
||||||
#=================== KIAUH ====================#
|
|
||||||
green=$(echo -en "\e[92m")
|
|
||||||
yellow=$(echo -en "\e[93m")
|
|
||||||
magenta=$(echo -en "\e[35m")
|
|
||||||
red=$(echo -en "\e[91m")
|
|
||||||
cyan=$(echo -en "\e[96m")
|
|
||||||
white=$(echo -en "\e[39m")
|
|
||||||
INI_FILE="${HOME}/.kiauh.ini"
|
|
||||||
LOGFILE="/tmp/kiauh.log"
|
|
||||||
RESOURCES="${KIAUH_SRCDIR}/resources"
|
|
||||||
BACKUP_DIR="${HOME}/kiauh-backups"
|
|
||||||
|
|
||||||
#================== KLIPPER ===================#
|
|
||||||
KLIPPY_ENV="${HOME}/klippy-env"
|
|
||||||
KLIPPER_DIR="${HOME}/klipper"
|
|
||||||
KLIPPER_REPO="https://github.com/Klipper3d/klipper.git"
|
|
||||||
|
|
||||||
#================= MOONRAKER ==================#
|
|
||||||
MOONRAKER_ENV="${HOME}/moonraker-env"
|
|
||||||
MOONRAKER_DIR="${HOME}/moonraker"
|
|
||||||
MOONRAKER_REPO="https://github.com/Arksine/moonraker.git"
|
|
||||||
|
|
||||||
#================= MAINSAIL ===================#
|
|
||||||
MAINSAIL_DIR="${HOME}/mainsail"
|
|
||||||
|
|
||||||
#================== FLUIDD ====================#
|
|
||||||
FLUIDD_DIR="${HOME}/fluidd"
|
|
||||||
|
|
||||||
#=============== KLIPPERSCREEN ================#
|
|
||||||
KLIPPERSCREEN_ENV="${HOME}/.KlipperScreen-env"
|
|
||||||
KLIPPERSCREEN_DIR="${HOME}/KlipperScreen"
|
|
||||||
KLIPPERSCREEN_REPO="https://github.com/jordanruthe/KlipperScreen.git"
|
|
||||||
|
|
||||||
#========== MOONRAKER-TELEGRAM-BOT ============#
|
|
||||||
TELEGRAM_BOT_ENV="${HOME}/moonraker-telegram-bot-env"
|
|
||||||
TELEGRAM_BOT_DIR="${HOME}/moonraker-telegram-bot"
|
|
||||||
TELEGRAM_BOT_REPO="https://github.com/nlef/moonraker-telegram-bot.git"
|
|
||||||
|
|
||||||
#=============== PRETTY-GCODE =================#
|
|
||||||
PGC_DIR="${HOME}/pgcode"
|
|
||||||
PGC_REPO="https://github.com/Kragrathea/pgcode"
|
|
||||||
|
|
||||||
#================== NGINX =====================#
|
|
||||||
NGINX_SA="/etc/nginx/sites-available"
|
|
||||||
NGINX_SE="/etc/nginx/sites-enabled"
|
|
||||||
NGINX_CONFD="/etc/nginx/conf.d"
|
|
||||||
|
|
||||||
#=============== MOONRAKER-OBICO ================#
|
|
||||||
MOONRAKER_OBICO_DIR="${HOME}/moonraker-obico"
|
|
||||||
MOONRAKER_OBICO_REPO="https://github.com/TheSpaghettiDetective/moonraker-obico.git"
|
|
||||||
|
|
||||||
#=============== OCTOEVERYWHERE ================#
|
|
||||||
OCTOEVERYWHERE_ENV="${HOME}/octoeverywhere-env"
|
|
||||||
OCTOEVERYWHERE_DIR="${HOME}/octoeverywhere"
|
|
||||||
OCTOEVERYWHERE_REPO="https://github.com/QuinnDamerell/OctoPrint-OctoEverywhere.git"
|
|
||||||
|
|
||||||
#=============== Crowsnest ================#
|
|
||||||
CROWSNEST_DIR="${HOME}/crowsnest"
|
|
||||||
CROWSNEST_REPO="https://github.com/mainsail-crew/crowsnest.git"
|
|
||||||
|
|
||||||
#=============== Mobileraker ================#
|
|
||||||
MOBILERAKER_ENV="${HOME}/mobileraker-env"
|
|
||||||
MOBILERAKER_DIR="${HOME}/mobileraker_companion"
|
|
||||||
MOBILERAKER_REPO="https://github.com/Clon1998/mobileraker_companion.git"
|
|
||||||
|
|
||||||
#=============== OCTOAPP ================#
|
|
||||||
OCTOAPP_ENV="${HOME}/octoapp-env"
|
|
||||||
OCTOAPP_DIR="${HOME}/octoapp"
|
|
||||||
OCTOAPP_REPO="https://github.com/crysxd/OctoApp-Plugin.git"
|
|
||||||
|
|
||||||
#=============== Spoolman ================#
|
|
||||||
SPOOLMAN_DIR="${HOME}/Spoolman"
|
|
||||||
SPOOLMAN_DB_DIR="${HOME}/.local/share/spoolman"
|
|
||||||
SPOOLMAN_REPO="https://api.github.com/repos/Donkie/Spoolman/releases/latest"
|
|
||||||
}
|
|
||||||
@@ -1,664 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
|
|
||||||
#=======================================================================#
|
|
||||||
# Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com> #
|
|
||||||
# #
|
|
||||||
# This file is part of KIAUH - Klipper Installation And Update Helper #
|
|
||||||
# https://github.com/dw-0/kiauh #
|
|
||||||
# #
|
|
||||||
# This file may be distributed under the terms of the GNU GPLv3 license #
|
|
||||||
#=======================================================================#
|
|
||||||
|
|
||||||
set -e
|
|
||||||
|
|
||||||
#TODO (multi instance):
|
|
||||||
# if the klipper installer is started another time while other klipper
|
|
||||||
# instances are detected, ask if new instances should be added
|
|
||||||
|
|
||||||
#=================================================#
|
|
||||||
#================ INSTALL KLIPPER ================#
|
|
||||||
#=================================================#
|
|
||||||
|
|
||||||
###
|
|
||||||
# this function detects all installed klipper
|
|
||||||
# systemd instances and returns their absolute path
|
|
||||||
function klipper_systemd() {
|
|
||||||
local services
|
|
||||||
local blacklist
|
|
||||||
local ignore
|
|
||||||
local match
|
|
||||||
|
|
||||||
###
|
|
||||||
# any service that uses "klipper" in its own name but isn't a full klipper service must be blacklisted using
|
|
||||||
# this variable, otherwise they will be falsely recognized as klipper instances. E.g. "klipper-mcu.service"
|
|
||||||
# is not a klipper service, but related to klippers linux mcu, which also requires its own service file, hence
|
|
||||||
# it must be blacklisted.
|
|
||||||
blacklist="mcu"
|
|
||||||
|
|
||||||
ignore="${SYSTEMD}/klipper-(${blacklist}).service"
|
|
||||||
match="${SYSTEMD}/klipper(-[0-9a-zA-Z]+)?.service"
|
|
||||||
|
|
||||||
services=$(find "${SYSTEMD}" -maxdepth 1 -regextype awk ! -regex "${ignore}" -regex "${match}" | sort)
|
|
||||||
echo "${services}"
|
|
||||||
}
|
|
||||||
|
|
||||||
function start_klipper_setup() {
|
|
||||||
local klipper_systemd_services
|
|
||||||
local python_version
|
|
||||||
local instance_count
|
|
||||||
local instance_names
|
|
||||||
local use_custom_names
|
|
||||||
local input
|
|
||||||
local regex
|
|
||||||
local blacklist
|
|
||||||
local error
|
|
||||||
|
|
||||||
status_msg "Initializing Klipper installation ...\n"
|
|
||||||
|
|
||||||
### return early if klipper already exists
|
|
||||||
klipper_systemd_services=$(klipper_systemd)
|
|
||||||
|
|
||||||
if [[ -n ${klipper_systemd_services} ]]; then
|
|
||||||
error="At least one Klipper service is already installed:"
|
|
||||||
|
|
||||||
for s in ${klipper_systemd_services}; do
|
|
||||||
log_info "Found Klipper service: ${s}"
|
|
||||||
error="${error}\n ➔ ${s}"
|
|
||||||
done
|
|
||||||
fi
|
|
||||||
[[ -n ${error} ]] && print_error "${error}" && return
|
|
||||||
|
|
||||||
### user selection for python version
|
|
||||||
print_dialog_user_select_python_version
|
|
||||||
while true; do
|
|
||||||
read -p "${cyan}###### Select Python version:${white} " -i "1" -e input
|
|
||||||
case "${input}" in
|
|
||||||
1)
|
|
||||||
select_msg "Python 3.x\n"
|
|
||||||
python_version=3
|
|
||||||
break;;
|
|
||||||
2)
|
|
||||||
select_msg "Python 2.7\n"
|
|
||||||
python_version=2
|
|
||||||
break;;
|
|
||||||
B|b)
|
|
||||||
clear; install_menu; break;;
|
|
||||||
*)
|
|
||||||
error_msg "Invalid Input!\n";;
|
|
||||||
esac
|
|
||||||
done && input=""
|
|
||||||
|
|
||||||
### user selection for instance count
|
|
||||||
print_dialog_user_select_instance_count
|
|
||||||
regex="^[1-9][0-9]*$"
|
|
||||||
while [[ ! ${input} =~ ${regex} ]]; do
|
|
||||||
read -p "${cyan}###### Number of Klipper instances to set up:${white} " -i "1" -e input
|
|
||||||
|
|
||||||
if [[ ${input} =~ ${regex} ]]; then
|
|
||||||
instance_count="${input}"
|
|
||||||
select_msg "Instance count: ${instance_count}\n"
|
|
||||||
break
|
|
||||||
elif [[ ${input} == "B" || ${input} == "b" ]]; then
|
|
||||||
install_menu
|
|
||||||
else
|
|
||||||
error_msg "Invalid Input!\n"
|
|
||||||
fi
|
|
||||||
done && input=""
|
|
||||||
|
|
||||||
### user selection for custom names
|
|
||||||
use_custom_names="false"
|
|
||||||
if (( instance_count > 1 )); then
|
|
||||||
print_dialog_user_select_custom_name_bool
|
|
||||||
while true; do
|
|
||||||
read -p "${cyan}###### Assign custom names? (y/N):${white} " input
|
|
||||||
case "${input}" in
|
|
||||||
Y|y|Yes|yes)
|
|
||||||
select_msg "Yes\n"
|
|
||||||
use_custom_names="true"
|
|
||||||
break;;
|
|
||||||
N|n|No|no|"")
|
|
||||||
select_msg "No\n"
|
|
||||||
break;;
|
|
||||||
B|b)
|
|
||||||
clear; install_menu; break;;
|
|
||||||
*)
|
|
||||||
error_msg "Invalid Input!\n";;
|
|
||||||
esac
|
|
||||||
done && input=""
|
|
||||||
else
|
|
||||||
instance_names+=("printer")
|
|
||||||
fi
|
|
||||||
|
|
||||||
### user selection for setting the actual custom names
|
|
||||||
shopt -s nocasematch
|
|
||||||
if (( instance_count > 1 )) && [[ ${use_custom_names} == "true" ]]; then
|
|
||||||
local i
|
|
||||||
|
|
||||||
i=1
|
|
||||||
regex="^[0-9a-zA-Z]+$"
|
|
||||||
blacklist="mcu"
|
|
||||||
while [[ ! ${input} =~ ${regex} || ${input} =~ ${blacklist} || ${i} -le ${instance_count} ]]; do
|
|
||||||
read -p "${cyan}###### Name for instance #${i}:${white} " input
|
|
||||||
|
|
||||||
if [[ ${input} =~ ${blacklist} ]]; then
|
|
||||||
error_msg "Name not allowed! You are trying to use a reserved name."
|
|
||||||
elif [[ ${input} =~ ${regex} && ! ${input} =~ ${blacklist} ]]; then
|
|
||||||
select_msg "Name: ${input}\n"
|
|
||||||
if [[ ${input} =~ ^[0-9]+$ ]]; then
|
|
||||||
instance_names+=("printer_${input}")
|
|
||||||
else
|
|
||||||
instance_names+=("${input}")
|
|
||||||
fi
|
|
||||||
i=$(( i + 1 ))
|
|
||||||
else
|
|
||||||
error_msg "Invalid Input!\n"
|
|
||||||
fi
|
|
||||||
done && input=""
|
|
||||||
elif (( instance_count > 1 )) && [[ ${use_custom_names} == "false" ]]; then
|
|
||||||
for (( i=1; i <= instance_count; i++ )); do
|
|
||||||
instance_names+=("printer_${i}")
|
|
||||||
done
|
|
||||||
fi
|
|
||||||
shopt -u nocasematch
|
|
||||||
|
|
||||||
(( instance_count > 1 )) && status_msg "Installing ${instance_count} Klipper instances ..."
|
|
||||||
(( instance_count == 1 )) && status_msg "Installing single Klipper instance ..."
|
|
||||||
|
|
||||||
run_klipper_setup "${python_version}" "${instance_names[@]}"
|
|
||||||
}
|
|
||||||
|
|
||||||
function print_dialog_user_select_python_version() {
|
|
||||||
top_border
|
|
||||||
echo -e "| Please select your preferred Python version. | "
|
|
||||||
echo -e "| The recommended version is Python 3.x. | "
|
|
||||||
hr
|
|
||||||
echo -e "| 1) [Python 3.x] (recommended) | "
|
|
||||||
echo -e "| 2) [Python 2.7] ${yellow}(legacy)${white} | "
|
|
||||||
back_footer
|
|
||||||
}
|
|
||||||
|
|
||||||
function print_dialog_user_select_instance_count() {
|
|
||||||
top_border
|
|
||||||
echo -e "| Please select the number of Klipper instances to set |"
|
|
||||||
echo -e "| up. The number of Klipper instances will determine |"
|
|
||||||
echo -e "| the amount of printers you can run from this host. |"
|
|
||||||
blank_line
|
|
||||||
echo -e "| ${yellow}WARNING:${white} |"
|
|
||||||
echo -e "| ${yellow}Setting up too many instances may crash your system.${white} |"
|
|
||||||
back_footer
|
|
||||||
}
|
|
||||||
|
|
||||||
function print_dialog_user_select_custom_name_bool() {
|
|
||||||
top_border
|
|
||||||
echo -e "| You can now assign a custom name to each instance. |"
|
|
||||||
echo -e "| If skipped, each instance will get an index assigned |"
|
|
||||||
echo -e "| in ascending order, starting at index '1'. |"
|
|
||||||
blank_line
|
|
||||||
echo -e "| Info: |"
|
|
||||||
echo -e "| Only alphanumeric characters for names are allowed! |"
|
|
||||||
back_footer
|
|
||||||
}
|
|
||||||
|
|
||||||
function run_klipper_setup() {
|
|
||||||
read_kiauh_ini "${FUNCNAME[0]}"
|
|
||||||
|
|
||||||
local python_version=${1}
|
|
||||||
local instance_names
|
|
||||||
local confirm
|
|
||||||
local custom_repo
|
|
||||||
local custom_branch
|
|
||||||
local dep
|
|
||||||
|
|
||||||
shift 1
|
|
||||||
read -r -a instance_names <<< "${@}"
|
|
||||||
|
|
||||||
custom_repo="${custom_klipper_repo}"
|
|
||||||
custom_branch="${custom_klipper_repo_branch}"
|
|
||||||
dep=(git)
|
|
||||||
|
|
||||||
### checking dependencies
|
|
||||||
dependency_check "${dep[@]}"
|
|
||||||
|
|
||||||
### step 1: clone klipper
|
|
||||||
clone_klipper "${custom_repo}" "${custom_branch}"
|
|
||||||
|
|
||||||
### step 2: install klipper dependencies and create python virtualenv
|
|
||||||
install_klipper_packages "${python_version}"
|
|
||||||
create_klipper_virtualenv "${python_version}"
|
|
||||||
|
|
||||||
### step 3: create klipper instances
|
|
||||||
for instance in "${instance_names[@]}"; do
|
|
||||||
create_klipper_service "${instance}"
|
|
||||||
done
|
|
||||||
|
|
||||||
### step 4: enable and start all instances
|
|
||||||
do_action_service "enable" "klipper"
|
|
||||||
do_action_service "start" "klipper"
|
|
||||||
|
|
||||||
### step 5: check for dialout group membership
|
|
||||||
check_usergroups
|
|
||||||
|
|
||||||
### confirm message
|
|
||||||
(( ${#instance_names[@]} == 1 )) && confirm="Klipper has been set up!"
|
|
||||||
(( ${#instance_names[@]} > 1 )) && confirm="${#instance_names[@]} Klipper instances have been set up!"
|
|
||||||
|
|
||||||
### finalizing the setup with writing instance names to the kiauh.ini
|
|
||||||
set_multi_instance_names
|
|
||||||
mask_disrupting_services
|
|
||||||
|
|
||||||
print_confirm "${confirm}" && return
|
|
||||||
}
|
|
||||||
|
|
||||||
function clone_klipper() {
|
|
||||||
local repo=${1} branch=${2}
|
|
||||||
|
|
||||||
[[ -z ${repo} ]] && repo="${KLIPPER_REPO}"
|
|
||||||
repo=$(echo "${repo}" | sed -r "s/^(http|https):\/\/github\.com\///i; s/\.git$//")
|
|
||||||
repo="https://github.com/${repo}"
|
|
||||||
|
|
||||||
[[ -z ${branch} ]] && branch="master"
|
|
||||||
|
|
||||||
### force remove existing klipper dir and clone into fresh klipper dir
|
|
||||||
[[ -d ${KLIPPER_DIR} ]] && rm -rf "${KLIPPER_DIR}"
|
|
||||||
|
|
||||||
status_msg "Cloning Klipper from ${repo} ..."
|
|
||||||
|
|
||||||
cd "${HOME}" || exit 1
|
|
||||||
if git clone "${repo}" "${KLIPPER_DIR}"; then
|
|
||||||
cd "${KLIPPER_DIR}" && git checkout "${branch}"
|
|
||||||
else
|
|
||||||
print_error "Cloning Klipper from\n ${repo}\n failed!"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
function create_klipper_virtualenv() {
|
|
||||||
local python_version="${1}"
|
|
||||||
|
|
||||||
[[ -d ${KLIPPY_ENV} ]] && rm -rf "${KLIPPY_ENV}"
|
|
||||||
|
|
||||||
status_msg "Installing $("python${python_version}" -V) virtual environment..."
|
|
||||||
|
|
||||||
if virtualenv -p "python${python_version}" "${KLIPPY_ENV}"; then
|
|
||||||
"${KLIPPY_ENV}"/bin/pip install -r "${KLIPPER_DIR}"/scripts/klippy-requirements.txt
|
|
||||||
else
|
|
||||||
log_error "failure while creating python3 klippy-env"
|
|
||||||
error_msg "Creation of Klipper virtualenv failed!"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
###
|
|
||||||
# extracts the required packages from the
|
|
||||||
# install-debian.sh script and installs them
|
|
||||||
#
|
|
||||||
# @param {string}: python_version - klipper-env python version
|
|
||||||
#
|
|
||||||
function install_klipper_packages() {
|
|
||||||
local packages log_name="Klipper" python_version="${1}"
|
|
||||||
local install_script="${KLIPPER_DIR}/scripts/install-debian.sh"
|
|
||||||
|
|
||||||
status_msg "Reading dependencies..."
|
|
||||||
# shellcheck disable=SC2016
|
|
||||||
packages=$(grep "PKGLIST=" "${install_script}" | cut -d'"' -f2 | sed 's/\${PKGLIST}//g' | tr -d '\n')
|
|
||||||
### add dfu-util for octopi-images
|
|
||||||
packages+=" dfu-util"
|
|
||||||
### add pkg-config for rp2040 build
|
|
||||||
packages+=" pkg-config"
|
|
||||||
### add dbus requirement for DietPi distro
|
|
||||||
[[ -e "/boot/dietpi/.version" ]] && packages+=" dbus"
|
|
||||||
|
|
||||||
if (( python_version == 3 )); then
|
|
||||||
### replace python-dev with python3-dev if python3 was selected
|
|
||||||
packages="${packages//python-dev/python3-dev}"
|
|
||||||
elif (( python_version == 2 )); then
|
|
||||||
### package name 'python-dev' is deprecated (-> no installation candidate) on more modern linux distros
|
|
||||||
packages="${packages//python-dev/python2-dev}"
|
|
||||||
else
|
|
||||||
log_error "Internal Error: missing parameter 'python_version' during function call of ${FUNCNAME[0]}"
|
|
||||||
error_msg "Internal Error: missing parameter 'python_version' during function call of ${FUNCNAME[0]}"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo "${cyan}${packages}${white}" | tr '[:space:]' '\n'
|
|
||||||
read -r -a packages <<< "${packages}"
|
|
||||||
|
|
||||||
### Update system package lists if stale
|
|
||||||
update_system_package_lists
|
|
||||||
|
|
||||||
### Install required packages
|
|
||||||
install_system_packages "${log_name}" "packages[@]"
|
|
||||||
}
|
|
||||||
|
|
||||||
function create_klipper_service() {
|
|
||||||
local instance_name=${1}
|
|
||||||
|
|
||||||
local printer_data
|
|
||||||
local cfg_dir
|
|
||||||
local gcodes_dir
|
|
||||||
local cfg
|
|
||||||
local log
|
|
||||||
local klippy_serial
|
|
||||||
local klippy_socket
|
|
||||||
local env_file
|
|
||||||
local service
|
|
||||||
local service_template
|
|
||||||
local env_template
|
|
||||||
local suffix
|
|
||||||
|
|
||||||
printer_data="${HOME}/${instance_name}_data"
|
|
||||||
cfg_dir="${printer_data}/config"
|
|
||||||
gcodes_dir="${printer_data}/gcodes"
|
|
||||||
cfg="${cfg_dir}/printer.cfg"
|
|
||||||
log="${printer_data}/logs/klippy.log"
|
|
||||||
klippy_serial="${printer_data}/comms/klippy.serial"
|
|
||||||
klippy_socket="${printer_data}/comms/klippy.sock"
|
|
||||||
env_file="${printer_data}/systemd/klipper.env"
|
|
||||||
|
|
||||||
if [[ ${instance_name} == "printer" ]]; then
|
|
||||||
suffix="${instance_name//printer/}"
|
|
||||||
else
|
|
||||||
suffix="-${instance_name//printer_/}"
|
|
||||||
fi
|
|
||||||
|
|
||||||
create_required_folders "${printer_data}"
|
|
||||||
|
|
||||||
service_template="${KIAUH_SRCDIR}/resources/klipper.service"
|
|
||||||
env_template="${KIAUH_SRCDIR}/resources/klipper.env"
|
|
||||||
service="${SYSTEMD}/klipper${suffix}.service"
|
|
||||||
|
|
||||||
if [[ ! -f ${service} ]]; then
|
|
||||||
status_msg "Create Klipper service file ..."
|
|
||||||
|
|
||||||
sudo cp "${service_template}" "${service}"
|
|
||||||
sudo cp "${env_template}" "${env_file}"
|
|
||||||
sudo sed -i "s|%USER%|${USER}|g; s|%KLIPPER_DIR%|${KLIPPER_DIR}|; s|%ENV%|${KLIPPY_ENV}|; s|%ENV_FILE%|${env_file}|" "${service}"
|
|
||||||
sudo sed -i "s|%USER%|${USER}|; s|%KLIPPER_DIR%|${KLIPPER_DIR}|; s|%LOG%|${log}|; s|%CFG%|${cfg}|; s|%PRINTER%|${klippy_serial}|; s|%UDS%|${klippy_socket}|" "${env_file}"
|
|
||||||
|
|
||||||
ok_msg "Klipper service file created!"
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [[ ! -f ${cfg} ]]; then
|
|
||||||
write_example_printer_cfg "${cfg}" "${gcodes_dir}"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
function write_example_printer_cfg() {
|
|
||||||
local cfg=${1}
|
|
||||||
local gcodes_dir=${2}
|
|
||||||
local cfg_template
|
|
||||||
|
|
||||||
cfg_template="${KIAUH_SRCDIR}/resources/example.printer.cfg"
|
|
||||||
|
|
||||||
status_msg "Creating minimal example printer.cfg ..."
|
|
||||||
if cp "${cfg_template}" "${cfg}"; then
|
|
||||||
sed -i "s|%GCODES_DIR%|${gcodes_dir}|" "${cfg}"
|
|
||||||
ok_msg "Minimal example printer.cfg created!"
|
|
||||||
else
|
|
||||||
error_msg "Couldn't create minimal example printer.cfg!"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
#================================================#
|
|
||||||
#================ REMOVE KLIPPER ================#
|
|
||||||
#================================================#
|
|
||||||
|
|
||||||
function remove_klipper_service() {
|
|
||||||
[[ -z $(klipper_systemd) ]] && return
|
|
||||||
|
|
||||||
status_msg "Removing Klipper services ..."
|
|
||||||
|
|
||||||
for service in $(klipper_systemd | cut -d"/" -f5); do
|
|
||||||
status_msg "Removing ${service} ..."
|
|
||||||
sudo systemctl stop "${service}"
|
|
||||||
sudo systemctl disable "${service}"
|
|
||||||
sudo rm -f "${SYSTEMD}/${service}"
|
|
||||||
sudo systemctl daemon-reload
|
|
||||||
sudo systemctl reset-failed
|
|
||||||
done
|
|
||||||
|
|
||||||
ok_msg "All Klipper services removed!"
|
|
||||||
}
|
|
||||||
|
|
||||||
function find_instance_files() {
|
|
||||||
local target_folder=${1}
|
|
||||||
local target_name=${2}
|
|
||||||
local files
|
|
||||||
|
|
||||||
readarray -t files < <(find "${HOME}" -regex "${HOME}/[A-Za-z0-9_]+_data/${target_folder}/${target_name}" | sort)
|
|
||||||
|
|
||||||
echo -e "${files[@]}"
|
|
||||||
}
|
|
||||||
|
|
||||||
function find_legacy_klipper_logs() {
|
|
||||||
local files
|
|
||||||
local regex="klippy(-[0-9a-zA-Z]+)?\.log(.*)?"
|
|
||||||
|
|
||||||
readarray -t files < <(find "${HOME}/klipper_logs" -maxdepth 1 -regextype posix-extended -regex "${HOME}/klipper_logs/${regex}" 2> /dev/null | sort)
|
|
||||||
echo -e "${files[@]}"
|
|
||||||
}
|
|
||||||
|
|
||||||
function find_legacy_klipper_uds() {
|
|
||||||
local files
|
|
||||||
|
|
||||||
readarray -t files < <(find /tmp -maxdepth 1 -regextype posix-extended -regex "/tmp/klippy_uds(-[0-9a-zA-Z]+)?" | sort)
|
|
||||||
echo -e "${files[@]}"
|
|
||||||
}
|
|
||||||
|
|
||||||
function find_legacy_klipper_printer() {
|
|
||||||
local files
|
|
||||||
|
|
||||||
readarray -t files < <(find /tmp -maxdepth 1 -regextype posix-extended -regex "/tmp/printer(-[0-9a-zA-Z]+)?" | sort)
|
|
||||||
echo -e "${files[@]}"
|
|
||||||
}
|
|
||||||
|
|
||||||
function remove_klipper_dir() {
|
|
||||||
[[ ! -d ${KLIPPER_DIR} ]] && return
|
|
||||||
|
|
||||||
status_msg "Removing Klipper directory ..."
|
|
||||||
rm -rf "${KLIPPER_DIR}"
|
|
||||||
ok_msg "Directory removed!"
|
|
||||||
}
|
|
||||||
|
|
||||||
function remove_klipper_env() {
|
|
||||||
[[ ! -d ${KLIPPY_ENV} ]] && return
|
|
||||||
|
|
||||||
status_msg "Removing klippy-env directory ..."
|
|
||||||
rm -rf "${KLIPPY_ENV}"
|
|
||||||
ok_msg "Directory removed!"
|
|
||||||
}
|
|
||||||
|
|
||||||
###
|
|
||||||
# takes in a string of space separated absolute
|
|
||||||
# filepaths and removes those files one after another
|
|
||||||
#
|
|
||||||
function remove_files() {
|
|
||||||
local files
|
|
||||||
read -r -a files <<< "${@}"
|
|
||||||
|
|
||||||
if (( ${#files[@]} > 0 )); then
|
|
||||||
for file in "${files[@]}"; do
|
|
||||||
status_msg "Removing ${file} ..."
|
|
||||||
rm -f "${file}"
|
|
||||||
ok_msg "${file} removed!"
|
|
||||||
done
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
function remove_klipper() {
|
|
||||||
remove_klipper_service
|
|
||||||
remove_files "$(find_instance_files "systemd" "klipper.env")"
|
|
||||||
remove_files "$(find_instance_files "logs" "klippy.log.*")"
|
|
||||||
remove_files "$(find_instance_files "comms" "klippy.sock")"
|
|
||||||
remove_files "$(find_instance_files "comms" "klippy.serial")"
|
|
||||||
|
|
||||||
remove_files "$(find_legacy_klipper_logs)"
|
|
||||||
remove_files "$(find_legacy_klipper_uds)"
|
|
||||||
remove_files "$(find_legacy_klipper_printer)"
|
|
||||||
|
|
||||||
remove_klipper_dir
|
|
||||||
remove_klipper_env
|
|
||||||
|
|
||||||
print_confirm "Klipper was successfully removed!" && return
|
|
||||||
}
|
|
||||||
|
|
||||||
#================================================#
|
|
||||||
#================ UPDATE KLIPPER ================#
|
|
||||||
#================================================#
|
|
||||||
|
|
||||||
###
|
|
||||||
# stops klipper, performs a git pull, installs
|
|
||||||
# possible new dependencies, then restarts klipper
|
|
||||||
#
|
|
||||||
function update_klipper() {
|
|
||||||
read_kiauh_ini "${FUNCNAME[0]}"
|
|
||||||
|
|
||||||
local py_ver
|
|
||||||
local custom_repo="${custom_klipper_repo}"
|
|
||||||
local custom_branch="${custom_klipper_repo_branch}"
|
|
||||||
|
|
||||||
py_ver=$(get_klipper_python_ver)
|
|
||||||
|
|
||||||
do_action_service "stop" "klipper"
|
|
||||||
|
|
||||||
if [[ ! -d ${KLIPPER_DIR} ]]; then
|
|
||||||
clone_klipper "${custom_repo}" "${custom_branch}"
|
|
||||||
else
|
|
||||||
backup_before_update "klipper"
|
|
||||||
|
|
||||||
status_msg "Updating Klipper ..."
|
|
||||||
cd "${KLIPPER_DIR}" && git pull
|
|
||||||
### read PKGLIST and install possible new dependencies
|
|
||||||
install_klipper_packages "${py_ver}"
|
|
||||||
### install possible new python dependencies
|
|
||||||
"${KLIPPY_ENV}"/bin/pip install -r "${KLIPPER_DIR}/scripts/klippy-requirements.txt"
|
|
||||||
fi
|
|
||||||
|
|
||||||
ok_msg "Update complete!"
|
|
||||||
do_action_service "restart" "klipper"
|
|
||||||
}
|
|
||||||
|
|
||||||
#================================================#
|
|
||||||
#================ KLIPPER STATUS ================#
|
|
||||||
#================================================#
|
|
||||||
|
|
||||||
function get_klipper_status() {
|
|
||||||
local sf_count status py_ver
|
|
||||||
sf_count="$(klipper_systemd | wc -w)"
|
|
||||||
|
|
||||||
py_ver=$(get_klipper_python_ver)
|
|
||||||
|
|
||||||
### remove the "SERVICE" entry from the data array if a klipper service is installed
|
|
||||||
local data_arr=(SERVICE "${KLIPPER_DIR}" "${KLIPPY_ENV}")
|
|
||||||
(( sf_count > 0 )) && unset "data_arr[0]"
|
|
||||||
|
|
||||||
### count+1 for each found data-item from array
|
|
||||||
local filecount=0
|
|
||||||
for data in "${data_arr[@]}"; do
|
|
||||||
[[ -e ${data} ]] && filecount=$(( filecount + 1 ))
|
|
||||||
done
|
|
||||||
|
|
||||||
if (( filecount == ${#data_arr[*]} )); then
|
|
||||||
if (( py_ver == 3 )); then
|
|
||||||
status="Installed: ${sf_count}(py${py_ver})"
|
|
||||||
else
|
|
||||||
status="Installed: ${sf_count}"
|
|
||||||
fi
|
|
||||||
elif (( filecount == 0 )); then
|
|
||||||
status="Not installed!"
|
|
||||||
else
|
|
||||||
status="Incomplete!"
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo "${status}"
|
|
||||||
}
|
|
||||||
|
|
||||||
function get_local_klipper_commit() {
|
|
||||||
[[ ! -d ${KLIPPER_DIR} || ! -d "${KLIPPER_DIR}/.git" ]] && return
|
|
||||||
|
|
||||||
local commit
|
|
||||||
cd "${KLIPPER_DIR}"
|
|
||||||
commit="$(git describe HEAD --always --tags | cut -d "-" -f 1,2)"
|
|
||||||
echo "${commit}"
|
|
||||||
}
|
|
||||||
|
|
||||||
function get_remote_klipper_commit() {
|
|
||||||
[[ ! -d ${KLIPPER_DIR} || ! -d "${KLIPPER_DIR}/.git" ]] && return
|
|
||||||
|
|
||||||
local commit
|
|
||||||
local branch
|
|
||||||
|
|
||||||
read_kiauh_ini "${FUNCNAME[0]}"
|
|
||||||
branch="${custom_klipper_repo_branch}"
|
|
||||||
[[ -z ${branch} ]] && branch="master"
|
|
||||||
|
|
||||||
cd "${KLIPPER_DIR}" && git fetch origin -q
|
|
||||||
commit=$(git describe "origin/${branch}" --always --tags | cut -d "-" -f 1,2)
|
|
||||||
echo "${commit}"
|
|
||||||
}
|
|
||||||
|
|
||||||
function compare_klipper_versions() {
|
|
||||||
local versions local_ver remote_ver
|
|
||||||
local_ver="$(get_local_klipper_commit)"
|
|
||||||
remote_ver="$(get_remote_klipper_commit)"
|
|
||||||
|
|
||||||
if [[ ${local_ver} != "${remote_ver}" ]]; then
|
|
||||||
versions="${yellow}$(printf " %-14s" "${local_ver}")${white}"
|
|
||||||
versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
|
|
||||||
# add klipper to application_updates_available in kiauh.ini
|
|
||||||
add_to_application_updates "klipper"
|
|
||||||
else
|
|
||||||
versions="${green}$(printf " %-14s" "${local_ver}")${white}"
|
|
||||||
versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo "${versions}"
|
|
||||||
}
|
|
||||||
|
|
||||||
#================================================#
|
|
||||||
#=================== HELPERS ====================#
|
|
||||||
#================================================#
|
|
||||||
|
|
||||||
###
|
|
||||||
# reads the python version from the klipper virtual environment
|
|
||||||
#
|
|
||||||
# @output: writes the python major version to STDOUT
|
|
||||||
#
|
|
||||||
function get_klipper_python_ver() {
|
|
||||||
[[ ! -d ${KLIPPY_ENV} ]] && return
|
|
||||||
|
|
||||||
local version
|
|
||||||
version=$("${KLIPPY_ENV}"/bin/python --version 2>&1 | cut -d" " -f2 | cut -d"." -f1)
|
|
||||||
echo "${version}"
|
|
||||||
}
|
|
||||||
|
|
||||||
function mask_disrupting_services() {
|
|
||||||
local brltty="false"
|
|
||||||
local brltty_udev="false"
|
|
||||||
local modem_manager="false"
|
|
||||||
|
|
||||||
[[ $(dpkg -s brltty 2>/dev/null | grep "Status") = *\ installed ]] && brltty="true"
|
|
||||||
[[ $(dpkg -s brltty-udev 2>/dev/null | grep "Status") = *\ installed ]] && brltty_udev="true"
|
|
||||||
[[ $(dpkg -s ModemManager 2>/dev/null | grep "Status") = *\ installed ]] && modem_manager="true"
|
|
||||||
|
|
||||||
status_msg "Installed brltty package detected, masking brltty service ..."
|
|
||||||
if [[ ${brltty} == "true" ]]; then
|
|
||||||
sudo systemctl stop brltty
|
|
||||||
sudo systemctl mask brltty
|
|
||||||
fi
|
|
||||||
ok_msg "brltty service masked!"
|
|
||||||
|
|
||||||
status_msg "Installed brltty-udev package detected, masking brltty-udev service ..."
|
|
||||||
if [[ ${brltty_udev} == "true" ]]; then
|
|
||||||
sudo systemctl stop brltty-udev
|
|
||||||
sudo systemctl mask brltty-udev
|
|
||||||
fi
|
|
||||||
ok_msg "brltty-udev service masked!"
|
|
||||||
|
|
||||||
status_msg "Installed ModemManager package detected, masking ModemManager service ..."
|
|
||||||
if [[ ${modem_manager} == "true" ]]; then
|
|
||||||
sudo systemctl stop ModemManager
|
|
||||||
sudo systemctl mask ModemManager
|
|
||||||
fi
|
|
||||||
ok_msg "ModemManager service masked!"
|
|
||||||
}
|
|
||||||
@@ -1,237 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
|
|
||||||
#=======================================================================#
|
|
||||||
# Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com> #
|
|
||||||
# #
|
|
||||||
# This file is part of KIAUH - Klipper Installation And Update Helper #
|
|
||||||
# https://github.com/dw-0/kiauh #
|
|
||||||
# #
|
|
||||||
# This file may be distributed under the terms of the GNU GPLv3 license #
|
|
||||||
#=======================================================================#
|
|
||||||
|
|
||||||
set -e
|
|
||||||
|
|
||||||
#===================================================#
|
|
||||||
#============== INSTALL KLIPPERSCREEN ==============#
|
|
||||||
#===================================================#
|
|
||||||
|
|
||||||
function klipperscreen_systemd() {
|
|
||||||
local services
|
|
||||||
services=$(find "${SYSTEMD}" -maxdepth 1 -regextype posix-extended -regex "${SYSTEMD}/KlipperScreen.service")
|
|
||||||
echo "${services}"
|
|
||||||
}
|
|
||||||
|
|
||||||
function install_klipperscreen() {
|
|
||||||
### return early if python version check fails
|
|
||||||
if [[ $(python3_check) == "false" ]]; then
|
|
||||||
local error="Versioncheck failed! Python 3.7 or newer required!\n"
|
|
||||||
error="${error} Please upgrade Python."
|
|
||||||
print_error "${error}" && return
|
|
||||||
fi
|
|
||||||
|
|
||||||
### first, we create a backup of the full klipper_config dir - safety first!
|
|
||||||
backup_config_dir
|
|
||||||
|
|
||||||
### install KlipperScreen
|
|
||||||
klipperscreen_setup
|
|
||||||
|
|
||||||
### add klipperscreen to the update manager in moonraker.conf
|
|
||||||
patch_klipperscreen_update_manager
|
|
||||||
|
|
||||||
do_action_service "restart" "KlipperScreen"
|
|
||||||
}
|
|
||||||
|
|
||||||
function klipperscreen_setup() {
|
|
||||||
local dep=(wget curl unzip dfu-util)
|
|
||||||
dependency_check "${dep[@]}"
|
|
||||||
status_msg "Cloning KlipperScreen from ${KLIPPERSCREEN_REPO} ..."
|
|
||||||
|
|
||||||
# force remove existing KlipperScreen dir
|
|
||||||
[[ -d ${KLIPPERSCREEN_DIR} ]] && rm -rf "${KLIPPERSCREEN_DIR}"
|
|
||||||
|
|
||||||
# clone into fresh KlipperScreen dir
|
|
||||||
cd "${HOME}" || exit 1
|
|
||||||
if ! git clone "${KLIPPERSCREEN_REPO}" "${KLIPPERSCREEN_DIR}"; then
|
|
||||||
print_error "Cloning KlipperScreen from\n ${KLIPPERSCREEN_REPO}\n failed!"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
status_msg "Installing KlipperScreen ..."
|
|
||||||
if "${KLIPPERSCREEN_DIR}"/scripts/KlipperScreen-install.sh; then
|
|
||||||
ok_msg "KlipperScreen successfully installed!"
|
|
||||||
else
|
|
||||||
print_error "KlipperScreen installation failed!"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
#===================================================#
|
|
||||||
#=============== REMOVE KLIPPERSCREEN ==============#
|
|
||||||
#===================================================#
|
|
||||||
|
|
||||||
function remove_klipperscreen() {
|
|
||||||
### remove KlipperScreen dir
|
|
||||||
if [[ -d ${KLIPPERSCREEN_DIR} ]]; then
|
|
||||||
status_msg "Removing KlipperScreen directory ..."
|
|
||||||
rm -rf "${KLIPPERSCREEN_DIR}" && ok_msg "Directory removed!"
|
|
||||||
fi
|
|
||||||
|
|
||||||
### remove KlipperScreen VENV dir
|
|
||||||
if [[ -d ${KLIPPERSCREEN_ENV} ]]; then
|
|
||||||
status_msg "Removing KlipperScreen VENV directory ..."
|
|
||||||
rm -rf "${KLIPPERSCREEN_ENV}" && ok_msg "Directory removed!"
|
|
||||||
fi
|
|
||||||
|
|
||||||
### remove KlipperScreen service
|
|
||||||
if [[ -e "${SYSTEMD}/KlipperScreen.service" ]]; then
|
|
||||||
status_msg "Removing KlipperScreen service ..."
|
|
||||||
do_action_service "stop" "KlipperScreen"
|
|
||||||
do_action_service "disable" "KlipperScreen"
|
|
||||||
sudo rm -f "${SYSTEMD}/KlipperScreen.service"
|
|
||||||
|
|
||||||
###reloading units
|
|
||||||
sudo systemctl daemon-reload
|
|
||||||
sudo systemctl reset-failed
|
|
||||||
ok_msg "KlipperScreen Service removed!"
|
|
||||||
fi
|
|
||||||
|
|
||||||
### remove KlipperScreen log
|
|
||||||
if [[ -e "/tmp/KlipperScreen.log" ]]; then
|
|
||||||
status_msg "Removing KlipperScreen log file ..."
|
|
||||||
rm -f "/tmp/KlipperScreen.log" && ok_msg "File removed!"
|
|
||||||
fi
|
|
||||||
|
|
||||||
### remove KlipperScreen log symlink in config dir
|
|
||||||
if [[ -e "${KLIPPER_CONFIG}/KlipperScreen.log" ]]; then
|
|
||||||
status_msg "Removing KlipperScreen log symlink ..."
|
|
||||||
rm -f "${KLIPPER_CONFIG}/KlipperScreen.log" && ok_msg "File removed!"
|
|
||||||
fi
|
|
||||||
|
|
||||||
print_confirm "KlipperScreen successfully removed!"
|
|
||||||
}
|
|
||||||
|
|
||||||
#===================================================#
|
|
||||||
#=============== UPDATE KLIPPERSCREEN ==============#
|
|
||||||
#===================================================#
|
|
||||||
|
|
||||||
function update_klipperscreen() {
|
|
||||||
local old_md5
|
|
||||||
old_md5=$(md5sum "${KLIPPERSCREEN_DIR}/scripts/KlipperScreen-requirements.txt" | cut -d " " -f1)
|
|
||||||
|
|
||||||
do_action_service "stop" "KlipperScreen"
|
|
||||||
backup_before_update "klipperscreen"
|
|
||||||
|
|
||||||
cd "${KLIPPERSCREEN_DIR}"
|
|
||||||
git pull origin master -q && ok_msg "Fetch successfull!"
|
|
||||||
git checkout -f master && ok_msg "Checkout successfull"
|
|
||||||
|
|
||||||
if [[ $(md5sum "${KLIPPERSCREEN_DIR}/scripts/KlipperScreen-requirements.txt" | cut -d " " -f1) != "${old_md5}" ]]; then
|
|
||||||
status_msg "New dependencies detected..."
|
|
||||||
"${KLIPPERSCREEN_ENV}"/bin/pip install -r "${KLIPPERSCREEN_DIR}/scripts/KlipperScreen-requirements.txt"
|
|
||||||
ok_msg "Dependencies have been installed!"
|
|
||||||
fi
|
|
||||||
|
|
||||||
ok_msg "Update complete!"
|
|
||||||
do_action_service "start" "KlipperScreen"
|
|
||||||
}
|
|
||||||
|
|
||||||
#===================================================#
|
|
||||||
#=============== KLIPPERSCREEN STATUS ==============#
|
|
||||||
#===================================================#
|
|
||||||
|
|
||||||
function get_klipperscreen_status() {
|
|
||||||
local sf_count status
|
|
||||||
sf_count="$(klipperscreen_systemd | wc -w)"
|
|
||||||
|
|
||||||
### remove the "SERVICE" entry from the data array if a moonraker service is installed
|
|
||||||
local data_arr=(SERVICE "${KLIPPERSCREEN_DIR}" "${KLIPPERSCREEN_ENV}")
|
|
||||||
(( sf_count > 0 )) && unset "data_arr[0]"
|
|
||||||
|
|
||||||
### count+1 for each found data-item from array
|
|
||||||
local filecount=0
|
|
||||||
for data in "${data_arr[@]}"; do
|
|
||||||
[[ -e ${data} ]] && filecount=$(( filecount + 1 ))
|
|
||||||
done
|
|
||||||
|
|
||||||
if (( filecount == ${#data_arr[*]} )); then
|
|
||||||
status="Installed!"
|
|
||||||
elif (( filecount == 0 )); then
|
|
||||||
status="Not installed!"
|
|
||||||
else
|
|
||||||
status="Incomplete!"
|
|
||||||
fi
|
|
||||||
echo "${status}"
|
|
||||||
}
|
|
||||||
|
|
||||||
function get_local_klipperscreen_commit() {
|
|
||||||
[[ ! -d ${KLIPPERSCREEN_DIR} || ! -d "${KLIPPERSCREEN_DIR}/.git" ]] && return
|
|
||||||
|
|
||||||
local commit
|
|
||||||
cd "${KLIPPERSCREEN_DIR}"
|
|
||||||
commit="$(git describe HEAD --always --tags | cut -d "-" -f 1,2)"
|
|
||||||
echo "${commit}"
|
|
||||||
}
|
|
||||||
|
|
||||||
function get_remote_klipperscreen_commit() {
|
|
||||||
[[ ! -d ${KLIPPERSCREEN_DIR} || ! -d "${KLIPPERSCREEN_DIR}/.git" ]] && return
|
|
||||||
|
|
||||||
local commit
|
|
||||||
cd "${KLIPPERSCREEN_DIR}" && git fetch origin -q
|
|
||||||
commit=$(git describe origin/master --always --tags | cut -d "-" -f 1,2)
|
|
||||||
echo "${commit}"
|
|
||||||
}
|
|
||||||
|
|
||||||
function compare_klipperscreen_versions() {
|
|
||||||
local versions local_ver remote_ver
|
|
||||||
local_ver="$(get_local_klipperscreen_commit)"
|
|
||||||
remote_ver="$(get_remote_klipperscreen_commit)"
|
|
||||||
|
|
||||||
if [[ ${local_ver} != "${remote_ver}" ]]; then
|
|
||||||
versions="${yellow}$(printf " %-14s" "${local_ver}")${white}"
|
|
||||||
versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
|
|
||||||
# add moonraker to application_updates_available in kiauh.ini
|
|
||||||
add_to_application_updates "klipperscreen"
|
|
||||||
else
|
|
||||||
versions="${green}$(printf " %-14s" "${local_ver}")${white}"
|
|
||||||
versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo "${versions}"
|
|
||||||
}
|
|
||||||
|
|
||||||
#================================================#
|
|
||||||
#=================== HELPERS ====================#
|
|
||||||
#================================================#
|
|
||||||
|
|
||||||
function patch_klipperscreen_update_manager() {
|
|
||||||
local patched="false"
|
|
||||||
local moonraker_configs
|
|
||||||
moonraker_configs=$(find "${KLIPPER_CONFIG}" -type f -name "moonraker.conf" | sort)
|
|
||||||
|
|
||||||
for conf in ${moonraker_configs}; do
|
|
||||||
if ! grep -Eq "^\[update_manager KlipperScreen\]\s*$" "${conf}"; then
|
|
||||||
### add new line to conf if it doesn't end with one
|
|
||||||
[[ $(tail -c1 "${conf}" | wc -l) -eq 0 ]] && echo "" >> "${conf}"
|
|
||||||
|
|
||||||
### add KlipperScreens update manager section to moonraker.conf
|
|
||||||
status_msg "Adding KlipperScreen to update manager in file:\n ${conf}"
|
|
||||||
/bin/sh -c "cat >> ${conf}" << MOONRAKER_CONF
|
|
||||||
|
|
||||||
[update_manager KlipperScreen]
|
|
||||||
type: git_repo
|
|
||||||
path: ${HOME}/KlipperScreen
|
|
||||||
origin: https://github.com/jordanruthe/KlipperScreen.git
|
|
||||||
env: ${HOME}/.KlipperScreen-env/bin/python
|
|
||||||
requirements: scripts/KlipperScreen-requirements.txt
|
|
||||||
install_script: scripts/KlipperScreen-install.sh
|
|
||||||
MOONRAKER_CONF
|
|
||||||
|
|
||||||
fi
|
|
||||||
|
|
||||||
patched="true"
|
|
||||||
done
|
|
||||||
|
|
||||||
if [[ ${patched} == "true" ]]; then
|
|
||||||
do_action_service "restart" "moonraker"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
@@ -1,690 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
|
|
||||||
#=======================================================================#
|
|
||||||
# Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com> #
|
|
||||||
# #
|
|
||||||
# This file is part of KIAUH - Klipper Installation And Update Helper #
|
|
||||||
# https://github.com/dw-0/kiauh #
|
|
||||||
# #
|
|
||||||
# This file may be distributed under the terms of the GNU GPLv3 license #
|
|
||||||
#=======================================================================#
|
|
||||||
|
|
||||||
set -e
|
|
||||||
|
|
||||||
#===================================================#
|
|
||||||
#================= INSTALL MAINSAIL ================#
|
|
||||||
#===================================================#
|
|
||||||
|
|
||||||
function install_mainsail() {
|
|
||||||
if [[ -z $(moonraker_systemd) ]]; then
|
|
||||||
local error="Moonraker not installed! It's recommended to install Moonraker first!"
|
|
||||||
print_error "${error}"
|
|
||||||
while true; do
|
|
||||||
local yn
|
|
||||||
read -p "${cyan}###### Proceed to install Mainsail without installing Moonraker? (y/N):${white} " yn
|
|
||||||
case "${yn}" in
|
|
||||||
Y|y|Yes|yes)
|
|
||||||
select_msg "Yes"
|
|
||||||
break;;
|
|
||||||
N|n|No|no|"")
|
|
||||||
select_msg "No"
|
|
||||||
abort_msg "Exiting Mainsail setup ...\n"
|
|
||||||
return;;
|
|
||||||
*)
|
|
||||||
error_msg "Invalid Input!";;
|
|
||||||
esac
|
|
||||||
done
|
|
||||||
fi
|
|
||||||
|
|
||||||
### checking dependencies
|
|
||||||
local dep=(wget nginx unzip)
|
|
||||||
dependency_check "${dep[@]}"
|
|
||||||
### detect conflicting Haproxy and Apache2 installations
|
|
||||||
detect_conflicting_packages
|
|
||||||
|
|
||||||
status_msg "Initializing Mainsail installation ..."
|
|
||||||
### first, we create a backup of the full klipper_config dir - safety first!
|
|
||||||
backup_config_dir
|
|
||||||
|
|
||||||
### check for other enabled web interfaces
|
|
||||||
unset SET_LISTEN_PORT
|
|
||||||
detect_enabled_sites
|
|
||||||
|
|
||||||
### check if another site already listens to port 80
|
|
||||||
mainsail_port_check
|
|
||||||
|
|
||||||
### download mainsail
|
|
||||||
download_mainsail
|
|
||||||
|
|
||||||
### ask user to install the recommended webinterface macros
|
|
||||||
install_mainsail_macros
|
|
||||||
|
|
||||||
### create /etc/nginx/conf.d/upstreams.conf
|
|
||||||
set_upstream_nginx_cfg
|
|
||||||
### create /etc/nginx/sites-available/<interface config>
|
|
||||||
set_nginx_cfg "mainsail"
|
|
||||||
### nginx on ubuntu 21 and above needs special permissions to access the files
|
|
||||||
set_nginx_permissions
|
|
||||||
|
|
||||||
### symlink nginx log
|
|
||||||
symlink_webui_nginx_log "mainsail"
|
|
||||||
|
|
||||||
### add mainsail to the update manager in moonraker.conf
|
|
||||||
patch_mainsail_update_manager
|
|
||||||
|
|
||||||
fetch_webui_ports #WIP
|
|
||||||
|
|
||||||
### confirm message
|
|
||||||
print_confirm "Mainsail has been set up!"
|
|
||||||
}
|
|
||||||
|
|
||||||
function install_mainsail_macros() {
|
|
||||||
local yn
|
|
||||||
while true; do
|
|
||||||
echo
|
|
||||||
top_border
|
|
||||||
echo -e "| It is recommended to use special macros in order to |"
|
|
||||||
echo -e "| have Mainsail fully functional and working. |"
|
|
||||||
blank_line
|
|
||||||
echo -e "| The recommended macros for Mainsail can be seen here: |"
|
|
||||||
echo -e "| https://github.com/mainsail-crew/mainsail-config |"
|
|
||||||
blank_line
|
|
||||||
echo -e "| If you already use these macros skip this step. |"
|
|
||||||
echo -e "| Otherwise you should consider to answer with 'yes' to |"
|
|
||||||
echo -e "| download the recommended macros. |"
|
|
||||||
bottom_border
|
|
||||||
read -p "${cyan}###### Download the recommended macros? (Y/n):${white} " yn
|
|
||||||
case "${yn}" in
|
|
||||||
Y|y|Yes|yes|"")
|
|
||||||
select_msg "Yes"
|
|
||||||
download_mainsail_macros
|
|
||||||
break;;
|
|
||||||
N|n|No|no)
|
|
||||||
select_msg "No"
|
|
||||||
break;;
|
|
||||||
*)
|
|
||||||
print_error "Invalid command!";;
|
|
||||||
esac
|
|
||||||
done
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
function download_mainsail_macros() {
|
|
||||||
local ms_cfg_repo path configs regex line gcode_dir
|
|
||||||
|
|
||||||
ms_cfg_repo="https://github.com/mainsail-crew/mainsail-config.git"
|
|
||||||
regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/config\/printer\.cfg"
|
|
||||||
configs=$(find "${HOME}" -maxdepth 3 -regextype posix-extended -regex "${regex}" | sort)
|
|
||||||
|
|
||||||
if [[ -z ${configs} ]]; then
|
|
||||||
print_error "No printer.cfg found! Installation of Macros will be skipped ..."
|
|
||||||
log_error "execution stopped! reason: no printer.cfg found"
|
|
||||||
return
|
|
||||||
fi
|
|
||||||
|
|
||||||
status_msg "Cloning mainsail-config ..."
|
|
||||||
[[ -d "${HOME}/mainsail-config" ]] && rm -rf "${HOME}/mainsail-config"
|
|
||||||
if git clone "${ms_cfg_repo}" "${HOME}/mainsail-config"; then
|
|
||||||
for config in ${configs}; do
|
|
||||||
path=$(echo "${config}" | rev | cut -d"/" -f2- | rev)
|
|
||||||
|
|
||||||
if [[ -e "${path}/mainsail.cfg" && ! -h "${path}/mainsail.cfg" ]]; then
|
|
||||||
warn_msg "Attention! Existing mainsail.cfg detected!"
|
|
||||||
warn_msg "The file will be renamed to 'mainsail.bak.cfg' to be able to continue with the installation."
|
|
||||||
if ! mv "${path}/mainsail.cfg" "${path}/mainsail.bak.cfg"; then
|
|
||||||
error_msg "Renaming mainsail.cfg failed! Aborting installation ..."
|
|
||||||
return
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [[ -h "${path}/mainsail.cfg" ]]; then
|
|
||||||
warn_msg "Recreating symlink in ${path} ..."
|
|
||||||
rm -rf "${path}/mainsail.cfg"
|
|
||||||
fi
|
|
||||||
|
|
||||||
if ! ln -sf "${HOME}/mainsail-config/client.cfg" "${path}/mainsail.cfg"; then
|
|
||||||
error_msg "Creating symlink failed! Aborting installation ..."
|
|
||||||
return
|
|
||||||
fi
|
|
||||||
|
|
||||||
if ! grep -Eq "^\[include mainsail.cfg\]$" "${path}/printer.cfg"; then
|
|
||||||
log_info "${path}/printer.cfg"
|
|
||||||
sed -i "1 i [include mainsail.cfg]" "${path}/printer.cfg"
|
|
||||||
fi
|
|
||||||
|
|
||||||
line=$(($(grep -n "\[include mainsail.cfg\]" "${path}/printer.cfg" | tail -1 | cut -d: -f1) + 1))
|
|
||||||
gcode_dir=${path/config/gcodes}
|
|
||||||
if ! grep -Eq "^\[virtual_sdcard\]$" "${path}/printer.cfg"; then
|
|
||||||
log_info "${path}/printer.cfg"
|
|
||||||
sed -i "${line} i \[virtual_sdcard]\npath: ${gcode_dir}\non_error_gcode: CANCEL_PRINT\n" "${path}/printer.cfg"
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
else
|
|
||||||
print_error "Cloning failed! Aborting installation ..."
|
|
||||||
log_error "execution stopped! reason: cloning failed"
|
|
||||||
return
|
|
||||||
fi
|
|
||||||
|
|
||||||
patch_mainsail_config_update_manager
|
|
||||||
|
|
||||||
ok_msg "Done!"
|
|
||||||
}
|
|
||||||
|
|
||||||
function download_mainsail() {
|
|
||||||
local services
|
|
||||||
local url
|
|
||||||
url=$(get_mainsail_download_url)
|
|
||||||
|
|
||||||
status_msg "Downloading Mainsail from ${url} ..."
|
|
||||||
|
|
||||||
if [[ -d ${MAINSAIL_DIR} ]]; then
|
|
||||||
rm -rf "${MAINSAIL_DIR}"
|
|
||||||
fi
|
|
||||||
|
|
||||||
mkdir "${MAINSAIL_DIR}" && cd "${MAINSAIL_DIR}"
|
|
||||||
|
|
||||||
if wget "${url}"; then
|
|
||||||
ok_msg "Download complete!"
|
|
||||||
status_msg "Extracting archive ..."
|
|
||||||
unzip -q -o ./*.zip && ok_msg "Done!"
|
|
||||||
status_msg "Remove downloaded archive ..."
|
|
||||||
rm -rf ./*.zip && ok_msg "Done!"
|
|
||||||
else
|
|
||||||
print_error "Downloading Mainsail from\n ${url}\n failed!"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
### check for moonraker multi-instance and if no-instance or multi-instance was found, enable mainsails remoteMode
|
|
||||||
services=$(moonraker_systemd)
|
|
||||||
if [[ ( -z "${services}" ) || ( $(echo "${services}" | wc -w) -gt 1 ) ]]; then
|
|
||||||
enable_mainsail_remotemode
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
#===================================================#
|
|
||||||
#================= REMOVE MAINSAIL =================#
|
|
||||||
#===================================================#
|
|
||||||
|
|
||||||
function remove_mainsail_dir() {
|
|
||||||
[[ ! -d ${MAINSAIL_DIR} ]] && return
|
|
||||||
|
|
||||||
status_msg "Removing Mainsail directory ..."
|
|
||||||
rm -rf "${MAINSAIL_DIR}" && ok_msg "Directory removed!"
|
|
||||||
}
|
|
||||||
|
|
||||||
function remove_mainsail_nginx_config() {
|
|
||||||
if [[ -e "/etc/nginx/sites-available/mainsail" ]]; then
|
|
||||||
status_msg "Removing Mainsail configuration for Nginx ..."
|
|
||||||
sudo rm "/etc/nginx/sites-available/mainsail" && ok_msg "File removed!"
|
|
||||||
fi
|
|
||||||
if [[ -L "/etc/nginx/sites-enabled/mainsail" ]]; then
|
|
||||||
status_msg "Removing Mainsail Symlink for Nginx ..."
|
|
||||||
sudo rm "/etc/nginx/sites-enabled/mainsail" && ok_msg "File removed!"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
function remove_mainsail_logs() {
|
|
||||||
local files
|
|
||||||
files=$(find /var/log/nginx -name "mainsail*" 2> /dev/null | sort)
|
|
||||||
|
|
||||||
if [[ -n ${files} ]]; then
|
|
||||||
for file in ${files}; do
|
|
||||||
status_msg "Removing ${file} ..."
|
|
||||||
sudo rm -f "${file}"
|
|
||||||
ok_msg "${file} removed!"
|
|
||||||
done
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
function remove_mainsail_log_symlinks() {
|
|
||||||
local files regex
|
|
||||||
|
|
||||||
regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/logs\/mainsail-.*"
|
|
||||||
files=$(find "${HOME}" -maxdepth 3 -regextype posix-extended -regex "${regex}" 2> /dev/null | sort)
|
|
||||||
|
|
||||||
if [[ -n ${files} ]]; then
|
|
||||||
for file in ${files}; do
|
|
||||||
status_msg "Removing ${file} ..."
|
|
||||||
rm -f "${file}"
|
|
||||||
ok_msg "${file} removed!"
|
|
||||||
done
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
function remove_legacy_mainsail_log_symlinks() {
|
|
||||||
local files
|
|
||||||
files=$(find "${HOME}/klipper_logs" -name "mainsail*" 2> /dev/null | sort)
|
|
||||||
|
|
||||||
if [[ -n ${files} ]]; then
|
|
||||||
for file in ${files}; do
|
|
||||||
status_msg "Removing ${file} ..."
|
|
||||||
rm -f "${file}"
|
|
||||||
ok_msg "${file} removed!"
|
|
||||||
done
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
function remove_mainsail_config() {
|
|
||||||
if [[ -d "${HOME}/mainsail-config" ]]; then
|
|
||||||
status_msg "Removing ${HOME}/mainsail-config ..."
|
|
||||||
rm -rf "${HOME}/mainsail-config"
|
|
||||||
ok_msg "${HOME}/mainsail-config removed!"
|
|
||||||
print_confirm "Mainsail-Config successfully removed!"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
function remove_mainsail() {
|
|
||||||
remove_mainsail_dir
|
|
||||||
remove_mainsail_nginx_config
|
|
||||||
remove_mainsail_logs
|
|
||||||
remove_mainsail_log_symlinks
|
|
||||||
remove_legacy_mainsail_log_symlinks
|
|
||||||
|
|
||||||
### remove mainsail_port from ~/.kiauh.ini
|
|
||||||
sed -i "/^mainsail_port=/d" "${INI_FILE}"
|
|
||||||
|
|
||||||
print_confirm "Mainsail successfully removed!"
|
|
||||||
}
|
|
||||||
|
|
||||||
#===================================================#
|
|
||||||
#================= UPDATE MAINSAIL =================#
|
|
||||||
#===================================================#
|
|
||||||
|
|
||||||
function update_mainsail() {
|
|
||||||
backup_before_update "mainsail"
|
|
||||||
status_msg "Updating Mainsail ..."
|
|
||||||
download_mainsail
|
|
||||||
match_nginx_configs
|
|
||||||
symlink_webui_nginx_log "mainsail"
|
|
||||||
print_confirm "Mainsail successfully updated!"
|
|
||||||
}
|
|
||||||
|
|
||||||
#===================================================#
|
|
||||||
#================= MAINSAIL STATUS =================#
|
|
||||||
#===================================================#
|
|
||||||
|
|
||||||
function get_mainsail_status() {
|
|
||||||
local status
|
|
||||||
local data_arr=("${MAINSAIL_DIR}" "${NGINX_SA}/mainsail" "${NGINX_SE}/mainsail")
|
|
||||||
|
|
||||||
### count+1 for each found data-item from array
|
|
||||||
local filecount=0
|
|
||||||
for data in "${data_arr[@]}"; do
|
|
||||||
[[ -e ${data} ]] && filecount=$(( filecount + 1 ))
|
|
||||||
done
|
|
||||||
|
|
||||||
if (( filecount == ${#data_arr[*]} )); then
|
|
||||||
status="Installed!"
|
|
||||||
elif (( filecount == 0 )); then
|
|
||||||
status="Not installed!"
|
|
||||||
else
|
|
||||||
status="Incomplete!"
|
|
||||||
fi
|
|
||||||
echo "${status}"
|
|
||||||
}
|
|
||||||
|
|
||||||
function get_local_mainsail_version() {
|
|
||||||
local versionfile="${MAINSAIL_DIR}/.version"
|
|
||||||
local relinfofile="${MAINSAIL_DIR}/release_info.json"
|
|
||||||
local version
|
|
||||||
|
|
||||||
if [[ -f ${relinfofile} ]]; then
|
|
||||||
version=$(grep -o '"version":"[^"]*' "${relinfofile}" | grep -o '[^"]*$')
|
|
||||||
elif [[ -f ${versionfile} ]]; then
|
|
||||||
version=$(head -n 1 "${versionfile}")
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo "${version}"
|
|
||||||
}
|
|
||||||
|
|
||||||
function get_remote_mainsail_version() {
|
|
||||||
[[ ! $(dpkg-query -f'${Status}' --show curl 2>/dev/null) = *\ installed ]] && return
|
|
||||||
|
|
||||||
local tags
|
|
||||||
tags=$(curl -s "https://api.github.com/repos/mainsail-crew/mainsail/tags" | grep "name" | cut -d'"' -f4)
|
|
||||||
echo "${tags}" | head -1
|
|
||||||
}
|
|
||||||
|
|
||||||
function compare_mainsail_versions() {
|
|
||||||
local versions local_ver remote_ver
|
|
||||||
local_ver="$(get_local_mainsail_version)"
|
|
||||||
remote_ver="$(get_remote_mainsail_version)"
|
|
||||||
|
|
||||||
if [[ ${local_ver} != "${remote_ver}" && ${local_ver} != "" ]]; then
|
|
||||||
versions="${yellow}$(printf " %-14s" "${local_ver}")${white}"
|
|
||||||
versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
|
|
||||||
# add moonraker to application_updates_available in kiauh.ini
|
|
||||||
add_to_application_updates "mainsail"
|
|
||||||
else
|
|
||||||
versions="${green}$(printf " %-14s" "${local_ver}")${white}"
|
|
||||||
versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo "${versions}"
|
|
||||||
}
|
|
||||||
|
|
||||||
#================================================#
|
|
||||||
#=========== MAINSAIL THEME INSTALLER ===========#
|
|
||||||
#================================================#
|
|
||||||
|
|
||||||
function print_theme_list() {
|
|
||||||
local i=0 theme_list=${1}
|
|
||||||
|
|
||||||
while IFS="," read -r col1 col2 col3 col4; do
|
|
||||||
if [[ ${col1} != "name" ]]; then
|
|
||||||
printf "| ${i}) %-51s|\n" "[${col1}]"
|
|
||||||
fi
|
|
||||||
i=$(( i + 1 ))
|
|
||||||
done <<< "${theme_list}"
|
|
||||||
}
|
|
||||||
|
|
||||||
function ms_theme_installer_menu() {
|
|
||||||
local theme_list theme_author theme_repo theme_name theme_note theme_url
|
|
||||||
local theme_csv_url="https://raw.githubusercontent.com/mainsail-crew/gb-docs/main/_data/themes.csv"
|
|
||||||
theme_list=$(curl -s -L "${theme_csv_url}")
|
|
||||||
|
|
||||||
top_border
|
|
||||||
echo -e "| ${red}~~~~~~~~ [ Mainsail Theme Installer ] ~~~~~~~${white} |"
|
|
||||||
hr
|
|
||||||
echo -e "| ${cyan}A preview of each Mainsail theme can be found here:${white} |"
|
|
||||||
echo -e "| https://docs.mainsail.xyz/theming/themes |"
|
|
||||||
blank_line
|
|
||||||
echo -e "| ${yellow}Important note:${white} |"
|
|
||||||
echo -e "| Installing a theme from this menu will overwrite an |"
|
|
||||||
echo -e "| already installed theme or modified custom.css file! |"
|
|
||||||
hr
|
|
||||||
print_theme_list "${theme_list}"
|
|
||||||
echo -e "| |"
|
|
||||||
echo -e "| R) [Remove Theme] |"
|
|
||||||
back_footer
|
|
||||||
|
|
||||||
while IFS="," read -r col1 col2 col3 col4; do
|
|
||||||
theme_name+=("${col1}")
|
|
||||||
theme_note+=("${col2}")
|
|
||||||
theme_author+=("${col3}")
|
|
||||||
theme_repo+=("${col4}")
|
|
||||||
done <<< "${theme_list}"
|
|
||||||
|
|
||||||
local option
|
|
||||||
while true; do
|
|
||||||
read -p "${cyan}Install theme:${white} " option
|
|
||||||
if (( option > 0 && option < ${#theme_name[@]} )); then
|
|
||||||
theme_url="https://github.com/${theme_author[${option}]}/${theme_repo[${option}]}"
|
|
||||||
ms_theme_install "${theme_url}" "${theme_name[${option}]}" "${theme_note[${option}]}"
|
|
||||||
break
|
|
||||||
elif [[ ${option} == "R" || ${option} == "r" ]]; then
|
|
||||||
ms_theme_delete
|
|
||||||
break
|
|
||||||
elif [[ ${option} == "B" || ${option} == "b" ]]; then
|
|
||||||
advanced_menu
|
|
||||||
break
|
|
||||||
else
|
|
||||||
error_msg "Invalid command!"
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
ms_theme_installer_menu
|
|
||||||
}
|
|
||||||
|
|
||||||
function ms_theme_install() {
|
|
||||||
read_kiauh_ini "${FUNCNAME[0]}"
|
|
||||||
|
|
||||||
local theme_url
|
|
||||||
local theme_name
|
|
||||||
local theme_note
|
|
||||||
theme_url=${1}
|
|
||||||
theme_name=${2}
|
|
||||||
theme_note=${3}
|
|
||||||
|
|
||||||
local folder_arr
|
|
||||||
local folder_names="${multi_instance_names}"
|
|
||||||
local target_folders=()
|
|
||||||
|
|
||||||
IFS=',' read -r -a folder_arr <<< "${folder_names}"
|
|
||||||
|
|
||||||
### build theme target folder array
|
|
||||||
if (( ${#folder_arr[@]} > 1 )); then
|
|
||||||
for folder in "${folder_arr[@]}"; do
|
|
||||||
### instance names/identifier of only numbers need to be prefixed with 'printer_'
|
|
||||||
if [[ ${folder} =~ ^[0-9]+$ ]]; then
|
|
||||||
target_folders+=("${HOME}/printer_${folder}_data/config")
|
|
||||||
else
|
|
||||||
target_folders+=("${HOME}/${folder}_data/config")
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
else
|
|
||||||
target_folders+=("${HOME}/printer_data/config")
|
|
||||||
fi
|
|
||||||
|
|
||||||
if (( ${#target_folders[@]} > 1 )); then
|
|
||||||
top_border
|
|
||||||
echo -e "| Please select the printer you want to apply the theme |"
|
|
||||||
echo -e "| installation to: |"
|
|
||||||
for (( i=0; i < ${#target_folders[@]}; i++ )); do
|
|
||||||
folder=$(echo "${target_folders[${i}]}" | rev | cut -d "/" -f2 | cut -d"_" -f2- | rev)
|
|
||||||
printf "|${cyan}%-55s${white}|\n" " ${i}) ${folder}"
|
|
||||||
done
|
|
||||||
bottom_border
|
|
||||||
|
|
||||||
local target re="^[0-9]*$"
|
|
||||||
while true; do
|
|
||||||
read -p "${cyan}###### Select printer:${white} " target
|
|
||||||
### break while loop if input is valid, else display error
|
|
||||||
[[ ${target} =~ ${re} && ${target} -lt ${#target_folders[@]} ]] && break
|
|
||||||
error_msg "Invalid command!"
|
|
||||||
done
|
|
||||||
fi
|
|
||||||
|
|
||||||
[[ -d "${target_folders[${target}]}/.theme" ]] && rm -rf "${target_folders[${target}]}/.theme"
|
|
||||||
|
|
||||||
status_msg "Installing '${theme_name}' to ${target_folders[${target}]} ..."
|
|
||||||
cd "${target_folders[${target}]}"
|
|
||||||
|
|
||||||
if git clone "${theme_url}" ".theme"; then
|
|
||||||
ok_msg "Theme installation complete!"
|
|
||||||
[[ -n ${theme_note} ]] && echo "${yellow}###### Theme Info: ${theme_note}${white}"
|
|
||||||
ok_msg "Please remember to delete your browser cache!\n"
|
|
||||||
else
|
|
||||||
error_msg "Theme installation failed!\n"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
function ms_theme_delete() {
|
|
||||||
local regex theme_folders target_folders=()
|
|
||||||
|
|
||||||
regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/config\/\.theme"
|
|
||||||
theme_folders=$(find "${HOME}" -maxdepth 3 -type d -regextype posix-extended -regex "${regex}" | sort)
|
|
||||||
# theme_folders=$(find "${KLIPPER_CONFIG}" -mindepth 1 -type d -name ".theme" | sort)
|
|
||||||
|
|
||||||
### build target folder array
|
|
||||||
for folder in ${theme_folders}; do
|
|
||||||
target_folders+=("${folder}")
|
|
||||||
done
|
|
||||||
|
|
||||||
if (( ${#target_folders[@]} == 0 )); then
|
|
||||||
status_msg "No Themes installed!\n"
|
|
||||||
return
|
|
||||||
elif (( ${#target_folders[@]} > 1 )); then
|
|
||||||
top_border
|
|
||||||
echo -e "| Please select the printer you want to remove the |"
|
|
||||||
echo -e "| theme installation from. |"
|
|
||||||
for (( i=0; i < ${#target_folders[@]}; i++ )); do
|
|
||||||
folder=$(echo "${target_folders[${i}]}" | rev | cut -d "/" -f2 | rev)
|
|
||||||
printf "|${cyan}%-55s${white}|\n" " ${i}) ${folder}"
|
|
||||||
done
|
|
||||||
bottom_border
|
|
||||||
|
|
||||||
local target re="^[0-9]*$"
|
|
||||||
while true; do
|
|
||||||
read -p "${cyan}###### Select printer:${white} " target
|
|
||||||
### break while loop if input is valid, else display error
|
|
||||||
[[ ${target} =~ ${re} && ${target} -lt ${#target_folders[@]} ]] && break
|
|
||||||
error_msg "Invalid command!"
|
|
||||||
done
|
|
||||||
fi
|
|
||||||
|
|
||||||
status_msg "Removing ${target_folders[${target}]} ..."
|
|
||||||
rm -rf "${target_folders[${target}]}" && ok_msg "Theme removed!\n"
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
#================================================#
|
|
||||||
#=================== HELPERS ====================#
|
|
||||||
#================================================#
|
|
||||||
|
|
||||||
function get_mainsail_download_url() {
|
|
||||||
local releases_by_tag tags tag unstable_url url
|
|
||||||
|
|
||||||
### latest stable download url
|
|
||||||
url="https://github.com/mainsail-crew/mainsail/releases/latest/download/mainsail.zip"
|
|
||||||
|
|
||||||
read_kiauh_ini "${FUNCNAME[0]}"
|
|
||||||
if [[ ${mainsail_install_unstable} == "true" ]]; then
|
|
||||||
releases_by_tag="https://api.github.com/repos/mainsail-crew/mainsail/tags"
|
|
||||||
tags=$(curl -s "${releases_by_tag}" | grep "name" | cut -d'"' -f4)
|
|
||||||
tag=$(echo "${tags}" | head -1)
|
|
||||||
|
|
||||||
### latest unstable download url including pre-releases (alpha, beta, rc)
|
|
||||||
unstable_url="https://github.com/mainsail-crew/mainsail/releases/download/${tag}/mainsail.zip"
|
|
||||||
|
|
||||||
if [[ ${unstable_url} == *"download//"* ]]; then
|
|
||||||
warn_msg "Download URL broken! Falling back to URL of latest stable release!"
|
|
||||||
else
|
|
||||||
url=${unstable_url}
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo "${url}"
|
|
||||||
}
|
|
||||||
|
|
||||||
function mainsail_port_check() {
|
|
||||||
if [[ ${MAINSAIL_ENABLED} == "false" ]]; then
|
|
||||||
|
|
||||||
if [[ ${SITE_ENABLED} == "true" ]]; then
|
|
||||||
status_msg "Detected other enabled interfaces:"
|
|
||||||
|
|
||||||
[[ ${FLUIDD_ENABLED} == "true" ]] && \
|
|
||||||
echo -e " ${cyan}● Fluidd - Port: ${FLUIDD_PORT}${white}"
|
|
||||||
|
|
||||||
if [[ ${FLUIDD_PORT} == "80" ]]; then
|
|
||||||
PORT_80_BLOCKED="true"
|
|
||||||
select_mainsail_port
|
|
||||||
fi
|
|
||||||
else
|
|
||||||
DEFAULT_PORT=$(grep listen "${KIAUH_SRCDIR}/resources/mainsail" | head -1 | sed 's/^\s*//' | cut -d" " -f2 | cut -d";" -f1)
|
|
||||||
SET_LISTEN_PORT=${DEFAULT_PORT}
|
|
||||||
fi
|
|
||||||
SET_NGINX_CFG="true"
|
|
||||||
|
|
||||||
else
|
|
||||||
SET_NGINX_CFG="false"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
function select_mainsail_port() {
|
|
||||||
if [[ ${PORT_80_BLOCKED} == "true" ]]; then
|
|
||||||
echo
|
|
||||||
top_border
|
|
||||||
echo -e "| ${red}!!!WARNING!!!${white} |"
|
|
||||||
echo -e "| ${red}You need to choose a different port for Mainsail!${white} |"
|
|
||||||
echo -e "| ${red}The following web interface is listening at port 80:${white} |"
|
|
||||||
blank_line
|
|
||||||
[[ ${FLUIDD_PORT} == "80" ]] && echo "| ● Fluidd |"
|
|
||||||
blank_line
|
|
||||||
echo -e "| Make sure you don't choose a port which was already |"
|
|
||||||
echo -e "| assigned to another webinterface! |"
|
|
||||||
blank_line
|
|
||||||
echo -e "| Be aware: there is ${red}NO${white} sanity check for the following |"
|
|
||||||
echo -e "| input. So make sure to choose a valid port! |"
|
|
||||||
bottom_border
|
|
||||||
|
|
||||||
local new_port re="^[0-9]+$"
|
|
||||||
while true; do
|
|
||||||
read -p "${cyan}Please enter a new Port:${white} " new_port
|
|
||||||
if [[ ${new_port} =~ ${re} && ${new_port} != "${FLUIDD_PORT}" ]]; then
|
|
||||||
select_msg "Setting port ${new_port} for Mainsail!"
|
|
||||||
SET_LISTEN_PORT=${new_port}
|
|
||||||
break
|
|
||||||
else
|
|
||||||
if [[ ! ${new_port} =~ ${re} ]]; then
|
|
||||||
error_msg "Invalid input!"
|
|
||||||
else
|
|
||||||
error_msg "Port already taken! Select a different one!"
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
function enable_mainsail_remotemode() {
|
|
||||||
[[ ! -f "${MAINSAIL_DIR}/config.json" ]] && return
|
|
||||||
|
|
||||||
status_msg "Setting instance storage location to 'browser' ..."
|
|
||||||
sed -i 's|"instancesDB": "moonraker"|"instancesDB": "browser"|' "${MAINSAIL_DIR}/config.json"
|
|
||||||
ok_msg "Done!"
|
|
||||||
}
|
|
||||||
|
|
||||||
function patch_mainsail_update_manager() {
|
|
||||||
local patched moonraker_configs regex
|
|
||||||
regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/config\/moonraker\.conf"
|
|
||||||
moonraker_configs=$(find "${HOME}" -maxdepth 3 -type f -regextype posix-extended -regex "${regex}" | sort)
|
|
||||||
|
|
||||||
patched="false"
|
|
||||||
for conf in ${moonraker_configs}; do
|
|
||||||
if ! grep -Eq "^\[update_manager mainsail\]\s*$" "${conf}"; then
|
|
||||||
### add new line to conf if it doesn't end with one
|
|
||||||
[[ $(tail -c1 "${conf}" | wc -l) -eq 0 ]] && echo "" >> "${conf}"
|
|
||||||
|
|
||||||
### add Mainsails update manager section to moonraker.conf
|
|
||||||
status_msg "Adding Mainsail to update manager in file:\n ${conf}"
|
|
||||||
/bin/sh -c "cat >> ${conf}" << MOONRAKER_CONF
|
|
||||||
|
|
||||||
[update_manager mainsail]
|
|
||||||
type: web
|
|
||||||
channel: stable
|
|
||||||
repo: mainsail-crew/mainsail
|
|
||||||
path: ~/mainsail
|
|
||||||
MOONRAKER_CONF
|
|
||||||
|
|
||||||
fi
|
|
||||||
|
|
||||||
patched="true"
|
|
||||||
done
|
|
||||||
|
|
||||||
if [[ ${patched} == "true" ]]; then
|
|
||||||
do_action_service "restart" "moonraker"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
function patch_mainsail_config_update_manager() {
|
|
||||||
local patched moonraker_configs regex
|
|
||||||
regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/config\/moonraker\.conf"
|
|
||||||
moonraker_configs=$(find "${HOME}" -maxdepth 3 -type f -regextype posix-extended -regex "${regex}" | sort)
|
|
||||||
|
|
||||||
patched="false"
|
|
||||||
for conf in ${moonraker_configs}; do
|
|
||||||
if ! grep -Eq "^\[update_manager mainsail-config\]\s*$" "${conf}"; then
|
|
||||||
### add new line to conf if it doesn't end with one
|
|
||||||
[[ $(tail -c1 "${conf}" | wc -l) -eq 0 ]] && echo "" >> "${conf}"
|
|
||||||
|
|
||||||
### add Mainsails update manager section to moonraker.conf
|
|
||||||
status_msg "Adding Mainsail-Config to update manager in file:\n ${conf}"
|
|
||||||
/bin/sh -c "cat >> ${conf}" << MOONRAKER_CONF
|
|
||||||
|
|
||||||
[update_manager mainsail-config]
|
|
||||||
type: git_repo
|
|
||||||
primary_branch: master
|
|
||||||
path: ~/mainsail-config
|
|
||||||
origin: https://github.com/mainsail-crew/mainsail-config.git
|
|
||||||
managed_services: klipper
|
|
||||||
MOONRAKER_CONF
|
|
||||||
|
|
||||||
fi
|
|
||||||
|
|
||||||
patched="true"
|
|
||||||
done
|
|
||||||
|
|
||||||
if [[ ${patched} == "true" ]]; then
|
|
||||||
do_action_service "restart" "moonraker"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
@@ -1,193 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
|
|
||||||
#=======================================================================#
|
|
||||||
# Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com> #
|
|
||||||
# #
|
|
||||||
# This file is part of KIAUH - Klipper Installation And Update Helper #
|
|
||||||
# https://github.com/dw-0/kiauh #
|
|
||||||
# #
|
|
||||||
# This file may be distributed under the terms of the GNU GPLv3 license #
|
|
||||||
#=======================================================================#
|
|
||||||
|
|
||||||
set -e
|
|
||||||
|
|
||||||
#=================================================#
|
|
||||||
#============= INSTALL MJPG-STREAMER =============#
|
|
||||||
#=================================================#
|
|
||||||
|
|
||||||
function install_mjpg-streamer() {
|
|
||||||
local webcamd="${KIAUH_SRCDIR}/resources/mjpg-streamer/webcamd"
|
|
||||||
local webcam_txt="${KIAUH_SRCDIR}/resources/mjpg-streamer/webcam.txt"
|
|
||||||
local service="${KIAUH_SRCDIR}/resources/mjpg-streamer/webcamd.service"
|
|
||||||
local repo="https://github.com/jacksonliam/mjpg-streamer.git"
|
|
||||||
|
|
||||||
### return early if webcamd.service already exists
|
|
||||||
if [[ -f "${SYSTEMD}/webcamd.service" ]]; then
|
|
||||||
print_error "Looks like MJPG-streamer is already installed!\n Please remove it first before you try to re-install it!"
|
|
||||||
return
|
|
||||||
fi
|
|
||||||
|
|
||||||
status_msg "Initializing MJPG-Streamer installation ..."
|
|
||||||
|
|
||||||
### check and install dependencies if missing
|
|
||||||
local dep=(git cmake build-essential imagemagick libv4l-dev ffmpeg)
|
|
||||||
if apt-cache search libjpeg62-turbo-dev | grep -Eq "^libjpeg62-turbo-dev "; then
|
|
||||||
dep+=(libjpeg62-turbo-dev)
|
|
||||||
elif apt-cache search libjpeg8-dev | grep -Eq "^libjpeg8-dev "; then
|
|
||||||
dep+=(libjpeg8-dev)
|
|
||||||
fi
|
|
||||||
|
|
||||||
dependency_check "${dep[@]}"
|
|
||||||
|
|
||||||
### step 1: clone mjpg-streamer
|
|
||||||
status_msg "Cloning MJPG-Streamer from ${repo} ..."
|
|
||||||
[[ -d "${HOME}/mjpg-streamer" ]] && rm -rf "${HOME}/mjpg-streamer"
|
|
||||||
|
|
||||||
cd "${HOME}" || exit 1
|
|
||||||
if ! git clone "${repo}" "${HOME}/mjpg-streamer"; then
|
|
||||||
print_error "Cloning MJPG-Streamer from\n ${repo}\n failed!"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
ok_msg "Cloning complete!"
|
|
||||||
|
|
||||||
### step 2: compiling mjpg-streamer
|
|
||||||
status_msg "Compiling MJPG-Streamer ..."
|
|
||||||
cd "${HOME}/mjpg-streamer/mjpg-streamer-experimental"
|
|
||||||
if ! make; then
|
|
||||||
print_error "Compiling MJPG-Streamer failed!"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
ok_msg "Compiling complete!"
|
|
||||||
|
|
||||||
#step 3: install mjpg-streamer
|
|
||||||
status_msg "Installing MJPG-Streamer ..."
|
|
||||||
cd "${HOME}/mjpg-streamer" && mv mjpg-streamer-experimental/* .
|
|
||||||
mkdir www-mjpgstreamer
|
|
||||||
|
|
||||||
cat <<EOT >> ./www-mjpgstreamer/index.html
|
|
||||||
<html>
|
|
||||||
<head><title>mjpg_streamer test page</title></head>
|
|
||||||
<body>
|
|
||||||
<h1>Snapshot</h1>
|
|
||||||
<p>Refresh the page to refresh the snapshot</p>
|
|
||||||
<img src="./?action=snapshot" alt="Snapshot">
|
|
||||||
<h1>Stream</h1>
|
|
||||||
<img src="./?action=stream" alt="Stream">
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
EOT
|
|
||||||
|
|
||||||
sudo cp "${webcamd}" "/usr/local/bin/webcamd"
|
|
||||||
sudo sed -i "/^config_dir=/ s|=.*|=${KLIPPER_CONFIG}|" /usr/local/bin/webcamd
|
|
||||||
sudo sed -i "/MJPGSTREAMER_HOME/ s/pi/${USER}/" /usr/local/bin/webcamd
|
|
||||||
sudo chmod +x /usr/local/bin/webcamd
|
|
||||||
|
|
||||||
### step 4: create webcam.txt config file
|
|
||||||
[[ ! -d ${KLIPPER_CONFIG} ]] && mkdir -p "${KLIPPER_CONFIG}"
|
|
||||||
if [[ ! -f "${KLIPPER_CONFIG}/webcam.txt" ]]; then
|
|
||||||
status_msg "Creating webcam.txt config file ..."
|
|
||||||
cp "${webcam_txt}" "${KLIPPER_CONFIG}/webcam.txt"
|
|
||||||
ok_msg "Done!"
|
|
||||||
fi
|
|
||||||
|
|
||||||
### step 5: create systemd service
|
|
||||||
status_msg "Creating MJPG-Streamer service ..."
|
|
||||||
sudo cp "${service}" "${SYSTEMD}/webcamd.service"
|
|
||||||
sudo sed -i "s|%USER%|${USER}|" "${SYSTEMD}/webcamd.service"
|
|
||||||
ok_msg "MJPG-Streamer service created!"
|
|
||||||
|
|
||||||
### step 6: enabling and starting mjpg-streamer service
|
|
||||||
status_msg "Starting MJPG-Streamer service, please wait ..."
|
|
||||||
sudo systemctl enable webcamd.service
|
|
||||||
if sudo systemctl start webcamd.service; then
|
|
||||||
ok_msg "MJPG-Streamer service started!"
|
|
||||||
else
|
|
||||||
status_msg "MJPG-Streamer service couldn't be started! No webcam connected?\n###### You need to manually restart the service once your webcam is set up correctly."
|
|
||||||
fi
|
|
||||||
|
|
||||||
### step 6.1: create webcamd.log symlink
|
|
||||||
[[ ! -d ${KLIPPER_LOGS} ]] && mkdir -p "${KLIPPER_LOGS}"
|
|
||||||
if [[ -f "/var/log/webcamd.log" && ! -L "${KLIPPER_LOGS}/webcamd.log" ]]; then
|
|
||||||
ln -s "/var/log/webcamd.log" "${KLIPPER_LOGS}/webcamd.log"
|
|
||||||
fi
|
|
||||||
|
|
||||||
### step 6.2: add webcamd.log logrotate
|
|
||||||
if [[ ! -f "/etc/logrotate.d/webcamd" ]]; then
|
|
||||||
status_msg "Create logrotate rule ..."
|
|
||||||
sudo /bin/sh -c "cat > /etc/logrotate.d/webcamd" << EOF
|
|
||||||
/var/log/webcamd.log
|
|
||||||
{
|
|
||||||
rotate 2
|
|
||||||
weekly
|
|
||||||
maxsize 32M
|
|
||||||
missingok
|
|
||||||
notifempty
|
|
||||||
compress
|
|
||||||
delaycompress
|
|
||||||
sharedscripts
|
|
||||||
}
|
|
||||||
EOF
|
|
||||||
ok_msg "Done!"
|
|
||||||
fi
|
|
||||||
|
|
||||||
### step 7: check if user is in group "video"
|
|
||||||
local usergroup_changed="false"
|
|
||||||
if ! groups "${USER}" | grep -q "video"; then
|
|
||||||
status_msg "Adding user '${USER}' to group 'video' ..."
|
|
||||||
sudo usermod -a -G video "${USER}" && ok_msg "Done!"
|
|
||||||
usergroup_changed="true"
|
|
||||||
fi
|
|
||||||
|
|
||||||
### confirm message
|
|
||||||
local confirm_msg="MJPG-Streamer has been set up!"
|
|
||||||
if [[ ${usergroup_changed} == "true" ]]; then
|
|
||||||
confirm_msg="${confirm_msg}\n ${yellow}INFO: Your User was added to a new group!${green}"
|
|
||||||
confirm_msg="${confirm_msg}\n ${yellow}You need to relog/restart for the group to be applied!${green}"
|
|
||||||
fi
|
|
||||||
|
|
||||||
print_confirm "${confirm_msg}"
|
|
||||||
|
|
||||||
### print webcam ip adress/url
|
|
||||||
local ip
|
|
||||||
ip=$(hostname -I | cut -d" " -f1)
|
|
||||||
local cam_url="http://${ip}:8080/?action=stream"
|
|
||||||
local cam_url_alt="http://${ip}/webcam/?action=stream"
|
|
||||||
echo -e " ${cyan}● Webcam URL:${white} ${cam_url}"
|
|
||||||
echo -e " ${cyan}● Webcam URL:${white} ${cam_url_alt}"
|
|
||||||
echo
|
|
||||||
}
|
|
||||||
|
|
||||||
#=================================================#
|
|
||||||
#============== REMOVE MJPG-STREAMER =============#
|
|
||||||
#=================================================#
|
|
||||||
|
|
||||||
function remove_mjpg-streamer() {
|
|
||||||
### remove MJPG-Streamer service
|
|
||||||
if [[ -e "${SYSTEMD}/webcamd.service" ]]; then
|
|
||||||
status_msg "Removing MJPG-Streamer service ..."
|
|
||||||
sudo systemctl stop webcamd && sudo systemctl disable webcamd
|
|
||||||
sudo rm -f "${SYSTEMD}/webcamd.service"
|
|
||||||
###reloading units
|
|
||||||
sudo systemctl daemon-reload
|
|
||||||
sudo systemctl reset-failed
|
|
||||||
ok_msg "MJPG-Streamer Service removed!"
|
|
||||||
fi
|
|
||||||
|
|
||||||
### remove webcamd from /usr/local/bin
|
|
||||||
if [[ -e "/usr/local/bin/webcamd" ]]; then
|
|
||||||
sudo rm -f "/usr/local/bin/webcamd"
|
|
||||||
fi
|
|
||||||
|
|
||||||
### remove MJPG-Streamer directory
|
|
||||||
if [[ -d "${HOME}/mjpg-streamer" ]]; then
|
|
||||||
status_msg "Removing MJPG-Streamer directory ..."
|
|
||||||
rm -rf "${HOME}/mjpg-streamer"
|
|
||||||
ok_msg "MJPG-Streamer directory removed!"
|
|
||||||
fi
|
|
||||||
|
|
||||||
### remove webcamd log and symlink
|
|
||||||
[[ -f "/var/log/webcamd.log" ]] && sudo rm -f "/var/log/webcamd.log"
|
|
||||||
[[ -L "${KLIPPER_LOGS}/webcamd.log" ]] && rm -f "${KLIPPER_LOGS}/webcamd.log"
|
|
||||||
|
|
||||||
print_confirm "MJPG-Streamer successfully removed!"
|
|
||||||
}
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user