Giter Club home page Giter Club logo

ironos-meta's Introduction

IronOS-Meta

Storing meta information for IronOS. This are things that are not part of the core "OS". This includes photographs of hardware, datasheets, schematics and of course bootup logos.

This repository uses github actions to automagically build the logos for each device. Periodically a "release" will be tagged and pre-compiled logo's will be put there as well to make it easy.

Boot-Up Logos

The IronOS 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.

  • Safe & Fun: will not over write your firmware
  • Easy install: use dfu tool just like updating firmware (or Pine64 Updater if you have a Pinecil).

Generating the Logo files

There are community logo's already converted and ready to use in 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. 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 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 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 method 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 Command line to install it.

  • dfu-util -D logo_file.dfu

ironos-meta's People

Contributors

ralim avatar river-mochi avatar discip avatar

Stargazers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.