How do I Install the Brainboxes.IO .NET API?

FAQs

Downloads
Brainboxes.IO-.NET-API-v1.5.0.0.zip (52.4 kB)
Brainboxes.IO.Documentation.NET-v1.5.0.0.zip (570.2 kB)

To Install the Brainboxes.IO .NET API you need:

Prerequisites

  • Windows 2000 or later, Mac OSX or recent version of Linux
  • Visual Studio Code or Visual Studio 2005 or later
  • .NET CORE or .NET Framework 2.0 or later –  the latest version is installed with Visual Studio
  • A Brainboxes Remote IO Device, or a Brainboxes Ethernet to Serial Device

For Use With

The Brainboxes.IO .NET API is for use with Brainboxes Remote IO or Brainboxes Ethernet to Serial Modules, these are product codes which being with “ED-XXX” or “ES-XXX”, for example ED-538, ED-204, ES-246, ES-346.

The Brainboxes.IO .NET API is for use with the C#, VB and F# programming languages for Microsoft .NET CORE and .NET Framework 2.0 and above. It can be compiled and used freely in your own software. It can target Windows, Mac or Linux runtimes for both x86 and ARM hardware, (e.g. can run on Raspberry Pi or latest Windows Server).  This is free and unencumbered software released into the public domain.

View the online documentation here: Brainboxes.IO.Documentation

If you are using the downloaded .CHM documentation file please open it from your local machine (not over the network) or it won’t work properly (this is a known issue with Microsoft .CHM files).

Target Platforms

Brainboxes.IO APIs for .NET can be targeted to:

  • Windows Platforms using .NET Framework or .NET CORE
  • Linux Platforms using Mono or .NET Core
  • Windows IoT, Windows Store App and XBOX platforms using Brainboxes.IO and the Universal Windows Platform

Installation Steps

Install via Nuget in Visual Studio, use Visual Studio Code Nuget Extension, or download from our website:

Download from Nuget using Visual Studio Striaght into your project

Install Via Nuget

If you are using NuGet the API is available from here: https://www.nuget.org/packages/Brainboxes.IO or by searching for Brainboxes.IO within NuGet.

  1. Open Visual Studio and start a new project
  2. Click Tools > Nuget Package Manager > Manage Nuget Packages for Solution
  3. In the search box enter “Brainboxes.IO”, ensure the package source is ‘Nuget.org’

The API should now be available in your Visual Studio project. The API is fully documented and IntelliSense within visual studio should provide relevant documentation. Additionally the documentation file can be downloaded unzipped and opened into the Microsoft Windows Help File Viewer.

Download from our Website:

  1. Download and unzip the file at the top of this page, into a permanent location.
  2. Open Visual Studio and start a new project.
  3. Right click on the project and click “Add Reference”
  4. In Reference Manager Click “Browse” and then the “Browse” button at the bottom of the page
  5. Browse to the location where the files are unzipped
  6. Click on “Brainboxes.IO.dll” and then click “Add”
  7. Click “OK” on the Reference Manager
FAQs