# This file was automatically generated by SWIG (http://www.swig.org).
# Version 3.0.8
#
# Do not make changes to this file unless you know what you are doing--modify
# the SWIG interface file instead.
from sys import version_info
if version_info >= (2, 6, 0):
def swig_import_helper():
from os.path import dirname
import imp
fp = None
try:
fp, pathname, description = imp.find_module('_pyupm_hka5', [dirname(__file__)])
except ImportError:
import _pyupm_hka5
return _pyupm_hka5
if fp is not None:
try:
_mod = imp.load_module('_pyupm_hka5', fp, pathname, description)
finally:
fp.close()
return _mod
_pyupm_hka5 = swig_import_helper()
del swig_import_helper
else:
import _pyupm_hka5
del version_info
try:
_swig_property = property
except NameError:
pass # Python < 2.2 doesn't have 'property'.
def _swig_setattr_nondynamic(self, class_type, name, value, static=1):
if (name == "thisown"):
return self.this.own(value)
if (name == "this"):
if type(value).__name__ == 'SwigPyObject':
self.__dict__[name] = value
return
method = class_type.__swig_setmethods__.get(name, None)
if method:
return method(self, value)
if (not static):
if _newclass:
object.__setattr__(self, name, value)
else:
self.__dict__[name] = value
else:
raise AttributeError("You cannot add attributes to %s" % self)
def _swig_setattr(self, class_type, name, value):
return _swig_setattr_nondynamic(self, class_type, name, value, 0)
def _swig_getattr_nondynamic(self, class_type, name, static=1):
if (name == "thisown"):
return self.this.own()
method = class_type.__swig_getmethods__.get(name, None)
if method:
return method(self)
if (not static):
return object.__getattr__(self, name)
else:
raise AttributeError(name)
def _swig_getattr(self, class_type, name):
return _swig_getattr_nondynamic(self, class_type, name, 0)
def _swig_repr(self):
try:
strthis = "proxy of " + self.this.__repr__()
except Exception:
strthis = ""
return "<%s.%s; %s >" % (self.__class__.__module__, self.__class__.__name__, strthis,)
try:
_object = object
_newclass = 1
except AttributeError:
class _object:
pass
_newclass = 0
def getVersion():
return _pyupm_hka5.getVersion()
getVersion = _pyupm_hka5.getVersion
[docs]class HKA5(_object):
"""
API for theDFRobot Laser PM2.5 Sensor.
ID: hka5
Name: Laser Particulate Matter (PM) Sensor
Category: gaseous
Manufacturer: dfrobot
Connection: uart gpio
Link:https://www.dfrobot.com/wiki/index.php/DFRobot_LM35_Linear_Temperature_Sensor_(SKU:DFR0023)
This driver was tested with a DFRobot Laser PM2.5 Sensor. It connects
to a UART at 9600 baud. This is the only baud rate supported. It
optionally supports Reset and Set/Sleep gpios as well.
C++ includes: hka5.hpp
"""
__swig_setmethods__ = {}
__setattr__ = lambda self, name, value: _swig_setattr(self, HKA5, name, value)
__swig_getmethods__ = {}
__getattr__ = lambda self, name: _swig_getattr(self, HKA5, name)
__repr__ = _swig_repr
def __init__(self, uart, set_pin, reset_pin):
"""
HKA5(unsigned int uart, int
set_pin, int reset_pin)
HKA5 object constructor
Parameters:
-----------
uart: Specify which uart to use.
set_pin: Specify the GPIO pin to use for Set. -1 to not use a set
pin.
reset_pin: Specify the GPIO pin to use for Reset. -1 to not use a
reset pin.
an initialized device context on success, NULL on error.
"""
this = _pyupm_hka5.new_HKA5(uart, set_pin, reset_pin)
try:
self.this.append(this)
except Exception:
self.this = this
__swig_destroy__ = _pyupm_hka5.delete_HKA5
__del__ = lambda self: None
[docs] def enable(self, enable):
"""
void enable(bool enable)
Enable or disable the device. When disabled, the device enters a low
power mode and does not emit data. You must have initialized and
connected the Set pin for this function to work.
Parameters:
-----------
enable: true to enable the device, false otherwise.
"""
return _pyupm_hka5.HKA5_enable(self, enable)
[docs] def reset(self):
"""
void reset()
Reset the device. You must have initialized and connected the Reset
pin for this function to work.
"""
return _pyupm_hka5.HKA5_reset(self)
[docs] def update(self):
"""
void update()
Query the device and store the latest values. You must call this
function before calling any of the get*() functions.
"""
return _pyupm_hka5.HKA5_update(self)
[docs] def getPM1(self):
"""
unsigned int getPM1()
Return the last read PM 1.0 value. The value is in micrograms per
cubic meter (ug/m3). You must have called the update() function before
calling this function.
The value in ug/m3
"""
return _pyupm_hka5.HKA5_getPM1(self)
[docs] def getPM2_5(self):
"""
unsigned int getPM2_5()
Return the last read PM 2.5 value. The value is in micrograms per
cubic meter (ug/m3). You must have called the update() function before
calling this function.
The value in ug/m3
"""
return _pyupm_hka5.HKA5_getPM2_5(self)
[docs] def getPM10(self):
"""
unsigned int getPM10()
Return the last read PM 10.0 value. The value is in micrograms per
cubic meter (ug/m3). You must have called the update() function before
calling this function.
The value in ug/m3
"""
return _pyupm_hka5.HKA5_getPM10(self)
HKA5_swigregister = _pyupm_hka5.HKA5_swigregister
HKA5_swigregister(HKA5)
# This file is compatible with both classic and new-style classes.