From f269a1002f07447390bd6632164e4eeab9841e29 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Tue, 2 Aug 2022 23:22:06 -0700 Subject: [PATCH 1/5] Update Logo.md --- Documentation/Logo.md | 29 ++++++++++++++++++++--------- 1 file changed, 20 insertions(+), 9 deletions(-) diff --git a/Documentation/Logo.md b/Documentation/Logo.md index 66f8a688..4fd2a287 100644 --- a/Documentation/Logo.md +++ b/Documentation/Logo.md @@ -1,26 +1,32 @@ # Startup Logos This firmware supports a user created bootup logo. -By default, there is _not_ one included in the firmware, as this means that once flashed they generally stay. +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](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. +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. -What works can vary, but this command may work: +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. -`python3 -m pip install pillow` +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: -- `python3 img2logo.py infile.png out -m` for Miniware -- `python3 img2logo.py infile.png out -p` for Pinecil +- `python img2logo.py infile.png out -m` for Miniware +- `python img2logo.py infile.png out -p` for Pinecil -Run `python3 img2logo.py --help` to see available options. +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 @@ -33,7 +39,12 @@ If you have flashed the `IronOS-dfu` alternative bootloader, you should use the ### Pinecil -For Pinecil, we require using dfu-util instead to flash the logo art (Pinecil does not use hex). -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 +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` From 3412e173790fc6c9c25d22862809998ff7fa9ec6 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Tue, 2 Aug 2022 23:23:10 -0700 Subject: [PATCH 2/5] Update Logo.md --- Documentation/Logo.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/Logo.md b/Documentation/Logo.md index 4fd2a287..e9ef1a48 100644 --- a/Documentation/Logo.md +++ b/Documentation/Logo.md @@ -14,7 +14,7 @@ The converter requires at least Python 3 and Pillow (if you don't have it, it wi 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: +Go back to Powershell, what works can vary, but this command may work: python -m pip install Pillow or From 579085d0559e2215d80c244e1b287406ec1556c4 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Wed, 3 Aug 2022 00:26:02 -0700 Subject: [PATCH 3/5] Update README.md --- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index b319730d..a067a743 100644 --- a/README.md +++ b/README.md @@ -21,13 +21,15 @@ 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._ -| Device | DC Supported | QC Supported | PD Supported | Reccomended | -|--------: |:------------: |:------------: |:------------: |:-----------: | -| MHP30 | ❌ | ❌ | ✔️ | ✔️ | -| Pinecil | ✔️ | ✔️ | ✔️ | ✔️ | -| TS100 | ✔️ | ❌ | ❌ | ❌ | -| TS80 | ❌ | ✔️ | ❌ | ❌ | -| TS80P | ❌ | ✔️ | ✔️ | ✔️ | +| Device | DC Supported | QC Supported | PD Supported | EPR Supported | Reccomended | +|--------: |:------------: |:------------: |:------------: |:-----------: |:-----------: | +| 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. ## Getting Started From c7bb7770941c73f8b7ba7e1bbcac4c972b1c78a8 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Wed, 3 Aug 2022 00:27:03 -0700 Subject: [PATCH 4/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a067a743..2fc4a2e5 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ _This firmware does **NOT** support the USB port while running for changing sett | 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 also includes BLE bluetooth and has a teal color silicone thumb grip. Original Pinecil was black with a sky blue colored grip. ## Getting Started From cac8a205d34c7d6667f059ec035ff00d431e1208 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Wed, 3 Aug 2022 08:28:53 -0700 Subject: [PATCH 5/5] Update HallSensor.md --- Documentation/HallSensor.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/HallSensor.md b/Documentation/HallSensor.md index e0dbe500..b079e0c4 100644 --- a/Documentation/HallSensor.md +++ b/Documentation/HallSensor.md @@ -10,11 +10,11 @@ Simply moving the iron will wake it back up into soldering mode. You can also pr Inside the Sleep Menu is an additional type of sleep setting. Pinecil has an unpopulated footprint (U14) for a hall effect sensor (Si7210). It is possible with the hall sensor to trigger Pinecil to go to sleep after it enters the stand, and Zzzz will appear on the screen. After installing the hall sensor, a magnet is positioned on the stand close enough to the sensor to activate one of ten user selectable settings. - 0=off, 1=1000, 2=750, 3=500, 4=250, 5=150, 6=100, 7=75, 8=50, 9=25 (9 has the highest sensitivity to magnets) - - Setting of 1 might be used if you solder on PCBs with magnets and do not wish Pinecil to auto-sleep constantly. And a very strong/large magnet would be required on the stand to activate the sensor sleep mode. + - Setting of 1 might be used if you solder on PCBs with magnets and do not wish Pinecil to auto-sleep constantly. A very strong/large magnet would be required on the stand to activate the sleep mode if you use setting 1. - Setting of 9 would be useful if you only had a small magnet and are not concerned about Pinecil falsely triggering sleep mode near magnetized items/tools. - Neodymium magnets are recommended. If using small magnets, 2-3 may be required, but too many can also be detrimental. - Actively watch the hall number change (in [debug menu](/Documentation/DebugMenu.md)) while you slowly move the magnet around to seek the best locations & whether you have too many or too few magnets. Positioning the magnet where you have the highest hall number will ensure consistent sleep mode when you place the iron in the stand. This requires some experimenting. - Sensor is physically located near the copper contacts for the tip at the front of the handle. Reference [Schematics U14](https://files.pine64.org/doc/Pinecil/Pinecil_schematic_v1.0a_20201120.pdf). - - Positioning/type/quantity of magnets is important for best results. Sometimes [too many magnets](https://www.youtube.com/shorts/afkqKwCX00I) breaks the effect by distorting the magnetic field. + - Positioning/type/quantity of magnets is important for best results. Sometimes too many magnets breaks the effect by distorting the magnetic field as seen [here](https://www.youtube.com/shorts/afkqKwCX00I). Video shows magnets at the top of the stand, and the pinecil goes correctly into Zzzz with only those magnets. Adding more magnets at the side, the Pinecil did not go to sleep, see PDF below for details on magnetic fields. - Orientation of North and South faces of magnets is important to increase reaction of the hall sensor [SI7210-B-00-IV](https://www.silabs.com/documents/public/application-notes/an1018-si72xx-sensors.pdf).