IR Server Suite - How YOU can help

[and-81]

Hello all,

IR Server Suite is a one-man development effort and it's quite a big project now that takes up a lot of my time. In fact, I don't get to do any development on MediaPortal itself because of all the time I spend supporting IR Server Suite!

I'm happy to continue the way I am, don't get me wrong. I enjoy working on IR Server Suite. But people often ask how they can help me improve IR Server Suite, to add new device support, new commands, test features, etc...

So I thought it would be a good idea to start a thread where I can explain the different ways you can help Me to make IR Server Suite better for You.

And there are several ways that users of IR Server Suite can help to improve it...


1. Testing and reporting issues.

Whenever a new version is released there is a mixture of bug-fixes, new features, and new devices supported. As a user of the software you can help me by reporting faults, usability problems, and even successes.

For example, if the change log suggests that a new device is supported you can help out by testing that device and reporting back to me on how you went. All feedback is welcome, positive and negative.

I don't actually own a lot of the devices supported by IR Server Suite, so often when new device support is added it goes in based on some existing source-code or an API specification. This is not the best way to operate, but I can't afford to buy dozens of devices that I don't need. I have a hard enough time affording the things I do need!

When a new command type is added, more often than not it's not a command that I use (otherwise I would have added it already). So I need people to test the commands and let me know if they work as expected.

The way to make a report of an error, omission, or usability problem is to post in the thread that announced the version of IR Server Suite that you have found the problem in. But remember to please include log files, details about your system and how you brought about the fault.

I know we aren't all software developers, and so users often overlook the log files. But believe me, having log files that show what went wrong makes my job 100% easier. And it means I get the problem fixed faster.

IR Server Suite log files can be found in the Start Menu under Programs -> IR Server Suite -> Logs. If you use the MCE remote support then there is another log file in your root directory, including that can also help.


2. Write guides and documentation.

I have some documentation written, but it is not very detailed. If you have some experience with IR Server Suite and you think you can improve an area of documentation then please submit your changes in this post and I'll be sure to include them in the very next release.

Documentation is necessary, but it can be very time consuming. I have to balance my time between:
Developing new features,
Developing new device support,
Developing new command types,
Finding bugs,
Fixing bugs,
Solving problems,
Answering emails and forum posts,
and documentation.

As you can imagine, documentation probably doesn't get the time it needs. If you think you can help, please do.


3. Writing device support plugins.

All the devices that IR Server Suite supports follow a simple API. The "IR Server Plugin Interface". This interface is available in the source code of IR Server Suite, and is attached to this post as well.

To create a new IR Server Plugin all you need to do is implement the relevant interfaces from the API in a new dll.

All IR Server Plugins must extend the PluginBase class and override the relevant details.

Optional interfaces:

IConfigure - Provides a configure button in the Input Service Configuration so that the user can fine tune settings for the device.

IKeyboardReceiver - For devices that support a remote keyboard. Eg. MCE remote keyboard (theoretically any device that can receiver time code information can decode remote keyboards and mouses).

ILearnIR - For devices that can learn IR commands to blast back later.

IMouseReceiver - For devices that support a remote mouse. Eg. MCE remote keyboard (with mouse).

IRemoteReceiver - For devices that support remote controls. (this is optional because some devices are just blasters).

ITransmitIR - For devices that can blast IR commands.

For an example framework of an IR Server Plugin see the attached example code.

For a more detailed example download the IR Server Suite source code and look at one of the existing devices supported.


4. Writing command type plugins (after version 1.0.5.0 is released).

After version 1.0.5.0 all commands will be stored in command library DLL files. They will all follow a specific interface, which means that other developers can easily add commands to IR Server Suite. I will write more about this after version 1.0.5.0 is released.


5. Donating a device you want supported.

The quickest way to develop support for a device is to have one to work with.

Unfortunately, I can't be going around buying devices I don't need. I just can't afford to do that.

opy was generous enough to donate an MCE keyboard, with it I was able to implement the keyboard IR protocol (which is different to the remote) into IR Server Suite. This means that I can make the keyboard work over a network and even with some receivers other than the MCE device.

fiftychickens has generously donated some hardware to go towards setting up a testing/development PC which will help me reproduce and then remove bugs in a more timely manner.

Not having a device I'm trying to support makes development 1000 times harder. There is almost always something different about the device that is not mentioned in the specs, and that's if you're lucky enough to find specs for the device.

If you'd like to donate a device to support then please contact me either here in the forums or through Private Message. Just click on my username and it will show a menu with "Send a Private Message to and-81" as an option. That way we can discuss the details.

I'm particularly interested in developing support for these remotes/devices:
* Hauppauge
* Creative LiveDrive/Audigy Drive and X-Fi Remote
* Imon
* StreamZap
* IgorPlug
* Tira
* Version 1 MCE remote & Vista-only MCE remote
* X10
* Egon
* Pinnacle PC Remote Kit


6. Provide IR Commands for your Set Top Box.

The TV Blaster plugins come with a collection of Set Top Box IR Commands to get you set up and going quicker.

This collection is compiled primarily from user contributions, but also from codes found on the web at places like Remote Central.com/.

If you have a set top box that is not on the quick setup list then please post a set of IR Commands and details about the STB and I'll include them in the next version.


7. Anything you think would help that I haven't thought of.

If there's anything you feel could help and I haven't mentioned it then please, post a reply and we can talk about it.


Funnily enough, pretty much all of these things I've just mentioned are also things you can do to support MediaPortal in general.

If you're thinking of supporting IR Server Suite then I urge you to consider supporting the MediaPortal project as a whole. We are currently short of developers, and that means the developers we have are over-worked and short of time. Anything you can do to help will either directly address the developer shortage or help our existing developers to get things done easier/quicker.


Cheers,

[Neptuni]

Hi Aaron,

What about adding a section to the Mediaportal wiki about the IR Server Suite, or would you prefer to have it all in the download?

/Mikael

Hi again,

I forget a question about log files, is the log file the one that is called "MCE...." something and placed directy under C:, I'm at work and don't have acccess to MP now?

If thats the case why not move it to IR Server Suite catalog and rename it, or maybe thats already planned?

Thanks for a great software!

/Mikael

[and-81]

Moving the documentation into the MediaPortal Wiki is a good idea, it would make it easier for people to add to it as well. I will definitely look into that.

There is a folder full of log files that you can find in the Start Menu -> Programs -> IR Server Suite -> Logs.

The log in the root directory is just for the MCE Remote driver. I'm going to stop making that log file once the MCE remote support is stable.

Thanks mate,

[konradb]

Hi!
I have searched for the source code that you mention to be attached in the post but I can not find it.
Could you please point me to the right direction? I looked in SVN aswell...
My plan is to write a plugin (if I understand how) to send remote commands to mControl, that is a home automation program.

[and-81]

konradb:

Sorry mate, I forgot to attach it. I will do so when I get home from work.

Thanks,

[konradb]

Hi!
Did you put the source code anywhere? Sorry to nag you about this...

By the way, I can put the documentation on the MP wiki if you like.
Just point me to where you think it should be located.