From 66fe4061dffaee84136ae621a42cb2426092ff9c Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 10:05:16 -0800 Subject: [PATCH 01/81] update debugging details --- Documentation/DebugMenu.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/Documentation/DebugMenu.md b/Documentation/DebugMenu.md index 91ac0a9a..d39857ee 100644 --- a/Documentation/DebugMenu.md +++ b/Documentation/DebugMenu.md @@ -1,12 +1,12 @@ # Debugging Menu In this firmware there is extra debugging information hidden under an extra menu. -This is accessed by holding the rear (B) button on the iron while it is on the home screen. +This is accessed by holding the rear (-/B) button on the iron while it is on the home screen. This menu is meant to be simple, so it has no fancy GUI animations. -To move through the menu use the front (A) button. -To exit, use the rear (B) button again. +To move through the menu use the front (+/A) button. +To exit, use the rear (-/B) button again. ## Menu items @@ -45,7 +45,7 @@ This can be used with RTip for assessing temperature processing performance. ### CHan -This is the handle temperature in C. This is used for cold junction compensation of the tip temp. +This is the handle temperature in C. This is used for cold junction compensation of the tip temperature. This is shown in degrees C x10, so 200 == 20.0C ### Vin @@ -73,6 +73,8 @@ This may change during power up as the sources are negotiated in turn. - **QC** input (We used QC2/3 negotiation for current supply) - **PD W. VBus** input (We used the PD subsystem to negotiate for the current supply); and VBus is connected to your input power source - **PD No VBus** input (We used the PD subsystem to negotiate for the current supply); and VBus is **NOT** connected to your input power source +- If you successfully modified the Pinecil to support 24V by cutting the trace line to Vbus, then PD No VBus displays on screen. +- Connect to any PD USB power to check Vbus status, it will not show message when Pinecil is powered by DC port. ### Max @@ -82,5 +84,5 @@ This is dependant on a few factors including the handle temperature so it can mo ### Hall -This will appear if your device is capable of having a magnetic hall effect sensor fitted. -This will show the current field strength reading from the sensor, this can be used to check the sensor is operational and measure how strong the magnetic field is for diagnostics. +This appears if your device is capable of having a magnetic hall effect sensor installed (Pinecil). +This shows the current field strength reading from the sensor. It can be used to check if the sensor is operational, and measure how strong the magnetic field is for diagnostics and optimal placement of magnets on a stand. From 07fd93af8f17de9a9888fc0a4abebe19a3323c1f Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 10:06:27 -0800 Subject: [PATCH 02/81] Update DebugMenu.md --- Documentation/DebugMenu.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/DebugMenu.md b/Documentation/DebugMenu.md index d39857ee..2b49d493 100644 --- a/Documentation/DebugMenu.md +++ b/Documentation/DebugMenu.md @@ -73,7 +73,7 @@ This may change during power up as the sources are negotiated in turn. - **QC** input (We used QC2/3 negotiation for current supply) - **PD W. VBus** input (We used the PD subsystem to negotiate for the current supply); and VBus is connected to your input power source - **PD No VBus** input (We used the PD subsystem to negotiate for the current supply); and VBus is **NOT** connected to your input power source -- If you successfully modified the Pinecil to support 24V by cutting the trace line to Vbus, then PD No VBus displays on screen. +- If you successfully modified the Pinecil to support 24V by cutting the trace line to Vbus, then 'PD No VBus' displays on screen. - Connect to any PD USB power to check Vbus status, it will not show message when Pinecil is powered by DC port. ### Max From 51d2fbb43348ced16722167bbcecf4ce474a1b42 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 10:07:00 -0800 Subject: [PATCH 03/81] Update DebugMenu.md --- Documentation/DebugMenu.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/DebugMenu.md b/Documentation/DebugMenu.md index 2b49d493..a0675ced 100644 --- a/Documentation/DebugMenu.md +++ b/Documentation/DebugMenu.md @@ -78,7 +78,7 @@ This may change during power up as the sources are negotiated in turn. ### Max -This indicates the max temp in C that the system estimates it can measure the tip reliably to. +This indicates the max temperature in C that the system estimates it can measure the tip reliably to. This is dependant on a few factors including the handle temperature so it can move around during use. From 86dce76cabf1c47d4a1bad67db7c7df0c498e597 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 10:12:28 -0800 Subject: [PATCH 04/81] Update Flashing.md --- Documentation/Flashing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md index 3e4b1caf..de56298a 100644 --- a/Documentation/Flashing.md +++ b/Documentation/Flashing.md @@ -12,7 +12,7 @@ These are built on every change and can be found on the Actions tab (see below). Main releases are made to the [releases page](https://github.com/Ralim/IronOS/releases). Download the zip file that matches your model of soldering iron, and extract it. -You then need to use the appropriate file type for your unit, in general Miniware devices need `.hex` and Pinecil need `.bin`. +Select the appropriate file type for your unit, in general Miniware devices need `.hex` and Pinecil needs `.dfu`. Flash according to details below ### Bleeding edge / latest From 82ed8beac2fc1b426806a5276b2cce4684f4fcbf Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 10:27:16 -0800 Subject: [PATCH 05/81] Update Flashing.md --- Documentation/Flashing.md | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md index de56298a..3a32cc86 100644 --- a/Documentation/Flashing.md +++ b/Documentation/Flashing.md @@ -88,18 +88,15 @@ Check the extension of your firmware, it should be `.RDY` now. ## Pinecil (Pine64) -The MCU used in the Pinecil supports usb-dfu. +The MCU used in the Pinecil supports usb-dfu. Reference Pine64 [Wiki](https://wiki.pine64.org/wiki/Pinecil). -There is the nice gui [Pinecil Firmware Updater](https://github.com/pine64/pinecil-firmware-updater/releases). In the event that this tool is unavailable or otherwise does not meet your needs, the below process may be used to update the firmware. +There is the nice gui [Pinecil Firmware Updater](https://github.com/pine64/pinecil-firmware-updater/releases). It works in several types of OS, i.e. Windows/Mac. If your OS is not currently supported by the Updater or it does not meet your needs, the below manual process may be used to update the firmware. -To enter DFU mode, hold the button at the back of the iron while connecting to usb over usb-c. +To enter DFU mode, long hold the (-) button at the back of the iron, then connect to usb over usb-c. Generally all usb controllers work, but some hubs have issues so avoiding hubs may be best. -Once the device is connected while holding the button, the screen will stay **off**. - -This is normal, and then you can use the appropriate tool to load the `.hex` or `.bin` file as per your OS. - -You can also refer to the Pine64 [Wiki](https://wiki.pine64.org/wiki/Pinecil). +Release the (-) button after ~10 seconds. The screen will stay **off/black** to indicate the Pinecil is in DFU mode. This is normal. +Then use the appropriate tool per you specific OS to load the `.dfu` file onto the Pinecil. ### Linux and Mac @@ -137,7 +134,7 @@ These are called "GD32 Dfu Drivers" if the link breaks. 1. Download both the `GD32 MCU DFU TOOL` and the `Drivers`. 2. Install the drivers and open the DFU tool. 3. Ignore the prompt to update the tool. -4. Connect the Pinecil to a Windows PC via USB cable while holding down the minus button, **screen will stay blank** but you will hear the noise from Windows connecting to it. +4. While holding down the minus button, Connect the Pinecil to a Windows PC via USB cable. The **screen will stay blank** but you will hear the beep from Windows connecting to it. 5. At the top of the DFU tool, you should see `GD DFU DEVICE 1` appear. 6. Change the mode to `Download to device`. 7. Select the `open` button in that area of the window and load the `Pinecil_XX.hex` file from the downloaded release. From 638cce8b1b7425cf78eab7d94468ffeab05eef08 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 10:29:32 -0800 Subject: [PATCH 06/81] Update GettingStarted.md --- Documentation/GettingStarted.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/GettingStarted.md b/Documentation/GettingStarted.md index 2899187a..b9e86c82 100644 --- a/Documentation/GettingStarted.md +++ b/Documentation/GettingStarted.md @@ -1,7 +1,7 @@ # Getting Started -Getting started with Iron OS on your Pinecil/TS80/TS80P/TS100. -If your device did not come with Iron OS already installed, or if you need to update to the latest version; please see the [Flashing Guide](/Documentation/Flashing.md). +Getting started with IronOS on your Pinecil/TS80/TS80P/TS100. +If your device did not come with IronOS already installed, or if you need to update to the latest version; please see the [Flashing Guide](/Documentation/Flashing.md). Once your Iron has been flashed, on first power on it _may_ warn you about the system settings being reset. _Do not panic_; this is 100% completely normal. This is here to note to you that they have been reset to handle the internal structure changing. From 005856023d7820e7a26b322c9619308daf1c936d Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 10:30:24 -0800 Subject: [PATCH 07/81] Update GettingStarted.md --- Documentation/GettingStarted.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/GettingStarted.md b/Documentation/GettingStarted.md index b9e86c82..76bc8bc1 100644 --- a/Documentation/GettingStarted.md +++ b/Documentation/GettingStarted.md @@ -1,7 +1,7 @@ # Getting Started Getting started with IronOS on your Pinecil/TS80/TS80P/TS100. -If your device did not come with IronOS already installed, or if you need to update to the latest version; please see the [Flashing Guide](/Documentation/Flashing.md). +If your device did not come with IronOS already installed, or if you need to update to the latest version; please see the [Flashing Guide](/Documentation/Flashing.md). It is recommended to update to the newest stable release. Once your Iron has been flashed, on first power on it _may_ warn you about the system settings being reset. _Do not panic_; this is 100% completely normal. This is here to note to you that they have been reset to handle the internal structure changing. From 71c450729e6634067ee873f10ba8a7e2ed79cae3 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 11:55:48 -0800 Subject: [PATCH 08/81] Update GettingStarted.md --- Documentation/GettingStarted.md | 31 +++++++++++++++++++------------ 1 file changed, 19 insertions(+), 12 deletions(-) diff --git a/Documentation/GettingStarted.md b/Documentation/GettingStarted.md index 76bc8bc1..89984f71 100644 --- a/Documentation/GettingStarted.md +++ b/Documentation/GettingStarted.md @@ -18,7 +18,7 @@ By default this will show a screen similar to the one below: Note that this may be drawn mirrored depending on the orientation of your screen. -The soldering iron symbol on the screen will appear near the tip. This is here to indicate that pressing the button closest to the front of the soldering iron will enter soldering mode. +The soldering iron symbol on the screen will appear near the tip. This is here to indicate that pressing the button closest to the front of the iron will enter soldering mode. And naturally, the spanner like icon represents that pressing the button near the rear of the soldering iron will enter the settings menu. @@ -40,11 +40,11 @@ If you press and hold the button near the rear of the iron it will take you into ## Soldering Mode -When you press the button to enter into the soldering mode, the iron will instantly start to heat up the tip. +When you press the button to enter the soldering mode, the iron will instantly start to heat up the tip. The firmware defaults to 320C as the set point for the soldering mode, however on this screen you can enter into the adjustment screen by pressing either button. -Pressing and holding the button near the tip will enter **boost** mode. This allows temporarily overriding the set temperature to a higher (or lower) value. This can be useful as a way to force the tip to a higher temperature to drive more wattage into a large joint when the thermal connection is not ideal. +Pressing and holding the button near the tip will enter **boost** mode. This allows temporarily override of the set temperature to a higher (or lower) value. This can be useful as a way to force the tip to a higher temperature to drive more wattage into a large joint when the thermal connection is not ideal. Pressing and holding the rear button will exit soldering mode and land you back at the home screen. You can also do this by pressing both buttons at once and this will also work, this is a bit harder to do but is kept for compatibility with the Miniware firmware. @@ -52,28 +52,35 @@ Pressing and holding **both** buttons at once will enter locked mode, which will ### Idle sleep -If the iron detects a period of time without any significant movement, it will enter into a sleep mode. This is indicated with a graphic on the screen similar to ZZzz (or text in detailed mode). +If the iron detects a period of time without any significant movement, it will enter sleep mode. This is indicated with a screen graphic similar to ZZzz (or text in detailed mode). -In this mode, the temperature of the iron will automatically reduce down to a temperature just below the melting point of the solder. This helps reduce the rate of oxidation and damage to the iron tip. +In Sleep mode, the temperature of the iron automatically lowers to a temperature just below the melting point of the solder. This helps reduce the rate of oxidation and damage to the iron tip. In general, when you are not using the iron, turn it off or let it sleep to increase durability of the replaceable tips. Simply picking up or moving the iron will wake it back up into soldering mode. You can also press any button and this will also wake the iron up. -The Pinecil has a footprint (unpopulated) on the PCB for a hall effect sensor (Si7210). If you fit this then iron will additionally force sleep when it detects a strong magnetic field near the tip of the plastic body. This allows attaching a strong magnet near your iron holder to ensure it always enters sleep. +Pinecil Only +Optional Hall Effect Feature: Pinecil has a footprint (unpopulated U14) on the PCB for a hall effect sensor (Si7210). Pinecil will sleep the moment it enters the stand and ZZzz appears on the screen. After installing the sensor, a magnet is positioned on the stand close enough to the sensor to activate one of 9 settings. + 9 = high sensitivity to small magnets...1 = low sensitivity. +Setting of 1 might be used by someone who solders on boards with magnets and does not wish Pinecil to auto-sleep constantly and would then also need to use a very strong/large neomydium magnet on the stand to activate the sensor sleep mode. Setting of 9 would be used by someone who only had a small magnet and is not concerned about Pinecil falsely triggering sleep near magnetic fields like magnetized screwdrivers. + +Neodymium magnets are recommended. If using small magnets, multiple may be required, but too many can also be detrimental - watch the Debug hall number. +The Debug Hall number can guide you to the best locations for the magnets & whether you have too many or too few [debug menu](/Documentation/DebugMenu.md). +The Hall Sensor is physically located near the copper contacts for the tip at the front of the handle. Reference [Schematics](https://files.pine64.org/doc/Pinecil/Pinecil_schematic_v1.0a_20201120.pdf) ### Idle shutdown -If, after entering sleep mode the iron still does not see movement for a much longer time; it will shut down and return to the home screen. +If, after entering sleep mode, the iron still does not see movement for a much longer time; it will shut down and return to the home screen (default = 10 minutes). ## Settings Menu -The settings menu is the most often evolving aspect of the firmware, so each option is not documented here. However, do not panic, as every menu option has a description so that you don't _need_ to come back here to figure them all out. +The settings menu is the most often evolving aspect of the firmware, so each option is not documented here. However, do not panic, as every menu option has an on-screen description so you don't _need_ to come back here to figure them all out. To navigate the menu, the two buttons act separately. -The button that you pressed to enter the menu (rear) cycles down the options, and the other button (front) will change the current option. +The button that you pressed to enter the menu (rear) scrolls down the options, and the other button (front) will enter and change the current option. -To see a description of an option, just pause and wait and after a little bit, it will scroll across the screen. +To see a description of an option, just wait and after a little time, it will scroll across the screen. -The menu is comprised of a "main menu" of categories and then sub-items that allows you to adjust parameters. +The menu is comprised of a 'main menu' of categories and then sub-items that allows you to adjust parameters. You can long hold buttons to change through options faster, and there is some acceleration when holding the buttons. @@ -81,4 +88,4 @@ There is a small scrollbar that will be shown along the edge of the screen to in Additionally, this scrollbar will blink rapidly when you are on the last item in a menu choice. -I highly recommend taking a few minutes to go through all of the options in the menu to get a feel for what you can change, almost every aspect of the internal system is adjustable to suit you. +I highly recommend taking a few minutes to go through all of the options in the menu to get a feel for what you can change, almost every aspect of the internal system is adjustable to suit your needs. From cf3f1c9e5a8d388d13d18f7f3776d21ebffa1c9e Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 11:57:23 -0800 Subject: [PATCH 09/81] Update GettingStarted.md --- Documentation/GettingStarted.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/GettingStarted.md b/Documentation/GettingStarted.md index 89984f71..ee69128a 100644 --- a/Documentation/GettingStarted.md +++ b/Documentation/GettingStarted.md @@ -58,7 +58,7 @@ In Sleep mode, the temperature of the iron automatically lowers to a temperature Simply picking up or moving the iron will wake it back up into soldering mode. You can also press any button and this will also wake the iron up. -Pinecil Only +# Pinecil Only Optional Hall Effect Feature: Pinecil has a footprint (unpopulated U14) on the PCB for a hall effect sensor (Si7210). Pinecil will sleep the moment it enters the stand and ZZzz appears on the screen. After installing the sensor, a magnet is positioned on the stand close enough to the sensor to activate one of 9 settings. 9 = high sensitivity to small magnets...1 = low sensitivity. Setting of 1 might be used by someone who solders on boards with magnets and does not wish Pinecil to auto-sleep constantly and would then also need to use a very strong/large neomydium magnet on the stand to activate the sensor sleep mode. Setting of 9 would be used by someone who only had a small magnet and is not concerned about Pinecil falsely triggering sleep near magnetic fields like magnetized screwdrivers. From 41ae8e9cbe7f68219d9bae358306ea24607b78b1 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 11:58:10 -0800 Subject: [PATCH 10/81] Update GettingStarted.md --- Documentation/GettingStarted.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Documentation/GettingStarted.md b/Documentation/GettingStarted.md index ee69128a..d313a917 100644 --- a/Documentation/GettingStarted.md +++ b/Documentation/GettingStarted.md @@ -58,7 +58,8 @@ In Sleep mode, the temperature of the iron automatically lowers to a temperature Simply picking up or moving the iron will wake it back up into soldering mode. You can also press any button and this will also wake the iron up. -# Pinecil Only +Pinecil Only + Optional Hall Effect Feature: Pinecil has a footprint (unpopulated U14) on the PCB for a hall effect sensor (Si7210). Pinecil will sleep the moment it enters the stand and ZZzz appears on the screen. After installing the sensor, a magnet is positioned on the stand close enough to the sensor to activate one of 9 settings. 9 = high sensitivity to small magnets...1 = low sensitivity. Setting of 1 might be used by someone who solders on boards with magnets and does not wish Pinecil to auto-sleep constantly and would then also need to use a very strong/large neomydium magnet on the stand to activate the sensor sleep mode. Setting of 9 would be used by someone who only had a small magnet and is not concerned about Pinecil falsely triggering sleep near magnetic fields like magnetized screwdrivers. From fe6dfaa40b2b603d933583becde2e60155a8dbff Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 12:00:21 -0800 Subject: [PATCH 11/81] Update GettingStarted.md --- Documentation/GettingStarted.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/Documentation/GettingStarted.md b/Documentation/GettingStarted.md index d313a917..0d4a2124 100644 --- a/Documentation/GettingStarted.md +++ b/Documentation/GettingStarted.md @@ -59,13 +59,12 @@ In Sleep mode, the temperature of the iron automatically lowers to a temperature Simply picking up or moving the iron will wake it back up into soldering mode. You can also press any button and this will also wake the iron up. Pinecil Only - Optional Hall Effect Feature: Pinecil has a footprint (unpopulated U14) on the PCB for a hall effect sensor (Si7210). Pinecil will sleep the moment it enters the stand and ZZzz appears on the screen. After installing the sensor, a magnet is positioned on the stand close enough to the sensor to activate one of 9 settings. 9 = high sensitivity to small magnets...1 = low sensitivity. Setting of 1 might be used by someone who solders on boards with magnets and does not wish Pinecil to auto-sleep constantly and would then also need to use a very strong/large neomydium magnet on the stand to activate the sensor sleep mode. Setting of 9 would be used by someone who only had a small magnet and is not concerned about Pinecil falsely triggering sleep near magnetic fields like magnetized screwdrivers. Neodymium magnets are recommended. If using small magnets, multiple may be required, but too many can also be detrimental - watch the Debug hall number. -The Debug Hall number can guide you to the best locations for the magnets & whether you have too many or too few [debug menu](/Documentation/DebugMenu.md). +The Debug Hall number can guide you to the best locations for the magnets & whether you have too many or too few [debug menu](/Documentation/DebugMenu.md). The Hall Sensor is physically located near the copper contacts for the tip at the front of the handle. Reference [Schematics](https://files.pine64.org/doc/Pinecil/Pinecil_schematic_v1.0a_20201120.pdf) ### Idle shutdown From 37e87f826d743b3b6b18b5f7dd8a554e51a8eb66 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 12:06:23 -0800 Subject: [PATCH 12/81] Update GettingStarted.md --- Documentation/GettingStarted.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/Documentation/GettingStarted.md b/Documentation/GettingStarted.md index 0d4a2124..d3e8943c 100644 --- a/Documentation/GettingStarted.md +++ b/Documentation/GettingStarted.md @@ -59,13 +59,14 @@ In Sleep mode, the temperature of the iron automatically lowers to a temperature Simply picking up or moving the iron will wake it back up into soldering mode. You can also press any button and this will also wake the iron up. Pinecil Only -Optional Hall Effect Feature: Pinecil has a footprint (unpopulated U14) on the PCB for a hall effect sensor (Si7210). Pinecil will sleep the moment it enters the stand and ZZzz appears on the screen. After installing the sensor, a magnet is positioned on the stand close enough to the sensor to activate one of 9 settings. - 9 = high sensitivity to small magnets...1 = low sensitivity. -Setting of 1 might be used by someone who solders on boards with magnets and does not wish Pinecil to auto-sleep constantly and would then also need to use a very strong/large neomydium magnet on the stand to activate the sensor sleep mode. Setting of 9 would be used by someone who only had a small magnet and is not concerned about Pinecil falsely triggering sleep near magnetic fields like magnetized screwdrivers. -Neodymium magnets are recommended. If using small magnets, multiple may be required, but too many can also be detrimental - watch the Debug hall number. -The Debug Hall number can guide you to the best locations for the magnets & whether you have too many or too few [debug menu](/Documentation/DebugMenu.md). -The Hall Sensor is physically located near the copper contacts for the tip at the front of the handle. Reference [Schematics](https://files.pine64.org/doc/Pinecil/Pinecil_schematic_v1.0a_20201120.pdf) +Optional Hall Effect Feature: Pinecil has a footprint (unpopulated U14) on the PCB for a hall effect sensor (Si7210). Pinecil will sleep the moment it enters the stand and ZZzz appears on the screen. After installing the sensor, a magnet is positioned on the stand close enough to the sensor to activate one of 9 settings. + - 9 = high sensitivity to small magnets...1 = low sensitivity. + - Setting of 1 might be used by someone who solders on PCBs with magnets and does not wish Pinecil to auto-sleep constantly. They would also need to use a very strong/large neomydium magnet on the stand to activate the sensor sleep mode. + - Setting of 9 would be useful if you only had a small magnet and are not concerned about Pinecil falsely triggering sleep mode near items like magnetized screwdrivers. + - Neodymium magnets are recommended. If using small magnets, multiple may be required, but too many can also be detrimental - watch the Debug hall number. + - The Debug Hall number can guide you to the best locations for the magnets & whether you have too many or too few [debug menu](/Documentation/DebugMenu.md). + - The Hall Sensor is physically located near the copper contacts for the tip at the front of the handle. Reference [Schematics](https://files.pine64.org/doc/Pinecil/Pinecil_schematic_v1.0a_20201120.pdf) ### Idle shutdown From 21d586153a734b728fa4ed9ecf0f11bd1de1785b Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 12:06:50 -0800 Subject: [PATCH 13/81] Update GettingStarted.md --- Documentation/GettingStarted.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/GettingStarted.md b/Documentation/GettingStarted.md index d3e8943c..602cf5a5 100644 --- a/Documentation/GettingStarted.md +++ b/Documentation/GettingStarted.md @@ -61,7 +61,7 @@ Simply picking up or moving the iron will wake it back up into soldering mode. Y Pinecil Only Optional Hall Effect Feature: Pinecil has a footprint (unpopulated U14) on the PCB for a hall effect sensor (Si7210). Pinecil will sleep the moment it enters the stand and ZZzz appears on the screen. After installing the sensor, a magnet is positioned on the stand close enough to the sensor to activate one of 9 settings. - - 9 = high sensitivity to small magnets...1 = low sensitivity. + - 9 = high sensitivity to small magnets ... 1 = low sensitivity. - Setting of 1 might be used by someone who solders on PCBs with magnets and does not wish Pinecil to auto-sleep constantly. They would also need to use a very strong/large neomydium magnet on the stand to activate the sensor sleep mode. - Setting of 9 would be useful if you only had a small magnet and are not concerned about Pinecil falsely triggering sleep mode near items like magnetized screwdrivers. - Neodymium magnets are recommended. If using small magnets, multiple may be required, but too many can also be detrimental - watch the Debug hall number. From 74a177338f562b7948283a97206d5097afa6f632 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 12:10:09 -0800 Subject: [PATCH 14/81] Update GettingStarted.md --- Documentation/GettingStarted.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/Documentation/GettingStarted.md b/Documentation/GettingStarted.md index 602cf5a5..73f22567 100644 --- a/Documentation/GettingStarted.md +++ b/Documentation/GettingStarted.md @@ -58,9 +58,8 @@ In Sleep mode, the temperature of the iron automatically lowers to a temperature Simply picking up or moving the iron will wake it back up into soldering mode. You can also press any button and this will also wake the iron up. -Pinecil Only - -Optional Hall Effect Feature: Pinecil has a footprint (unpopulated U14) on the PCB for a hall effect sensor (Si7210). Pinecil will sleep the moment it enters the stand and ZZzz appears on the screen. After installing the sensor, a magnet is positioned on the stand close enough to the sensor to activate one of 9 settings. +Optional Hall Effect Feature on Pinecil Only: +Pinecil has an unpopulated footprint (U14) for a hall effect sensor (Si7210). Pinecil will sleep after it enters the stand and ZZzz will appear on the screen. After installing the sensor, a magnet is positioned on the stand close enough to the sensor to activate one of 9 settings. - 9 = high sensitivity to small magnets ... 1 = low sensitivity. - Setting of 1 might be used by someone who solders on PCBs with magnets and does not wish Pinecil to auto-sleep constantly. They would also need to use a very strong/large neomydium magnet on the stand to activate the sensor sleep mode. - Setting of 9 would be useful if you only had a small magnet and are not concerned about Pinecil falsely triggering sleep mode near items like magnetized screwdrivers. From ae65374205fe0653fe86c127a6e38477354190c7 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 12:13:04 -0800 Subject: [PATCH 15/81] Update GettingStarted.md --- Documentation/GettingStarted.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/Documentation/GettingStarted.md b/Documentation/GettingStarted.md index 73f22567..0dc8f668 100644 --- a/Documentation/GettingStarted.md +++ b/Documentation/GettingStarted.md @@ -63,8 +63,7 @@ Pinecil has an unpopulated footprint (U14) for a hall effect sensor (Si7210). Pi - 9 = high sensitivity to small magnets ... 1 = low sensitivity. - Setting of 1 might be used by someone who solders on PCBs with magnets and does not wish Pinecil to auto-sleep constantly. They would also need to use a very strong/large neomydium magnet on the stand to activate the sensor sleep mode. - Setting of 9 would be useful if you only had a small magnet and are not concerned about Pinecil falsely triggering sleep mode near items like magnetized screwdrivers. - - Neodymium magnets are recommended. If using small magnets, multiple may be required, but too many can also be detrimental - watch the Debug hall number. - - The Debug Hall number can guide you to the best locations for the magnets & whether you have too many or too few [debug menu](/Documentation/DebugMenu.md). + - Neodymium magnets are recommended. If using small magnets, multiple may be required, but too many can also be detrimental. Actively watch the Debug hall number while you slowly move the magnet around as it can guide you to the best locations & whether you have too many or too few magnets [debug menu](/Documentation/DebugMenu.md). - The Hall Sensor is physically located near the copper contacts for the tip at the front of the handle. Reference [Schematics](https://files.pine64.org/doc/Pinecil/Pinecil_schematic_v1.0a_20201120.pdf) ### Idle shutdown From be2407d7925a6e425e75ecad9a49797a3d9acc53 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 12:16:06 -0800 Subject: [PATCH 16/81] Update GettingStarted.md --- Documentation/GettingStarted.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/GettingStarted.md b/Documentation/GettingStarted.md index 0dc8f668..06fac834 100644 --- a/Documentation/GettingStarted.md +++ b/Documentation/GettingStarted.md @@ -63,7 +63,7 @@ Pinecil has an unpopulated footprint (U14) for a hall effect sensor (Si7210). Pi - 9 = high sensitivity to small magnets ... 1 = low sensitivity. - Setting of 1 might be used by someone who solders on PCBs with magnets and does not wish Pinecil to auto-sleep constantly. They would also need to use a very strong/large neomydium magnet on the stand to activate the sensor sleep mode. - Setting of 9 would be useful if you only had a small magnet and are not concerned about Pinecil falsely triggering sleep mode near items like magnetized screwdrivers. - - Neodymium magnets are recommended. If using small magnets, multiple may be required, but too many can also be detrimental. Actively watch the Debug hall number while you slowly move the magnet around as it can guide you to the best locations & whether you have too many or too few magnets [debug menu](/Documentation/DebugMenu.md). + - Neodymium magnets are recommended. If using small magnets, multiple may be required, but too many can also be detrimental. Actively watch the changing hall number (in debug menu) while you slowly move the magnet around to seek the best locations & whether you have too many or too few magnets [debug menu](/Documentation/DebugMenu.md). Higher hall number is best. - The Hall Sensor is physically located near the copper contacts for the tip at the front of the handle. Reference [Schematics](https://files.pine64.org/doc/Pinecil/Pinecil_schematic_v1.0a_20201120.pdf) ### Idle shutdown From 4bb1afc0a5bfba1a1c15fb1dadfe17b576d1939e Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 12:16:56 -0800 Subject: [PATCH 17/81] Update GettingStarted.md --- Documentation/GettingStarted.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/GettingStarted.md b/Documentation/GettingStarted.md index 06fac834..63c4d8e4 100644 --- a/Documentation/GettingStarted.md +++ b/Documentation/GettingStarted.md @@ -62,7 +62,7 @@ Optional Hall Effect Feature on Pinecil Only: Pinecil has an unpopulated footprint (U14) for a hall effect sensor (Si7210). Pinecil will sleep after it enters the stand and ZZzz will appear on the screen. After installing the sensor, a magnet is positioned on the stand close enough to the sensor to activate one of 9 settings. - 9 = high sensitivity to small magnets ... 1 = low sensitivity. - Setting of 1 might be used by someone who solders on PCBs with magnets and does not wish Pinecil to auto-sleep constantly. They would also need to use a very strong/large neomydium magnet on the stand to activate the sensor sleep mode. - - Setting of 9 would be useful if you only had a small magnet and are not concerned about Pinecil falsely triggering sleep mode near items like magnetized screwdrivers. + - 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, multiple may be required, but too many can also be detrimental. Actively watch the changing hall number (in debug menu) while you slowly move the magnet around to seek the best locations & whether you have too many or too few magnets [debug menu](/Documentation/DebugMenu.md). Higher hall number is best. - The Hall Sensor is physically located near the copper contacts for the tip at the front of the handle. Reference [Schematics](https://files.pine64.org/doc/Pinecil/Pinecil_schematic_v1.0a_20201120.pdf) From c52862b1537b2f35a2090eba307666acfc673efe Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 12:17:31 -0800 Subject: [PATCH 18/81] Update GettingStarted.md --- Documentation/GettingStarted.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/GettingStarted.md b/Documentation/GettingStarted.md index 63c4d8e4..059e3f30 100644 --- a/Documentation/GettingStarted.md +++ b/Documentation/GettingStarted.md @@ -60,7 +60,7 @@ Simply picking up or moving the iron will wake it back up into soldering mode. Y Optional Hall Effect Feature on Pinecil Only: Pinecil has an unpopulated footprint (U14) for a hall effect sensor (Si7210). Pinecil will sleep after it enters the stand and ZZzz will appear on the screen. After installing the sensor, a magnet is positioned on the stand close enough to the sensor to activate one of 9 settings. - - 9 = high sensitivity to small magnets ... 1 = low sensitivity. + - 9 = high sensitivity to small magnets ... 1 = low sensitivity. - Setting of 1 might be used by someone who solders on PCBs with magnets and does not wish Pinecil to auto-sleep constantly. They would also need to use a very strong/large neomydium magnet on the stand to activate the sensor sleep mode. - 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, multiple may be required, but too many can also be detrimental. Actively watch the changing hall number (in debug menu) while you slowly move the magnet around to seek the best locations & whether you have too many or too few magnets [debug menu](/Documentation/DebugMenu.md). Higher hall number is best. From d4cefa3952b01a3dab622f5eb515a563fd8f448a Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 12:34:07 -0800 Subject: [PATCH 19/81] Update GettingStarted.md --- Documentation/GettingStarted.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/Documentation/GettingStarted.md b/Documentation/GettingStarted.md index 059e3f30..25f8405d 100644 --- a/Documentation/GettingStarted.md +++ b/Documentation/GettingStarted.md @@ -60,10 +60,11 @@ Simply picking up or moving the iron will wake it back up into soldering mode. Y Optional Hall Effect Feature on Pinecil Only: Pinecil has an unpopulated footprint (U14) for a hall effect sensor (Si7210). Pinecil will sleep after it enters the stand and ZZzz will appear on the screen. After installing the sensor, a magnet is positioned on the stand close enough to the sensor to activate one of 9 settings. - - 9 = high sensitivity to small magnets ... 1 = low sensitivity. + - 0 = off, 1=1000, 2=750, 3=500, 4=250, 5=150, 6=100, 7=75, 8=50, 9=25 (9 is most sensitive to magnets) - Setting of 1 might be used by someone who solders on PCBs with magnets and does not wish Pinecil to auto-sleep constantly. They would also need to use a very strong/large neomydium magnet on the stand to activate the sensor sleep mode. - 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, multiple may be required, but too many can also be detrimental. Actively watch the changing hall number (in debug menu) while you slowly move the magnet around to seek the best locations & whether you have too many or too few magnets [debug menu](/Documentation/DebugMenu.md). Higher hall number is best. + - Neodymium magnets are recommended. If using small magnets, multiple may be required, but too many can also be detrimental. + - Actively watch the changing hall number (in debug menu) while you slowly move the magnet around to seek the best locations & whether you have too many or too few magnets [debug menu](/Documentation/DebugMenu.md). Positioning the magnet where you have the highest hall number will ensure consistent sleep mode when you place the iron in the stand. - The Hall Sensor is physically located near the copper contacts for the tip at the front of the handle. Reference [Schematics](https://files.pine64.org/doc/Pinecil/Pinecil_schematic_v1.0a_20201120.pdf) ### Idle shutdown From 1ecac417b0db3caa78a4a22c3c44ded087d15ad3 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 12:39:35 -0800 Subject: [PATCH 20/81] Update GettingStarted.md --- Documentation/GettingStarted.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/Documentation/GettingStarted.md b/Documentation/GettingStarted.md index 25f8405d..b3dda0b7 100644 --- a/Documentation/GettingStarted.md +++ b/Documentation/GettingStarted.md @@ -59,12 +59,12 @@ In Sleep mode, the temperature of the iron automatically lowers to a temperature Simply picking up or moving the iron will wake it back up into soldering mode. You can also press any button and this will also wake the iron up. Optional Hall Effect Feature on Pinecil Only: -Pinecil has an unpopulated footprint (U14) for a hall effect sensor (Si7210). Pinecil will sleep after it enters the stand and ZZzz will appear on the screen. After installing the sensor, a magnet is positioned on the stand close enough to the sensor to activate one of 9 settings. - - 0 = off, 1=1000, 2=750, 3=500, 4=250, 5=150, 6=100, 7=75, 8=50, 9=25 (9 is most sensitive to magnets) - - Setting of 1 might be used by someone who solders on PCBs with magnets and does not wish Pinecil to auto-sleep constantly. They would also need to use a very strong/large neomydium magnet on the stand to activate the sensor sleep mode. +Pinecil has an unpopulated footprint (U14) for a hall effect sensor (Si7210). Pinecil will sleep after it enters the stand and ZZzz will appear on the screen. After installing the sensor, a magnet is positioned on the stand close enough to the sensor to activate one of 9 sensitivities. + - 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 you would also need to use a very strong/large neomydium magnet on the stand to activate the sensor sleep mode. - 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, multiple may be required, but too many can also be detrimental. - - Actively watch the changing hall number (in debug menu) while you slowly move the magnet around to seek the best locations & whether you have too many or too few magnets [debug menu](/Documentation/DebugMenu.md). Positioning the magnet where you have the highest hall number will ensure consistent sleep mode when you place the iron in the stand. + - Neodymium magnets are recommended. If using small magnets, multiple may be required, but too many can also be detrimental because it deforms the shape of the field away from the sensor. + - Actively watch the changing hall number (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. - The Hall Sensor is physically located near the copper contacts for the tip at the front of the handle. Reference [Schematics](https://files.pine64.org/doc/Pinecil/Pinecil_schematic_v1.0a_20201120.pdf) ### Idle shutdown From 4277758db793b4192152fd4d13fdbca4baec10d1 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 12:42:26 -0800 Subject: [PATCH 21/81] Update GettingStarted.md --- Documentation/GettingStarted.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/GettingStarted.md b/Documentation/GettingStarted.md index b3dda0b7..a28fee1e 100644 --- a/Documentation/GettingStarted.md +++ b/Documentation/GettingStarted.md @@ -65,7 +65,7 @@ Pinecil has an unpopulated footprint (U14) for a hall effect sensor (Si7210). Pi - 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, multiple may be required, but too many can also be detrimental because it deforms the shape of the field away from the sensor. - Actively watch the changing hall number (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. - - The Hall Sensor is physically located near the copper contacts for the tip at the front of the handle. Reference [Schematics](https://files.pine64.org/doc/Pinecil/Pinecil_schematic_v1.0a_20201120.pdf) + - The Hall 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) ### Idle shutdown From ec094e7720d638dfb7cc84f9507b040eb830099e Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 12:42:51 -0800 Subject: [PATCH 22/81] Update GettingStarted.md --- Documentation/GettingStarted.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/GettingStarted.md b/Documentation/GettingStarted.md index a28fee1e..8e362e93 100644 --- a/Documentation/GettingStarted.md +++ b/Documentation/GettingStarted.md @@ -65,7 +65,7 @@ Pinecil has an unpopulated footprint (U14) for a hall effect sensor (Si7210). Pi - 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, multiple may be required, but too many can also be detrimental because it deforms the shape of the field away from the sensor. - Actively watch the changing hall number (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. - - The Hall 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) + - The Hall 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). ### Idle shutdown From 4d5cc80d105a7b19ae9ac9eafb8154e24f4fc7e6 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 12:51:40 -0800 Subject: [PATCH 23/81] Update Logo.md --- Documentation/Logo.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Documentation/Logo.md b/Documentation/Logo.md index 52af863d..d16ca5d9 100644 --- a/Documentation/Logo.md +++ b/Documentation/Logo.md @@ -28,10 +28,10 @@ You perform this the same way as if you were flashing a new firmware, and all of ### Pinecil -For the Pinecil, we require to flash the logo using dfu-util instead. -To flash the logo, use the following steps: +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. - `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. \ No newline at end of file + The converter will create a DFU instead of a HEX file if the .dfu extension is used. From 1a115a520c2bb95c85c0fae2a1d09fdf71aca800 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 12:53:22 -0800 Subject: [PATCH 24/81] Create Hall Sensor.md --- Documentation/Hall Sensor.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 Documentation/Hall Sensor.md diff --git a/Documentation/Hall Sensor.md b/Documentation/Hall Sensor.md new file mode 100644 index 00000000..8b137891 --- /dev/null +++ b/Documentation/Hall Sensor.md @@ -0,0 +1 @@ + From b333768166fa7373ad56a9276fbd9c054b9f7ff2 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 12:53:48 -0800 Subject: [PATCH 25/81] Rename Hall Sensor.md to HallSensor.md --- Documentation/{Hall Sensor.md => HallSensor.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename Documentation/{Hall Sensor.md => HallSensor.md} (100%) diff --git a/Documentation/Hall Sensor.md b/Documentation/HallSensor.md similarity index 100% rename from Documentation/Hall Sensor.md rename to Documentation/HallSensor.md From da56233b37b963dab26fc62cb05f6c3201a14ad6 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 13:02:06 -0800 Subject: [PATCH 26/81] Update HallSensor.md --- Documentation/HallSensor.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/Documentation/HallSensor.md b/Documentation/HallSensor.md index 8b137891..969a3359 100644 --- a/Documentation/HallSensor.md +++ b/Documentation/HallSensor.md @@ -1 +1,18 @@ +# Hall Effect Sensor + +### Sleep Mode Menu + +In Sleep mode, the temperature of the iron automatically lowers to a temperature just below the melting point of the solder. This helps reduce the rate of oxidation and damage to the iron tip. In general, when you are not using the iron, turn it off or let it sleep to increase durability of the replaceable tips. The default sleep mode temperature can also be customized. + +Simply picking up or moving the iron will wake it back up into soldering mode. You can also press any button and this will also wake the iron up. + +####Optional Hall Effect Feature on Pinecil Only: + +Pinecil has an unpopulated footprint (U14) for a hall effect sensor (Si7210). Pinecil will sleep after it enters the stand and ZZzz will appear on the screen. After installing the sensor, a magnet is positioned on the stand close enough to the sensor to activate one of 9 sensitivities. + - 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 you would also need to use a very strong/large neomydium magnet on the stand to activate the sensor sleep mode. + - 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, multiple may be required, but too many can also be detrimental because it deforms the shape of the field away from the sensor. + - Actively watch the changing hall number (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. + - The Hall 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). From 7899b3aee1d476f77f75ea6ad3774b54b9c4429e Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 13:07:13 -0800 Subject: [PATCH 27/81] 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 969a3359..9850a013 100644 --- a/Documentation/HallSensor.md +++ b/Documentation/HallSensor.md @@ -1,12 +1,12 @@ # Hall Effect Sensor -### Sleep Mode Menu +## Sleep Mode Menu In Sleep mode, the temperature of the iron automatically lowers to a temperature just below the melting point of the solder. This helps reduce the rate of oxidation and damage to the iron tip. In general, when you are not using the iron, turn it off or let it sleep to increase durability of the replaceable tips. The default sleep mode temperature can also be customized. Simply picking up or moving the iron will wake it back up into soldering mode. You can also press any button and this will also wake the iron up. -####Optional Hall Effect Feature on Pinecil Only: +###Optional Hall Effect Feature on Pinecil Only: Pinecil has an unpopulated footprint (U14) for a hall effect sensor (Si7210). Pinecil will sleep after it enters the stand and ZZzz will appear on the screen. After installing the sensor, a magnet is positioned on the stand close enough to the sensor to activate one of 9 sensitivities. - 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) From 9b27da57f0f8e31aabcbb73d2c109096e1947cf6 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 17:22:52 -0800 Subject: [PATCH 28/81] Update HallSensor.md --- Documentation/HallSensor.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/Documentation/HallSensor.md b/Documentation/HallSensor.md index 9850a013..645f2ec6 100644 --- a/Documentation/HallSensor.md +++ b/Documentation/HallSensor.md @@ -2,17 +2,19 @@ ## Sleep Mode Menu -In Sleep mode, the temperature of the iron automatically lowers to a temperature just below the melting point of the solder. This helps reduce the rate of oxidation and damage to the iron tip. In general, when you are not using the iron, turn it off or let it sleep to increase durability of the replaceable tips. The default sleep mode temperature can also be customized. +In Sleep mode, the temperature of the iron automatically lowers to 150C (default), which is just below the melting point of the solder. This helps reduce rate of oxidation and damage to the iron tip. In general, when not using the iron, unplug it or let it sleep to increase the longevity of replaceable tips. The default sleep temperature can be customized. -Simply picking up or moving the iron will wake it back up into soldering mode. You can also press any button and this will also wake the iron up. +Simply moving the iron will wake it back up into soldering mode. You can also press any button and this will also wake-up the iron. ###Optional Hall Effect Feature on Pinecil Only: -Pinecil has an unpopulated footprint (U14) for a hall effect sensor (Si7210). Pinecil will sleep after it enters the stand and ZZzz will appear on the screen. After installing the sensor, a magnet is positioned on the stand close enough to the sensor to activate one of 9 sensitivities. +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 nine 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 you would also need to use a very strong/large neomydium magnet 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. And a very strong/large magnet would be required on the stand to activate the sensor sleep mode. - 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, multiple may be required, but too many can also be detrimental because it deforms the shape of the field away from the sensor. - - Actively watch the changing hall number (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. - - The Hall 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). + - 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 breaks the effect by distorting the magnetic field (https://www.youtube.com/shorts/afkqKwCX00I). + - 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). From 0a066d58ce8c4bf1daa5a611f60fb86d9f1e47ac Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 17:23:30 -0800 Subject: [PATCH 29/81] Update HallSensor.md --- Documentation/HallSensor.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/HallSensor.md b/Documentation/HallSensor.md index 645f2ec6..55420546 100644 --- a/Documentation/HallSensor.md +++ b/Documentation/HallSensor.md @@ -6,7 +6,7 @@ In Sleep mode, the temperature of the iron automatically lowers to 150C (default Simply moving the iron will wake it back up into soldering mode. You can also press any button and this will also wake-up the iron. -###Optional Hall Effect Feature on Pinecil Only: +### Optional Hall Effect Feature on Pinecil Only: 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 nine 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) From 3b3fd0fc87659e61a8626a44abd10f47b5bcbede Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 17:23:41 -0800 Subject: [PATCH 30/81] Update HallSensor.md --- Documentation/HallSensor.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/HallSensor.md b/Documentation/HallSensor.md index 55420546..071c5cc7 100644 --- a/Documentation/HallSensor.md +++ b/Documentation/HallSensor.md @@ -6,7 +6,7 @@ In Sleep mode, the temperature of the iron automatically lowers to 150C (default Simply moving the iron will wake it back up into soldering mode. You can also press any button and this will also wake-up the iron. -### Optional Hall Effect Feature on Pinecil Only: +## Optional Hall Effect Feature on Pinecil Only: 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 nine 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) From e1279957a2f3069e59dff59f447428204d1f8916 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 17:23:52 -0800 Subject: [PATCH 31/81] Update HallSensor.md --- Documentation/HallSensor.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/HallSensor.md b/Documentation/HallSensor.md index 071c5cc7..b0953063 100644 --- a/Documentation/HallSensor.md +++ b/Documentation/HallSensor.md @@ -6,7 +6,7 @@ In Sleep mode, the temperature of the iron automatically lowers to 150C (default Simply moving the iron will wake it back up into soldering mode. You can also press any button and this will also wake-up the iron. -## Optional Hall Effect Feature on Pinecil Only: +# Optional Hall Effect Feature on Pinecil Only: 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 nine 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) From c238acc2675ee17d0860173dd526624858a14943 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 17:24:02 -0800 Subject: [PATCH 32/81] Update HallSensor.md --- Documentation/HallSensor.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/HallSensor.md b/Documentation/HallSensor.md index b0953063..55420546 100644 --- a/Documentation/HallSensor.md +++ b/Documentation/HallSensor.md @@ -6,7 +6,7 @@ In Sleep mode, the temperature of the iron automatically lowers to 150C (default Simply moving the iron will wake it back up into soldering mode. You can also press any button and this will also wake-up the iron. -# Optional Hall Effect Feature on Pinecil Only: +### Optional Hall Effect Feature on Pinecil Only: 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 nine 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) From 90e369d9ca3a9edf6777acc090b995250c279617 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 17:24:23 -0800 Subject: [PATCH 33/81] Update HallSensor.md --- Documentation/HallSensor.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/HallSensor.md b/Documentation/HallSensor.md index 55420546..855e5dd2 100644 --- a/Documentation/HallSensor.md +++ b/Documentation/HallSensor.md @@ -6,7 +6,7 @@ In Sleep mode, the temperature of the iron automatically lowers to 150C (default Simply moving the iron will wake it back up into soldering mode. You can also press any button and this will also wake-up the iron. -### Optional Hall Effect Feature on Pinecil Only: +### Optional Hall Effect Feature (Pinecil only): 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 nine 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) From 4b2df71394b6f16ecaf4bbcaf885018aca1d48f9 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 17:32:10 -0800 Subject: [PATCH 34/81] Update GettingStarted.md --- Documentation/GettingStarted.md | 17 ++++++----------- 1 file changed, 6 insertions(+), 11 deletions(-) diff --git a/Documentation/GettingStarted.md b/Documentation/GettingStarted.md index 8e362e93..b837fd98 100644 --- a/Documentation/GettingStarted.md +++ b/Documentation/GettingStarted.md @@ -50,24 +50,19 @@ Pressing and holding the rear button will exit soldering mode and land you back Pressing and holding **both** buttons at once will enter locked mode, which will prevent the buttons from doing anything. You can in the settings allow boost mode in locked mode optionally. This can be useful if you find yourself hitting the buttons and entering into the temperature adjustment screen by accident. -### Idle sleep +### Idle Sleep If the iron detects a period of time without any significant movement, it will enter sleep mode. This is indicated with a screen graphic similar to ZZzz (or text in detailed mode). -In Sleep mode, the temperature of the iron automatically lowers to a temperature just below the melting point of the solder. This helps reduce the rate of oxidation and damage to the iron tip. In general, when you are not using the iron, turn it off or let it sleep to increase durability of the replaceable tips. +In Sleep mode, the temperature of the iron automatically lowers to 150C (default), which is just below the melting point of the solder. This helps reduce rate of oxidation and damage to the iron tip. In general, when not using the iron, unplug it or let it sleep to increase the longevity of replaceable tips. The default sleep temperature can be customized. Simply picking up or moving the iron will wake it back up into soldering mode. You can also press any button and this will also wake the iron up. -Optional Hall Effect Feature on Pinecil Only: -Pinecil has an unpopulated footprint (U14) for a hall effect sensor (Si7210). Pinecil will sleep after it enters the stand and ZZzz will appear on the screen. After installing the sensor, a magnet is positioned on the stand close enough to the sensor to activate one of 9 sensitivities. - - 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 you would also need to use a very strong/large neomydium magnet on the stand to activate the sensor sleep mode. - - 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, multiple may be required, but too many can also be detrimental because it deforms the shape of the field away from the sensor. - - Actively watch the changing hall number (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. - - The Hall 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). +Optional Hall Effect Feature (Pinecil only): +Pinecil has an unpopulated footprint (U14) for a hall effect sensor (Si7210). Adding the sensor and placing a strong magnet on the holder stand will trigger Pinecil to sleep after it enters the stand, and ZZzz will appear on the screen. The magnet is positioned on the stand in proximity to the sensor which then activates one of ten user defined settings. -### Idle shutdown + +### Idle Shutdown If, after entering sleep mode, the iron still does not see movement for a much longer time; it will shut down and return to the home screen (default = 10 minutes). From a0e621630a57819e64c58e3276676e908cbc8e5e Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 17:34:49 -0800 Subject: [PATCH 35/81] Update GettingStarted.md --- Documentation/GettingStarted.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/GettingStarted.md b/Documentation/GettingStarted.md index b837fd98..a32bf1ee 100644 --- a/Documentation/GettingStarted.md +++ b/Documentation/GettingStarted.md @@ -59,7 +59,7 @@ In Sleep mode, the temperature of the iron automatically lowers to 150C (default Simply picking up or moving the iron will wake it back up into soldering mode. You can also press any button and this will also wake the iron up. Optional Hall Effect Feature (Pinecil only): -Pinecil has an unpopulated footprint (U14) for a hall effect sensor (Si7210). Adding the sensor and placing a strong magnet on the holder stand will trigger Pinecil to sleep after it enters the stand, and ZZzz will appear on the screen. The magnet is positioned on the stand in proximity to the sensor which then activates one of ten user defined settings. +Pinecil has an unpopulated footprint (U14) for a hall effect sensor (Si7210). Adding the sensor and placing a strong magnet on the holder stand will trigger Pinecil to sleep after it enters the stand, and ZZzz will appear on the screen. The magnet is positioned in proximity to the sensor which then activates one of 10 user defined settings (0=off, 1= lowest sensitivity, 9= highest sensitivity). Read Hall Sensor document for detail on installation. ### Idle Shutdown From ee9998ee649e2a54f2e71a2849c4f34b863a20ca Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 17:37:12 -0800 Subject: [PATCH 36/81] Update GettingStarted.md --- Documentation/GettingStarted.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/GettingStarted.md b/Documentation/GettingStarted.md index a32bf1ee..4f85220e 100644 --- a/Documentation/GettingStarted.md +++ b/Documentation/GettingStarted.md @@ -59,7 +59,7 @@ In Sleep mode, the temperature of the iron automatically lowers to 150C (default Simply picking up or moving the iron will wake it back up into soldering mode. You can also press any button and this will also wake the iron up. Optional Hall Effect Feature (Pinecil only): -Pinecil has an unpopulated footprint (U14) for a hall effect sensor (Si7210). Adding the sensor and placing a strong magnet on the holder stand will trigger Pinecil to sleep after it enters the stand, and ZZzz will appear on the screen. The magnet is positioned in proximity to the sensor which then activates one of 10 user defined settings (0=off, 1= lowest sensitivity, 9= highest sensitivity). Read Hall Sensor document for detail on installation. +Pinecil has an unpopulated footprint (U14) for a hall effect sensor (Si7210). Adding the sensor and placing a strong magnet on the holder stand will trigger Pinecil to sleep after it enters the stand, and ZZzz will appear on the screen. The magnet is positioned in proximity to the sensor which then activates one of 10 user defined settings (0=off, 1= lowest sensitivity, 9= highest sensitivity). Read the Hall Sensor document for details on [installation](/Documentation/HallSensor.md). ### Idle Shutdown From 6ba40cef3d1f3c9c66ca3ef176bd7adc3302bc03 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 17:39:00 -0800 Subject: [PATCH 37/81] Update GettingStarted.md --- Documentation/GettingStarted.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/GettingStarted.md b/Documentation/GettingStarted.md index 4f85220e..e1e6bf33 100644 --- a/Documentation/GettingStarted.md +++ b/Documentation/GettingStarted.md @@ -59,7 +59,7 @@ In Sleep mode, the temperature of the iron automatically lowers to 150C (default Simply picking up or moving the iron will wake it back up into soldering mode. You can also press any button and this will also wake the iron up. Optional Hall Effect Feature (Pinecil only): -Pinecil has an unpopulated footprint (U14) for a hall effect sensor (Si7210). Adding the sensor and placing a strong magnet on the holder stand will trigger Pinecil to sleep after it enters the stand, and ZZzz will appear on the screen. The magnet is positioned in proximity to the sensor which then activates one of 10 user defined settings (0=off, 1= lowest sensitivity, 9= highest sensitivity). Read the Hall Sensor document for details on [installation](/Documentation/HallSensor.md). +Pinecil has an unpopulated footprint (U14) for a hall effect sensor (Si7210). Adding the sensor and placing a strong magnet on the holder stand will trigger Pinecil to sleep after it enters the stand, and ZZzz will appear on the screen. The magnet is positioned on the stand in proximity to the sensor which then activates one of 10 user defined settings (0=off, 1= lowest sensitivity, 9= highest sensitivity). Read the Hall Sensor document for details on [installation](/Documentation/HallSensor.md). ### Idle Shutdown From a9a6bcbc992d35b4b8c183883897ca093204ecfe Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 17:42:17 -0800 Subject: [PATCH 38/81] Update GettingStarted.md --- Documentation/GettingStarted.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Documentation/GettingStarted.md b/Documentation/GettingStarted.md index e1e6bf33..a8a93001 100644 --- a/Documentation/GettingStarted.md +++ b/Documentation/GettingStarted.md @@ -64,7 +64,8 @@ Pinecil has an unpopulated footprint (U14) for a hall effect sensor (Si7210). Ad ### Idle Shutdown -If, after entering sleep mode, the iron still does not see movement for a much longer time; it will shut down and return to the home screen (default = 10 minutes). +If, after entering sleep mode, the iron still does not see movement for a much longer time (default = 10 min.); it will shut down and return to the home screen. + ## Settings Menu From 72441921c2fc620356249bdf49287b6301cbd9a8 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 17:44:10 -0800 Subject: [PATCH 39/81] Update HallSensor.md --- Documentation/HallSensor.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/HallSensor.md b/Documentation/HallSensor.md index 855e5dd2..64f1d545 100644 --- a/Documentation/HallSensor.md +++ b/Documentation/HallSensor.md @@ -15,6 +15,6 @@ Inside the Sleep Menu is an additional type of sleep setting. Pinecil has an unp - 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 breaks the effect by distorting the magnetic field (https://www.youtube.com/shorts/afkqKwCX00I). + - 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. - 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). From 652c2147a0e2cc6a8c94a637621a803ed5a8d5dd Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 18:45:53 -0800 Subject: [PATCH 40/81] Update HallSensor.md --- Documentation/HallSensor.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/HallSensor.md b/Documentation/HallSensor.md index 64f1d545..723f7de1 100644 --- a/Documentation/HallSensor.md +++ b/Documentation/HallSensor.md @@ -8,7 +8,7 @@ Simply moving the iron will wake it back up into soldering mode. You can also pr ### Optional Hall Effect Feature (Pinecil only): -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 nine user selectable settings. +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 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. From d3fd506156d7de9871f15764f857a5a3917020e1 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 19:54:02 -0800 Subject: [PATCH 41/81] Update DebugMenu.md --- Documentation/DebugMenu.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/DebugMenu.md b/Documentation/DebugMenu.md index a0675ced..7e484267 100644 --- a/Documentation/DebugMenu.md +++ b/Documentation/DebugMenu.md @@ -74,7 +74,7 @@ This may change during power up as the sources are negotiated in turn. - **PD W. VBus** input (We used the PD subsystem to negotiate for the current supply); and VBus is connected to your input power source - **PD No VBus** input (We used the PD subsystem to negotiate for the current supply); and VBus is **NOT** connected to your input power source - If you successfully modified the Pinecil to support 24V by cutting the trace line to Vbus, then 'PD No VBus' displays on screen. -- Connect to any PD USB power to check Vbus status, it will not show message when Pinecil is powered by DC port. +- Connect to any PD USB power to check Vbus status. It will not show any PD message when Pinecil is powered by DC port, QC, or USB 5V (non PD). ### Max From 645324af836d191ef66cf7cc8adf6b920e432057 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 21:43:11 -0800 Subject: [PATCH 42/81] Update Flashing.md --- Documentation/Flashing.md | 75 +++++++++++++++++++++++++-------------- 1 file changed, 49 insertions(+), 26 deletions(-) diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md index 3a32cc86..448b4193 100644 --- a/Documentation/Flashing.md +++ b/Documentation/Flashing.md @@ -90,59 +90,82 @@ Check the extension of your firmware, it should be `.RDY` now. The MCU used in the Pinecil supports usb-dfu. Reference Pine64 [Wiki](https://wiki.pine64.org/wiki/Pinecil). -There is the nice gui [Pinecil Firmware Updater](https://github.com/pine64/pinecil-firmware-updater/releases). It works in several types of OS, i.e. Windows/Mac. If your OS is not currently supported by the Updater or it does not meet your needs, the below manual process may be used to update the firmware. +It is recommended to use the [Pine64 Updater](https://github.com/pine64/pinecil-firmware-updater/releases). This GUI app is easy to use, works in several types of OS, i.e. Windows/Mac, and will automatically fetch the newest stable version of IronOS from Github. -To enter DFU mode, long hold the (-) button at the back of the iron, then connect to usb over usb-c. -Generally all usb controllers work, but some hubs have issues so avoiding hubs may be best. +If your OS is not currently supported by the [Updater](https://github.com/pine64/pinecil-firmware-updater/releases) or it does not meet your needs, the below manual method may be used. You will need to connect your Pinecil to a computer usinga USB cable. Generally all usb controllers work, but some hubs have issues so it is recommended to connect directly and avoid USB hubs. -Release the (-) button after ~10 seconds. The screen will stay **off/black** to indicate the Pinecil is in DFU mode. This is normal. -Then use the appropriate tool per you specific OS to load the `.dfu` file onto the Pinecil. + 1. Never have DC power plugged into Pinecil when you are updating firmware, only use a USB-C cable or you may destroy something. + 2. Download and extract the firmware package from Github [IronOS Releases](/Ralim/IronOS/releases) + 3. Enter DFU mode: hold down the (-) button at the back of the iron (do not release it). + 4. Connect USB to PC, and USB-C to back of Pinecil, keep holding (-) button down. + 5. The screen will stay **black/off** to indicate the Pinecil is in DFU mode. This is normal. + 6. Once USB cable is connected at two ends, wait additional 10 seconds, then release the (-) button. + 7. Then use the appropriate tool below per you specific OS to load the `.dfu` file onto the Pinecil. ### Linux and Mac -Using `dfu-util` you can flash the firmware using a command line as such: - + 8. Highly recommended to first update `dfu-util` to the newest version. + 9. Using `dfu-util` you can flash the firmware using a command line like this ``` dfu-util -D Pinecil_EN.dfu ``` +Type the file name from the folder with the appropriate 2-letter country code for your chosen language (i.e, EN = English). + +####Troubleshooting: If you get a message stating that `More than one DFU capable USB device found!` when running the above command you probably have an old version of `dfu-util` installed. Might be worth updating. You can still install on the old version, but you will have to specify which DFU interface to flash to. Running the command `dfu-util -l` will show you if there are several DFU devices detected. Example: ``` Found DFU: [28e9:0189] ver=0100, devnum=48, cfg=1, intf=0, path="1-1", alt=1, name="@Option Bytes /0x1FFFF800/01*016Be", serial="??" Found DFU: [28e9:0189] ver=0100, devnum=48, cfg=1, intf=0, path="1-1", alt=0, name="@Internal Flash /0x08000000/128*001Kg", serial="??" ``` -In this example we see that more than one part of the Pinecil is detected as a DFU interface and we need to specify which one we want to flash to. We want to the `Internal Flash` so in this case we can use `alt=0` to identify which interface to target. The command would then look like this: +In this example we see that more than one part of the Pinecil is detected as a DFU interface and we need to specify which one we want to flash to. We want the `Internal Flash` so in this case we can use `alt=0` to identify which interface to target. The command would then look like this: ``` dfu-util -D Pinecil_EN.dfu -a 0 ``` -Note that if you are using an older release of `dfu-util` and you do not see `alt=0, name="@Internal Flash /0x08000000/128*001Kg"` when running `dfu-util -l` you likely will not be able to update without updating `dfu-util`. +Note: if you are using an older release of `dfu-util` and you do not see `alt=0, name="@Internal Flash /0x08000000/128*001Kg"` when running `dfu-util -l` you likely will not be able to update without first updating `dfu-util`. ### Windows -For Windows there are two options, you can use dfu-util via command line as shown above. +For Windows there are two options: -If you are uncomfortable with the command line, the easiest tool to use is the vendors gui tool from [here](http://www.gd32mcu.com/en/download?kw=GD32+MCU+Dfu+Tool&lan=en). +####Option 1: use `dfu-util` via Command line as shown above for Linux/Mac. -Should the link break, its called "GD32 MCU Dfu Tool" and can be grabbed from http://www.gd32mcu.com/en/download/. + a. Open PowerShell or Command window. + b. Change to the directory of the unzipped firmware files + c. Execute this command +``` +dfu-util -D Pinecil_EN.dfu +``` + d. If you have errors, see Linux Troubleshooting above for solutions. -You will also need the matching drivers from [here](http://www.gd32mcu.com/en/download?kw=GD32+Dfu+Drivers&lan=en) installed if you have not used gigadevice parts before. -These are called "GD32 Dfu Drivers" if the link breaks. +####Option 2: if you are uncomfortable with the command line, the easiest tool to use is the chip vendors gui tool and drivers. -#### Steps: +Steps: -1. Download both the `GD32 MCU DFU TOOL` and the `Drivers`. -2. Install the drivers and open the DFU tool. -3. Ignore the prompt to update the tool. -4. While holding down the minus button, Connect the Pinecil to a Windows PC via USB cable. The **screen will stay blank** but you will hear the beep from Windows connecting to it. -5. At the top of the DFU tool, you should see `GD DFU DEVICE 1` appear. -6. Change the mode to `Download to device`. -7. Select the `open` button in that area of the window and load the `Pinecil_XX.hex` file from the downloaded release. -8. Tick the `verify after download` check box. -9. Click the OK button at the bottom of the window to run the process. -10. After it is complete either click `Leave DFU` or unplug the iron and power cycle it while _not_ holding down the buttons. +1. Complete Steps 1-7 from [above](/Documentation/Flashing.md#L97) +2. Download both the `GD32 MCU DFU TOOL` and the `GD32 Dfu Drivers`. + - [GD32 DFU](http://www.gd32mcu.com/en/download?kw=GD32+MCU+Dfu+Tool&lan=en). + - If the link breaks, search for "GD32 MCU Dfu Tool" at this [link](http://www.gd32mcu.com/en/download/). + - [GD32 DFU Drivers](http://www.gd32mcu.com/en/download?kw=GD32+Dfu+Drivers&lan=en) + - If the link breaks, search for "GD32 Dfu Drivers" at this [link](http://www.gd32mcu.com/en/download/). + - Check properties of both downloads, tick Unblock if needed, then Unzip +2. Install the drivers and Open the GD32 DFU tool. Ignore the prompt to update the tool. +3. While continuously holding down the minus (-) button, Connect the Pinecil to a Windows PC via USB cable (do not release the (-) yet). +4. . The **screen will stay black** and you will hear a beep from Windows as it connects to Pinecil in DFU mode. +5. . If you see windows notification that it does not recognize Usb device, then you didn't connect, repeat step 4 + -plug usb-c to pc first, then hold down (-) on pinecil & while holding down, then push usb-c into pinecil (keep holding the (-) button). + +6. At the top of the DFU tool, you should see `GD DFU DEVICE 1` appear if you successfully connected Pinecil. +7. Release the (-) button. +8. Select `Download to device` > open > browse to folder you unziped in step 2. (don't use Upload from Device section) +9. Select the hex file for language. English is Pinecil_EN.hex , tick `Verify after download`. +10. Click `OK` at bottom. After a few minutes you will see 0-100%, Download successfully! Click `Leave DFU` at the top. +11. Disconnect pinecil cable from computer, plug it into a power source. +12. Do not hold down any buttons, a new screen should appear. +13. To confirm upgrade, hold the minus (-) button down for a few seconds, it then shows new firmware version v2.xx.x....date -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. +Note: pc/laptop can not power pinecil, it generally only gets 5V (non-PD) there to communicate for firmware updates and Pinecil will report `DC Low` if you try. ### FAQ From e87c7dfc51adb7fd523978b94d97ba3b5c9ce5f7 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 21:47:03 -0800 Subject: [PATCH 43/81] Update GettingStarted.md --- Documentation/GettingStarted.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/GettingStarted.md b/Documentation/GettingStarted.md index a8a93001..8ecd2c75 100644 --- a/Documentation/GettingStarted.md +++ b/Documentation/GettingStarted.md @@ -44,7 +44,7 @@ When you press the button to enter the soldering mode, the iron will instantly s The firmware defaults to 320C as the set point for the soldering mode, however on this screen you can enter into the adjustment screen by pressing either button. -Pressing and holding the button near the tip will enter **boost** mode. This allows temporarily override of the set temperature to a higher (or lower) value. This can be useful as a way to force the tip to a higher temperature to drive more wattage into a large joint when the thermal connection is not ideal. +Pressing and holding the button near the tip will enter **Boost** mode. This allows a temporarily override of the set temperature to a higher (or lower) value. This can be useful as a way to force the tip to a higher temperature to drive more wattage into a large joint when the thermal connection is not ideal. Pressing and holding the rear button will exit soldering mode and land you back at the home screen. You can also do this by pressing both buttons at once and this will also work, this is a bit harder to do but is kept for compatibility with the Miniware firmware. From d4920d2039358b6bcd8f3b8d1cacf7fcc121eedf Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 21:48:48 -0800 Subject: [PATCH 44/81] Update GettingStarted.md --- Documentation/GettingStarted.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/GettingStarted.md b/Documentation/GettingStarted.md index 8ecd2c75..69657881 100644 --- a/Documentation/GettingStarted.md +++ b/Documentation/GettingStarted.md @@ -44,7 +44,7 @@ When you press the button to enter the soldering mode, the iron will instantly s The firmware defaults to 320C as the set point for the soldering mode, however on this screen you can enter into the adjustment screen by pressing either button. -Pressing and holding the button near the tip will enter **Boost** mode. This allows a temporarily override of the set temperature to a higher (or lower) value. This can be useful as a way to force the tip to a higher temperature to drive more wattage into a large joint when the thermal connection is not ideal. +Pressing and holding the button near the tip will enter **Boost** mode. This allows a temporary override of the set temperature to a higher (or lower) value. This can be useful as a way to force the tip to a higher temperature to drive more wattage into a large joint when the thermal connection is not ideal. Pressing and holding the rear button will exit soldering mode and land you back at the home screen. You can also do this by pressing both buttons at once and this will also work, this is a bit harder to do but is kept for compatibility with the Miniware firmware. From e9bcd165fa75ad265169b9fc371be73481c7f399 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 21:53:41 -0800 Subject: [PATCH 45/81] Update Flashing.md --- Documentation/Flashing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md index 448b4193..273e6d0a 100644 --- a/Documentation/Flashing.md +++ b/Documentation/Flashing.md @@ -88,7 +88,7 @@ Check the extension of your firmware, it should be `.RDY` now. ## Pinecil (Pine64) -The MCU used in the Pinecil supports usb-dfu. Reference Pine64 [Wiki](https://wiki.pine64.org/wiki/Pinecil). +The MCU used in the Pinecil supports usb-dfu. Reference [Pine64 Wiki](https://wiki.pine64.org/wiki/Pinecil). It is recommended to use the [Pine64 Updater](https://github.com/pine64/pinecil-firmware-updater/releases). This GUI app is easy to use, works in several types of OS, i.e. Windows/Mac, and will automatically fetch the newest stable version of IronOS from Github. From f9f5aa49cbe85ea0eaf7e59be88291f0937d5e1c Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 22:03:50 -0800 Subject: [PATCH 46/81] Update Flashing.md --- Documentation/Flashing.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md index 273e6d0a..36c6aedc 100644 --- a/Documentation/Flashing.md +++ b/Documentation/Flashing.md @@ -94,25 +94,27 @@ It is recommended to use the [Pine64 Updater](https://github.com/pine64/pinecil- If your OS is not currently supported by the [Updater](https://github.com/pine64/pinecil-firmware-updater/releases) or it does not meet your needs, the below manual method may be used. You will need to connect your Pinecil to a computer usinga USB cable. Generally all usb controllers work, but some hubs have issues so it is recommended to connect directly and avoid USB hubs. +### Steps + 1. Never have DC power plugged into Pinecil when you are updating firmware, only use a USB-C cable or you may destroy something. 2. Download and extract the firmware package from Github [IronOS Releases](/Ralim/IronOS/releases) 3. Enter DFU mode: hold down the (-) button at the back of the iron (do not release it). 4. Connect USB to PC, and USB-C to back of Pinecil, keep holding (-) button down. 5. The screen will stay **black/off** to indicate the Pinecil is in DFU mode. This is normal. 6. Once USB cable is connected at two ends, wait additional 10 seconds, then release the (-) button. - 7. Then use the appropriate tool below per you specific OS to load the `.dfu` file onto the Pinecil. + 7. Continue to the next section below for your specific OS to complete loading the `.dfu` file onto Pinecil. ### Linux and Mac - 8. Highly recommended to first update `dfu-util` to the newest version. - 9. Using `dfu-util` you can flash the firmware using a command line like this + 1. Highly recommended to first update `dfu-util` to the newest version. + 2. Using `dfu-util` you can flash the firmware using a command line like this ``` dfu-util -D Pinecil_EN.dfu ``` Type the file name from the folder with the appropriate 2-letter country code for your chosen language (i.e, EN = English). -####Troubleshooting: +#### Troubleshooting: If you get a message stating that `More than one DFU capable USB device found!` when running the above command you probably have an old version of `dfu-util` installed. Might be worth updating. You can still install on the old version, but you will have to specify which DFU interface to flash to. Running the command `dfu-util -l` will show you if there are several DFU devices detected. Example: ``` Found DFU: [28e9:0189] ver=0100, devnum=48, cfg=1, intf=0, path="1-1", alt=1, name="@Option Bytes /0x1FFFF800/01*016Be", serial="??" @@ -128,7 +130,7 @@ Note: if you are using an older release of `dfu-util` and you do not see `alt=0, For Windows there are two options: -####Option 1: use `dfu-util` via Command line as shown above for Linux/Mac. +#### Option 1: use `dfu-util` via Command line as shown above for Linux/Mac. a. Open PowerShell or Command window. b. Change to the directory of the unzipped firmware files @@ -139,7 +141,7 @@ dfu-util -D Pinecil_EN.dfu d. If you have errors, see Linux Troubleshooting above for solutions. -####Option 2: if you are uncomfortable with the command line, the easiest tool to use is the chip vendors gui tool and drivers. +#### Option 2: if you are uncomfortable with the command line, the easiest tool to use is the chip vendors gui tool and drivers. Steps: From 71c4a8760e0d21d6c7b99ebdd9c9571432243de2 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 22:05:54 -0800 Subject: [PATCH 47/81] Update Flashing.md --- Documentation/Flashing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md index 36c6aedc..0040913c 100644 --- a/Documentation/Flashing.md +++ b/Documentation/Flashing.md @@ -145,7 +145,7 @@ dfu-util -D Pinecil_EN.dfu Steps: -1. Complete Steps 1-7 from [above](/Documentation/Flashing.md#L97) +1. Complete Steps 1-7 from [above](https://github.com/Ralim/IronOS/blob/e9bcd165fa75ad265169b9fc371be73481c7f399/Documentation/Flashing.md#L97) 2. Download both the `GD32 MCU DFU TOOL` and the `GD32 Dfu Drivers`. - [GD32 DFU](http://www.gd32mcu.com/en/download?kw=GD32+MCU+Dfu+Tool&lan=en). - If the link breaks, search for "GD32 MCU Dfu Tool" at this [link](http://www.gd32mcu.com/en/download/). From 59b36c283113d6affb42d0990b68d72075a40653 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 22:10:14 -0800 Subject: [PATCH 48/81] Update Flashing.md --- Documentation/Flashing.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md index 0040913c..ee580ea2 100644 --- a/Documentation/Flashing.md +++ b/Documentation/Flashing.md @@ -132,13 +132,13 @@ For Windows there are two options: #### Option 1: use `dfu-util` via Command line as shown above for Linux/Mac. - a. Open PowerShell or Command window. - b. Change to the directory of the unzipped firmware files - c. Execute this command + - Open PowerShell or Command window. + - Change to the directory of the unzipped firmware files + - Execute this command ``` dfu-util -D Pinecil_EN.dfu ``` - d. If you have errors, see Linux Troubleshooting above for solutions. + - If you have errors, see Linux Troubleshooting above for solutions. #### Option 2: if you are uncomfortable with the command line, the easiest tool to use is the chip vendors gui tool and drivers. From 723b6874f4f11cbd030a5077adaa374710714c35 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 22:14:03 -0800 Subject: [PATCH 49/81] Update Flashing.md --- Documentation/Flashing.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md index ee580ea2..6150f5ce 100644 --- a/Documentation/Flashing.md +++ b/Documentation/Flashing.md @@ -147,9 +147,9 @@ Steps: 1. Complete Steps 1-7 from [above](https://github.com/Ralim/IronOS/blob/e9bcd165fa75ad265169b9fc371be73481c7f399/Documentation/Flashing.md#L97) 2. Download both the `GD32 MCU DFU TOOL` and the `GD32 Dfu Drivers`. - - [GD32 DFU](http://www.gd32mcu.com/en/download?kw=GD32+MCU+Dfu+Tool&lan=en). + - GD32 DFU Tool [here](http://www.gd32mcu.com/en/download?kw=GD32+MCU+Dfu+Tool&lan=en). - If the link breaks, search for "GD32 MCU Dfu Tool" at this [link](http://www.gd32mcu.com/en/download/). - - [GD32 DFU Drivers](http://www.gd32mcu.com/en/download?kw=GD32+Dfu+Drivers&lan=en) + - GD32 DFU Drivers [here](http://www.gd32mcu.com/en/download?kw=GD32+Dfu+Drivers&lan=en) - If the link breaks, search for "GD32 Dfu Drivers" at this [link](http://www.gd32mcu.com/en/download/). - Check properties of both downloads, tick Unblock if needed, then Unzip 2. Install the drivers and Open the GD32 DFU tool. Ignore the prompt to update the tool. From 2b2ecbfb5487a5470324c5970cf2cb80ffc342c9 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 22:16:08 -0800 Subject: [PATCH 50/81] Update Flashing.md --- Documentation/Flashing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md index 6150f5ce..ea11a4d0 100644 --- a/Documentation/Flashing.md +++ b/Documentation/Flashing.md @@ -97,7 +97,7 @@ If your OS is not currently supported by the [Updater](https://github.com/pine64 ### Steps 1. Never have DC power plugged into Pinecil when you are updating firmware, only use a USB-C cable or you may destroy something. - 2. Download and extract the firmware package from Github [IronOS Releases](/Ralim/IronOS/releases) + 2. Download and extract the firmware package from Github [IronOS Releases](https://github.com/Ralim/IronOS/releases) 3. Enter DFU mode: hold down the (-) button at the back of the iron (do not release it). 4. Connect USB to PC, and USB-C to back of Pinecil, keep holding (-) button down. 5. The screen will stay **black/off** to indicate the Pinecil is in DFU mode. This is normal. From 35db18f549a0e9ceb9a9211d6936d9203c95088b Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 22:52:14 -0800 Subject: [PATCH 51/81] Update Flashing.md --- Documentation/Flashing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md index ea11a4d0..a11fc0c3 100644 --- a/Documentation/Flashing.md +++ b/Documentation/Flashing.md @@ -145,7 +145,7 @@ dfu-util -D Pinecil_EN.dfu Steps: -1. Complete Steps 1-7 from [above](https://github.com/Ralim/IronOS/blob/e9bcd165fa75ad265169b9fc371be73481c7f399/Documentation/Flashing.md#L97) +1. Complete Steps 1-7 from [above](/Documentation/Flashing.md#steps) 2. Download both the `GD32 MCU DFU TOOL` and the `GD32 Dfu Drivers`. - GD32 DFU Tool [here](http://www.gd32mcu.com/en/download?kw=GD32+MCU+Dfu+Tool&lan=en). - If the link breaks, search for "GD32 MCU Dfu Tool" at this [link](http://www.gd32mcu.com/en/download/). From 236dbfb6d336f16826098644b15e32801214b807 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 22:56:03 -0800 Subject: [PATCH 52/81] Update Flashing.md --- Documentation/Flashing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md index a11fc0c3..0b8424a3 100644 --- a/Documentation/Flashing.md +++ b/Documentation/Flashing.md @@ -145,7 +145,7 @@ dfu-util -D Pinecil_EN.dfu Steps: -1. Complete Steps 1-7 from [above](/Documentation/Flashing.md#steps) +1. Complete Steps 1-7 from [above](/Documentation/Flashing.md#Steps). 2. Download both the `GD32 MCU DFU TOOL` and the `GD32 Dfu Drivers`. - GD32 DFU Tool [here](http://www.gd32mcu.com/en/download?kw=GD32+MCU+Dfu+Tool&lan=en). - If the link breaks, search for "GD32 MCU Dfu Tool" at this [link](http://www.gd32mcu.com/en/download/). From 4b5fdbeaf8c556d64a4eff0ae4536c0b11345d29 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 23:02:19 -0800 Subject: [PATCH 53/81] Update Flashing.md --- Documentation/Flashing.md | 1 + 1 file changed, 1 insertion(+) diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md index 0b8424a3..b2f0edc0 100644 --- a/Documentation/Flashing.md +++ b/Documentation/Flashing.md @@ -95,6 +95,7 @@ It is recommended to use the [Pine64 Updater](https://github.com/pine64/pinecil- If your OS is not currently supported by the [Updater](https://github.com/pine64/pinecil-firmware-updater/releases) or it does not meet your needs, the below manual method may be used. You will need to connect your Pinecil to a computer usinga USB cable. Generally all usb controllers work, but some hubs have issues so it is recommended to connect directly and avoid USB hubs. ### Steps +
Warning: Do not have a barrel jack PSU plugged in at the same time as a USB-C cable. Doing this will severely damage your computer, or Type-C PSU.
1. Never have DC power plugged into Pinecil when you are updating firmware, only use a USB-C cable or you may destroy something. 2. Download and extract the firmware package from Github [IronOS Releases](https://github.com/Ralim/IronOS/releases) From 733c7dcd4d21fdbeaeb2b815d50778b6dcf7ba73 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 23:07:57 -0800 Subject: [PATCH 54/81] Update Flashing.md --- Documentation/Flashing.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md index b2f0edc0..795e5da5 100644 --- a/Documentation/Flashing.md +++ b/Documentation/Flashing.md @@ -95,9 +95,10 @@ It is recommended to use the [Pine64 Updater](https://github.com/pine64/pinecil- If your OS is not currently supported by the [Updater](https://github.com/pine64/pinecil-firmware-updater/releases) or it does not meet your needs, the below manual method may be used. You will need to connect your Pinecil to a computer usinga USB cable. Generally all usb controllers work, but some hubs have issues so it is recommended to connect directly and avoid USB hubs. ### Steps +
Warning: Do not have a barrel jack PSU plugged in at the same time as a USB-C cable. Doing this will severely damage your computer, or Type-C PSU.
- 1. Never have DC power plugged into Pinecil when you are updating firmware, only use a USB-C cable or you may destroy something. + 1. :warning: Never have DC power plugged into Pinecil when you are updating firmware, only use a USB-C cable or you may destroy something. 2. Download and extract the firmware package from Github [IronOS Releases](https://github.com/Ralim/IronOS/releases) 3. Enter DFU mode: hold down the (-) button at the back of the iron (do not release it). 4. Connect USB to PC, and USB-C to back of Pinecil, keep holding (-) button down. From 792234250ad1c57d997c5c357ae2769ded5fd30e Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 23:15:42 -0800 Subject: [PATCH 55/81] Update Flashing.md --- Documentation/Flashing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md index 795e5da5..efe80b73 100644 --- a/Documentation/Flashing.md +++ b/Documentation/Flashing.md @@ -98,7 +98,7 @@ If your OS is not currently supported by the [Updater](https://github.com/pine64
Warning: Do not have a barrel jack PSU plugged in at the same time as a USB-C cable. Doing this will severely damage your computer, or Type-C PSU.
- 1. :warning: Never have DC power plugged into Pinecil when you are updating firmware, only use a USB-C cable or you may destroy something. + 1. ⚠️ Never have DC power plugged into Pinecil when you are updating firmware, only use a USB-C cable or you may destroy something. 2. Download and extract the firmware package from Github [IronOS Releases](https://github.com/Ralim/IronOS/releases) 3. Enter DFU mode: hold down the (-) button at the back of the iron (do not release it). 4. Connect USB to PC, and USB-C to back of Pinecil, keep holding (-) button down. From 4ed42c733fbfffb667410a7b991aa7cad0c64e50 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 23:18:36 -0800 Subject: [PATCH 56/81] Update Flashing.md --- Documentation/Flashing.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md index efe80b73..98f120e6 100644 --- a/Documentation/Flashing.md +++ b/Documentation/Flashing.md @@ -96,15 +96,13 @@ If your OS is not currently supported by the [Updater](https://github.com/pine64 ### Steps -
Warning: Do not have a barrel jack PSU plugged in at the same time as a USB-C cable. Doing this will severely damage your computer, or Type-C PSU.
- - 1. ⚠️ Never have DC power plugged into Pinecil when you are updating firmware, only use a USB-C cable or you may destroy something. - 2. Download and extract the firmware package from Github [IronOS Releases](https://github.com/Ralim/IronOS/releases) - 3. Enter DFU mode: hold down the (-) button at the back of the iron (do not release it). - 4. Connect USB to PC, and USB-C to back of Pinecil, keep holding (-) button down. - 5. The screen will stay **black/off** to indicate the Pinecil is in DFU mode. This is normal. - 6. Once USB cable is connected at two ends, wait additional 10 seconds, then release the (-) button. - 7. Continue to the next section below for your specific OS to complete loading the `.dfu` file onto Pinecil. +⚠️ 1.❗ Never have DC power plugged into Pinecil when you are updating firmware, only use a USB-C cable or you may destroy something. + 2. Download and extract the firmware package from Github [IronOS Releases](https://github.com/Ralim/IronOS/releases) + 3. Enter DFU mode: hold down the (-) button at the back of the iron (do not release it). + 4. Connect USB to PC, and USB-C to back of Pinecil, keep holding (-) button down. + 5. The screen will stay **black/off** to indicate the Pinecil is in DFU mode. This is normal. + 6. Once USB cable is connected at two ends, wait additional 10 seconds, then release the (-) button. + 7. Continue to the next section below for your specific OS to complete loading the `.dfu` file onto Pinecil. ### Linux and Mac From 1a039e065e430ce1956697515723627c32fcfaf1 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 23:38:53 -0800 Subject: [PATCH 57/81] Update Flashing.md --- Documentation/Flashing.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md index 98f120e6..9814c23d 100644 --- a/Documentation/Flashing.md +++ b/Documentation/Flashing.md @@ -95,8 +95,8 @@ It is recommended to use the [Pine64 Updater](https://github.com/pine64/pinecil- If your OS is not currently supported by the [Updater](https://github.com/pine64/pinecil-firmware-updater/releases) or it does not meet your needs, the below manual method may be used. You will need to connect your Pinecil to a computer usinga USB cable. Generally all usb controllers work, but some hubs have issues so it is recommended to connect directly and avoid USB hubs. ### Steps - -⚠️ 1.❗ Never have DC power plugged into Pinecil when you are updating firmware, only use a USB-C cable or you may destroy something. + + 1. :octagonal_sign: never have a DC barrel jack plugged into Pinecil when updating firmware, use only a USB-C cable or you may destroy your PC. 2. Download and extract the firmware package from Github [IronOS Releases](https://github.com/Ralim/IronOS/releases) 3. Enter DFU mode: hold down the (-) button at the back of the iron (do not release it). 4. Connect USB to PC, and USB-C to back of Pinecil, keep holding (-) button down. From c484e383ce3fef20c2cfc78f8c800e922b4f0599 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 23:52:29 -0800 Subject: [PATCH 58/81] Update Flashing.md --- Documentation/Flashing.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md index 9814c23d..1e61ea78 100644 --- a/Documentation/Flashing.md +++ b/Documentation/Flashing.md @@ -90,19 +90,19 @@ Check the extension of your firmware, it should be `.RDY` now. The MCU used in the Pinecil supports usb-dfu. Reference [Pine64 Wiki](https://wiki.pine64.org/wiki/Pinecil). -It is recommended to use the [Pine64 Updater](https://github.com/pine64/pinecil-firmware-updater/releases). This GUI app is easy to use, works in several types of OS, i.e. Windows/Mac, and will automatically fetch the newest stable version of IronOS from Github. +It is recommended to use the [Pine64 Updater](https://github.com/pine64/pinecil-firmware-updater/releases). This GUI app is easy to use, works in several types of OS, i.e. Windows/Mac, and will automatically fetch the newest stable version of IronOS from Github. One advantage to Pinecil is you can not permanently damage it doing a firmware update (because DFU is in ROM); an update could render Pinecil temporarily inoperable if you flash an invalid firmware. However, simply flashing a working firmware will fix everything. If your OS is not currently supported by the [Updater](https://github.com/pine64/pinecil-firmware-updater/releases) or it does not meet your needs, the below manual method may be used. You will need to connect your Pinecil to a computer usinga USB cable. Generally all usb controllers work, but some hubs have issues so it is recommended to connect directly and avoid USB hubs. ### Steps - - 1. :octagonal_sign: never have a DC barrel jack plugged into Pinecil when updating firmware, use only a USB-C cable or you may destroy your PC. - 2. Download and extract the firmware package from Github [IronOS Releases](https://github.com/Ralim/IronOS/releases) - 3. Enter DFU mode: hold down the (-) button at the back of the iron (do not release it). - 4. Connect USB to PC, and USB-C to back of Pinecil, keep holding (-) button down. - 5. The screen will stay **black/off** to indicate the Pinecil is in DFU mode. This is normal. - 6. Once USB cable is connected at two ends, wait additional 10 seconds, then release the (-) button. - 7. Continue to the next section below for your specific OS to complete loading the `.dfu` file onto Pinecil. + +1. 🚫 ⛔ Do not have a DC barrel jack plugged into Pinecil while updating firmware, use only a USB-C cable or you may destroy your PC. +2. Download and extract the firmware package from Github [IronOS Releases](https://github.com/Ralim/IronOS/releases) +3. Enter DFU mode: hold down the (-) button at the back of the iron (do not release it). +4. Connect USB to PC, and USB-C to back of Pinecil, keep holding (-) button down. +5. The screen will stay **black/off** to indicate the Pinecil is in DFU mode. This is normal. +6. Once USB cable is connected at two ends, wait additional 10 seconds, then release the (-) button. +7. Continue to the next section below for your specific OS to complete loading the `.dfu` file onto Pinecil. ### Linux and Mac From 32553ef44e845cce85fb9989ba957a74f6a8866b Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Fri, 11 Mar 2022 23:58:26 -0800 Subject: [PATCH 59/81] Update Flashing.md --- Documentation/Flashing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md index 1e61ea78..b4c29636 100644 --- a/Documentation/Flashing.md +++ b/Documentation/Flashing.md @@ -96,7 +96,7 @@ If your OS is not currently supported by the [Updater](https://github.com/pine64 ### Steps -1. 🚫 ⛔ Do not have a DC barrel jack plugged into Pinecil while updating firmware, use only a USB-C cable or you may destroy your PC. +1. ⛔ Do not have a DC barrel jack plugged into Pinecil while updating firmware, use only a USB-C cable or you may destroy your PC. 2. Download and extract the firmware package from Github [IronOS Releases](https://github.com/Ralim/IronOS/releases) 3. Enter DFU mode: hold down the (-) button at the back of the iron (do not release it). 4. Connect USB to PC, and USB-C to back of Pinecil, keep holding (-) button down. From 4107e18d27f2b766cb1849133187489e58ce2aff Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sat, 12 Mar 2022 00:09:28 -0800 Subject: [PATCH 60/81] Update Flashing.md --- Documentation/Flashing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md index b4c29636..262114fc 100644 --- a/Documentation/Flashing.md +++ b/Documentation/Flashing.md @@ -96,7 +96,7 @@ If your OS is not currently supported by the [Updater](https://github.com/pine64 ### Steps -1. ⛔ Do not have a DC barrel jack plugged into Pinecil while updating firmware, use only a USB-C cable or you may destroy your PC. +1. ⛔ Do not have a DC jack plugged into Pinecil while updating firmware. Only use a USB-C cable when updating or you may destroy your PC. 2. Download and extract the firmware package from Github [IronOS Releases](https://github.com/Ralim/IronOS/releases) 3. Enter DFU mode: hold down the (-) button at the back of the iron (do not release it). 4. Connect USB to PC, and USB-C to back of Pinecil, keep holding (-) button down. From 8f213bd26a05242ad14dff3f979cc1c29b2481cd Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sat, 12 Mar 2022 00:23:21 -0800 Subject: [PATCH 61/81] Update Flashing.md --- Documentation/Flashing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md index 262114fc..ff22fdd0 100644 --- a/Documentation/Flashing.md +++ b/Documentation/Flashing.md @@ -96,7 +96,7 @@ If your OS is not currently supported by the [Updater](https://github.com/pine64 ### Steps -1. ⛔ Do not have a DC jack plugged into Pinecil while updating firmware. Only use a USB-C cable when updating or you may destroy your PC. +⛔ Do not use the DC power jack while updating firmware or you may destroy your PC.⛔ 2. Download and extract the firmware package from Github [IronOS Releases](https://github.com/Ralim/IronOS/releases) 3. Enter DFU mode: hold down the (-) button at the back of the iron (do not release it). 4. Connect USB to PC, and USB-C to back of Pinecil, keep holding (-) button down. From ff240d9b25599f0cd960e7637d951f173760bcfa Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sat, 12 Mar 2022 00:25:41 -0800 Subject: [PATCH 62/81] Update Flashing.md --- Documentation/Flashing.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md index ff22fdd0..35ed1962 100644 --- a/Documentation/Flashing.md +++ b/Documentation/Flashing.md @@ -97,12 +97,13 @@ If your OS is not currently supported by the [Updater](https://github.com/pine64 ### Steps ⛔ Do not use the DC power jack while updating firmware or you may destroy your PC.⛔ -2. Download and extract the firmware package from Github [IronOS Releases](https://github.com/Ralim/IronOS/releases) -3. Enter DFU mode: hold down the (-) button at the back of the iron (do not release it). -4. Connect USB to PC, and USB-C to back of Pinecil, keep holding (-) button down. -5. The screen will stay **black/off** to indicate the Pinecil is in DFU mode. This is normal. -6. Once USB cable is connected at two ends, wait additional 10 seconds, then release the (-) button. -7. Continue to the next section below for your specific OS to complete loading the `.dfu` file onto Pinecil. + +1. Download and extract the firmware package from Github [IronOS Releases](https://github.com/Ralim/IronOS/releases). +2. Enter DFU mode: hold down the (-) button at the back of the iron (do not release it). +3. Connect USB to PC, and USB-C to back of Pinecil, keep holding (-) button down. +4. The screen will stay **black/off** to indicate the Pinecil is in DFU mode. This is normal. +5. Once USB cable is connected at two ends, wait additional 10 seconds, then release the (-) button. +6. Continue to the next section below for your specific OS to complete loading the `.dfu` file onto Pinecil. ### Linux and Mac From 1fbf48bbfe03ab1f4bc272011ec8b596e373bc58 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sat, 12 Mar 2022 00:37:19 -0800 Subject: [PATCH 63/81] Update Flashing.md --- Documentation/Flashing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md index 35ed1962..c900400a 100644 --- a/Documentation/Flashing.md +++ b/Documentation/Flashing.md @@ -99,7 +99,7 @@ If your OS is not currently supported by the [Updater](https://github.com/pine64 ⛔ Do not use the DC power jack while updating firmware or you may destroy your PC.⛔ 1. Download and extract the firmware package from Github [IronOS Releases](https://github.com/Ralim/IronOS/releases). -2. Enter DFU mode: hold down the (-) button at the back of the iron (do not release it). +2. Enter DFU mode: press and hold (-) button at the back of the iron (do not release). 3. Connect USB to PC, and USB-C to back of Pinecil, keep holding (-) button down. 4. The screen will stay **black/off** to indicate the Pinecil is in DFU mode. This is normal. 5. Once USB cable is connected at two ends, wait additional 10 seconds, then release the (-) button. From ae96806676ed9f8296abcc796d7010ed42b21835 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sat, 12 Mar 2022 00:55:20 -0800 Subject: [PATCH 64/81] Update Flashing.md --- Documentation/Flashing.md | 52 +++++++++++++++++++++++---------------- 1 file changed, 31 insertions(+), 21 deletions(-) diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md index c900400a..ad7d13ed 100644 --- a/Documentation/Flashing.md +++ b/Documentation/Flashing.md @@ -24,7 +24,7 @@ In general you probably want `master`. Once you click on a run, scroll down to the "Artifacts" section and then click on your model to download a zip file. Then this works the same as a production release (use the correct file). -## Miniware devices (TS100, TS80, TS80P & MHP30) +# Miniware devices (TS100, TS80, TS80P & MHP30) This is completely safe, but if it goes wrong just put the `.hex` file from the official website ([TS100](https://www.minidso.com/forum.php?mod=viewthread&tid=868&extra=page%3D1), [TS80](https://www.minidso.com/forum.php?mod=viewthread&tid=3202&extra=page%3D1), [TS80P](https://www.minidso.com/forum.php?mod=viewthread&tid=4070&extra=page%3D1) & [MHP30](https://www.minidso.com/forum.php?mod=viewthread&tid=4385&extra=page%3D1)) onto the unit and you're back to the old firmware. Downloads for the `.hex` files to flash are available on the [releases page.](https://github.com/Ralim/IronOS/releases) The file you want is called _(MODEL)\_EN.hex_ unless you want the translations, they are (MODEL)\__language short name_.hex. Where (MODEL) is either TS100 or TS80. @@ -47,13 +47,13 @@ There is a complete device flash backup included in this repository. (Note this For the TS80 the SWD pins are used for the QC negotiation, so you can actually connect to the SWD power via the USB connector. -# Mac +## Mac sgr1ff1n (Shane) commented in [issue 11](https://github.com/Ralim/ts100/issues/11) that upgrading worked on their Mac as per normal: > I just wanted to say that I was able to update the firmware on my ts100 from the stock version to 1.08 found in this repository using my Mac. I simply followed the same steps however through Finder. I have a MacBook Pro (13-inch, Mid 2012) running Sierra 10.12.4 (16E195). -# Linux +## Linux While in the past there were reports of unreliable upgrades, the consensus in [issue 11](https://github.com/Ralim/ts100/issues/11) is that things work mostly as expected in Linux. @@ -86,34 +86,33 @@ rmdir /tmp/mntdfu Device will reboot and automount will rerun if not disabled. Check the extension of your firmware, it should be `.RDY` now. -## Pinecil (Pine64) +# Pinecil (Pine64) -The MCU used in the Pinecil supports usb-dfu. Reference [Pine64 Wiki](https://wiki.pine64.org/wiki/Pinecil). +The MCU used in the Pinecil supports usb-dfu. Reference [Pinecil Wiki](https://wiki.pine64.org/wiki/Pinecil). It is recommended to use the [Pine64 Updater](https://github.com/pine64/pinecil-firmware-updater/releases). This GUI app is easy to use, works in several types of OS, i.e. Windows/Mac, and will automatically fetch the newest stable version of IronOS from Github. One advantage to Pinecil is you can not permanently damage it doing a firmware update (because DFU is in ROM); an update could render Pinecil temporarily inoperable if you flash an invalid firmware. However, simply flashing a working firmware will fix everything. If your OS is not currently supported by the [Updater](https://github.com/pine64/pinecil-firmware-updater/releases) or it does not meet your needs, the below manual method may be used. You will need to connect your Pinecil to a computer usinga USB cable. Generally all usb controllers work, but some hubs have issues so it is recommended to connect directly and avoid USB hubs. +## Linux and Mac + ### Steps ⛔ Do not use the DC power jack while updating firmware or you may destroy your PC.⛔ 1. Download and extract the firmware package from Github [IronOS Releases](https://github.com/Ralim/IronOS/releases). -2. Enter DFU mode: press and hold (-) button at the back of the iron (do not release). -3. Connect USB to PC, and USB-C to back of Pinecil, keep holding (-) button down. -4. The screen will stay **black/off** to indicate the Pinecil is in DFU mode. This is normal. -5. Once USB cable is connected at two ends, wait additional 10 seconds, then release the (-) button. -6. Continue to the next section below for your specific OS to complete loading the `.dfu` file onto Pinecil. +2. Highly recommended updating `dfu-util` to the newest version. +3. Enter DFU mode: press and hold (-) button at the back of the iron (do not release). +4. Connect USB to PC, and USB-C to back of Pinecil, keep holding (-) button down. +5. The screen will stay **black/off** to indicate the Pinecil is in DFU mode. This is normal. +6. Once USB cable is connected at two ends, wait additional 10 seconds, then release the (-) button. +7. Using `dfu-util` you can flash the firmware using a command line like this: -### Linux and Mac - - 1. Highly recommended to first update `dfu-util` to the newest version. - 2. Using `dfu-util` you can flash the firmware using a command line like this ``` dfu-util -D Pinecil_EN.dfu ``` -Type the file name from the folder with the appropriate 2-letter country code for your chosen language (i.e, EN = English). +Choose the file name from the folder with the appropriate 2-letter country code for your chosen language (i.e, EN = English). #### Troubleshooting: If you get a message stating that `More than one DFU capable USB device found!` when running the above command you probably have an old version of `dfu-util` installed. Might be worth updating. You can still install on the old version, but you will have to specify which DFU interface to flash to. Running the command `dfu-util -l` will show you if there are several DFU devices detected. Example: @@ -129,22 +128,33 @@ Note: if you are using an older release of `dfu-util` and you do not see `alt=0, ### Windows -For Windows there are two options: +Two Options for Windows #### Option 1: use `dfu-util` via Command line as shown above for Linux/Mac. - - Open PowerShell or Command window. - - Change to the directory of the unzipped firmware files - - Execute this command +### Steps + +⛔ Do not use the DC power jack while updating firmware or you may destroy your PC.⛔ + +1. Download and extract the firmware package from Github [IronOS Releases](https://github.com/Ralim/IronOS/releases). +2. Highly recommended updating `dfu-util` to the newest version. +3. Enter DFU mode: press and hold (-) button at the back of the iron (do not release). +4. Connect USB to PC, and USB-C to back of Pinecil, keep holding (-) button down. +5. The screen will stay **black/off** to indicate the Pinecil is in DFU mode. This is normal. +6. Once USB cable is connected at two ends, wait additional 10 seconds, then release the (-) button. +7. Open PowerShell or Command window. +8. Change to the directory of the unzipped firmware files +9. Using `dfu-util` you can flash the firmware using a command line like this: + ``` dfu-util -D Pinecil_EN.dfu ``` - - If you have errors, see Linux Troubleshooting above for solutions. + - If you have errors, see Troubleshooting above. #### Option 2: if you are uncomfortable with the command line, the easiest tool to use is the chip vendors gui tool and drivers. -Steps: +Steps 1. Complete Steps 1-7 from [above](/Documentation/Flashing.md#Steps). 2. Download both the `GD32 MCU DFU TOOL` and the `GD32 Dfu Drivers`. From 7cb83850a8177eba5e7edbce4717b7aefd5938a0 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sat, 12 Mar 2022 01:13:28 -0800 Subject: [PATCH 65/81] Update Flashing.md --- Documentation/Flashing.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md index ad7d13ed..c3889495 100644 --- a/Documentation/Flashing.md +++ b/Documentation/Flashing.md @@ -88,11 +88,10 @@ Check the extension of your firmware, it should be `.RDY` now. # Pinecil (Pine64) -The MCU used in the Pinecil supports usb-dfu. Reference [Pinecil Wiki](https://wiki.pine64.org/wiki/Pinecil). - -It is recommended to use the [Pine64 Updater](https://github.com/pine64/pinecil-firmware-updater/releases). This GUI app is easy to use, works in several types of OS, i.e. Windows/Mac, and will automatically fetch the newest stable version of IronOS from Github. One advantage to Pinecil is you can not permanently damage it doing a firmware update (because DFU is in ROM); an update could render Pinecil temporarily inoperable if you flash an invalid firmware. However, simply flashing a working firmware will fix everything. - -If your OS is not currently supported by the [Updater](https://github.com/pine64/pinecil-firmware-updater/releases) or it does not meet your needs, the below manual method may be used. You will need to connect your Pinecil to a computer usinga USB cable. Generally all usb controllers work, but some hubs have issues so it is recommended to connect directly and avoid USB hubs. +- The MCU used in the Pinecil supports usb-dfu. Reference [Pinecil Wiki](https://wiki.pine64.org/wiki/Pinecil). +- Recommended [Pine64 Updater](https://github.com/pine64/pinecil-firmware-updater/releases). This GUI app is easy to use, works in several types of OS, i.e. Windows/Mac, and will automatically fetch the newest stable version of IronOS from Github. +- One advantage to Pinecil is that you can not permanently damage it doing a firmware update (because DFU is in ROM); an update could render Pinecil temporarily inoperable if you flash an invalid firmware. Never fear, simply re-flashing with a working firmware copy will fix everything. +- If your OS is not currently supported by the [Updater](https://github.com/pine64/pinecil-firmware-updater/releases) or it does not meet your needs, the below manual method may be used. It requires connectting your Pinecil to a computer usinga a USB cable. Generally all usb controllers work, but some hubs have issues so it is preferred to avoid USB hubs for updates. ## Linux and Mac @@ -130,7 +129,7 @@ Note: if you are using an older release of `dfu-util` and you do not see `alt=0, Two Options for Windows -#### Option 1: use `dfu-util` via Command line as shown above for Linux/Mac. +#### Option 1: use `dfu-util` via Command line similar to above for Linux / Mac. ### Steps From 3b409d5dae06d7687cfcb1b6993129674d8fa0c6 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sat, 12 Mar 2022 01:16:12 -0800 Subject: [PATCH 66/81] Update Flashing.md --- Documentation/Flashing.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md index c3889495..3c93f3c0 100644 --- a/Documentation/Flashing.md +++ b/Documentation/Flashing.md @@ -140,7 +140,7 @@ Two Options for Windows 3. Enter DFU mode: press and hold (-) button at the back of the iron (do not release). 4. Connect USB to PC, and USB-C to back of Pinecil, keep holding (-) button down. 5. The screen will stay **black/off** to indicate the Pinecil is in DFU mode. This is normal. -6. Once USB cable is connected at two ends, wait additional 10 seconds, then release the (-) button. +6. After the USB cable is connected at both ends, wait additional 10 seconds, then release the (-) button. 7. Open PowerShell or Command window. 8. Change to the directory of the unzipped firmware files 9. Using `dfu-util` you can flash the firmware using a command line like this: @@ -148,7 +148,7 @@ Two Options for Windows ``` dfu-util -D Pinecil_EN.dfu ``` - - If you have errors, see Troubleshooting above. + - If you have errors, see Troubleshooting [above](https://github.com/Ralim/IronOS/blob/7cb83850a8177eba5e7edbce4717b7aefd5938a0/Documentation/Flashing.md#troubleshooting). #### Option 2: if you are uncomfortable with the command line, the easiest tool to use is the chip vendors gui tool and drivers. From 1b146ca3c0827177a38b4bd8ccf7cd806266b47b Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sat, 12 Mar 2022 01:19:12 -0800 Subject: [PATCH 67/81] Update Flashing.md --- Documentation/Flashing.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md index 3c93f3c0..66484f58 100644 --- a/Documentation/Flashing.md +++ b/Documentation/Flashing.md @@ -179,7 +179,7 @@ Steps Note: pc/laptop can not power pinecil, it generally only gets 5V (non-PD) there to communicate for firmware updates and Pinecil will report `DC Low` if you try. -### FAQ +## FAQ #### [Miniware] The file is showing up with the extension `.ERR` @@ -205,7 +205,7 @@ If you are on Windows, it's often best to try another computer (friends, work, p 2. Try other USB ports. Often different USB controllers will interact with the units differently due to design quirks in the miniware design. -## [Miniware] Alternative bootloader +### [Miniware] Alternative bootloader If you are an advanced user, and you have used `usb-dfu` tools before, or you would like to learn; there is an alternative bootloader for these irons. This will **NOT** show up as a USB storage drive, but instead show up using a standard DFU protocol device. You can then use dfu tools or GUI's to upgrade the iron using the `.bin` files that are posted to the releases page. From 7404f9dc36e676a4b3483f924562d2e53dab7f0e Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sat, 12 Mar 2022 01:23:07 -0800 Subject: [PATCH 68/81] Update Flashing.md --- Documentation/Flashing.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md index 66484f58..652ffa75 100644 --- a/Documentation/Flashing.md +++ b/Documentation/Flashing.md @@ -129,7 +129,7 @@ Note: if you are using an older release of `dfu-util` and you do not see `alt=0, Two Options for Windows -#### Option 1: use `dfu-util` via Command line similar to above for Linux / Mac. +#### Option 1: use command line `dfu-util` similar to above for Linux / Mac. ### Steps @@ -155,7 +155,7 @@ dfu-util -D Pinecil_EN.dfu Steps -1. Complete Steps 1-7 from [above](/Documentation/Flashing.md#Steps). +1. Complete Steps 1-7 from [above](/Documentation/Flashing.md#Steps). Then continue with steps below. 2. Download both the `GD32 MCU DFU TOOL` and the `GD32 Dfu Drivers`. - GD32 DFU Tool [here](http://www.gd32mcu.com/en/download?kw=GD32+MCU+Dfu+Tool&lan=en). - If the link breaks, search for "GD32 MCU Dfu Tool" at this [link](http://www.gd32mcu.com/en/download/). From 823a8a2e11e6f9328a502380989dd010deaff79e Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sat, 12 Mar 2022 02:15:46 -0800 Subject: [PATCH 69/81] Update Flashing.md --- Documentation/Flashing.md | 50 +++++++++++++++++++++++---------------- 1 file changed, 29 insertions(+), 21 deletions(-) diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md index 652ffa75..29457f48 100644 --- a/Documentation/Flashing.md +++ b/Documentation/Flashing.md @@ -86,6 +86,7 @@ rmdir /tmp/mntdfu Device will reboot and automount will rerun if not disabled. Check the extension of your firmware, it should be `.RDY` now. + # Pinecil (Pine64) - The MCU used in the Pinecil supports usb-dfu. Reference [Pinecil Wiki](https://wiki.pine64.org/wiki/Pinecil). @@ -104,7 +105,7 @@ Check the extension of your firmware, it should be `.RDY` now. 3. Enter DFU mode: press and hold (-) button at the back of the iron (do not release). 4. Connect USB to PC, and USB-C to back of Pinecil, keep holding (-) button down. 5. The screen will stay **black/off** to indicate the Pinecil is in DFU mode. This is normal. -6. Once USB cable is connected at two ends, wait additional 10 seconds, then release the (-) button. +6. Once USB cable is connected at two ends, wait 10 seconds more, then release the (-) button. 7. Using `dfu-util` you can flash the firmware using a command line like this: ``` @@ -138,12 +139,12 @@ Two Options for Windows 1. Download and extract the firmware package from Github [IronOS Releases](https://github.com/Ralim/IronOS/releases). 2. Highly recommended updating `dfu-util` to the newest version. 3. Enter DFU mode: press and hold (-) button at the back of the iron (do not release). -4. Connect USB to PC, and USB-C to back of Pinecil, keep holding (-) button down. -5. The screen will stay **black/off** to indicate the Pinecil is in DFU mode. This is normal. -6. After the USB cable is connected at both ends, wait additional 10 seconds, then release the (-) button. +4. Connect USB to PC, and USB-C to the back of Pinecil, keep holding (-) button down. +5. Screen will stay **black/off** to indicate the Pinecil is in DFU mode. This is normal. +6. After the USB cable is connected at both ends, wait ~10 seconds more, then release the (-) button. 7. Open PowerShell or Command window. 8. Change to the directory of the unzipped firmware files -9. Using `dfu-util` you can flash the firmware using a command line like this: +9. Using `dfu-util,` flash the firmware using a command like this: ``` dfu-util -D Pinecil_EN.dfu @@ -151,34 +152,41 @@ dfu-util -D Pinecil_EN.dfu - If you have errors, see Troubleshooting [above](https://github.com/Ralim/IronOS/blob/7cb83850a8177eba5e7edbce4717b7aefd5938a0/Documentation/Flashing.md#troubleshooting). -#### Option 2: if you are uncomfortable with the command line, the easiest tool to use is the chip vendors gui tool and drivers. +#### Option 2: if you are uncomfortable with the command line, the easiest tool (besides Pine64 Updater) is the chip vendors gui tool/drivers. -Steps +### Steps -1. Complete Steps 1-7 from [above](/Documentation/Flashing.md#Steps). Then continue with steps below. +⛔ Do not use the DC power jack while updating firmware or you may destroy your PC.⛔ + +1. Download and extract the firmware package from Github [IronOS Releases](https://github.com/Ralim/IronOS/releases). 2. Download both the `GD32 MCU DFU TOOL` and the `GD32 Dfu Drivers`. - GD32 DFU Tool [here](http://www.gd32mcu.com/en/download?kw=GD32+MCU+Dfu+Tool&lan=en). - If the link breaks, search for "GD32 MCU Dfu Tool" at this [link](http://www.gd32mcu.com/en/download/). - GD32 DFU Drivers [here](http://www.gd32mcu.com/en/download?kw=GD32+Dfu+Drivers&lan=en) - If the link breaks, search for "GD32 Dfu Drivers" at this [link](http://www.gd32mcu.com/en/download/). - Check properties of both downloads, tick Unblock if needed, then Unzip -2. Install the drivers and Open the GD32 DFU tool. Ignore the prompt to update the tool. -3. While continuously holding down the minus (-) button, Connect the Pinecil to a Windows PC via USB cable (do not release the (-) yet). -4. . The **screen will stay black** and you will hear a beep from Windows as it connects to Pinecil in DFU mode. -5. . If you see windows notification that it does not recognize Usb device, then you didn't connect, repeat step 4 - -plug usb-c to pc first, then hold down (-) on pinecil & while holding down, then push usb-c into pinecil (keep holding the (-) button). +3. Install the drivers and the GD32 DFU tool (ignore prompts to update the tool). +4. Enter DFU mode: press and hold (-) button at the back of Pinecil (do not release). +5. Connect Pinecil to a PC via USB cable (do not release the (-) yet). +6. Screen will stay **black/off** to indicate the Pinecil is in DFU mode. This is normal. +7. You may hear a beep from Windows as it connects to Pinecil in DFU mode. +8. If you see windows notification that it `does not recognize Usb device`, then you didn't connect, repeat step 3-8. + -plug usb-c to pc first, then hold down (-) & while holding down, then push usb-c into pinecil (keep holding the (-) button). -6. At the top of the DFU tool, you should see `GD DFU DEVICE 1` appear if you successfully connected Pinecil. -7. Release the (-) button. -8. Select `Download to device` > open > browse to folder you unziped in step 2. (don't use Upload from Device section) -9. Select the hex file for language. English is Pinecil_EN.hex , tick `Verify after download`. -10. Click `OK` at bottom. After a few minutes you will see 0-100%, Download successfully! Click `Leave DFU` at the top. -11. Disconnect pinecil cable from computer, plug it into a power source. -12. Do not hold down any buttons, a new screen should appear. -13. To confirm upgrade, hold the minus (-) button down for a few seconds, it then shows new firmware version v2.xx.x....date +8. Open the GD32 DFU Tool (ignore prompts to update tool). +10. At the top of the DFU tool, you should see `GD DFU DEVICE 1` appear if you successfully connected Pinecil. +11. If DFU Device box at top is blank, then Pinecil is not connected in DFU mode, repeat steps 3-11. +12. If it has been more than 10 seconds since you connected the USB cable, Release the (-) button. (don't use Upload from Device section) +14. Select `Download to device` > Open > Browse to folder dyou unziped in step 2. +15. Select the `hex` file for language. English is Pinecil_EN.hex , tick `Verify after download`. +16. Click `OK` at bottom. After a few minutes you will see 0-100%, Download successfully! Click `Leave DFU` at the top. +17. Disconnect pinecil cable from PC, plug it into a power supply. +18. Do not need to press any buttons, a new screen should appear. +19. To confirm upgrade, hold the minus (-) button down for a few seconds, it then shows new firmware version v2.xx.x....date Note: pc/laptop can not power pinecil, it generally only gets 5V (non-PD) there to communicate for firmware updates and Pinecil will report `DC Low` if you try. + ## FAQ #### [Miniware] The file is showing up with the extension `.ERR` From 6612efda754d48147d591671740dc39b38b32c1f Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sat, 12 Mar 2022 02:18:41 -0800 Subject: [PATCH 70/81] Update Flashing.md --- Documentation/Flashing.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md index 29457f48..d576e90a 100644 --- a/Documentation/Flashing.md +++ b/Documentation/Flashing.md @@ -126,13 +126,13 @@ dfu-util -D Pinecil_EN.dfu -a 0 ``` Note: if you are using an older release of `dfu-util` and you do not see `alt=0, name="@Internal Flash /0x08000000/128*001Kg"` when running `dfu-util -l` you likely will not be able to update without first updating `dfu-util`. -### Windows +## Windows Two Options for Windows -#### Option 1: use command line `dfu-util` similar to above for Linux / Mac. +### Option 1: use command line `dfu-util` similar to above for Linux / Mac. -### Steps +#### Steps ⛔ Do not use the DC power jack while updating firmware or you may destroy your PC.⛔ @@ -152,9 +152,9 @@ dfu-util -D Pinecil_EN.dfu - If you have errors, see Troubleshooting [above](https://github.com/Ralim/IronOS/blob/7cb83850a8177eba5e7edbce4717b7aefd5938a0/Documentation/Flashing.md#troubleshooting). -#### Option 2: if you are uncomfortable with the command line, the easiest tool (besides Pine64 Updater) is the chip vendors gui tool/drivers. +### Option 2: if you are uncomfortable with the command line, the easiest tool (besides Pine64 Updater) is the chip vendors gui tool/drivers. -### Steps +#### Steps ⛔ Do not use the DC power jack while updating firmware or you may destroy your PC.⛔ From 1fbc3be223b17d5659a9b2178216fc43af5357f9 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sat, 12 Mar 2022 02:22:05 -0800 Subject: [PATCH 71/81] Update Flashing.md --- Documentation/Flashing.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md index d576e90a..a5b6875d 100644 --- a/Documentation/Flashing.md +++ b/Documentation/Flashing.md @@ -98,7 +98,7 @@ Check the extension of your firmware, it should be `.RDY` now. ### Steps -⛔ Do not use the DC power jack while updating firmware or you may destroy your PC.⛔ +⛔ Do not use the DC power jack while updating firmware or you may destroy your PC. ⛔ 1. Download and extract the firmware package from Github [IronOS Releases](https://github.com/Ralim/IronOS/releases). 2. Highly recommended updating `dfu-util` to the newest version. @@ -134,7 +134,7 @@ Two Options for Windows #### Steps -⛔ Do not use the DC power jack while updating firmware or you may destroy your PC.⛔ +⛔ Do not use the DC power jack while updating firmware or you may destroy your PC. ⛔ 1. Download and extract the firmware package from Github [IronOS Releases](https://github.com/Ralim/IronOS/releases). 2. Highly recommended updating `dfu-util` to the newest version. @@ -156,10 +156,10 @@ dfu-util -D Pinecil_EN.dfu #### Steps -⛔ Do not use the DC power jack while updating firmware or you may destroy your PC.⛔ +⛔ Do not use the DC power jack while updating firmware or you may destroy your PC. ⛔ 1. Download and extract the firmware package from Github [IronOS Releases](https://github.com/Ralim/IronOS/releases). -2. Download both the `GD32 MCU DFU TOOL` and the `GD32 Dfu Drivers`. +2. 2. Download both the `GD32 MCU DFU TOOL` and the `GD32 Dfu Drivers`. - GD32 DFU Tool [here](http://www.gd32mcu.com/en/download?kw=GD32+MCU+Dfu+Tool&lan=en). - If the link breaks, search for "GD32 MCU Dfu Tool" at this [link](http://www.gd32mcu.com/en/download/). - GD32 DFU Drivers [here](http://www.gd32mcu.com/en/download?kw=GD32+Dfu+Drivers&lan=en) @@ -171,9 +171,7 @@ dfu-util -D Pinecil_EN.dfu 6. Screen will stay **black/off** to indicate the Pinecil is in DFU mode. This is normal. 7. You may hear a beep from Windows as it connects to Pinecil in DFU mode. 8. If you see windows notification that it `does not recognize Usb device`, then you didn't connect, repeat step 3-8. - -plug usb-c to pc first, then hold down (-) & while holding down, then push usb-c into pinecil (keep holding the (-) button). - -8. Open the GD32 DFU Tool (ignore prompts to update tool). +9. Open the GD32 DFU Tool (ignore prompts to update tool). 10. At the top of the DFU tool, you should see `GD DFU DEVICE 1` appear if you successfully connected Pinecil. 11. If DFU Device box at top is blank, then Pinecil is not connected in DFU mode, repeat steps 3-11. 12. If it has been more than 10 seconds since you connected the USB cable, Release the (-) button. (don't use Upload from Device section) From 4161b752d7f5a24c276320ca91906f06efa7b67f Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sat, 12 Mar 2022 02:28:30 -0800 Subject: [PATCH 72/81] Update Flashing.md --- Documentation/Flashing.md | 50 ++++++++++++++++++++------------------- 1 file changed, 26 insertions(+), 24 deletions(-) diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md index a5b6875d..a5e09781 100644 --- a/Documentation/Flashing.md +++ b/Documentation/Flashing.md @@ -130,21 +130,22 @@ Note: if you are using an older release of `dfu-util` and you do not see `alt=0, Two Options for Windows -### Option 1: use command line `dfu-util` similar to above for Linux / Mac. +### Option 1: use command line -#### Steps +### Steps ⛔ Do not use the DC power jack while updating firmware or you may destroy your PC. ⛔ -1. Download and extract the firmware package from Github [IronOS Releases](https://github.com/Ralim/IronOS/releases). +1. Using command line `dfu-util` is similar to above for Linux / Mac. 2. Highly recommended updating `dfu-util` to the newest version. -3. Enter DFU mode: press and hold (-) button at the back of the iron (do not release). -4. Connect USB to PC, and USB-C to the back of Pinecil, keep holding (-) button down. -5. Screen will stay **black/off** to indicate the Pinecil is in DFU mode. This is normal. -6. After the USB cable is connected at both ends, wait ~10 seconds more, then release the (-) button. -7. Open PowerShell or Command window. -8. Change to the directory of the unzipped firmware files -9. Using `dfu-util,` flash the firmware using a command like this: +3. Download and extract the firmware package from Github [IronOS Releases](https://github.com/Ralim/IronOS/releases). +4. Enter DFU mode: press and hold (-) button at the back of the iron (do not release). +5. Connect USB to PC, and USB-C to the back of Pinecil, keep holding (-) button down. +6. Screen will stay **black/off** to indicate the Pinecil is in DFU mode. This is normal. +7. After the USB cable is connected at both ends, wait ~10 seconds more, then release the (-) button. +8. Open PowerShell or Command window. +9. Change to the directory of the unzipped firmware files +10. Using `dfu-util,` flash the firmware using a command like this: ``` dfu-util -D Pinecil_EN.dfu @@ -152,29 +153,30 @@ dfu-util -D Pinecil_EN.dfu - If you have errors, see Troubleshooting [above](https://github.com/Ralim/IronOS/blob/7cb83850a8177eba5e7edbce4717b7aefd5938a0/Documentation/Flashing.md#troubleshooting). -### Option 2: if you are uncomfortable with the command line, the easiest tool (besides Pine64 Updater) is the chip vendors gui tool/drivers. +### Option 2: Use the gui tool/drivers from chip vendor -#### Steps +### Steps ⛔ Do not use the DC power jack while updating firmware or you may destroy your PC. ⛔ -1. Download and extract the firmware package from Github [IronOS Releases](https://github.com/Ralim/IronOS/releases). -2. 2. Download both the `GD32 MCU DFU TOOL` and the `GD32 Dfu Drivers`. +1. If you are uncomfortable with the command line, then this chip vendor supplied gui tool/drivers is an option. +2. Download and extract the firmware package from Github [IronOS Releases](https://github.com/Ralim/IronOS/releases). +3. Download both the `GD32 MCU DFU TOOL` and the `GD32 Dfu Drivers`. - GD32 DFU Tool [here](http://www.gd32mcu.com/en/download?kw=GD32+MCU+Dfu+Tool&lan=en). - If the link breaks, search for "GD32 MCU Dfu Tool" at this [link](http://www.gd32mcu.com/en/download/). - GD32 DFU Drivers [here](http://www.gd32mcu.com/en/download?kw=GD32+Dfu+Drivers&lan=en) - If the link breaks, search for "GD32 Dfu Drivers" at this [link](http://www.gd32mcu.com/en/download/). - Check properties of both downloads, tick Unblock if needed, then Unzip -3. Install the drivers and the GD32 DFU tool (ignore prompts to update the tool). -4. Enter DFU mode: press and hold (-) button at the back of Pinecil (do not release). -5. Connect Pinecil to a PC via USB cable (do not release the (-) yet). -6. Screen will stay **black/off** to indicate the Pinecil is in DFU mode. This is normal. -7. You may hear a beep from Windows as it connects to Pinecil in DFU mode. -8. If you see windows notification that it `does not recognize Usb device`, then you didn't connect, repeat step 3-8. -9. Open the GD32 DFU Tool (ignore prompts to update tool). -10. At the top of the DFU tool, you should see `GD DFU DEVICE 1` appear if you successfully connected Pinecil. -11. If DFU Device box at top is blank, then Pinecil is not connected in DFU mode, repeat steps 3-11. -12. If it has been more than 10 seconds since you connected the USB cable, Release the (-) button. (don't use Upload from Device section) +4. Install the drivers and the GD32 DFU tool (ignore prompts to update the tool). +5. Enter DFU mode: press and hold (-) button at the back of Pinecil (do not release). +6. Connect Pinecil to a PC via USB cable (do not release the (-) yet). +7. Screen will stay **black/off** to indicate the Pinecil is in DFU mode. This is normal. +8. You may hear a beep from Windows as it connects to Pinecil in DFU mode. +9. If you see windows notification that it `does not recognize Usb device`, then you didn't connect, repeat step 3-8. +10. Open the GD32 DFU Tool (ignore prompts to update tool). +11. At the top of the DFU tool, you should see `GD DFU DEVICE 1` appear if you successfully connected Pinecil. +12. If DFU Device box at top is blank, then Pinecil is not connected in DFU mode, repeat steps 3-11. +13. If it has been more than 10 seconds since you connected the USB cable, Release the (-) button. (don't use Upload from Device section) 14. Select `Download to device` > Open > Browse to folder dyou unziped in step 2. 15. Select the `hex` file for language. English is Pinecil_EN.hex , tick `Verify after download`. 16. Click `OK` at bottom. After a few minutes you will see 0-100%, Download successfully! Click `Leave DFU` at the top. From 622760104dc788ff5cba469fd6450ca900ebd337 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sat, 12 Mar 2022 02:33:05 -0800 Subject: [PATCH 73/81] Update Flashing.md --- Documentation/Flashing.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md index a5e09781..399d9b0a 100644 --- a/Documentation/Flashing.md +++ b/Documentation/Flashing.md @@ -162,11 +162,11 @@ dfu-util -D Pinecil_EN.dfu 1. If you are uncomfortable with the command line, then this chip vendor supplied gui tool/drivers is an option. 2. Download and extract the firmware package from Github [IronOS Releases](https://github.com/Ralim/IronOS/releases). 3. Download both the `GD32 MCU DFU TOOL` and the `GD32 Dfu Drivers`. - - GD32 DFU Tool [here](http://www.gd32mcu.com/en/download?kw=GD32+MCU+Dfu+Tool&lan=en). - - If the link breaks, search for "GD32 MCU Dfu Tool" at this [link](http://www.gd32mcu.com/en/download/). - - GD32 DFU Drivers [here](http://www.gd32mcu.com/en/download?kw=GD32+Dfu+Drivers&lan=en) - - If the link breaks, search for "GD32 Dfu Drivers" at this [link](http://www.gd32mcu.com/en/download/). - - Check properties of both downloads, tick Unblock if needed, then Unzip + - GD32 DFU Tool [here](http://www.gd32mcu.com/en/download?kw=GD32+MCU+Dfu+Tool&lan=en). + - If the link breaks, search for "GD32 MCU Dfu Tool" at this [link](http://www.gd32mcu.com/en/download/). + - GD32 DFU Drivers [here](http://www.gd32mcu.com/en/download?kw=GD32+Dfu+Drivers&lan=en) + - If the link breaks, search for "GD32 Dfu Drivers" at this [link](http://www.gd32mcu.com/en/download/). + - Check properties of both downloads, tick Unblock if needed, then Unzip 4. Install the drivers and the GD32 DFU tool (ignore prompts to update the tool). 5. Enter DFU mode: press and hold (-) button at the back of Pinecil (do not release). 6. Connect Pinecil to a PC via USB cable (do not release the (-) yet). From 0b7b17fc34eb980a7e0bff0fb70cf086b65b3137 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sat, 12 Mar 2022 02:34:39 -0800 Subject: [PATCH 74/81] Update Flashing.md --- Documentation/Flashing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md index 399d9b0a..7a0d74e1 100644 --- a/Documentation/Flashing.md +++ b/Documentation/Flashing.md @@ -153,7 +153,7 @@ dfu-util -D Pinecil_EN.dfu - If you have errors, see Troubleshooting [above](https://github.com/Ralim/IronOS/blob/7cb83850a8177eba5e7edbce4717b7aefd5938a0/Documentation/Flashing.md#troubleshooting). -### Option 2: Use the gui tool/drivers from chip vendor +### Option 2: use the gui tool from chip vendor ### Steps From d0382cb256455c2bfd993adf78ea6a0595ecffdf Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sat, 12 Mar 2022 02:42:02 -0800 Subject: [PATCH 75/81] Update Flashing.md --- Documentation/Flashing.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md index 7a0d74e1..da5dbd74 100644 --- a/Documentation/Flashing.md +++ b/Documentation/Flashing.md @@ -115,7 +115,7 @@ dfu-util -D Pinecil_EN.dfu Choose the file name from the folder with the appropriate 2-letter country code for your chosen language (i.e, EN = English). #### Troubleshooting: -If you get a message stating that `More than one DFU capable USB device found!` when running the above command you probably have an old version of `dfu-util` installed. Might be worth updating. You can still install on the old version, but you will have to specify which DFU interface to flash to. Running the command `dfu-util -l` will show you if there are several DFU devices detected. Example: +- If you get a message stating that `More than one DFU capable USB device found!` when running the above command you probably have an old version of `dfu-util` installed. Might be worth updating. You can still install on the old version, but you will have to specify which DFU interface to flash to. Running the command `dfu-util -l` will show you if there are several DFU devices detected. Example: ``` Found DFU: [28e9:0189] ver=0100, devnum=48, cfg=1, intf=0, path="1-1", alt=1, name="@Option Bytes /0x1FFFF800/01*016Be", serial="??" Found DFU: [28e9:0189] ver=0100, devnum=48, cfg=1, intf=0, path="1-1", alt=0, name="@Internal Flash /0x08000000/128*001Kg", serial="??" @@ -124,7 +124,11 @@ In this example we see that more than one part of the Pinecil is detected as a D ``` dfu-util -D Pinecil_EN.dfu -a 0 ``` -Note: if you are using an older release of `dfu-util` and you do not see `alt=0, name="@Internal Flash /0x08000000/128*001Kg"` when running `dfu-util -l` you likely will not be able to update without first updating `dfu-util`. +- Note: if you are using an older release of `dfu-util` and you do not see `alt=0, name="@Internal Flash /0x08000000/128*001Kg"` when running `dfu-util -l` you likely will not be able to update without first updating `dfu-util`. +- If your update is crashing using USB2 or USB3 ports, make sure you are connected directly and not using a USB hub and use shorter cables. +- Switch to a different PC/Laptop and use different ports. If your PC supports it, USB-C ports are recommended. +- Also try to hold down the (-) button for the entire firmware update, do not release until near the end. + ## Windows From 79efa3624ac2d073efdad3913c420f9815802324 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sat, 12 Mar 2022 02:52:09 -0800 Subject: [PATCH 76/81] Update Flashing.md --- Documentation/Flashing.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md index da5dbd74..7a634160 100644 --- a/Documentation/Flashing.md +++ b/Documentation/Flashing.md @@ -166,11 +166,11 @@ dfu-util -D Pinecil_EN.dfu 1. If you are uncomfortable with the command line, then this chip vendor supplied gui tool/drivers is an option. 2. Download and extract the firmware package from Github [IronOS Releases](https://github.com/Ralim/IronOS/releases). 3. Download both the `GD32 MCU DFU TOOL` and the `GD32 Dfu Drivers`. - - GD32 DFU Tool [here](http://www.gd32mcu.com/en/download?kw=GD32+MCU+Dfu+Tool&lan=en). - - If the link breaks, search for "GD32 MCU Dfu Tool" at this [link](http://www.gd32mcu.com/en/download/). - - GD32 DFU Drivers [here](http://www.gd32mcu.com/en/download?kw=GD32+Dfu+Drivers&lan=en) - - If the link breaks, search for "GD32 Dfu Drivers" at this [link](http://www.gd32mcu.com/en/download/). - - Check properties of both downloads, tick Unblock if needed, then Unzip + - GD32 DFU Tool [here](http://www.gd32mcu.com/en/download?kw=GD32+MCU+Dfu+Tool&lan=en). + - If the link breaks, search for "GD32 MCU Dfu Tool" at this [link](http://www.gd32mcu.com/en/download/). + - GD32 DFU Drivers [here](http://www.gd32mcu.com/en/download?kw=GD32+Dfu+Drivers&lan=en) + - If the link breaks, search for "GD32 Dfu Drivers" at this [link](http://www.gd32mcu.com/en/download/). + - Check properties of both downloads, tick Unblock if needed, then Unzip 4. Install the drivers and the GD32 DFU tool (ignore prompts to update the tool). 5. Enter DFU mode: press and hold (-) button at the back of Pinecil (do not release). 6. Connect Pinecil to a PC via USB cable (do not release the (-) yet). From c920f5accff7b247302c3c1e00d3702ed12987bf Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sat, 12 Mar 2022 03:01:06 -0800 Subject: [PATCH 77/81] Update Flashing.md --- Documentation/Flashing.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md index 7a634160..634cb312 100644 --- a/Documentation/Flashing.md +++ b/Documentation/Flashing.md @@ -90,8 +90,9 @@ Check the extension of your firmware, it should be `.RDY` now. # Pinecil (Pine64) - The MCU used in the Pinecil supports usb-dfu. Reference [Pinecil Wiki](https://wiki.pine64.org/wiki/Pinecil). -- Recommended [Pine64 Updater](https://github.com/pine64/pinecil-firmware-updater/releases). This GUI app is easy to use, works in several types of OS, i.e. Windows/Mac, and will automatically fetch the newest stable version of IronOS from Github. -- One advantage to Pinecil is that you can not permanently damage it doing a firmware update (because DFU is in ROM); an update could render Pinecil temporarily inoperable if you flash an invalid firmware. Never fear, simply re-flashing with a working firmware copy will fix everything. +- Recommended: the [Pine64 Updater](https://github.com/pine64/pinecil-firmware-updater/releases), is an easy to use GUI app. It is fast, and works in several types of OS, i.e. Windows/Mac, and will automatically fetch the newest stable version of IronOS from Github. +- If you have issues using the Pine64 Updater or your install fails, please look at some of the troubleshooting tips below. If that does not work, then join the Pine64 Pinecil channel. There are volunteer community helpers in Discord/Telegram/Matrix. Telegram and Matrix are bridged into Discord for people who can not use it. +- One advantage of Pinecil is that you can not permanently damage it doing a firmware update (because DFU is in ROM); an update could render Pinecil temporarily inoperable if you flash an invalid firmware. Never fear, simply re-flashing with a working firmware copy will fix everything. - If your OS is not currently supported by the [Updater](https://github.com/pine64/pinecil-firmware-updater/releases) or it does not meet your needs, the below manual method may be used. It requires connectting your Pinecil to a computer usinga a USB cable. Generally all usb controllers work, but some hubs have issues so it is preferred to avoid USB hubs for updates. ## Linux and Mac From 47789e1af63e8e54de2cec9824ff5a7078489888 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sat, 12 Mar 2022 03:04:54 -0800 Subject: [PATCH 78/81] Update Flashing.md --- Documentation/Flashing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md index 634cb312..90ea8621 100644 --- a/Documentation/Flashing.md +++ b/Documentation/Flashing.md @@ -91,7 +91,7 @@ Check the extension of your firmware, it should be `.RDY` now. - The MCU used in the Pinecil supports usb-dfu. Reference [Pinecil Wiki](https://wiki.pine64.org/wiki/Pinecil). - Recommended: the [Pine64 Updater](https://github.com/pine64/pinecil-firmware-updater/releases), is an easy to use GUI app. It is fast, and works in several types of OS, i.e. Windows/Mac, and will automatically fetch the newest stable version of IronOS from Github. -- If you have issues using the Pine64 Updater or your install fails, please look at some of the troubleshooting tips below. If that does not work, then join the Pine64 Pinecil channel. There are volunteer community helpers in Discord/Telegram/Matrix. Telegram and Matrix are bridged into Discord for people who can not use it. +- If you have issues using the Pine64 Updater or your install fails, please look at some of the troubleshooting tips below. If that does not work, then join the Pine64 Pinecil channel. There are volunteer community helpers in Discord/Telegram/Matrix. Discord has a bridge bot connection to Telegram and Matrix so that all pine volunteers/members can see the issues and advice for Pinecil and related items or get tips on which Power supply to purchase. - One advantage of Pinecil is that you can not permanently damage it doing a firmware update (because DFU is in ROM); an update could render Pinecil temporarily inoperable if you flash an invalid firmware. Never fear, simply re-flashing with a working firmware copy will fix everything. - If your OS is not currently supported by the [Updater](https://github.com/pine64/pinecil-firmware-updater/releases) or it does not meet your needs, the below manual method may be used. It requires connectting your Pinecil to a computer usinga a USB cable. Generally all usb controllers work, but some hubs have issues so it is preferred to avoid USB hubs for updates. From a5caac558778cd99be005fe4d6f38d01943cfe1f Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sat, 12 Mar 2022 03:06:31 -0800 Subject: [PATCH 79/81] Update Flashing.md --- Documentation/Flashing.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md index 90ea8621..7b586ff9 100644 --- a/Documentation/Flashing.md +++ b/Documentation/Flashing.md @@ -102,7 +102,7 @@ Check the extension of your firmware, it should be `.RDY` now. ⛔ Do not use the DC power jack while updating firmware or you may destroy your PC. ⛔ 1. Download and extract the firmware package from Github [IronOS Releases](https://github.com/Ralim/IronOS/releases). -2. Highly recommended updating `dfu-util` to the newest version. +2. Highly recommend updating `dfu-util` to the newest version. 3. Enter DFU mode: press and hold (-) button at the back of the iron (do not release). 4. Connect USB to PC, and USB-C to back of Pinecil, keep holding (-) button down. 5. The screen will stay **black/off** to indicate the Pinecil is in DFU mode. This is normal. @@ -142,7 +142,7 @@ Two Options for Windows ⛔ Do not use the DC power jack while updating firmware or you may destroy your PC. ⛔ 1. Using command line `dfu-util` is similar to above for Linux / Mac. -2. Highly recommended updating `dfu-util` to the newest version. +2. Highly recommend updating `dfu-util` to the newest version. 3. Download and extract the firmware package from Github [IronOS Releases](https://github.com/Ralim/IronOS/releases). 4. Enter DFU mode: press and hold (-) button at the back of the iron (do not release). 5. Connect USB to PC, and USB-C to the back of Pinecil, keep holding (-) button down. From e5d68391de1deb057bd7a4c6d8bfc4b72dfa8589 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sat, 12 Mar 2022 03:21:16 -0800 Subject: [PATCH 80/81] Update Flashing.md --- Documentation/Flashing.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md index 7b586ff9..7a365fc5 100644 --- a/Documentation/Flashing.md +++ b/Documentation/Flashing.md @@ -167,10 +167,8 @@ dfu-util -D Pinecil_EN.dfu 1. If you are uncomfortable with the command line, then this chip vendor supplied gui tool/drivers is an option. 2. Download and extract the firmware package from Github [IronOS Releases](https://github.com/Ralim/IronOS/releases). 3. Download both the `GD32 MCU DFU TOOL` and the `GD32 Dfu Drivers`. - - GD32 DFU Tool [here](http://www.gd32mcu.com/en/download?kw=GD32+MCU+Dfu+Tool&lan=en). - - If the link breaks, search for "GD32 MCU Dfu Tool" at this [link](http://www.gd32mcu.com/en/download/). - - GD32 DFU Drivers [here](http://www.gd32mcu.com/en/download?kw=GD32+Dfu+Drivers&lan=en) - - If the link breaks, search for "GD32 Dfu Drivers" at this [link](http://www.gd32mcu.com/en/download/). + - GD32 DFU Tool [here](http://www.gd32mcu.com/en/download?kw=GD32+MCU+Dfu+Tool&lan=en). If the link breaks, search for "GD32 MCU Dfu Tool" at this [link](http://www.gd32mcu.com/en/download/). + - GD32 DFU Drivers [here](http://www.gd32mcu.com/en/download?kw=GD32+Dfu+Drivers&lan=en). If the link breaks, search for "GD32 Dfu Drivers" at this [link](http://www.gd32mcu.com/en/download/). - Check properties of both downloads, tick Unblock if needed, then Unzip 4. Install the drivers and the GD32 DFU tool (ignore prompts to update the tool). 5. Enter DFU mode: press and hold (-) button at the back of Pinecil (do not release). From 5e350296892a013a4d9c2b390f61bb6b1aab9c08 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sat, 12 Mar 2022 04:03:50 -0800 Subject: [PATCH 81/81] Update Flashing.md --- Documentation/Flashing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md index 7a365fc5..c683fe22 100644 --- a/Documentation/Flashing.md +++ b/Documentation/Flashing.md @@ -93,7 +93,7 @@ Check the extension of your firmware, it should be `.RDY` now. - Recommended: the [Pine64 Updater](https://github.com/pine64/pinecil-firmware-updater/releases), is an easy to use GUI app. It is fast, and works in several types of OS, i.e. Windows/Mac, and will automatically fetch the newest stable version of IronOS from Github. - If you have issues using the Pine64 Updater or your install fails, please look at some of the troubleshooting tips below. If that does not work, then join the Pine64 Pinecil channel. There are volunteer community helpers in Discord/Telegram/Matrix. Discord has a bridge bot connection to Telegram and Matrix so that all pine volunteers/members can see the issues and advice for Pinecil and related items or get tips on which Power supply to purchase. - One advantage of Pinecil is that you can not permanently damage it doing a firmware update (because DFU is in ROM); an update could render Pinecil temporarily inoperable if you flash an invalid firmware. Never fear, simply re-flashing with a working firmware copy will fix everything. -- If your OS is not currently supported by the [Updater](https://github.com/pine64/pinecil-firmware-updater/releases) or it does not meet your needs, the below manual method may be used. It requires connectting your Pinecil to a computer usinga a USB cable. Generally all usb controllers work, but some hubs have issues so it is preferred to avoid USB hubs for updates. +- If your OS is not currently supported by the [Updater](https://github.com/pine64/pinecil-firmware-updater/releases) or it does not meet your needs, the below manual method may be used. It requires connectting your Pinecil to a computer using a USB cable. Generally all usb controllers work, but some hubs have issues so it is preferred to avoid USB hubs for updates. ## Linux and Mac