Merge pull request #1279 from cewbdex/patch-3

Typo fixes and various improvements

Documentation/DebugMenu.md

@@ -5,7 +5,7 @@ This is accessed by holding the rear (-/B) button on the iron while it is on the
 
 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 move through the menu, use the front (+/A) button.
 To exit, use the rear (-/B) button again.
 
 ## Menu items
@@ -31,8 +31,8 @@ This just shows how many deciseconds the unit has been powered for.
 
 ### Move
 
-This is the last timestamp of movement. When the iron is moved this should update to match the time field (one before in the menu).
-This can be used for checking performance of the movement dection code.
+This is the last timestamp of movement. When the iron is moved, this should update to match the time field (one before in the menu).
+This can be used for checking performance of the movement detection code.
 
 ### RTip
 
@@ -74,12 +74,12 @@ 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 24 V 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 any PD message when Pinecil is powered by DC port, QC, or USB 5 V (non PD).
+- 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 5 V (non-PD).
 
 ### Max
 
 This indicates the max temperature in degrees Celsius 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.
+This is dependent on a few factors including the handle temperature so it can move around during use.
 
 ### Hall
 

Documentation/Development.md

@@ -94,11 +94,11 @@ To build a release instead, run the `build.sh` script. This will update translat
 ## Updating languages
 
 To update the language translation files and their associated font maps, execute the `make_translation.py` code from the `Translations` directory.
-If you edit the translation definitions or the english translation, please also run `gen_menu_docs.py` to update the settings menu documentation automatically.
+If you edit the translation definitions or the English translation, please also run `gen_menu_docs.py` to update the settings menu documentation automatically.
 
 ## Building Pinecil
 
 I highly recommend using the command line tools and using Docker to run the compiler.
-It's a bit more fussy on setup than the STM tooling, and this is by far the easiest way.
+It's a bit fussier on setup than the STM tooling, and this is by far the easiest way.
 If you _need_ an IDE I have used [Nuclei's IDE](https://nucleisys.com/download.php).
 Follow the same idea as the STM Cube IDE notes above.

Documentation/Flashing.md

@@ -11,7 +11,7 @@ These are built on every change and can be found on the Actions tab (see below).
 ### Main release
 
 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.
+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
 
@@ -31,7 +31,7 @@ This is completely safe, but if it goes wrong just put the `.hex` file from the
 Officially the bootloader on the devices only works under Windows (use the built-in File Explorer, as alternative file managers or copy handlers like Teracopy will fail). However, users have reported that it does work under Mac, and can be made to work under Linux _sometimes_. Details over on the [wiki page](https://github.com/Ralim/ts100/wiki/Upgrading-Firmware).
 
 1. Hold the button closest to the tip (MHP30 the left button on the back), and plug in the USB to the computer.
-2. The unit will appear as a USB drive. ( Screen will say `DFU` on it.)
+2. The unit will appear as a USB drive. (Screen will say `DFU` on it.)
 3. Drag the `.hex` file onto the USB drive.
 4. The unit will disconnect and reconnect.
 5. The filename will have changed to end in *.RDY* or *.ERR*
@@ -90,11 +90,11 @@ Check the extension of your firmware, it should be `.RDY` now.
 # Pinecil (Pine64)
 
 - 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.
+- 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.
 - 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.
-- 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. 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.
+- 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. 
 
 ## Linux and Mac
@@ -103,7 +103,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).
+1. Download and extract the firmware package from GitHub [IronOS Releases](https://github.com/Ralim/IronOS/releases).
 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.
@@ -115,7 +115,7 @@ Check the extension of your firmware, it should be `.RDY` now.
 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).
+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,10 +129,10 @@ dfu-util -D Pinecil_EN.dfu -a 0
 ```
 - Note: if you use an older release of `dfu-util` and 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 part-way into the update, there is sometimes an issue with older/fussy USB controllers (they can show up/disappear/then show up again)
-    - Try a direct connection to the USB port, do not use a USB hub, and use shorter cable. If possible pick a port connected to the main board.
+    - Try a direct connection to the USB port, do not use a USB hub, and use shorter cable. If possible, pick a port connected to the main board.
     - Switch to a different PC/Laptop and use different ports. USB-C ports are recommended but some have also reported having a fussy C port.
     - Hold down the (-) button for the entire firmware update, do not release until near the end.
-- `DC Low` message: a pc/laptop can not fully power pinecil, it generally can only get 5 V (non-PD) to communicate for firmware updates and Pinecil will report 'DC Low'. This is normal.
+- `DC Low` message: a pc/laptop cannot fully power Pinecil, it generally can only get 5 V (non-PD) to communicate for firmware updates and Pinecil will report 'DC Low'. This is normal.
 
 
 ## Windows
@@ -147,7 +147,7 @@ Two Options for Windows
 
 1. Using command line `dfu-util` is similar to above for Linux / Mac.
 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).
+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.
@@ -162,14 +162,14 @@ dfu-util -D Pinecil_EN.dfu
   - If you have errors, see Troubleshooting [above](/Documentation/Flashing.md#troubleshooting).
 
 
-### Option 2: use the gui tool from chip vendor
+### Option 2: use the GUI tool from chip vendor
 
 ### Steps
 
 ⛔  Do not use the DC power jack while updating firmware or you may destroy your PC. ⛔
 
-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).
+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/).
@@ -179,15 +179,15 @@ dfu-util -D Pinecil_EN.dfu
 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.
+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. 
-17. Disconnect pinecil cable from PC, plug it into a power supply.
+14. Select `Download to device` > Open > Browse to folder you unzipped 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
 
@@ -213,18 +213,18 @@ First, try just copying the file a second time.
 
 If this fails and you are on Mac or Linux reading the wiki page about programming can help. There is also a very long issue thread going through all of the different attempts around this too.
 
-If you are on Windows, it's often best to try another computer (friends, work, partners etc).
+If you are on Windows, it's often best to try another computer (friends, work, partners etc.).
 
 #### [Miniware] Device randomly disconnects or does not show up in DFU mode
 
-1. Check if the USB cable you are using has the data pins; test it on another device. There are a surprisingly large number of usb-micro cables that are power _only_.
+1. Check if the USB cable you are using has the data pins; test it on another device. There are a surprisingly large number of micro-USB cables that are power _only_.
 
-2. Try other USB ports. Often different USB controllers will interact with the units differently due to design quirks in the miniware design.
+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
 
 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.
+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 GUIs to upgrade the iron using the `.bin` files that are posted to the releases page.
 
 To install this alternative bootloader, follow the instructions [here](https://github.com/Ralim/IronOS-dfu/blob/mainline/docs/Bootloader.md).
 

Documentation/Hardware.md

@@ -5,4 +5,4 @@
 - Accelerometer is the MSA301, this is mounted roughly in the middle of the unit
 - USB-PD is using the FUSB302
 - The hardware I2C bus on PB6/7 is used for the MSA301 and FUSB302
-- The OLED is the same SSD1306 as everything else, but its on a bit-banged bus
+- The OLED is the same SSD1306 as everything else, but it’s on a bit-banged bus

Documentation/HardwareIssues.md

@@ -16,7 +16,7 @@ If your iron is new, there is a slim chance your accelerometer may be DOA and ne
 
 ## No USB-PD IC detected
 
-Generally, this means either something went very awry in the firmware or the chip is not answering as would normally be expected. Try rolling back to an earlier release to confirm if the issue still persists then the device may need repair. If you have some form of seller protection/support you most likely want to reach out to this to be safe. If you don't, you can always attempt to replace the IC yourself. As of writing both the TS80P and Pinecil use the FUSB302.
+Generally, this means either something went very awry in the firmware, or the chip is not answering as would normally be expected. Try rolling back to an earlier release to confirm if the issue still persists then the device may need repair. If you have some form of seller protection/support, you most likely want to reach out to this to be safe. If you don't, you can always attempt to replace the IC yourself. As of writing both the TS80P and Pinecil use the FUSB302.
 
 **Note this warning will only be shown the first few times until settings are reset**
 

Documentation/Logo.md

@@ -1,7 +1,7 @@
 # Startup Logos
 
 This firmware supports a user created bootup logo.
-By default there is _not_ one included in the firmware, as this means that once flashed they generally stay.
+By default, there is _not_ one included in the firmware, as this means that once flashed they generally stay.
 
 ## Generating the Logo files
 
@@ -27,7 +27,7 @@ Run `python3 img2logo.py --help` to see available options.
 ### Miniware (TS100/TS80/TS80P)
 
 Upload the HEX file to the iron in DFU mode and, if the file's extension changes to .RDY, your custom splash screen should show up on startup.
-You perform this the same way as if you were flashing a new firmware, and all of the existing notes around this apply.
+You perform this the same way as if you were flashing a new firmware, and all the existing notes around this apply.
 
 If you have flashed the `IronOS-dfu` alternative bootloader, you should use the `.dfu` files instead
 

Documentation/Menu.md

@@ -14,7 +14,7 @@ Holding the button at the front of the iron will enter boost mode (if enabled).
 This menu allows you to cycle through all the options and set their values.
 The button near the USB cycles through the options, and the one near the tip changes the selected option.
 Note that settings are not saved until you exit the menu.
-If you leave the unit alone (ie don't press any buttons) on a setting, after 3 seconds the screen will scroll a rough description of the setting.
+If you leave the unit alone (i.e., don't press any buttons) on a setting, after 3 seconds the screen will scroll a rough description of the setting.
 
 The menu is arranged so that the most often used settings are first.
 With submenus being selected to enter using the front button (as if you were going to change the setting).
@@ -41,7 +41,7 @@ To calibrate your iron:
 Some tips will have an offset on their readings, to calibrate this out perform the following steps:
 
 1. Connect power to your iron
-2. Make sure the tip is at room temperature (ie. wait for a fair while after using the iron before calibration)
+2. Make sure the tip is at room temperature (i.e., wait for a fair while after using the iron before calibration)
 3. Enter the settings menu
 4. Scroll down to the advanced menu, and then the temperature calibration
 5. Press the button to change the option (tip button)
@@ -54,6 +54,6 @@ Some tips will have an offset on their readings, to calibrate this out perform t
 
 ### Boost mode
 
-This allows you to change the front key (one near the tip) to become a boost button when you hold it for > 2 seconds. This allows you to set this button to change the soldering temperature for short periods. For example when soldering a big joint and you want to boost the temperature a bit.
+This allows you to change the front key (one near the tip) to become a boost button when you hold it for > 2 seconds. This allows you to set this button to change the soldering temperature for short periods. For example, when soldering a big joint and you want to boost the temperature a bit.
 
 The boost temperature is set in the settings menu.