diff --git a/README.md b/README.md index 1dc7228b..1a93c857 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,8 @@ | nanoFramework.M5StickCPlus (preview) | [![Build Status](https://dev.azure.com/nanoframework/nanoFramework.M5Stack/_apis/build/status/nanoFramework.M5Stack?repoName=nanoframework%2FnanoFramework.M5Stack&branchName=develop)](https://dev.azure.com/nanoframework/nanoFramework.M5Stack/_build/latest?definitionId=52&repoName=nanoframework%2FnanoFramework.M5Stack&branchName=develop) | [![NuGet](https://img.shields.io/nuget/vpre/nanoFramework.M5StickCPlus.svg?label=NuGet&style=flat&logo=nuget)](https://www.nuget.org/packages/nanoFramework.M5StickCPlus/) | | nanoFramework.M5Core2 | [![Build Status](https://dev.azure.com/nanoframework/nanoFramework.M5Stack/_apis/build/status/nanoFramework.M5Stack?repoName=nanoframework%2FnanoFramework.M5Stack&branchName=main)](https://dev.azure.com/nanoframework/nanoFramework.M5Stack/_build/latest?definitionId=52&repoName=nanoframework%2FnanoFramework.M5Stack&branchName=main) | [![NuGet](https://img.shields.io/nuget/v/nanoFramework.M5Core2.svg?label=NuGet&style=flat&logo=nuget)](https://www.nuget.org/packages/nanoFramework.M5Core2/) | | nanoFramework.M5Core2 (preview) | [![Build Status](https://dev.azure.com/nanoframework/nanoFramework.M5Stack/_apis/build/status/nanoFramework.M5Stack?repoName=nanoframework%2FnanoFramework.M5Stack&branchName=develop)](https://dev.azure.com/nanoframework/nanoFramework.M5Stack/_build/latest?definitionId=52&repoName=nanoframework%2FnanoFramework.M5Stack&branchName=develop) | [![NuGet](https://img.shields.io/nuget/vpre/nanoFramework.M5Core2.svg?label=NuGet&style=flat&logo=nuget)](https://www.nuget.org/packages/nanoFramework.M5Core2/) | +| nanoFramework.AtomLite | [![Build Status](https://dev.azure.com/nanoframework/nanoFramework.M5Stack/_apis/build/status/nanoFramework.M5Stack?repoName=nanoframework%2FnanoFramework.M5Stack&branchName=main)](https://dev.azure.com/nanoframework/nanoFramework.M5Stack/_build/latest?definitionId=52&repoName=nanoframework%2FnanoFramework.M5Stack&branchName=main) | [![NuGet](https://img.shields.io/nuget/v/nanoFramework.AtomLite.svg?label=NuGet&style=flat&logo=nuget)](https://www.nuget.org/packages/nanoFramework.AtomLite/) | +| nanoFramework.AtomLite (preview) | [![Build Status](https://dev.azure.com/nanoframework/nanoFramework.M5Stack/_apis/build/status/nanoFramework.M5Stack?repoName=nanoframework%2FnanoFramework.M5Stack&branchName=develop)](https://dev.azure.com/nanoframework/nanoFramework.M5Stack/_build/latest?definitionId=52&repoName=nanoframework%2FnanoFramework.M5Stack&branchName=develop) | [![NuGet](https://img.shields.io/nuget/vpre/nanoFramework.AtomLite.svg?label=NuGet&style=flat&logo=nuget)](https://www.nuget.org/packages/nanoFramework.AtomLite/) | ## Usage @@ -59,7 +61,7 @@ For the M5Core2: nanoff --target M5Core2 --update --preview --serialport COM3 ``` -For the M5AtomLite: +For the Atom Lite: ```shell nanoff --target ESP32_PICO --update --preview --serialport COM3 @@ -168,20 +170,20 @@ M5StickC.M5Button.Holding += (sender, e) => On the Atom Lite it's called `Button`. You can get access to the status of the button, the events and everything you need. For example: ```csharp -M5AtomLite.Button.Press +=> (sender, e) +AtomLite.Button.Press +=> (sender, e) { - var color = M5AtomLite.NeoPixel.GetColor(); + var color = AtomLite.NeoPixel.GetColor(); if(color.R > 0) { - M5AtomLite.NeoPixel.SetColor(Color.FromArgb(255, 0, 255, 0)); + AtomLite.NeoPixel.SetColor(Color.FromArgb(255, 0, 255, 0)); } else if (color.G > 0) { - M5AtomLite.NeoPixel.SetColor(Color.FromArgb(255, 0, 0, 255)); + AtomLite.NeoPixel.SetColor(Color.FromArgb(255, 0, 0, 255)); } else { - M5AtomLite.NeoPixel.SetColor(Color.FromArgb(255, 255, 0, 0)); + AtomLite.NeoPixel.SetColor(Color.FromArgb(255, 255, 0, 0)); } }; ``` @@ -370,15 +372,15 @@ M5StickC.Led.Toggle(); ### Infrared Led -The M5StickC/CPlus and M5AtomLite exposes an infrared led. You can access it thru the `InfraredLed` property. This will give you a `TransmitterChannel`. Check out the [sample pack](https://github.com/nanoframework/Samples/tree/main/samples/Hardware.Esp32.Rmt) to understand how to use it. +The M5StickC/CPlus and Atom Lite exposes an infrared led. You can access it thru the `InfraredLed` property. This will give you a `TransmitterChannel`. Check out the [sample pack](https://github.com/nanoframework/Samples/tree/main/samples/Hardware.Esp32.Rmt) to understand how to use it. ### NeoPixel -The M5AtomLite exposes a rgb led. You can access it thru the `NeoPixel` property: +The Atom Lite exposes a rgb led. You can access it thru the `NeoPixel` property: ```csharp // This will set NeoPixel to green: -M5AtomLite.NeoPixel.SetColor(Color.Green); +AtomLite.NeoPixel.SetColor(Color.Green); ``` ## Feedback and documentation diff --git a/Tests/M5AtomLiteTestApp/M5AtomLiteTestApp.nfproj b/Tests/AtomLiteTestApp/AtomLiteTestApp.nfproj similarity index 94% rename from Tests/M5AtomLiteTestApp/M5AtomLiteTestApp.nfproj rename to Tests/AtomLiteTestApp/AtomLiteTestApp.nfproj index c0af7e35..a9a72581 100644 --- a/Tests/M5AtomLiteTestApp/M5AtomLiteTestApp.nfproj +++ b/Tests/AtomLiteTestApp/AtomLiteTestApp.nfproj @@ -12,8 +12,8 @@ Exe Properties 512 - M5AtomLiteTestApp - M5AtomLiteTestApp + AtomLiteTestApp + AtomLiteTestApp v1.0 @@ -21,9 +21,6 @@ - - - @@ -52,6 +49,9 @@ ..\..\packages\nanoFramework.System.Drawing.1.0.288-preview.20\lib\System.Drawing.dll + + + diff --git a/Tests/M5AtomLiteTestApp/Program.cs b/Tests/AtomLiteTestApp/Program.cs similarity index 64% rename from Tests/M5AtomLiteTestApp/Program.cs rename to Tests/AtomLiteTestApp/Program.cs index faeabd0a..b171eb44 100644 --- a/Tests/M5AtomLiteTestApp/Program.cs +++ b/Tests/AtomLiteTestApp/Program.cs @@ -1,20 +1,20 @@ // Licensed to the .NET Foundation under one or more agreements. // The .NET Foundation licenses this file to you under the MIT license. +using nanoFramework.AtomLite; using System; using System.Diagnostics; using System.Drawing; using System.Threading; -using nanoFramework.M5AtomLite; -namespace M5AtomLiteTestApp +namespace AtomLiteTestApp { public class Program { public static void Main() { - var button = M5AtomLite.Button; - var rgb = M5AtomLite.NeoPixel; + var button = AtomLite.Button; + var rgb = AtomLite.NeoPixel; rgb.SetColor(Color.FromArgb(255, 255, 0, 0)); button.Press += Button_Press; @@ -26,18 +26,18 @@ public static void Main() private static void Button_Press(object sender, EventArgs e) { - var color = M5AtomLite.NeoPixel.GetColor(); + var color = AtomLite.NeoPixel.GetColor(); if(color.R > 0) { - M5AtomLite.NeoPixel.SetColor(Color.FromArgb(255, 0, 255, 0)); + AtomLite.NeoPixel.SetColor(Color.FromArgb(255, 0, 255, 0)); } else if (color.G > 0) { - M5AtomLite.NeoPixel.SetColor(Color.FromArgb(255, 0, 0, 255)); + AtomLite.NeoPixel.SetColor(Color.FromArgb(255, 0, 0, 255)); } else { - M5AtomLite.NeoPixel.SetColor(Color.FromArgb(255, 255, 0, 0)); + AtomLite.NeoPixel.SetColor(Color.FromArgb(255, 255, 0, 0)); } } } diff --git a/Tests/M5AtomLiteTestApp/Properties/AssemblyInfo.cs b/Tests/AtomLiteTestApp/Properties/AssemblyInfo.cs similarity index 100% rename from Tests/M5AtomLiteTestApp/Properties/AssemblyInfo.cs rename to Tests/AtomLiteTestApp/Properties/AssemblyInfo.cs diff --git a/Tests/M5AtomLiteTestApp/packages.config b/Tests/AtomLiteTestApp/packages.config similarity index 100% rename from Tests/M5AtomLiteTestApp/packages.config rename to Tests/AtomLiteTestApp/packages.config diff --git a/azure-pipelines.yml b/azure-pipelines.yml index 5bce43a4..e9ce687a 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -53,6 +53,10 @@ steps: parameters: nugetPackageName: 'nanoFramework.M5Core2' +- template: azure-pipelines-templates/class-lib-package.yml@templates + parameters: + nugetPackageName: 'nanoFramework.AtomLite' + - template: azure-pipelines-templates/class-lib-publish.yml@templates # create or update GitHub release diff --git a/nanoFramework.M5AtomLite.nuspec b/nanoFramework.AtomLite.nuspec similarity index 68% rename from nanoFramework.M5AtomLite.nuspec rename to nanoFramework.AtomLite.nuspec index a433b3bc..f64e79a0 100644 --- a/nanoFramework.M5AtomLite.nuspec +++ b/nanoFramework.AtomLite.nuspec @@ -1,9 +1,9 @@ - nanoFramework.M5AtomLite + nanoFramework.AtomLite $version$ - nanoFramework.M5AtomLite + nanoFramework.AtomLite nanoFramework project contributors nanoFramework,dotnetfoundation false @@ -16,8 +16,8 @@ images\nf-logo.png Copyright (c) .NET Foundation and Contributors - This package includes the nanoFramework.M5AtomLite assembly for .NET nanoFramework C# projects. - nanoFramework C# csharp netmf netnf nanoFramework.M5AtomLite + This package includes the nanoFramework.AtomLite assembly for .NET nanoFramework C# projects. + nanoFramework C# csharp netmf netnf nanoFramework.AtomLite @@ -33,11 +33,11 @@ - - - - - + + + + + diff --git a/nanoFramework.M5AtomLite/M5AtomLite.cs b/nanoFramework.AtomLite/AtomLite.cs similarity index 83% rename from nanoFramework.M5AtomLite/M5AtomLite.cs rename to nanoFramework.AtomLite/AtomLite.cs index 0e585274..017b32ba 100644 --- a/nanoFramework.M5AtomLite/M5AtomLite.cs +++ b/nanoFramework.AtomLite/AtomLite.cs @@ -2,21 +2,21 @@ // The .NET Foundation licenses this file to you under the MIT license. using Iot.Device.Button; +using nanoFramework.Hardware.Esp32; +using nanoFramework.Hardware.Esp32.Rmt; using System; -using System.Device.Gpio; -using System.Device.Dac; using System.Device.Adc; -using nanoFramework.Hardware.Esp32.Rmt; +using System.Device.Dac; +using System.Device.Gpio; using System.Device.I2c; -using nanoFramework.Hardware.Esp32; using System.Device.Spi; -namespace nanoFramework.M5AtomLite +namespace nanoFramework.AtomLite { /// - /// The M5AtomLite B=board + /// The AtomLite Board. /// - public static class M5AtomLite + public static class AtomLite { private static GpioButton _button; private static RgbLed _rgbLed; @@ -43,7 +43,7 @@ public static GpioButton Button } /// - /// RGB NeoPixel led + /// RGB NeoPixel led. /// public static RgbLed NeoPixel { @@ -60,12 +60,12 @@ public static RgbLed NeoPixel } /// - /// Gets the main GPIO Controller. + /// Gets the main . /// public static GpioController GpioController => _gpio; /// - /// Gets DAC1 which is GPIO 25. + /// Gets connected to GPIO 25. /// public static DacChannel Dac1 { @@ -82,7 +82,7 @@ public static DacChannel Dac1 } /// - /// Gets DAC1 which is GPIO 26. + /// Gets connected to GPIO 26. /// public static DacChannel Dac2 { @@ -100,16 +100,16 @@ public static DacChannel Dac2 } /// - /// Gets an I2C device. + /// Gets an . /// - /// The I2C device address on the bus. + /// The address of the on the bus. /// The I2cDevice. public static I2cDevice GetI2cDevice(int i2cDeviceAddress) => new(new I2cConnectionSettings(1, i2cDeviceAddress)); /// - /// Gets an I2C device. + /// Gets an . /// - /// The I2C device address on the bus. + /// The address of the on the bus. /// The I2cDevice. public static I2cDevice GetGrove(int i2cDeviceAddress) => new(new I2cConnectionSettings(1, i2cDeviceAddress)); @@ -130,16 +130,16 @@ public static TransmitterChannel InfraredLed } /// - /// Gets an SPI Device. + /// Gets an . /// /// The chip select of the device, needs to be any valid GPIO. /// An SpiDevice. public static SpiDevice GetSpiDevice(int chipSelect) => new(new SpiConnectionSettings(1, chipSelect)); /// - /// Gets an ADC channel + /// Gets an /// - /// The GPIO pin number + /// The GPIO pin number where the is connected to. /// An AdcChannel public static AdcChannel GetAdcGpio(int gpioNumber) { @@ -161,7 +161,7 @@ public static AdcChannel GetAdcGpio(int gpioNumber) } } - static M5AtomLite() + static AtomLite() { // Setup first the I2C bus Configuration.SetPinFunction(32, DeviceFunction.I2C1_CLOCK); diff --git a/nanoFramework.M5AtomLite/Properties/AssemblyInfo.cs b/nanoFramework.AtomLite/Properties/AssemblyInfo.cs similarity index 100% rename from nanoFramework.M5AtomLite/Properties/AssemblyInfo.cs rename to nanoFramework.AtomLite/Properties/AssemblyInfo.cs diff --git a/nanoFramework.M5AtomLite/RgbLed.cs b/nanoFramework.AtomLite/RgbLed.cs similarity index 98% rename from nanoFramework.M5AtomLite/RgbLed.cs rename to nanoFramework.AtomLite/RgbLed.cs index 1b296693..456e926a 100644 --- a/nanoFramework.M5AtomLite/RgbLed.cs +++ b/nanoFramework.AtomLite/RgbLed.cs @@ -4,7 +4,7 @@ using nanoFramework.Hardware.Esp32.Rmt; using System.Drawing; -namespace nanoFramework.M5AtomLite +namespace nanoFramework.AtomLite { /// /// The RGB Led controller for M5Stack Atom Lite. diff --git a/nanoFramework.M5AtomLite/key.snk b/nanoFramework.AtomLite/key.snk similarity index 100% rename from nanoFramework.M5AtomLite/key.snk rename to nanoFramework.AtomLite/key.snk diff --git a/nanoFramework.M5AtomLite/nanoFramework.M5AtomLite.nfproj b/nanoFramework.AtomLite/nanoFramework.AtomLite.nfproj similarity index 95% rename from nanoFramework.M5AtomLite/nanoFramework.M5AtomLite.nfproj rename to nanoFramework.AtomLite/nanoFramework.AtomLite.nfproj index fba8ab09..6fb4d504 100644 --- a/nanoFramework.M5AtomLite/nanoFramework.M5AtomLite.nfproj +++ b/nanoFramework.AtomLite/nanoFramework.AtomLite.nfproj @@ -12,10 +12,10 @@ Library Properties 512 - nanoFramework.M5AtomLite - nanoFramework.M5AtomLite + nanoFramework.AtomLite + nanoFramework.AtomLite v1.0 - bin\$(Configuration)\nanoFramework.M5AtomLite.xml + bin\$(Configuration)\nanoFramework.AtomLite.xml true @@ -28,7 +28,7 @@ - + diff --git a/nanoFramework.AtomLite/nanoFramework.M5AtomLite.nfproj b/nanoFramework.AtomLite/nanoFramework.M5AtomLite.nfproj new file mode 100644 index 00000000..88a55094 --- /dev/null +++ b/nanoFramework.AtomLite/nanoFramework.M5AtomLite.nfproj @@ -0,0 +1,4 @@ + + + + \ No newline at end of file diff --git a/nanoFramework.M5AtomLite/packages.config b/nanoFramework.AtomLite/packages.config similarity index 100% rename from nanoFramework.M5AtomLite/packages.config rename to nanoFramework.AtomLite/packages.config diff --git a/nanoFramework.M5Stack.sln b/nanoFramework.M5Stack.sln index 03ec0d5d..961076dc 100644 --- a/nanoFramework.M5Stack.sln +++ b/nanoFramework.M5Stack.sln @@ -6,7 +6,7 @@ Project("{11A8DD76-328B-46DF-9F39-F559912D0360}") = "nanoFramework.M5Core", "nan EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{0A689EB3-86E0-448E-99F4-3D644EC3D8C5}" ProjectSection(SolutionItems) = preProject - nanoFramework.M5AtomLite.nuspec = nanoFramework.M5AtomLite.nuspec + nanoFramework.AtomLite.nuspec = nanoFramework.AtomLite.nuspec nanoFramework.M5Core.nuspec = nanoFramework.M5Core.nuspec nanoFramework.M5Core2.nuspec = nanoFramework.M5Core2.nuspec nanoFramework.M5StickC.nuspec = nanoFramework.M5StickC.nuspec @@ -37,9 +37,9 @@ Project("{D954291E-2A0B-460D-934E-DC6B0785DB48}") = "nanoFramework.M5StackCore", EndProject Project("{11A8DD76-328B-46DF-9F39-F559912D0360}") = "M5Core2TestApp", "Tests\M5Core2TestApp\M5Core2TestApp.nfproj", "{20266750-53F3-46D5-8626-1438AC985033}" EndProject -Project("{11A8DD76-328B-46DF-9F39-F559912D0360}") = "nanoFramework.M5AtomLite", "nanoFramework.M5AtomLite\nanoFramework.M5AtomLite.nfproj", "{C20734A9-C944-4B2A-9CEA-A9B3F855B132}" +Project("{11A8DD76-328B-46DF-9F39-F559912D0360}") = "nanoFramework.AtomLite", "nanoFramework.AtomLite\nanoFramework.AtomLite.nfproj", "{C20734A9-C944-4B2A-9CEA-A9B3F855B132}" EndProject -Project("{11A8DD76-328B-46DF-9F39-F559912D0360}") = "M5AtomLiteTestApp", "Tests\M5AtomLiteTestApp\M5AtomLiteTestApp.nfproj", "{7533C164-9D3E-461B-BEED-888C91AC640B}" +Project("{11A8DD76-328B-46DF-9F39-F559912D0360}") = "AtomLiteTestApp", "Tests\AtomLiteTestApp\AtomLiteTestApp.nfproj", "{7533C164-9D3E-461B-BEED-888C91AC640B}" EndProject Global GlobalSection(SharedMSBuildProjectFiles) = preSolution