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

Logo rework (#1232)

Browse Source 
!Allows for new logo format that supports animation!
Also moves logos out of repo into their own repo for ease of management.


Changes:
* Remove deprecated logos
* Draft new Bootloader decoder
* Use new logo handler
* Simplify logo code further
* Fix time bug on static images
* Fix exit at end of animation
* Docs
* Interframe delay in 5ms increments
* Quick pass handling empty updates
* Exit at the end _after_ the frame delay
* One final delay
* Fix for overrun of logo data
* Fixes https://github.com/Ralim/IronOS-Meta/issues/7
This commit is contained in:
Ben V. Brown
2022-03-14 09:08:05 +11:00
committed by GitHub
parent fd4d93db64
commit 232009bf54
47 changed files with 129 additions and 5553 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
Documentation/Logo.md
View File

@@ -5,19 +5,22 @@ By default there is _not_ one included in the firmware, as this means that once
## Generating the Logo files
The [Python script](https://github.com/Ralim/ts100/blob/master/Bootup%20Logo/python_logo_converter/img2ts100.py) converts an image passed into it on the command line to a HEX file to be uploaded to the iron in DFU mode (similar to the process described above). 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 in an image editor and color the pixels black or white manually.
The [Python script](https://github.com/Ralim/IronOS-Meta/blob/main/Bootup%20Logos/img2logo.py) 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 (similar to the process described above). 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 in an image editor and color the pixels black or white manually.
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.
What works can vary, but this command may work:
`python3 -m pip install Pillow`
`python3 -m pip install pillow`
Then, to convert an image:
`python3 img2ts100.py infile.png outfile.hex`
- `python3 img2logo.py infile.png out -m` for Miniware
- `python3 img2logo.py infile.png out -p` for Pinecil
Run `python3 img2ts100.py --help` to see available options.
Run `python3 img2logo.py --help` to see available options.
## Flashing the Logo
@@ -26,12 +29,11 @@ Run `python3 img2ts100.py --help` to see available options.
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 of 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 instead to flash the logo art (Pinecil does not use hex).
To flash the logo, use the following steps to convert the PNG image into a .dfu file and then install the .dfu file.
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
- `python3 img2ts100.py input.png logo.dfu`
- `dfu-util -D logo.dfu`
The converter will create a DFU instead of a HEX file if the .dfu extension is used.
- `dfu-util -D logo_file.dfu`