I decided to write a quick "How To" install this driver. I don't mean to offend either Beelzerob or Fonceur, but with several threads and directions spread out in all of them, I wanted to bring it all back to one spot.
Check your CQC version
Version .90 of the Sage driver (and up) now requires CQC beta 2.4.40 and up. So make sure you have a high enough CQC version to make everything work.
Install Needed Software (other than CQC Driverpacks)
First, there are several things that must be installed on the computer running the SageTV Software in order for the CQC driver to work (in addition to the CQC driver packs). So let's start with
GKusnick's Studio Tools. Just download the zip file from the Sage site and all you have to do is extract the zip file components into the C:\Program Files\SageTV\SageTV folder. This will create a new gkusnick.sagetv folder and create a new .jar file in the jar folder.
Second, download the SageTCPServer-vXXX.zip file from the
1st post in this thread. It only has one file, the SageTCPServer.jar file. Simply extract this file into the C:\Program Files\SageTV\SageTV\JARs folder.
Modify Sage.Properties File
Now we are ready to modify the Sage.properties file. This is also located on the computer running the SageTV software in the C:\Program Files\SageTV\SageTV folder. Look for a file called "Sage" since the .properties portion of the name will probably be hidden unless you have the "View Extentions" option turned on.
Make sure the SageTV software is not open/running and the SageTV Service is turned off before modifying the file. If the Sage service is left running, you will be able to open and edit the file just fine, but the changes will not be saved.
Here are the modifications that need to be made to the Sage.Properties file:
1. add the line: load_at_startup_runnable_classes=
sagetcpserver.StartServers
Note that the line: load_at_startup_runnable_classes= may already exist. If it does, than just add the value to the end of this line
If anything already exists in this line, separate each item with a semicolon ';'
Note that this is case-sensitive and there must be no spaces at all in this line.
2. add the line:
sageTCPServer/clients=<client1MACID>.<port>,<client2MACID>.<port >, etc, etc, etc
<clientMACID> = The MAC address of the client you want to control Sage on. This client could be a placeshifter client, or an MVP, or any other client that Sage renders for. The one exception to this is if you wish to control the sage client on the PC that this sage.properties file resides on, then use the name "local" instead of a MAC ID.
Note, to use the SageMediaServer driver, you'll need to have a "client" for it also. That client will always be "local". So it would look like "local.<port>"
<port> = Any valid TCP port. It doesn't matter what port number you choose, so long as it's un-used. Remember this port number, as you'll need to add it when you go through the CQC manifest when installing the driver.
Here is an example of how the line might look if you wanted to install the SageMediaServer on the machine that is running the SageTV software and 1 client/extender.
Example: sageTCPServer/clients=local.9750,01e04cd32eda.9100
The SageMediaServer uses the address of local since it is running on the same machine as the SageTV software and will use port 9750. The client/extender is a separate device with a MAC address of 01e04cd32eda and will use port number 9100.
Here is an example of how the line might look if you wanted to install the SageMediaServer on the machine that is running the SageTV software and 2 client/extenders (one on the same machine as the SageTV software and one separate device)
Example: sageTCPServer/clients=local.9750,01e04cd32eda.9100,local.9101
The SageMediaServer uses the address of local since it is running on the same machine as the SageTV software and will use port 9750. The first client/extender is a separate device with a MAC address of 01e04cd32eda and will use port number 9100. The second client is running of the same machine as the SageTV software, so it uses the local address as well, and will use port 9101.
3. add the line:
sageTCPServer/debugOn=false
This value is just what it says, for debugging only. If things are working well, feel free to keep this to false. However, if things go bad and I ask for the sage log, then set this to true and restart sage to reproduce the problem, and then send me the logfile. To get Sage to start logging in general, you'll also need the line:
debug_logging=TRUE in the file. This make Sage output debug messages into to a file. Then modify the line: sageTCPServer/debugOn=
True which makes sure any debug messages related to the SageTCPServer jar are included in the debug file. The file will have the name "tv0" and it will be located in the SageTV folder I believe.
Other useful info:
1) To enable the console window, define the following value under HKEY_LOCAL_MACHINE\SOFTWARE\Frey Technologies\Common:
consolewin REG_DWORD 1
Install CQC Drivers
Download the driverpacks (x2), the XML macropack, and Sage Channel template pack from the
first post and use the Admin Interface to install them all.
Use the Admin Interface to load the drivers. The SageMediaServer driver has many fields related to the core SageTV software. Things like "upcoming recordings", "recent recordings", "TV channels", etc, etc. You will only need one SageMediaServer driver per system. The SagePlayer driver is used to control a specific client or extender. You will want to install one SagePlayer driver per client/extender that you wish to control. If you have two extenders then you will install two SagePlayer drivers. It is not required that you load both types of drivers (SageMediaServer and SagePlayer), but most people will probably want to install both types to insure they have access to all the potential driver fields.
When installing the drivers, it will ask you for the IP address and port number.
The IP address requested is the address of the computer running the SageTV software because this is where the java code is executing. Do not use the IP address of each client. However, you do use the unique port number that you used in the sage.properties file for each device. So every driver you install will have the same IP address, but a different port number.
For example, if you are running the SageTV Software on a computer with the IP address 192.168.1.10 and the Sage.properties file was modified to include this line: "sageTCPServer/clients=local.9750,01e04cd32eda.9100,local.9101" , when you go to install the three separate sage drivers, you would use the IP address 192.168.1.10 and port 9750 for the SageMediaServer driver, address 192.168.1.10 and port 9100 for the first SagePlayer driver, and address 192.168.1.10 and port 9101 for the second SagePlayer Driver.
Conclusions
Hopefully everything is up and running and connected! If you feel empowered now, you might want to install the
Sage Information Popup driver. This will allow you to cause a custom message to popup on a client or extender.
Lgkusnick/sagetv/api/AiringAPI$List; AT sagecqc.SageServer.getUpcomingRecordingsList(SageServer.java:563)