Getting Started With Plugins

  • 133 Views
  • Last Post 05 February 2014
Ryan-Scott posted this 02 February 2013

With the release of version InControl HA 2.200, we've introduced a plugin framework.

There are three types of plugins available to be used within InControl: Service Plugins, GUI plugins and Controller plugins.

[b]Service Plugins[/b]

Service plugins allow you to create a service that runs along side InControl's service. An example would be a new plugin that exposes a port which provides access to devices, scenes and control of devices.

[b]GUI Plugins[/b]

GUI Plugins provide a menu item and an option GUI interface inside the main InControl application. Other plugins can use this to provide a way for the user to input settings about the plugin in general or can provide a general interface used to manipulate devices.

[b]Controller Plugins[/b]

Controller Plugins provide you with a way to add new technology and devices to InControl. For example, you might create a plugin to control your favorite media library. Controllers can expose new devices to InControl which can then be accessed and controlled by your smart phone, within scenes or by events and rules.

I personally enjoy learning by example. If you do too, here's the source code for the Virtual Device controller that InControl uses.

Check out the tutorial wiki for sample source code and walk-throughs of how to create plugins.

More information on plugins can also be found on our wiki.

Order By: Standard | Newest | Votes
monkey-magic posted this 02 December 2013

I'm getting access denied on the links...

Josh

Ryan-Scott posted this 03 December 2013

I'm getting access denied on the links...

Josh


I've been trying to get in touch with the provider JumpWiki to retrieve our content but they are non-responsive... seems we'll need to recreate all that and move it to a new home. Not cool JumpWiki...

All isn't lost though - we do have some source code out there for making your own plugins.

If you want to build a controller to be able to add new devices to InControl, you can see this Foscam source. There's also some other source in our repo that might be handy.

While I'm working on re-creating our Wiki page, please don't hesitate to ask me if you need help with anything.

monkey-magic posted this 07 December 2013

When you get the new wiki up is it going to be user contribute?

Josh

rscott posted this 07 December 2013

When you get the new wiki up is it going to be user contribute?

Josh


It could be... I guess it depends on what the interest level is from the community.

hdrider465@gmail.com posted this 10 January 2014

Ryan

any progress with this. I would love to work on some plugins

bratcliff7 posted this 01 February 2014

Any update? Want to write plugins for Nest and my Yamaha rx-3000, among others. Writing rules to set scenes based on weather and vicinity beacons.

Axial-User posted this 01 February 2014

I'm interested also. Any type of initial guide would be helpful.

Matt posted this 05 February 2014

Me too. I want to write an interface for RFID control.

Ryan-Scott posted this 05 February 2014

Love the way back machine!

http://web.archive.org/web/20130629040319/http://incontrolha.jumpwiki.com/wiki/CreatingaFoscamIPCameraController


Nice find!

Also, I just GitHubbed the source code for the Virtual Device controller that InControl uses. It's pretty well-documented, so that should help out as well.

Close