0.1.2 PERIPUMP

This commit is contained in:
Rob Tillaart 2023-11-14 17:36:39 +01:00
parent 0793832e5a
commit 13f62d5d5a
7 changed files with 34 additions and 17 deletions

View File

@ -6,8 +6,12 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).
## [0.1.1] - 2022-10-14
## [0.1.2] - 2023-11-14
- update readme.md
- update keywords.txt
## [0.1.1] - 2022-10-14
- add parameter to begin(float percentage)
- refactored stop()
- refactored setPercentage()
@ -18,9 +22,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
- add setInvert(flag = false)
- updated readme.md
## [0.1.0] - 2022-10-13
- initial version
- add stop(), get- and setPercentage()
- add getSeconds(), resetSeconds() for simple duration management.

View File

@ -1,7 +1,7 @@
//
// FILE: PERIPUMP.cpp
// AUTHOR: Rob Tillaart
// VERSION: 0.1.1
// VERSION: 0.1.2
// DATE: 2022-10-13
// PURPOSE: Arduino library for peristaltic pump
@ -118,5 +118,5 @@ float PERIPUMP::resetRunTime()
}
// -- END OF FILE --
// -- END OF FILE --

View File

@ -2,7 +2,7 @@
//
// FILE: PERIPUMP.h
// AUTHOR: Rob Tillaart
// VERSION: 0.1.1
// VERSION: 0.1.2
// DATE: 2022-10-13
// PURPOSE: Arduino library for peristaltic pump
//
@ -13,7 +13,7 @@
#include "Arduino.h"
#include "Servo.h"
#define PERIPUMP_LIB_VERSION (F("0.1.1"))
#define PERIPUMP_LIB_VERSION (F("0.1.2"))
class PERIPUMP
@ -59,5 +59,5 @@ private:
};
// -- END OF FILE --
// -- END OF FILE --

View File

@ -2,8 +2,11 @@
[![Arduino CI](https://github.com/RobTillaart/PERIPUMP/workflows/Arduino%20CI/badge.svg)](https://github.com/marketplace/actions/arduino_ci)
[![Arduino-lint](https://github.com/RobTillaart/PERIPUMP/actions/workflows/arduino-lint.yml/badge.svg)](https://github.com/RobTillaart/PERIPUMP/actions/workflows/arduino-lint.yml)
[![JSON check](https://github.com/RobTillaart/PERIPUMP/actions/workflows/jsoncheck.yml/badge.svg)](https://github.com/RobTillaart/PERIPUMP/actions/workflows/jsoncheck.yml)
[![GitHub issues](https://img.shields.io/github/issues/RobTillaart/PERIPUMP.svg)](https://github.com/RobTillaart/PERIPUMP/issues)
[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/RobTillaart/PERIPUMP/blob/master/LICENSE)
[![GitHub release](https://img.shields.io/github/release/RobTillaart/PERIPUMP.svg?maxAge=3600)](https://github.com/RobTillaart/PERIPUMP/releases)
[![PlatformIO Registry](https://badges.registry.platformio.org/packages/robtillaart/library/PERIPUMP.svg)](https://registry.platformio.org/libraries/robtillaart/PERIPUMP)
# PERIPUMP
@ -13,7 +16,7 @@ Arduino library for peristaltic pump DFR0523 and compatibles.
## Description
VERY EXPERIMENTAL - AVR (UNO) only for now.
**VERY EXPERIMENTAL - AVR (UNO) only for now**
The DFR0523 is a peristaltic pump which can be controlled by a PWM signal.
This PWM (Pulse Width Modulation) is provided by the Arduino Servo library.
@ -66,6 +69,11 @@ This implies an external power supply of 5 (or 6) volts is mandatory.
## Interface
```cpp
#include "PERIPUMP.h"
```
### Base
- **PERIPUMP(uint8_t pumpPin)** constructor. pumpPin should be a PWM supporting pin.
@ -107,22 +115,20 @@ The examples show the basic working of the functions.
#### Must (next release)
- documentation
- investigate calibration process
- function to set the ranges for percentage.
- four values needed 500-VAR1 VAR2-2500
- defaults for these variables.
- could that be command line #defines?
#### Should
- update readme.md
- test more
- examples
- investigate flow rate == (non) linear
- investigate startup behaviour (had some hickups)
#### Could
- investigate flow support
@ -130,7 +136,6 @@ The examples show the basic working of the functions.
- at full speed only?
- linear / non linear interpolatable (multiMap).
#### Won't (for now lowest prio)
- unit test possible?
@ -143,3 +148,13 @@ The examples show the basic working of the functions.
- sum += time x speed - is that better?
- two counters needed, one per direction
- **incr()** and **decr()** as they are direction dependant.
## Support
If you appreciate my libraries, you can support the development and maintenance.
Improve the quality of the libraries by providing issues and Pull Requests, or
donate through PayPal or GitHub sponsors.
Thank you,

View File

@ -1,4 +1,4 @@
# Syntax Colouring Map For peristaltic
# Syntax Colouring Map For PERIPUMP
# Data types (KEYWORD1)
PERIPUMP KEYWORD1

View File

@ -15,9 +15,9 @@
"type": "git",
"url": "https://github.com/RobTillaart/PERIPUMP.git"
},
"version": "0.1.1",
"version": "0.1.2",
"license": "MIT",
"frameworks": "arduino",
"frameworks": "*",
"platforms": "*",
"headers": "PERIPUMP.h"
}

View File

@ -1,5 +1,5 @@
name=PERIPUMP
version=0.1.1
version=0.1.2
author=Rob Tillaart <rob.tillaart@gmail.com>
maintainer=Rob Tillaart <rob.tillaart@gmail.com>
sentence=Arduino library for peristaltic pump DFR0523 and compatibles.