xIOT

An injectable framework for GPIO, I2C, SPI and other bits on Windows 10 IOT core for Rasberry Pi 2 and FTDI based USB devices.

PM> Install-Package xIOT

Note: as of 1.0.11 we support the new Universal App Nuget version.

Note: You will need FTDI D2XX drivers if you're using an FTDI based break out (not required for Rasberry Pi 2 deployments).

XIOTCore is a framework to assist you in developing IOT applications on Windows 10 IoT Core. It allows you to get your projects up and running very quickly so you can concentrate on your thing rather than being bogged down with boilerplate code.

###Samples

Check out the samples here for a good starting point!

Note: The samples in the main library project are for developers - they change often and are not really what you're looking for!

###Getting Started

Once you've installed the Nuget package you can get started by configuring the factory and requesting objects from it. You can request I2C devices, or GPIO devices for example. By configuring the factory you can tell the framework which platform you'd like to operate on, like the Raspberry Pi 2 or FTDI.

The framework can also support HATs (Hardware Attached on Top - like an Arduino shield) and other extensions. At the moment it supports features from the Explorer HAT Pro.

Configure the factory for base Raspberry Pi 2 operation.

private readonly IXIOTCoreFactory _factory = 
    XIOTCoreWindowsFactory.Create(Platforms.RaspberryPi2ModelB);

Configure for Raspberry Pi 2 with an Explorer HAT Pro on top.

private readonly IXIOTCoreFactory _factory = 
    XIOTCoreWindowsFactory.Create(Platforms.RaspberryPi2ModelB | Platforms.RaspberryPi2ExporerHatPro);

Configure for an FTDI based USB thing - we use a FT232H

private readonly IXIOTCoreFactory _factory =
    XIOTCoreWindowsFactory.Create(Platforms.FTDI_USB);

Important: Before you can start requesting things, you need to Init() the factory!

Note: You can use the FTDI bits in normal .NET (non Windows) projects, like console apps. The FTDI parts are in a PCL. Use XIOTCoreFactory as opposed to XIOTCoreWindowsFactory.

_factory.Init();

Now that the factory is configured you can start asking for things!

Get the Red LED from the Explorer HAT Pro and turn it off and on

var _redLed = _factory.GetComponent<IExplorerHat_RedLed>();
_redLed.On();
await Task.Delay(2000);
_redLed.Off();

IEXplorerHat_RedLed is based on the IXGpioControl which you can use to do straight GPIO style control on any pin. The interface which looks like this.

public interface IXGpioControl
{
    void On();
    void Off();
    bool State { get; set; }
}

What about something a little more advanced, like controlling an LCD connected via I2C. Note, change the factory creation settings and this exact same code will work on an FT232H or a Rasberry Pi 2!

Note: The framework supports the common Hitachi HD44780 based displays on I2C only.

 var i2c = _factory.GetComponent<IXI2CDevice>(); //Grab an I2C device

//Create an I2C LCD, pass in the I2C device. 
//You could set up the factory to grab this using Autofac injection (see advanced examples - TODO :P). 
var _lcd = new I2CLCD(i2c, 0x27, 2, 1, 0, 4, 5, 6, 7, 3, BacklightPolarity.Positive);

await _lcd.Begin(16,2); //fire it up as a 16x2 LCD

_lcd.BackLight(); //Turn on the backlight. .NoBacklight() will disable it
_lcd.Home(); 
_lcd.SetCursor(0, 0); //Start at character 4 on line 0
_lcd.Write("RPi 2, LCD, C#");
StopwatchDelay.Delay(250);
_lcd.SetCursor(0, 1);
_lcd.Write("git.io/vmEdE");

Cool eh?! For wiring and examples see the LCD samples section (TODO :P).

###Flexible Framework XIOT is based around Autofac dependency injection, so you can build simple apps right up to the most advanced applications without having to add any complexity. Just inject your device and start using it!

Becasue of XIOT's design around dependency injection it can support multiple different platforms without you having to change your code (much!). At this time the framework supports FTDI and Raspberry Pi 2.

###Rapid development Sometimes building for IoT devices is slow and time consuming. That's due in part to slow build, deployment and debug cycles.

XIOT supports FTDI based devices, such as [FT232H breakout] (https://learn.adafruit.com/adafruit-ft232h-breakout/overview) from Adafruit. This device can plug straight in to your PC, meaning you can very quickly develop your code and design your circuits before taking them to the Pi (and possibly others later) for completion.

At present the framework supports I2C and SPI. We're working on GPIO too very soon.

We started with DVDPT's libMPSSEWrapper project and extended from there to add I2C support using FTDI's libMPSSE (which is required). Our fork of that project is here but the code in XIOT is now separate (as we've made it injectable etc).

You will need to install the FTDI D2XX drivers before any of that stuff will work :)

Please see our the FTDI examples for more information on how to get it up and running!

###Runs on Pi 2 and your PC XIOT is built around Windows 10 Universal Apps. The framework works for UI based apps and headless background apps. It will run on your PC or Surface (using FTDI based USB breakout) or your PI2. Write once, run anywhere (okay, run on some things anyway).

###Support for special components As time goes on we'll add support for lots of components that you can inject in to your code and start using straight away. For now we've added some things to get started.

####Bits that are supported

HC-SR04 sonic distance sensor (sample)
Hitachi (HD44780) based LCD displays (sample)
OLED (SSD1306) based displays (sample)

We ported the LCD library from here (thanks fmalpartida for a great lib) - itself a port from the in built Arduino LCD library.

We've only implemnted the I2C version of the LCD library. Using FTDI it will run from USB - or you can run directly from your PI by changing aroudn the factory config.

We ported parts of the OLED library from Adafruit here.

Support for Raspberry Pi 2 running Windows 10 IoT Core
Support for FTDI (FT232H) USB for rapid development of circuits and logic from your PC
Works with I2C, SPI and GPIO
It works from console apps (using FTDI FT232 etc.) - you could even create unit tests to run against circuits you have set up!
Supports the built in Windows 10 IOT classes like I2C, GPIO etc
Supports Explorer HAT Pro for Raspberry Pi 2
Supports HC-SR04 ultrasonic distance sensor
Supports Hitatchi HD44780 based displays using I2C
More coming very soon...

jakkaj/xIOT

xIOT