nl.maartenvisscher.samsungtvcontrol

Class SamsungRemote

java.lang.Object

nl.maartenvisscher.samsungtvcontrol.SamsungRemote

public class SamsungRemote
extends java.lang.Object

API for controlling Samsung Smart TVs using a socket connection on port 55000. The protocol information has been gathered from http://sc0ty.pl/2012/02/samsung-tv-network-remote-control-protocol/ .

Constructor Summary

Constructors

Constructor and Description
SamsungRemote(java.net.InetAddress host) Opens a socket connection to the television.
SamsungRemote(java.net.InetAddress host, boolean debug) Opens a socket connection to the television and keeps a simple log when debug is true.
SamsungRemote(java.lang.String host) Deprecated.
SamsungRemote(java.lang.String host, boolean debug) Deprecated.

Method Summary

Modifier and Type	Method and Description
TVReply	authenticate(java.lang.String name) Authenticates with the television using host IP address for the ip and id parameters.
TVReply	authenticate(java.lang.String id, java.lang.String name) Authenticates with the television using host IP address for the ip parameter.
TVReply	authenticate(java.lang.String ip, java.lang.String id, java.lang.String name) Authenticates with the television.
void	checkConnection() Checks the connection by sending an empty key code, does not return anything but instead throws an exception when a problem arose (for instance the TV turned off).
void	close() Closes the socket connection.
java.lang.String[]	getLog() Returns a simple log with for instance TV response payloads as string array, will only be filled when this class is constructed with debug true (otherwise the array will be empty).
void	keycode(Keycode keycode) Sends a key code to TV, blocks shortly waiting for TV response to check delivery.
void	keycode(java.lang.String keycode) Sends a key code to TV, blocks shortly waiting for TV response to check delivery.
void	keycodeAsync(Keycode keycode) Sends a key code to TV in a non-blocking manner, thus it does not check the delivery (use checkConnection() to poll the TV status).
void	keycodeAsync(java.lang.String keycode) Sends a key code to TV in a non-blocking manner, thus it does not check the delivery (use checkConnection() to poll the TV status).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SamsungRemote

public SamsungRemote(java.net.InetAddress host)
              throws java.io.IOException

Opens a socket connection to the television.

Parameters:

host - the host address.

Throws:

java.io.IOException - if an I/O error occurs when creating the socket.

SamsungRemote

public SamsungRemote(java.net.InetAddress host,
                     boolean debug)
              throws java.io.IOException

Opens a socket connection to the television and keeps a simple log when debug is true.

Parameters:

host - the host address.

debug - whether or not to keep a log.

Throws:

java.io.IOException - if an I/O error occurs when creating the socket.

SamsungRemote

public SamsungRemote(java.lang.String host)
              throws java.io.IOException

Deprecated.

Opens a socket connection to the television.

Parameters:

host - the host name.

Throws:

java.io.IOException - if an I/O error occurs when creating the socket.

SamsungRemote

public SamsungRemote(java.lang.String host,
                     boolean debug)
              throws java.io.IOException

Deprecated.

Opens a socket connection to the television and keeps a simple log when debug is true.

Parameters:

host - the host name.

debug - whether or not to keep a log.

Throws:

java.io.IOException - if an I/O error occurs when creating the socket.

Method Detail

authenticate

public TVReply authenticate(java.lang.String name)
                     throws java.io.IOException

Authenticates with the television using host IP address for the ip and id parameters.

Parameters:

name - the name for this controller, which is displayed on the television.

Returns:

the response from the television.

Throws:

java.io.IOException - if an I/O error occurs.

See Also:

authenticate

authenticate

public TVReply authenticate(java.lang.String id,
                            java.lang.String name)
                     throws java.io.IOException

Authenticates with the television using host IP address for the ip parameter.

Parameters:

id - a parameter for the television.

name - the name for this controller, which is displayed on the television.

Returns:

the response from the television.

Throws:

java.io.IOException - if an I/O error occurs.

See Also:

authenticate

authenticate

public TVReply authenticate(java.lang.String ip,
                            java.lang.String id,
                            java.lang.String name)
                     throws java.io.IOException

Authenticates with the television. Has to be done every time when a new socket connection has been made, prior to sending key codes. Blocks while waiting for the television response.

Parameters:

ip - a parameter for the television.

id - a parameter for the television.

name - the name for this controller, which is displayed on the television.

Returns:

the response from the television.

Throws:

java.io.IOException - if an I/O error occurs.

keycode

public void keycode(Keycode keycode)
             throws java.io.IOException

Sends a key code to TV, blocks shortly waiting for TV response to check delivery. Only works when you are successfully authenticated.

Parameters:

keycode - the key code to send.

Throws:

java.io.IOException - if an I/O error occurs.

keycode

public void keycode(java.lang.String keycode)
             throws java.io.IOException

Sends a key code to TV, blocks shortly waiting for TV response to check delivery. Only works when you are successfully authenticated.

Parameters:

keycode - the key code to send.

Throws:

java.io.IOException - if an I/O error occurs.

keycodeAsync

public void keycodeAsync(Keycode keycode)
                  throws java.io.IOException

Sends a key code to TV in a non-blocking manner, thus it does not check the delivery (use checkConnection() to poll the TV status). Only works when you are successfully authenticated.

Parameters:

keycode - the key code to send.

Throws:

java.io.IOException - if an I/O error occurs.

keycodeAsync

public void keycodeAsync(java.lang.String keycode)
                  throws java.io.IOException

Sends a key code to TV in a non-blocking manner, thus it does not check the delivery (use checkConnection() to poll the TV status). Only works when you are successfully authenticated.

Parameters:

keycode - the key code to send.

Throws:

java.io.IOException - if an I/O error occurs.

checkConnection

public void checkConnection()
                     throws java.io.IOException

Checks the connection by sending an empty key code, does not return anything but instead throws an exception when a problem arose (for instance the TV turned off).

Throws:

java.io.IOException - if an I/O error occurs.

getLog

public java.lang.String[] getLog()

Returns a simple log with for instance TV response payloads as string array, will only be filled when this class is constructed with debug true (otherwise the array will be empty).

Returns:

a simple log.

close

public void close()

Closes the socket connection. Should always be called at the end of a session.