nanoFramework.System.Device.Spi 1.3.37

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
.NET Framework
dotnet add package nanoFramework.System.Device.Spi --version 1.3.37
NuGet\Install-Package nanoFramework.System.Device.Spi -Version 1.3.37
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.System.Device.Spi" Version="1.3.37" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add nanoFramework.System.Device.Spi --version 1.3.37
#r "nuget: nanoFramework.System.Device.Spi, 1.3.37"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install nanoFramework.System.Device.Spi as a Cake Addin
#addin nuget:?package=nanoFramework.System.Device.Spi&version=1.3.37

// Install nanoFramework.System.Device.Spi as a Cake Tool
#tool nuget:?package=nanoFramework.System.Device.Spi&version=1.3.37

Quality Gate Status Reliability Rating License NuGet #yourfirstpr Discord

nanoFramework logo


Welcome to the .NET nanoFramework System.Device.Spi Library repository

Build status

Component Build Status NuGet Package
System.Device.Spi Build Status NuGet

Usage

To create a SpiDevice, you need to follow this pattern:

SpiDevice spiDevice;
SpiConnectionSettings connectionSettings;
// Note: the ChipSelect pin should be adjusted to your device, here 12
// You can adjust as well the bus, here 1 for SPI1
connectionSettings = new SpiConnectionSettings(1, 12);
spiDevice = SpiDevice.Create(connectionSettings);

If you'll be controlling the state of the Chip Select line, you need to pass -1 to the second parameter of SpiConnectionSettings(...). When specifying a GPIO number the driver takes care of this for you by setting the appropriate state for the signal during the SPI transactions.

SpiConnectionSettings and SpiBusInfo

The SpiConnectionSettings contains the key elements needed to setup properly the hardware SPI device. Once created, those elements can't be adjusted.

connectionSettings.ChipSelectLineActiveState = PinValue.High; // Default is active Low
connectionSettings.ClockFrequency = 1_000_000;
connectionSettings.DataFlow = DataFlow.LsbFirst; // Default is MSB

To get the default bus values, especially the bus min and max frequencies, the maximum number of ChipSelect, you can use SpiBusInfo.

SpiBusInfo spiBusInfo = SpiDevice.GetBusInfo(1);
Debug.WriteLine($"{nameof(spiBusInfo.MaxClockFrequency)}: {spiBusInfo.MaxClockFrequency}");
Debug.WriteLine($"{nameof(spiBusInfo.MinClockFrequency)}: {spiBusInfo.MinClockFrequency}");

Reading and Writing

You can read, write and do a full transfer. You have the opportunity to use either a SpanByte, either a ushort array.

Important: in both cases, the data bit length will be automatically adjusted. So you can use both SpanByte and ushort array at the same time.

You can write a SpanByte like this:

SpanByte writeBuffer = new byte[2] { 42, 84 };
spiDevice.Write(writeBuffer);

You can write a ushort array like this:

ushort[] writeBuffer = new ushort[2] { 4200, 8432 };
spiDevice.Write(writeBuffer);

You can as well write a single byte:

spiDevice.WriteByte(42);

Read operations are similar:

SpanByte readBuffer = new byte[2];
// This will read 2 bytes
spiDevice.Read(readBuffer);
ushort[] readUshort = new ushort[4];
// This will read 4 ushort
spiDevice.Read(readUshort);
// read 1 byte
byte readMe = spiDevice.ReadByte();

For full transfer, you need to have 2 arrays of the same size and perform a full duplex transfer:

SpanByte writeBuffer = new byte[4] { 0xAA, 0xBB, 0xCC, 0x42 };
SpanByte readBuffer = new byte[4];
spiDevice.TransferFullDuplex(writeBuffer, readBuffer);
// Same for ushirt arrays:
ushort[] writeBuffer = new ushort[4] { 0xAABC, 0x00BB, 0xCC00, 0x4242 };
ushort[] readBuffer = new ushort[4];
spiDevice.TransferFullDuplex(writeBuffer, readBuffer);

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 Versions
.NET Framework net
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (29)

Showing the top 5 NuGet packages that depend on nanoFramework.System.Device.Spi:

Package Downloads
nanoFramework.M5Core2 The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

This package includes the nanoFramework.M5Core2 assembly for .NET nanoFramework C# projects.

nanoFramework.Iot.Device.Apa102 The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

This package includes the .NET IoT Core binding Iot.Device.Apa102 for .NET nanoFramework C# projects.

nanoFramework.M5Core The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

This package includes the nanoFramework.M5Core assembly for .NET nanoFramework C# projects.

nanoFramework.AtomLite The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

This package includes the nanoFramework.AtomLite assembly for .NET nanoFramework C# projects.

nanoFramework.AtomMatrix The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

This package includes the nanoFramework.AtomMatrix assembly for .NET nanoFramework C# projects.

GitHub repositories (2)

Showing the top 2 popular GitHub repositories that depend on nanoFramework.System.Device.Spi:

Repository Stars
nanoframework/Samples
🍬 Code samples from the nanoFramework team used in testing, proof of concepts and other explorational endeavours
nanoframework/nanoFramework.IoT.Device
📦 This repo includes .NET nanoFramework implementations for various sensors, chips, displays, hats and drivers
Version Downloads Last updated
1.3.37 4,406 12/27/2022
1.3.34 168 12/27/2022
1.3.32 200 12/22/2022
1.3.30 120 12/22/2022
1.3.22 19,119 10/11/2022
1.3.18 8,110 9/23/2022
1.3.15 11,737 9/14/2022
1.3.12 259 9/13/2022
1.3.8 4,253 9/7/2022
1.3.4 23,623 7/12/2022
1.3.2 5,949 7/6/2022
1.2.1 51,068 4/25/2022
1.1.1 8,209 4/21/2022
1.0.5 18,942 3/29/2022
1.0.5-preview.5 81 3/29/2022
1.0.5-preview.3 72 3/29/2022
1.0.4 83 3/28/2022
1.0.4-preview.14 68 3/28/2022
1.0.4-preview.11 311 3/17/2022
1.0.4-preview.9 83 3/17/2022
1.0.4-preview.7 164 3/14/2022
1.0.4-preview.5 72 3/14/2022
1.0.4-preview.3 362 3/3/2022
1.0.4-preview.1 165 2/24/2022
1.0.3-preview.24 148 2/18/2022
1.0.3-preview.21 75 2/17/2022
1.0.3-preview.19 241 2/4/2022
1.0.3-preview.17 263 1/28/2022
1.0.3-preview.15 91 1/28/2022
1.0.3-preview.13 88 1/28/2022
1.0.3-preview.11 186 1/22/2022
1.0.3-preview.9 136 1/21/2022
1.0.3-preview.7 94 1/21/2022
1.0.3-preview.5 95 1/21/2022
1.0.3-preview.3 293 12/29/2021
1.0.2 3,840 12/3/2021
1.0.2-preview.31 107 12/2/2021
1.0.2-preview.29 102 12/2/2021
1.0.2-preview.27 103 12/2/2021
1.0.2-preview.25 106 12/2/2021
1.0.2-preview.22 94 12/2/2021
1.0.2-preview.20 105 12/1/2021
1.0.2-preview.17 5,942 11/23/2021
1.0.2-preview.15 284 11/13/2021
1.0.2-preview.13 250 10/23/2021
1.0.2-preview.11 477 10/18/2021
1.0.2-preview.5 657 7/16/2021
1.0.2-preview.3 120 7/16/2021
1.0.1 633 7/16/2021
1.0.0-preview.80 111 7/16/2021
1.0.0-preview.77 139 7/15/2021
1.0.0-preview.75 136 7/14/2021
1.0.0-preview.70 385 6/20/2021
1.0.0-preview.68 233 6/19/2021
1.0.0-preview.65 124 6/8/2021
1.0.0-preview.63 133 6/7/2021
1.0.0-preview.61 156 6/7/2021
1.0.0-preview.59 227 6/5/2021
1.0.0-preview.57 138 6/3/2021
1.0.0-preview.55 125 6/2/2021
1.0.0-preview.53 152 6/1/2021
1.0.0-preview.51 167 5/31/2021
1.0.0-preview.50 179 5/31/2021
1.0.0-preview.49 165 5/31/2021
1.0.0-preview.48 152 5/31/2021
1.0.0-preview.46 154 5/30/2021
1.0.0-preview.44 126 5/29/2021
1.0.0-preview.42 404 5/26/2021
1.0.0-preview.40 440 5/25/2021
1.0.0-preview.38 641 5/20/2021
1.0.0-preview.36 118 5/19/2021
1.0.0-preview.34 155 5/19/2021
1.0.0-preview.32 134 5/15/2021
1.0.0-preview.30 120 5/14/2021
1.0.0-preview.28 145 5/13/2021
1.0.0-preview.26 120 5/12/2021
1.0.0-preview.24 252 5/6/2021
1.0.0-preview.21 125 5/4/2021
1.0.0-preview.19 509 4/29/2021