aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorRiver M <[email protected]>2023-03-01 22:58:46 -0800
committerGitHub <[email protected]>2023-03-02 17:58:46 +1100
commit344c1a649d5a254f9d5b4d7e90e2a56154869a15 (patch)
tree6479f7026f3b53dd48a1b130d2e4937d7f3514d6
parent6fc27e1544fce624536eded93f5e307e40e71e0c (diff)
downloadIronOS-344c1a649d5a254f9d5b4d7e90e2a56154869a15.tar.gz
IronOS-344c1a649d5a254f9d5b4d7e90e2a56154869a15.zip
Update documents, esp. Pinecil V2 instructions (#1604)
* Update README.md * Update Pinecil V2.md * Update Pinecil V2.md update very outdated instructions on how to update Pinecil V2. * Update Pinecil V1.md * Update Pinecil V2.md * Update Pinecil V2.md
-rw-r--r--Documentation/Flashing/Pinecil V1.md15
-rw-r--r--Documentation/Flashing/Pinecil V2.md20
-rw-r--r--README.md1
3 files changed, 22 insertions, 14 deletions
diff --git a/Documentation/Flashing/Pinecil V1.md b/Documentation/Flashing/Pinecil V1.md
index 49517935..bd3f23a8 100644
--- a/Documentation/Flashing/Pinecil V1.md
+++ b/Documentation/Flashing/Pinecil V1.md
@@ -12,8 +12,8 @@ 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.
-Select the appropriate file type for your unit, in general Miniware devices need `.hex` and Pinecil needs `.dfu`.
-Flash according to details below
+Select the appropriate file type for your unit, in general Miniware devices need `.hex`, Pinecil V1 needs `.dfu`, and Pinecil V2 needs `.bin`.
+Flash according to details below.
### Bleeding edge / latest
@@ -26,13 +26,16 @@ Then this works the same as a production release (use the correct file).
# Pinecil V1
-- The MCU used in Pinecil supports usb-dfu. Reference [Pinecil Wiki](https://wiki.pine64.org/wiki/Pinecil).
-- Recommended Updater: 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. It will automatically fetch the newest stable version of IronOS from GitHub.
+- The MCU used in Pinecil supports usb-dfu. Reference [Pinecil Wiki](https://wiki.pine64.org/wiki/Pinecil) for hardware and firmware instructions.
+- Recommended Updater for Windows/MacOS: [Pine64 Updater](https://github.com/pine64/pine64_updater) is an easy-to-use GUI app. It is fast and automatically fetches the newest stable version of IronOS from GitHub. It can also be used to load custom boot logo art.
+- Recommended Updater for Linux/MacOS: [PineFlash](https://github.com/Spagett1/PineFlash) is an easy-to-use GUI app. It is fast and automatically fetches the newest stable version of IronOS from Github. It can also be used to load custom boot logo art.
+
- Troubleshooting: if you have issues using the Pine64 Updater or your install fails, please go to troubleshooting tips below.
-- Community chat: if troubleshooting doesn't work, then join the Pine64 > Pinecil channel. There are knowledgeable members in Discord/Telegram/Matrix. Discord has a bridge bot connection to Telegram and Matrix so that all pine volunteers/members can see advice for Pinecil and related items or just get tips on which Power supply to purchase.
+- The [Pinecil Wiki](https://wiki.pine64.org/wiki/Pinecil) is a great resource for all things Pinecil.
+- Community chat: if troubleshooting doesn't work, then join the Pine64 > Pinecil channel [here](https://wiki.pine64.org/wiki/Pinecil#Live_Community_Chat). There are knowledgeable members in Discord/Telegram/Matrix. Discord has a bridge bot connection to Telegram and Matrix so that all pine64 volunteers/members can see advice for Pinecil and related items or just get tips on which power supply to purchase.
- One advantage of Pinecil is that you cannot 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. But no worries, simply re-flashing with a working firmware copy will fix everything.
- USB-C cable is required to do an update. Generally, all USB controllers work, but some hubs have issues, so it is preferred to avoid USB hubs for updates.
-- Alternate Update Methods: 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, i.e., you want to install a beta version, the below manual methods may be used.
+- Alternate Update Methods: if your OS is not currently supported by the [Pine64 Updater](https://github.com/pine64/pine64_updater) or it does not meet your needs, i.e., you want to install a beta version, the below manual methods may be used.
## Linux and Mac
diff --git a/Documentation/Flashing/Pinecil V2.md b/Documentation/Flashing/Pinecil V2.md
index 82ce680c..d75fd289 100644
--- a/Documentation/Flashing/Pinecil V2.md
+++ b/Documentation/Flashing/Pinecil V2.md
@@ -12,21 +12,25 @@ 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.
-Select the appropriate file type for your unit, in general Miniware devices need `.hex` and Pinecil needs `.dfu`.
-Flash according to details below
+Select the appropriate file type for your unit, in general Miniware devices need `.hex`, Pinecil V1 needs `.dfu`, and Pinecil V2 needs `.bin`.
+Flash according to details below.
### Bleeding edge / latest
-For the _latest_ code, you will need to download the zip file from the artifacts page on the build for what you want.
-Head to the [Actions](https://github.com/Ralim/IronOS/actions) page and then select the run for the appropriate branch you would like.
+For the _latest_ code, you need to download the zip file from the artifacts page for the build that you want.
+Head to the [Actions](https://github.com/Ralim/IronOS/actions) page and then select the run for the appropriate branch and beta you would like.
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.
+Once you click on a run, scroll down to the "Artifacts" section and then click on your device model name to download a zip file.
Then this works the same as a production release (use the correct file).
# Pinecil V2
-- The MCU in V2 is Bouffalo BL706 and does _not_ use usb-dfu for flashing as the previous MCU did.
-- The current firmware (2.18) is very fresh and no upgrade is available/needed.
-- When an update is released for V2, then IronOS will also include an update method to follow.
+- The MCU in Pinecil V2 is Bouffalo BL706 and does _not_ use usb-dfu for flashing as the previous Pinecil V1 MCU did.
+- See the Pinecil Wiki page [here](https://wiki.pine64.org/wiki/Pinecil#Firmware_&_Updates) for instructions.
+- The V2 uses the [BLISP flasher](https://github.com/pine64/blisp) to upload the firmware to the MCU.
+- The [Pinecil Wiki] (https://wiki.pine64.org/wiki/Pinecil) is a great resource for all things Pinecil.
+- Community chat: if there are issues updating, then join the Pine64 > Pinecil channel [here](https://wiki.pine64.org/wiki/Pinecil#Live_Community_Chat). There are knowledgeable members in Discord/Telegram/Matrix. Discord has a bridge bot connection to Telegram and Matrix so that all pine64 volunteers/members can see advice for Pinecil and related items or just get tips on which power supply to purchase.
+- One advantage of Pinecil is that you cannot permanently damage it doing a firmware update (because BIN is in ROM); an update could render Pinecil temporarily inoperable if you flash an invalid firmware. But no worries, simply re-flashing with a working firmware copy will fix everything.
+- USB-C cable is required to do an update. Generally, all USB controllers work, but some hubs have issues, so it is preferred to avoid USB hubs for updates.
- Background on the [BL706 chipset](https://lupyuen.github.io/articles/bl706)
diff --git a/README.md b/README.md
index 65889f48..c547174b 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,6 @@
![CI](https://github.com/Ralim/ts100/workflows/CI%20Build%20all/badge.svg)
![GitHub all](https://img.shields.io/github/downloads/ralim/IronOS/total)
+![GitHub contributors](https://img.shields.io/github/contributors-anon/ralim/ironos?color=blue&style=flat)
![Latest Release](https://img.shields.io/github/v/release/ralim/IronOS)
# IronOS - Flexible Soldering iron control Firmware