GenericTunerPlugin 1.0 Released

[jpwegas]

The Generic Tuner Plugin is a new tuning plugin for SageTV.

It was created to move the complexities of tuning your myriad of recording devices from a poorly understood C library to the language of your choice.

The plugin acts as a passthru to a script or program called gentuner. gentuner can be written in whatever language you desire. It needs to accept several simple arguments on the command line and return results on stdout. gentuner is responsible for handing off the actual tuning work to the appropriate software (LIRC, 6200ch, panelctl, etc).

It can support multiple recording devices each with it's own independent tuning mechanism. For example, if you have four recording devices, two could be tuned using LIRC, one could use FireWire tuning, and one could send a command over the serial port to a robotic arm to poke a trained hamster to punch the keys on your favorite remote. Several example scripts are included in the distribution (sorry, hamster poking script not included).

Currently it has only been tested on Linux (since I don't own the server version for Windows or Mac), but may work on those platforms with modifications.

Wiki with configuration and install documentation: http://code.google.com/p/customsaget...ricTunerPlugin

Download: http://code.google.com/p/customsaget...Plugin-1.0.zip

GenericTunerPlugin is based on the ExternalCommandTunerPlugin and LIRCTuner, which are both derived from MultiDCTTunerDLL.

Thanks to Sean for letting me host everything on the customsagetv googlecode project page with his other excellent projects.

--John

[stuckless]

Nice going John. I know I'll be giving this a try when I hook my receiver again.

I think that if anyone is using my original external tuner plugin, then you can probably switch to this one, which offers more flexibility over the tuning and the # of tuners.

[MrD]

This is a great plugin! Thanks for pushing this out. Now that the USB port on my H21-200 box is dead, I'll be using this approach.

I wanted to make a few comments:

NB: I am using the Sage 7 beta -- perhaps the behavior is different on 6.x

The path to gentuner is hard coded to /opt/sagetv/server, obviously this can change per install (especially mine I was able to figure this out quickly and confirmed it by reading the source code. You may want to consider pulling the path / script from an environment variable set in the sage start script. Or maybe through the sage api but I am not sure what the api exposes.

The directions to update the sage properties file, do not completely work as stated. I used this technique but it did not work as expected. It took me a while to figure out that the REMOTES / KEYS APIs are called during the tuning setup; but by following the doc procedure to update the properties file, sage was passing in empty string for the pszPathName in LoadRemotes so that code was not working as expected. Then I went down the remove tuner process path and everything worked as expected.

[loonsailor]

Thanks for posting that, MrD. I've been holding off on updating to the v7 beta because I rely on this plugin for tuning my two STBs via firewire, and wasn't sure it would work. Sounds like I should go ahead and take the plunge.

[bcjenkins]

I can confirm it works as well.

B

[jpwegas]

Originally Posted by MrD

This is a great plugin! Thanks for pushing this out. Now that the USB port on my H21-200 box is dead, I'll be using this approach.

Thanks!

Originally Posted by MrD

I wanted to make a few comments:

NB: I am using the Sage 7 beta -- perhaps the behavior is different on 6.x

The path to gentuner is hard coded to /opt/sagetv/server, obviously this can change per install (especially mine I was able to figure this out quickly and confirmed it by reading the source code. You may want to consider pulling the path / script from an environment variable set in the sage start script. Or maybe through the sage api but I am not sure what the api exposes.

The behavior is the same in Sage 6.

Not having the gentuner path hardcoded in the plugin (by either inferring the location from Sage itself or having it defined in the Sage.properties file) is on my list of things to improve.

Originally Posted by MrD

The directions to update the sage properties file, do not completely work as stated. I used this technique but it did not work as expected. It took me a while to figure out that the REMOTES / KEYS APIs are called during the tuning setup; but by following the doc procedure to update the properties file, sage was passing in empty string for the pszPathName in LoadRemotes so that code was not working as expected. Then I went down the remove tuner process path and everything worked as expected.

I think I ran into this too when I was testing but I didn't have time to figure out a good way to work around it.

Ideally Sage would allow you to select the tuning plugin after a tuner is set up but there isn't a way to do that. Instead, I was hoping to be able to just change the plugin defined in the properties file so that people didn't have to recreate the tuner, but for some reason that doesn't work as I expected.

I will do some more testing on this the next time I dig into the code. Meanwhile, I will update the instructions on the wiki.

Thanks for the feedback!

--John

[jleonard78]

Awesome plugin. Not only did you build on the old LIRCTuner, but you pretty much made it able to work with any external program and customized easily.

However, I am having problems getting SageTV to "blast" my commands. I can get everything working from the script in my terminal, and verify the results through the TV (bypassing SageTV). SageTV responds to the remote as well, but channels never change. SageTV even goes through the motions of re-tuning, but I only ever see what's playing on Channel 2.

I am using Sage 7 Beta, Hauppauge PVR 1600 MCE. Since this is the newer USB one, I am using LIRC for my remote/blaster...(and the reason why your plugin was needed so badly by me). I am not using any other special plugins or extras for SageTV - a basic config.

I am using the Composite input on the card, but had the same problem when trying to use the Analog tuner.

I followed all your steps and used the default paths for the plugin.

Permissions on /opt/sagetv/server/gentuner are as follows:

-rwxr-xr-x (755)

Ownership of file is root:root

Obviously, my powers of deduction tell me that somehow, the script is never actually getting run.


My gentuner.log looks something like this:

2010-06-11 14:28 INFO: Generic Tuner, Version 1.1, Revision 287
2010-06-11 14:28 DEBUG: OpenDevice: 0

...followed by a whole bunch of entries like this...


2010-06-11 14:29 DEBUG: LoadRemotes: Remote: StubDevice
2010-06-11 14:29 DEBUG: LoadRemotes: Using command: /opt/sagetv/server/gentuner REMOTES


and eventually, a whole bunch of these...


2010-06-11 16:40 DEBUG: LoadRemotes: Found Remote: DCT2000
2010-06-11 16:40 DEBUG: CreateRemote: Remote: DCT2000
2010-06-11 16:40 DEBUG: LoadRemoteKeys: Using command: /opt/sagetv/server/gentuner KEYS DCT2000


At some point I get this...


2010-06-11 16:40 DEBUG: LoadRemotes: Found Remote: mceusb
2010-06-11 16:40 DEBUG: CreateRemote: Remote: mceusb
2010-06-11 16:40 DEBUG: LoadRemoteKeys: Using command: /opt/sagetv/server/gentuner KEYS mceusb


For one, I'm not sure what OpenDevice: 0 refers to. Does that mean it's trying to use lirc0? Because lirc1 is my blaster. Anyway, it seems to me that SageTV is not even using the right commands. It just keeps getting a key list but I never see any SEND commands.

Am I simply just missing something silly?

[bcjenkins]

Two things:

Did you select the remote in the tuner settings? StubDevice is the default remote.

Can you post the gentuner script you're using? I am inserting mine here

#!/bin/bash
#
# gentuner.LIRC
# GenericTunerPlugin to LIRC Connector
#
# See gentuner.README for details on gentuner
#
# This script proxies commands from the Generic Tuner Plugin
# to LIRC. If the remote name defined in the lircd.conf file
# ends in "-N" (where N is 1, 2, 3 or 4), it will also 
# use SET_TRANSMITTERS to restrict which emitters LIRC uses.
# Your LIRC hardware must support this feature.
#

CMD=$1
REMOTE=$2
KEY=$3
CHANNEL=$3
DELAY=.8
LOCKFILE=/tmp/lirclock

REMOTE_OVERRIDE=directtv
LIRC_ENTERCMD=enter
TRANS_REMOTE=CommandIR
TRANS_REMOTE_CMD="settransmitters-"

case "$CMD" in
    REMOTES)
        /usr/bin/irsend LIST "" "" 2>&1 | cut -d" " -f2
        ;;
         
    KEYS)
        if [ ! $REMOTE ]; then
            echo "Usage: $0 KEYS REMOTE"
            echo "To see a list of remotes execute: $0 REMOTES"
        else
            /usr/bin/irsend LIST "$REMOTE" "" 2>&1 | cut -d" " -f3
        fi
        ;;
    
    SEND)
        while [ -f $LOCKFILE ]
        do
            #echo "Waiting for lock"
            sleep $DELAY
        done

        touch $LOCKFILE
		POST=${REMOTE:(-2)}
	    TRANSMITTER_NUM=${REMOTE:(-1)}
	    
	    if [ $REMOTE_OVERRIDE ]; then REMOTE=$REMOTE_OVERRIDE; fi
        if [[ ! $2 || ! $3 ]]; then
            echo "Usage: $0 SEND REMOTE KEY"
            echo "To see a list of remotes execute: $0 REMOTES"
            echo "To see a list of supported keys execute: $0 KEYS REMOTE"
        else
            if [[ ${POST/-[1-9]/OK} = "OK" ]]; then
                /usr/bin/irsend SET_TRANSMITTERS $TRANSMITTER_NUM
                sleep $DELAY
            else
                /usr/bin/irsend SET_TRANSMITTERS 1 2 3 4
                sleep $DELAY
            fi
            /usr/bin/irsend SEND_ONCE $REMOTE $KEY
            sleep $DELAY
        fi
        rm $LOCKFILE
        ;;
    
    TUNE)
        
        while [ -f $LOCKFILE ]
        do
            #echo "Waiting for lock"
            sleep $DELAY
        done

        touch $LOCKFILE
		POST=${REMOTE:(-2)}
	    TRANSMITTER_NUM=${REMOTE:(-1)}
	    
	    if [ $REMOTE_OVERRIDE ]; then REMOTE=$REMOTE_OVERRIDE; fi
        if [[ ! $2 || ! $3 ]]; then
            echo "Usage: $0 TUNE REMOTE KEY"
            echo "To see a list of remotes execute: $0 REMOTES"
            echo "To see a list of supported keys execute: $0 KEYS REMOTE"
        else
            if [[ ${POST/-[1-9]/OK} = "OK" ]]; then
                if [ $TRANS_REMOTE ]; then
                    /usr/bin/irsend send_once ${TRANS_REMOTE} ${TRANS_REMOTE_CMD}${TRANSMITTER_NUM}
                else
                    /usr/bin/irsend SET_TRANSMITTERS ${TRANSMITTER_NUM}
                    sleep $DELAY
                fi
            else
                /usr/bin/irsend SET_TRANSMITTERS 1 2 3 4
                sleep $DELAY
            fi
            sleep $DELAY
            /usr/bin/irsend send_once $REMOTE $LIRC_ENTERCMD
            sleep $DELAY
            for (( x = 0 ; x < ${#CHANNEL} ; x++ )); do
                irsend send_once $REMOTE "${CHANNEL:$x:1}"
                sleep $DELAY
            done 
            /usr/bin/irsend send_once $REMOTE $LIRC_ENTERCMD
        fi
        rm $LOCKFILE
        ;;
    
    CAN_TUNE)
        echo "OK"
        ;;
         
    *)
    echo $"Usage: $0 {REMOTES|KEYS|SEND|TUNE|CAN_TUNE}"
    exit 1

B

[jpwegas]

Originally Posted by jleonard78

Awesome plugin. Not only did you build on the old LIRCTuner, but you pretty much made it able to work with any external program and customized easily.

Thanks!

Originally Posted by jleonard78

However, I am having problems getting SageTV to "blast" my commands. I can get everything working from the script in my terminal, and verify the results through the TV (bypassing SageTV). SageTV responds to the remote as well, but channels never change. SageTV even goes through the motions of re-tuning, but I only ever see what's playing on Channel 2.

I am using Sage 7 Beta, Hauppauge PVR 1600 MCE. Since this is the newer USB one, I am using LIRC for my remote/blaster...(and the reason why your plugin was needed so badly by me). I am not using any other special plugins or extras for SageTV - a basic config.

I am using the Composite input on the card, but had the same problem when trying to use the Analog tuner.

I followed all your steps and used the default paths for the plugin.

Permissions on /opt/sagetv/server/gentuner are as follows:

-rwxr-xr-x (755)

Ownership of file is root:root

Obviously, my powers of deduction tell me that somehow, the script is never actually getting run.


My gentuner.log looks something like this:

2010-06-11 14:28 INFO: Generic Tuner, Version 1.1, Revision 287
2010-06-11 14:28 DEBUG: OpenDevice: 0

...followed by a whole bunch of entries like this...


2010-06-11 14:29 DEBUG: LoadRemotes: Remote: StubDevice
2010-06-11 14:29 DEBUG: LoadRemotes: Using command: /opt/sagetv/server/gentuner REMOTES


and eventually, a whole bunch of these...


2010-06-11 16:40 DEBUG: LoadRemotes: Found Remote: DCT2000
2010-06-11 16:40 DEBUG: CreateRemote: Remote: DCT2000
2010-06-11 16:40 DEBUG: LoadRemoteKeys: Using command: /opt/sagetv/server/gentuner KEYS DCT2000


At some point I get this...


2010-06-11 16:40 DEBUG: LoadRemotes: Found Remote: mceusb
2010-06-11 16:40 DEBUG: CreateRemote: Remote: mceusb
2010-06-11 16:40 DEBUG: LoadRemoteKeys: Using command: /opt/sagetv/server/gentuner KEYS mceusb


For one, I'm not sure what OpenDevice: 0 refers to. Does that mean it's trying to use lirc0? Because lirc1 is my blaster. Anyway, it seems to me that SageTV is not even using the right commands. It just keeps getting a key list but I never see any SEND commands.

Am I simply just missing something silly?

Don't worry about the OpenDevice entry. That's sort of a leftover from when the original code (pre-LIRCTuner actually) used com ports.

The "Found Remote" lines means that the gentuner script is being called and is returning values to the plugin for the REMOTES command.

Both of bcjenkins' comments are spot on - basically either:

• You need to select which remote you want to use (DCT2000 or mceusb) in the Source Details screen. At the bottom of the Source Details screen you should see "Tuner Control: Generic Tuner REMOTE". If REMOTE is StubDevice, just click it and then click "Change Tuning Device" then select the correct remote.
• The correct remote name is being sent but the gentuner script isn't recognizing it.

If you see any lines in the log that say something like "PlayCommand: Using command: /opt/sagetv/server/gentuner SEND StubDevice 0", check the first item above.

I suspect it's the first item since you mentioned you are using LIRC, and you shouldn't need to modify the sample gentuner.LIRC script at all.

If those two things look ok, please attach or PM me the whole gentuner.log file (or the last 200 lines or so).

--John

[jleonard78]

Thanks guys for your quick responses. Indeed, that's all I needed to do. I didn't even realize you could configure stuff from the Source summary screen. Sure enough, though, I was able to change StubDevice to DCT2000 and all is well!!!

Just in time, too - tomorrow would have been day 30 since my Linux version purchase, so I was anxious to get things working 100%...I didn't want to have to try switch to Winbloze.

Eventhough Sage doesn't officially support Linux well, it's good to see a reasonable core of 3rd party help.

I really like this plugin alot. If I had more time, I would definitely configure some other scripts for it. But knowing it's just a bash script will make it easy for me to control my emulators, games and other programs as well. I can handle bash scripting!

[jpwegas]

Originally Posted by jleonard78

Eventhough Sage doesn't officially support Linux well, it's good to see a reasonable core of 3rd party help.

I've always gotten good support from Sage on the Linux product. Even though it's technically an OEM product, they have always been responsive. And just like the other platforms, there's lots of people on the forums who offer help.

Originally Posted by jleonard78

I really like this plugin alot. If I had more time, I would definitely configure some other scripts for it. But knowing it's just a bash script will make it easy for me to control my emulators, games and other programs as well. I can handle bash scripting!

Remember gentuner doesn't have to be a bash script - it could be written in any language you are comfortable with as long as it responds to the commands as described in the README file.

Glad it's working for you!

--John

[SuiDog]

Where would I get the updated panelctl that supports multiple STB's?

[loonsailor]

Though I submitted the new panelctl to libavc1394 many months ago, it's still not in the released version. It is in the main development trunk, however. So, you get it by getting a copy of the development source and building and installing it.

>svn co https://libavc1394.svn.sourceforge.n...oot/libavc1394 libavc1394
>cd libavc1394/trunk/libavc1394
>autoreconf -f -i
>./configure
>make
>sudo make install

Check and make sure that panelctl is version .2 or greater (>panelctl -V). ">panelctl --help" gives you a list of commands.

I e-mailed the head of the libavc1394 project today, and he told me that he'd do a new release soon, and move this into the current version. It's up to the distros, though, to decide when to make that new version be the default.

[loonsailor]

I use gentuner in Sage V6, and it works great. I'm going to go to the V7 beta soon. When I do, will the gentuner plugin be configured automatically, or do I need to do anything to make it work?

Thanks.

[loonsailor]

I just checked, and the updated panelctl, with flexible control of multible STBs by firewire, is now the default provided by the libavc1394 project. Unfortunately, it hasn't been picked up by any of the distro's yet, to my knowledge. You can get it from http://sourceforge.net/projects/libavc1394/. Just download the release (0.5.4 or higher) and install according to directions.

Hopefully, this will make it into ubuntu and other distros at some point.

[bcjenkins]

Originally Posted by loonsailor

I use gentuner in Sage V6, and it works great. I'm going to go to the V7 beta soon. When I do, will the gentuner plugin be configured automatically, or do I need to do anything to make it work?

Thanks.

It works fine in 7.0.

[loonsailor]

I upgraded to v7, and the plugin works perfectly straight out of the gates. However, I don't see it in the plugin manager. Should I?

[bcjenkins]

No, just use it the same way as you did in 6. If jpwegas ever gets around to making it an official plugin, we might get that.

B

[jpwegas]

Originally Posted by bcjenkins

If jpwegas ever gets around to making it an official plugin, we might get that.

I'm not sure whether I'd be able to use the plugin manager - isn't that only for STV plugins?

--John

[jpwegas]

Originally Posted by jpwegas

I'm not sure whether I'd be able to use the plugin manager - isn't that only for STV plugins?

Nevermind, just found the plugin developers guide - the plugin manager supports various types of plugins, including simple collections of files (i.e. channel logos).

But currently in the case of this plugin there may also be some manual user customization required as well. I'll have to think about how to implement that for a few of the common cases to avoid the customization.

--John