io.gitlab.mguimard.openrgb.client

Class OpenRGBClient

java.lang.Object

io.gitlab.mguimard.openrgb.client.OpenRGBClient

public class OpenRGBClient
extends Object

Client class to communicate with an OpenRGBServer

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, this method also sets the client name and retrieves the server protocol version
void	deleteProfile(String profileName) Deletes the given profile name
void	disconnect() Disconnect the socket
int	getControllerCount() Retrieve the count of controllers discovered by OpenRGBServer
OpenRGBDevice	getDeviceController(int deviceIndex) Returns all controller information for a given deviceIndex
String[]	getProfileList() Retrieves the list of profile names
void	loadProfile(String profileName) Loads a given profile
void	resizeZone(int deviceIndex, int zoneIndex, int size) Resizes a given zone
void	saveProfile(String profileName) Saves the current configuration as a new profile
void	setClientName() Send the client name to the OpenRGBServer
void	updateLed(int deviceIndex, int ledIndex, OpenRGBColor color) Update a given Led color
void	updateLeds(int deviceIndex, OpenRGBColor[] colors) Update all leds for a given device
void	updateMode(int deviceIndex, int modeIndex, OpenRGBMode mode) Change the mode for a controller
void	updateZoneLeds(int deviceIndex, int zoneIndex, 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, this method also sets the client name and retrieves the server protocol version

Throws:

IOException

disconnect

public void disconnect()
                throws IOException

Disconnect the socket

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 deviceIndex)
                                  throws IOException

Returns all controller information for a given deviceIndex

Parameters:

deviceIndex - the device id sent by OpenRGBServer

Returns:

the controller information

Throws:

IOException

updateLed

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

Update a given Led color

Parameters:

deviceIndex - the device to update

ledIndex - the led index to update

color - the color to set

Throws:

IOException

updateLeds

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

Update all leds for a given device

Parameters:

deviceIndex - the device to update

colors - the colors to set

Throws:

IOException

updateZoneLeds

public void updateZoneLeds(int deviceIndex,
                           int zoneIndex,
                           OpenRGBColor[] colors)
                    throws IOException

Update leds in a given zone for a given device

Parameters:

deviceIndex - the device to update

zoneIndex - the zone to update

colors - the colors to set

Throws:

IOException

updateMode

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

Change the mode for a controller

Parameters:

deviceIndex - the device id sent by OpenRGBServer

modeIndex - the mode index to set

mode - the updated mode

Throws:

IOException

resizeZone

public void resizeZone(int deviceIndex,
                       int zoneIndex,
                       int size)
                throws IOException

Resizes a given zone

Parameters:

deviceIndex - device index to resize

zoneIndex - zone index to resize

size - the size to set

Throws:

IOException

getProfileList

public String[] getProfileList()
                        throws IOException

Retrieves the list of profile names

Returns:

the list of profile names

Throws:

IOException

saveProfile

public void saveProfile(String profileName)
                 throws IOException

Saves the current configuration as a new profile

Parameters:

profileName - the new profile name

Throws:

IOException

loadProfile

public void loadProfile(String profileName)
                 throws IOException

Loads a given profile

Parameters:

profileName - the profile name to load

Throws:

IOException

deleteProfile

public void deleteProfile(String profileName)
                   throws IOException

Deletes the given profile name

Parameters:

profileName - the profile name to delete

Throws:

IOException