mirror of
https://github.com/RobTillaart/Arduino.git
synced 2024-09-19 16:46:11 -04:00
0.1.2 PERIPUMP
This commit is contained in:
parent
0793832e5a
commit
13f62d5d5a
@ -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/).
|
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)
|
- add parameter to begin(float percentage)
|
||||||
- refactored stop()
|
- refactored stop()
|
||||||
- refactored setPercentage()
|
- refactored setPercentage()
|
||||||
@ -18,9 +22,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
|
|||||||
- add setInvert(flag = false)
|
- add setInvert(flag = false)
|
||||||
- updated readme.md
|
- updated readme.md
|
||||||
|
|
||||||
|
|
||||||
## [0.1.0] - 2022-10-13
|
## [0.1.0] - 2022-10-13
|
||||||
|
|
||||||
- initial version
|
- initial version
|
||||||
- add stop(), get- and setPercentage()
|
- add stop(), get- and setPercentage()
|
||||||
- add getSeconds(), resetSeconds() for simple duration management.
|
- add getSeconds(), resetSeconds() for simple duration management.
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
//
|
//
|
||||||
// FILE: PERIPUMP.cpp
|
// FILE: PERIPUMP.cpp
|
||||||
// AUTHOR: Rob Tillaart
|
// AUTHOR: Rob Tillaart
|
||||||
// VERSION: 0.1.1
|
// VERSION: 0.1.2
|
||||||
// DATE: 2022-10-13
|
// DATE: 2022-10-13
|
||||||
// PURPOSE: Arduino library for peristaltic pump
|
// PURPOSE: Arduino library for peristaltic pump
|
||||||
|
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
//
|
//
|
||||||
// FILE: PERIPUMP.h
|
// FILE: PERIPUMP.h
|
||||||
// AUTHOR: Rob Tillaart
|
// AUTHOR: Rob Tillaart
|
||||||
// VERSION: 0.1.1
|
// VERSION: 0.1.2
|
||||||
// DATE: 2022-10-13
|
// DATE: 2022-10-13
|
||||||
// PURPOSE: Arduino library for peristaltic pump
|
// PURPOSE: Arduino library for peristaltic pump
|
||||||
//
|
//
|
||||||
@ -13,7 +13,7 @@
|
|||||||
#include "Arduino.h"
|
#include "Arduino.h"
|
||||||
#include "Servo.h"
|
#include "Servo.h"
|
||||||
|
|
||||||
#define PERIPUMP_LIB_VERSION (F("0.1.1"))
|
#define PERIPUMP_LIB_VERSION (F("0.1.2"))
|
||||||
|
|
||||||
|
|
||||||
class PERIPUMP
|
class PERIPUMP
|
||||||
|
@ -2,8 +2,11 @@
|
|||||||
[![Arduino CI](https://github.com/RobTillaart/PERIPUMP/workflows/Arduino%20CI/badge.svg)](https://github.com/marketplace/actions/arduino_ci)
|
[![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)
|
[![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)
|
[![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)
|
[![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)
|
[![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
|
# PERIPUMP
|
||||||
@ -13,7 +16,7 @@ Arduino library for peristaltic pump DFR0523 and compatibles.
|
|||||||
|
|
||||||
## Description
|
## 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.
|
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.
|
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
|
## Interface
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
#include "PERIPUMP.h"
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
### Base
|
### Base
|
||||||
|
|
||||||
- **PERIPUMP(uint8_t pumpPin)** constructor. pumpPin should be a PWM supporting pin.
|
- **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)
|
#### Must (next release)
|
||||||
|
|
||||||
|
- documentation
|
||||||
- investigate calibration process
|
- investigate calibration process
|
||||||
- function to set the ranges for percentage.
|
- function to set the ranges for percentage.
|
||||||
- four values needed 500-VAR1 VAR2-2500
|
- four values needed 500-VAR1 VAR2-2500
|
||||||
- defaults for these variables.
|
- defaults for these variables.
|
||||||
- could that be command line #defines?
|
- could that be command line #defines?
|
||||||
|
|
||||||
|
|
||||||
#### Should
|
#### Should
|
||||||
|
|
||||||
- update readme.md
|
|
||||||
- test more
|
- test more
|
||||||
- examples
|
- examples
|
||||||
- investigate flow rate == (non) linear
|
- investigate flow rate == (non) linear
|
||||||
- investigate startup behaviour (had some hickups)
|
- investigate startup behaviour (had some hickups)
|
||||||
|
|
||||||
|
|
||||||
#### Could
|
#### Could
|
||||||
|
|
||||||
- investigate flow support
|
- investigate flow support
|
||||||
@ -130,7 +136,6 @@ The examples show the basic working of the functions.
|
|||||||
- at full speed only?
|
- at full speed only?
|
||||||
- linear / non linear interpolatable (multiMap).
|
- linear / non linear interpolatable (multiMap).
|
||||||
|
|
||||||
|
|
||||||
#### Won't (for now lowest prio)
|
#### Won't (for now lowest prio)
|
||||||
|
|
||||||
- unit test possible?
|
- unit test possible?
|
||||||
@ -143,3 +148,13 @@ The examples show the basic working of the functions.
|
|||||||
- sum += time x speed - is that better?
|
- sum += time x speed - is that better?
|
||||||
- two counters needed, one per direction
|
- two counters needed, one per direction
|
||||||
- **incr()** and **decr()** as they are direction dependant.
|
- **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,
|
||||||
|
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
# Syntax Colouring Map For peristaltic
|
# Syntax Colouring Map For PERIPUMP
|
||||||
|
|
||||||
# Data types (KEYWORD1)
|
# Data types (KEYWORD1)
|
||||||
PERIPUMP KEYWORD1
|
PERIPUMP KEYWORD1
|
||||||
|
@ -15,9 +15,9 @@
|
|||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "https://github.com/RobTillaart/PERIPUMP.git"
|
"url": "https://github.com/RobTillaart/PERIPUMP.git"
|
||||||
},
|
},
|
||||||
"version": "0.1.1",
|
"version": "0.1.2",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"frameworks": "arduino",
|
"frameworks": "*",
|
||||||
"platforms": "*",
|
"platforms": "*",
|
||||||
"headers": "PERIPUMP.h"
|
"headers": "PERIPUMP.h"
|
||||||
}
|
}
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
name=PERIPUMP
|
name=PERIPUMP
|
||||||
version=0.1.1
|
version=0.1.2
|
||||||
author=Rob Tillaart <rob.tillaart@gmail.com>
|
author=Rob Tillaart <rob.tillaart@gmail.com>
|
||||||
maintainer=Rob Tillaart <rob.tillaart@gmail.com>
|
maintainer=Rob Tillaart <rob.tillaart@gmail.com>
|
||||||
sentence=Arduino library for peristaltic pump DFR0523 and compatibles.
|
sentence=Arduino library for peristaltic pump DFR0523 and compatibles.
|
||||||
|
Loading…
Reference in New Issue
Block a user