nanoFramework.M5Core 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
• Fire
• Atom Lite
• Atom Matrix
• Tough

注意 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包，您就可以 Enjoy 访问屏幕、加速度计、获取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或更多的非常大的数值，但那些没有的不能超过几个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 是一个特征，让您知道在发生另一个接触点。每个接触点都将接收到此标志。事件会触发两次，一次针对每个点。在双触控上下文中，您可能不会获得第二个点的 LiftUp 事件，但您会在 DoubleTouch 标志消失和第一个点的最终 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();

有关更多信息，请参阅 SerialPort 文档。

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 表示位于左上角的一个，向左向右，从上到下增长。

您可以通过 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的支持。