nanoFramework.Iot.Device.Buzzer 1.0.288-preview.103

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
This is a prerelease version of nanoFramework.Iot.Device.Buzzer.
There is a newer version of this package available.
See the version list below for details.
dotnet add package nanoFramework.Iot.Device.Buzzer --version 1.0.288-preview.103
NuGet\Install-Package nanoFramework.Iot.Device.Buzzer -Version 1.0.288-preview.103
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="nanoFramework.Iot.Device.Buzzer" Version="1.0.288-preview.103" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add nanoFramework.Iot.Device.Buzzer --version 1.0.288-preview.103
#r "nuget: nanoFramework.Iot.Device.Buzzer, 1.0.288-preview.103"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install nanoFramework.Iot.Device.Buzzer as a Cake Addin
#addin nuget:?package=nanoFramework.Iot.Device.Buzzer&version=1.0.288-preview.103&prerelease

// Install nanoFramework.Iot.Device.Buzzer as a Cake Tool
#tool nuget:?package=nanoFramework.Iot.Device.Buzzer&version=1.0.288-preview.103&prerelease

Buzzer - Piezo Buzzer Controller

This device binding allows playing certain tones using piezo buzzer. It uses PWM with 50% duty cycle and various frequencies.

Piezo buzzers with three pins supported as well as piezo buzzers with two pins.

Device Family

This binding was tested on two types of piezo buzzers. First type of buzzer has two pins vcc and gnd. Second type of buzzers has addition signal pin.

Usage

The Buzzer class can use either software or hardware PWM. This is done fully transparently by the initialization.

If you want to use the software PWM, you have to call the constructor that takes in one integer: public Buzzer(int pinNumber).

To use the hardware PWM, make sure you reference correctly the chip and channel you want to use, and call the constructor that takes two integers (chip and channel).

Also you could explicitly pass a PwmChannel if you want to construct that yourself.

Here's an example how you could use Buzzer.

using (Buzzer buzzer = new Buzzer(21)); // Initialize buzzer with software PWM connected to pin 21.
{
    buzzer.PlayTone(440, 1000); // Play tone with frequency 440 hertz for one second.
}

Important Depending on your platform, you may have to setup the pins properly. In case of ESP32, use the nanoFramework.Hardware.Esp32 nuget then configure the pin properly like Configuration.SetPinFunction(21, DeviceFunction.PWM1);. That should be done before creating the Buzzer.

Buzzer allows to play tone for certain duration like in example above. Or you could start tone playing, perform some operation and then stop tone playing like in a following example.

using (Buzzer buzzer = new Buzzer(21));
{
    buzzer.StartPlaying(440);
    Thread.Sleep(1000);
    buzzer.StopPlaying();
}

The result will be the same as in previous example.

Buzzer allows you to play only single tone at a single moment. If you will call SetFrequency sequentially with a different frequencies then the last call will override previous calls. Following example explains it.

using (Buzzer buzzer = new Buzzer(21)); // Initialize buzzer with software PWM connected to pin 21.
{
    buzzer.StartPlaying(440);
    Thread.Sleep(1000);
    buzzer.StartPlaying(880);
    Thread.Sleep(1000);
    buzzer.StopPlaying();
}

This example will play tone with frequency 440 for a second and then will play tone with a frequency 880 for a second.

Example of Alphabet song played using Buzzer

Schematic

You have 2 types of buzzers. Those with 2 pins only and those with 3 pins. For buzzer with 3 pins: simply connect signal pin of buzzer to commutation pin (any valid GPIO), vcc pin to +5v, gnd pin to ground. For buzzer with 2 pins: connect vcc pin of buzzer to commutation pin (any valid GPIO) and gnd to ground.

You could use any types of buzzers in any order. No changes to code are required.

schema

Code

This sample contains a wrapper on a Buzzer called MelodyPlayer.

MelodyPlayer and MelodyElement

To create an instance of a MelodyPlayer use following line:

MelodyPlayer player = new MelodyPlayer(new  Buzzer(26));

Constructor takes a single parameter type of Buzzer.

After initialization MelodyPlayer allows playing melody represented by sequence of MelodyElement objects. MelodyElement is a base class for two types of elements:

  • NoteElement - It will be played. So in a constructor it accepts Note and Octave to determine frequency of the sound and Duration to determine duration of the sound.
  • PauseElement - It's supposed to make a pause between two NoteElements so it's only have duration of pause as constructor parameter.
How to use

Following example demonstrates how to create MelodyElement sequence and how to play it using MelodyPlayer:

IListMelodyElement sequence = new ListMelodyElement()
{
    new NoteElement(Note.C, Octave.Fourth, Duration.Quarter),
    new PauseElement(Duration.Quarter),
    new NoteElement(Note.C, Octave.Fourth, Duration.Quarter)
};

using (var player = new MelodyPlayer(new Buzzer(21)))
{
    player.Play(sequence, 100);
}

Play method MelodyPlayer accepts a sequence of MelodyElements as the first parameter and a tempo as the second. Tempo is an amount of quarter notes per minute. So the more tempo is the quicker melody will be played.

Also there is an overload of MelodyPlayer.Play with 3 parameters: MelodyElement sequence, tempo and transposition value. Transposition increases or decreases every tone of melody sequence by desired amount of semitones. For example: following line will decrease every tone of sequence by one octave since octave consists of 12 semitones.

player.Play(sequence, 100, -12);
Parallel buzzer playing

As far as MelodyPlayer.Play method is not asynchronous, calls of this method are wrapped by task like this:

var player1 = new MelodyPlayer(new Buzzer(21));
player1.Play(AlphabetSong, 100, -12);
player1.Play(AlphabetSong, 100);

This approach allows playing two melodies independently however example above plays a single melody in the same time using two different buzzers.

Alphabet song

Presented sample plays Alphabet song using two buzzers. The song is hardcoded in a Buzzer.Sample.cs file as a sequence of MelodyElements. Read more about Alphabet song on Wikipedia

Product Compatible and additional computed target framework versions.
.NET Framework net is compatible. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (5)

Showing the top 5 NuGet packages that depend on nanoFramework.Iot.Device.Buzzer:

Package Downloads
nanoFramework.M5Core The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

This package includes the nanoFramework.M5Core assembly for .NET nanoFramework C# projects.

nanoFramework.M5StickCPlus The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

This package includes the nanoFramework.M5StickCPlus assembly for .NET nanoFramework C# projects.

nanoFramework.Fire The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

This package includes the nanoFramework.Fire assembly for .NET nanoFramework C# projects.

nanoFramework.MagicBit The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

This package includes nanoFramework.MagicBit, a board package library for MagicBit in .NET nanoFramework C# projects.

nanoFramework.M5Stack The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

This package includes the nanoFramework.M5Stack assembly for .NET nanoFramework C# projects.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.2.514 163 3/22/2024
1.2.494 282 2/28/2024
1.2.474 390 1/24/2024
1.2.462 139 1/5/2024
1.2.458 132 12/20/2023
1.2.436 360 11/10/2023
1.2.416 307 11/8/2023
1.2.403 319 10/6/2023
1.2.396 299 9/27/2023
1.2.384 337 9/6/2023
1.2.378 400 8/16/2023
1.2.369 363 8/2/2023
1.2.363 266 7/28/2023
1.2.357 351 7/19/2023
1.2.354 294 7/14/2023
1.2.345 366 6/21/2023
1.2.341 320 6/14/2023
1.2.337 406 6/7/2023
1.2.335 199 6/2/2023
1.2.329 331 5/26/2023
1.2.313 612 5/12/2023
1.2.302 435 5/10/2023
1.2.297 398 5/3/2023
1.2.273 1,707 3/17/2023
1.2.267 1,049 3/10/2023
1.2.263 763 3/8/2023
1.2.259 755 2/27/2023
1.2.256 795 2/24/2023
1.2.253 788 2/22/2023
1.2.222 2,009 1/9/2023
1.2.217 1,192 1/6/2023
1.2.208 1,212 1/3/2023
1.2.203 804 12/28/2022
1.2.159 1,466 11/14/2022
1.2.153 2,681 11/5/2022
1.2.141 4,208 10/25/2022
1.2.128 1,245 10/22/2022
1.2.87 9,719 9/15/2022
1.2.63 3,940 9/3/2022
1.2.47 1,661 8/15/2022
1.2.40 1,930 8/6/2022
1.2.38 1,564 8/5/2022
1.2.32 3,593 8/2/2022
1.2.28 1,513 8/1/2022
1.2.13 3,071 7/24/2022
1.2.10 1,524 7/23/2022
1.1.145.58726 3,055 7/7/2022
1.1.133.52556 4,860 6/30/2022
1.1.121.35854 3,765 6/26/2022
1.1.116.8772 2,713 6/24/2022
1.1.113.2032 737 6/23/2022
1.1.102.51394 2,134 6/15/2022
1.1.99.36719 1,582 6/14/2022
1.1.72.29765 7,547 5/31/2022
1.1.64.21380 3,192 5/26/2022
1.1.58.10097 2,096 5/23/2022
1.1.54.28879 1,024 5/23/2022
1.1.40 3,693 5/5/2022
1.1.3 11,859 4/15/2022
1.1.1 481 4/14/2022
1.0.302 4,997 3/31/2022
1.0.300 464 3/31/2022
1.0.288-preview.114 150 3/25/2022
1.0.288-preview.113 120 3/25/2022
1.0.288-preview.103 142 3/21/2022
1.0.288-preview.100 126 3/19/2022
1.0.288-preview.99 134 3/18/2022
1.0.288-preview.98 116 3/18/2022
1.0.288-preview.94 171 3/15/2022
1.0.288-preview.93 119 3/15/2022
1.0.288-preview.90 172 3/11/2022
1.0.288-preview.86 150 3/8/2022
1.0.288-preview.77 174 2/27/2022
1.0.288-preview.75 127 2/26/2022
1.0.288-preview.65 155 2/18/2022
1.0.288-preview.63 141 2/16/2022
1.0.288-preview.61 140 2/12/2022
1.0.288-preview.58 135 2/10/2022
1.0.288-preview.53 129 2/9/2022
1.0.288-preview.48 161 2/4/2022
1.0.288-preview.41 160 1/31/2022
1.0.288-preview.29 142 1/28/2022
1.0.288-preview.22 163 1/27/2022
1.0.288-preview.20 138 1/27/2022
1.0.288-preview.19 133 1/27/2022
1.0.288-preview.18 137 1/27/2022
1.0.288-preview.5 150 1/24/2022
1.0.288-preview.1 147 1/21/2022
1.0.272 560 1/10/2022
1.0.263 367 12/24/2021
1.0.260 477 12/10/2021
1.0.259 164 12/9/2021
1.0.258 174 12/7/2021
1.0.218 346 10/18/2021
1.0.191 172 9/29/2021
1.0.179 163 9/22/2021