nanoframework/nanoFramework.IoT.DevicePublic

NotificationsYou must be signed in to change notification settings
Fork115
Star263

📦 This repo includes .NET nanoFramework implementations for various sensors, chips, displays, hats and drivers

License

MIT license

263 stars 115 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 1,593 Commits
.github/workflows		.github/workflows
.pipeline-assets		.pipeline-assets
StyleCop		StyleCop
assets		assets
devices		devices
src		src
tests		tests
.gitignore		.gitignore
LICENSE.md		LICENSE.md
NuGet.Config		NuGet.Config
README.md		README.md
azure-pipelines.yml		azure-pipelines.yml
migrate-binding-to-dotnetiot.md		migrate-binding-to-dotnetiot.md
tips-trick.md		tips-trick.md

Repository files navigation

Welcome to thenanoFramework IoT.Device Library repository!

This repository contains bindings which can be sensors, small screen and anything else that you can connect to your nanoFramework chip!

Most of the bindings have been migrated from.NET IoT repository. Not all the bindings make sense to migrate to .NET nanoFramework, so the effort of migration has been placed into devices that can work with .NET nanoFramework. Please note as well that some devices have been migrated without been tested, so they main contain problems.

List of devices

Folder Structure

/devices/ contains devices that were cleaned up and should be working out of the box.

/src/devices_generated/ contains devices that were automatically ported fromthe NET Core IoT Libraries devices. They might not work or compile at this point, but are a good starting point if you need support for one of the devices contained here but missing from the/devices/ folder.

/src/nanoFramework.IoT.Device.CodeConverter contains the tool used to generate the devices fromthe NET Core IoT Libraries devices.

Other folders in/src contain nanoFramework projects that you can reference when creating/updating devices with provide functionality such as a StopWatach, a DelayHelper, BinaryPrimitives or various System.Device.Model Attributes.

Contributing

Important: If you plan to clean up the code in/src/devices_generated/, please copy your work to the/devices/ folder as the content of/src/devices_generated/ will be overwritten by the generator tool.

Please check thedetail list of tips and tricks to facilitate the migration. The generator takes care of some heavy lifting but there is always some manual adjustments needed.

We are using the following structure for the bindings:

/devices  /Binding1    /samples      Binding1.Samples.nfproj      AssicateFile.cs      Program.cs    /test      BindingA.Test.nfproj      AssociatedTestFile.cs    Binding1.nfproj    Binding1.nuspec    version.json    OtherFiles.cs    OtherFiles.anythingelse    Readme.md

Using the Code Converter

The Code Converter allows to facilitate migration of .NET Core/.NET 5.0 code into .NET nanoFramework. More information and how tocustomize and run it here.

Porting a .NET nanoFramework binding to .NET IoT

Did you know that with minimal efforts you can make a nanoFramework binding available for .NET IoT as well? More information and guidance on the steps to take, can be found inthis article.

Feedback and documentation

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

Join our Discord communityhere.

Credits

The list of contributors to this project can be found atCONTRIBUTORS.

License

ThenanoFramework Class Libraries are licensed under theMIT license.

Code of Conduct

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