From e0517738b2f862f5a57b362a81b02226fbf9f78d Mon Sep 17 00:00:00 2001
From: Sgr A* VMT <1611902585@qq.com>
Date: Sat, 12 Aug 2023 12:51:19 +0000
Subject: [PATCH] add README.md.

Signed-off-by: Sgr A* VMT <1611902585@qq.com>
---
 README.md | 83 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 83 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a486ba3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,83 @@
+# IDM scanner
+
+#### 介绍
+idm scanner 上位机python代码
+修改自beacon
+
+#### 软件架构
+软件架构说明
+
+
+#### 安装教程
+
+解压后拖到klipper文件夹所在的用户目录
+执行install.sh
+
+#### 使用说明
+
+
+[idm]
+serial:/dev/serial/by-id/usb-IDM_614e_473431383817584A-if00
+
+#/dev/serial/by-id/usb-1a86_USB2.0-Ser_-if00-port0
+#   Path to the serial port for the idm device. Typically has the form
+#   /dev/serial/by-id/usb-idm_idm_...
+speed: 40.
+#   Z probing dive speed.
+lift_speed: 5.
+#   Z probing lift speed.
+backlash_comp: 0.5
+#   Backlash compensation distance for removing Z backlash before measuring
+#   the sensor response.
+x_offset: 0.
+#   X offset of idm from the nozzle.
+y_offset: 21.1
+#   Y offset of idm from the nozzle.
+trigger_distance: 2.
+#   idm trigger distance for homing.
+trigger_dive_threshold: 1.5
+#   Threshold for range vs dive mode probing. Beyond `trigger_distance +
+#   trigger_dive_threshold` a dive will be used.
+trigger_hysteresis: 0.006
+#   Hysteresis on trigger threshold for untriggering, as a percentage of the
+#   trigger threshold.
+cal_nozzle_z: 0.1
+#   Expected nozzle offset after completing manual Z offset calibration.
+cal_floor: 0.1
+#   Minimum z bound on sensor response measurement.
+cal_ceil:5.
+#   Maximum z bound on sensor response measurement.
+cal_speed: 1.0
+#   Speed while measuring response curve.
+cal_move_speed: 10.
+#   Speed while moving to position for response curve measurement.
+default_model_name: default
+#   Name of default idm model to load.
+mesh_main_direction: x
+#   Primary travel direction during mesh measurement.
+#mesh_overscan: -1
+#   Distance to use for direction changes at mesh line ends. Omit this setting
+#   and a default will be calculated from line spacing and available travel.
+mesh_cluster_size: 1
+#   Radius of mesh grid point clusters.
+mesh_runs: 2
+#   Number of passes to make during mesh scan.
+serial改成你自己的
+probe项可以删了
+
+#### 参与贡献
+
+1.  Fork 本仓库
+2.  新建 Feat_xxx 分支
+3.  提交代码
+4.  新建 Pull Request
+
+
+#### 特技
+
+1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
+2.  Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
+3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
+4.  [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
+5.  Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
+6.  Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)