Skip to content

Commit 91240b5

Browse files
committed
Added a little more documentation
1 parent 93b08e1 commit 91240b5

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,17 @@ vcgencmd = RaspberryPiVcgencmd()
2424
print vcgencmd.get_version()
2525
```
2626

27+
## Exposed Functions
2728

29+
The majority of the useful output from vcgencmd is exposed in the class with the below functions
2830

31+
* get_cpu_temp - Gets the system temperature of the soc in Celsius or Fahrenheit
32+
* get_ram_split - Gets the memory split between the gpu and cpu
33+
* measure_volts - Measures the voltage of various internal components
34+
* measure_clock - Mesures the clock frequency of various internal components
35+
* is_codec_available - Returns whether the codec specificed video/audio codec is available on the Raspberry Pi
36+
* get_version - Gets the version of the firmware installed on the Raspberry Pi
37+
* set_display_power - Allows turning off/on the video output of the Raspberry Pi
2938

3039
## Todo
3140

0 commit comments

Comments
 (0)