Skip to content

Commit 9d851b3

Browse files
committed
Update README.md
1 parent b06cfb6 commit 9d851b3

File tree

1 file changed

+57
-31
lines changed

1 file changed

+57
-31
lines changed

README.md

Lines changed: 57 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ The source code also provides an easy way to write your own **speed controller**
5353
| Floe Riing RGB 240/280/360 | :heavy_check_mark: | :heavy_check_mark: |
5454
| Pacific PR22-D5 Plus | :heavy_check_mark: | :heavy_check_mark: |
5555
| Pacific W4 | :heavy_check_mark: | :heavy_check_mark: |
56-
| Riing Duo 12/14 | :heavy_check_mark: | :x: | same as Riing Trio?
56+
| Riing Duo 12/14 | :heavy_check_mark: | :x: |
5757
| WaterRam RGB | :heavy_check_mark: | :x: |
5858
| Pacific CL360/RL360 | :heavy_check_mark: | :x: |
5959
| Pacific V-GTX/V-RTX | :heavy_check_mark: | :x: |
@@ -77,7 +77,7 @@ The source code also provides an easy way to write your own **speed controller**
7777
* [RippleEffect](https://github.com/MoshiMoshi0/TTController/blob/master/Plugins/Effects/TTController.Plugin.RippleEffect/RippleEffect.cs)
7878
* [WaveEffect](https://github.com/MoshiMoshi0/TTController/blob/master/Plugins/Effects/TTController.Plugin.WaveEffect/WaveEffect.cs)
7979
* [SnakeEffect](https://github.com/MoshiMoshi0/TTController/blob/master/Plugins/Effects/TTController.Plugin.SnakeEffect/SnakeEffect.cs)
80-
* [TemperatureEffect](https://github.com/MoshiMoshi0/TTController/blob/master/Plugins/Effects/TTController.Plugin.TemperatureEffect/TemperatureEffect.cs)
80+
* [SensorEffect](https://github.com/MoshiMoshi0/TTController/blob/master/Plugins/Effects/TTController.Plugin.SensorEffect/SensorEffect.cs)
8181
* [SoundEffect](https://github.com/MoshiMoshi0/TTController/blob/master/Plugins/Effects/TTController.Plugin.SoundEffect/SoundEffect.cs)
8282
* [RawEffect](https://github.com/MoshiMoshi0/TTController/blob/master/Plugins/Effects/TTController.Plugin.RawEffect/RawEffect.cs)
8383

@@ -87,7 +87,13 @@ The source code also provides an easy way to write your own **speed controller**
8787
* [ProcessTrigger](https://github.com/MoshiMoshi0/TTController/blob/master/Plugins/Triggers/TTController.Plugin.ProcessTrigger/ProcessTrigger.cs)
8888
* [PulseTrigger](https://github.com/MoshiMoshi0/TTController/blob/master/Plugins/Triggers/TTController.Plugin.PulseTrigger/PulseTrigger.cs)
8989
* [LogicTrigger](https://github.com/MoshiMoshi0/TTController/blob/master/Plugins/Triggers/TTController.Plugin.LogicTrigger/LogicTrigger.cs)
90-
* [TemperatureTrigger](https://github.com/MoshiMoshi0/TTController/blob/master/Plugins/Triggers/TTController.Plugin.TemperatureTrigger/TemperatureTrigger.cs)
90+
* [SensorTrigger](https://github.com/MoshiMoshi0/TTController/blob/master/Plugins/Triggers/TTController.Plugin.SensorTrigger/SensorTrigger.cs)
91+
92+
### Devices
93+
* [RiingController](https://github.com/MoshiMoshi0/TTController/blob/master/Plugins/Devices/TTController.Plugin.RiingController/RiingControllerDefinition.cs)
94+
* [RiingPlusController](https://github.com/MoshiMoshi0/TTController/blob/master/Plugins/Devices/TTController.Plugin.RiingPlusController/RiingPlusControllerDefinition.cs)
95+
* [RiingTrioController](https://github.com/MoshiMoshi0/TTController/blob/master/Plugins/Devices/TTController.Plugin.RiingTrioController/RiingTrioControllerDefinition.cs)
96+
* [DpsgController](https://github.com/MoshiMoshi0/TTController/blob/master/Plugins/Devices/TTController.Plugin.DpsgController/DpsgControllerDefinition.cs)
9197

9298
# Config
9399

@@ -131,13 +137,14 @@ The source code also provides an easy way to write your own **speed controller**
131137
]
132138
}
133139
],
134-
"PortConfig": [],
135-
"CriticalTemperature": {
136-
"/intelcpu/0/temperature/8": 90
137-
},
138-
"TemperatureTimerInterval": 250,
139-
"DeviceSpeedTimerInterval": 2500,
140-
"DeviceRgbTimerInterval": 32
140+
"SensorConfigs": [
141+
{
142+
"Sensors": ["/intelcpu/0/temperature/8"],
143+
"Config": {
144+
"CriticalValue": 90
145+
}
146+
}
147+
]
141148
}
142149
```
143150

@@ -154,12 +161,12 @@ The source code also provides an easy way to write your own **speed controller**
154161
"List of port configs"
155162
"The values in this list are optional, if PortConfig for a port is not present"
156163
"the default values will be used"
157-
"PortConfig": ["<PortConfig>"],
164+
"PortConfigs": ["<PortConfig>"],
158165

159-
"Sensor -> Critical Temperature map"
160-
"If the temperature of a sensor exceeds critical temperature"
161-
"the speed on all ports is set to 100% ignoring speed controllers"
162-
"CriticalTemperature": {},
166+
"List of sensor configs"
167+
"The values in this list are optional, if SensorConfig for a sesnor is not present"
168+
"the default valuse will be used"
169+
"SensorConfigs": ["<SensorConfig"],
163170

164171
"Miliseconds between temperature updates"
165172
"TemperatureTimerInterval": "<int>",
@@ -175,20 +182,6 @@ The source code also provides an easy way to write your own **speed controller**
175182
}
176183
```
177184

178-
##### Examples:
179-
```json
180-
{
181-
"Profiles": ["..."],
182-
"PortConfig": ["..."],
183-
"CriticalTemperature": {
184-
"/intelcpu/0/temperature/8": 90
185-
},
186-
"TemperatureTimerInterval": 250,
187-
"DeviceSpeedTimerInterval": 2500,
188-
"DeviceRgbTimerInterval": 32
189-
}
190-
```
191-
192185
---
193186

194187
### Profile
@@ -329,6 +322,7 @@ The source code also provides an easy way to write your own **speed controller**
329322

330323
"Effect type, depends on the controller type"
331324
"If not set the rgb effect is not changed"
325+
"See show hardware info option for avaible effect types for each controller"
332326
"EffectType": "<string>",
333327

334328
"List of LedColor that the effect should use."
@@ -388,16 +382,48 @@ The source code also provides an easy way to write your own **speed controller**
388382
##### Examples:
389383
```json
390384
{
391-
"Key": [9802, 8101, 1],
392-
"Value": {
385+
"Ports": [[9802, 8101, 1]],
386+
"Config": {
393387
"Name": "Top Left",
394388
"LedCount": 12,
389+
"LedCountHandling": "Lerp",
395390
"LedRotation": 10,
396391
"LedReverse": true
397392
}
398393
}
399394
```
400395

396+
---
397+
398+
399+
### Sensor Config
400+
```json
401+
{
402+
"List of sensor identifiers that this config applies to"
403+
"Sensors": ["<string>"],
404+
405+
"Sensor config"
406+
"Config": {
407+
"If the value of the sensor exceeds this value"
408+
"all fans will be set to 100% speed"
409+
"CriticalValue": "<float>",
410+
411+
"Sensor value offset"
412+
"Offset": "<float>"
413+
}
414+
}
415+
```
416+
417+
##### Examples:
418+
```json
419+
{
420+
"Sensors": ["/intelcpu/0/temperature/8"],
421+
"Config": {
422+
"CriticalValue": 90
423+
}
424+
}
425+
```
426+
401427
# Credits
402428

403429
Logo based on icon by Freepik from [flaticon](https://flaticon.com)

0 commit comments

Comments
 (0)