Skip to content

Commit

Permalink
update library.json and readme.md to publish on PlatformIO (#11)
Browse files Browse the repository at this point in the history
* update library.json + readme.md
  • Loading branch information
RobTillaart authored Feb 14, 2025
1 parent 5ea8e73 commit 5810a3f
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 24 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,27 @@
[![Arduino CI](https://github.com/ripred/Smooth/workflows/Arduino%20CI/badge.svg)](https://github.com/marketplace/actions/arduino_ci)
[![Arduino-lint](https://github.com/ripred/Smooth/actions/workflows/arduino-lint.yml/badge.svg)](https://github.com/ripred/Smooth/actions/workflows/arduino-lint.yml)
![code size:](https://img.shields.io/github/languages/code-size/ripred/Smooth)
[![JSON check](https://github.com/ripred/Smooth/actions/workflows/jsoncheck.yml/badge.svg)](https://github.com/ripred/Smooth/actions/workflows/jsoncheck.yml)
[![GitHub release](https://img.shields.io/github/release/ripred/Smooth.svg?maxAge=3600)](https://github.com/ripred/Smooth/releases)
[![PlatformIO Registry](https://badges.registry.platformio.org/packages/ripred/library/Smooth.svg)](https://registry.platformio.org/libraries/ripred/Smooth)
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/ripred/Smooth/blob/master/LICENSE)

![code size:](https://img.shields.io/github/languages/code-size/ripred/Smooth)
[![Stars](https://img.shields.io/github/stars/ripred/Smooth.svg?style=flat-square&colorB=4183c4)](https://github.com/ripred/Smooth)
[![Forks](https://img.shields.io/github/forks/ripred/Smooth.svg?style=flat-square&colorB=4183c4)](https://github.com/ripred/Smooth)


# Smooth Arduino Library

Keep smooth running averages without using arrays! No arrays. No Looping. Fast and Constant Time regardless of the sample window size!

The sample size is adjustable at runtime. The average is available and accurate even before N samples have been received. The `Smooth` object uses 8 bytes of memory. That's it. No matter how large the window size. Perfect for smoothing and filtering signals from noisy devices **like accelerometers** and **stable potentiometer readings**!
The sample size is adjustable at runtime. The average is available and accurate even before N samples have been received.
The `Smooth` object uses 8 bytes of memory. That's it. No matter how large the window size. Perfect for smoothing and filtering
signals from noisy devices **like accelerometers** and **stable potentiometer readings**!

update: added support for change, upper and lower bounds callbacks!

### Example sketch:

```cpp
#include <Arduino.h>
#include <Smooth.h>
Expand Down
46 changes: 24 additions & 22 deletions library.json
Original file line number Diff line number Diff line change
@@ -1,23 +1,25 @@
{
"name": "Smooth",
"keywords": "",
"description": "Keep smooth running averages without using arrays! The sample size is adjustable at runtime.\nThe average is available and accurate even before N samples have been received. Now the library suppports callbacks as well for changes, lower bounds, and upper bounds.",
"authors":
[
{
"name": "Trent M. Wyatt",
"email": "robotics@trentwyatt.com",
"maintainer": true
}
],
"repository":
{
"type": "git",
"url": "https://github.com/ripred/Smooth"
},
"version": "1.9.0",
"license": "MIT",
"frameworks": "*",
"platforms": "*",
"headers": "Smooth.h"
}
"name": "Smooth",
"keywords": "",
"description": "Keep smooth running averages without using arrays! The sample size is adjustable at runtime.\nThe average is available and accurate even before N samples have been received. Now the library suppports callbacks as well for changes, lower bounds, and upper bounds.",
"authors": [
{
"name": "Trent M. Wyatt",
"email": "robotics@trentwyatt.com",
"maintainer": true
},
{
"name": "Rob Tillaart",
"email": "Rob.Tillaart@gmail.com"
}
],
"repository": {
"type": "git",
"url": "https://github.com/ripred/Smooth"
},
"version": "1.9.0",
"license": "MIT",
"frameworks": "*",
"platforms": "*",
"headers": "Smooth.h"
}

0 comments on commit 5810a3f

Please # to comment.