sv/IronOS
1
0
Fork 0
forked from me/IronOS
Code Pull Requests Activity

document updates (#1355)

Browse Source
This commit is contained in:
River B
2022-08-04 16:50:11 -07:00
committed by GitHub
parent 79aa8ed1f4
commit eebf65f83c
2 changed files with 68 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

106
Documentation/Logo.md
View File

@@ -1,50 +1,56 @@
# Startup Logos
This firmware supports a user created bootup logo.
By default, there is _not_ one included in the firmware. This means that once flashed they generally stay. If you want no logo again, you would have to flash a blank image to the bootup logo.
## Generating the Logo files
The Python script and related files are in [IronOS-Meta](https://github.com/Ralim/IronOS-Meta/). It converts an image passed into it on the command line to a `.hex` file or a `.dfu` to be uploaded to the iron in DFU mode. The image can be in color and any size, but it will be resized and converted to 1-bit color. However, it looks best if you create a 96x16 image (Png or Bmp) in any image editor and color the pixels black & white manually. It is easiest to select green Code button, then Download Zip. This way you get all the files you need and some extras. You only need what is inside Boot Logos. Put your custom image inside Boot Logos folder with all python script files in there.
There are community logo's already converted available for download in the releases in [IronOS-Meta](https://github.com/Ralim/IronOS-Meta/).
The converter requires at least Python 3 and Pillow (if you don't have it, it will tell you to install PIL, which is an old version of the same thing). See [this page](https://stackoverflow.com/a/20061019/6705343) on StackOverflow about installing it.
Follow online instructions for installing Python and Pillow. For Windows, it is recommended to use Windows PowerShell instead of Command.
Open Powershell (run as administrator), type python to install it, it will open microsoft store where you can install it.
Go back to Powershell, what works can vary, but this command may work:
python -m pip install Pillow
or
python3 -m pip install pillow
Then, to convert an image:
- `python img2logo.py infile.png out -m` for Miniware
- `python img2logo.py infile.png out -p` for Pinecil
Run `python img2logo.py --help` to see available options. Replace word python with python3 if you have multiple versions of python installed.
Make sure your image file is in the same folder as scripts img2logo.py, output_dfu.py, and output_hex.py.
## Flashing the Logo
### Miniware (TS100/TS80/TS80P)
Upload the HEX file to the iron in DFU mode and, if the file's extension changes to .RDY, your custom splash screen should show up on startup.
You perform this the same way as if you were flashing a new firmware, and all the existing notes around this apply.
If you have flashed the `IronOS-dfu` alternative bootloader, you should use the `.dfu` files instead
### Pinecil
For Pinecil, we require using dfu-util to flash the logo art (Pinecil does not use hex).
[Pine64 Updater](https://github.com/pine64/pine64_updater/releases) is the easiest way to load the Bootup logo onto Pinecil as it already includes the necessary DFU library. Connect Pinecil to PC, and open the Updater the same as if you were updating firmware.
Select Custom > Browse to the DFU image file you just made > Update to install.
The bootup logo is stored in a separate location than the IronOS firmware and you do not have to worry about it changing or breaking the IronOS.
Please see the [Meta repo](https://github.com/Ralim/IronOS-Meta) for the tooling for converting logo's as well as automatically generated logo's.
You could also use dfu-util and use Command line to install it.
- `dfu-util -D logo_file.dfu`
# Startup Logos
This firmware supports a user created bootup logo.
By default, there is _not_ one included in the firmware. This means that once flashed they generally stay. If you want no logo again, you would have to flash a blank image to the bootup logo.
## Generating the Logo files
There are community logo's already converted and ready to use in [IronOS-Meta/releases](https://github.com/Ralim/IronOS-Meta/releases).
Download the zip for Pinecil or Miniware and then install using the instructions in the Flashing section below.
If you want to make custom art then it needs to be converted with a Python script. The script and other needed files are in [IronOS-Meta](https://github.com/Ralim/IronOS-Meta/). Go to that folder, then it is easiest to select the green Code button (upper right), then Download Zip. This way you get all the files you need and some extras. You only need what is inside Boot Logos. Put your custom image inside the Boot Logos folder with all python script files already there.
The Python script converts an image passed into it on the command line into both a `.hex` file and a `.dfu` to be uploaded to the iron in DFU mode. The image can be in color and any size, but it will be resized and converted to 1-bit color. However, it looks best if you create a 96x16 image (Png or Bmp) in any image editor and color the pixels black & white manually.
The converter requires at least Python3 and Pillow apps. Follow online instructions for installing Python and Pillow.
For Windows, it is recommended to use Windows PowerShell instead of Command.
Open Powershell (run as administrator), type python to install it, it will open microsoft store where you can install it free.
Go back to Powershell and install Pillow. What works can vary, but this command may work:
python -m pip install Pillow
or
python3 -m pip install pillow
If the above does not work, see [this page](https://stackoverflow.com/a/20061019/6705343) on StackOverflow about installing Pillow.
Now that Python and Pillow are successfuly installed, you can convert an image.
Go back to Powershell and type this command (change infile.png to the name of your image):
- `python img2logo.py infile.png out -m` for Miniware
- `python img2logo.py infile.png out -p` for Pinecil
Run `python img2logo.py --help` to see available options. Replace the word python with python3 if you have multiple versions of python installed.
Note: make sure your image file is in the same folder as script files (img2logo.py, output_dfu.py, output_hex.py).
## Flashing the Logo
### Miniware (TS100/TS80/TS80P)
Upload the HEX file to the iron in DFU mode and, if the file's extension changes to .RDY, your custom splash screen should show up on startup.
You perform this the same way as if you were flashing a new firmware, and all the existing notes around this apply.
If you have flashed the `IronOS-dfu` alternative bootloader, you should use the `.dfu` files instead
### Pinecil
For Pinecil, we require using dfu-util to flash the logo art (Pinecil does not use hex).
[Pine64 Updater](https://github.com/pine64/pine64_updater/releases) is the easiest way to load the Bootup logo onto Pinecil as it already includes the necessary DFU library. Connect Pinecil to a PC, and open the Updater the same as updating firmware.
Select Custom > Browse to the DFU image file you just made > Update to install.
The bootup logo is stored in a separate location than the IronOS firmware and you do not have to worry about it changing or breaking the IronOS.
You could also use dfu-util and use Command line to install it.
- `dfu-util -D logo_file.dfu`

24
README.md
View File

@@ -8,30 +8,30 @@ _This repository was formerly known as TS100, it's the same great code. Just wit
Originally conceived as an alternative firmware for the TS100, this firmware has evolved into a complex soldering iron control firmware.
The firmware implements all of the standard features of a "smart" soldering iron, with lots of little extras and tweaks.
The firmware implements all of the standard features of a 'smart' soldering iron, with lots of little extras and tweaks.
I highly recommend reading the installation guide fully when installing on your iron. And after install just explore the settings menu.
For soldering irons that are designed to be powered by "smart" power sources (QC and PD), the firmware supports settings around the negotiated power and voltage.
For soldering irons that are designed to be powered by 'smart' power sources (QC and PD), the firmware supports settings around the negotiated power and voltage.
For soldering irons that are designed to be powered by batteries (TS100 & Pinecil), settings for a cutoff voltage for battery protection are supported.
There are 30 languages currently supported as of present. When downloading the firmware for your soldering iron take note of the language code in the file name.
There are 30 languages currently supported. When downloading the firmware for your soldering iron, take note of the language code in the file name.
This project is considered feature complete for use as a soldering iron, _so please suggest any feature improvements you would like!_
_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._
| Device | DC Supported | QC Supported | PD Supported | EPR Supported | Reccomended |
|--------: |:------------: |:------------: |:------------: |:-----------: |:-----------: |
| MHP30 | ❌ | ❌ | ✔️ | ❌ | ✔️ |
| Pinecil | ✔️ | ✔️ | ✔️ | ✔️* | ✔️ |
| TS100 | ✔️ | ❌ | ❌ | ❌ | ❌ |
| TS80 | ❌ | ✔️ | ❌ | ❌ | ❌ |
| TS80P | ❌ | ✔️ | ✔️ | ❌ | ✔️ |
| Device | DC Support| QC Support | PD Support | EPR Support | Battery | Recommended |
|--------: |:---------:|:----------:|:----------:|:----------:|:--------:|:-----------:|
| MHP30 | ❌ | ❌ | ✔️ | ❌ | ❌ | ✔️ |
| Pinecil | ✔️ | ✔️ | ✔️ | ✔️* | ✔️ | ✔️ |
| TS100 | ✔️ | ❌ | ❌ | ❌ | ✔️ | ❌ |
| TS80 | ❌ | ✔️ | ❌ | ❌ | ✔️ | ❌ |
| TS80P | ❌ | ✔️ | ✔️ | ❌ | ✔️ | ✔️ |
*Only Pinecil version 2 sold after Aug 2, 2022 has support for EPR PD3.1 28V/140W. The new model also includes BLE bluetooth and has a teal color silicone thumb grip. Original Pinecil was black with a sky blue colored grip.
_*Only Pinecil version 2 sold after Aug 2, 2022 has support for EPR PD3.1 28V/140W_. The new model includes BLE bluetooth and has a teal color silicone thumb grip. Original Pinecil was black with a sky blue colored grip.
Please note that Miniware have started to ship TS100's using cloned STM32 Chips. While these do work with IronOS, their DFU bootloader works terribly and it is hard to get it to successfully flash larger firmware images like IronOS without timing out. THis is the main reason why the TS100 is _no longer reccomended_.
Please note that Miniware started shipping TS100's using cloned STM32 Chips. While these do work with IronOS, their DFU bootloader works terribly, and it is hard to get it to successfully flash larger firmware images like IronOS without timing out. This is the main reason why the TS100 is _no longer recommended_.
## Getting Started