Skip to content

Commit bb725e7

Browse files
josesimoesjosesimoes
authored
Rename Atom Lite namespace and projects (#74)
1 parent 002c2b5 commit bb725e7

File tree

15 files changed

+68
-58
lines changed

15 files changed

+68
-58
lines changed

‎README.md‎

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@
1818
| 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/) |
1919
| 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/) |
2020
| 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/) |
21+
| 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/) |
22+
| 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/) |
2123

2224
## Usage
2325

@@ -59,7 +61,7 @@ For the M5Core2:
5961
nanoff --target M5Core2 --update --preview --serialport COM3
6062
```
6163

62-
For the M5AtomLite:
64+
For the Atom Lite:
6365

6466
```shell
6567
nanoff --target ESP32_PICO --update --preview --serialport COM3
@@ -168,20 +170,20 @@ M5StickC.M5Button.Holding += (sender, e) =>
168170
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:
169171

170172
```csharp
171-
M5AtomLite.Button.Press +=> (sender, e)
173+
AtomLite.Button.Press +=> (sender, e)
172174
{
173-
var color = M5AtomLite.NeoPixel.GetColor();
175+
var color = AtomLite.NeoPixel.GetColor();
174176
if(color.R > 0)
175177
{
176-
M5AtomLite.NeoPixel.SetColor(Color.FromArgb(255, 0, 255, 0));
178+
AtomLite.NeoPixel.SetColor(Color.FromArgb(255, 0, 255, 0));
177179
}
178180
else if (color.G > 0)
179181
{
180-
M5AtomLite.NeoPixel.SetColor(Color.FromArgb(255, 0, 0, 255));
182+
AtomLite.NeoPixel.SetColor(Color.FromArgb(255, 0, 0, 255));
181183
}
182184
else
183185
{
184-
M5AtomLite.NeoPixel.SetColor(Color.FromArgb(255, 255, 0, 0));
186+
AtomLite.NeoPixel.SetColor(Color.FromArgb(255, 255, 0, 0));
185187
}
186188
};
187189
```
@@ -370,15 +372,15 @@ M5StickC.Led.Toggle();
370372

371373
### Infrared Led
372374

373-
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.
375+
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.
374376

375377
### NeoPixel
376378

377-
The M5AtomLite exposes a rgb led. You can access it thru the `NeoPixel` property:
379+
The Atom Lite exposes a rgb led. You can access it thru the `NeoPixel` property:
378380

379381
```csharp
380382
// This will set NeoPixel to green:
381-
M5AtomLite.NeoPixel.SetColor(Color.Green);
383+
AtomLite.NeoPixel.SetColor(Color.Green);
382384
```
383385

384386
## Feedback and documentation

‎Tests/M5AtomLiteTestApp/M5AtomLiteTestApp.nfproj‎ renamed to ‎Tests/AtomLiteTestApp/AtomLiteTestApp.nfproj‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,15 @@
1212
<OutputType>Exe</OutputType>
1313
<AppDesignerFolder>Properties</AppDesignerFolder>
1414
<FileAlignment>512</FileAlignment>
15-
<RootNamespace>M5AtomLiteTestApp</RootNamespace>
16-
<AssemblyName>M5AtomLiteTestApp</AssemblyName>
15+
<RootNamespace>AtomLiteTestApp</RootNamespace>
16+
<AssemblyName>AtomLiteTestApp</AssemblyName>
1717
<TargetFrameworkVersion>v1.0</TargetFrameworkVersion>
1818
</PropertyGroup>
1919
<Import Project="$(NanoFrameworkProjectSystemPath)NFProjectSystem.props" Condition="Exists('$(NanoFrameworkProjectSystemPath)NFProjectSystem.props')" />
2020
<ItemGroup>
2121
<Compile Include="Program.cs" />
2222
<Compile Include="Properties\AssemblyInfo.cs" />
2323
</ItemGroup>
24-
<ItemGroup>
25-
<ProjectReference Include="..\..\nanoFramework.M5AtomLite\nanoFramework.M5AtomLite.nfproj" />
26-
</ItemGroup>
2724
<ItemGroup>
2825
<None Include="packages.config" />
2926
</ItemGroup>
@@ -52,6 +49,9 @@
5249
<HintPath>..\..\packages\nanoFramework.System.Drawing.1.0.288-preview.20\lib\System.Drawing.dll</HintPath>
5350
</Reference>
5451
</ItemGroup>
52+
<ItemGroup>
53+
<ProjectReference Include="..\..\nanoFramework.AtomLite\nanoFramework.AtomLite.nfproj" />
54+
</ItemGroup>
5555
<Import Project="$(NanoFrameworkProjectSystemPath)NFProjectSystem.CSharp.targets" Condition="Exists('$(NanoFrameworkProjectSystemPath)NFProjectSystem.CSharp.targets')" />
5656
<ProjectExtensions>
5757
<ProjectCapabilities>

‎Tests/M5AtomLiteTestApp/Program.cs‎ renamed to ‎Tests/AtomLiteTestApp/Program.cs‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
// Licensed to the .NET Foundation under one or more agreements.
22
// The .NET Foundation licenses this file to you under the MIT license.
33

4+
using nanoFramework.AtomLite;
45
using System;
56
using System.Diagnostics;
67
using System.Drawing;
78
using System.Threading;
8-
using nanoFramework.M5AtomLite;
99

10-
namespace M5AtomLiteTestApp
10+
namespace AtomLiteTestApp
1111
{
1212
public class Program
1313
{
1414
public static void Main()
1515
{
16-
var button = M5AtomLite.Button;
17-
var rgb = M5AtomLite.NeoPixel;
16+
var button = AtomLite.Button;
17+
var rgb = AtomLite.NeoPixel;
1818
rgb.SetColor(Color.FromArgb(255, 255, 0, 0));
1919

2020
button.Press += Button_Press;
@@ -26,18 +26,18 @@ public static void Main()
2626

2727
private static void Button_Press(object sender, EventArgs e)
2828
{
29-
var color = M5AtomLite.NeoPixel.GetColor();
29+
var color = AtomLite.NeoPixel.GetColor();
3030
if(color.R > 0)
3131
{
32-
M5AtomLite.NeoPixel.SetColor(Color.FromArgb(255, 0, 255, 0));
32+
AtomLite.NeoPixel.SetColor(Color.FromArgb(255, 0, 255, 0));
3333
}
3434
else if (color.G > 0)
3535
{
36-
M5AtomLite.NeoPixel.SetColor(Color.FromArgb(255, 0, 0, 255));
36+
AtomLite.NeoPixel.SetColor(Color.FromArgb(255, 0, 0, 255));
3737
}
3838
else
3939
{
40-
M5AtomLite.NeoPixel.SetColor(Color.FromArgb(255, 255, 0, 0));
40+
AtomLite.NeoPixel.SetColor(Color.FromArgb(255, 255, 0, 0));
4141
}
4242
}
4343
}

‎Tests/M5AtomLiteTestApp/Properties/AssemblyInfo.cs‎ renamed to ‎Tests/AtomLiteTestApp/Properties/AssemblyInfo.cs‎

File renamed without changes.

‎Tests/M5AtomLiteTestApp/packages.config‎ renamed to ‎Tests/AtomLiteTestApp/packages.config‎

File renamed without changes.

‎azure-pipelines.yml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,10 @@ steps:
5353
parameters:
5454
nugetPackageName: 'nanoFramework.M5Core2'
5555

56+
- template: azure-pipelines-templates/class-lib-package.yml@templates
57+
parameters:
58+
nugetPackageName: 'nanoFramework.AtomLite'
59+
5660
- template: azure-pipelines-templates/class-lib-publish.yml@templates
5761

5862
# create or update GitHub release

‎nanoFramework.M5AtomLite.nuspec‎ renamed to ‎nanoFramework.AtomLite.nuspec‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
33
<metadata>
4-
<id>nanoFramework.M5AtomLite</id>
4+
<id>nanoFramework.AtomLite</id>
55
<version>$version$</version>
6-
<title>nanoFramework.M5AtomLite</title>
6+
<title>nanoFramework.AtomLite</title>
77
<authors>nanoFramework project contributors</authors>
88
<owners>nanoFramework,dotnetfoundation</owners>
99
<requireLicenseAcceptance>false</requireLicenseAcceptance>
@@ -16,8 +16,8 @@
1616
<icon>images\nf-logo.png</icon>
1717
<repository type="git" url="https://github.com/nanoframework/nanoFramework.M5Stack" commit="$commit$" />
1818
<copyright>Copyright (c) .NET Foundation and Contributors</copyright>
19-
<description>This package includes the nanoFramework.M5AtomLite assembly for .NET nanoFramework C# projects.</description>
20-
<tags>nanoFramework C# csharp netmf netnf nanoFramework.M5AtomLite</tags>
19+
<description>This package includes the nanoFramework.AtomLite assembly for .NET nanoFramework C# projects.</description>
20+
<tags>nanoFramework C# csharp netmf netnf nanoFramework.AtomLite</tags>
2121
<dependencies>
2222
<dependency id="nanoFramework.CoreLibrary" version="1.12.0-preview.5" />
2323
<dependency id="nanoFramework.Hardware.Esp32" version="1.3.5-preview.6" />
@@ -33,11 +33,11 @@
3333
</dependencies>
3434
</metadata>
3535
<files>
36-
<file src="nanoFramework.M5AtomLite\bin\Release\nanoFramework.M5AtomLite.dll" target="lib\nanoFramework.M5AtomLite.dll" />
37-
<file src="nanoFramework.M5AtomLite\bin\Release\nanoFramework.M5AtomLite.pdb" target="lib\nanoFramework.M5AtomLite.pdb" />
38-
<file src="nanoFramework.M5AtomLite\bin\Release\nanoFramework.M5AtomLite.pdbx" target="lib\nanoFramework.M5AtomLite.pdbx" />
39-
<file src="nanoFramework.M5AtomLite\bin\Release\nanoFramework.M5AtomLite.pe" target="lib\nanoFramework.M5AtomLite.pe" />
40-
<file src="nanoFramework.M5AtomLite\bin\Release\nanoFramework.M5AtomLite.xml" target="lib\nanoFramework.M5AtomLite.xml" />
36+
<file src="nanoFramework.AtomLite\bin\Release\nanoFramework.AtomLite.dll" target="lib\nanoFramework.AtomLite.dll" />
37+
<file src="nanoFramework.AtomLite\bin\Release\nanoFramework.AtomLite.pdb" target="lib\nanoFramework.AtomLite.pdb" />
38+
<file src="nanoFramework.AtomLite\bin\Release\nanoFramework.AtomLite.pdbx" target="lib\nanoFramework.AtomLite.pdbx" />
39+
<file src="nanoFramework.AtomLite\bin\Release\nanoFramework.AtomLite.pe" target="lib\nanoFramework.AtomLite.pe" />
40+
<file src="nanoFramework.AtomLite\bin\Release\nanoFramework.AtomLite.xml" target="lib\nanoFramework.AtomLite.xml" />
4141
<file src="assets\readme.txt" target="" />
4242
<file src="README.md" target="docs\" />
4343
<file src="assets\nf-logo.png" target="images\" />

‎nanoFramework.M5AtomLite/M5AtomLite.cs‎ renamed to ‎nanoFramework.AtomLite/AtomLite.cs‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,21 @@
22
// The .NET Foundation licenses this file to you under the MIT license.
33

44
using Iot.Device.Button;
5+
using nanoFramework.Hardware.Esp32;
6+
using nanoFramework.Hardware.Esp32.Rmt;
57
using System;
6-
using System.Device.Gpio;
7-
using System.Device.Dac;
88
using System.Device.Adc;
9-
using nanoFramework.Hardware.Esp32.Rmt;
9+
using System.Device.Dac;
10+
using System.Device.Gpio;
1011
using System.Device.I2c;
11-
using nanoFramework.Hardware.Esp32;
1212
using System.Device.Spi;
1313

14-
namespace nanoFramework.M5AtomLite
14+
namespace nanoFramework.AtomLite
1515
{
1616
/// <summary>
17-
/// The M5AtomLite B=board
17+
/// The AtomLite Board.
1818
/// </summary>
19-
public static class M5AtomLite
19+
public static class AtomLite
2020
{
2121
private static GpioButton _button;
2222
private static RgbLed _rgbLed;
@@ -43,7 +43,7 @@ public static GpioButton Button
4343
}
4444

4545
/// <summary>
46-
/// RGB NeoPixel led
46+
/// RGB NeoPixel led.
4747
/// </summary>
4848
public static RgbLed NeoPixel
4949
{
@@ -60,12 +60,12 @@ public static RgbLed NeoPixel
6060
}
6161

6262
/// <summary>
63-
/// Gets the main GPIO Controller.
63+
/// Gets the main <see cref="GpioController"/>.
6464
/// </summary>
6565
public static GpioController GpioController => _gpio;
6666

6767
/// <summary>
68-
/// Gets DAC1 which is GPIO 25.
68+
/// Gets <see cref="DacChannel"/> connected to GPIO 25.
6969
/// </summary>
7070
public static DacChannel Dac1
7171
{
@@ -82,7 +82,7 @@ public static DacChannel Dac1
8282
}
8383

8484
/// <summary>
85-
/// Gets DAC1 which is GPIO 26.
85+
/// Gets <see cref="DacChannel"/> connected to GPIO 26.
8686
/// </summary>
8787
public static DacChannel Dac2
8888
{
@@ -100,16 +100,16 @@ public static DacChannel Dac2
100100
}
101101

102102
/// <summary>
103-
/// Gets an I2C device.
103+
/// Gets an <see cref="I2cDevice"/>.
104104
/// </summary>
105-
/// <param name="i2cDeviceAddress">The I2C device address on the bus.</param>
105+
/// <param name="i2cDeviceAddress">The address of the <see cref="I2cDevice"/> on the bus.</param>
106106
/// <returns>The I2cDevice.</returns>
107107
public static I2cDevice GetI2cDevice(int i2cDeviceAddress) => new(new I2cConnectionSettings(1, i2cDeviceAddress));
108108

109109
/// <summary>
110-
/// Gets an I2C device.
110+
/// Gets an <see cref="I2cDevice"/>.
111111
/// </summary>
112-
/// <param name="i2cDeviceAddress">The I2C device address on the bus.</param>
112+
/// <param name="i2cDeviceAddress">The address of the <see cref="I2cDevice"/> on the bus.</param>
113113
/// <returns>The I2cDevice.</returns>
114114
public static I2cDevice GetGrove(int i2cDeviceAddress) => new(new I2cConnectionSettings(1, i2cDeviceAddress));
115115

@@ -130,16 +130,16 @@ public static TransmitterChannel InfraredLed
130130
}
131131

132132
/// <summary>
133-
/// Gets an SPI Device.
133+
/// Gets an <see cref="SpiDevice"/>.
134134
/// </summary>
135135
/// <param name="chipSelect">The chip select of the device, needs to be any valid GPIO.</param>
136136
/// <returns>An SpiDevice.</returns>
137137
public static SpiDevice GetSpiDevice(int chipSelect) => new(new SpiConnectionSettings(1, chipSelect));
138138

139139
/// <summary>
140-
/// Gets an ADC channel
140+
/// Gets an <see cref="AdcChannel"/>
141141
/// </summary>
142-
/// <param name="gpioNumber">The GPIO pin number</param>
142+
/// <param name="gpioNumber">The GPIO pin number where the <see cref="AdcChannel"/> is connected to.</param>
143143
/// <returns>An AdcChannel</returns>
144144
public static AdcChannel GetAdcGpio(int gpioNumber)
145145
{
@@ -161,7 +161,7 @@ public static AdcChannel GetAdcGpio(int gpioNumber)
161161
}
162162
}
163163

164-
static M5AtomLite()
164+
static AtomLite()
165165
{
166166
// Setup first the I2C bus
167167
Configuration.SetPinFunction(32, DeviceFunction.I2C1_CLOCK);

‎nanoFramework.M5AtomLite/Properties/AssemblyInfo.cs‎ renamed to ‎nanoFramework.AtomLite/Properties/AssemblyInfo.cs‎

File renamed without changes.

‎nanoFramework.M5AtomLite/RgbLed.cs‎ renamed to ‎nanoFramework.AtomLite/RgbLed.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
using nanoFramework.Hardware.Esp32.Rmt;
55
using System.Drawing;
66

7-
namespace nanoFramework.M5AtomLite
7+
namespace nanoFramework.AtomLite
88
{
99
/// <summary>
1010
/// The RGB Led controller for M5Stack Atom Lite.

0 commit comments

Comments
 (0)