nanoFramework.System.Device.Model 1.2.586

System.Device.Model - 设备绑定的属性

此库是试验性的，未来可能发生变化，也可能移动到不同的包中。请避免直接依赖它。

此库提供了一组属性，可以用来注释设备。

它们可以用于

• Azure 插拔式实现
• 提供关于传感器的额外元数据（例如，我们可以生成一些 README 文件的部分或添加额外的检查）

模型表示与语言无关的设备描述。属性表示从 C# 类型到模型的 C# 映射。

InterfaceAttribute

应将遥测属性放在所有生成遥测或公开命令的类上

    [Interface("LPS25H - Piezoresistive pressure and thermometer sensor")]
    public class Lps25h : IDisposable

• 如果类是从用 [Interface(...)] 属性注释的类派生的
  • 类将继承基础类（或类）的所有注释
  • 如果类提供了额外的遥测/命令/属性，则应为其本身添加另一个 InterfaceAttribute
  • 如果类不提供任何额外的注释，则不应有额外的接口
• InterfaceAttribute 必须提供显示名称

TelemetryAttribute

每个产生遥测的方法或属性都应该带有[遥测]属性。对于提供遥测名称的属性是可选的，因为可以从属性名称中推断出来。

遥测可以放置在：

• 属性
• 返回值但不接受任何参数的方法
• 返回bool类型并接受一个out参数的方法
  • 多个out参数目前不适用，但正在考虑中

        [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() { /*...*/ }

• 如果遥测没有生成类型化单元（即Vector3），则应提供额外的displayName
• 可选参数被视为不存在
• 不允许在相同的Interface上有多个同名Telemetry属性

PropertyAttribute

属性应该放置在表示设备或改变其功能的功能属性或方法上。它们应该只在调用之间不更改值的对象上使用（除非已经写入或已在设备上执行了命令）。特别是从设备读取（遥测）不应更改属性的状态。

用法类似于遥测，但有一些添加

• 它们可以是可写的
  • 如果使用相同的名称（如PowerMode）在SetPowerMode和ReadPowerMode上使用，它们将被合并为单个模型属性
• 它们可以放置在无返回值且接受一个参数的方法上（该参数不必须是按引用传递的）
• 不允许在同一个接口上存在多个同名的写入器或读取器

[Property]
public Sampling HumiditySampling { get { /*...*/ } set { /* ... */ } }

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

ComponentAttribute

组件代表指向其他（实例）接口的引用。它们只能在属性上放置，属性的返回类型或其祖先类应具有Interface属性。

[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

命令可以是可以在设备上执行的操作，并且只能放置在方法上。

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

类型序列化

只能序列化简单类型

• 枚举（无Flags属性）
  • 不允许枚举范围之外的值（例如，位组合）
• UnitsNet单元
• 基本C#类型
• System.Numerics.Vector2, System.Numerics.Vector3, System.Numerics.Vector4
• System.Drawing.Color