Bindings for RaspberryPi's vcgencmd utility

Crates.io Documentation MIT license

The vcgencmd crate provides a way to interact with the vcgencmd utility included in Raspbian in a Rust program.

As of yet, not all vcgencmd commands have a binding. To see which commands are missing, take a look at PROGRESS.md in the projects repo. I will only actively add bindings for commands if I happen to need them personally. If you need a specific command that's unimplemented, feel free to open an issue asking for it or submit a pull request with the implementation yourself.

Installation

Install from Crates.io:

toml [dependencies] vcgencmd = "0.3.*"

Features

toml [dependencies] vcgencmd = {version: "0.3.*", features = ["serde"]}

Quick Start

```rust use vcgencmd::{measuretemp, getthrottle, ThrottledStatus};

// You'll want to import the Src enum, which holds all available sources // for the different commands use vcgendcmd::Src;

// Gives the current temperature as f64 in °C let temp = measure_temp().unwrap();

// Measure the arm chips memory usage let armmem = getmem(Src::Mem(MemSrc::Arm)).unwrap();

// Measure the voltage at the video core let voltgpu = measurevolts(Src::Volt(VoltSrc::Core)).unwrap();

// Get a bit pattern which represents the throttled state of the system let bitpattern = getthrottle.unwrap();

// Get comprehensive, human readable info about the throttled state of the system let throttlestatus = ThrottledStatus::new(&bitpattern);

// If you've enabled the serde feature, you can serialize/deserialize the crates datastructures use serdejson::tostring; let serialized = tostring(&throttlestatus).unwrap(); ```