simple-pid-controller/README.md

A simple application to demonstrate the usage of a PID Controller with examples

# PID Controller

A Proportional-Integral-Derivative (PID) controller is a control loop feedback mechanism widely used in industrial control systems. This module provides a PID controller implementation in Node.js.

## Installation

To install this module, run the following command:

```sh
npm install pid-controller
```

## Usage

First, require the module:

```javascript
const PIDController = require('simple-pid-controller');
```

Then, create a new PIDController instance. You can optionally provide proportional, integral, and derivative gains:

```javascript
const controller = new PIDController(1.2, 1, 0.01);
```

You can set a new target for the controller:

```javascript
controller.setTarget(34);
```

And you can update the controller with the current value to get the control output:

```javascript
let power = controller.update(currentValue);
```

## API

This module exports the `PIDController` class, which has the following methods:

- `constructor(k_p = 1.0, k_i = 0.0, k_d = 0.0)`: Constructs a new PIDController.

- `setTarget(target)`: Sets a new target for the controller.

- `update(currentValue)`: Updates the controller with the current value and calculates the control output.

## Applications

PID controllers are used in a wide variety of applications in industrial control systems and other areas, including:

- Controlling the temperature of an oven
- Regulating the speed of a car
- Managing the flight controls of an airplane
- Controlling the power output of a generator

By using this module, developers can implement PID control in their Node.js applications without having to understand all of the underlying mathematics.

## License

This module is licensed under the Apache License.

## Author

Harshad Joshi @ Bufferstack.IO Analytics Technology LLP, Pune