Winsen Sensors製 NDIR方式 CO2センサーモジュール、MH-Z19シリーズ用のライブラリです。
Arduino Frameworkが利用可能な各種ボード/MCUでMH-Z19シリーズを動作させることができます。
examplesディレクトリから、各ボード/MCU向けのサンプルコードを閲覧できます。
The sample codes for various boards/MCUs can be found in the examples directory.
Arduino Framework用のライブラリです。 PlatformIOでの動作を確認していますが、Arduino IDEでも動作が期待できます。
This library has been tested with PlatformIO, is also expected to work with the Arduino IDE.
MH-Z19はPWM信号/シリアル通信の二種類で計測値を取得できますが、現時点では本ライブラリはシリアル通信のみをサポートしています。
This library only supports retrieving measurement values by the serial communication. Retrieving measurement values from the PWM signals is not supported.
以下のようなAPIでセンサモジュールの操作を行うことができます。
現時点では、MH-Z19シリーズがサポートするCO2濃度の読み取り(コマンド0x86)および、セルフキャリブレーションの有効化/無効化の設定(コマンド0x79)のみをサポートしています。
#include <Arduino.h>
#include <MHZ19X.h>
// MH-Z19Cセンサモジュールを操作するインスタンスを作成
auto co2sensor = MHZ19C(); // Arduinoおよび同互換ボードの場合
// auto co2sensor = MHZ19C_UART1(); // ESP32の場合
void setup()
{
co2sensor.begin();
// セルフキャリブレーションをオンにする
co2sensor.switchSelfCalibration(true);
}
void loop()
{
uint16_t co2ppm;
MHZ19X_error_t result;
// CO2濃度を取得する
result = co2sensor.getCO2Concentration(co2ppm);
if (MHZ19X_error_t::success == result) {
// 取得に成功した場合、「なんらかのディスプレイ」に測定値を表示する
// display.print(co2ppm);
}
delay(3000);
}Important
センサモジュールを操作する型の名前は、Arduinoおよび同互換ボードではMHZ19Cとなりますが、これはボード/MCUごとに異なります。 詳細はexamplesディレクトリにあるボード/MCUごとのサンプルコードを参照してください。
Important
The type name for the sensor module is MHZ19C for Arduino-compatible boards. This type name, however, depends on the board/MCU. See examples for the actual type names.
本ライブラリでは、さまざまなボード/MCUで動作させられるよう、UARTシリアル通信を任意の実装に差し替えられるようにしています。 具体的には、MHZ19XDriverクラスのテンプレートパラメータTUartStreamに任意の実装を指定することができます。
デフォルトでは、標準で使用できるシリアル通信を利用しますが、必要に応じてUARTシリアル通信の実装を差し替えることにより、任意のGPIOピンを使用するように変更することもできます。
Note
標準のシリアル通信が利用できない場合は、ライブラリでのフォールバック実装としてSloppySoftwareSerialStreamが利用可能です。
ただし、これはdigitalRead(), digitalWrite()およびdelayMicroseconds()を使用した雑な実装であり、動作が安定せず期待する結果を得られない場合があります。
- MH-Z19C
- MH-Z19E
Note
他のセンサーモジュールでも動作する可能性はありますが、実機での動作は未検証です。 Also the library may work with other sensor modules, but has not been tested with actual modules.
| Module | Image | Details |
|---|---|---|
| MH-Z19C |  |
https://www.winsen-sensor.com/sensors/co2-sensor/mh-z19c.html |
| MH-Z19E |  |
https://www.winsen-sensor.com/sensors/co2-sensor/mh-z19e.html |
- ESP32
- ESP32-WROOM-32
- ATtiny
- ATtiny 402
- ATtiny 404
- Arduino
- Arduino Nano
- Arduino Nano Every
Important
ATtinyで動作させる場合、20 MHzまたは16 MHzで動作させることを推奨します。 それより低い動作周波数では、シリアル通信が安定しません。
これはシリアル通信に使用している実装が雑な実装であるためです。 delayMicrosecondsに渡す値の調整により改善する場合もありますが、電源電圧の影響を受ける場合もあり、調整の難易度は高いです。
ATtinyで動作する、より良いシリアル通信を実装してくれる方がいましたら、ぜひIssuesにてご提案ください。
- Parts:Sensor:MH-Z19C - robot-jp wiki
- https://github.com/SpenceKonde/megaTinyCore/blob/master/megaavr/extras/PlatformIO.md
Contributions are appreciated!
If there's a feature you would like to add or a bug you would like to fix, please read Contribution guidelines and create an Issue or Pull Request.
IssueやPull Requestを送る際は、Contribution guidelinesをご覧頂ください。 使用言語は日本語で構いません。
(An English translation for the reference follows the text written in Japanese.)
本プロジェクトはMIT Licenseの条件に基づきライセンスされています。
This project is licensed under the terms of the MIT License.
本プロジェクトは、MH-Z19シリーズの製造元・供給元・販売元とは無関係の、非公式なものです。
This is an unofficial project that has no affiliation with the manufacturers/vendors/suppliers of MH-Z19 series.