Documentation
Aperçu
CADCAMFUN intègre le dessin, la modélisation solide, les parcours d'outils, l'historique du projet et un assistant IA dans une application de bureau locale.
Traduit automatiquement de l'anglais. Voir l'original en anglais
Produit
Le bureau combine un workbench SolidJS avec un shell Tauri. L'atelier modifie les dessins et les modèles, affiche la géométrie dans une fenêtre Three.js, gère les opérations d'usinage et prévisualise ou exporte le G-code. Les données du projet, les outils, les matériaux, les configurations de machines et l'état de l'assistant sont gérés par un sidecar Bun et stockés localement.
Le noyau de calcul est partagé entre le bureau et le sidecar. La géométrie interactive peut s'exécuter dans la vue Web sans aller-retour HTTP ; les opérations persistantes, les appels de fournisseur, l'historique du projet et l'exécution du flux de travail passent par des services sidecar. Le stockage local ne nécessite pas de compte d'application hébergé. Les fournisseurs d'IA, les opérations GitHub, les paiements et les mises à jour logicielles utilisent leurs services réseau configurés.
De la conception à l'usinage
- Créez ou ouvrez un projet et préparez ses dessins, entités ou scènes solides. Le Référence CAO couvre les esquisses, la géométrie B-rep, la tessellation et les formats d'échange.
- Choisissez une opération, un outil, un matériau et une configuration de machine. Générez des parcours d'outils avec le Services de FAO et inspectez le résultat dans la fenêtre.
- Utiliser configurations d'usinage et les documents du programme pour conserver l'ordre de fonctionnement, les cadres de travail et les paramètres du programme. Sélectionnez un envoi recommandé pour le responsable du traitement prévu.
- Examinez le programme généré et les résultats de la vérification avant l'exportation. Le noyau géométrique, le post-enregistrement, les transformations avancées du code G et la configuration de la machine sont des parties distinctes de ce processus.
- Enregistrez un instantané du projet avec histoire, ou lancez un enregistrement flux de travail pour une validation et un traitement répétés.
Le assistant appelle des actions d'application via les mêmes adaptateurs de service que ceux utilisés par l'application. Le compagnon mobile se connecte à un ordinateur de bureau couplé ; il n'exécute pas de deuxième backend CAO/FAO sur le téléphone.
Composants d'exécution
apps/desktop- L'atelier SolidJS, les adaptateurs de routage, les modules de fonctionnalités, la fenêtre d'affichage et le shell Tauri natif.
apps/sidecar- Gestionnaires HTTP authentifiés, référentiels, services Effect, identité locale, intégration de l'IA, passerelle compagnon et cycle de vie de la base de données.
apps/mobile- Compagnon d'exposition avec transport de couplage natif, vues de projet et d'historique et accès assistant.
packages/web- Ce site de documentation Astro, l'exportation Markdown, l'assistant de documentation, les pages de guide générées et le Studio local.
Le référence de l'espace de travail décrit chaque bibliothèque, son point d'entrée public et ses consommateurs. Le carte des sources pointe vers les fichiers d’implémentation pour les modifications courantes.
Commencer le développement
bun install
bun run desktop:dev
# Documentation and local Studio
bun run --filter @cadcamfun/web dev La commande de bureau compile le sidecar et copie les ressources de migration avant de démarrer Tauri. Les prérequis de construction de Rust et de la plate-forme WebView doivent être installés. Pour exécuter le serveur de documentation sans démarrer l'API Studio locale, utilisez bun run --filter @cadcamfun/web start.
Suivre Démarrage rapide pour les prérequis et le premier lancement, ou Développement local pour les boucles sidecar et client isolées.
Contrats et persévérance
packages/api/src/index.ts compose le contrat HTTP basé sur le schéma. Le sidecar ServedApi sélectionne les groupes qu'il sert et publie un document OpenAPI sur /api/openapi.json. Le shell découvre le port de bouclage alloué dynamiquement à partir d'un événement de préparation et donne à la vue Web un point de terminaison et un jeton de support.
La base de données sidecar est cadcamfun.db sous son répertoire de données configuré. La couche de base de données active les clés étrangères et les WAL, applique les migrations configurées et sauvegarde un fichier existant avant une mise à niveau en attente. Le Studio de documentation possède sa propre sélection de chemin de base de données ; il ne découvre pas automatiquement le fichier du sidecar en cours d'exécution.
Ces pages décrivent l'implémentation dans ce référentiel. Une exportation de package, un point de terminaison HTTP, un contrôle de bureau et un programme d'installation publié sont différentes surfaces d'intégration ; consultez la référence pertinente pour connaître le comportement et les limites pris en charge.
Choisissez un chemin de travail
| Tâche | Commencez ici | Que retenir |
|---|---|---|
| Modifier une pièce | Géométrie CAO et contrôles de fenêtre | L'historique du dessin ou des fonctionnalités modifiable, y compris les unités et l'emplacement. |
| Générer une sortie d'usinage | CAME et programmes sauvegardés | La géométrie capturée, le stock, les outils, les paramètres de la machine, la CN émise et les preuves de vérification applicables. |
| Examiner un changement | Historique du projet | Le commit et la différence structurelle, ainsi que les verdicts de révision actuels. |
| Automatisez une vérification répétée | Flux de travail | Le fichier de flux de travail validé, la référence sélectionnée, les étapes enregistrées et les résultats de vérification individuels. |
| Construire une intégration | Référence API | Le type de jeton correct, le contrat de point de terminaison exact et la gestion des résultats/erreurs. |
Les sauvegardes de projet, les versions de ressources, les validations de l'ensemble du projet, la synchronisation à distance et les artefacts de guide générés sont des opérations distinctes. L'enregistrement d'un parcours d'outil ne le valide pas automatiquement, et un push GitHub réussi ne vérifie pas sa sortie d'usinage.
Pour une première intégration API, suivez les demande de procédure pas à pas. Il affiche la sonde de santé publique, les appels protégés, la création de projets et le stockage des préférences avec les réponses capturées du gestionnaire.
Documentation opérationnelle
Le bibliothèque de guides parcourt les tâches terminées. Commencez par création de projet et travail enregistré, puis utilisez fabrication native pour prendre une conception capturée à travers la génération et la persistance du programme. Les deux expliquent ce qui est enregistré et ce qui reste dans un état dérivé ou non enregistré.
Pour le travail d'intégration, le Référence des ressources API couvre chaque opération déclarée avec des schémas de demande et de réponse. Le guide d'intégration client couvre la construction des promesses et des effets, l’authentification, l’annulation et la gestion des erreurs. Le guide de diffusion en continu ajoute la récupération de conversation et la gestion interactive des autorisations/questions.
Pour le fonctionnement et l'assistance, consultez configuration d'exécution, diagnostic de bureau, et appariement de compagnon. Chacun conserve le shell natif, le sidecar, la base de données, le fournisseur, la passerelle téléphonique et le déploiement de la documentation distincts afin qu'une défaillance puisse être étudiée à sa limite réelle.
Pour les extensions et le travail d'équipe, utilisez création de plugins et branches, révisions et flux de travail. Ces guides documentent les exportations de modules prises en charge, le comportement actuel de l'hôte, les règles de fusion structurelles, les entrées de flux de travail validées et les effets secondaires basés sur les services.
CADCAMFUN en chiffres
| Mesure | Valeur |
|---|---|
| Version de l'application | 6.0.0 |
| Opérations HTTP/groupes de ressources | 270 / 34 |
| Tables de base de données / migrations | 60 / 4 |
| Espaces de travail | 10 packages, 3 applications |
| Objectifs de version de bureau | 6 (macOS, Windows et Linux, chacun x64 et ARM64) |
| Dialectes post-code G | générique, GRBL, Fanuc, Haas (nom LinuxCNC réservé) |
| Stratégies CAM natives | face, adaptatif, poche, profil, alésage, perçage, filetage, gravure, chanfrein, surface |
| Revendications de preuves du noyau | 10, des données de découpe à la relecture CN et au dédouanement de la machine |
Quoi de neuf
Travaux récents sur la branche principale, résumés à partir de l'historique des commits :
- Noyau exact sur le sidecar. A
cadExactgroupe (analyze,step,assembly) exécute une analyse de scène partagée à partir du noyau : validité par solide, masse, trous, interférences, nomenclature et fixations manquantes. - Modélisation exacte. Balayages et coques de balayage, lissages avec des colonnes réglées de manière rationnelle, push-pull et accouplement sur des faces exactes, et congés environ 2.5 × plus rapidement.
- Sous-programmes CN. Les parcours d'outils répétés sont écrits une fois sous forme incrémentielle
M98sous-programme ; replay comprendO-les programmes,M98/M99etG91. Câblé de bout en bout de l'instantané au commutateur de bureau. - CAM de B-rep. Le planificateur lit les trous, les poches et les contours à partir de solides exacts, y compris les pièces STEP et les pièces pivotées ; L'enlèvement de matière volumétrique fonctionne le long d'un axe d'outil incliné.
- Assistant de durcissement. 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.
- Documentation. Ce site Astro avec une référence API générée pour chaque opération.
Prochaines étapes
| Si tu veux… | Aller à |
|---|---|
| Installer une version publiée | Télécharger et Installer |
| Exécutez l'application à partir de la source | Démarrage rapide, alors Développement local |
| Comprendre les processus | Architecture et Sidecar |
| Modéliser une pièce | GOUJAT et Fenêtre d'affichage |
| Générer du code G | CAME et Fabrication native |
| Appeler l'API | Visite guidée des API et Clients API |
| Étendre l'application | Création de plugins |
| Gérer votre compte | Studio et Comptes |
| Contribuer | Contribuer |