mirror of
https://github.com/RobTillaart/Arduino.git
synced 2024-10-03 18:09:02 -04:00
0.1.4 RAIN
This commit is contained in:
parent
8c498de087
commit
df5e54a59c
@ -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.4] - 2023-11-16
|
||||||
|
- update readme.md
|
||||||
|
|
||||||
|
|
||||||
## [0.1.3] - 2023-01-19
|
## [0.1.3] - 2023-01-19
|
||||||
- update GitHub actions
|
- update GitHub actions
|
||||||
- update license 2023
|
- update license 2023
|
||||||
@ -14,7 +18,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
|
|||||||
- update readme.md
|
- update readme.md
|
||||||
- add unit tests
|
- add unit tests
|
||||||
|
|
||||||
|
|
||||||
## [0.1.2] - 2022-12-06
|
## [0.1.2] - 2022-12-06
|
||||||
- add powerPin to constructor. Optional.
|
- add powerPin to constructor. Optional.
|
||||||
- add powerPin example
|
- add powerPin example
|
||||||
@ -35,8 +38,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
|
|||||||
- add delta() => delta with previous read().
|
- add delta() => delta with previous read().
|
||||||
|
|
||||||
## [0.1.0] - 2022-12-03
|
## [0.1.0] - 2022-12-03
|
||||||
- initial version
|
- initial release
|
||||||
|
|
||||||
|
----
|
||||||
|
|
||||||
## [0.0.1] - 2021-12-??
|
## [0.0.1] - 2021-12-??
|
||||||
- experimental version (not released)
|
- experimental version (not released)
|
||||||
|
@ -2,8 +2,11 @@
|
|||||||
[![Arduino CI](https://github.com/RobTillaart/RAIN/workflows/Arduino%20CI/badge.svg)](https://github.com/marketplace/actions/arduino_ci)
|
[![Arduino CI](https://github.com/RobTillaart/RAIN/workflows/Arduino%20CI/badge.svg)](https://github.com/marketplace/actions/arduino_ci)
|
||||||
[![Arduino-lint](https://github.com/RobTillaart/RAIN/actions/workflows/arduino-lint.yml/badge.svg)](https://github.com/RobTillaart/RAIN/actions/workflows/arduino-lint.yml)
|
[![Arduino-lint](https://github.com/RobTillaart/RAIN/actions/workflows/arduino-lint.yml/badge.svg)](https://github.com/RobTillaart/RAIN/actions/workflows/arduino-lint.yml)
|
||||||
[![JSON check](https://github.com/RobTillaart/RAIN/actions/workflows/jsoncheck.yml/badge.svg)](https://github.com/RobTillaart/RAIN/actions/workflows/jsoncheck.yml)
|
[![JSON check](https://github.com/RobTillaart/RAIN/actions/workflows/jsoncheck.yml/badge.svg)](https://github.com/RobTillaart/RAIN/actions/workflows/jsoncheck.yml)
|
||||||
|
[![GitHub issues](https://img.shields.io/github/issues/RobTillaart/RAIN.svg)](https://github.com/RobTillaart/RAIN/issues)
|
||||||
|
|
||||||
[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/RobTillaart/RAIN/blob/master/LICENSE)
|
[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/RobTillaart/RAIN/blob/master/LICENSE)
|
||||||
[![GitHub release](https://img.shields.io/github/release/RobTillaart/RAIN.svg?maxAge=3600)](https://github.com/RobTillaart/RAIN/releases)
|
[![GitHub release](https://img.shields.io/github/release/RobTillaart/RAIN.svg?maxAge=3600)](https://github.com/RobTillaart/RAIN/releases)
|
||||||
|
[![PlatformIO Registry](https://badges.registry.platformio.org/packages/robtillaart/library/RAIN.svg)](https://registry.platformio.org/libraries/robtillaart/RAIN)
|
||||||
|
|
||||||
|
|
||||||
# RAIN
|
# RAIN
|
||||||
@ -13,7 +16,9 @@ RAIN is an Arduino library for a rain sensor (analog).
|
|||||||
|
|
||||||
## Description
|
## Description
|
||||||
|
|
||||||
A rain sensor like the FC-37, YL-83, HM-RD a.o. is a relative simple device.
|
**Experimental**
|
||||||
|
|
||||||
|
A rain sensor like the **FC-37, YL-83, HM-RD** a.o. is a relative simple device.
|
||||||
It measures the resistance between wires when these are put in a liquid, water or in the ground.
|
It measures the resistance between wires when these are put in a liquid, water or in the ground.
|
||||||
The device converts the resistance to a voltage typical 0 .. 5 Volt.
|
The device converts the resistance to a voltage typical 0 .. 5 Volt.
|
||||||
The more the wires are covered by the liquid, the lower the voltage.
|
The more the wires are covered by the liquid, the lower the voltage.
|
||||||
@ -23,7 +28,7 @@ The breakout (LM393 comparator) I used to test also has a digital output,
|
|||||||
which goes LOW if a threshold (to be set with a potentiometer on the breakout) is reached.
|
which goes LOW if a threshold (to be set with a potentiometer on the breakout) is reached.
|
||||||
|
|
||||||
The library is EXPERIMENTAL as it needs more testing.
|
The library is EXPERIMENTAL as it needs more testing.
|
||||||
(changes of the interface are definitely possible).
|
Changes of the interface are definitely possible.
|
||||||
|
|
||||||
|
|
||||||
## Hardware connection
|
## Hardware connection
|
||||||
@ -47,6 +52,10 @@ Typical connection
|
|||||||
|
|
||||||
## Interface
|
## Interface
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
#include "rain.h"
|
||||||
|
```
|
||||||
|
|
||||||
- **RAIN(uint8_t analogPort, uint8_t powerPin = 255)** constructor.
|
- **RAIN(uint8_t analogPort, uint8_t powerPin = 255)** constructor.
|
||||||
analogPort is the internal analog port to use.
|
analogPort is the internal analog port to use.
|
||||||
powerPin is optional, but recommended.
|
powerPin is optional, but recommended.
|
||||||
@ -137,7 +146,6 @@ For other applications it depends.
|
|||||||
- update documentation
|
- update documentation
|
||||||
- links etc.
|
- links etc.
|
||||||
|
|
||||||
|
|
||||||
#### Should
|
#### Should
|
||||||
|
|
||||||
- optimizations
|
- optimizations
|
||||||
@ -146,7 +154,6 @@ For other applications it depends.
|
|||||||
- breaking change == 0.2.0
|
- breaking change == 0.2.0
|
||||||
- level(0) should be settable too
|
- level(0) should be settable too
|
||||||
|
|
||||||
|
|
||||||
#### Could
|
#### Could
|
||||||
|
|
||||||
- add unit-tests
|
- add unit-tests
|
||||||
@ -160,7 +167,6 @@ For other applications it depends.
|
|||||||
- different liquids? which?
|
- different liquids? which?
|
||||||
- how linear is the device?
|
- how linear is the device?
|
||||||
|
|
||||||
|
|
||||||
#### Won't (unless requested)
|
#### Won't (unless requested)
|
||||||
|
|
||||||
- example with multiMap
|
- example with multiMap
|
||||||
@ -172,3 +178,12 @@ For other applications it depends.
|
|||||||
- make the number of levels configurable
|
- make the number of levels configurable
|
||||||
- dynamic array allocation.?
|
- dynamic array allocation.?
|
||||||
|
|
||||||
|
|
||||||
|
## 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,
|
||||||
|
|
||||||
|
@ -15,9 +15,9 @@
|
|||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "https://github.com/RobTillaart/RAIN.git"
|
"url": "https://github.com/RobTillaart/RAIN.git"
|
||||||
},
|
},
|
||||||
"version": "0.1.3",
|
"version": "0.1.4",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"frameworks": "arduino",
|
"frameworks": "*",
|
||||||
"platforms": "*",
|
"platforms": "*",
|
||||||
"headers": "rain.h"
|
"headers": "rain.h"
|
||||||
}
|
}
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
name=RAIN
|
name=RAIN
|
||||||
version=0.1.3
|
version=0.1.4
|
||||||
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 FC-37 analog rain sensor and compatibles.
|
sentence=Arduino library for FC-37 analog rain sensor and compatibles.
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
//
|
//
|
||||||
// FILE: rain.cpp
|
// FILE: rain.cpp
|
||||||
// AUTHOR: Rob Tillaart
|
// AUTHOR: Rob Tillaart
|
||||||
// VERSION: 0.1.3
|
// VERSION: 0.1.4
|
||||||
// DATE: 2021-12-03
|
// DATE: 2021-12-03
|
||||||
// PURPOSE: Arduino library for a rain sensor
|
// PURPOSE: Arduino library for a rain sensor
|
||||||
// URL: https://github.com/RobTillaart/RAIN
|
// URL: https://github.com/RobTillaart/RAIN
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
//
|
//
|
||||||
// FILE: rain.h
|
// FILE: rain.h
|
||||||
// AUTHOR: Rob Tillaart
|
// AUTHOR: Rob Tillaart
|
||||||
// VERSION: 0.1.3
|
// VERSION: 0.1.4
|
||||||
// DATE: 2022-11-23
|
// DATE: 2022-11-23
|
||||||
// PURPOSE: Arduino library for rain sensor (analog).
|
// PURPOSE: Arduino library for rain sensor (analog).
|
||||||
// URL: https://github.com/RobTillaart/RAIN
|
// URL: https://github.com/RobTillaart/RAIN
|
||||||
@ -12,7 +12,7 @@
|
|||||||
#include "Arduino.h"
|
#include "Arduino.h"
|
||||||
|
|
||||||
|
|
||||||
#define RAIN_LIB_VERSION (F("0.1.3"))
|
#define RAIN_LIB_VERSION (F("0.1.4"))
|
||||||
|
|
||||||
|
|
||||||
class RAIN
|
class RAIN
|
||||||
|
Loading…
Reference in New Issue
Block a user