Skip to content

Commit 204e582

Browse files
Andrew PattisonJamesH65
Andrew Pattison
authored andcommitted
Improve description of vcgencmd get_throttled output (raspberrypi#1341)
* Improve description of vcgencmd get_throttled output * fix typo * Fix up monospaced text * Another attempt to fix monospaced text * Oops - forgot bit zero * Add missing full stop in measure_temp section * 2 more missing full stops on this page * Fix typo * cammand -> command * remove period
1 parent 7f765da commit 204e582

File tree

1 file changed

+18
-5
lines changed

1 file changed

+18
-5
lines changed

raspbian/applications/vcgencmd.md

+18-5
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Some of the more useful commands are described below.
1515

1616
#### vcos
1717

18-
The `vcos` cammand has a number of sub commands
18+
The `vcos` command has a number of sub commands.
1919

2020
`version` Displays the build date and version of the firmware on the VideoCore.
2121
`log status` Displays the error log status of the various VideoCore software areas.
@@ -30,7 +30,7 @@ Displays the enabled and detected state of the official camera. 1 means yes, 0 m
3030

3131
#### get_throttled
3232

33-
Returns the throttled state of the system. This is a bit pattern.
33+
Returns the throttled state of the system. This is a bit pattern - a bit being set indicates the following meanings:
3434

3535
| Bit | Meaning |
3636
|:---:|---------|
@@ -39,15 +39,28 @@ Returns the throttled state of the system. This is a bit pattern.
3939
| 2 | Currently throttled |
4040
| 3 | Soft temperature limit active |
4141
| 16 | Under-voltage has occurred |
42-
| 17 | Arm frequency capped has occurred |
42+
| 17 | Arm frequency capping has occurred |
4343
| 18 | Throttling has occurred |
4444
| 19 | Soft temperature limit has occurred |
4545

46-
For example, 0x50000 has bits 16 and 18 set, indicating that the Pi has previously been throttled due to under-voltage, but is not currently throttled for any reason.
46+
A value of zero indicates that none of the above conditions is true.
47+
48+
To find if one of these bits has been set, convert the value returned to binary, then number each bit along the top. You can then see which bits are set. For example:
49+
50+
``0x50000 = 0101 0000 0000 0000 0000``
51+
52+
Adding the bit numbers along the top we get:
53+
54+
```text
55+
19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
56+
0 1 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
57+
```
58+
59+
From this we can see that bits 18 and 16 are set, indicating that the Pi has previously been throttled due to under-voltage, but is not currently throttled for any reason.
4760

4861
#### measure_temp
4962

50-
Returns the temperature of the SoC as measured by the on-board temperature sensor
63+
Returns the temperature of the SoC as measured by the on-board temperature sensor.
5164

5265
#### measure_clock [clock]
5366

0 commit comments

Comments
 (0)