8000 sensor/mhz19: Add driver for MH-Z19 (CO2 sensor). by jimmo · Pull Request #575 · micropython/micropython-lib · GitHub
[go: up one dir, main page]

Skip to content

sensor/mhz19: Add driver for MH-Z19 (CO2 sensor). #575

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 15, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions micropython/drivers/sensor/mhz19/manifest.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
metadata(description="Driver for MH-Z19 CO2 sensor.", version="0.1.0")

module("mhz19.py", opt=3)
48 changes: 48 additions & 0 deletions micropython/drivers/sensor/mhz19/mhz19.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# MH-Z19 CO2 sensor driver for MicroPython.
# MIT license; Copyright (c) 2018 Fredrik Strupe

import machine
import utime


class TimeoutError(Exception):
pass


class MHZ19:
"""MH-Z19 CO2 sensor driver"""

def __init__(self, pin, max_value=5000):
"""
Args:
pin: the pin that the PWM pin on the MH-Z19 is connected to.
max_value: upper bound of measuring range. usually 2000 or 5000.
"""
self.pin = pin
self.max_value = max_value

def _wait_on_condition(self, cond, timeout=5000):
start = utime.ticks_ms()
while not cond():
if utime.ticks_diff(utime.ticks_ms(), start) > timeout:
raise TimeoutError

def pwm_read(self):
"""Read CO2 value via PWM pin.

Reading usually takes 1-2 seconds.

Returns:
CO2 value in ppm (parts per million), with an accuracy of
±(50 + result * 0.05) ppm.
Raises:
TimeoutError: if the reading takes more than 5 seconds.
"""
# Wait until a new cycle starts
self._wait_on_condition(lambda: self.pin.value() == 0)

# Measure high and low duration during cycle
t_h = machine.time_pulse_us(self.pin, 1, 1500000)
t_l = machine.time_pulse_us(self.pin, 0, 1500000)

return self.max_value * (t_h - 2000) / (t_h + t_l - 4000)
0