Source code for pyupm_buzzer

# 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_buzzer', [dirname(__file__)])
        except ImportError:
            import _pyupm_buzzer
            return _pyupm_buzzer
        if fp is not None:
            try:
                _mod = imp.load_module('_pyupm_buzzer', fp, pathname, description)
            finally:
                fp.close()
            return _mod
    _pyupm_buzzer = swig_import_helper()
    del swig_import_helper
else:
    import _pyupm_buzzer
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_buzzer.getVersion()
getVersion = _pyupm_buzzer.getVersion

_pyupm_buzzer.BUZZER_DO_swigconstant(_pyupm_buzzer)
BUZZER_DO = _pyupm_buzzer.BUZZER_DO

_pyupm_buzzer.BUZZER_RE_swigconstant(_pyupm_buzzer)
BUZZER_RE = _pyupm_buzzer.BUZZER_RE

_pyupm_buzzer.BUZZER_MI_swigconstant(_pyupm_buzzer)
BUZZER_MI = _pyupm_buzzer.BUZZER_MI

_pyupm_buzzer.BUZZER_FA_swigconstant(_pyupm_buzzer)
BUZZER_FA = _pyupm_buzzer.BUZZER_FA

_pyupm_buzzer.BUZZER_SOL_swigconstant(_pyupm_buzzer)
BUZZER_SOL = _pyupm_buzzer.BUZZER_SOL

_pyupm_buzzer.BUZZER_LA_swigconstant(_pyupm_buzzer)
BUZZER_LA = _pyupm_buzzer.BUZZER_LA

_pyupm_buzzer.BUZZER_SI_swigconstant(_pyupm_buzzer)
BUZZER_SI = _pyupm_buzzer.BUZZER_SI
[docs]class Buzzer(_object): """ API for the Buzzer component. ID: buzzer Name: Buzzer Category: sound Manufacturer: seeed Connection: pwm Kit: gsk This module defines the Buzzer interface for libbuzzer. This sensor can make different tones when connected to a pin capable of analog pulse-width modulation. It emits sound using a piezoelectric material that vibrates at different frequencies based on the input voltage. C++ includes: buzzer.hpp """ __swig_setmethods__ = {} __setattr__ = lambda self, name, value: _swig_setattr(self, Buzzer, name, value) __swig_getmethods__ = {} __getattr__ = lambda self, name: _swig_getattr(self, Buzzer, name) __repr__ = _swig_repr def __init__(self, pinNumber): """ Buzzer(int pinNumber) Instantiates a Buzzer object. Parameters: ----------- pinNumber: Buzzer pin number """ this = _pyupm_buzzer.new_Buzzer(pinNumber) try: self.this.append(this) except Exception: self.this = this __swig_destroy__ = _pyupm_buzzer.delete_Buzzer __del__ = lambda self: None
[docs] def playSound(self, note, delay): """ int playSound(int note, int delay) Plays a tone for a certain amount of time or indefinitely. When delay is not used, the sound can be stopped by calling stopSound(). Parameters: ----------- note: Note to play (DO, RE, MI, etc.) or frequency delay: Time in microseconds for which to play the sound; if the value is 0, the sound is played indefinitely Note played """ return _pyupm_buzzer.Buzzer_playSound(self, note, delay)
[docs] def stopSound(self): """ void stopSound() Stops the sound currently playing. Should be called when playSound() does not have a delay value. """ return _pyupm_buzzer.Buzzer_stopSound(self)
[docs] def setVolume(self, vol): """ void setVolume(float vol) Sets the volume for the buzzer, but may affect the sound timbre. Works best with halved values; e.g., 1.0, 0.5, 0.25, etc. Parameters: ----------- vol: Value to set the volume to, from 0.0 to 1.0 """ return _pyupm_buzzer.Buzzer_setVolume(self, vol)
[docs] def getVolume(self): """ float getVolume() Gets the buzzer volume. Value the volume was set to """ return _pyupm_buzzer.Buzzer_getVolume(self)
[docs] def name(self): """ std::string name() Returns the name of the sensor. Name of the sensor """ return _pyupm_buzzer.Buzzer_name(self)
Buzzer_swigregister = _pyupm_buzzer.Buzzer_swigregister Buzzer_swigregister(Buzzer) # This file is compatible with both classic and new-style classes.