mirror of
https://github.com/RobTillaart/Arduino.git
synced 2024-09-19 16:46:11 -04:00
0.1.5 SRF05
This commit is contained in:
parent
bdfd037b3e
commit
8b96d867ad
@ -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/).
|
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
|
## [0.1.4] - 2023-03-15
|
||||||
- add **uint32_t lastTime()**
|
- add **uint32_t lastTime()**
|
||||||
- changed return type **bool setCorrectionFactor()**
|
- changed return type **bool setCorrectionFactor()**
|
||||||
@ -16,7 +20,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
|
|||||||
- update license 2023
|
- update license 2023
|
||||||
- minor edits
|
- minor edits
|
||||||
|
|
||||||
|
|
||||||
## [0.1.3] - 2022-11-25
|
## [0.1.3] - 2022-11-25
|
||||||
- Add RP2040 support to build-CI.
|
- Add RP2040 support to build-CI.
|
||||||
- Add CHANGELOG.md
|
- Add CHANGELOG.md
|
||||||
|
@ -2,8 +2,11 @@
|
|||||||
[![Arduino CI](https://github.com/RobTillaart/SRF05/workflows/Arduino%20CI/badge.svg)](https://github.com/marketplace/actions/arduino_ci)
|
[![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)
|
[![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)
|
[![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)
|
[![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)
|
[![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
|
# SRF05
|
||||||
@ -74,7 +77,6 @@ speed of sound however it is technically more correct to keep the two separated.
|
|||||||
#include "SRF05.h"
|
#include "SRF05.h"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
#### Constructor
|
#### Constructor
|
||||||
|
|
||||||
- **SRF05(const uint8_t trigger, const uint8_t echo, const uint8_t out = 0)** constructor to set the trigger and echo pin.
|
- **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.
|
- investigate purpose/possibilities of the OUT pin.
|
||||||
|
|
||||||
|
|
||||||
#### Should
|
#### Should
|
||||||
|
|
||||||
- add examples
|
- add examples
|
||||||
@ -197,14 +198,12 @@ See examples.
|
|||||||
- should **setSpeedOfSound(float sos)** return bool if sos <=0 ?
|
- should **setSpeedOfSound(float sos)** return bool if sos <=0 ?
|
||||||
- value of **setTriggerLength()**
|
- value of **setTriggerLength()**
|
||||||
|
|
||||||
|
|
||||||
#### Could
|
#### Could
|
||||||
|
|
||||||
- set default SOS to an SOS from the table instead of 340.
|
- set default SOS to an SOS from the table instead of 340.
|
||||||
- add example to determine the correction factor?
|
- add example to determine the correction factor?
|
||||||
- delay(1) in average configurable?
|
- delay(1) in average configurable?
|
||||||
|
|
||||||
|
|
||||||
#### Wont
|
#### Wont
|
||||||
|
|
||||||
- print feet as 3'2" or 3-7/8 feet (is that needed in this lib)
|
- 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()``` ?
|
- add ```float lastValue()``` ?
|
||||||
- not all paths update this variable.
|
- not all paths update this variable.
|
||||||
- add ```float delta()``` difference with last value.
|
- 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,
|
||||||
|
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
//
|
//
|
||||||
// FILE: SRF05.cpp
|
// FILE: SRF05.cpp
|
||||||
// AUTHOR: Rob Tillaart
|
// AUTHOR: Rob Tillaart
|
||||||
// VERSION: 0.1.4
|
// VERSION: 0.1.5
|
||||||
// DATE: 2021-05-17
|
// DATE: 2021-05-17
|
||||||
// PURPOSE: Arduino library for the SRF05 distance sensor (and compatibles)
|
// PURPOSE: Arduino library for the SRF05 distance sensor (and compatibles)
|
||||||
// URL: https://github.com/RobTillaart/SRF05
|
// URL: https://github.com/RobTillaart/SRF05
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
//
|
//
|
||||||
// FILE: SRF05.h
|
// FILE: SRF05.h
|
||||||
// AUTHOR: Rob Tillaart
|
// AUTHOR: Rob Tillaart
|
||||||
// VERSION: 0.1.4
|
// VERSION: 0.1.5
|
||||||
// DATE: 2021-05-17
|
// DATE: 2021-05-17
|
||||||
// PURPOSE: Arduino library for SRF05 distance sensor
|
// PURPOSE: Arduino library for SRF05 distance sensor
|
||||||
// URL: https://github.com/RobTillaart/SRF05
|
// URL: https://github.com/RobTillaart/SRF05
|
||||||
@ -10,7 +10,7 @@
|
|||||||
|
|
||||||
#include "Arduino.h"
|
#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;
|
const uint8_t SRF05_MODE_SINGLE = 0;
|
||||||
|
@ -15,9 +15,9 @@
|
|||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "https://github.com/RobTillaart/SRF05.git"
|
"url": "https://github.com/RobTillaart/SRF05.git"
|
||||||
},
|
},
|
||||||
"version": "0.1.4",
|
"version": "0.1.5",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"frameworks": "arduino",
|
"frameworks": "*",
|
||||||
"platforms": "*",
|
"platforms": "*",
|
||||||
"headers": "SRF05.h"
|
"headers": "SRF05.h"
|
||||||
}
|
}
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
name=SRF05
|
name=SRF05
|
||||||
version=0.1.4
|
version=0.1.5
|
||||||
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 SRF05 distance sensor
|
sentence=Arduino library for SRF05 distance sensor
|
||||||
|
Loading…
Reference in New Issue
Block a user