MLSageTV Plugin
From Tallus LLC Wiki
Contents |
About
MLSageTV plugin is an interface for SageTV Personal Video Recorder software application. With this software suite, you can manage your Live TV, Recorded TV, Manage recorded Video (including ripped DVDs), choose a Photo to be displayed, choose Music to listen to on all SageTV client PCs, and Sage hardware extenders.
It is not meant to be a full fledged SageTV client or placeshifter (where you could watch videos on your touchscreen), but instead as a tool to access information about your SageTV Server (i.e. list of Upcoming recordings, Recorded shows, etc.) from a MainLobby Client PC. But it does allow to select and control a Monitored device (i.e. SageTV client or extender), where you could launch the play back of a Recorded show.
MLSageTV does not support display of a custom MainLobby scene on a SageTV Client PC or Sage Extender.
Order Link
Download Link
MLSageTV Plugin installer + UI installer
MLSageTV Plugin installer
The plugin installs in a 30 day trial mode. Once you have decided to purchase it from Tallus's shopping cart, just apply the software license you will receive from Tallus via email on purchase of the plugin. After the plugin is installed, the license is then applied to MLServer3's Software Registration Menu (in MLServer: Help/Manage License Keys) which you must then Activate to that PC by sending your purchased license, your MLServer's Hardware ID (found at bottom of the Registration Menu window) to: info(at)talluscorp.com. You will soon receive an Activation code via email that is applied to the Registration Menu which makes that plugin permenant to that PC.
You should perform the above within the 30 day trial period to enjoy uninterrupted usage of the plugin with no rework needed between trial and licensed useage. Please allow up to two days for Tallus processing time for your requests. Most requests are processed within a few hours.
Requirements / Recommendations
.NET framework 3.5
Latest version of SageTV (currently 6.6)
SageTCPServer and GKusnick Studio Tools Installer
GuiGraphix Library #0019.
TVLobby (optional, to display the TV Guide)
Example of how SageTV and MainLobby Server interconnect.
Installation
Glossary
SageTV Server: PC on which SageTV has been installed.
SageTV User Interface (UI): The native SageTV interface which allows you to navigate the menus, play a video, etc.
Service mode: Mode where the recording engine and other processes run independently of the UI.
SageTVService Control: Sage application to start / stop the SageTV server when the server is running as a windows service (service mode). When SageTV is installed on a Windows Home Server PC, one can start / stop the server from the WHS Console as well.
SageTV Client: This is the UI installed and run from a different PC then the SageTV Server. When using SageTV in service mode, the UI component (which does not need to be installed separately) is also considered to be a SageTV Client.
Extender: Self contained media players like the Hauppauge MVP, HD Extender HD100/200, etc. They are basically a SageTV Client on dedicated hardware, rather that a PC...
Monitored device: This can be a real (i.e. Extender) or virtual (i.e. TheaterTek player) device used to playback audio and/or video...
How to setup MLSageTV
1) Shutdown MLServer3
2) Install
.NET 3.5 (if your PC does not already have it).
3) Install SageTV latest server software and perform all the SageTV configurations. Optionally install your Extenders (including Sage's HD Extender) and note the Extender IDs (on bottom of unit - you will need this later to control your Extender's from MainLobby client)
4) Shutdown SageTV (if you are running in service mode, make sure to stop the SageTV Service). All changes made while SageTV is running will be lost once SageTV is restarted.
5) Run the SageTV_TCPServer_Setup.exe on the SageTV Server PC.
This installs GKusnick's Studio Tools (i.e. extract to SageTV\SageTV folder). Make sure you choose both the GKusnick Studio AND the SageTCPServer to be installed on initial installation. The SageTCPServer is updated more often than the GKusnick components. You can deselect the GKusnick Studio on subsequent SageTCPServer updates. Example path (default settings)
c:\Program Files\SageTV\SageTV\JARs\gkusnkick.sagetv.jar
and installs Sage TCP Server (i.e. extract to SageTV\SageTV\JARs folder). Example path (default settings)
c:\Program Files\SageTV\SageTV\JARs\SageTCPServer.jar
You will have to restart SageTV application to start using the latest jar version.
6) In order for the plugin to receive from (or send to) the SageTV server, a communication port (TCP) will be used. This is done by adding the following lines to the sage.properties file (lower/upper case are important here):
load_at_startup_runnable_classes=sagetcpserver.StartServers sageTCPServer/clients=local.9250
9250 is the default port for the SageTV Server.
You also need to open up that port in your Firewall.
7) In order to monitor or control a SageTV client or extender, it is also necessary to use another port. For an Extender, you would append ",ExtenderMacID.port" to the previous line, where ExtenderMacID is the Physical Address of the device (i.e. look at the sticker underneath the HD Extender or from ipconfig /all or viewing logs from your network router, you can also look in the clients folder for a file like 00085a12b34c.properties. Use lower case.). So the line from sage.properties would then read:
sageTCPServer/clients=local.9250,00085a12b34c.9260
If you are running SageTV in service mode, and also running SageTV as a client on the same PC then you need to make similar entries in the sageclient.properties file:
load_at_startup_runnable_classes=sagetcpserver.StartServers sageTCPServer/clients=local.9250
If you are running a SageTV client on a different PC, in order to monitor/control it, you will need to add the 2 .jar files from step 6 and 7, as well as add similar lines to the sageclient.properties file on it:
load_at_startup_runnable_classes=sagetcpserver.StartServers sageTCPServer/clients=local.9261
Warning: Make sure to use unique port numbers for the clients, the sage UI and each Extender.
The default port configuration is to start with 9260 for each Extender or SageClient PC.
8) (Optional): if you want to see information about 14 days of upcoming recordings.
scheduling_lookahead=1209600000
9) Launch SageTV.
10) Install the MLSageTV plugin onto the primary MLServer3. This can optionally install MLMedia.mdb. This database is shared with at least the MLPhotoAlbum plugin. If you already have a copy, then you don't need to update it, unless a version updates the database tables (the release notes will advise when this is the case). If you don't have MLMedia.mdb on your system, then choose to install it for the initial installation. Subsequent plugin updates likely will not require to update the database. You then won't have to reimport your content with subsequent updates.
11) In MLServer, go to Plugins -> MLSageTV -> Settings, set the SageTV server and port appropriately, then save those settings.
11B) Share (read and write access) the following directory (assuming a default location):
c:\Program Files\SageTV\SageTV\GeneratedThumbnails
This is where Sage deposits its thumbnails. The directory needs to be shared so that MLServer can also display those images on MainLobby Clients. Other files, such as the TheaterTek DVD playlist, might also get created there by the plugin.
12) This plugin makes it possible to monitor or control the playback of audio or video files, anywhere in the house, through any MLClient. This is done through the concept of a Monitored device. There are 4 possible type of Monitored device: 1) the SageTV Server itself, 2) any SageTV Client (which includes the SageTV Server UI, when used in service mode), 3) a SageTV Extender or 4) a Zone Client (i.e. a software player like MLZoneAudio or MLTheaterTek).
Go to the Devices tab to add any extra Client/Extender defined in step 8 (the hostname should match the SageTV Server name, unless monitoring a SageTV Client on a different PC) or a Zone Client (by default the plugin will monitor the same zones as the ML Clients, but you could replace the {{zone}} by specific zones). You can also define an alias (between STV1 and STV6), this will allow you to use calls like PVR.STV#|Play~<file> (i.e. similar to using AV.TT1 to control TheaterTek DVD) in DVDLobby.
Hint: MLStartup is a good place to define variables on launch, like "media_HTPC_activeplayer = 1".
13) Load the MLSTV\STVGenericMenu.mls on each MainLobby client (that's how the plugin becomes aware of them).
15) To monitor/control a different device than the SageTV server, you have 2 options: A) through the "Monitored device" scene on the ML Client, you can press modify and chose between the SageTV server or the devices added in step 13, or B) in MLServer, go to Plugins -> MLSageTV -> Settings -> Scenes, select a ML Client, select a "Device to monitor" and press the big "Associate" button. Note that you should see the same ports that you defined in the SageTV properties files. WARNING: some operations (i.e. playlist) will fail if the monitored device is not online (i.e. Extender in standby), waking up the device or monitoring the SageTV Server should fix those issues.
14) (optional) In MLServer, go to Plugins -> MLSageTV -> Settings -> Scenes. When selecting a ML Client, you also have various options to change how things are displayed on the ML Client, like the X and Y offset of the Popups when using a wide screen display or settings about the navigation overlay. You should first open a MainLobby client, and open the MLSageTV scene. This will load the MLServeCmd.MLSageTV|Update command. Within the MLSageTV Plugin Scenes tab, you can then click on Client and see the connected client. You can then configure a default Monitored device, set the default navigation menu to use, etc. Click Save template when done making setting changes.
15) Click on the Databases tab. Here you can command TVLobby to grab the TV scheduling data from SageTV's server. This assumes you have setup SageTV software appropriately for your TV network, and SageTV software has downloaded the Guide data.
Once you configure SageTV software to monitor your Video / Photos / Music folder(s), and SageTV has updated that content into it's database, you can then click on Rebuild now to move that data into the MLMedia.mdb database. This allows MainLobby Server to send that same data to MainLobby client for presentation.
What it does
On launch it connects to the SageTV server through TCP and obtains various information (i.e. Recording Schedule, Recorded shows, Favorites, etc.). Those lists are available through the MainLobby UI. It also creates a file SageTV-Channels.xml containing your lineups.
It is possible to manually update the TVLobby database with the SageTV Guide data, from MLServer -> View -> Plugins -> MLSageTV -> Settings -> "Update the TVLobby database". Alternatively, you can enable the "Auto update the database", which will update the TVLobby database 10 minutes after starting the Plugin, or 30 minutes after the next time that SageTV gets new Guide data.
It is possible to launch Live TV or control the playback of a file on a "Monitored device", through the corresponding scene.
Debugging
In case of problems getting the plugin to work, you should:
Stop the SageTV service mode (if using it). Edit sage.properties, set "debug_logging=TRUE" and "sageTCPServer/debugOn=true". Save the file. Restart the SageTV service mode.(if using it). Probably need to restart MLServer.
Navigation
WARNING: Do not use the "back" option from MainLobby itself.
The navigation system supports touchscreen/mouse/keyboard/remote.
- Pressing the SageTV logo (or "Home" key) will bring you back to the Main menu.
- Pressing the "left arrow" on the top-left corner (or "Esc" key {requires disabling the option to shutdown the client that way}) will take you back to the previous page/scene.
- When a scroll bar is present, the use of "page up" and "page down" is enabled.
- You can scroll up/down using the up/down arrows.
- Some scenes can be scrolled left/right to change the view (i.e. Music).
- The Enter key will act the same as pressing/clicking an item.
- On the Album detailed scene, the spacebar will mark/un-mark a song, while the Enter key will act on the Play/Add menu. Pressing a number will mark/un-mark that song.
- On scenes with a scroll bar, in addition to using the scroll bar itself, it is generally possible to use numbers too (i.e. 1 = 10%, 5 = 50%, etc.).
Supported MLServeCmds
Starts up HD Extender
MLSageTV|Sendtoport~9250~XTC:killall waitpower
Shuts down HD Extender
MLSageTV|Sendtoport~9250~XTC:killall miniclient
Reboot HD Extender
MLSageTV|Sendtoport~9250~XTC:reboot
Manually or Schedule Media Updates and Rebuilds
MLSageTV|UpdateDb~<choice>
where <choice> can be one of {TVLobby|Music|Photos|Videos}. The command also supports the optional parameter ~rebuild, to force a wipe and refill of {Photos|Videos|Music}.
For example:
MLSageTV|UpdateDb~Photos~rebuild
The above commands can be manually triggered via a button on a MainLobby client scene, or scheduled to occur using MLScheduler or MLStartup (rebuild on MLServer startup).
Execute a Transport Command on Monitored Device
MLSageTV|MediaControl~<Command>
to execute a command on the media currently playing on the monitored device. Possible commands are: {FastForward|Next|Pause|Play|Previous|Rewind|Stop}. For example:
MLSageTV|MediaControl~Stop
would stop the playback on the monitored device.
To set the media currently playing on the monitored device to a certain position, use:
MLSageTV|SetMediaTime~<%>
For example:
MLSageTV|SetMediaTime~25
would move to 25% into the currently playing media file.
Initiate a Recording
MLSageTV|Record~<Type>~<AutoID>
to create a recording job. The <Type> can be Manual = one time recording, FirstRun = Favorite for only the first run episodes, ReRun = Favorite for reruns only or Any = Favorite for first run and reruns. The autoID is the value from the TVLobby database. Alternatively, when browsing the UI's guide, you can press the M = Manual (i.e. only one time), 1 = First run (i.e. new episodes only) or A = All buttons.
For example:
MLSageTV|Record~Manual~1234567
would record that TV show once.
Stream a show
MLSageTV|StreamAShow~{{PVR2_{{ClientName}}_Details_ID}}
MLSageTV|StreamAShow~12345
would start streaming the show associated with the ShowID.
Execute a Command on the Monitored Device
MLSageTV|SendToPort~<Port>~<Command>
to send a command directly to the appropriate SageTV TCP server/client/extender.
For example:
MLSageTV|SendToPort~9250~CMD:Live TV
would switch Sage TV to the Live TV mode.
Execute a Command on the Server
Example of use
MLSageTV|SendToServer~CMD:Power
the possible commands are:
Up
Down
Left
Right
Select
Info
Time Scroll
Volume Up
Volume Down
Power (won't boot HD Extender)
Watched
Favorite
Dont Like (not tested)
Num 0
Num 1
Num 2
Num 3
Num 4
Num 5
Num 6
Num 7
Num 8
Num 9
Search
Setup
Aspect Ratio Fill(not tested)
Aspect Ratio 4_3 (not tested)
Aspect Ratio 16_9 (not tested)
Aspect Ratio Source (not tested)
Audio (not working)
Page Left
Page Right
Previous Channel
Live TV
DVD Next Chapter
DVD Prev Chapter
DVD_Menu (not tested)
DVD_TitleMenu (not tested)
DVD_Return (not tested)
DVD
Delete
Music Jukebox
Recording Schedule
Picture Library
Video Library
Video Out (not working)
Eject (no apparant effect on HD Extender)
Supported MainLobby Server Variables
PVR2_numActiveRecs = Number of active recordings.
PVR2_StreamingURL = URL to access the VLC stream.
PVR2_{{ClientName}}_port = TCP Port of the monitored device.
PVR2_{{ClientName}}_device = Name of the monitored device.
PVR2_{{TCPPort}}_* = various information about a monitored device.
Release Notes
Version 3.1.8
- Added support for BMT's non-conform EPGID.
Version 3.1.7
- Switched more variable updates to SetVariable.
Version 3.1.6
- Most variables will now use SetVariable instead of SetVariableFast.
Version 3.1.5
- Added streaming through VLC.
Version 3.1.4
- Fix: Some MLSageTV commands were not parsed properly.
- Moved the log file to MLServer\Logs.
Version 3.1.3
- Added more debugging text for the TVLobby update.
Version 3.1.2
- Fixed the Last EPG Download time.
Version 3.1.1
- Moved the Logger part out of the invoke...
Version 3.1.0b
- Updated TCPServer and sample UI scenes.
Version 3.1.0
- Writing to the log listview should no longer be able to crash the plugin.
Version 3.0.0 to 3.0.9
- Will now reconnect after a communication loss.
- Fix: searches only worked when monitoring the server.
- Enhanced the information of the currently playing media.
- PVR.STV#|<Command> did not work from DVDLobby...
- Bug fixes.
- New SageTCPServer.jar.
- Added support for PVR.{{Alias}}|<<command>> to control a SageTV Client or Extender from another application.
- Changed the handling of the log file.
- Changed the TheaterTek DVD playlist support.
- Changed ownership from Cinemar Solutions Inc. to Tallus LLC.
Version 0.7.0 to .0.7.6
- Changed the navigation layer to one dedicated to the plugin.
- Adjusted the scenes to make use of the new navigation layer.
- Fix: in service mode, closing MLSageTV was not resetting the TCP connection to the SageTV Server.
- It is now possible to delete the selected device.
- Fix: media % was not updating.
- Fix: some playback variables were wrong.
- The Playlist should be functional for the "Power DVD" and "TheaterTek DVD" devices (make sure to have configured the shared GeneratedThumbnails folder with write access), for other "software" devices, only the first item will be played.
- Fix: variables for the playback were no longer updating.
- Replaced the "Zone Client" by "ArcSoft TMT", "Power DVD", "TheaterTer DVD", "Zone Audio" and "Zoom Player" devices (Playlist non functional)...
- Minor tweaks.
- Fix: needed to replace {{clientname}} by its value for "Zone Client".
- Fix: Client Zone commands were using ~ instead of |...
- Fix: ripped DVD's were not handled properly by "Zone Client".
Version 0.6.0 to .0.6.9
- Added support for "Zone Client" as a valid Device, which uses MLZoneAudio and MLTheatherTek.
- The plugin needs to be re-configured from scratch.
- The command MLSageTV|UpdateDb~<choice> can now use the optional parameter ~rebuild, to force a wipe and refill of {Photos|Videos|Music}.
- Don't read the Photos if they have no MediaID.
- Re-enabled the Photos Update. Another keyboard update...
- Replaced the standard keyboard.swf by mnkynifefite's one.
- Using a new table for the Photos.
- Changed the default database file.
- Added ability to turn on / off HD Extender hardware
- Moved the logging to StartUp to resolve a .NET Framework error.
- Fix: "Now Playing" was not always listed as a valid playlist.
- Possible fix for the playback % not updating when StartTime = EndTime.
- Enabled the creation of a new playlist.
- Fix: creation of new templates was not working.
Version 0.5.0 - 0.5.9
- Minor tweaks for the Playlist.
- The search by Title now uses the standard keyboard layout (wide screen users will need to copy the Movie folder from 1024x768).
- Can change to another existing playlist (New is not active yet).
- Initial version of the Playlist scene, it allows to browse it, delete it or delete selected items from it.
- Fix: if a connection to a monitored device could not be established, more and more attempts were made.
- It is now possible to change the Music view (Album/Artist/Genre/Song) using the Left/Right arrow.
- It is now possible to add songs or albums to the playlist without going to the detailed view.
- Fix: removed the trigger and work around for the MainLobby un-clickable --> clickable bug.
- Fix: changed the ComboBox from DrowDown to DropDownList...
- By default the Navigation menu will use the layer 3 while the Popups will use the layer 4.
- Forced a reload of the navigation layer, when going to the Main menu, as a work around for the disappearing layer...
- Fix: navigation issues with detailed view and "Viewing by...".
- Fix: the filename of some thumbnails were not properly reconstructed.
- The Music by Artist and Genre will now default to a view by Albums.
- Set albumID as the first songID of that album, requires a full rebuild of the Music.
- Added the possiblity of updating the Music/Photos/Videos, instead of a full rebuilt.
- Fix: the "optimized" data queries were taking way too long.
- Added the possibility to select Music through a slider.
Version 0.4.0 - 0.4.9
- Fix: the songs by album query was broken.
- Merged the Albums/Artist/Genre/Song scenes into one.
- Fix: songs were using the wrong ID.
- Improved the browse by Artist and by Genre.
- Added a detailed view for the albums.
- Fix: could not access the last data from the Albums view. Improved the database queries.
- Added some Browse by Albums, Artists and Genres scenes.
- Fix: some navigation commands lead to unnecessary refresh.
- Fix: can now browse the full collection of Media files.
- Added a scene to display photos in a 480x480 frame.
- Fix: the monitored device scene was not handling DVD's properly.
- Added the command MLSageTV|UpdateDb~<choice>, where <choice> can be one of {TVLobby|Music|Photos|Videos}.
- Made it more obvious when an update was started.
- Added the cover art for albums.
- The Music/Photos/Videos lists are now alphabetically ordered.
- Initial work on the MLSageTV database (limit of 250 items displayed in UI).
Version 0.3.1 to 0.3.9
- Thumbnails can be made available on the network by sharing the SageTV\SageTV\GeneratedThumbnails folder and setting it in the plugin.
- Fix: it is now possible to control a SageTV client (requires the sageclient.properties entries and .jar file on that PC too).
- Fix: the lists would not get sent when they contained too many items (now limited to 10k).
- Added the thumbnails (SageTV server only for now) in the detailed view, when available.
- Fix: Changing the monitored device from the UI was not saving it for the next time.
- Fix: albums with no "year" were not properly handled.
- Added the possibility to mute/un-mute the monitored device.
- Improved the Music support.
- Fix: the creation of some lists was failing.
- Fix: auto-update of the TVLobby database would only work every other day, instead of daily.
-Increased the size of some fonts on many scenes.
- Added the possibility to "Auto update the TVLobby database".
- Fix: simultaneous log entries were creating duplicates in the log file.
- Fix: inactive "monitored TCP port" will no longer prevent the plugin from loading.
- If no TCP connections are made with the SageTV server/clients/extenders, reconnect attempts will be made every 5 minutes.
- Added the "MLSageTV|SendToServer~<<command>>" command, which works like "SendToPort", but without having to specify a port.
- Improved the configuration, should no longer require to restart the plugin or MLServer after various changes.
- Added the video playback controls to the Monitored device scene.
- Added the Episode title to the "Monitored device" scene.
Version 0.2.1 to 0.3.0
- Added a "Monitored device" scene.
- Removed the forced overlay refresh and instead fixed some scenes with overlay scales of 0.
- Fix: the recording icon was not working properly.
- Forced a refresh of the overlay on each change scene.
- The lists of Recordings (Favorites, Manual, Upcoming) are now updated after creating a new Recording job.
- The recording icon and number of active recordings will now be visible (if > 0).
- Added the Manual/Timed recordings to the list of Favorite shows.
- The list of upcoming episodes is no longer limited to that specific episode, it will instead display all the episodes of that series.
- The Favorites scene now displays an icon for the type of recording, 1 = first runs, R = reruns, A = any.
- Cleaned up the user interface and the underlying code.
- Added the Watched status to the Recorded show details.
- The Duration displayed on the Recorded show details is now based on the Start and End time, unless already provided (i.e. movie).
- Added a search by title.
- Added a Playlist.
- Added the list of Music files and Photos.
Version 0.1.1 to 0.2.0
- The free video disk space is now working.
- Added the possibility of creating a recording job from the Program Guide.
- Added the command "MLSageTV|Record~{{Type}}~{{AutoID}}", where {{TYpe}} = (Manual|FirstRun|Any) and {{AutoID}} is the database's autoID of the TblProgram.
- Requires SageTCPServer version 0.7.
- Added the Lineup selection to the Program Guide scene
- Added a Media Center scene for the other type of video files.
- Can use Live TV and Play back a file on the monitored SageTV device.
- Added the command: "MLSageTV|SendToPort~{{port}}~{{Command}}", where {{port}} is the port of one of the monitored devices and {{Command}} is one of the accepted SageTCPServer commands like "CMD:Live TV" (replaces the "send" command which only worked on the Sage TV Server).
- The "Recorded show details" scene is now more informative.
- The scenes now contain more detailed information.
- Requires SageTCPServer version 0.6.
- Added the possibility of updating the TVLobby database.
- Uses the new SageTCPServer. Retrieves the list of Lineups and create the MLSageTV-Channels.xml file from it, if not already done. Can update the table of channels of the TVLobby database.
- It is now possible to define a "Device to monitor" (i.e. SageTV Server/Client/Extender) for each MainLobby client.
- Fix: the date was not in human readable format on the "Recorded show details" scene. A set of PVR2_Play_{attributes} are now created during playback.
Version 0.0.1 to 0.1.0
- Fix: At a glance was not properly handling limited Upcoming/Recent/Rejected recordings. Moved the TCP listening to its own background worker thread.
- MLSageTV|Send~<Command> to send a command directly to the SageTV TCP server. For example: "MLSageTV|Send~CMD:Live TV" (without the "") would switch Sage TV to the Live TV mode.
- Includes a new UI for interaction with SageTV app.
- Replaced the use of Nielm's web server by Beelzerob's SageCQC Home Automation Server. No UI support yet and very limited functionality.
- Added the Favorites (Recording jobs) and Detailed show informations scenes.
- Added the Recorded shows information.
- Added minimal UI support.
- Proof of concept. Connects to Nielm's SageTV Server to get the list of Upcoming recordings. No MainLobby interface yet, everything is done through the plugins/settings of MLServer.
Screenshots
