# Klipper_Auto_Save_Config_Plugin

**Repository Path**: 676758285/klipper_auto_save_config_plugin

## Basic Information

- **Project Name**: Klipper_Auto_Save_Config_Plugin
- **Description**: 用于Klipper自动上传配置插件 基于阿里云OSS
- **Primary Language**: Python
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-06-30
- **Last Updated**: 2022-07-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<!-- PROJECT LOGO -->
<br />
<p align="center">
  <a href="https://gitee.com/676758285/klipper_auto_save_config_plugin">
    <img src="https://gitee.com/676758285/klipper_auto_save_config_plugin/raw/master/img/LOGO.png" alt="Logo" width="500" height="500">
  </a>

  <h3 align="center">Klipper_Auto_Save_Config_Plugin</h3>

  <p align="center">
    一款应用于 klipper 自动上传配置到OSS的插件
    <br />
    <a href="https://space.bilibili.com/123363171?spm_id_from=333.337.0.0"><strong>骚栋个人B站主页 »</strong></a>
    <br />
    <br />
    <a href="https://gitee.com/676758285/klipper_auto_save_config_plugin/issues">提Bug</a>
    ·
    <a href="https://gitee.com/676758285/klipper_auto_save_config_plugin/issues">提需求</a>
  </p>
</p>


<!-- 目录 -->
<details open="open">
  <summary>目录</summary>
  <ol>
    <li>
      <a href="#关于插件">关于插件</a>
      <ul>
        <li><a href="#使用技术">使用技术</a></li>
      </ul>
    </li>
    <li>
      <a href="#导入插件">插件导入</a>
      <ul>
        <li><a href="#前期准备">前期准备</a></li>
        <li><a href="#导入">导入</a></li>
      </ul>
    </li>
    <li><a href="#使用示例">使用示例</a></li>
    <li><a href="#联系我">联系我</a></li>

  </ol>
</details>



<!-- About-Project -->
## 关于插件


由于配置文件的重要性 很多时候当系统宕机或者无法恢复的时候,配置文件需要重新做一份,除了手动备份,别无它的选择,所以这里我采用阿里云OSS的方案,对文件进行自动的存储



### 使用技术

涉及到的相关基础:
* [Python3](https://www.python.org/)


<!-- Import -->
## 导入插件

### 前期准备

首先你必须安装了 MainsailOS 和 Fluidd,可以方便后期的管理
* [MainsailOS](https://github.com/meteyou/mainsail)
* [Fluidd](https://github.com/cadriel/fluidd)
* 上位机(树莓派或者香橙派)需要python3的环境❗️❗️❗️❗️

### 导入

1. 如果当前的用户不是你安装Klipper用户,例如当前用户是root等,请先切换一下用户.假设安装用户名为klipper,那么如下操作即可.(可选步骤.)

   ```sh
    su klipper
   ```
2. 首先进入就是切换到你安装 Klipper的目录下, 如果是树莓派,应该在 `/home/pi`,如果是香橙派的Debian系统 则应该是 `/home/orangepi`. 我们可以直接使用下面命令完成文件夹切换.

   ```sh
   cd ~
   ```
3. 下载源码
    ```sh
   git clone https://gitee.com/676758285/klipper_auto_save_config_plugin.git
   ```
4. 直接运行编译源码中的注入脚本 `install.sh`
	```sh
   bash ./klipper_auto_save_config_plugin/scripts/install.sh
   ```

5. 然后在 Klipper的 moonraker.conf 中 添加如下代码, 方便后期升级更新.


	```sh
    [octoprint_compat]

    [update_manager]

    [update_manager client Klipper_Auto_Save_Config_Plugin]
    type: git_repo
    path: ~/klipper_auto_save_config_plugin
    origin: https://gitee.com/676758285/klipper_auto_save_config_plugin.git
    ```

6. 添加完成上面信息之后,保存并且重启Klipper.
7. 然后在配置页面`Klipper_AutoSave.cfg`中,设置上传阿里云OSS的相关配置

	``` Python
        [FilePaths]
        # 可不添加任何路径,那么脚本不会执行上传操作
        # 格式: 文件名称+后缀 = 文件完整路径 
        #printer.cfg = /home/orangepi/klipper_config/printer.cfg
        
        [Save-Config]
        # 0: don't Open OSS Update 1: open OSS Save Update
        # 默认关闭OSS服务
        isOpen = 0 
        # Endpoint填写Bucket所在地域对应的Endpoint。以华东1（杭州）为例，Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com。
        EndPoint = https://oss-cn-beijing.aliyuncs.com
        # Bucket 名称
        BucketName = BucketName
        AccessKeyId = AccessKeyId
        AccessKeySecret = AccessKeySecret
        # 保存到OSS上的路径 / 为根路径 
        # 如果 想要保存到 save文件下的 config 中 则值改为 save/config 即可. 
        # 例 : SaveMkdirPath = save/config
        SaveMkdirPath = /
    ```

8. 手动启动脚本,我们只需要在SSH的命令使用如下命令就可以了.

	``` sh
    python3 ~/klipper_auto_save_config_plugin/scripts/config_auto_save.py
    ```


9. 如果想要开机自启动的话,我们需要编辑 `/etc/rc.local` 文件,首先打开文件.

	``` sh
    sudo nano /etc/rc.local
    ```
10. 然后在 `exit 0` 之前添加上执行代码 `python3 ~/klipper_auto_save_config_plugin/scripts/config_auto_save.py`即可.整体如下所示.

	``` sh
    #!/bin/sh -e
    #
    # rc.local
    #
    # This script is executed at the end of each multiuser runlevel.
    # Make sure that the script will "exit 0" on success or any other
    # value on error.
    #
    # In order to enable or disable this script just change the execution
    # bits.
    #
    # By default this script does nothing.
    python3 ~/klipper_auto_save_config_plugin/scripts/config_auto_save.py
    exit 0
    ```
11. 然后 `Ctrl + O` 回车保存, `Ctrl + X` 退出编辑.



<!-- 使用 -->
## 联系我

如果有问题,可以联系邮箱 676758285@qq.com 或者 加 QQ 676758285.



### End