KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#typescript #ai-agents #cli #open-source #ai #claude-code #codex #deepseek-harness #dsh-plugin #react #windows #developer-tools

CPUVolt

★ 81 Open GitHub ↗

Library for Arduino and ATmega series processors to read the processor's Vcc voltage and percentage of capacity (for battery based projects) using *absolutely* no external components or connections!

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# CPU Voltage

[![Arduino CI](https://flat.badgen.net/badge/Arduino%20CI/passing/2da44e?labelColor=24292f)](https://github.com/ripred/CPUVolt/actions/workflows/arduino_test_runner.yml)
[![Arduino-lint](https://flat.badgen.net/badge/Arduino-lint/passing/2da44e?labelColor=24292f)](https://github.com/ripred/CPUVolt/actions/workflows/arduino-lint.yml)
[![JSON check](https://flat.badgen.net/badge/JSON%20check/passing/2da44e?labelColor=24292f)](https://github.com/ripred/CPUVolt/actions/workflows/jsoncheck.yml)
[![Arduino Library Manager](https://flat.badgen.net/badge/Arduino%20Library%20Manager/available/00878f?labelColor=24292f)](https://www.ardu-badge.com/CPUVolt)
[![Release](https://flat.badgen.net/badge/Release/v1.0.3/8250df?labelColor=24292f)](https://github.com/ripred/CPUVolt/releases/latest)
[![License](https://flat.badgen.net/badge/License/MIT/0969da?labelColor=24292f)](https://github.com/ripred/CPUVolt/blob/main/LICENSE)
[![Stars](https://flat.badgen.net/badge/Stars/81/bf8700?labelColor=24292f)](https://github.com/ripred/CPUVolt/stargazers)
[![Forks](https://flat.badgen.net/badge/Forks/3/6f42c1?labelColor=24292f)](https://github.com/ripred/CPUVolt/network/members)

## Measure the voltage of the processor or retrieve the percent of charge for battery based systems.

Measure the voltage applied to Vcc on the Microchip (Atmel) ATMega processors using nothing more than the internal registers.
NO external parts or connections necessary!

[see this Microchip application note to learn more about the internal features used and supported to implement this feature](https://ww1.microchip.com/downloads/en/Appnotes/00002447A.pdf)

**Update**: Now includes support for reading the voltage as a percentage of total capacity. 
You can also optionally supply the voltage level that is considered to be 0% and the voltage level considered to be 100%. 
This is really useful for battery-based projects! You can now specify the lower voltage level you would like to use to
indicate when the system needs recharging and the level at which it is fully charged!
___
## Example use:
```cpp
/*
 * CPUVolt.ino
 *
 * Example Arduino sketch showing the use of the CPUVolt library.
 * Updated to show the use of the new readPercent(...) methods.
 *
 */
#include <CPUVolt.h>

void setup() {
    Serial.begin(115200);

/*
     * Read the current voltage level and convert it
     * to an easier to read floating point value
     */
    float mv = readVcc() / 1000.0;

// Show the voltage with 2 decimal places
    Serial.print("Voltage: ");
    Serial.println(mv, 2);

/*
     * Get the voltage level as a percentage of total charge.
     * You can optionally specify the voltage level to be considered
     * as 100%. The default voltage is 5V if not supplied.
     */
    float pct = readPercent(/*5000*/);
    Serial.print("Percent: ");
    Serial.println(pct, 2);

/*
     * You can also specify both the lower and upper voltage
     * ranges to be considered what is 0% and what is 100%.
     * This is really useful for battery powered projects!
     */
    pct = readPercent(2900, 4700);
    Serial.print("Percent: ");
    Serial.println(pct, 2);

/*
     * The following code shows how you might use the percent of charge
     * to turn on a "needs recharging" LED at the percent you want:
     */
    float const low_pct = 70.0;                // season to taste :)
    bool const needs_charging = pct <= low_pct;// set a "needs charging" flag
    int const led_pin = LED_BUILTIN;           // Or use any other GPIO pin (besides A6 or A7)
    pinMode(led_pin, OUTPUT);                  // set the pin as an output
    digitalWrite(led_pin, needs_charging);     // set the LED pin HIGH or LOW as needed
}

void loop() { }
```

## Example Output:
```
Voltage: 4.67
Percent: 93.38
Percent: 98.28
```

CPUVolt

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README