io.gitlab.mguimard.openrgb.client

Class OpenRGBClient

java.lang.Object

io.gitlab.mguimard.openrgb.client.OpenRGBClient

public class OpenRGBClient
extends Object

Constructor Summary

Constructors

Constructor and Description
OpenRGBClient(String host, int port, String name) Returns an instance of OpenRGBClient

Method Summary

Modifier and Type	Method and Description
void	connect() Connect to the OpenRGBServer
void	disconnect() Disconnect the socket
int	getControllerCount() Retrieve the count of controllers discovered by OpenRGBServer
OpenRGBDevice	getDeviceController(int deviceId) Returns all controller information for a given deviceId
int	getProtocolVersion()
void	setClientName() Send the client name to the OpenRGBServer
void	updateLed(int deviceId, int ledIndex, OpenRGBColor color) Update a given Led color
void	updateLeds(int deviceId, OpenRGBColor[] colors) Update all leds for a given device
void	updateMode(int deviceId, int modeIndex, OpenRGBMode mode) Change the mode for a controller
void	updateZoneLeds(int deviceId, int zoneId, OpenRGBColor[] colors) Update leds in a given zone for a given device

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenRGBClient

public OpenRGBClient(String host,
                     int port,
                     String name)

Returns an instance of OpenRGBClient

Parameters:

host - server ip or host

port - server port

name - client name displayed in OpenRGBServer

Method Detail

connect

public void connect()
             throws IOException

Connect to the OpenRGBServer

Throws:

IOException

disconnect

public void disconnect()
                throws IOException

Disconnect the socket

Throws:

IOException

getProtocolVersion

public int getProtocolVersion()
                       throws IOException

Throws:

IOException

setClientName

public void setClientName()
                   throws IOException

Send the client name to the OpenRGBServer

Throws:

IOException

getControllerCount

public int getControllerCount()
                       throws IOException

Retrieve the count of controllers discovered by OpenRGBServer

Returns:

the count of controllers

Throws:

IOException

getDeviceController

public OpenRGBDevice getDeviceController(int deviceId)
                                  throws IOException

Returns all controller information for a given deviceId

Parameters:

deviceId - the device id sent by OpenRGBServer

Returns:

the controller information

Throws:

IOException

updateLed

public void updateLed(int deviceId,
                      int ledIndex,
                      OpenRGBColor color)
               throws IOException

Update a given Led color

Parameters:

deviceId - the device to update

ledIndex - the led index to update

color - the color to set

Throws:

IOException

updateLeds

public void updateLeds(int deviceId,
                       OpenRGBColor[] colors)
                throws IOException

Update all leds for a given device

Parameters:

deviceId - the device to update

colors - the colors to set

Throws:

IOException

updateZoneLeds

public void updateZoneLeds(int deviceId,
                           int zoneId,
                           OpenRGBColor[] colors)
                    throws IOException

Update leds in a given zone for a given device

Parameters:

deviceId - the device to update

zoneId - the zone to update

colors - the colors to set

Throws:

IOException

updateMode

public void updateMode(int deviceId,
                       int modeIndex,
                       OpenRGBMode mode)
                throws IOException

Change the mode for a controller

Parameters:

deviceId - the device id sent by OpenRGBServer

modeIndex - the mode index to set

mode - the updated mode

Throws:

IOException