me/IronOS
1
0
Fork 1
mirror of https://github.com/Ralim/IronOS.git synced 2025-02-26 07:53:55 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Adding a few more notes to the Flashing page

Browse Source
This commit is contained in:
Ben V. Brown
2022-01-05 21:24:12 +11:00
parent ee9a7c7ddb
commit 2cac11fdda
2 changed files with 28 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
Documentation/Flashing.md
View File

@@ -2,6 +2,12 @@
## Downloading source file
In the development of this firmware, there are three _types_ of firmware released.
These are the "Main" stable releases, which generally have high confidence in being bug free.
Release candidates are released slightly more often, and these are generally perfectly fine for everyday use. These are released early to allow for translation checking and for wonderful people to help spot bugs and regressions.
Finally, there are the "mainline" builds, which are built from the main git branch.
These are built on every change an can be found on the Actions tab (see below).
### Main release
Main releases are made to the [releases page](https://github.com/Ralim/IronOS/releases).
@@ -111,7 +117,20 @@ You will also need the matching drivers from [here](http://www.gd32mcu.com/downl
These are called "GD32 Dfu Drivers" if the link breaks.
You can also use dfu-util if you wish to set it up, but that is better documented by others
#### Steps:
1. Download both the `GD32 MCU DFU TOOL` and the `Drivers`
1. Install the drivers and open the DFU tool
1. Ignore the prompt to update the tool.
1. Connect pinecil to windows with usb cable while holding down minus button, **screen will be stay blank** but you will hear the noise from windows connecting to it.
1. At the top of the DFU tool, you should see `GD DFU DEVICE 1` appear at the top
1. Change the mode to `Download to device`
1. Select the `open` button in that area of the window and load the `Pinecil_XX.hex` file from the downloaded release
1. Tick the `verify after download` check box
1. Click the OK button at the bottom of the window to run the process
1. After it is complete either click "Leave DFU` or unplug the iron and power cycle it while _not_ holding down the buttons.
You can also use dfu-util if you wish to set it up, but that is better documented by others when it comes to windows.
### FAQ

14
README.md
View File

@@ -4,7 +4,7 @@
# IronOS - Flexible Soldering iron control Firmware
_This repository was formerly known as TS100, it's the same great code. Just with more supported devices_
_This repository was formerly known as TS100, it's the same great code. Just with more supported devices._
Originally conceived as an alternative firmware for the TS100, this firmware has evolved into a complex soldering iron control firmware.
@@ -20,7 +20,13 @@ This project is considered feature complete for use as a soldering iron, _so ple
_This firmware does **NOT** support the USB port while running for changing settings. This is done through the onscreen menu only. Logos are edited using the tool or python script and uploaded in DFU mode._
To get started with this firmware, please jump over to [here](Documentation/GettingStarted.md)
To get started with this firmware, please jump over to [here](Documentation/GettingStarted.md).
But the TL;DR is to press the button near the front of the iron to heat up. Use the button near the back of the iron to enter the settings menu.
Long hold the rear button in soldering mode to exit back to the start screen.
## Installation
For notes on installation for your device, please refer to the [Flashing Guide](Documentation/Flashing.md).
## Key Features
@@ -41,10 +47,6 @@ To get started with this firmware, please jump over to [here](Documentation/Gett
- [Custom boot up logo support](Documentation/Logo.md)
- Automatic LCD rotation based on the orientation
## Installation
For notes on installation for your device, please refer to the [Flashing Guide](Documentation/Flashing.md).
## Menu System
This new firmware uses a new menu system to allow access to the settings on the device.