Source code for pyupm_light

# 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_light', [dirname(__file__)])
        except ImportError:
            import _pyupm_light
            return _pyupm_light
        if fp is not None:
            try:
                _mod = imp.load_module('_pyupm_light', fp, pathname, description)
            finally:
                fp.close()
            return _mod
    _pyupm_light = swig_import_helper()
    del swig_import_helper
else:
    import _pyupm_light
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_light.getVersion()
getVersion = _pyupm_light.getVersion
[docs]class Light(_object): """ API for the Light Sensor. ID: light Name: Analog Light Sensor Category: light Manufacturer: seeed Connection: analog Kit: gsk The light sensor detects the intensity of the ambient light. As the light intensity of the environment increases, the resistance of the sensor decreases. This means the raw value from the analog pin is larger in bright light and smaller in the dark. A very approximate lux value can also be returned. C++ includes: light.hpp """ __swig_setmethods__ = {} __setattr__ = lambda self, name, value: _swig_setattr(self, Light, name, value) __swig_getmethods__ = {} __getattr__ = lambda self, name: _swig_getattr(self, Light, name) __repr__ = _swig_repr def __init__(self, pin): """ Light(unsigned int pin) Analog light sensor constructor Parameters: ----------- pin: Analog pin to use Exceptions: ----------- std::runtime_error: on initialization error """ this = _pyupm_light.new_Light(pin) try: self.this.append(this) except Exception: self.this = this __swig_destroy__ = _pyupm_light.delete_Light __del__ = lambda self: None
[docs] def raw_value(self): """ float raw_value() Gets the raw value from the AIO pin Deprecated This function is deprecated use getNormalized() instead. Raw value from the ADC Exceptions: ----------- std::runtime_error: on error """ return _pyupm_light.Light_raw_value(self)
[docs] def value(self): """ int value() Gets an approximate light value in lux from the sensor Approximate light reading in lux Exceptions: ----------- std::runtime_error: on error """ return _pyupm_light.Light_value(self)
[docs] def setAref(self, aref): """ void setAref(float aref) Set ADC reference voltage Parameters: ----------- aref: ADC reference voltage """ return _pyupm_light.Light_setAref(self, aref)
[docs] def setScale(self, scale): """ void setScale(float scale) Set sensor scale. This scale is applied to the return value: counts = counts * scale Parameters: ----------- scale: count scale value used """ return _pyupm_light.Light_setScale(self, scale)
[docs] def setOffset(self, offset): """ void setOffset(float offset) Set sensor offset. This offset is applied to the return value: value = value + offset Parameters: ----------- offset: count offset value used Function result code """ return _pyupm_light.Light_setOffset(self, offset)
[docs] def getAref(self): """ float getAref() Get sensor aref Parameters: ----------- dev: sensor context pointer Sensor ADC reference voltage """ return _pyupm_light.Light_getAref(self)
[docs] def getScale(self): """ float getScale() Get sensor scale Parameters: ----------- dev: sensor context pointer Sensor scale """ return _pyupm_light.Light_getScale(self)
[docs] def getOffset(self): """ float getOffset() Get sensor offset Parameters: ----------- dev: sensor context pointer Sensor offset """ return _pyupm_light.Light_getOffset(self)
[docs] def getNormalized(self): """ float getNormalized() Read normalized value for sensor Parameters: ----------- dev: sensor context pointer *value: Normalized value (0.0 -> 1.0) Function result code Exceptions: ----------- std::runtime_error: on error """ return _pyupm_light.Light_getNormalized(self)
[docs] def getRawVolts(self): """ float getRawVolts() Read raw voltage from the sensor Parameters: ----------- dev: sensor context pointer *value: Raw sensor voltage Function result code Exceptions: ----------- std::runtime_error: on error """ return _pyupm_light.Light_getRawVolts(self)
[docs] def name(self): """std::string name() """ return _pyupm_light.Light_name(self)
Light_swigregister = _pyupm_light.Light_swigregister Light_swigregister(Light) # This file is compatible with both classic and new-style classes.