nanoFramework.System.Device.Model 1.0.288-preview.113

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
.NET Framework
This is a prerelease version of nanoFramework.System.Device.Model.
There is a newer version of this package available.
See the version list below for details.
dotnet add package nanoFramework.System.Device.Model --version 1.0.288-preview.113
NuGet\Install-Package nanoFramework.System.Device.Model -Version 1.0.288-preview.113
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.Model" Version="1.0.288-preview.113" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add nanoFramework.System.Device.Model --version 1.0.288-preview.113
#r "nuget: nanoFramework.System.Device.Model, 1.0.288-preview.113"
#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.
// Install nanoFramework.System.Device.Model as a Cake Addin
#addin nuget:?package=nanoFramework.System.Device.Model&version=1.0.288-preview.113&prerelease

// Install nanoFramework.System.Device.Model as a Cake Tool
#tool nuget:?package=nanoFramework.System.Device.Model&version=1.0.288-preview.113&prerelease

System.Device.Model - attributes for device bindings

This library is experimental, it may change and it may be moved to a different package in the future. Avoid taking direct dependency on it.

This library provides a set of attributes which allow to annotate devices.

They can be used for:

  • implementation of Azure Plug & Play
  • providing extra metadata about sensors (we can i.e. generate some parts of the README file or add extra checks)

Model is representing language independent description of the device. The attributes represent a C# mapping from C# types into the model.

InterfaceAttribute

Every class producing telemetry or exposing some commands should put a telemetry attribute on it

    [Interface("LPS25H - Piezoresistive pressure and thermometer sensor")]
    public class Lps25h : IDisposable
  • if class derives from class annotated with [Interface(...)] attribute:
    • class will inherit all annotations from the base class(es)
    • if class provides extra telemetry/command/properties it should add another InterfaceAttribute on itself
    • if class doesn't provide any extra annotations it should not have extra interface
  • display name must be provided to the InterfaceAttribute

TelemetryAttribute

Every method or property producing telemetry should have [Telemetry] attribute on it. For properties providing name of the Telemetry is optional as it can be deduced from the property name.

Telemetry can be put on:

  • properties
  • methods returning value but not taking any arguments
  • methods returning bool and taking one out argument
    • multiple out arguments are currently out of scope but are considered
        [Telemetry]
        public Temperature Temperature => Temperature.FromDegreesCelsius(42.5f + ReadInt16(Register.Temperature) / 480f);

        [Telemetry("Humidity")]
        public bool TryReadHumidity(out RelativeHumidity humidity) => TryReadHumidityCore(out humidity);

        [Telemetry("Pressure")]
        public Pressure ReadPressure() { /*...*/ }
  • if telemetry is not producing typed unit (i.e. Vector3) it should have additional displayName provided
  • optional arguments are treated as if they were not there
  • it's not allowed to have more than one Telemetry attribute with the same name on the same Interface

PropertyAttribute

Properties should be put on properties or methods which describe the device or change its functioning. They should only be used on things which don't change value between calls (unless it's been written to or a command has been executed on the device). Specifially reading (telemetry) from the device should not change the state of the property.

Usage is similar to Telemetry with some additions:

  • they can be writable
    • if same name (i.e. PowerMode) is used on i.e. SetPowerMode and ReadPowerMode they will be merged into a single model property
  • they can be put on methods without return value taking one argument (it must not be be passed by reference)
  • it's not allowed for more than one writers or readers with the same name to be present on the same interface
[Property]
public Sampling HumiditySampling { get { /*...*/ } set { /* ... */ } }

[Property("PowerMode")]
public void SetPowerMode(Bme680PowerMode powerMode) { /*...*/ }
[Property("PowerMode")]
public Bme680PowerMode ReadPowerMode() { /*...*/ }

ComponentAttribute

Components represent references to other (instances) of interfaces. They can only be put on the properties, the return type of the property or its ancestor class should have an Interface attribute.

[Component]
public SenseHatTemperatureAndHumidity TemperatureAndHumidity { get; private set; }

// ...
public class SenseHatTemperatureAndHumidity : Hts221.Hts221 { /* ... */ }
// ...
[Interface("HTS221 - Capacitive digital sensor for relative humidity and temperature")]
public class Hts221 : IDisposable { /* ... */ }

CommandAttribute

Commands can be something which can be executed on the device and they can be put only on methods.

[Command]
public void PlayTone(double frequency, int duraton) { /* ... */ }
[Command]
protected override void SetDefaultConfiguration() { /* ... */ }

Type serialization

Only simple types can be serialized:

  • enums (without Flags attribute)
    • values out of enum range are not permitted (i.e. bitwise combination)
  • UnitsNet units
  • basic C# types
  • System.Numerics.Vector2, System.Numerics.Vector3, System.Numerics.Vector4
  • System.Drawing.Color
Product Versions
.NET Framework net
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (40)

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

Package Downloads
nanoFramework.Iot.Device.Mpu6886 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.Mpu6886 for .NET nanoFramework C# projects.

nanoFramework.Iot.Device.Buzzer 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.Buzzer for .NET nanoFramework C# projects.

nanoFramework.Iot.Device.Bmm150 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.Bmm150 for .NET nanoFramework C# projects.

nanoFramework.Iot.Device.Bmxx80 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.Bmxx80 for .NET nanoFramework C# projects.

nanoFramework.Iot.Device.Bmp180 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.Bmp180 for .NET nanoFramework C# projects.

GitHub repositories (2)

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

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.2.216 13,859 1/6/2023
1.2.158 14,690 11/13/2022
1.2.141 9,633 10/25/2022
1.2.82 41,448 9/14/2022
1.1.113.2032 102,359 6/23/2022
1.1.1 117,186 4/14/2022
1.0.288 13,456 3/29/2022
1.0.288-preview.113 146 3/25/2022
1.0.288-preview.99 184 3/18/2022
1.0.288-preview.97 110 3/17/2022
1.0.288-preview.92 195 3/14/2022
1.0.288-preview.64 387 2/18/2022
1.0.288-preview.20 488 1/27/2022
1.0.259 3,335 12/9/2021
1.0.176 2,129 9/22/2021
1.0.160 1,179 9/6/2021