Documentação
Visão geral
CADCAMFUN traz desenho, modelagem sólida, percursos da ferramentas, histórico de projetos e um assistente de IA em um aplicativo de desktop local.
Traduzido automaticamente do inglês. Ver o original em inglês
Produto
A área de trabalho combina um ambiente de trabalho SolidJS com um shell Tauri. O ambiente de trabalho edita desenhos e modelos, exibe geometria em uma viewport Three.js, gerencia operações de usinagem e visualiza ou exporta código G. Dados do projeto, ferramentas, materiais, configurações de máquinas e estado do assistente são gerenciados por um sidecar Bun e armazenados localmente.
O kernel computacional é compartilhado entre o desktop e o sidecar. A geometria interativa pode ser executada no webview sem uma viagem de ida e volta HTTP; operações persistentes, chamadas de provedores, histórico de projetos e execução de fluxo de trabalho passam por serviços secundários. O armazenamento local não requer uma conta de aplicativo hospedada. Provedores de IA, operações do GitHub, pagamentos e atualizações de software usam seus serviços de rede configurados.
Projeto para usinagem
- Crie ou abra um projeto e prepare seus desenhos, entidades ou cena sólida. O Referência CAD abrange esboços, geometria B-rep, mosaico e formatos de troca.
- Escolha uma configuração de operação, ferramenta, material e máquina. Gere percursos da ferramenta de ferramenta com o Serviços CAM e inspecione o resultado na janela de visualização.
- Usar configurações de usinagem e documentos do programa para reter a ordem de operação, estruturas de trabalho e configurações do programa. Selecione um posto registrado para o controlador pretendido.
- Revise o programa gerado e os resultados da verificação antes de exportar. O kernel de geometria, pós-registro, transformações avançadas de código G e configuração da máquina são partes distintas desse processo.
- Grave um instantâneo do projeto com história, ou execute um registro fluxo de trabalho para validação e processamento repetidos.
O assistente invoca ações do aplicativo por meio dos mesmos adaptadores de serviço usados pelo aplicativo. O companheiro móvel conecta-se a uma área de trabalho emparelhada; ele não executa um segundo backend CAD/CAM no telefone.
Componentes de tempo de execução
apps/desktop- O ambiente de trabalho SolidJS, adaptadores de rota, módulos de recursos, janela de visualização e shell Tauri nativo.
apps/sidecar- Manipuladores HTTP autenticados, repositórios, serviços de efeito, identidade local, integração de IA, gateway complementar e ciclo de vida do banco de dados.
apps/mobile- Companheiro da Expo com transporte de emparelhamento nativo, visualizações de projeto e histórico e acesso de assistente.
packages/web- Este site de documentação do Astro, exportação de Markdown, assistente de documentação, páginas de guia geradas e Studio local.
O referência do espaço de trabalho descreve cada biblioteca, seu ponto de entrada público e seus consumidores. O mapa de origem aponta para arquivos de implementação para mudanças comuns.
Iniciar o desenvolvimento
bun install
bun run desktop:dev
# Documentation and local Studio
bun run --filter @cadcamfun/web dev O comando desktop compila o sidecar e copia os recursos de migração antes de iniciar o Tauri. Os pré-requisitos de construção do Rust e do webview da plataforma devem ser instalados. Para executar o servidor de documentação sem iniciar a API local do Studio, use bun run --filter @cadcamfun/web start.
Seguir Início rápido para pré-requisitos e primeiro lançamento, ou Desenvolvimento local para sidecar isolado e loops de cliente.
Contratos e persistência
packages/api/src/index.ts compõe o primeiro contrato HTTP do esquema. O sidecar ServedApi seleciona os grupos que atende e publica um documento OpenAPI em /api/openapi.json. O shell descobre a porta de loopback alocada dinamicamente a partir de um evento de prontidão e fornece ao webview um endpoint e um token de portador.
O banco de dados secundário é cadcamfun.db em seu diretório de dados configurado. A camada de banco de dados habilita chaves estrangeiras e WAL, aplica migrações configuradas e faz backup de um arquivo existente antes de uma atualização pendente. A documentação do Studio possui sua própria seleção de caminho de banco de dados; ele não descobre o sidecar em execução automaticamente.
Estas páginas descrevem a implementação neste repositório. Uma exportação de pacote, um endpoint HTTP, um controle de desktop e um instalador lançado são superfícies de integração diferentes; consulte a referência relevante para comportamento e limites suportados.
Escolha um caminho de trabalho
| Tarefa | Comece aqui | O que reter |
|---|---|---|
| Editar uma parte | Geometria CAD e controles da janela de visualização | O desenho editável ou histórico de recursos, incluindo unidades e posicionamento. |
| Gerar resultados de usinagem | CAM e programas salvos | A geometria capturada, material, ferramentas, configurações da máquina, NC emitido e evidências de verificação aplicáveis. |
| Revise uma alteração | História do projeto | O commit e a diferença estrutural, além dos veredictos da revisão atual. |
| Automatize uma verificação repetida | Fluxos de trabalho | O arquivo de fluxo de trabalho confirmado, referência selecionada, etapas registradas e resultados de verificação individuais. |
| Crie uma integração | Referência da API | O tipo de token correto, contrato de endpoint exato e tratamento de resultados/erros. |
Salvamentos de projetos, versões de recursos, confirmações de todo o projeto, sincronização remota e artefatos de guia gerados são operações separadas. Salvar um percurso não o confirma automaticamente e um push bem-sucedido do GitHub não verifica sua saída de usinagem.
Para uma primeira integração API, siga o solicitar passo a passo. Ele mostra a investigação de saúde pública, chamadas protegidas, criação de projetos e armazenamento de preferências com respostas capturadas do manipulador.
Documentação operacional
O biblioteca de guias percorre tarefas completas. Comece com criação de projeto e trabalho salvo, então use fabricação nativa para obter um design capturado por meio de geração e persistência do programa. Ambos explicam o que é salvo e o que permanece no estado derivado ou não salvo.
Para o trabalho de integração, o Referência de recursos da API cobre todas as operações declaradas com esquemas de solicitação e resposta. O guia de integração do cliente cobre construção de promessa e efeito, autenticação, cancelamento e tratamento de erros. O guia de streaming adiciona recuperação de conversa e tratamento interativo de permissões/perguntas.
Para operação e suporte, consulte configuração de tempo de execução, diagnóstico de área de trabalho, e emparelhamento de companheiro. Cada um mantém distintos o shell nativo, o sidecar, o banco de dados, o provedor, o gateway telefônico e a implantação da documentação, para que uma falha possa ser investigada em seu limite real.
Para extensões e trabalho em equipe, use autoria de plugin e filiais, revisões e fluxos de trabalho. Esses guias documentam exportações de módulos compatíveis, comportamento atual do host, regras de mesclagem estrutural, entradas de fluxo de trabalho confirmadas e efeitos colaterais apoiados por serviço.
CADCAMFUN em números
| Medir | Valor |
|---|---|
| Versão do aplicativo | 6.0.0 |
| Operações HTTP/grupos de recursos | 270 / 34 |
| Tabelas/migrações de banco de dados | 60 / 4 |
| Espaços de trabalho | 10 pacotes, 3 aplicativos |
| Destinos de lançamento para desktop | 6 (macOS, Windows e Linux, cada um x64 e ARM64) |
| Dialetos postais de código G | genérico, GRBL, Fanuc, Haas (nome LinuxCNC reservado) |
| Estratégias CAM nativas | face, adaptativo, bolso, perfil, furo, broca, rosca, gravar, chanfro, superfície |
| Alegações de evidências do kernel | 10, desde o corte de dados até a repetição NC e liberação da máquina |
O que há de novo
Trabalho recente no branch principal, resumido do histórico de commits:
- Kernel exato no sidecar. A
cadExactgrupo (analyze,step,assembly) executa uma análise de cena compartilhada do núcleo: validade por sólido, massa, furos, interferência, lista de materiais e fixadores ausentes. - Modelagem exata. Varreduras e varreduras de cascas, lofts com colunas regradas racionais, push-pull e mate em faces exatas e filetes cerca de 2.5× mais rápido.
- Subprogramas NC. Percursos repetidos são escritos uma vez como incrementais
M98subprograma; replay entendeO-programas,M98/M99eG91. Conectado de ponta a ponta do snapshot ao switch de desktop. - CAM do representante B. O planejador lê furos, bolsões e contornos de sólidos exatos, incluindo peças STEP e peças rotacionadas; a remoção volumétrica de material funciona ao longo de um eixo de ferramenta inclinado.
- Endurecimento assistente. 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.
- Documentação. Este site Astro com uma referência de API gerada para cada operação.
Próximas etapas
| Se você quiser… | Vá para |
|---|---|
| Instalar uma compilação publicada | Download e Instalar |
| Execute o aplicativo da fonte | Início rápido, então Desenvolvimento local |
| Entenda os processos | Arquitetura e Sidecar |
| Modelar uma peça | CAD e Janela de visualização |
| Gerar código G | CAM e Fabricação nativa |
| Chame a API | Tour da API e Clientes de API |
| Estenda o aplicativo | Criação de plug-ins |
| Gerencie sua conta | Studio e Contas |
| Contribuir | Contribuindo |