# Bindings for RaspberryPi's vcgencmd utility

[![Crates.io](https://img.shields.io/crates/v/vcgencmd.svg)](https://crates.io/crates/vcgencmd)
[![Documentation](https://docs.rs/vcgencmd/badge.svg)](https://docs.rs/vcgencmd)
[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://lbesson.mit-license.org/)

The `vcgencmd` crate provides a way to interact with the vcgencmd utility
included in Raspbian through 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](https://crates.io/crates/vcgencmd):

```toml
[dependencies]
vcgencmd = "0.3.*"
```

## Features
- `serde`: Serialization and de-serialization for the few data structures this crate contains are supported via the `serde` feature flag:

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

## Quick Start

```rust
use vcgencmd::{measure_temp, get_throttle, 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 arm_mem = get_mem(Src::Mem(MemSrc::Arm)).unwrap();

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

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

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

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