nanoFramework.Iot.Device.Button 1.2.536

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
dotnet add package nanoFramework.Iot.Device.Button --version 1.2.536
NuGet\Install-Package nanoFramework.Iot.Device.Button -Version 1.2.536
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.Button" Version="1.2.536" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add nanoFramework.Iot.Device.Button --version 1.2.536
#r "nuget: nanoFramework.Iot.Device.Button, 1.2.536"
#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.Button as a Cake Addin
#addin nuget:?package=nanoFramework.Iot.Device.Button&version=1.2.536

// Install nanoFramework.Iot.Device.Button as a Cake Tool
#tool nuget:?package=nanoFramework.Iot.Device.Button&version=1.2.536

Button

The ButtonBase class is a base implementation for buttons that is hardware independent and can be used across devices. The GpioButton is a GPIO implementation of the button and inherits from the ButtonBase class. This implementation has been tested on an ESP32 platform, specifically on the M5StickC Plus.

Documentation

Documentation for the M5StickC Plus, including pin mapping, can be found here. Information regarding standard mouse events, used as inspiration for the button events, can be found here.

Usage

You can find an example in the samples directory.

// Initialize a new button with the corresponding button pin
GpioButton button = new GpioButton(buttonPin: 37);

Debug.WriteLine("Button is initialized, starting to read state");

// Enable or disable holding or doublepress events
button.IsDoublePressEnabled = true;
button.IsHoldingEnabled = true;

// Write to debug if the button is down
button.ButtonDown += (sender, e) =>
{
    Debug.WriteLine($"buttondown IsPressed={button.IsPressed}");
};

// Write to debug if the button is up
button.ButtonUp += (sender, e) =>
{
    Debug.WriteLine($"buttonup IsPressed={button.IsPressed}");
};

// Write to debug if the button is pressed
button.Press += (sender, e) =>
{
    Debug.WriteLine($"Press");
};

// Write to debug if the button is double pressed
button.DoublePress += (sender, e) =>
{
    Debug.WriteLine($"Double press");
};

// Write to debug if the button is held and released
button.Holding += (sender, e) =>
{
    switch (e.HoldingState)
    {
        case ButtonHoldingState.Started:
            Debug.WriteLine($"Holding Started");
            break;
        case ButtonHoldingState.Completed:
            Debug.WriteLine($"Holding Completed");
            break;
    }
};

Thread.Sleep(Timeout.Infinite);

Expected output

Button is initialized, starting to read state
buttondown IsPressed=True
buttonup IsPressed=False
Press
buttondown IsPressed=True
buttonup IsPressed=False
Press
Double press
buttondown IsPressed=True
Holding Started
buttonup IsPressed=False
Press
Holding Completed

Testing

The unit test project can be found in the tests directory. You can simply run them using the VS2019 built-in test capabilites:

unit tests

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 (9)

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

Package Downloads
nanoFramework.M5Core2 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.M5Core2 assembly for .NET nanoFramework C# projects.

nanoFramework.M5StickC 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.M5StickC assembly for .NET nanoFramework C# projects.

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.AtomLite 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.AtomLite assembly for .NET nanoFramework C# projects.

GitHub repositories (2)

Showing the top 2 popular GitHub repositories that depend on nanoFramework.Iot.Device.Button:

Repository Stars
nanoframework/Samples
🍬 Code samples from the nanoFramework team used in testing, proof of concepts and other explorational endeavours
nanoframework/nanoFramework.IoT.Device
📦 This repo includes .NET nanoFramework implementations for various sensors, chips, displays, hats and drivers
Version Downloads Last updated
1.2.536 248 4/15/2024
1.2.514 873 3/22/2024
1.2.436 2,461 11/10/2023
1.2.329 5,648 5/26/2023
1.2.313 1,544 5/12/2023
1.2.308 1,035 5/11/2023
1.2.302 737 5/10/2023
1.2.297 1,176 5/3/2023
1.2.273 3,879 3/17/2023
1.2.215 12,524 1/6/2023
1.2.203 3,101 12/28/2022
1.2.153 7,698 11/5/2022
1.2.141 8,118 10/25/2022
1.2.122 4,132 10/12/2022
1.2.114 3,262 10/8/2022
1.2.95 8,460 9/22/2022
1.2.87 8,572 9/15/2022
1.2.73 3,421 9/8/2022
1.2.32 18,662 8/2/2022
1.1.113.2032 36,615 6/23/2022
1.1.58.10097 32,385 5/23/2022
1.1.43.5388 8,616 5/5/2022
1.1.16 987 4/19/2022
1.1.1 29,762 4/14/2022
1.0.300 11,642 3/31/2022
1.0.289-preview.6 176 3/25/2022
1.0.289-preview.1 140 3/24/2022
1.0.288-preview.99 171 3/18/2022
1.0.288-preview.98 126 3/18/2022
1.0.288-preview.93 187 3/15/2022
1.0.288-preview.86 203 3/8/2022
1.0.288-preview.65 222 2/18/2022
1.0.288-preview.48 241 2/4/2022
1.0.288-preview.29 239 1/28/2022
1.0.288-preview.20 221 1/27/2022
1.0.288-preview.19 145 1/27/2022
1.0.288-preview.5 192 1/24/2022
1.0.288-preview.3 160 1/21/2022
1.0.288-preview.1 149 1/21/2022
1.0.272 277 1/10/2022
1.0.259 1,470 12/9/2021
1.0.218 361 10/18/2021
1.0.214 793 10/15/2021
1.0.207 822 10/11/2021
1.0.196 781 10/5/2021