How to control Client/Server via TCP/IP socket

[moamoa]

Hi,

Is is possible to open a network socket to a SageTVClient and then send commands to it in order to control it?

Basically, like a remote control but over the network rather then IR.

If this is possible, is that any documentation the outlines the process and the commands that can be sent in order to control it?

Thanks.

[evilpenguin]

Yep, its very possible, although not quite like you're describing. Check out Neilm's webserver which has a webremote that lets you send commands via HTTP requests.

[sic0048]

Actually I think the command are routed to the Sage Server which uses the API to actually control the clients. The end result is the same, but I'm not sure you can control a HD-200 in stand alone mode via this method. There is no connection with the Sage Server in stand alone mode, so there is no communication pathway open.

I know we use this method in CQC to control just about all the variables of a Sage system. But it doesn't work with a HD-200 in standalone mode while it works fine for a HD-200 (or other extenders/clients) that are using the SageTV software connection.

[GKusnick]

It's fairly trivial for someone who knows Java to write a background class that runs in the SageTV process, accepts a telnet connection, listens for commands, and passes them to the SageCommand() API method. (This is more or less what the web server does, except that it uses an HTTP connection instead of a telnet connection.)

For clients that execute the UI on the server (i.e. Extender and Placeshifter clients), the listener class must run on the server. For SageTV Client, which executes the UI locally, the listener class must run on the client. (So if you want to control SageTV Client via the web server, you must install it on the client as well as on the server.)

[nyplayer]

Originally Posted by moamoa

Hi,

Is is possible to open a network socket to a SageTVClient and then send commands to it in order to control it?

Basically, like a remote control but over the network rather then IR.

If this is possible, is that any documentation the outlines the process and the commands that can be sent in order to control it?

Thanks.

Did you checkout the SageTV Remote Control here?

http://forums.sagetv.com/forums/down...do=file&id=270

[smoothtlk]

Both MainLobby and CQC automation software can control and see status of SageTV and Sage Extenders. Both use the TCPServer that Fonceur / Beelzerob have been supporting. All connections are via TCP.

[moamoa]

Originally Posted by GKusnick

It's fairly trivial for someone who knows Java to write a background class that runs in the SageTV process, accepts a telnet connection, listens for commands, and passes them to the SageCommand() API method. (This is more or less what the web server does, except that it uses an HTTP connection instead of a telnet connection.)

This sounds just about perfect for what I want.

Can you point me at the docs to this SageCommand() api, java I hope.

Also, any simple examples of how to make my java class install in to sage and any example of how to use the API to execute a commands such as "Play" or something.

Point me in the right direction and I'll have a go!

[GKusnick]

See the Studio Information Resources sticky for links to the SageTV API docs.

Java API docs are at http://java.sun.com/javase/6/docs/api/.

There are numerous examples in the Downloads section of plugins that run as background classes in the SageTV process. Some of them (the web server for example) include source, or have links to publicly accessible source. But basically it's just a matter of implementing the Runnable interface and adding your fully-qualified class name to the load_at_startup_runnable_classes property.

[moamoa]

thanks that's a big help.

I've downloaded;
sagex.api-6.5.15-5.zip

I've upzipped this into my server (JARS) and restarted it.

Is there something else I need to do configuration wise, as typing this;
http://<my-server-ip>/sagex/api
into the browser is doing nothing?

From the docs

The /sagex/api handler has documentation built into the handler. If you call this handler from a browser without any arguments, it will return a page that shows the basic usage and the api documentation.

Am I missing something?

Originally Posted by GKusnick

See the Studio Information Resources sticky for links to the SageTV API docs.

Java API docs are at http://java.sun.com/javase/6/docs/api/.

There are numerous examples in the Downloads section of plugins that run as background classes in the SageTV process. Some of them (the web server for example) include source, or have links to publicly accessible source. But basically it's just a matter of implementing the Runnable interface and adding your fully-qualified class name to the load_at_startup_runnable_classes property.

[stuckless]

Originally Posted by moamoa

thanks that's a big help.

I've downloaded;
sagex.api-6.5.15-5.zip

I've upzipped this into my server (JARS) and restarted it.

Is there something else I need to do configuration wise, as typing this;
http://<my-server-ip>/sagex/api
into the browser is doing nothing?

From the docs

Am I missing something?

This wasn't exactly what Greg was referring to... but since you asked, check out this page for instructions on enabling these apis in the neilm webserver or the jetty server. (i personally recommend the jetty server method).

EDIT: BTW, I just updated the wiki, because I realized the install instructions for jetty was outdated.