pyupm_speaker module

class pyupm_speaker.Speaker(pin, usePWM=False)

Bases: object

API for the Speaker.

ID: speaker libupm-speaker

Name: Speaker

Other Names: Grove Speaker

Category: sound

Manufacturer: seeed

Connection: gpio

Kit: hak UPM module for the Speaker. This sensor can generate different tones and sounds depending on the frequency of the input signal.

It can operate in one of two modes: GPIO (default) and PWM.

Depending on which mode is selected, some methods may not be usable. In GPIO mode, the playAll() and playSound() methods are supported. In PWM mode, setFrequency(), emit(), on() and off() are supported. Calling a method not appropriate for the mode will have no effect.

C++ includes: speaker.hpp

emit(freq, emit_ms)

void emit(unsigned int freq, unsigned int emit_ms)

Emit a specific frequency for a given period of time and return. This function only operates when in PWM mode. The frequency is limited to between 50-32000Hz. In addition, the allowable frequencies may be restricted further by the capabilities of your PWM hardware.

freq: The frequency to emit. Must be between 50 and 32000Hz inclusive.

emit_ms: The number of milliseconds to emit the frequency.

off()

void off()

Turn the speaker off. This function only operates when in PWM mode.

on()

void on()

Turn the speaker on, and emit the frequency last specified with setFrequency() or emit(). This function only operates when in PWM mode.

playAll()

void playAll()

Plays all alto notes (lowest notes)

playSound(letter, sharp, vocalWeight)

void playSound(char letter, bool sharp, std::string vocalWeight)

Plays a sound and a note whether it’s sharp or not

letter: Character name of the note (‘a’, ‘b’, ‘c’, ‘d’, ‘e’, ‘f’, or ‘g’)

sharp: If true, plays a sharp version of the note; otherwise, does not play the note

vocalWeight: String to determine whether to play a low (“low”), a medium (“med”), or a high (“high”) note

setFrequency(freq)

void setFrequency(unsigned int freq)

Set a default frequency to be used with on() and off(). This function only operates when in PWM mode. The frequency is limited to between 50-32000Hz. In addition, the allowable frequencies may be restricted further by the capabilities of your PWM hardware.

freq: The frequency to emit. Must be between 50 and 32000Hz inclusive.