# Dual Booting OpenGlow and Glowforge Factory Firmware
OpenGlow firmware for Glowforge brand CNC lasers can be installed along side the factory firmware using the on-board flash storage.  This has the advantage of not requiring you to solder on an external SDCARD holder.

The factory flash is a 4GB eMMC.  The factory firmware resides on two partitions that are 200MB each, and has a non-volatile (survives firmware updates) ```/data``` partition of ~3GB.  All that is stored on the ```/data``` partition is configuration files and log files.

We can resize the ```/data``` partition down to 2GB, leaving a ~1GB partition for us to install OpenGlow on.

## Prerequisites
Before getting started, you will need [serial console](https://github.com/ScottW514/forgefirm/blob/master/SERIAL.md)  access to your Glowforge.  If you do not have a unit with the factory installed, you will need to install your own.

You should also have followed the initial Glowforge [setup instructions](https://glowforge.com/support/topic/unboxing-setting-up/unboxing-and-setting-up-your-glowforge), and have your unit connected to your wireless network.

## Installation
Connect to the console port (or plug in your wired adapter) and fire up your Glowforge.  When you reach the logon prompt, enter ```root``` for the username.  No password is necessary.

![initial_boot|689x417](https://raw.githubusercontent.com/ScottW514/forgefirm/master/docs/assets/initial_boot.PNG) 

### Stage 1
We'll need to remount the root partition as read/write, and download and run the [installation script](https://github.com/ScottW514/forgefirm/blob/master/scripts/install-forgefirm.sh) by entering the following commands:
```bash
mount -o remount,rw /
curl -L https://raw.githubusercontent.com/ScottW514/forgefirm/master/scripts/install-forgefirm.sh --output ./install-forgefirm.sh
chmod +x install-forgefirm.sh
./install-forgefirm.sh
```

This will fire up the installation script, and present you with **a very important warning**:

![initial_go2|690x342](https://raw.githubusercontent.com/ScottW514/forgefirm/master/docs/assets/initial_go2.png) 

**---Dramatic Pause---**

**Did you read that?  Yes? I'll repeat, just in case - This is experimental software.  Use of this software could seriously maim or kill you or others.  Use at your own risk!**

If you are bold, type ```y``` and hit ```enter```.

From there, the script will automagically do the following:

* Stop all Glowforge services
* Back up critical data from the ```/data``` partition.  This does not include log files, but you probably don't care about those anyway...
* Rewrite the flash partition table.  This shrinks the ```/data``` partition from 3GB to 2GB, and creates a new 1GB partition for OpenGlow to live on.

After these steps have completed, you will be prompted to reboot:

![stage1|690x332](https://raw.githubusercontent.com/ScottW514/forgefirm/master/docs/assets/stage1.PNG) 

### Stage 2
After the device reboots, login as root and run the script again:
```bash
./install-forgefirm.sh
```

This will complete the installation process by performing the following steps:
* Stopping all Glowforge services
* Restoring the critical ```/data``` files
* Restarting the network services.
* Downloads the [latest OpenGlow image](https://github.com/ScottW514/forgefirm/releases) from GitHub.
* Writes the OpenGlow image to the flash (this takes a bit, be patient)
* Installs the ```/data/ffboot``` utility so you can switch between ForgeFIRM and factory images.

Hit any key to reboot into your fancy new OpenGlow image.

![stage2|690x368](https://raw.githubusercontent.com/ScottW514/forgefirm/master/docs/assets/stage2.PNG) 

### Welcome to OpenGlow!

![og_boot|689x219](https://raw.githubusercontent.com/ScottW514/forgefirm/master/docs/assets/og_boot.PNG) 

Login is ```root```, no password.  You can also connect via SSH - same user, no password (obviously, you should change this).

> **Current status: this image is bring-up-only.** No controller or cloud
> client starts at boot — the machine boots to an idle shell with the kernel
> driver, hardware libraries (gfhardware/gfutilities), and camera tooling
> installed. The grblHAL controller (forgectrl) is under development; the
> legacy cloud client (gfui-client) is deliberately not shipped. Nothing
> homes, moves, or connects anywhere until you start it yourself.

You can easily switch back and forth between factory and OpenGlow images:
```bash
# To switch to the factory image run:
/data/ffboot -e
# To switch to the OpenGlow image, run:
/data/ffboot -e4
# If you added the SDCARD, you can boot from that with:
/data/ffboot -s
```

**NOTE:**
This firmware is in beta.  It mostly works.  It is for experimentation purposes - not for production. Expect problems.