lowpassns 0.1.0

Lightweight no_std low-pass filters for embedded systems, open source and GPL-protected.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

# lowpassns

[![License: GPL-2.0-or-later](https://img.shields.io/badge/License-GPL%202.0%2B-blue.svg)](https://www.gnu.org/licenses/gpl-2.0)  
[![No Std](https://img.shields.io/badge/no_std-compatible-green.svg)](https://docs.rs/lowpassns)  
[![Maintenance](https://img.shields.io/badge/Maintenance-Actively--developed-brightgreen.svg)](https://github.com/jorgeandrecastro/lowpassns)  

## Lightweight `no_std` Low-Pass Filter for Embedded Systems

**lowpassns** is a small, efficient, and robust **first-order low-pass filter** crate for `no_std` Rust environments. Designed for embedded systems like RP2040 or STM32, it smooths sensor readings or signals in real-time while being memory- and CPU-efficient.  

GPL-2.0-or-later licensed to ensure open and free usage in both hobbyist and commercial projects.  

---

## Table of Contents
- [Features](#features)  
- [Installation](#installation)  
- [Quickstart](#quickstart)  
- [API Reference](#api-reference)  
- [Performance & Optimization](#performance--optimization)  
- [Testing](#testing)  
- [License](#license)  

---

## ๐Ÿš€ Features
- โœ… **Pure `no_std`**: Zero standard library dependencies, perfect for bare-metal and RTOS.  
- โšก **Flexible Floating-Point**: Default `f64`, optional `f32` feature for memory-constrained devices.  
- ๐Ÿ”ง **Lightweight**: Minimal stack usage, O(1) per update.  
- ๐Ÿ›ก๏ธ **Stable & Safe**: Handles zero/negative dt safely, clamps tiny dt for embedded portability.  
- ๐Ÿ“ˆ **Smooth Filtering**: Simple first-order low-pass behavior for sensor smoothing or signal conditioning.  
- โ›‘๏ธ **Resettable State**: Filter value can be reset at any time.  

---

## ๐Ÿ› ๏ธ Installation

Add to your `Cargo.toml`:

```toml
[dependencies]
lowpassns = { git = "https://github.com/jorgeandrecastro/lowpassns.git" }


Enable f32 for constrained MCUs:

lowpassns = { git = "https://github.com/jorgeandrecastro/lowpassns.git", features = ["f32"] }

Build with optimizations:

cargo build --release

๐Ÿš€ Quickstart
use lowpassns::LowPass1;

fn main() {
    // Initial value = 0.0, time constant ฯ„ = 0.1 s
    let mut filter = LowPass1::new(0.0, 0.1);

    let dt = 0.01; // 10 ms timestep

    for i in 0..100 {
        let input = 1.0; // example sensor input
        let output = filter.update(input, dt);
        // output smoothly approaches input
    }

    filter.reset(0.0); // Reset the filter state
}
๐Ÿ“š API Reference
| Method   | Signature                                             | Description                              |
| -------- | ----------------------------------------------------- | ---------------------------------------- |
| `new`    | `LowPass1::new(initial: Float, tau: Float)`           | Creates a new low-pass filter.           |
| `update` | `update(&mut self, input: Float, dt: Float) -> Float` | Updates the filter state for a timestep. |
| `reset`  | `reset(&mut self, value: Float)`                      | Resets the filter state.                 |


Type Float = f64 (default) or f32 via feature flag.

โšก Performance & Optimization
Minimal binary size
CPU cost: constant time O(1) per update
Stack-only, zero allocations
Ideal for 100 Hz โ€“ 10 kHz control loops on MCUs
๐Ÿงช Testing

Includes tests for:

Step response stability
Zero/negative dt handling
Reset functionality

Run:

cargo test -- --nocapture
โš–๏ธ License

GPL-2.0-or-later ยฉ 2026 Jorge Andre Castro.

Free to use, modify, and distribute. Any derivative works must also be GPL-2.0-or-later.