0.1.5 SRF05

This commit is contained in:
Rob Tillaart 2023-11-22 11:12:31 +01:00
parent bdfd037b3e
commit 8b96d867ad
6 changed files with 24 additions and 12 deletions

View File

@ -6,6 +6,10 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).
## [0.1.5] - 2023-11-22
- update readme.md
## [0.1.4] - 2023-03-15
- add **uint32_t lastTime()**
- changed return type **bool setCorrectionFactor()**
@ -16,7 +20,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
- update license 2023
- minor edits
## [0.1.3] - 2022-11-25
- Add RP2040 support to build-CI.
- Add CHANGELOG.md

View File

@ -2,8 +2,11 @@
[![Arduino CI](https://github.com/RobTillaart/SRF05/workflows/Arduino%20CI/badge.svg)](https://github.com/marketplace/actions/arduino_ci)
[![Arduino-lint](https://github.com/RobTillaart/SRF05/actions/workflows/arduino-lint.yml/badge.svg)](https://github.com/RobTillaart/SRF05/actions/workflows/arduino-lint.yml)
[![JSON check](https://github.com/RobTillaart/SRF05/actions/workflows/jsoncheck.yml/badge.svg)](https://github.com/RobTillaart/SRF05/actions/workflows/jsoncheck.yml)
[![GitHub issues](https://img.shields.io/github/issues/RobTillaart/SRF05.svg)](https://github.com/RobTillaart/SRF05/issues)
[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/RobTillaart/SRF05/blob/master/LICENSE)
[![GitHub release](https://img.shields.io/github/release/RobTillaart/SRF05.svg?maxAge=3600)](https://github.com/RobTillaart/SRF05/releases)
[![PlatformIO Registry](https://badges.registry.platformio.org/packages/robtillaart/library/SRF05.svg)](https://registry.platformio.org/libraries/robtillaart/SRF05)
# SRF05
@ -74,7 +77,6 @@ speed of sound however it is technically more correct to keep the two separated.
#include "SRF05.h"
```
#### Constructor
- **SRF05(const uint8_t trigger, const uint8_t echo, const uint8_t out = 0)** constructor to set the trigger and echo pin.
@ -187,7 +189,6 @@ See examples.
- investigate purpose/possibilities of the OUT pin.
#### Should
- add examples
@ -197,14 +198,12 @@ See examples.
- should **setSpeedOfSound(float sos)** return bool if sos <=0 ?
- value of **setTriggerLength()**
#### Could
- set default SOS to an SOS from the table instead of 340.
- add example to determine the correction factor?
- delay(1) in average configurable?
#### Wont
- print feet as 3'2" or 3-7/8 feet (is that needed in this lib)
@ -213,4 +212,14 @@ See examples.
- add ```float lastValue()``` ?
- not all paths update this variable.
- add ```float delta()``` difference with last value.
- how to handle different units? or only time?
- how to handle different units? or only time?
## 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,7 +1,7 @@
//
// FILE: SRF05.cpp
// AUTHOR: Rob Tillaart
// VERSION: 0.1.4
// VERSION: 0.1.5
// DATE: 2021-05-17
// PURPOSE: Arduino library for the SRF05 distance sensor (and compatibles)
// URL: https://github.com/RobTillaart/SRF05

View File

@ -2,7 +2,7 @@
//
// FILE: SRF05.h
// AUTHOR: Rob Tillaart
// VERSION: 0.1.4
// VERSION: 0.1.5
// DATE: 2021-05-17
// PURPOSE: Arduino library for SRF05 distance sensor
// URL: https://github.com/RobTillaart/SRF05
@ -10,7 +10,7 @@
#include "Arduino.h"
#define SRF05_LIB_VERSION (F("0.1.4"))
#define SRF05_LIB_VERSION (F("0.1.5"))
const uint8_t SRF05_MODE_SINGLE = 0;

View File

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

View File

@ -1,5 +1,5 @@
name=SRF05
version=0.1.4
version=0.1.5
author=Rob Tillaart <rob.tillaart@gmail.com>
maintainer=Rob Tillaart <rob.tillaart@gmail.com>
sentence=Arduino library for SRF05 distance sensor