Dokumentation
Überblick
CADCAMFUN bringt Zeichnung, Volumenmodellierung, Werkzeugwege, Projektverlauf und einen KI-Assistenten in eine lokale Desktop-Anwendung.
Automatisch aus dem Englischen übersetzt. Englisches Original ansehen
Produkt
Der Desktop kombiniert eine SolidJS-Workbench mit einer Tauri-Shell. Die Workbench bearbeitet Zeichnungen und Modelle, zeigt Geometrie in einem Three.js-Ansichtsfenster an, verwaltet Bearbeitungsvorgänge und zeigt G-Code in der Vorschau an oder exportiert ihn. Projektdaten, Werkzeuge, Materialien, Maschinenkonfigurationen und Assistentenstatus werden von einem Bun-Sidecar verwaltet und lokal gespeichert.
Der Rechenkern wird zwischen dem Desktop und dem Sidecar gemeinsam genutzt. Interaktive Geometrie kann in der Webansicht ohne HTTP-Roundtrip ausgeführt werden. Persistente Vorgänge, Anbieteraufrufe, Projektverlauf und Workflow-Ausführung laufen über Sidecar-Dienste. Für den lokalen Speicher ist kein gehostetes Anwendungskonto erforderlich. KI-Anbieter, GitHub-Vorgänge, Zahlungen und Software-Updates nutzen ihre konfigurierten Netzwerkdienste.
Vom Design bis zur Bearbeitung
- Erstellen oder öffnen Sie ein Projekt und bereiten Sie seine Zeichnungen, Elemente oder Volumenkörperszenen vor. Der CAD-Referenz behandelt Skizzen, B-Rep-Geometrie, Tessellation und Austauschformate.
- Wählen Sie einen Vorgang, ein Werkzeug, ein Material und eine Maschinenkonfiguration. Erzeugen Sie Werkzeugwege mit dem CAM-Dienste und überprüfen Sie das Ergebnis im Ansichtsfenster.
- Verwenden bearbeitungsaufbauten und Programmdokumente, um die Arbeitsreihenfolge, Arbeitsrahmen und Programmeinstellungen beizubehalten. Wählen Sie einen registrierten Beitrag für den vorgesehenen Controller aus.
- Überprüfen Sie vor dem Export das generierte Programm und die Überprüfungsergebnisse. Der Geometriekern, die Post-Registrierung, erweiterte G-Code-Transformationen und die Maschinenkonfiguration sind verschiedene Teile dieses Prozesses.
- Zeichnen Sie einen Projekt-Schnappschuss mit auf geschichte, oder führen Sie ein registriertes Konto aus arbeitsablauf zur wiederholten Validierung und Verarbeitung.
Der assistent ruft Anwendungsaktionen über dieselben Dienstadapter auf, die von der App verwendet werden. Der mobiler Begleiter stellt eine Verbindung zu einem gekoppelten Desktop her; Es wird kein zweites CAD/CAM-Backend auf dem Telefon ausgeführt.
Laufzeitkomponenten
apps/desktop- Die SolidJS-Workbench, Routenadapter, Feature-Module, Viewport und native Tauri-Shell.
apps/sidecar- Authentifizierte HTTP-Handler, Repositorys, Effektdienste, lokale Identität, KI-Integration, Companion-Gateway und Datenbanklebenszyklus.
apps/mobile- Expo-Begleiter mit nativem Pairing-Transport, Projekt- und Verlaufsansichten und Assistentenzugriff.
packages/web- Diese Astro-Dokumentationsseite, Markdown-Export, Dokumentationsassistent, generierte Leitfadenseiten und lokales Studio.
Der referenz zum Arbeitsbereich beschreibt jede Bibliothek, ihren öffentlichen Einstiegspunkt und ihre Verbraucher. Der quellkarte verweist auf Implementierungsdateien für allgemeine Änderungen.
Beginnen Sie mit der Entwicklung
bun install
bun run desktop:dev
# Documentation and local Studio
bun run --filter @cadcamfun/web dev Der Desktop-Befehl kompiliert den Sidecar und kopiert Migrationsressourcen, bevor er Tauri startet. Rust und die Webview-Build-Voraussetzungen für die Plattform müssen installiert sein. Um den Dokumentationsserver auszuführen, ohne die lokale Studio-API zu starten, verwenden Sie bun run --filter @cadcamfun/web start.
Folgen Schnellstart für Voraussetzungen und Erststart, oder Lokale Entwicklung für isolierte Sidecar- und Client-Schleifen.
Verträge und Beharrlichkeit
packages/api/src/index.ts erstellt den Schema-First-HTTP-Vertrag. Der Sidecar ServedApi wählt die Gruppen aus, die es bedient, und veröffentlicht ein OpenAPI-Dokument unter /api/openapi.json. Die Shell erkennt den dynamisch zugewiesenen Loopback-Port anhand eines Bereitschaftsereignisses und gibt der Webansicht einen Endpunkt und ein Trägertoken.
Die Sidecar-Datenbank ist cadcamfun.db unter seinem konfigurierten Datenverzeichnis. Die Datenbankschicht aktiviert Fremdschlüssel und WAL, wendet konfigurierte Migrationen an und sichert eine vorhandene Datei vor einem ausstehenden Upgrade. Das Dokumentationsstudio verfügt über eine eigene Datenbankpfadauswahl; Die Datei des laufenden Sidecars wird nicht automatisch erkannt.
Auf diesen Seiten wird die Implementierung in diesem Repository beschrieben. Ein Paketexport, ein HTTP-Endpunkt, ein Desktop-Steuerelement und ein freigegebenes Installationsprogramm sind unterschiedliche Integrationsoberflächen; Informationen zu unterstütztem Verhalten und Grenzwerten finden Sie in der entsprechenden Referenz.
Wählen Sie einen Arbeitspfad
| Aufgabe | Beginnen Sie hier | Was Sie behalten sollten |
|---|---|---|
| Bearbeiten Sie ein Teil | CAD-Geometrie und ansichtsfenster-Steuerelemente | Der bearbeitbare Zeichnungs- oder Feature-Verlauf, einschließlich Einheiten und Platzierung. |
| Bearbeitungsausgabe generieren | NOCKEN und gespeicherte Programme | Die erfasste Geometrie, das Material, die Werkzeuge, die Maschineneinstellungen, die ausgegebene NC und die entsprechenden Verifizierungsnachweise. |
| Überprüfen Sie eine Änderung | Projektgeschichte | Der Commit- und Strukturunterschied sowie die aktuellen Überprüfungsurteile. |
| Automatisieren Sie eine wiederholte Prüfung | Arbeitsabläufe | Die festgeschriebene Workflowdatei, die ausgewählte Referenz, die registrierten Schritte und die einzelnen Prüfergebnisse. |
| Erstellen Sie eine Integration | API-Referenz | Der richtige Tokentyp, der genaue Endpunktvertrag und die Ergebnis-/Fehlerbehandlung. |
Projektspeicherungen, Ressourcenversionen, Commits für das gesamte Projekt, Remote-Synchronisierung und generierte Leitfadenartefakte sind separate Vorgänge. Durch das Speichern eines Werkzeugwegs wird dieser nicht automatisch festgeschrieben, und ein erfolgreicher GitHub-Push überprüft seine Bearbeitungsausgabe nicht.
Befolgen Sie für eine erste API-Integration die komplettlösung anfordern. Es zeigt die Untersuchung der öffentlichen Gesundheit, geschützte Anrufe, Projekterstellung und Präferenzspeicherung mit erfassten Handler-Antworten.
Betriebsdokumentation
Der führerbibliothek geht vollständige Aufgaben durch. Beginnen Sie mit projekterstellung und gespeicherte Arbeit, dann verwenden einheimische Fertigung um einen erfassten Entwurf durch Generierung und Programmpersistenz zu führen. Beide erklären, was gespeichert wird und was im abgeleiteten oder nicht gespeicherten Zustand verbleibt.
Für die Integrationsarbeit ist die API-Ressourcenreferenz deckt jede deklarierte Operation mit Anforderungs- und Antwortschemata ab. Der leitfaden zur Client-Integration deckt die Konstruktion von Versprechen und Effekten, die Authentifizierung, den Abbruch und die Fehlerbehandlung ab. Der streaming-Guide fügt Konversationswiederherstellung und interaktive Berechtigungs-/Fragenbearbeitung hinzu.
Für Bedienung und Support wenden Sie sich bitte an laufzeitkonfiguration, desktop-Diagnose, und begleiterpaarung. Bei jedem bleiben die native Shell, der Sidecar, die Datenbank, der Anbieter, das Telefon-Gateway und die Dokumentationsbereitstellung getrennt, sodass ein Fehler an seiner tatsächlichen Grenze untersucht werden kann.
Für Erweiterungen und Teamarbeit verwenden Sie plugin-Erstellung und zweige, Überprüfungen und Arbeitsabläufe. Diese Leitfäden dokumentieren unterstützte Modulexporte, aktuelles Hostverhalten, strukturelle Zusammenführungsregeln, festgeschriebene Workflow-Eingaben und dienstgestützte Nebenwirkungen.
CADCAMFUN in Zahlen
| Messen | Wert |
|---|---|
| Anwendungsversion | 6.0.0 |
| HTTP-Operationen/Ressourcengruppen | 270 / 34 |
| Datenbanktabellen / Migrationen | 60 / 4 |
| Arbeitsbereiche | 10 Pakete, 3 Apps |
| Desktop-Release-Ziele | 6 (macOS, Windows und Linux, jeweils x64 und ARM64) |
| G-Code-Post-Dialekte | generisch, GRBL, Fanuc, Haas (LinuxCNC-Name reserviert) |
| Native CAM-Strategien | fläche, adaptive, Tasche, Profil, Bohrung, bohren, Gewinde, gravieren, Fase, Oberfläche |
| Kernbeweisansprüche | 10, von Schnittdaten bis hin zu NC-Wiedergabe und Maschinenfreigabe |
Was ist neu
Aktuelle Arbeiten am Hauptzweig, zusammengefasst aus dem Commit-Verlauf:
- Exakter Kernel im Sidecar. A
cadExactgruppe (analyze,step,assembly) führt eine gemeinsame Szenenanalyse vom Kern aus durch: Gültigkeit pro Volumenkörper, Masse, Löcher, Interferenz, Stückliste und fehlende Befestigungselemente. - Exakte Modellierung. Sweeps und Sweep-Shells, Lofts mit rationalen Regelsäulen, Push-Pull und Mate auf exakten Flächen und Verrundungen etwa 2.5× schneller.
- NC-Unterprogramme. Wiederholte Werkzeugwege werden einmal inkrementell geschrieben
M98unterprogramm; Wiederholung verstehtO-Programme,M98/M99undG91. End-to-End-Verkabelung vom Snapshot bis zum Desktop-Switch. - CAM von B-rep. Der Planer liest Löcher, Taschen und Umrisse aus exakten Volumenkörpern, einschließlich STEP-Teilen und gedrehten Teilen; Der volumetrische Abtrag erfolgt entlang einer geneigten Werkzeugachse.
- Assistent Härten. 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.
- Dokumentation. Diese Astro-Site mit einer generierten API-Referenz für jeden Vorgang.
Nächste Schritte
| Wenn Sie wollen… | Gehe zu |
|---|---|
| Installieren Sie einen veröffentlichten Build | Herunterladen und Installieren |
| Führen Sie die App aus der Quelle aus | Schnellstart, dann Lokale Entwicklung |
| Verstehen Sie die Prozesse | Architektur und Sidecar |
| Modellieren Sie ein Teil | CAD und Ansichtsfenster |
| G-Code generieren | NOCKEN und Einheimische Fertigung |
| Rufen Sie die API auf | API-Tour und API-Clients |
| Erweitern Sie die App | Plugin-Erstellung |
| Verwalten Sie Ihr Konto | Studio und Konten |
| Beitragen | Mitwirken |