Arduino/Firmata device support

src/devices/Arduino/Arduino.csproj

@@ -0,0 +1,24 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>netcoreapp2.1</TargetFramework>
+    <EnableDefaultItems>false</EnableDefaultItems>
+    <RootNamespace>Iot.Device.Arduino</RootNamespace>
+  </PropertyGroup>
+
+ <ItemGroup>
+    <Compile Include="*.cs" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="$(MainLibraryPath)System.Device.Gpio.csproj" />
+    <ProjectReference Include="..\Common\CommonHelpers.csproj" />
+    <PackageReference Include="System.IO.Ports" Version="$(SystemIOPortsPackageVersion)" />
+    <PackageReference Include="System.Memory" Version="$(SystemMemoryPackageVersion)" />
+  </ItemGroup>
+  <ItemGroup>
+    <AssemblyAttribute Include="System.Runtime.CompilerServices.InternalsVisibleTo">
+      <_Parameter1>$(AssemblyName).Tests</_Parameter1>
+    </AssemblyAttribute>
+  </ItemGroup>
+</Project>

src/devices/Arduino/Arduino.sln

@@ -0,0 +1,88 @@
+
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio Version 16
+VisualStudioVersion = 16.0.29905.134
+MinimumVisualStudioVersion = 10.0.40219.1
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Arduino", "Arduino.csproj", "{0D3AA0FD-4834-4AB1-AD2A-BB12180B61B4}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "System.Device.Gpio", "..\..\System.Device.Gpio\System.Device.Gpio.csproj", "{0B90F9D4-7353-4172-A317-714471A06781}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Arduino.sample", "samples\Arduino.sample.csproj", "{2670F7BF-A7C8-49EB-9A99-1719A90D0C67}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Bmxx80", "..\Bmxx80\Bmxx80.csproj", "{EEEB0FB8-E1ED-4970-BDF6-DA3D5E2ED074}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Mcp3xxx", "..\Mcp3xxx\Mcp3xxx.csproj", "{26911D2A-E303-4846-96A1-5ABC92F54445}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "CharacterLcd", "..\CharacterLcd\CharacterLcd.csproj", "{D47A6627-4041-4CEA-8903-A6C67C6993CF}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "CommonHelpers", "..\Common\CommonHelpers.csproj", "{CD593083-8E94-4B60-86BF-DF3FB7873893}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "samples", "samples", "{9E5A25ED-9839-4C1A-9B27-993437D1CB31}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Arduino.Monitor", "samples\Arduino.Monitor.csproj", "{23B4B60C-9594-42BB-9D25-C54983B0F809}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "tests", "tests", "{CA26B999-4C0E-4E82-A46E-A68AC1B85C10}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Arduino.Tests", "tests\Arduino.Tests.csproj", "{273C9233-8A7D-4A0B-8DB2-FB7F56FA727D}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "HardwareMonitor", "..\HardwareMonitor\HardwareMonitor.csproj", "{D1C467D8-E6E3-4811-826B-216DCB80A16E}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|Any CPU = Debug|Any CPU
+		Release|Any CPU = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{0D3AA0FD-4834-4AB1-AD2A-BB12180B61B4}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{0D3AA0FD-4834-4AB1-AD2A-BB12180B61B4}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{0D3AA0FD-4834-4AB1-AD2A-BB12180B61B4}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{0D3AA0FD-4834-4AB1-AD2A-BB12180B61B4}.Release|Any CPU.Build.0 = Release|Any CPU
+		{0B90F9D4-7353-4172-A317-714471A06781}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{0B90F9D4-7353-4172-A317-714471A06781}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{0B90F9D4-7353-4172-A317-714471A06781}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{0B90F9D4-7353-4172-A317-714471A06781}.Release|Any CPU.Build.0 = Release|Any CPU
+		{2670F7BF-A7C8-49EB-9A99-1719A90D0C67}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{2670F7BF-A7C8-49EB-9A99-1719A90D0C67}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{2670F7BF-A7C8-49EB-9A99-1719A90D0C67}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{2670F7BF-A7C8-49EB-9A99-1719A90D0C67}.Release|Any CPU.Build.0 = Release|Any CPU
+		{EEEB0FB8-E1ED-4970-BDF6-DA3D5E2ED074}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{EEEB0FB8-E1ED-4970-BDF6-DA3D5E2ED074}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{EEEB0FB8-E1ED-4970-BDF6-DA3D5E2ED074}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{EEEB0FB8-E1ED-4970-BDF6-DA3D5E2ED074}.Release|Any CPU.Build.0 = Release|Any CPU
+		{26911D2A-E303-4846-96A1-5ABC92F54445}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{26911D2A-E303-4846-96A1-5ABC92F54445}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{26911D2A-E303-4846-96A1-5ABC92F54445}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{26911D2A-E303-4846-96A1-5ABC92F54445}.Release|Any CPU.Build.0 = Release|Any CPU
+		{D47A6627-4041-4CEA-8903-A6C67C6993CF}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{D47A6627-4041-4CEA-8903-A6C67C6993CF}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{D47A6627-4041-4CEA-8903-A6C67C6993CF}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{D47A6627-4041-4CEA-8903-A6C67C6993CF}.Release|Any CPU.Build.0 = Release|Any CPU
+		{CD593083-8E94-4B60-86BF-DF3FB7873893}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{CD593083-8E94-4B60-86BF-DF3FB7873893}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{CD593083-8E94-4B60-86BF-DF3FB7873893}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{CD593083-8E94-4B60-86BF-DF3FB7873893}.Release|Any CPU.Build.0 = Release|Any CPU
+		{23B4B60C-9594-42BB-9D25-C54983B0F809}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{23B4B60C-9594-42BB-9D25-C54983B0F809}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{23B4B60C-9594-42BB-9D25-C54983B0F809}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{23B4B60C-9594-42BB-9D25-C54983B0F809}.Release|Any CPU.Build.0 = Release|Any CPU
+		{273C9233-8A7D-4A0B-8DB2-FB7F56FA727D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{273C9233-8A7D-4A0B-8DB2-FB7F56FA727D}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{273C9233-8A7D-4A0B-8DB2-FB7F56FA727D}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{273C9233-8A7D-4A0B-8DB2-FB7F56FA727D}.Release|Any CPU.Build.0 = Release|Any CPU
+		{D1C467D8-E6E3-4811-826B-216DCB80A16E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{D1C467D8-E6E3-4811-826B-216DCB80A16E}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{D1C467D8-E6E3-4811-826B-216DCB80A16E}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{D1C467D8-E6E3-4811-826B-216DCB80A16E}.Release|Any CPU.Build.0 = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
+	EndGlobalSection
+	GlobalSection(NestedProjects) = preSolution
+		{2670F7BF-A7C8-49EB-9A99-1719A90D0C67} = {9E5A25ED-9839-4C1A-9B27-993437D1CB31}
+		{23B4B60C-9594-42BB-9D25-C54983B0F809} = {9E5A25ED-9839-4C1A-9B27-993437D1CB31}
+		{273C9233-8A7D-4A0B-8DB2-FB7F56FA727D} = {CA26B999-4C0E-4E82-A46E-A68AC1B85C10}
+	EndGlobalSection
+	GlobalSection(ExtensibilityGlobals) = postSolution
+		SolutionGuid = {47BF9684-1876-4AC1-8C87-04B8C7FA6C3A}
+	EndGlobalSection
+EndGlobal

src/devices/Arduino/ArduinoAnalogController.cs

@@ -0,0 +1,101 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System;
+using System.Collections.Generic;
+using System.Collections.ObjectModel;
+using System.Device.Analog;
+using System.Device.Gpio;
+using System.Linq;
+using System.Text;
+using System.Threading;
+
+namespace Iot.Device.Arduino
+{
+    internal class ArduinoAnalogController : AnalogController
+    {
+        private readonly ArduinoBoard _board;
+        private readonly IReadOnlyList<SupportedPinConfiguration> _supportedPinConfigurations;
+        private readonly Dictionary<int, ValueChangedEventHandler> _callbacks;
+
+        public ArduinoAnalogController(ArduinoBoard board,
+            IReadOnlyList<SupportedPinConfiguration> supportedPinConfigurations, PinNumberingScheme scheme)
+            : base(scheme)
+        {
+            _board = board ?? throw new ArgumentNullException(nameof(board));
+            _supportedPinConfigurations = supportedPinConfigurations ?? throw new ArgumentNullException(nameof(supportedPinConfigurations));
+            _callbacks = new Dictionary<int, ValueChangedEventHandler>();
+            PinCount = _supportedPinConfigurations.Count;
+
+            // Note: While the Arduino does have an external analog input reference pin, Firmata doesn't allow configuring it.
+            VoltageReference = 5.0;
+        }
+
+        public override int PinCount
+        {
+            get;
+        }
+
+        public override int ConvertPinNumberToLogicalNumberingScheme(int pinNumber)
+        {
+            int numberAnalogPinsFound = 0;
+            for (int i = 0; i < _supportedPinConfigurations.Count; i++)
+            {
+                if (_supportedPinConfigurations[i].PinModes.Contains(SupportedMode.AnalogInput))
+                {
+                    numberAnalogPinsFound++;
+                    if (pinNumber == i)
+                    {
+                        return numberAnalogPinsFound - 1;
+                    }
+                }
+            }
+
+            throw new InvalidOperationException($"Pin {pinNumber} is not a valid analog input pin.");
+        }
+
+        public override int ConvertLogicalNumberingSchemeToPinNumber(int logicalPinNumber)
+        {
+            int numberAnalogPinsFound = 0;
+            for (int i = 0; i < _supportedPinConfigurations.Count; i++)
+            {
+                if (_supportedPinConfigurations[i].PinModes.Contains(SupportedMode.AnalogInput))
+                {
+                    numberAnalogPinsFound++;
+                    if (logicalPinNumber == numberAnalogPinsFound - 1)
+                    {
+                        return i;
+                    }
+                }
+            }
+
+            throw new InvalidOperationException($"Pin A{logicalPinNumber} is not existing");
+        }
+
+        public override bool SupportsAnalogInput(int pinNumber)
+        {
+            return _supportedPinConfigurations[pinNumber].PinModes.Contains(SupportedMode.AnalogInput);
+        }
+
+        protected override AnalogInputPin OpenPinCore(int pinNumber)
+        {
+            // This method is called with the logical pin numbering (input pin A0 is 0, A1 is 1, etc)
+            // but the SetPinMode method operates on the global numbers
+            int fullNumber = ConvertLogicalNumberingSchemeToPinNumber(pinNumber);
+            _board.Firmata.SetPinMode(fullNumber, SupportedMode.AnalogInput);
+            _board.Firmata.EnableAnalogReporting(pinNumber);
+            return new ArduinoAnalogInputPin(_board, this, _supportedPinConfigurations[fullNumber], pinNumber, VoltageReference);
+        }
+
+        public override void ClosePin(AnalogInputPin pin)
+        {
+            _board.Firmata.DisableAnalogReporting(pin.PinNumber);
+        }
+
+        protected override void Dispose(bool disposing)
+        {
+            _callbacks.Clear();
+            base.Dispose(disposing);
+        }
+    }
+}

src/devices/Arduino/ArduinoAnalogInputPin.cs

@@ -0,0 +1,80 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System;
+using System.Collections.Generic;
+using System.Device.Analog;
+using System.Device.Gpio;
+using System.Text;
+using UnitsNet;
+
+namespace Iot.Device.Arduino
+{
+    internal class ArduinoAnalogInputPin : AnalogInputPin
+    {
+        private readonly SupportedPinConfiguration _configuration;
+        private int _autoReportingReferenceCount;
+        private ArduinoBoard _board;
+
+        public ArduinoAnalogInputPin(ArduinoBoard board, AnalogController controller, SupportedPinConfiguration configuration,
+            int pinNumber, double voltageReference)
+            : base(controller, pinNumber, voltageReference)
+        {
+            _board = board;
+            _configuration = configuration;
+        }
+
+        public override void EnableAnalogValueChangedEvent(GpioController? masterController, int masterPin)
+        {
+            // The pin is already open, so analog reporting is enabled, we just need to forward it.
+            if (_autoReportingReferenceCount == 0)
+            {
+                _board.Firmata.AnalogPinValueUpdated += FirmataOnAnalogPinValueUpdated;
+            }
+
+            _autoReportingReferenceCount += 1;
+        }
+
+        public override void DisableAnalogValueChangedEvent()
+        {
+            if (_autoReportingReferenceCount == 0)
+            {
+                throw new InvalidOperationException("Attempt to disable event when no events are connected");
+            }
+
+            _autoReportingReferenceCount -= 1;
+            if (_autoReportingReferenceCount == 0)
+            {
+                _board.Firmata.AnalogPinValueUpdated -= FirmataOnAnalogPinValueUpdated;
+            }
+        }
+
+        private void FirmataOnAnalogPinValueUpdated(int pin, uint rawvalue)
+        {
+            if (_autoReportingReferenceCount > 0)
+            {
+                int physicalPin = Controller.ConvertLogicalNumberingSchemeToPinNumber(pin);
+                var voltage = ConvertToVoltage(rawvalue);
+                var message = new ValueChangedEventArgs(rawvalue, voltage, physicalPin, TriggerReason.Timed);
+                FireValueChanged(message);
+            }
+        }
+
+        public override ElectricPotential MinVoltage => ElectricPotential.Zero;
+
+        /// <summary>
+        /// The arduino would theoretically allow for an external analog reference, but firmata currently doesn't support that.
+        /// </summary>
+        public override ElectricPotential MaxVoltage => ElectricPotential.FromVolts(5);
+
+        /// <summary>
+        /// Similar here: Some boards support more than 10 bit resolution, but we'd have to extend the firmware for that.
+        /// </summary>
+        public override int AdcResolutionBits => 10;
+
+        public override uint ReadRaw()
+        {
+            return _board.Firmata.GetAnalogRawValue(PinNumber);
+        }
+    }
+}