{"id":26412142,"url":"https://github.com/solidsoils/arduino","last_synced_at":"2025-04-09T05:11:39.293Z","repository":{"id":6575764,"uuid":"7817844","full_name":"SolidSoils/Arduino","owner":"SolidSoils","description":"C# .NET - Arduino library supporting simultaneous serial ASCII, Firmata and I2C communication","archived":false,"fork":false,"pushed_at":"2021-10-24T22:35:34.000Z","size":10653,"stargazers_count":206,"open_issues_count":8,"forks_count":61,"subscribers_count":26,"default_branch":"master","last_synced_at":"2025-04-09T05:11:33.497Z","etag":null,"topics":["arduino","csharp","firmata","i2c","serial"],"latest_commit_sha":null,"homepage":"https://solidsoils.github.io/Arduino/index.html","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SolidSoils.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-01-25T10:06:44.000Z","updated_at":"2025-03-28T15:15:03.000Z","dependencies_parsed_at":"2022-08-26T10:21:56.952Z","dependency_job_id":null,"html_url":"https://github.com/SolidSoils/Arduino","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SolidSoils%2FArduino","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SolidSoils%2FArduino/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SolidSoils%2FArduino/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SolidSoils%2FArduino/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SolidSoils","download_url":"https://codeload.github.com/SolidSoils/Arduino/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247980844,"owners_count":21027808,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["arduino","csharp","firmata","i2c","serial"],"created_at":"2025-03-17T21:46:35.354Z","updated_at":"2025-04-09T05:11:39.274Z","avatar_url":"https://github.com/SolidSoils.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SolidSoils4Arduino\n\nSolidSoils4Arduino is a client library built on .NET Standard 2.1. It offers an easy way to interact with Arduino boards.\nThe library implements the main communication protocols, the first of which is the Firmata protocol.\nIt aims to make communication with Arduino boards in MS .NET projects easier\nthrough a comprehensive and consistent set of methods and events.\n\nThe library supports the following protocols:\n\n1. Serial (ASCII) messaging\n2. Firmata\n3. I2C (as it has become part of Firmata)\n\nAll protocols can be mixed. The library brokers all incoming message types\nand directs them to the appropriate requestors (synchronous as well as asynchronous).\n\nCurrently [Standard Firmata 2.6](https://github.com/firmata/protocol/blob/master/protocol.md) is supported.\n(Extra capabilities of Standard Firmata Plus and Configurable Firmata are currently not supported by this client library.)\n\nTechnology: C#/Microsoft .NET Standard 2.1\n\nDependencies: none\n\n### Downloads\n\nThe library is available as a [NuGet package](https://www.nuget.org/packages/SolidSoils.Arduino.Client/#).\n\n### API Documentation\n\nSee [reference documentation](https://solidsoils.github.io/Arduino/index.html).\n\n## Getting started\n\n#### Setup your Arduino with StandardFirmata\n1. [Download the Arduino IDE](https://www.arduino.cc/en/main/software) and install it.\n2. Connect your Arduino board to your computer using an USB cable.\n3. Start the Arduino IDE and navigate to File \u003e Examples \u003e Firmata \u003e StandardFirmata.\n4. Upload the sketch.\n\n#### Basic test (C#)\nPreparation\n- Your Arduino is setup with the StandardFirmata sketch (see above).\n- An LED is connected to pin 10 of your Arduino.\n\nFurther steps\n1. Open Visual Studio and create a new C# console program project.\n2. Add NuGet package [SolidSoils.Arduino.Client](https://www.nuget.org/packages/SolidSoils.Arduino.Client/).\n3. In Program.cs put the following code:\n\n```csharp\nusing System;\nusing Solid.Arduino.Firmata;\n\nnamespace Demo\n{\n    class Program\n    {\n        static void Main(string[] args)\n        {\n            ISerialConnection connection = GetConnection();\n\n            if (connection != null)\n                using (var session = new ArduinoSession(connection))\n                    PerformBasicTest(session);\n\n            Console.WriteLine(\"Press a key\");\n            Console.ReadKey(true);\n        }\n\n        private static ISerialConnection GetConnection()\n        {\n            Console.WriteLine(\"Searching Arduino connection...\");\n            ISerialConnection connection = EnhancedSerialConnection.Find();\n\n            if (connection == null)\n                Console.WriteLine(\"No connection found. Make shure your Arduino board is attached to a USB port.\");\n            else\n                Console.WriteLine($\"Connected to port {connection.PortName} at {connection.BaudRate} baud.\");\n\n            return connection;\n        }\n\n        private static void PerformBasicTest(IFirmataProtocol session)\n        {\n            var firmware = session.GetFirmware();\n            Console.WriteLine($\"Firmware: {firmware.Name} version {firmware.MajorVersion}.{firmware.MinorVersion}\");\n            var protocolVersion = session.GetProtocolVersion();\n            Console.WriteLine($\"Firmata protocol version {protocolVersion.Major}.{protocolVersion.Minor}\");\n\n            session.SetDigitalPinMode(10, PinMode.DigitalOutput);\n            session.SetDigitalPin(10, true);\n            Console.WriteLine(\"Command sent: Light on (pin 10)\");\n            Console.WriteLine(\"Press a key\");\n            Console.ReadKey(true);\n            session.SetDigitalPin(10, false);\n            Console.WriteLine(\"Command sent: Light off\");\n        }\n    }\n}\n```\n\n#### Display board capabilities\nPreparation\n- Your Arduino is setup with the StandardFirmata sketch (see above).\n- In this example the Arduino is connected to COM3 at 57600 baud. Modify as needed.\n\nFurther steps\n1. Open Visual Studio and create a new C# console program project.\n2. Add NuGet package [SolidSoils.Arduino.Client](https://www.nuget.org/packages/SolidSoils.Arduino.Client/).\n3. In Program.cs put the following code:\n\n```csharp\nusing System;\nusing Solid.Arduino.Firmata;\n\nnamespace Demo\n{\n    class Program\n    {\n        static void Main(string[] args)\n        {\n            DisplayPortCapabilities();\n            Console.WriteLine(\"Press a key\");\n            Console.ReadKey(true);\n        }\n\n        private static void DisplayPortCapabilities()\n        {\n            using (var session = new ArduinoSession(new EnhancedSerialConnection(\"COM3\", SerialBaudRate.Bps_57600)))\n            {\n                BoardCapability cap = session.GetBoardCapability();\n                Console.WriteLine();\n                Console.WriteLine(\"Board Capability:\");\n\n                foreach (var pin in cap.Pins)\n                {\n                    Console.WriteLine(\"Pin {0}: Input: {1}, Output: {2}, Analog: {3}, Analog-Res: {4}, PWM: {5}, PWM-Res: {6}, Servo: {7}, Servo-Res: {8}, Serial: {9}, Encoder: {10}, Input-pullup: {11}\",\n                        pin.PinNumber,\n                        pin.DigitalInput,\n                        pin.DigitalOutput,\n                        pin.Analog,\n                        pin.AnalogResolution,\n                        pin.Pwm,\n                        pin.PwmResolution,\n                        pin.Servo,\n                        pin.ServoResolution,\n                        pin.Serial,\n                        pin.Encoder,\n                        pin.InputPullup);\n                }\n            }\n        }\n    }\n}\n```\n\n## Current status\n\n**v1.0.0**\n\n## Milestones\n\n1. Firmata protocol implemented, unit- and integration-tested.\n2. I2C protocol implemented and unit-tested.\n3. Serial ASCII protocol implemented and unit-tested.\n4. API fully documented.\n5. IObservable methods implemented (to be unittested).\n6. Mono support added.\n7. NuGet package published.\n\n## License\n[BSD-2 license](https://github.com/SolidSoils/Arduino/blob/master/LICENSE.md)\n\n## Contributing\nIf you discover a bug or would like to propose a new feature,\nplease open a new [issue](https://github.com/solidsoils/arduino/issues?sort=created\u0026state=open).\n\nTo contribute, fork this respository and create a new topic branch for the bug,\nfeature or other existing issue you are addressing. Submit the pull request against the *master* branch.\n\nIf you would like to contribute but don't have a specific bugfix or new feature to contribute,\nyou can take on an existing issue. Add a comment to\nthe issue to express your intent to begin work and/or to get any additional information about the issue.\n\nPlease, test your contributed code thoroughly. In your pull request, describe tests performed to ensure \nthat no existing code is broken and that any changes maintain backwards compatibility with the existing API.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsolidsoils%2Farduino","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsolidsoils%2Farduino","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsolidsoils%2Farduino/lists"}