Skip to content

Commit

Permalink
Updated documents, fixed English Translation (Ralim#1400)
Browse files Browse the repository at this point in the history 
* Update translations_def.js

* Update translation_EN.json

* Update translation_EN.json

* Update translation_EN.json

* Update translation_EN.json

* Update translation_EN.json

* Update translation_EN.json

* Update translation_EN.json

* Update translation_EN.json

* Update translation_EN.json

* Update DebugMenu.md

* Update DebugMenu.md

* Update Development.md

* Update Flashing.md

* Update GettingStarted.md

* Update GettingStarted.md

* Update GettingStarted.md

* Update HallSensor.md

* Update HallSensor.md

* Update HallSensor.md

* Update HallSensor.md

* Update HallSensor.md

* Update HallSensor.md

* Update HardwareIssues.md

* Update HardwareIssues.md

* Update HardwareIssues.md

* Update HardwareIssues.md

* Update HardwareIssues.md

* Update Logo.md

* Update Menu.md

* Update Menu.md

* Update Menu.md

* Update Menu.md

* Update Menu.md

* Update Power.md

* Update Power.md

* Update Power.md

* Update Power.md

* Update Power.md

* Update Power.md

* Update Power.md

* Update Power.md

* Update Power.md

* Update Power.md

* Update Power.md

* Update Power.md

* Update Power.md

* Update Power.md

* Update Power.md

* Update Power.md

* Update Power.md

* Update Power.md

* Update Power.md

* Update Settings.md

* Update Settings.md

* Update Settings.md

* Update translation_EN.json

* Update Settings.md

* Update Settings.md

* Update Settings.md

* Update Settings.md

* Update Settings.md

* Update DebugMenu.md

* Update DebugMenu.md

* Update README.md

* Update translation_FR.json

* Update README.md

* Update Power.md

* Update Troubleshooting.md

* Update Troubleshooting.md

* Update Troubleshooting.md

* Update HardwareIssues.md

* Update DebugMenu.md

* Update DebugMenu.md

* Update Power.md

* Update Power.md

* Update Power.md

* Update Menu.md

* Update Power.md

* Update Documentation/Settings.md

Co-authored-by: discip <[email protected]>

* Update Translations/translation_EN.json

Co-authored-by: discip <[email protected]>

* Update translation_EN.json

* Update Documentation/Settings.md

Co-authored-by: discip <[email protected]>

* Update translation_EN.json

* Update Documentation/Settings.md

Co-authored-by: discip <[email protected]>

* Update Settings.md

* Update translation_EN.json

* Update Documentation/Settings.md

Co-authored-by: discip <[email protected]>

* Update translation_EN.json

* Update translation_EN.json

* Update translation_EN.json

* Update translation_EN.json

* Add files via upload

* Update translation_EN.json

* Update Settings.md

* Add files via upload

* Update Settings.md

* Update Settings.md

* Update Settings.md

* Add files via upload

* Delete translation_EN.json

* Add files via upload

* Update Power.md

* Update Power.md

* Add files via upload

* Update Settings.md

* Add files via upload

* handle font with no symbols to contribute

* Format

* Generate settings.md menu dock

Co-authored-by: discip <[email protected]>
Co-authored-by: Ben V. Brown <[email protected]>
  • Loading branch information
@River-Mochi @discip @Ralim
3 people authored Sep 1, 2022
1 parent fbddbda commit 904428e
Show file tree
Hide file tree
Showing 15 changed files with 483 additions and 430 deletions.
46 changes: 28 additions & 18 deletions Documentation/DebugMenu.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ Items are shown in the menu on a single line, so they use short codes and appear

### ID
- This is used by Irons that have an ID and serial number to help check if the iron is authentic. All Pinecil V1 show the same ID number as this is the number programmed into the MCU.
- The new Pinecil V2 released Aug. 2, 2022 now uses BL706, which enables generating a unique ID/Serial number to every iron. This can be used to verify your Pinecil authenticity [here](https://pinecil.pine64.org/).
- The new Pinecil V2 released Aug. 2, 2022 now uses MCU BL706, which enables generating a unique ID/Serial number to every iron. This can be used to verify your [Pinecil authenticity here](https://pinecil.pine64.org/).

### UpTime
### Time

This just shows how many deciseconds the unit has been powered for.
This is just uptime; it shows how many deciseconds the unit has been powered for (600 ds = 1 minute).

### 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 is the last timestamp of movement. When the iron is moved, this should update to match the Time field (previous menu item).
This can be used for checking performance of the movement detection code.

### ACC
Expand All @@ -38,11 +38,11 @@ This indicates the accelerometer that is fitted inside the unit.

### Tip Res

This indicates the tip resistance that the device is currently using. For devices with multiple possible values to choose from (Pinecil V2), the appropriate value is set automatically.
This indicates the tip resistance that the device is currently using. For devices with multiple possible values to choose from (Pinecil V2), the appropriate value is automatically detected at every boot-up. Tip should be installed before boot-up or reading can not be done.

### RTip

This is the raw tip reading in μV. This can be used when assessing the calibration routines for example.
This is the raw tip reading in μV. Tip must be installed or reading will be high/inaccurate. At cool, the range of 700-1000 is normal for larger tips and ~1500 for smaller tips (TS80). This is used to evaluate the calibration routines.

### CTip

Expand All @@ -51,17 +51,19 @@ 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 temperature.
This is shown in degrees Celsius x10, so 200 == 20.0 °C
This is the handle temperature or more accurately the reading of the Cold Junction Compensation (CJC) temperature sensor. This is expressed in °C x 10 (29.0 °C ambient should read as 290). Range of 200-400 (20-40 °C) is normal depending on how hot/cold the room is and how long power has been plugged in which warms the PCB further.
This is used for CJC of the tip temperature.
> If CHan is extremely high, this indicates the temperature sensor isn't reading correctly ([see Troubleshooting](/Documentation/Troubleshooting.md))

### CMax

This indicates the max temperature in degrees Celsius that the system estimates it can measure the tip reliably to.
This is dependent on a few factors including the handle temperature so it can move around during use.
This indicates the max temperature in °Celsius that the system estimates it can measure the tip reliably to.
This is dependent on a few factors including the handle temperature so it can move around during use. As you use the iron, the Max increases to a point.

### Vin

The input voltage as read by the internal ADC. Can be used to sanity check its being read correctly.
The input voltage as read by the internal ADC. Can be used to sanity check it is being read correctly.

### PWR

Expand All @@ -71,7 +73,7 @@ This may change during power up as the sources are negotiated in turn.
- **DC** input (dumb)
- **QC** input (We used QC2/3 negotiation for current supply)
- **PD W. VBus** input (PD subsystem is used to negotiate for current supply); and VBus is connected to your input power source
- **PD No VBus** input (PD subsystem is used to negotiate for current supply); and VBus is **NOT** connected to your input power source. If it is Not required or possible to do a special mod of your PCB (i.e. late model V1, some early Green PCB models) then 'PD No VBus' displays on screen, see details and PD Debug [below](/Documentation/DebugMenu.md#pd-debug-menu). Or if you had 'PD Vbus' displayed before and then successfully modified the Pinecil to support 24V by cutting the trace line to Vbus, then you will see 'PD No Vbus' now as a confirmation that the cut worked.
- **PD No VBus** input (PD subsystem is used to negotiate for current supply); and VBus is **NOT** connected to your input power source. If it is Not required or possible to do a special mod of your PCB (i.e. late model V1, some early Green PCB models) then [PD No VBus] displays on-screen ([see details and PD Debug section below](/Documentation/DebugMenu.md#pd-debug-menu)).

### HW G

Expand All @@ -80,16 +82,16 @@ As this is a high-water mater, you should only trust this once you have walked t

### HW M

This indicates the high water mark for the stack for the movement detection thread. The smaller this number is, the less headroom we have in the stack.
This indicates the high-water mark for the stack for the movement detection thread. The smaller this number is, the less headroom we have in the stack.

### HW P

This indicates the high water mark for the stack for the PID thread. The smaller this number is, the less headroom we have in the stack.
This indicates the high-water mark for the stack for the PID thread. The smaller this number is, the less headroom we have in the stack.

### Hall

This appears if your device is capable of having a hall effect sensor installed (Pinecil).
This shows the current magnetic field strength reading from the sensor. It is used to check if the sensor is operational, and for diagnostics and optimal placement of magnets on a stand (higher number is better/stronger).
This shows the current magnetic field strength reading from the sensor. It is used to check if the sensor is operational, and for diagnostics and optimal placement of magnets on a stand (higher number is better/stronger). [See Hall Sensor for details](/Documentation/HallSensor.md).

# PD Debug menu

Expand All @@ -102,8 +104,16 @@ The first page shows the PD negotiation stage number; which can be used for diag
#### Below is a method for user modification to convert some early models of Pinecil V1 to safely support 24V on the DC5525 barrel.
⚠️ Warning: do this at your own risk, read everything in this document, and go to the [Pine64 community chat](https://wiki.pine64.org/wiki/Pinecil#Community_links) if you desire advice. An incorrect cut of the trace could render the Pinecil non-working.

Background: a simple user modification to the PCB on some models of original V1 allows it to safely use DC24V by cutting a trace line to the Vbus which held it back to 21V. You can check whether your Pinecil V1 needs the update or can benefit from it by using the PD debug menu. After a few seconds or after PD negotiates (state above 5) it will show `[No VBus]` if the VBus modification is performed correctly or not needed (i.e., late model V1). Alternately, if it shows `[VBus]`, then the mod has not been done and there is still a connection to the Vbus (and Vbus connection limits you to 21V).
Background: a simple user modification to the PCB on _some models_ of original V1 allows it to safely use DC barrel 24V by cutting a trace line to the Vbus which held it back to 21V. You can check whether your Pinecil V1 needs the update or can benefit from it by using a hidden trick in the PD debug menu.

- Follow instructions above to enter the PD Debug menu.
- After a few seconds or after PD negotiates (state above 5) it will show `[PD No VBus]` if it is not needed (i.e., late model V1). Alternately, if it shows `[VBus]`, then the mod has not been done and there is still a connection to the Vbus (the Vbus connection limits you to 21V until you do the mod).
- If you need to do the mod, then follow the instructions/links below which have photos. Careful to only cut the trace and nothing else.
- Then use the PD debug menu again to check for `[PD No Vbus]` before attaching any 24V PSU to the DC barrel. If you do not get the message, then try cutting the trace a little deeper or using alcohol to clear the gap of copper dust. Then check PD messages again. If you need advice/tips, join the Pine64 chat room.

The mod method is shown in the [February 2022 PINE64 community updates](https://www.pine64.org/2022/02/15/february-update-chat-with-the-machine/). Early Pinecil V1 models required cutting a trace to achieve 24V safety with DC barrel PSU. Late model V1 made sometime in 2022 came with `[No Vbus]` already displayed, and no mod is required.

| Pinecil V2 model released Aug. 2, 2022 is an overhaul of the PCB with all relevant components capable of 28V. V2 requires no mods to support the use of 24V DC Barrel jack charger. |
:--------

The mod method is shown in the February 2022 [PINE64 community updates](https://www.pine64.org/2022/02/15/february-update-chat-with-the-machine/). Early Pinecil V1 models required cutting a trace. Late model V1 made sometime in 2022 came with '[No Vbus]' already displayed, and no mod is required.

The V2 model released Aug. 2, 2022 is an overhaul of the PCB with all relevant components capable of 28V. V2 requires no mods to support the use of 24V DC Barrel jack charger.
4 changes: 3 additions & 1 deletion Documentation/Development.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -96,9 +96,11 @@ To build a release instead, run the `build.sh` script. This will update translat
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.

## Building Pinecil
## Building Pinecil V1

I highly recommend using the command line tools and using Docker to run the compiler.
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.

## Building Pinecil V2
1 change: 1 addition & 0 deletions Documentation/Flashing.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ Check the extension of your firmware, it should be `.RDY` now.
- 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.
- Background on the [BL706 chipset](https://lupyuen.github.io/articles/bl706)

# Pinecil V1 (Pine64)

Expand Down
24 changes: 13 additions & 11 deletions Documentation/GettingStarted.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,27 +16,27 @@ By default this will show a screen similar to the one below:

![Home Screen](/Documentation/images/HomeScreen.png)

Note that this may be drawn mirrored depending on the orientation of your screen.
Note that this may be drawn mirrored depending on the orientation of your screen (detailed mode shows a different home 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 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.

In the settings, you can turn on an advanced idle screen instead. The buttons still function the same, however, the image will be swapped for a text telling you the current status of the iron with extra details.
In the settings, you can turn on a detailed idle screen instead. The buttons still function the same, however, the image will be swapped for a text telling you the current status of the iron with extra details.

Depending on how your device is being powered, at one end of the screen, the firmware will either draw text to show you the current-voltage your unit is being provided with, a battery icon (if battery mode is enabled) or a power plug icon.
Depending on how your device is being powered, at right side of the screen, the firmware will either show the voltage your unit is being provided with, a battery icon (if battery mode is enabled) or a power plug icon.

If you see exclamation marks (!!!) where the soldering iron should be, this indicates that the firmware can't see the tip connected. This could indicate a problem with the iron or tip if there is one inserted. First, try removing and reinstalling the tip. If the issue persists please see the [hardware issues section](/Documentation/HardwareIssues.md).
If you see an (**X**) where the soldering iron should be, this indicates that the firmware can't see the tip connected. This could indicate a problem with the iron or tip. First, try removing the tip screw and tip and gently reinstalling both; ensure that the tip is seated all the way back. If the issue persists please see the [hardware issues section](/Documentation/HardwareIssues.md).

This screen features a burn-in protection feature, where if no buttons or movement have been detected for a while it will automatically blank the screen to try and reduce burn-in if the iron is left unattended. Any movement or button press will wake the screen.
This OLED screen features burn-in protection; if no buttons or movement have been detected for a while it will automatically blank the screen to reduce burn-in when the iron is left unattended. Any movement or button press will wake the screen.

### Hidden Extras

Additionally to the two icons shown, there are two "hidden" actions that can be performed on this menu.

If you press and hold on to the button near the tip of the soldering iron, this will bring up the temperature adjustment screen. Normally this is not required; but if you would like to adjust the set temperature _before_ the tip starts to heat, this can be useful.
If you press and hold the button near the tip (`+/A`), this enters the temperature adjustment screen. Normally this is not required; but if you would like to adjust the set temperature _before_ the tip starts to heat, this can be useful.

If you press and hold the button near the rear of the iron it will take you into the [debug menu](/Documentation/DebugMenu.md).
If you press and hold the button near the rear of the iron (`-/B`), it will take you into the [debug menu](/Documentation/DebugMenu.md).

## Soldering Mode

Expand All @@ -58,8 +58,8 @@ In Sleep mode, the temperature of the iron automatically lowers to 150 °C (defa

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 10 user defined settings (0=off, 1=lowest sensitivity, 9=highest sensitivity). Read the Hall Sensor document for details on [installation](/Documentation/HallSensor.md).
#### Optional Hall Effect Feature (Pinecil only):
Pinecil has an unpopulated footprint (U14) for a hall effect sensor (Si7210-B-00-IV). Adding the sensor and placing a neodymium magnet on the holder stand will trigger Pinecil to sleep after it enters the stand, and Zzzz will appear on-screen. The magnet is positioned on the stand in proximity to the sensor/handle 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
Expand All @@ -69,7 +69,7 @@ If, after entering sleep mode, the iron still does not see movement for a much l

## 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 an on-screen description so you don't _need_ to come back here to figure them all out.
The settings menu is the most 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 rear button (`-/B`) is pressed to enter the menu and scrolls down the main options, and the other front button (`+/A`) will enter and change the current option.
Expand All @@ -84,4 +84,6 @@ There is a small scrollbar that appears along the right edge of the screen to in

Additionally, this scrollbar will blink rapidly when you are on the last value in a range of a sub-menu. For example, if you are in Motion Sensitivity, which has a range of 0 - 9, it will blink when you are at 9.

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. If you want to start over, simply go to Advanced settings > Restore factory settings, confirm using the front (`+/A`) button. This sets all menu items to defaults, and keeps the same version firmware.
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.

If you want to start over, simply go to Advanced settings > Restore default settings, confirm using the front (`+/A`) button. This sets all menu items to defaults, and keeps the same version firmware.
Loading

0 comments on commit 904428e

Please sign in to comment.