Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nanoframework/system.device.i2c.slave
📦 .NET nanoFramework library for Syste.Device.I2c.Slave
https://github.com/nanoframework/system.device.i2c.slave
dotnet embedded-systems esp32 giantgecko hacktoberfest i2c iot nanoframework nxp stm32
Last synced: 11 days ago
JSON representation
📦 .NET nanoFramework library for Syste.Device.I2c.Slave
- Host: GitHub
- URL: https://github.com/nanoframework/system.device.i2c.slave
- Owner: nanoframework
- License: mit
- Created: 2023-11-08T11:55:01.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-23T00:39:17.000Z (28 days ago)
- Last Synced: 2024-10-29T21:06:17.859Z (21 days ago)
- Topics: dotnet, embedded-systems, esp32, giantgecko, hacktoberfest, i2c, iot, nanoframework, nxp, stm32
- Language: C#
- Homepage: https://www.nanoframework.net
- Size: 47.9 KB
- Stars: 2
- Watchers: 5
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://sonarcloud.io/dashboard?id=nanoframework_System.Device.I2c.Slave) [](https://sonarcloud.io/dashboard?id=nanoframework_System.Device.I2c.Slave) [](https://www.nuget.org/packages/nanoFramework.System.Device.I2c.Slave/) [](https://github.com/nanoframework/Home/blob/master/CONTRIBUTING.md) [](https://discord.gg/gCyBu8T)
-----
# Welcome to the .NET **nanoFramework** System.Device.I2c.Slave Library repository
This repository contains the .NET **nanoFramework** System.Device.I2c.Slave class library.
## Build status
| Component | Build Status | NuGet Package |
|:-|---|---|
| System.Device.I2c.Slave | [](https://dev.azure.com/nanoframework/System.Device.I2c.Slave/_build/latest?definitionId=103&branchName=main) | [](https://www.nuget.org/packages/nanoFramework.System.Device.I2c.Slave/) |
## System.Device.I2c.Slave usage
### Creating an I2C slave device
To instantiate a new I2C slave device call the constructor passing the device address in the parameter and the I2C hardware bus where this device will be exposed from. Like this:
```csharp
// create an I2C slave device on bus 1 with address 0x10
var device = new I2cSlaveDevice(1, 0x10);
```
### Typical read/write operation
A common operation on an I2C device is to read the content of a specified address.
The following code snippet reads a byte with the "register address" and returns the content as an array of two bytes.
For simplicity no timeouts will be specified. Be aware that there are overloaded methods on the API that accept a timeout parameter in milliseconds.
```csharp
byte registerAddress;
if(device.ReadByte(out registerAddress))
{
switch(registerAddress)
{
// (...)
// return dummy content for register 0x22
case 0x22:
device.Write(new byte[] { 0xBE, 0xEF});
break;
// (...)
}
}
```
From the I2C master end, assuming that's a .NET nanoFramework device, using the [System.Device.I2c](https://github.com/nanoframework/System.Device.I2c) library, the code to perform the above operation on a slave device on I2C bus 1 would be like this:
```csharp
// create I2C device
var myI2cDevice = I2cDevice.Create(new I2cConnectionSettings(1, 0x10, I2cBusSpeed.FastMode));
// setup read buffer
var buffer = new byte[2];
// set address to read from
myI2cDevice.Write(new byte[] { 0x22 });
myI2cDevice.Read(buffer);
// expected buffer content is: 0xBE, 0xEF
Console.Writeline($"Register content: {buffer[0]:X2} {buffer[1]:X2}")
```
## Feedback and documentation
For documentation, providing feedback, issues and finding out how to contribute please refer to the [Home repo](https://github.com/nanoframework/Home).
Join our Discord community [here](https://discord.gg/gCyBu8T).
## Credits
The list of contributors to this project can be found at [CONTRIBUTORS](https://github.com/nanoframework/Home/blob/main/CONTRIBUTORS.md).
## License
The **nanoFramework** Class Libraries are licensed under the [MIT license](LICENSE.md).
## 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](https://dotnetfoundation.org/code-of-conduct).
### .NET Foundation
This project is supported by the [.NET Foundation](https://dotnetfoundation.org).