OpenRGB/Documentation/OpenRGBSDK.md

OpenRGB SDK Documentation

OpenRGB provides a network-based Software Development Kit (SDK) interface for third-party software applications to integrate with OpenRGB to control lighting on OpenRGB-supported devices. This protocol is a binary, packet-based protocol designed for efficient, lightweight transfer of lighting data over a TCP/IP connection. It may be used locally or over a physical network between computers. The protocol is versioned. Client and server must negotiate a minimum supported protocol version upon connection. The selected protocol version determines what capabilities are available and can change packet format for certain packets as new information is added to the protocol.

The protocol mimics the RGBController API closely. It can be thought of as "RGBController over IP" in that the protocol is designed so that a network RGBController object can be created on the client that is a direct copy of the real RGBController object on the server. Calls to the network client RGBController object send packets to the server which trigger calls to the real object, updating the necessary object data before the call.

Protocol Versions

Protocol Version	OpenRGB Release	Description
0	0.3	Initial (unversioned) protocol
1	0.5	Add versioning, add vendor string
2	0.6	Add profile controls
3	0.7	Add brightness field to modes, add SaveMode()
4	0.9	Add segments field to zones, plugin interface
5	1.0rc1	Add zone flags, controller flags, effects-only zones, alternative LED names, add ClearSegments and AddSegments
6*	1.0	Add matrix map segments, per-zone modes, remote SettingsManager and ProfileManager, update callbacks

* Denotes unreleased version, reflects status of current pipeline

Protocol Basics

The default port for the OpenRGB SDK server is 6742. This is "ORGB" on a telephone keypad.

Each packet starts with a header that indicates the packet is an OpenRGB SDK packet and provides the device and packet IDs. The header format is described in the following table.

NetPacketHeader structure

Size	Format	Name	Description
4	char[4]	pkt_magic	Magic value, "ORGB"
4	unsigned int	pkt_dev_id	Device ID
4	unsigned int	pkt_id	Packet ID
4	unsigned int	pkt_size	Packet Size

pkt_magic: Always set this to the literal value "ORGB".

pkt_dev_id: The device index that the command is targeting.

pkt_id: The command ID, see IDs table below

pkt_size: The size, in bytes, of the packet data

Packet IDs

The following IDs represent different SDK commands. Each ID packet has a certain format of data associated with it, which will be explained under each ID's section of this document. Gaps have been left in the ID values to allow for future expansion. The same ID values are often used for both request and response packets.

Value	Name	Description	Protocol Version
0	NET_PACKET_ID_REQUEST_CONTROLLER_COUNT	Request RGBController device count/device IDs from server	0
1	NET_PACKET_ID_REQUEST_CONTROLLER_DATA	Request RGBController data block	0
40	NET_PACKET_ID_REQUEST_PROTOCOL_VERSION	Request OpenRGB SDK protocol version from server	1*
50	NET_PACKET_ID_SET_CLIENT_NAME	Send client name string to server	0
51	NET_PACKET_ID_SET_SERVER_NAME	Send server name string to client	6
100	NET_PACKET_ID_DEVICE_LIST_UPDATED	Indicate to clients that device list has updated	1
101	NET_PACKET_ID_DETECTION_STARTED	Indicate to clients that detection started	6
102	NET_PACKET_ID_DETECTION_PROGRESS_CHANGED	Indicate to clients that detection progress changed	6
103	NET_PACKET_ID_DETECTION_COMPLETE	Indicate to clients that detection completed	6
140	NET_PACKET_ID_REQUEST_RESCAN_DEVICES	Request server to rescan devices	5
150	NET_PACKET_ID_PROFILEMANAGER_GET_PROFILE_LIST	Get profile list	2
151	NET_PACKET_ID_PROFILEMANAGER_SAVE_PROFILE	Save current configuration in a new profile	2
152	NET_PACKET_ID_PROFILEMANAGER_LOAD_PROFILE	Load a given profile	2
153	NET_PACKET_ID_PROFILEMANAGER_DELETE_PROFILE	Delete a given profile	2
154	NET_PACKET_ID_PROFILEMANAGER_UPLOAD_PROFILE	Upload a profile to the server in JSON format	6
155	NET_PACKET_ID_PROFILEMANAGER_DOWNLOAD_PROFILE	Download a profile from the server in JSON format	6
156	NET_PACKET_ID_PROFILEMANAGER_GET_ACTIVE_PROFILE	Get the active profile name	6
200	NET_PACKET_ID_PLUGINMANAGER_GET_PLUGIN_LIST	Get list of plugins	4
201	NET_PACKET_ID_PLUGINMANAGER_PLUGIN_SPECIFIC	Interact with a plugin	4
250	NET_PACKET_ID_SETTINGSMANAGER_GET_SETTINGS	Get settings for a given key in JSON format	6
251	NET_PACKET_ID_SETTINGSMANAGER_SET_SETTINGS	Set settings for a given key in JSON format	6
252	NET_PACKET_ID_SETTINGSMANAGER_SAVE_SETTINGS	Save settings	6
1000	NET_PACKET_ID_RGBCONTROLLER_RESIZEZONE	RGBController::ResizeZone()	0
1001	NET_PACKET_ID_RGBCONTROLLER_CLEARSEGMENTS	RGBController::ClearSegments()	5
1002	NET_PACKET_ID_RGBCONTROLLER_ADDSEGMENT	RGBController::AddSegment()	5
1050	NET_PACKET_ID_RGBCONTROLLER_UPDATELEDS	RGBController::UpdateLEDs()	0
1051	NET_PACKET_ID_RGBCONTROLLER_UPDATEZONELEDS	RGBController::UpdateZoneLEDs()	0
1052	NET_PACKET_ID_RGBCONTROLLER_UPDATESINGLELED	RGBController::UpdateSingleLED()	0
1100	NET_PACKET_ID_RGBCONTROLLER_SETCUSTOMMODE	RGBController::SetCustomMode()	0
1101	NET_PACKET_ID_RGBCONTROLLER_UPDATEMODE	RGBController::UpdateMode()	0
1102	NET_PACKET_ID_RGBCONTROLLER_SAVEMODE	RGBController::SaveMode()	3
1103	NET_PACKET_ID_RGBCONTROLLER_UPDATEZONEMODE	RGBController::UpdateZoneMode()	6
1150	NET_PACKET_ID_RGBCONTROLLER_SIGNALUPDATE	RGBController::SignalUpdate()	6

* The NET_PACKET_ID_REQUEST_PROTOCOL_VERSION packet was not present in protocol version 0, but clients supporting protocol versions 1+ should always send this packet. If no response is received, it should be assumed that the server is using protocol 0.

Device IDs

The OpenRGB SDK is used to allow a client to access one or more RGBControllers on the server. As there are usually more than one controllers on the server, an identifier is needed to specify which controller the client wants to access. The pkt_dev_id field in the header is used for this purpose. Originally, OpenRGB used a simple indexing scheme, where the value of pkt_dev_id is the index in the server's controllers list. Starting with protocol version 6, however, OpenRGB switched to using a unique ID scheme, where each controller detected on the server is assigned a unique ID and then the server sends a list of these unique IDs to the client. If the list changes, the IDs of any existing controllers stay the same but new controllers have new unique IDs, allowing the client to keep track of which controllers stayed the same and which have changed. The control flow for both schemes is described below.

Protocol versions 0-5 (indexed IDs)

In this scheme, the client starts by sending NET_PACKET_ID_REQUEST_CONTROLLER_COUNT to the server, which returns the count of controllers in the list. The client then sends NET_PACKET_ID_REQUEST_CONTROLLER_DATA with pkt_dev_id for each controller index 0 to [count - 1], waiting for each controller data response before moving on to the next controller. Following this, any accesses to the controllers use the index for the pkt_dev_id field of any NET_PACKET_ID_RGBCONTROLLER packet. If the device list changes (indicated by the server sending NET_PACKET_ID_DEVICE_LIST_UPDATED), the indexes on the client side may no longer match those on the server side. The client must immediately stop using the existing indexes, clear its list of controllers, and obtain the new list by performing this sequence again.

Protocol versions 6 and above (unique IDs)

In this scheme, the client starts by sending NET_PACKET_ID_REQUEST_CONTROLLER_COUNT to the server, which returns both the count of controllers in the list as well as a list of unique 32-bit IDs. Each unique ID represents one controller in the server's list. The order of these unique IDs also matches the order of controllers in the server's list. The client then sends NET_PACKET_ID_REQUEST_CONTROLLER_DATA with pkt_dev_id for each unique ID in the list, waiting for each controller data response before moving on to the next controller. Following this, any accesses to the controllers use the unique ID for the pkt_dev_id field of any NET_PACKET_ID_RGBCONTROLLER packet. If the device list changes (indicated by the server sending NET_PACKET_ID_DEVICE_LIST_UPDATED), the client must request a new list of unique IDs by sending NET_PACKET_ID_REQUEST_CONTROLLER_COUNT again. Once the response is received, the client should compare the new list of unique IDs against its existing list. Unique IDs that were in its existing list that no longer exist in the new list should be deleted on the client as these controllers are no longer present. Unique IDs that exist in the new list but did not exist in the existing list are newly added controllers and the client should request these by sending NET_PACKET_ID_REQUEST_CONTROLLER_DATA with pkt_dev_id for each newly added unique ID, waiting for each controller data response before moving on to the next controller. Unique IDs that are present in the existing list as well as the new list are controllers that have not changed on the server side, so the client does not need to re-request these controllers and can continue using them as is.

Packet-Specific Documentation

NET_PACKET_ID_REQUEST_CONTROLLER_COUNT

Request [Size: 0]

The client uses this ID to request the number of controllers on the server. The request contains no data.

Response [Protocol 0-5 Size: 4] [Protocol 6+ Size: 4 + (4 * number of controllers)]

The server responds to this request with the number of controllers in the device list. For protocol versions below 6, the response contains a single unsigned int, size 4, holding this value.

For protocol versions 6 and above, the response contains a single unsigned int, size 4, holding this value followed by a list of unsigned ints, each size 4, representing the unique IDs of each controller in the device list. See the Device IDs section for more information.

NET_PACKET_ID_REQUEST_CONTROLLER_DATA

Request [Protocol 0 Size: 0] [Protocol 1+ Size: 4]

The client uses this ID to request the controller data for a given controller. For protocol 0, this request contains no data. For protocol 1 or higher, this request contains a single unsigned int, size 4, holding the highest protocol version supported by both the client and the server. The pkt_dev_id of this request's header indicates which controller you are requesting data for. See the Device IDs section for more information.

NOTE: Before sending this request, the client should request the protocol version from the server and determine the value to send, if any. If the server is using protocol version 0, even if the SDK implementation supports higher, send this packet with no data.

Response [Size: Variable]

The server responds to this request with a large data block. The format of the block is shown below. Portions of this block are omitted if the requested protocol level is below the listed value. The receiver is expected to parse this data block using the same protocol version sent in the request (or protocol 0 if the request is sent with no data).

Size	Format	Name	Protocol Version	Description
4	unsigned int	data_size	0	Size of all data in packet
Variable	Device Data	device_data	0	See Device Data block format table

Device Data

The Device Data block represents an entire RGBController. This data block is provided by RGBController::GetDeviceDescriptionData(). Portions of this block are omitted if the requested protocol level is below the listed value.

Size	Format	Name	Protocol Version	Description
4	int	type	0	RGBController type field value
2	unsigned short	name_len	0	Length of RGBController name field string, including null termination
name_len	char[name_len]	name	0	RGBController name field string value, including null termination
2	unsigned short	vendor_len	1	Length of RGBController vendor field string, including null termination
vendor_len	char[vendor_len]	vendor	1	RGBController vendor field string value, including null termination
2	unsigned short	description_len	0	Length of RGBController description field string, including null termination
description_len	char[description_len]	description	0	RGBController description field string value, including null termination
2	unsigned short	version_len	0	Length of RGBController version field string, including null termination
version_len	char[version_len]	version	0	RGBController version field string value, including null termination
2	unsigned short	serial_len	0	Length of RGBController serial field string, including null termination
serial_len	char[serial_len]	serial	0	RGBController serial field string value, including null termination
2	unsigned short	location_len	0	Length of RGBController location field string, including null termination
location_len	char[location_len]	location	0	RGBController location field string value, including null termination
2	unsigned short	num_modes	0	Number of modes in RGBController
4	int	active_mode	0	RGBController active_mode field value
Variable	Mode Data[num_modes]	modes	0	See Mode Data block format table. Repeat num_modes times
2	unsigned short	num_zones	0	Number of zones in RGBController
Variable	Zone Data[num_zones]	zones	0	See Zone Data block format table. Repeat num_zones times
2	unsigned short	num_leds	0	Number of LEDs in RGBController
Variable	LED Data[num_leds]	leds	0	See LED Data block format table. Repeat num_leds times
2	unsigned short	num_colors	0	Number of colors in RGBController
4 * num_colors	RGBColor[num_colors]	colors	0	RGBController colors field values
2	unsigned short	num_led_alt_names	5	Number of LED alternate name strings
Variable	LED Alternate Name[num_led_alt_names]	led_alt_names	5	See LED Alternate Name Data block format table. Repeat num_led_alt_names times
4	unsigned int	flags	5	RGBController flags field value

Mode Data

The Mode Data block represents one entry in the RGBController::modes vector. This data block is provided by RGBController::GetModeDescriptionData(). Portions of this block are omitted if the requested protocol level is below the listed value.

Size	Format	Name	Protocol Version	Description
2	unsigned short	mode_name_len	0	Length of mode name string, including null termination
mode_name_len	char[mode_name_len]	mode_name	0	Mode name string value, including null termination
4	int	mode_value	0	Mode value field value
4	unsigned int	mode_flags	0	Mode flags field value
4	unsigned int	mode_speed_min	0	Mode speed_min field value
4	unsigned int	mode_speed_max	0	Mode speed_max field value
4	unsigned int	mode_brightness_min	3	Mode brightness_min field value
4	unsigned int	mode_brightness_max	3	Mode brightness_max field value
4	unsigned int	mode_colors_min	0	Mode colors_min field value
4	unsigned int	mode_colors_max	0	Mode colors_max field value
4	unsigned int	mode_speed	0	Mode speed value
4	unsigned int	mode_brightness	3	Mode brightness value
4	unsigned int	mode_direction	0	Mode direction value
4	unsigned int	mode_color_mode	0	Mode color_mode value
2	unsigned short	mode_num_colors	0	Mode number of colors
4 * mode_num_colors	RGBColor[mode_num_colors]	mode_colors	0	Mode color values

Zone Data

The Zone Data block represents one entry in the RGBController::zones vector. This data block is provided by RGBController::GetZoneDescriptionData(). Portions of this block are omitted if the requested protocol level is below the listed value.

Size	Format	Name	Protocol Version	Description
2	unsigned short	zone_name_len	0	Length of zone name string, including null termination
zone_name_len	char[zone_name_len]	zone_name	0	Zone name string value, including null termination
4	int	zone_type	0	Zone type value
4	unsigned int	zone_leds_min	0	Zone leds_min value
4	unsigned int	zone_leds_max	0	Zone leds_max value
4	unsigned int	zone_leds_count	0	Zone leds_count value
2	unsigned short	zone_matrix_len	0	Zone matrix map length if matrix_map exists, otherwise 0 if matrix_map NULL
zone_matrix_len	Matrix Map Data	zone_matrix_map	0	See Matrix Map Data block format table, only if matrix_map exists.
2	unsigned short	num_segments	4	Number of segments in zone
Variable	Segment Data[num_segments]	segments	4	See Segment Data block format table. Repeat num_segments times
4	unsigned int	zone_flags	5	Zone flags value
2	unsigned short	zone_num_modes	6	Number of modes in zone
4	int	zone_active_mode	6	zone active_mode field value
Variable	Mode Data[zone_num_modes]	zone_modes	6	See Mode Data block format table. Repeat zone_num_modes times

Segment Data

The Segment Data block represents one entry in the RGBController::zones::segments vector. This data block is provided by RGBController::GetSegmentDescriptionData(). Portions of this block are omitted if the requested protocol level is below the listed value.

Size	Format	Name	Protocol Version	Description
2	unsigned short	segment_name_len	4	Length of segment name string, including null termination
segment_name_len	char[segment_name_len]	segment_name	4	Segment name string value, including null termination
4	int	segment_type	4	Segment type value
4	unsigned int	segment_start_idx	4	Segment start_idx value
4	unsigned int	segment_leds_count	4	Segment leds_count value
2	unsigned short	segment_matrix_len	6	Segment matrix map length if matrix_map exists, otherwise 0 if matrix_map NULL
segment_matrix_len	Matrix Map Data	segment_matrix_map	6	See Matrix Map Data block format table, only if matrix_map exists.

Matrix Map Data

The Matrix Map Data block represents the matrix_map_type type. This data block is provided by RGBController::GetMatrixMapDescriptionData(). Portions of this block are omitted if the requested protocol level is below the listed value.

Size	Format	Name	Protocol Version	Description
4	unsigned int	matrix_map_height	0	Matrix_map height
4	unsigned int	matrix_map_width	0	Matrix_map width
(zone_matrix_len - 8)*	unsigned int[matrix_map_height * matrix_map_width]	matrix_map_data	0	Matrix_map data

LED Data

The LED Data block represents one entry in the RGBController::leds vector. This data block is provided by RGBController::GetLEDDescriptionData(). Portions of this block are omitted if the requested protocol level is below the listed value.

Size	Format	Name	Protocol Version	Description
2	unsigned short	led_name_len	0	Length of LED name string, including null termination
led_name_len	char[led_name_len]	led_name	0	LED name string value, including null termination
4	unsigned int	led_value	0	LED value field value

LED Alternate Name Data

The LED Alternate Name Data block represents one entry in the RGBController::led_alt_names vector. This data block was introduced in protocol version 5.

Size	Format	Name	Protocol Version	Description
2	unsigned short	led_alt_name_len	5	Length of LED alternate name string, including null termination
led_alt_name_len	char[led_alt_name_len]	led_alt_name	5	LED alternate name string value, including null termination

NET_PACKET_ID_REQUEST_PROTOCOL_VERSION

Request [Size: 4]

The client uses this ID to request the server's highest supported protocol version as well as to indicate to the server the client's highest supported protocol version. The request contains a single unsigned int, size 4, containing the client's highest supported protocol version.

Response [Size: 4]

The server responds to this request with a single unsigned int, size 4, containing the server's highest supported protocol version. If the server is using protocol version 0, it will not send a response. If no response is received, assume the server's highest supported protocol version is version 0.

NET_PACKET_ID_SET_CLIENT_NAME

Client Only [Size: Variable]

The client uses this ID to send the client's null-terminated name string to the server. The size of the packet is the size of the string including the null terminator. In C, this is strlen() + 1. There is no response from the server for this packet.

NET_PACKET_ID_SET_SERVER_NAME

Server Only [Size: Variable]

The server uses this ID to send the server's null-terminated name string to the client. The size of the packet is the size of the string including the null terminator. In C, this is strlen() + 1. There is no response from the server for this packet.

NET_PACKET_ID_DEVICE_LIST_UPDATED

Server Only [Size: 0]

The server uses this ID to notify a client that the server's device list has been updated. Upon receiving this packet, clients should synchronize their local device lists with the server by requesting size and controller data again. This packet contains no data.

NET_PACKET_ID_DETECTION_STARTED

Server Only [Size: 0]

The server uses this ID to notifiy a client that the server's detection process has started.

NET_PACKET_ID_DETECTION_PROGRESS_CHANGED

Server Only [Size: Variable]

The server uses this ID to notify a client that the server's detection progress has changed. The format of the block is shown below.

Size	Format	Name	Protocol Version	Description
4	unsigned int	data_size	6	Size of all data in packet
4	unsigned int	detection_percent	6	Detection percent
2	unsigned short	string_length	6	Length of detection string, including null termination
Variable	char[string_length]	detection_string	6	Detection string value, including null termination

NET_PACKET_ID_DETECTION_COMPLETE

Server Only [Size: 0]

The server uses this ID to notify a client that the server's detection process has completed.

NET_PACKET_ID_REQUEST_RESCAN_DEVICES

Client Only [Size: 0]

The client uses this ID to request the server rescan its devices.

NET_PACKET_ID_PROFILEMANAGER_GET_PROFILE_LIST

Request [Size: 0]

The client uses this ID to request the server's profile list. The request contains no data.

Response [Size: Variable]

The server responds to this request with a data block. The format of the block is shown below.

Size	Format	Name	Protocol Version	Description
4	unsigned int	data_size	2	Size of all data in packet
2	unsigned short	num_profiles	2	Number of profiles on server
Variable	Profile Data[num_profiles]	profiles	2	See Profile Data block format table. Repeat num_profiles times

Profile Data

The profile data block represents the information of one profile. This data block was introduced in protocol version 2.

Size	Format	Name	Protocol Version	Description
2	unsigned short	profile_name_len	2	Length of profile name string, including null termination
profile_name_len	char[profile_name_len]	profile_name	2	Profile name string value, including null termination

NET_PACKET_ID_PROFILEMANAGER_SAVE_PROFILE

Client Only [Size: Variable]

The client uses this ID to command the server to save the current configuration to a profile. It passes the name of the profile to save as a null-terminated string. The size of the packet is the size of the string including the null terminator. In C, this is strlen() + 1. There is no response from the server for this packet.

NET_PACKET_ID_PROFILEMANAGER_LOAD_PROFILE

Client Only [Size: Variable]

The client uses this ID to command the server to load the given profile. It passes the name of the profile to load as a null-terminated string. The size of the packet is the size of the string including the null terminator. In C, this is strlen() + 1. There is no response from the server for this packet.

Calling this function will not actually update the controllers. Instead, the controller states will be updated from the profile on the server side. After sending this request, the client should re-request all controller states from the server so that the client controller states match the server states loaded from the profile. After requesting all of the controller data, the client shall call UpdateMode() on all controllers to apply the updated state.

NET_PACKET_ID_PROFILEMANAGER_DELETE_PROFILE

Client Only [Size: Variable]

The client uses this ID to command the server to delete the given profile. It passes the name of the profile to delete as a null-terminated string. The size of the packet is the size of the string including the null terminator. In C, this is strlen() + 1. There is no response from the server for this packet.

NET_PACKET_ID_PROFILEMANAGER_UPLOAD_PROFILE

NET_PACKET_ID_PROFILEMANAGER_DOWNLOAD_PROFILE

NET_PACKET_ID_PROFILEMANAGER_GET_ACTIVE_PROFILE

NET_PACKET_ID_PLUGINMANAGER_GET_PLUGIN_LIST

Request [Size: 0]

The client uses this ID to request the server's plugin list. The request contains no data.

Response [Size: Variable]

The server responds to this request with a data block. The format of the block is shown below.

Size	Format	Name	Protocol Version	Description
4	unsigned int	data_size	4	Size of all data in packet
2	unsigned short	num_plugins	4	Number of plugins on server
Variable	Plugin Data[num_plugins]	plugins	4	See Plugin Data block format table. Repeat num_plugins times

Plugin Data

The plugin data block represents the information of one plugin. This data block was introduced in protocol version 4.

Size	Format	Name	Protocol Version	Description
2	unsigned short	plugin_name_len	4	Length of plugin name string, including null termination
plugin_name_len	char[plugin_name_len]	plugin_name	4	Plugin name string value, including null termination
2	unsigned short	plugin_description_len	4	Length of plugin description string, including null termination
plugin_description_len	char[plugin_description_len]	plugin_description	4	Plugin description string value, including null termination
2	unsigned short	plugin_version_len	4	Length of plugin version string, including null termination
plugin_version_len	char[plugin_version_len]	plugin_version	4	Plugin version string value, including null termination
4	unsigned int	plugin_index	4	Plugin index value
4	unsigned int	plugin_protocol_version	4	Plugin protocol version value

NET_PACKET_ID_PLUGINMANAGER_PLUGIN_SPECIFIC

Request [Size: Variable]

This packet is used to send data to a plugin. The pkt_dev_id field in the header specifies which plugin to send to and corresponds to the plugin_index field in the plugin list. The first 4 bytes of the data is the plugin packet type, the rest of the packet is plugin-specific.

List of plugins that currently support this:

• Effects plugin

Response [Size: Variable]

The response is optionally generated by the plugin. The data in the packet is plugin-specific.

NET_PACKET_ID_SETTINGSMANAGER_GET_SETTINGS

NET_PACKET_ID_SETTINGSMANAGER_SET_SETTINGS

NET_PACKET_ID_SETTINGSMANAGER_SAVE_SETTINGS

NET_PACKET_ID_RGBCONTROLLER_RESIZEZONE

Client Only [Size: 8]

The client uses this ID to call the ResizeZone() function of an RGBController device. The packet data contains a data block. The format of the block is shown below. The pkt_dev_id of this request's header indicates which controller you are calling ResizeZone() on. See the Device IDs section for more information.

Size	Format	Name	Description
4	int	zone_idx	Zone index to resize
4	int	new_size	New size of the zone

NET_PACKET_ID_RGBCONTROLLER_CLEARSEGMENTS

Client Only [Size: 4]

The client uses this ID to call the ClearSegments() function of an RGBController device. The packet contains the index of the zone to clear segments on, type int (size 4). The pkt_dev_id of this request's header indicates which controller you are calling ClearSegments() on. See the Device IDs section for more information.

NET_PACKET_ID_RGBCONTROLLER_ADDSEGMENT

Client Only [Size: Variable]

The client uses this ID to call the AddSegment() function of an RGBController device. The packet contains a data block. The format of the block is shown below. The pkt_dev_id of this request's header indicates which controller you are calling AddSegment() on. See the Device IDs section for more information.

Size	Format	Name	Description
4	unsigned int	data_size	Size of all data in packet
4	unsigned int	zone_idx	Zone index to add segment to
Variable	Segment Data	segment	See Segment Data block format table.

NET_PACKET_ID_RGBCONTROLLER_UPDATELEDS

Client Only [Size: Variable]

The client uses this ID to call the UpdateLEDs() function of an RGBController device. The packet data contains a data block. The format of the block is shown below. The pkt_dev_id of this request's header indicates which controller you are calling UpdateLEDs() on. See the Device IDs section for more information.

Size	Format	Name	Description
4	unsigned int	data_size	Size of all data in packet
2	unsigned short	num_colors	Number of color values in packet
4 * num_colors	RGBColor[num_colors]	led_color	Color values for each LED in device

NET_PACKET_ID_RGBCONTROLLER_UPDATEZONELEDS

Client Only [Size: Variable]

The client uses this ID to call the UpdateZoneLEDs() function of an RGBController device. The packet data contains a data block. The format of the data block is shown below. The pkt_dev_id of this request's header indicates which controller you are calling UpdateZoneLEDs() on. See the Device IDs section for more information.

Size	Format	Name	Description
4	unsigned int	data_size	Size of all data in packet
4	unsigned int	zone_idx	Zone index to update
2	unsigned short	num_colors	Number of color values in packet
4 * num_colors	RGBColor[num_colors]	led_color	Color values for each LED in zone

NET_PACKET_ID_RGBCONTROLLER_UPDATESINGLELED

Client Only [Size: 8]

The client uses this ID to call the UpdateSingleLED() function of an RGBController device. The packet data contains a data block. The format of the data block is shown below. The pkt_dev_id of this request's header indicates which controller you are calling UpdateSingleLED() on. See the Device IDs section for more information.

Size	Format	Name	Description
4	int	led_idx	LED index
4	RGBColor	led_color	LED color

NET_PACKET_ID_RGBCONTROLLER_SETCUSTOMMODE

Client Only [Size: 0]

The client uses this ID to call the SetCustomMode() function of an RGBController device. The packet contains no data. The pkt_dev_id of this request's header indicates which controller you are calling SetCustomMode() on. See the Device IDs section for more information.

NET_PACKET_ID_RGBCONTROLLER_UPDATEMODE

Client Only [Size: Variable]

The client uses this ID to call the UpdateMode() function of an RGBController device. The packet contains a data block. The format of the data block is shown below. The pkt_dev_id of this request's header indicates which controller you are calling UpdateMode() on. See the Device IDs section for more information.

Size	Format	Name	Protocol Version	Description
4	unsigned int	data_size	0	Size of all data in packet
4	int	mode_idx	0	Mode index to update
Variable	Mode Data	mode	0	See Mode Data block format table.

NET_PACKET_ID_RGBCONTROLLER_SAVEMODE

Client Only [Size: Variable]

The client uses this ID to call the SaveMode() function of an RGBController device. The packet contains a data block. The format of the data block is the same as for NET_PACKET_ID_RGBCONTROLLER_UPDATEMODE. The pkt_dev_id of this request's header indicates which controller you are calling SaveMode() on.

NET_PACKET_ID_RGBCONTROLLER_UPDATEZONEMODE

The client uses this ID to call the UpdateZoneMode() function of an RGBController device. The packet contains a data block. The format of the data block is shown below. The pkt_dev_id of this request's header indicates which controller you are calling UpdateZoneMode() on. See the Device IDs section for more information.

NET_PACKET_ID_RGBCONTROLLER_SIGNALUPDATE

The server uses this ID to signal the client that SignalUpdate() was called on an RGBController device. The packet contains a data block. The format of the data block is shown below. The pkt_dev_id of this request's header indicates which controller signalled SignalUpdate(). See the Device IDs section for more information.