nanoFramework.M5Core 1.0.1-preview.12

Prefix Reserved
This is a prerelease version of nanoFramework.M5Core.
There is a newer version of this package available.
See the version list below for details.
dotnet add package nanoFramework.M5Core --version 1.0.1-preview.12
                    
NuGet\Install-Package nanoFramework.M5Core -Version 1.0.1-preview.12
                    
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.M5Core" Version="1.0.1-preview.12" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="nanoFramework.M5Core" Version="1.0.1-preview.12" />
                    
Directory.Packages.props
<PackageReference Include="nanoFramework.M5Core" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add nanoFramework.M5Core --version 1.0.1-preview.12
                    
#r "nuget: nanoFramework.M5Core, 1.0.1-preview.12"
                    
#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.
#addin nuget:?package=nanoFramework.M5Core&version=1.0.1-preview.12&prerelease
                    
Install nanoFramework.M5Core as a Cake Addin
#tool nuget:?package=nanoFramework.M5Core&version=1.0.1-preview.12&prerelease
                    
Install nanoFramework.M5Core as a Cake Tool

Quality Gate Status Reliability Rating License NuGet #yourfirstpr Discord

nanoFramework logo


Welcome to the .NET nanoFramework M5Stack Libraries repository

Build status

Component Build Status NuGet Package
nanoFramework.M5Core Build Status NuGet
nanoFramework.M5Core (preview) Build Status NuGet
nanoFramework.M5Stick Build Status NuGet
nanoFramework.M5Stick (preview) Build Status NuGet
nanoFramework.M5StickCPlus Build Status NuGet
nanoFramework.M5StickCPlus (preview) Build Status NuGet
nanoFramework.M5Core2 Build Status NuGet
nanoFramework.M5Core2 (preview) Build Status NuGet

Usage

These NuGet packages provide a support for M5Stack products:

NOTE1: Before trying to add NuGet packages to your projects and/or before flashing the devices (see next section) using MS Visual Studio (VS), open VS > Tools > Options > NuGet Package Manager > Package Sources and make sure that it contains an entry pointing to https://api.nuget.org/v3/index.json , otherwise add it. NOTE2: When invoking VS > Project > Manage NuGet Packages make sure that in the Package source drop-down menu (right upper corner) "nuget.org" is selected. Also if you're using preview version the "include prerelease" checkbox should be clicked/selected as well.

The NuGets bring support for the screens as well and require to be flashed with the proper image (using nanoff dotnet CLI). On the examples below replace COM3 with the appropriate number of the COM port to which your device is connected. (on Windows you can check this in the Device Manager).

For the M5Core:

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

For the M5StickC:

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

For the M5StickCPlus:

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

For the M5Core2:

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

NOTE3: If the nanoff commands fails, make sure you have followed instruction from NOTE1 above.

Once you have the NuGets, you can then enjoy accessing the screen, the accelerometer, get a Grove I2C connecter, add events on the buttons. And you don't even need to think about anything, all is done for you in the most transparent way!

Note: All the classes that you'll have access are all using the Lazy pattern to be instantiated including the screen. This have the advantage to use as little memory and setup time as possible.

In the samples below, we'll use either M5Core or M5Stick as examples, they are all working in a very similar way.

Namespaces

Make sure you add the proper namespaces reference to your C# program header e.g. using nanoFramework;

Screen

The only thing you need to do to access the screen is to initialize it (please note that InitializeScreen() it's target specific) e.g.:

For Core:

M5Core.InitializeScreen();

For StickCPlus:

M5StickCPlus.InitializeScreen();

Once you've initialized it, you can access both a Screen static class and a Console static class.

THe Screen one brings primitives to write directly on the screen points or scare of colours as well as writing a text.

For example, you can write a blue square of 10x10 at the position 0, 0 like this:

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);

The Console class works in a similar way as the classic System.Console. In order to use it you have to reference it using the fully qualified name of the methods, like this:

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");

Note: You can change the default font as well, you need to provide it as a property. The Cursor positions are calculated with the largest possible character.

M5Core2 has SPRAM, so you can get a full screen buffer as well. Refer to the Graphics samples to understand all you can do with it.

Buttons

The main buttons except the power buttons are exposed.

On the M5Stack they are called ButtonLeft, ButtonCenter and ButtonRight. You can get access to the events as well. For example:

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

On the M5StickC/CPlus they are called ButtonM5 and ButtonRight. You can get access to the status of the button, the events and everything you need. For example:

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

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

Note: The M5Core2 has touch screen and the buttons are "virtual"". At the time of this writing the .NET nanoFramework team is implementing and testing the touch-screen (touch-panel) functionality (will be released soon).

Power management

The M5Core and M5StickC/CPlus are exposing their power management elements. It is not recommended to change any default value except if you know what you are doing.

Please refer to the detailed examples for the AXP192 used in the M5StickC/CPlus; M5Core2 and IP5306 for the M5Core.

Accelerometer and Gyroscope

You can get access to the Accelerometer and Gyroscope like this:

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");

Refer to the MPU6886 documentation for more detailed usage on this sensor.

Magnetometer

The M5Core has a magnetometer, you can access it as well:

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}  ");

SerialPort

The M5Core and M5Core2 can provide a Serial Port, just get it like this:

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

Refer to the SerialPort documentation for more information.

ADC Channels

ADC Channels are pre setup on the M5Core, access them like this:

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

Refer to the M5Stack documentation to have the mapping of the ADC channels and the pins.

I2C Device/Grove

You can get an I2cDevice/Grove like this:

// 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 Device

The M5Core provides as well an SpiDevice:

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

GPIO Controller

Similar as previously, you can get the GpioController on any of the M5Core, M5Core2 and M5StickC/CPlus:

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

DAC

The M5Core exposes 2 DAC and you can access them thru the Dac1 and Dac2 properties. Refer to the DAC documentation for more information.

Led

The M5StickC/CPlus exposes a led. You can access it thru the Led property:

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

Infrared Led

The M5StickC/CPlus exposes an infrared led. You can access it thru the InfraredLed property. This will give you a TransmitterChannel. Check out the sample pack to understand how to use it.

Feedback and documentation

For documentation, providing feedback, issues and finding out how to contribute please refer to the Home repo.

Join our Discord community here.

Credits

The list of contributors to this project can be found at CONTRIBUTORS.

License

The nanoFramework Class Libraries are licensed under the MIT license.

Code of Conduct

This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behaviour in our community. For more information see the .NET Foundation Code of Conduct.

.NET Foundation

This project is supported by the .NET Foundation.

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

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.1.280 154 a month ago
1.1.279 167 2 months ago
1.1.278 169 2 months ago
1.1.277 164 2 months ago
1.1.276 161 3 months ago
1.1.275 170 3 months ago
1.1.274 213 3 months ago
1.1.273 150 3 months ago
1.1.272 120 3 months ago
1.1.271 107 3 months ago
1.1.270 109 3 months ago
1.1.269 115 3 months ago
1.1.268 116 3 months ago
1.1.267 105 3 months ago
1.1.266 114 3 months ago
1.1.265 127 4 months ago
1.1.264 115 4 months ago
1.1.263 108 4 months ago
1.1.262 121 4 months ago
1.1.261 106 4 months ago
1.1.260 100 4 months ago
1.1.259 105 4 months ago
1.1.255 105 4 months ago
1.1.253 124 5 months ago
1.1.252 114 5 months ago
1.1.249 109 6 months ago
1.1.248 102 6 months ago
1.1.247 126 6 months ago
1.1.246 137 7 months ago
1.1.245 136 8 months ago
1.1.244 103 8 months ago
1.1.243 116 8 months ago
1.1.242 125 8 months ago
1.1.241 111 8 months ago
1.1.240 112 8 months ago
1.1.239 123 8 months ago
1.1.238 117 9 months ago
1.1.236 128 9 months ago
1.1.235 133 9 months ago
1.1.234 148 10 months ago
1.1.232 110 7/31/2024
1.1.229 122 7/19/2024
1.1.228 116 7/17/2024
1.1.227 111 7/12/2024
1.1.225 135 6/28/2024
1.1.223 124 6/19/2024
1.1.220 132 5/31/2024
1.1.217 140 5/15/2024
1.1.215 118 5/10/2024
1.1.213 145 4/17/2024
1.1.211 139 4/15/2024
1.1.209 142 4/5/2024
1.1.207 109 3/27/2024
1.1.203 140 2/28/2024
1.1.201 156 1/31/2024
1.1.199 134 1/26/2024
1.1.197 133 1/24/2024
1.1.187 258 11/17/2023
1.1.185 157 11/14/2023
1.1.183 163 11/9/2023
1.1.180 155 11/8/2023
1.1.177 190 10/11/2023
1.1.175 183 9/29/2023
1.1.171 186 9/8/2023
1.1.169 155 9/6/2023
1.1.167 209 8/18/2023
1.1.163 230 8/2/2023
1.1.161 199 7/28/2023
1.1.157 207 7/19/2023
1.1.155 197 7/14/2023
1.1.152 201 6/21/2023
1.1.150 178 6/14/2023
1.1.148 199 6/7/2023
1.1.146 187 5/31/2023
1.1.144 216 5/24/2023
1.1.142 211 5/17/2023
1.1.139 208 5/11/2023
1.1.137 240 5/5/2023
1.1.135 283 4/5/2023
1.1.133 291 3/29/2023
1.1.131 305 3/24/2023
1.1.128 293 3/17/2023
1.1.125 290 3/16/2023
1.1.123 287 3/13/2023
1.1.121 308 3/9/2023
1.1.119 310 2/27/2023
1.1.117 324 2/27/2023
1.1.115 328 2/22/2023
1.1.113 312 2/20/2023
1.1.111 296 2/16/2023
1.1.106 351 1/10/2023
1.1.104 355 1/9/2023
1.1.102 353 1/6/2023
1.1.100 356 1/6/2023
1.1.98 383 1/5/2023
1.1.96 372 12/29/2022
1.1.90 422 11/15/2022
1.1.88 418 11/14/2022
1.1.86 418 11/5/2022
1.1.84 450 11/5/2022
1.1.82 403 11/4/2022
1.1.80 423 11/3/2022
1.1.78 440 11/1/2022
1.1.76 441 10/27/2022
1.1.70 487 10/13/2022
1.1.68 478 10/12/2022
1.1.64 442 10/7/2022
1.1.62 463 10/7/2022
1.1.58 550 9/23/2022
1.1.55 520 9/23/2022
1.1.53 498 9/22/2022
1.1.47 515 9/21/2022
1.1.45 524 9/16/2022
1.1.42 514 9/15/2022
1.1.40 489 9/8/2022
1.1.38 498 9/7/2022
1.1.36 500 9/3/2022
1.1.34 520 8/15/2022
1.1.32 527 8/6/2022
1.1.30 483 8/5/2022
1.1.28 486 8/4/2022
1.1.26 530 8/3/2022
1.1.24 493 8/3/2022
1.1.22 505 8/2/2022
1.1.20 545 7/30/2022
1.1.18 500 7/26/2022
1.1.16 499 7/24/2022
1.1.14 506 7/23/2022
1.1.12 529 7/13/2022
1.1.7 518 7/7/2022
1.1.5 554 7/7/2022
1.1.3 559 7/6/2022
1.1.1 526 7/5/2022
1.0.107.13280 521 7/1/2022
1.0.105.49254 560 6/30/2022
1.0.102.851 545 6/28/2022
1.0.100.17145 531 6/28/2022
1.0.98.48733 547 6/28/2022
1.0.96.40373 524 6/26/2022
1.0.92.59206 544 6/24/2022
1.0.90.38187 523 6/16/2022
1.0.88.50207 500 6/15/2022
1.0.86.52668 500 6/14/2022
1.0.83.14512 554 6/13/2022
1.0.81.41619 508 6/8/2022
1.0.79.53990 515 6/3/2022
1.0.77.26764 508 6/3/2022
1.0.75.37268 521 6/1/2022
1.0.72.43325 517 5/31/2022
1.0.70.15497 517 5/31/2022
1.0.68.55953 538 5/31/2022
1.0.66.24331 489 5/27/2022
1.0.64.6330 521 5/26/2022
1.0.62.28047 488 5/26/2022
1.0.60.49583 501 5/25/2022
1.0.58.20063 507 5/24/2022
1.0.56.35800 515 5/23/2022
1.0.54.60782 516 5/20/2022
1.0.51.48271 537 5/12/2022
1.0.49.30985 520 5/6/2022
1.0.46 514 5/5/2022
1.0.42 528 4/26/2022
1.0.40 524 4/25/2022
1.0.38 525 4/24/2022
1.0.36 525 4/23/2022
1.0.34 523 4/22/2022
1.0.32 504 4/22/2022
1.0.30 517 4/21/2022
1.0.26 537 4/21/2022
1.0.24 514 4/20/2022
1.0.22 538 4/19/2022
1.0.20 514 4/18/2022
1.0.18 521 4/17/2022
1.0.16 525 4/16/2022
1.0.14 525 4/15/2022
1.0.12 570 4/13/2022
1.0.10 531 4/6/2022
1.0.8 526 4/4/2022
1.0.6 523 4/3/2022
1.0.4 532 3/31/2022
1.0.2 524 3/31/2022
1.0.1-preview.68 156 3/30/2022
1.0.1-preview.67 170 3/25/2022
1.0.1-preview.66 167 3/25/2022
1.0.1-preview.65 152 3/25/2022
1.0.1-preview.64 165 3/23/2022
1.0.1-preview.63 149 3/22/2022
1.0.1-preview.62 159 3/21/2022
1.0.1-preview.61 159 3/20/2022
1.0.1-preview.60 159 3/19/2022
1.0.1-preview.58 167 3/16/2022
1.0.1-preview.57 161 3/16/2022
1.0.1-preview.56 160 3/14/2022
1.0.1-preview.55 160 3/14/2022
1.0.1-preview.54 163 3/11/2022
1.0.1-preview.53 162 3/9/2022
1.0.1-preview.52 174 3/8/2022
1.0.1-preview.51 165 3/7/2022
1.0.1-preview.50 157 3/4/2022
1.0.1-preview.49 158 3/3/2022
1.0.1-preview.48 168 2/27/2022
1.0.1-preview.47 164 2/26/2022
1.0.1-preview.46 166 2/25/2022
1.0.1-preview.45 169 2/18/2022
1.0.1-preview.43 165 2/16/2022
1.0.1-preview.42 178 2/12/2022
1.0.1-preview.41 163 2/10/2022
1.0.1-preview.40 162 2/9/2022
1.0.1-preview.39 169 2/8/2022
1.0.1-preview.38 170 2/6/2022
1.0.1-preview.37 171 2/5/2022
1.0.1-preview.36 176 2/4/2022
1.0.1-preview.35 179 2/3/2022
1.0.1-preview.34 182 1/31/2022
1.0.1-preview.32 183 1/31/2022
1.0.1-preview.31 183 1/29/2022
1.0.1-preview.30 176 1/28/2022
1.0.1-preview.28 176 1/28/2022
1.0.1-preview.26 180 1/27/2022
1.0.1-preview.25 185 1/27/2022
1.0.1-preview.24 179 1/26/2022
1.0.1-preview.23 175 1/24/2022
1.0.1-preview.22 178 1/21/2022
1.0.1-preview.21 179 1/21/2022
1.0.1-preview.20 176 1/21/2022
1.0.1-preview.19 181 1/21/2022
1.0.1-preview.18 188 1/20/2022
1.0.1-preview.17 183 1/20/2022
1.0.1-preview.16 181 1/16/2022
1.0.1-preview.15 174 1/14/2022
1.0.1-preview.14 182 1/14/2022
1.0.1-preview.13 180 1/12/2022
1.0.1-preview.12 181 1/11/2022
1.0.1-preview.9 180 1/5/2022
1.0.1-preview.8 181 12/31/2021
1.0.1-preview.7 173 12/31/2021
1.0.1-preview.6 182 12/29/2021
1.0.1-preview.5 187 12/28/2021