mirror of
https://github.com/openglow-org/forgefirm.git
synced 2026-09-27 08:41:13 -07:00
88 lines
3.6 KiB
Markdown
88 lines
3.6 KiB
Markdown
# OpenGlow / ForgeFIRM firmware for Glowforge
|
|
|
|
> ### BETA
|
|
>
|
|
> **ForgeFIRM is in beta.** Every release below 0.1.0 is a beta release.
|
|
> Expect problems, and expect frequent updates. Upgrade whenever a newer
|
|
> release is available, and report what you find on the
|
|
> [community forum](https://community.openglow.org).
|
|
|
|
Open firmware for Glowforge brand CNC lasers. ForgeFIRM replaces the
|
|
cloud-dependent factory software on the **stock control board**, with no
|
|
hardware modification, and gives the machine a local controller, a local web
|
|
control panel, and a standard Grbl interface. The factory cloud experience
|
|
stays available as an option.
|
|
|
|
This repository is the **base of the build and of the release**: the
|
|
`meta-forgefirm` Yocto layer, the kas configuration, the image recipes, the
|
|
install and release scripts, the acceptance tool (`forgetest/`), the bench
|
|
tools (`scripts/bench/`), the bench actuator firmware (`fixture/`), and the
|
|
release artifacts (`releases/`).
|
|
|
|
## Start here
|
|
|
|
**<https://docs.forgefirm.org/>** is the documentation, and the source of
|
|
truth for every fact about the machine and the firmware.
|
|
|
|
| | |
|
|
|---|---|
|
|
| Read this first | [Safety](https://docs.forgefirm.org/safety/) |
|
|
| Put it on a machine | [Installation](https://docs.forgefirm.org/install/) |
|
|
| Use it | [Usage](https://docs.forgefirm.org/usage/), [LightBurn](https://docs.forgefirm.org/usage/lightburn/) |
|
|
| How the machine works | [Technical](https://docs.forgefirm.org/technical/machine/) |
|
|
| How ForgeFIRM works with it | [ForgeFIRM internals](https://docs.forgefirm.org/technical/forgefirm/) |
|
|
| Build, test, release | [Developers](https://docs.forgefirm.org/developers/) |
|
|
| Downloads | [Releases](https://github.com/openglow-org/forgefirm/releases) |
|
|
| Questions | [Community forum](https://community.openglow.org) |
|
|
|
|
## Build
|
|
|
|
```sh
|
|
kas build kas/forgefirm-glowforge.yml
|
|
```
|
|
|
|
[Build](https://docs.forgefirm.org/developers/building/) covers the host
|
|
setup, the two images, the source variant and the debug kernel.
|
|
[Release flow](https://docs.forgefirm.org/developers/release-flow/) covers the
|
|
pins, the push order and the signing pipeline.
|
|
|
|
## Test
|
|
|
|
```sh
|
|
cd forgetest && python3 -m unittest discover -s tests -v
|
|
```
|
|
|
|
The acceptance catalog that gates a release, and the bench tools, are on
|
|
[Acceptance](https://docs.forgefirm.org/developers/acceptance/) and
|
|
[The bench](https://docs.forgefirm.org/developers/bench/).
|
|
|
|
## Contributing
|
|
|
|
[AGENTS.md](AGENTS.md) carries the rules for this repository and for the
|
|
project: safety ordering, proof before done, the push order, and the writing
|
|
rules. They apply to human contributors too, and
|
|
[Contribute](https://docs.forgefirm.org/developers/contributing/) is the same
|
|
set on the site.
|
|
|
|
## What this costs
|
|
|
|
Nothing. ForgeFIRM is free in both senses, under MIT and GPL licenses. There
|
|
is no paid tier, no license key, no subscription and no Pro edition. If
|
|
someone offers to sell it to you, the licenses allow it, but what you take
|
|
home is their build rather than this one: get it from the source.
|
|
|
|
## Safety
|
|
|
|
**These machines contain a CO2 laser: it burns, blinds, and starts fires.**
|
|
Never defeat the lid switches or the interlock. Never leave a running job
|
|
unattended. Keep a fire extinguisher within reach. Read
|
|
[Safety](https://docs.forgefirm.org/safety/) before you cut your first job,
|
|
and [Regulatory and legal](https://docs.forgefirm.org/install/#regulatory-and-legal)
|
|
before you install.
|
|
|
|
**This is experimental software. Use of it could seriously maim or kill you or
|
|
others, and it may void your warranty. Use it at your own risk.**
|
|
|
|
Glowforge is a trademark of Glowforge, Inc. This project is not affiliated
|
|
with, authorized by, or endorsed by Glowforge, Inc.
|