Документация
Обзор
CADCAMFUN объединяет чертежи, твердотельное моделирование, траектории движения инструментов, историю проекта и помощника искусственного интеллекта в локальном настольном приложении.
Автоматически переведено с английского. Смотреть оригинал на английском
Продукт
Рабочий стол сочетает в себе рабочую среду SolidJS и оболочку Tauri. Инструментальные средства редактируют чертежи и модели, отображают геометрию в окне просмотра Three.js, управляют операциями обработки, а также просматривают или экспортируют G-код. Данные проекта, инструменты, материалы, конфигурации станков и состояние помощника управляются дополнительным устройством Bun и хранятся локально.
Вычислительное ядро используется совместно настольным компьютером и сайдкаром. Интерактивная геометрия может работать в веб-просмотре без HTTP-обмена; постоянные операции, вызовы поставщика, история проекта и выполнение рабочего процесса проходят через дополнительные службы. Локальное хранилище не требует учетной записи размещенного приложения. Поставщики ИИ, операции GitHub, платежи и обновления программного обеспечения используют настроенные ими сетевые сервисы.
От дизайна до механической обработки
- Создайте или откройте проект и подготовьте его рисунки, объекты или твердотельную сцену. Справочник САПР охватывает эскизы, геометрию B-rep, тесселяцию и форматы обмена.
- Выберите операцию, инструмент, материал и конфигурацию станка. Создавайте траектории инструмента с помощью CAM-услуги и проверьте результат в окне просмотра.
- Использовать установки для обработки и программные документы для сохранения порядка операций, рабочих рамок и настроек программы. Выберите зарегистрированное сообщение для предполагаемого контроллера.
- Перед экспортом просмотрите созданную программу и результаты проверки. Ядро геометрии, пост-регистрация, расширенные преобразования G-кода и конфигурация машины являются отдельными частями этого процесса.
- Запишите снимок проекта с помощью историяили запустите зарегистрированную рабочий процесс для повторной проверки и обработки.
The помощник вызывает действия приложения через те же адаптеры служб, которые используются приложением. мобильный спутник подключается к сопряженному рабочему столу; на телефоне не работает второй сервер CAD/CAM.
Компоненты среды выполнения
apps/desktop- Рабочая среда SolidJS, адаптеры маршрутов, функциональные модули, область просмотра и собственная оболочка Tauri.
apps/sidecar- Аутентифицированные обработчики HTTP, репозитории, сервисы эффектов, локальная идентификация, интеграция с искусственным интеллектом, сопутствующий шлюз и жизненный цикл базы данных.
apps/mobile- Компаньон Expo с собственным сопряженным транспортом, просмотром проектов и истории, а также доступом к помощнику.
packages/web- Это сайт документации Astro, экспорт Markdown, помощник по документации, сгенерированные страницы руководства и локальная студия.
The ссылка на рабочую область описывает каждую библиотеку, ее публичную точку входа и ее потребителей. исходная карта указывает на файлы реализации для общих изменений.
Начать разработку
bun install
bun run desktop:dev
# Documentation and local Studio
bun run --filter @cadcamfun/web dev Команда рабочего стола компилирует вспомогательную программу и копирует ресурсы миграции перед запуском Tauri. Должны быть установлены необходимые условия для сборки Rust и платформы WebView. Чтобы запустить сервер документации без запуска локального API Studio, используйте bun run --filter @cadcamfun/web start.
Следовать Быстрый старт для предварительных условий и первого запуска, или Местное развитие для изолированных побочных и клиентских циклов.
Контракты и настойчивость
packages/api/src/index.ts составляет HTTP-контракт с приоритетом схемы. Сайдкар ServedApi выбирает группы, которые он обслуживает, и публикует документ OpenAPI по адресу /api/openapi.json. Оболочка обнаруживает динамически выделенный порт обратной связи из события готовности и предоставляет веб-просмотру конечную точку и токен носителя.
База данных колясок cadcamfun.db в настроенном каталоге данных. Уровень базы данных включает внешние ключи и WAL, применяет настроенные миграции и создает резервную копию существующего файла перед предстоящим обновлением. Студия документации имеет собственный выбор пути к базе данных; он не обнаруживает автоматически работающий сайдкар.
На этих страницах описывается реализация в этом репозитории. Экспорт пакета, конечная точка HTTP, элемент управления рабочего стола и выпущенный установщик — это разные поверхности интеграции; обратитесь к соответствующей ссылке для получения информации о поддерживаемом поведении и ограничениях.
Выберите рабочий путь
| Задача | Начните здесь | Что сохранить |
|---|---|---|
| Редактировать часть | САПР-геометрия и элементы управления видовым окном | Редактируемая история чертежа или объекта, включая единицы измерения и размещение. |
| Создание результатов обработки | САМ и сохраненные программы | Зарегистрированная геометрия, заготовка, инструменты, настройки станка, выданное ЧПУ и применимые доказательства проверки. |
| Просмотрите изменение | История проекта | Коммит и структурные различия, а также текущие вердикты проверки. |
| Автоматизируйте повторную проверку | Рабочие процессы | Зафиксированный файл рабочего процесса, выбранная ссылка, зарегистрированные шаги и результаты отдельных проверок. |
| Создайте интеграцию | Справочник по API | Правильный тип токена, точный контракт конечной точки и обработка результатов/ошибок. |
Сохранение проекта, версии ресурсов, фиксации всего проекта, удаленная синхронизация и создание артефактов руководства — это отдельные операции. Сохранение траектории не фиксирует ее автоматически, а успешная публикация на GitHub не проверяет результаты обработки.
Для первой интеграции API следуйте инструкциям запросить пошаговое руководство. Он показывает проверку общественного здравоохранения, защищенные вызовы, создание проектов и хранилище предпочтений с записанными ответами обработчиков.
Эксплуатационная документация
The путеводитель по библиотеке проходит полные задания. Начните с создание проекта и сохраненная работа, затем используйте родное производство взять захваченный проект через генерацию и сохранение программы. Оба объясняют, что сохраняется, а что остается в производном или несохраненном состоянии.
Для интеграционной работы Справочник ресурсов API охватывает каждую объявленную операцию со схемами запросов и ответов. руководство по интеграции клиента охватывает построение обещаний и эффектов, аутентификацию, отмену и обработку ошибок. руководство по потоковому вещанию добавляет восстановление разговора и интерактивную обработку разрешений/вопросов.
По вопросам эксплуатации и поддержки обращайтесь конфигурация времени выполнения, настольная диагностика, и компаньон в паре. Каждый из них сохраняет собственную оболочку, дополнительную версию, базу данных, поставщика, телефонный шлюз и развертывание документации отдельно, поэтому сбой можно исследовать на его фактической границе.
Для расширений и совместной работы используйте разработка плагинов и ветки, обзоры и рабочие процессы. В этих руководствах описаны поддерживаемые экспорты модулей, текущее поведение хоста, правила структурного слияния, зафиксированные входные данные рабочего процесса и побочные эффекты, поддерживаемые службами.
КАДКАМФУН в цифрах
| Мера | Ценить |
|---|---|
| Версия приложения | 6.0.0 |
| HTTP-операции/группы ресурсов | 270 / 34 |
| Таблицы базы данных/миграции | 60 / 4 |
| Рабочие пространства | 10 пакетов, 3 приложений |
| Цели выпуска настольных компьютеров | 6 (macOS, Windows и Linux, x64 и ARM64) |
| Почтовые диалекты G-кода | универсальный, GRBL, Fanuc, Haas (имя LinuxCNC зарезервировано) |
| Собственные стратегии CAM | торец, адаптивный, карман, профиль, отверстие, сверло, резьба, гравировка, фаска, поверхность |
| Заявления о доказательствах ядра | 10, от данных резки до воспроизведения ЧПУ и очистки станка |
Что нового
Недавняя работа над основной веткой, обобщенная из истории коммитов:
- Точное ядро на сайдкаре. A
cadExactгруппа (analyze,step,assembly) запускает общий анализ сцены из ядра: достоверность каждого твердого тела, масса, отверстия, помехи, спецификация материалов и недостающие крепежные детали. - Точное моделирование. Вытягивание и вытягивание оболочек, лофты с рациональными линейчатыми колоннами, двухтактное и сопряжение на точных гранях, а также скругления примерно на 2.5× быстрее.
- Подпрограммы ЧПУ. Повторяющиеся траектории записываются один раз как инкрементные.
M98подпрограмма; повтор понимаетO-программы,M98/M99иG91. Сквозное соединение от моментального снимка к коммутатору рабочего стола. - САМ от Б-реп. Планировщик считывает отверстия, карманы и контуры точных тел, включая детали 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 и Счета |
| Способствовать | Содействие |