nanoFramework.M5Core2 1.1.232

欢迎使用 .NET nanoFramework M5Stack 库存储库

构建状态

组件	构建状态	NuGet 包
nanoFramework.M5Core
nanoFramework.M5Stick
nanoFramework.M5StickCPlus
nanoFramework.M5Core2
nanoFramework.Fire
nanoFramework.AtomLite
nanoFramework.AtomMatrix
nanoFramework.Tough

用法

这些 NuGet 包提供了对 M5Stack 产品支持的库

• 核心（灰色）和基础
• M5StickC
• M5StickCPlus
• M5Core2
• 火
• Atom Lite
• Atom Matrix
• 坚固

注意1：在添加 NuGet 包到您项目中和/或在使用 MS Visual Studio (VS) 擦写设备之前（参见下一部分），打开 VS > 工具 > 选项 > NuGet 包管理器 > 包来源，确保其中包含指向 https://api.nuget.org/v3/index.json 的条目，如果没有，则添加。注意2：当调用 VS > 项目 > 管理NuGet包时，请确保在包来源下拉菜单（右上角）中选择了“nuget.org”。

NuGet 包也提供了对屏幕的支持，并且需要用适当的应用程序文件进行烧录（使用nanoff dotnet CLI）。在下面的示例中，请将 COM3 替换为您设备连接的相应COM端口号。 （在Windows中，您可以在“设备管理器”中检查此信息）。

对于M5Core

nanoff --target M5Core --update --serialport COM3

对于M5StickC

nanoff --target M5StickC --update --serialport COM3 --baud 115200

对于M5StickCPlus

nanoff --target M5StickCPlus --update --serialport COM3

对于M5Core2、Tough和Fire

nanoff --target M5Core2 --update --serialport COM3

对于Atom Lite和Matrix

nanoff --target ESP32_PICO --update --serialport COM3

注意3：如果nanoff命令失败，请确保您已遵循上述第1点中的说明。

一旦您有了NuGet包，您就可以享受到访问屏幕、加速度计、获取Grove I2C连接器、在按钮上添加事件等功能。而且您甚至无需考虑任何事情，所有的一切都为您以最透明的方式进行

注意4：您将访问的所有类都使用Lazy模式进行实例化，包括屏幕。这的优点是最小化内存和设置时间。

在下面的示例中，我们将使用M5Core或M5Stick作为示例，它们都以非常相似的方式工作。

命名空间

请确保您在C#程序头部中添加正确的命名空间引用，例如：using nanoFramework;

屏幕

要访问屏幕，您只需要初始化它（请注意，InitializeScreen()是特定目标）例如：

对于Core

M5Core.InitializeScreen();

对于StickCPlus

M5StickCPlus.InitializeScreen();

初始化后，您既可以访问Screen静态类，也可以访问Console静态类。

Screen类提供了向屏幕直接绘图的原语，例如在屏幕的点或区域绘制颜色以及写入文本。

例如，您可以用如下方式在0，0的位置写一个10x10的蓝色方块：

ushort[] toSend = new ushort[100];
ushort blue = ColorUtility.To16Bpp(Color.Blue);

for (int i = 0; i < toSend.Length; i++)
{
    toSend[i] = blue;
}

Screen.Write(0, 0, 10, 10, toSend);

Console类与经典System.Console的工作方式类似。为了使用它，您必须使用方法的全称进行引用，如下所示：

nanoFramework.Console.Clear();

// Test the console display
nanoFramework.Console.Write("This is a short text. ");
nanoFramework.Console.ForegroundColor = nanoFramework.Presentation.Media.Color.Red;
nanoFramework.Console.WriteLine("This one displays in red after the previous one and is already at the next line.");
nanoFramework.Console.BackgroundColor = nanoFramework.Presentation.Media.Color.Yellow;
nanoFramework.Console.ForegroundColor = nanoFramework.Presentation.Media.Color.RoyalBlue;
nanoFramework.Console.WriteLine("And this is blue on yellow background");
nanoFramework.Console.ResetColor();
nanoFramework.Console.CursorLeft = 0;
nanoFramework.Console.CursorTop = 8;
nanoFramework.Console.Write("This is white on black again and on 9th line");

注意：您也可以更改默认字体，您需要提供它作为属性。光标位置是使用最大的字符计算得出的。

M5Core2和Fire有PSRAM，因此您还可以得到完整的屏幕缓冲区。参考图形样本了解您可以做什么。

如果您对任何M5Stack有大量的图形需求，您可以根据需要调整请求的内存。虽然M5Core2和Fire都有PSRAM并能容纳2 Mb或更多的非常大的数据量，而没有PSRAM的设备则不能超过几个Kb或几十Kb。

// This will allocate 2 Mb of memory for the graphics
M5Core2.InitializeScreen(2 * 1024 * 1024);

按钮

除了电源按钮之外的主要按钮都被公开了。

在M5Stack和Fire上，它们被称为ButtonLeft、ButtonCenter和ButtonRight。您可以访问事件。例如：

M5Stack.ButtonLeft.Press += (sender, e) =>
{
    Console.ForegroundColor = Color.Yellow;
    Console.CursorLeft = 0;
    Console.CursorTop = 0;
    Console.Write($"Left Pressed  ");
};

在M5StickC/CPlus上，它们被称为ButtonM5和ButtonRight。您可以访问按钮的状态、事件以及您需要的所有东西。例如：

while (!M5StickC.ButtonRight.IsPressed)
{
    Thread.Sleep(10);
}

M5StickC.M5Button.IsHoldingEnabled = true;
M5StickC.M5Button.Holding += (sender, e) =>
{
    Console.Write("M5 button hold long.");
};

在Atom Lite/Matrix上，它被称为Button。您可以访问按钮的状态、事件以及您所需的所有东西。例如：

AtomLite.Button.Press +=> (sender, e)
{
    var color = AtomLite.NeoPixel.GetColor();
    if(color.R > 0)
    {
        AtomLite.NeoPixel.SetColor(Color.FromArgb(255, 0, 255, 0));
    }
    else if (color.G > 0)
    {
        AtomLite.NeoPixel.SetColor(Color.FromArgb(255, 0, 0, 255));
    }
    else
    {
        AtomLite.NeoPixel.SetColor(Color.FromArgb(255, 255, 0, 0));
    }
};

注意：M5Core2有触摸屏，按钮是“虚拟”的。见下一节了解如何使用它们。

M5Core2触摸屏和按钮

触摸屏与屏幕一同提供。两者同时初始化和激活。要获取触摸事件，您需要注册到TouchEvent事件

M5Core2.InitializeScreen();
M5Core2.TouchEvent += TouchEventCallback;

以下是如何检查是否在按钮上以及获取各种元素的示例：

void TouchEventCallback(object sender, TouchEventArgs e)
{
    const string StrLB = "LEFT BUTTON PRESSED  ";
    const string StrMB = "MIDDLE BUTTON PRESSED  ";
    const string StrRB = "RIGHT BUTTON PRESSED  ";
    const string StrXY1 = "TOUCHED at X= ";
    const string StrXY2 = ",Y= ";
    const string StrID = ",Id= ";
    const string StrDoubleTouch = "Double touch. ";
    const string StrMove = "Moving... ";
    const string StrLiftUp = "Lift up. ";

    Debug.WriteLine($"Touch Panel Event Received Category= {e.EventCategory} Subcategory= {e.TouchEventCategory}");
    Console.CursorLeft = 0;
    Console.CursorTop = 0;

    Debug.WriteLine(StrXY1 + e.X + StrXY2 + e.Y + StrID + e.Id);
    Console.WriteLine(StrXY1 + e.X + StrXY2 + e.Y + StrID + e.Id + "  ");

    if ((e.TouchEventCategory & TouchEventCategory.LeftButton) == TouchEventCategory.LeftButton)
    {
        Debug.WriteLine(StrLB);
        Console.WriteLine(StrLB);
    }
    else if ((e.TouchEventCategory & TouchEventCategory.MiddleButton) == TouchEventCategory.MiddleButton)
    {
        Debug.WriteLine(StrMB);
        Console.WriteLine(StrMB);
    }
    else if ((e.TouchEventCategory & TouchEventCategory.RightButton) == TouchEventCategory.RightButton)
    {
        Debug.WriteLine(StrRB);
        Console.WriteLine(StrRB);
    }

    if ((e.TouchEventCategory & TouchEventCategory.Moving) == TouchEventCategory.Moving)
    {
        Debug.WriteLine(StrMove);
        Console.Write(StrMove);
    }

    if ((e.TouchEventCategory & TouchEventCategory.LiftUp) == TouchEventCategory.LiftUp)
    {
        Debug.WriteLine(StrLiftUp);
        Console.Write(StrLiftUp);
    }

    if ((e.TouchEventCategory & TouchEventCategory.DoubleTouch) == TouchEventCategory.DoubleTouch)
    {
        Debug.WriteLine(StrDoubleTouch);
        Console.Write(StrDoubleTouch);
    }

    Console.WriteLine("                                    ");
    Console.WriteLine("                                    ");
    Console.WriteLine("                                    ");
}

TouchEventCategory 枚举是一个标记，可以组合按钮和状态。按钮是互斥的，因此您只能有左键、中键或右键，状态有 Moving 和 LiftUp。 Moving 发生在已经建立接触且触摸点在移动时。当接触被释放时会出现 LiftUp。

DoubleTouch 是一个特定类型，它会通知您有另一个接触点发生。每个接触点都会接收到此标记。该事件将触发2次，每次为一个点。在双触控上下文中，您可能无法获得第二个点的 LiftUp 事件，但您将获得与双触控标记消失有关的变更以及第一个点的最终 LiftUp。

电源管理

M5Core 和 M5StickC/CPlus 正在公开它们的电源管理元素。除非您知道自己在做什么，否则不建议更改任何默认值。

有关 M5StickC/CPlus 中使用的 AXP192 的详细信息，请参阅；M5Core2 和 IP5306 用于 M5Core 和 Fire。

加速度计和陀螺仪

您可以像这样获取对加速度计和陀螺仪的访问权限

var ag = M5Core.AccelerometerGyroscope;
// Do not move the M5Core/M5Stick during the calibration
ag.Calibrate(100);
var acc = ag.GetAccelerometer();
var gyr = ag.GetGyroscope();
Debug.WriteLine($"Accelerometer data x:{acc.X} y:{acc.Y} z:{acc.Z}");
Debug.WriteLine($"Gyroscope data x:{gyr.X} y:{gyr.Y} z:{gyr.Z}\n");

请参阅 MPU6886 文档 以获取该传感器在详细信息上的更多使用方法。

磁力计

M5Core 具有磁力计，您也可以访问它

var mag = M5Core.Magnetometer;
// It is more than strongly recommended to calibrate the magnetometer.
// Move the M5Core in all directions to have a proper calibration.
mag.CalibrateMagnetometer(100);
var magVal = mag.ReadMagnetometer();
Console.WriteLine($"x={magVal.X:N2}   ");
Console.WriteLine($"y={magVal.Y:N2}   ");
Console.WriteLine($"Z={magVal.Z:N2}   ");
var headDir = Math.Atan2(magVal.X, magVal.Y) * 180.0 / Math.PI;
Console.WriteLine($"h={headDir:N2}  ");

串行端口

M5Core 和 M5Core2 可以提供串行端口，只需这样获取即可

// You can access any of the Serial Port feature
M5Core.SerialPort.Open(115200);
// Do anything else you need
M5Core.SerialPort.Close();

有关更多信息，请参阅 串行端口文档。

ADC 通道

在 M5Core、M5Core2、Fire 和 Atom Lite/Matrix 上预先设置了 ADC 通道，可以像这样访问它们

// This will give you the ADC1 channel 7 which is on pin 35 of M5Core
AdcChannel myChannel = M5Core.GetAdcGpio(35);

请参阅 M5Stack 文档，以获取 ADC 通道和引脚的映射。

I2C 设备/Grove

您可以像这样获取 I2cDevice/Grove

// In this example, the I2C address of the device is 0x42:
I2cDevice myDevice = M5Core.GetGrove(0x42);
// replacing GetGrove by GetI2cDevice will have the same impact

SPI 设备

M5Core、M5Core2、Fire 和 Atom Lite/Matrix 还提供 SpiDevice

// In this case GPIO5 will be used as chip select:
SpiDevice mySpi = M5Core.GetSpiDevice(5);

GPIO 控制器

与之前类似，您可以在 M5Core、M5Core2、Fire 和 M5StickC/CPlus 中的任何一个上获取 GpioController

// This will open the GPIO 36 as output
var pin5 = M5StickC.GpioController.OpenPin(36, PinMode.Output);

DAC

M5Core、M5Core2、Fire 和 Atom Lite/Matrix 揭露了 2 个 DAC，您可以通过 Dac1 和 Dac2 属性访问它们。有关更多信息，请参阅 DAC 文档。

I2S（声音）

在 M5Core2 上，可以通过安装 nanoFramework.System.Device.I2s 软件包使用 I2S 播放 .wav 文件。要在 M5Core2 上播放 .wav 文件，使用以下初始化

int bckPin = 12;
int dataPin = 2;
int wsPin = 0;
I2sWavPlayer.Bus bus = I2sWavPlayer.Bus.One;
var audioFile = "D:\\Variation-CLJ013901.wav";
using (var player = new I2sWavPlayer(bus, audioFile, bckPin, dataPin, wsPin))
{
    M5Core2.Power.Gpio2Value = PinValue.High; //speaker power on
    player.Play();
    M5Core2.Power.Gpio2Value = PinValue.Low; //speaker power off
}

LED

M5StickC/CPlus 揭露了一个 LED。您可以通过 Led 属性访问它

// This will toggle the led:
M5StickC.Led.Toggle();

红外 LED

M5StickC/CPlus 和 Atom Lite/Matrix 揭露了一个红外 LED。您可以通过 InfraredLed 属性访问它。这将为您提供 TransmitterChannel。查看 示例包 了解如何使用它。

AtomLite 上的 NeoPixel

Atom Lite 揭露了一个 RGB LED。您可以通过 NeoPixel 属性访问它

// This will set NeoPixel to green:
AtomLite.NeoPixel.Image.SetPixel(0, 0, Color.Green);
AtomLite.NeoPixel.Update();

AtomMatrix 上的 RGB LED 矩阵和 Fire 上的 LED 棒

Atom Matrix 有一个 25 个 RGB LED 的矩阵。LED 在数组中的位置遵循矩阵中的位置，0 是左上角的 LED，从左到右，从上到下增长。

您可以通过 AtomMatrix 上的 LedMatrix 属性访问它，如下所示

// This will set the RGB LED at position 2, 2 to green
AtomMatrix.LedMatrix.Image.SetPixel(2, 2, Color.Green);

同样，您可以在Fire上访问LedBar属性。

// This will set the second RGB LED to green
Fire.LedBar.Image.SetPixel(2, 0, Color.Green);

在更新完所有需要更改的LED后，像这样将更新刷入LED：

// This will update all RGB LED 
AtomMatrix.LedMatrix.Update();

在Fire上

// This will update all RGB LED 
Fire.LedBar.Update();

SD卡

M5Core、M5Core2、Fire和Tough都配备了SD卡读卡器。您可以简单地访问它，如下所述：

SDCard sdCard = M5Core.SDCard;
try
{
    // This will actually mount the SD Card, if no card, you will get an exception
    sdCard.Mount();
    // Mounting properly a card can take a bit of time, so wait for the card to be mounted
    // Note: it is recommended to use a cancellation token or equivalent to make sure you are not in a dead loop
    while (!sdCard.IsMounted)
    {
        Thread.Sleep(10);
    }

    // You can now access the files on the SD Card
    // As an example you can read a json file and deserialize it
    // D: is the drive from the SD Card
    const string ParamFile = "D:\\params.json";
    using FileStream fs = new FileStream(ParamFile, FileMode.Open, FileAccess.Read);
    // In this case, you will need to have a class called Configuration and a properly serialized file
    Configuration config = (Configuration)JsonConvert.DeserializeObject(fs, typeof(Configuration));
}
catch
{
    // Something wrong happened
}

有关如何使用文件系统的更多示例，请参见此处。

反馈和文档

有关文档、提供反馈、报告问题和了解如何贡献力量，请参阅主页仓库。

加入我们的Discord社区这里。

鸣谢

此项目的贡献者名单可在CONTRIBUTORS中找到。

许可证

nanoFramework类库的授权协议为MIT许可。

行为准则

本项目采用贡献者誓言中定义的行为准则，以阐明我们社区中预期的行为。更多信息请参阅.NET Foundation行为准则。

.NET Foundation

本项目由.NET Foundation支持。