文档
概述
CADCAMFUN 将绘图、实体建模、刀具路径、项目历史记录和 AI 助手引入本地桌面应用程序。
从英文自动翻译。 查看英文原文
产品
该桌面将 SolidJS 工作台与 Tauri shell 结合在一起。该工作台可编辑工程图和模型、在 Three.js 视口中显示几何图形、管理加工操作以及预览或导出 G 代码。项目数据、工具、材料、机器配置和辅助状态均由 Bun sidecar 管理并存储在本地。
计算内核在桌面和 sidecar 之间共享。交互式几何图形可以在 webview 中运行,无需 HTTP 往返;持久性操作、提供者调用、项目历史记录和工作流执行都通过 sidecar 服务进行。本地存储不需要托管应用程序帐户。 AI 提供商、GitHub 运营、支付和软件更新使用其配置的网络服务。
从设计到加工
- 创建或打开项目并准备其绘图、实体或实体场景。这 CAD参考 涵盖草图、B-rep 几何、曲面细分和交换格式。
- 选择操作、工具、材料和机器配置。生成刀具路径 视密卡服务 并在视口中检查结果。
- 使用 加工设置 和程序文档,用于保留操作顺序、工作框架和程序设置。为目标控制者选择一个注册职位。
- 导出前查看生成的程序和验证结果。几何内核、注册后、高级 G 代码转换和机器配置是此过程的不同部分。
- 记录项目快照 历史,或者运行一个注册的 工作流程 用于重复验证和处理。
这 助手 通过应用程序使用的相同服务适配器调用应用程序操作。这 移动伴侣 连接到配对的桌面;它不在手机上运行第二个 CAD/CAM 后端。
运行时组件
apps/desktop- SolidJS 工作台、路由适配器、功能模块、视口和本机 Tauri shell。
apps/sidecar- 经过身份验证的 HTTP 处理程序、存储库、效果服务、本地身份、AI 集成、配套网关和数据库生命周期。
apps/mobile- 世博会伴侣具有本地配对交通、项目和历史视图以及助理访问权限。
packages/web- 这个 Astro 文档站点、Markdown 导出、文档助手、生成的指南页面和本地 Studio。
开始开发
bun install
bun run desktop:dev
# Documentation and local Studio
bun run --filter @cadcamfun/web dev 桌面命令会在启动 Tauri 之前编译 sidecar 并复制迁移资源。必须安装 Rust 和平台 webview 构建先决条件。要运行文档服务器而不启动本地 Studio API,请使用 bun run --filter @cadcamfun/web start.
契约与坚持
packages/api/src/index.ts 组成模式优先的 HTTP 合约。边车的 ServedApi 选择其服务的组并在以下位置发布 OpenAPI 文档 /api/openapi.json。 shell 从就绪事件中发现动态分配的环回端口,并为 webview 提供端点和承载令牌。
Sidecar数据库是 cadcamfun.db 在其配置的数据目录下。数据库层启用外键和 WAL,应用配置的迁移,并在挂起的升级之前备份现有文件。文档工作室有自己的数据库路径选择;它不会自动发现正在运行的 sidecar 的文件。
这些页面描述了此存储库中的实现。包导出、HTTP 端点、桌面控件和发布的安装程序是不同的集成表面;请参阅相关参考资料以了解支持的行为和限制。
选择工作路径
| 任务 | 从这里开始 | 保留什么 |
|---|---|---|
| 编辑一部分 | CAD几何图形 和 视口控件 | 可编辑的图形或特征历史记录,包括单位和放置。 |
| 生成加工输出 | 计算机辅助制造 和 保存的程序 | 捕获的几何形状、库存、刀具、机器设置、发出的 NC 以及适用的验证证据。 |
| 查看更改 | 项目历史 | 提交和结构差异,加上当前的审查结论。 |
| 自动重复检查 | 工作流程 | 提交的工作流程文件、选定的参考、注册的步骤和单独的检查结果。 |
| 构建集成 | API参考 | 正确的令牌类型、准确的端点合约以及结果/错误处理。 |
项目保存、资源版本、整个项目提交、远程同步和生成的指南工件是单独的操作。保存刀具路径不会自动提交它,并且成功的 GitHub 推送不会验证其加工输出。
对于首次 API 集成,请遵循 请求演练。它显示了公共卫生探测、受保护的调用、项目创建以及带有捕获的处理程序响应的首选项存储。
操作文档
这 指南库 逐步完成任务。开始于 项目创建和保存的工作,然后使用 本土制造 通过生成和程序持久性获取捕获的设计。两者都解释了什么被保存以及什么保持派生或未保存状态。
对于集成工作, API资源参考 涵盖带有请求和响应模式的每个声明的操作。这 客户端集成指南 涵盖 Promise 和 Effect 构造、身份验证、取消和错误处理。这 流媒体指南 添加对话恢复和交互式权限/问题处理。
如需操作和支持,请咨询 运行时配置, 桌面诊断, 和 同伴配对。每个都保持本机 shell、sidecar、数据库、提供程序、电话网关和文档部署不同,以便可以在其实际边界调查故障。
对于扩展和团队合作,请使用 插件创作 和 分支、评论和工作流程。这些指南记录了支持的模块导出、当前主机行为、结构合并规则、提交的工作流输入和服务支持的副作用。
CADCAMFUN 的数字
| 措施 | 价值 |
|---|---|
| 应用版本 | 6.0.0 |
| HTTP 操作/资源组 | 270 / 34 |
| 数据库表/迁移 | 60 / 4 |
| 工作空间 | 10 个软件包、3 个应用程序 |
| 桌面版本目标 | 6(macOS、Windows 和 Linux,每个 x64 和 ARM64) |
| G 代码后方言 | generic、GRBL、Fanuc、Haas(LinuxCNC 名称保留) |
| 原生 CAM 策略 | 面、自适应、型腔、轮廓、孔、钻孔、螺纹、雕刻、倒角、表面 |
| 内核证据声明 | 10,从切削数据到 NC 重放和机器间隙 |
什么是新的
从提交历史中总结的主分支最近的工作:
- Sidecar 上的确切内核。 A
cadExact团体 (analyze,step,assembly)从核心运行共享场景分析:每个实体的有效性、质量、孔、干扰、材料清单和缺失的紧固件。 - 精确建模。 扫掠和扫掠壳、具有理性直纹柱的放样、精确面上的推拉和配合以及圆角速度大约为 2.5×。
- NC 子程序。 重复刀具路径作为增量写入一次
M98子程序;重播理解O-程序,M98/M99和G91。从快照到桌面交换机的有线端到端。 - B 代表的 CAM。 规划师从精确的实体(包括 STEP 零件和旋转零件)中读取孔、型腔和轮廓;体积切削沿着倾斜的刀具轴进行。
- 辅助硬化。 Every action declares its result schema; destructive tools always need a human; each turn is bound to its drawing with compare-and-swap writes; a durable background-task journal; kernel jobs in a worker.
- 文档。 这个 Astro 网站为每个操作提供了生成的 API 参考。
后续步骤
| 如果你想… | 前往 |
|---|---|
| 安装已发布的版本 | 下载 和 安装 |
| 从源代码运行应用程序 | 快速入门, 然后 当地发展 |
| 了解流程 | 建筑学 和 边车 |
| 为零件建模 | 计算机辅助设计 和 视口 |
| 生成G代码 | 计算机辅助制造 和 本土制造 |
| 调用API | API之旅 和 API客户端 |
| 扩展应用程序 | 插件创作 |
| 管理您的帐户 | Studio 和 账户 |
| 贡献 | 贡献 |