Home

Welcome to the TTController documentation!

Note: If you have issues with configuring the service, try asking for help in github discussions.

Important: This documentation might not apply to development builds.

Quick start

Installing the service

Installing the service will make the service auto start with windows, the service starts before the windows login screen and you are not required to log in to start it.

1. Unpack all files to the desired directory.

2. Run TTController.Service.exe.

   Important: If you can’f find the TTController.Service.exe file you propably downloaded the source code. Check the releases tab for all released builds.

   Note: A quick test to see if the service will work properly is to run debug report found in Main Menu -> Debug -> Report menu. It should list all detected controllers, sensors and plugins.

3. Select Manage Service from the menu and select Install option to install the service.

Important: You cannot move the service files once it is installed. You have to uninstall it first, and reinstall after moving to a desired location.

Note: The service will start automatically and will create a default empty config. See Configuring the service section on how to configure it.

Configuring the service

1. If the service is running, stop it using Manage Service menu.
2. Edit config.json file.
3. Start the service using Manage Service menu.

Note: See Service Config as a starting point.

Note: It is recommended to use the Console mode when testing and/or updating the configuration.

Note: You can use Main Menu -> Debug -> Controllers menu to find your port identifiers and Main Menu -> Debug -> Sensors menu to find your sensor identifiers to be used in config.json.

Uninstalling the service

1. Run TTController.Service.exe.
2. Uninstall the service from Manage Service menu.
3. You can now safely move or remove the folder containing service files.

Updating the service

1. If the service is running, stop it using Manage Service menu.
2. Remove all files except config.json.
3. Unpack newest release to the same directory.
4. Start the service using Manage Service menu.

Console mode

1. If the service is running, stop it using Manage Service menu.
2. Select Main Menu -> Run in console option.

In console mode the service will output its logs to the console window with some additional debug information to help diagnose any issues with the service or configuration. Console mode does not require the service to be installed.

How to read the docs

This section contains some tips on the format of this documentation.

Value types

Type	Description
<bool>	true or false value
<byte>	Value from 0 to 255
<float>, <double>	Floating point value, e.g. 1.5
<int>	Integer value, e.g. 42
<string>	Text value, e.g. "Top Fan"
<enum>	Text value with strict allowed values
<Class>	Object value with variables, e.g. { "Name": <string> } Class will be replaced with a specific type name but will always start with a captial letter
[<type>]	List of values with specific type, e.g. [<int>] = [10, 20, 3, 45, 100, ...] [<string>] = ["Top", "Bottom", "Left", "Right", ...]

Device support matrix

Device	Support	Confirmed	Notes
Riing controller
Riing Plus controller
Riing Trio controller
Riing Quad controller
Level20 Desk controller
Dpsg controller			not fully implemented
Riing Plus 12/14/20
Riing Quad 12/14
Riing Trio 12/14
Riing Duo 12/14
Pure Plus 12/14
Floe Riing RGB 240/280/360
Pacific PR22-D5 Plus
Pacific W4
Razer Connect
WaterRam RGB
Pacific CL360/RL360
Pacific V-GTX/V-RTX
Pacific Lumi/Rad/R1/Fitting
Toughpower iRGB PLUS			controller not fully implemented
Pacific W5/W6			temperature sensor unsupported

Menu tree

.
├── Manage Service
│   ├── Start
│   ├── Stop
│   ├── Restart
│   ├── Uninstall
│   ├── Install
│   └── Back
├── Run in console
├── Debug
│   ├── Report
│   ├── Controllers
│   ├── Sensors
│   ├── Plugins
│   └── Back
└── Exit