0.3.7 Cozir

This commit is contained in:
Rob Tillaart 2023-10-19 12:07:06 +02:00
parent d7b3c7cc42
commit 3b8ea17c1e
6 changed files with 79 additions and 39 deletions

View File

@ -2,8 +2,11 @@
[![Arduino CI](https://github.com/RobTillaart/Cozir/workflows/Arduino%20CI/badge.svg)](https://github.com/marketplace/actions/arduino_ci)
[![Arduino-lint](https://github.com/RobTillaart/Cozir/actions/workflows/arduino-lint.yml/badge.svg)](https://github.com/RobTillaart/Cozir/actions/workflows/arduino-lint.yml)
[![JSON check](https://github.com/RobTillaart/Cozir/actions/workflows/jsoncheck.yml/badge.svg)](https://github.com/RobTillaart/Cozir/actions/workflows/jsoncheck.yml)
[![GitHub issues](https://img.shields.io/github/issues/RobTillaart/Cozir.svg)](https://github.com/RobTillaart/Cozir/issues)
[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/RobTillaart/Cozir/blob/master/LICENSE)
[![GitHub release](https://img.shields.io/github/release/RobTillaart/Cozir.svg?maxAge=3600)](https://github.com/RobTillaart/Cozir/releases)
[![PlatformIO Registry](https://badges.registry.platformio.org/packages/robtillaart/library/Cozir.svg)](https://registry.platformio.org/libraries/robtillaart/Cozir)
# Cozir
@ -41,10 +44,26 @@ It needs to be set to **CZR_POLLING** mode.
- Not all COZIR devices support all calls of this library.
#### Related
- https://emariete.com/en/sensor-co2-mh-z19b/
- https://emariete.com/en/sensor-co2-low-consumption-mh-z1311a-winsen/
- https://revspace.nl/MHZ19
- https://www.co2.earth/ - current outdoor CO2 level can be used for calibrating.
- https://keelingcurve.ucsd.edu/ - historical outdoor CO2 level.
- https://github.com/RobTillaart/ACD10
- https://github.com/RobTillaart/MTP40C
- https://github.com/RobTillaart/MTP40F
- https://github.com/RobTillaart/Cozir
## Interface Cozir
Read the datasheet (again).
```cpp
#include "Cozir.h"
```
Read the datasheet (again).
### Constructor and initialisation
@ -221,9 +240,10 @@ See examples.
## Future
#### must
#### Must
#### Should
#### should
- improve documentation
- COZIR Parser
- separate readme.md
@ -232,12 +252,14 @@ See examples.
- add examples
- example COZIR with I2C LCD display?
#### could
#### Could
- COZIR I2C class for newer generation
~ same functional interface
- multiWire / pin a la PCF8574 lib
#### won't
#### Won't
- add a **setEEPROMFactoryDefault()**?
- unknown if all sensors have same values
- build a Arduino COZIR simulator for testing.
@ -304,8 +326,15 @@ The remainder of the interface are getters for the different fields.
## Future
#### Must
- improve documentation
- COZIR Parser a separate readme?
#### Should
#### Could
- COZIR Parser a separate readme?
- support splitting output of Y and \* command.
- separate parser COZIRParserY()
- separate parser COZIRParserStar()
@ -313,4 +342,14 @@ The remainder of the interface are getters for the different fields.
- add examples
- examples for COZIRParser.
#### 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,

View File

@ -1,13 +1,21 @@
# Change Log Cozir
# Cozir Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).
## 0.3.6 2022-10-30
## [0.3.7] - 2023-10-19
- update readme.md (badges)
- redo changelog.md layout
## [0.3.6] - 2022-10-30
- add RP2040 to build-CI
- minor edits
## 0.3.5 2022-02-25
## [0.3.5] - 2022-02-25
- added capturing mode 'K' field in the COZIRParser class
- added all known fields in the COZIRParser class
- added sending commands in stream parser example to test.
@ -15,32 +23,27 @@
- verify requested field in **\_request()**
- minor edits.
## 0.3.4 2022-02-22
## [0.3.4] - 2022-02-22
- added COZIRParser class for streaming mode
- added streaming examples
- minor edits
## 0.3.3 2022-02-21
## [0.3.3] - 2022-02-21
- update readme.md
- update + add examples
- tested with GC0034
- changed return value of **setOperatingMode()** to bool.
- refactor
## 0.3.2 2021-12-14
## [0.3.2] - 2021-12-14
- update library.json
- license, minor edits
## 0.3.1 2021-10-20
## [0.3.1] - 2021-10-20
- update Arduino-CI
- badges in readme.md
## 0.3.0 2021-08-08
## [0.3.0] - 2021-08-08
- Major update - breaks interface (names mainly)
- add **isInitialized()**
- add **getOperatingMode()**
@ -53,40 +56,40 @@
----
## 0.2.6 2021-01-31
## [0.2.6] - 2021-01-31
- fix #4 use Mode0 for versions and configuration
## 0.2.5 2020-12-26
## [0.2.5] - 2020-12-26
- fix software Serial + version number (oops)
## 0.2.2 2020-12-17
## [0.2.2] - 2020-12-17
- add Arduino-CI + unit tests
## 0.2.1 2020-06-05
## [0.2.1] - 2020-06-05
- fix library.json
## 0.2.0 2020-03-30
## [0.2.0] - 2020-03-30
- some refactor and own repo
-----
## 0.1.06
## [0.1.06]
- added support for HardwareSerial for MEGA
- removed support for NewSoftSerial
- stop pre 1.0 support)
## 0.1.05
## [0.1.05]
- fixed bug uint16_t request() to uint32_t request() in .h file
## 0.1.04
## [0.1.04]
- changed CO2 to support larger values
## 0.1.03
## [0.1.03]
- added setOperatingMode
## 0.1.02
## [0.1.02]
- added support Arduino 1.x
## 0.1.01
## [0.1.01] - 2012-??-??
- initial version

View File

@ -1,14 +1,12 @@
//
// FILE: Cozir.cpp
// AUTHOR: DirtGambit & Rob Tillaart
// VERSION: 0.3.6
// VERSION: 0.3.7
// PURPOSE: library for COZIR range of sensors for Arduino
// Polling Mode + stream parser
// URL: https://github.com/RobTillaart/Cozir
// http://forum.arduino.cc/index.php?topic=91467.0
//
// HISTORY: see changelog.md
//
// READ DATASHEET BEFORE USE OF THIS LIB !
//

View File

@ -1,7 +1,7 @@
#pragma once
//
// FILE: Cozir.h
// VERSION: 0.3.6
// VERSION: 0.3.7
// PURPOSE: library for COZIR range of sensors for Arduino
// Polling Mode + stream parser
// URL: https://github.com/RobTillaart/Cozir
@ -14,7 +14,7 @@
#include "Arduino.h"
#define COZIR_LIB_VERSION (F("0.3.6"))
#define COZIR_LIB_VERSION (F("0.3.7"))
// OUTPUT FIELDS

View File

@ -18,9 +18,9 @@
"type": "git",
"url": "https://github.com/RobTillaart/Cozir.git"
},
"version": "0.3.6",
"version": "0.3.7",
"license": "MIT",
"frameworks": "arduino",
"frameworks": "*",
"platforms": "*",
"headers": "cozir.h"
}

View File

@ -1,5 +1,5 @@
name=Cozir
version=0.3.6
version=0.3.7
author=Rob Tillaart <rob.tillaart@gmail.com>, DirtGambit
maintainer=Rob Tillaart <rob.tillaart@gmail.com>
sentence=Arduino library for COZIR range of CO2 sensors. Polling mode only.