diff --git a/docs/img/firmware-flashing-done.png b/docs/img/firmware-flashing-done.png new file mode 100644 index 0000000..8feb634 Binary files /dev/null and b/docs/img/firmware-flashing-done.png differ diff --git a/docs/img/firmware-flashing-utility.png b/docs/img/firmware-flashing-utility.png new file mode 100644 index 0000000..fcec7c9 Binary files /dev/null and b/docs/img/firmware-flashing-utility.png differ diff --git a/docs/img/menu-tools-load-firmware.png b/docs/img/menu-tools-load-firmware.png new file mode 100644 index 0000000..158e041 Binary files /dev/null and b/docs/img/menu-tools-load-firmware.png differ diff --git a/docs/installation/firmware.md b/docs/installation/firmware.md new file mode 100644 index 0000000..3acb3d0 --- /dev/null +++ b/docs/installation/firmware.md @@ -0,0 +1,37 @@ +# Firmware + +Part of the software that makes up AYAB runs on the Arduino board that is either plugged into your AYAB shield or part of your AYAB interface. We call this part the **firmware**. It is very small (about the size of a plain text email) but crucial to the operation of AYAB! + +The AYAB desktop application you installed on your computer contains the necessary firmware ready to copy to the Arduino board, but you need to ask it to do that operation. We call this "uploading" or "flashing" the firmware. + +You should perform this operation every time you install a new AYAB version on your computer. Or, if you have multiple versions of AYAB installed (for testing, for example), every time you switch from one version to another. + +Starting with AYAB 1.0, the same firmware is used regardless of the knitting machine you install the shield or interface into. So, if you have multiple knitting machines and move your AYAB shield or interface between them, there is no need to upload the firmware again every time you switch between machines. + +## Uploading the firmware + +These steps assume you have already followed the [Software installation](./software.md) instructions. + +Do not launch the AYAB application yet! First, plug your Arduino board or AYAB interface into your computer with the correct USB cable. At least one LED should light up on the board. If the computer prompts you to install drivers, follow its instructions. + +Note that the shield or interface does not need to be connected to the knitting machine for this operation, but if it is, there is no need to separate it from the machine either. + +Next, launch the AYAB software. Open to the **Tools** menu and choose the **Load AYAB firmware** item. + +![](../img/menu-tools-load-firmware.png) + +AYAB's _Firmware Flashing Utility_ opens. + +![](../img/firmware-flashing-utility.png) + +Look at the **Port** drop-down in the top right of the window. If it is empty, it means your Arduino board was not detected. Make sure the board is correctly plugged in; to give it another chance, you will have to close the _Firmware Flashing Utility_ and re-open it so that it tries to detect the board again. + +If multiple devices appear in the list and you're not sure which is your AYAB board, you can try unplugging non-essential USB devices from your computer, then close and re-open the _Firmware Flashing Utility_ so that the list is refreshed. + +Once you have selected the correct **Port**, you can go on to select the **uno** controller (this is the only type of Arduino board that AYAB 1.0 supports), then the **Firmware Version** of which there will generally only be one — the one that works with the AYAB application you are running. + +Once the firmware version is selected, the **Flash** button becomes available. Click it, and if everything goes to plan, after a few seconds the software should tell you the operation is complete: + +![](../img/firmware-flashing-done.png) + +Close the pop-up and the _Firmware Flashing Utility_. You're all set to knit! \ No newline at end of file diff --git a/docs/installation/software.md b/docs/installation/software.md index 4e882ae..6bb9bc3 100644 --- a/docs/installation/software.md +++ b/docs/installation/software.md @@ -39,6 +39,8 @@ Follow the [AppImage instructions](https://docs.appimage.org/introduction/quicks Then you can double-click the AppImage to start AYAB. +You can now head over to [Firmware](./firmware.md) to update your Arduino board. + ## Windows ### Prerequisites @@ -59,6 +61,8 @@ Run the setup, install AYAB and run it with the icon on your Desktop. **Important**: when choosing the installation directory, make sure that you do not overwrite any previous versions. Remove them or use another folder for installation. +You can now head over to [Firmware](./firmware.md) to update your Arduino board. + ## macOS ### Prerequisites @@ -107,3 +111,5 @@ You now get the option of opening the application: ![](../img/macos/ayab-app-confirm-open.png) You only have to do this confirmation once. Until you overwrite the app with a different version, macOS will remember you authorized it to run and not bother you again when you run it. + +You can now head over to [Firmware](./firmware.md) to update your Arduino board. \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index f621130..e5f0567 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -8,6 +8,7 @@ nav: - Installation: - Hardware: installation/hardware.md - Software: installation/software.md + - Firmware: installation/firmware.md - Graphical User Interface: gui.md - How To Knit: - Basics: how_to_knit/basics.md