Skip to content

Commit

Permalink
update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
RobTillaart committed Nov 22, 2023
1 parent 4ae40ba commit 1204650
Show file tree
Hide file tree
Showing 6 changed files with 42 additions and 15 deletions.
6 changes: 5 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,18 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).


## [0.1.3] - 2023-11-22
- update readme.md
- fix version number


## [0.1.2] - 2022-11-26
- Add RP2040 support to build-CI.
- Add CHANGELOG.md
- update readme.md
- minor edits
- update unit test


## [0.1.1] - 2021-12-29
- update library.json
- update readme.md
Expand Down
33 changes: 28 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@

[![Arduino CI](https://github.com/RobTillaart/tinySHT2x/actions/workflows/arduino_test_runner.yml/badge.svg)](https://github.com/RobTillaart/tinySHT2x/actions/workflows/arduino_test_runner.yml)
[![Arduino CI](https://github.com/RobTillaart/tinySHT2x/workflows/Arduino%20CI/badge.svg)](https://github.com/marketplace/actions/arduino_ci)
[![Arduino-lint](https://github.com/RobTillaart/tinySHT2x/actions/workflows/arduino-lint.yml/badge.svg)](https://github.com/RobTillaart/tinySHT2x/actions/workflows/arduino-lint.yml)
[![JSON check](https://github.com/RobTillaart/tinySHT2x/actions/workflows/jsoncheck.yml/badge.svg)](https://github.com/RobTillaart/tinySHT2x/actions/workflows/jsoncheck.yml)
[![GitHub issues](https://img.shields.io/github/issues/RobTillaart/tinySHT2x.svg)](https://github.com/RobTillaart/tinySHT2x/issues)

[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/RobTillaart/tinySHT2x/blob/master/LICENSE)
[![GitHub release](https://img.shields.io/github/release/RobTillaart/tinySHT2x.svg?maxAge=3600)](https://github.com/RobTillaart/tinySHT2x/releases)
[![PlatformIO Registry](https://badges.registry.platformio.org/packages/robtillaart/library/tinySHT2x.svg)](https://registry.platformio.org/libraries/robtillaart/tinySHT2x)


# tinySHT2x
Expand All @@ -13,29 +16,49 @@ Arduino library specific for AVR tiny processors.

## Description

Experimental ^2
**Experimental**

Not portable, AVR only

#### Related

Based upon https://github.com/RobTillaart/SHT2x


## Interface

```cpp
#include "tinySHT2x.h"
```

- see https://github.com/RobTillaart/SHT2x


## Future

#### must
#### Must

- test test test test (Viktor)
- improve documentation

#### should
#### Should

#### Could

#### could
- Can a tiny have another Wire than Wire?
- Check the status bit (temperature / humidity flag)
- datasheet page 8, LSB bit 1 - bit 0 not used)
- needed?
- Move Wire parameter to constructor?


#### Wont


## 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,
4 changes: 2 additions & 2 deletions library.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@
"type": "git",
"url": "https://github.com/RobTillaart/tinySHT2x.git"
},
"version": "0.1.2",
"version": "0.1.3",
"license": "MIT",
"frameworks": "arduino",
"platforms": "*",
"platforms": "avr",
"headers": "tinySHT2x.h"
}
4 changes: 2 additions & 2 deletions library.properties
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
name=tinySHT2x
version=0.1.2
version=0.1.3
author=Rob Tillaart <rob.tillaart@gmail.com>
maintainer=Rob Tillaart <rob.tillaart@gmail.com>
sentence=Arduino library for the SHT20, SHT21 and SHT25 temperature and humidity sensor. Optimized for AVR tiny.
paragraph=Supports SHT20 and SHT25 too.
category=Sensors
url=https://github.com/RobTillaart/tinySHT2x
architectures=*
architectures=avr
includes=tinySHT2x.h
depends=
4 changes: 2 additions & 2 deletions tinySHT2x.cpp
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
//
// FILE: tinytinySHT2x.cpp
// AUTHOR: Rob Tillaart, Viktor Balint
// VERSION: 0.1.2
// VERSION: 0.1.3
// DATE: 2021-09-27
// PURPOSE: Arduino library for the SHT2x temperature and humidity sensor optimized for AVR tiny
// URL: https://github.com/RobTillaart/tinytinySHT2x
Expand Down Expand Up @@ -92,7 +92,7 @@ bool tinySHT2x::readBytes(uint8_t n, uint8_t *val, uint8_t maxDuration)
uint32_t start = millis();
while (_wire->available() < n)
{
if (millis() - start > maxDuration)
if (millis() - start > maxDuration)
{
return false;
}
Expand Down
6 changes: 3 additions & 3 deletions tinySHT2x.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
//
// FILE: tinySHT2x.h
// AUTHOR: Rob Tillaart, Viktor Balint
// VERSION: 0.1.1
// VERSION: 0.1.3
// DATE: 2021-09-27
// PURPOSE: Arduino library for the SHT2x temperature and humidity sensor optimized for AVR tiny
// URL: https://github.com/RobTillaart/tinySHT2x
Expand All @@ -12,7 +12,7 @@
#include "Arduino.h"
#include "Wire.h"

#define TINY_SHT2x_LIB_VERSION (F("0.1.1"))
#define TINY_SHT2x_LIB_VERSION (F("0.1.3"))

#define TINY_SHT2x_NO_VALUE -999

Expand All @@ -34,5 +34,5 @@ class tinySHT2x
};


// -- END OF FILE --
// -- END OF FILE --

0 comments on commit 1204650

Please sign in to comment.