aboutsummaryrefslogtreecommitdiffhomepage
path: root/Documentation/GettingStarted.md
blob: a28fee1e711ef37e71f0a4f767f57b0718b13bb2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
# 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). 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.

If you receive a warning about the accelerometer or USB-PD not being detected, please see [here](/Documentation/HardwareIssues.md).

## The Home screen (or idle screen)

This is the landing page of the firmware, from here you can choose to either go into the [settings menu](#Settings-Menu) or go into [soldering mode](#Soldering-Mode).

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.

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.

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.

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).

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.

### 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 rear of the iron it will take you into the [debug menu](/Documentation/DebugMenu.md).

## Soldering Mode

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 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.

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

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.

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)

### 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).

## 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.

To navigate the menu, the two buttons act separately.
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 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.

You can long hold buttons to change through options faster, and there is some acceleration when holding the buttons.

There is a small scrollbar that will be shown along the edge of the screen to indicate how far through the current list you are.

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 your needs.