# Q60 Firmware Protocol
11/8/2023

Firmware Version: 1.0.2.1

Q60 firmware protocol includes the following functions:
1. Get Q60 Pump Info
2. Get Channel Info
3. Set Q60 Current Cooling Mode
4. Set Pump RPM
5. Set Fan RPM
6. Set Q60 Default Cooling Mode
7. Get Q60 Default Cooling Mode
8. LED Streaming
9. Get Firmware Version

4/15/2024

Firmware Version: 1.0.6.1
- Update Section 2 for FP12 Duo and Trio

---

Q60 has 1x Nexus Link Type-C (Port1) and 1x Nexus Link Type-M (Port2) channels
The Type-M channel is connected to both the 2x pumps and 2x fans by default

## 1. Get Q60 Pump Info
This protocol is used to get pump info and is also used as a **flag** to check if Nexus software is in control
If the software does not call this function within 5 seconds, Q60 cooling and LED control will revert back to the default state (motherboard/temp/firmware mode)

Pump info includes:
* Temperature (in/out)
* Pump RPM
* Raidator Fans (exhaust/intake)
* Current Cooling Mode
* Nexus Link AmpScale Warnings

Serial.Write
| Byte 0 | Byte 1 | Byte 2 | Byte 3 |
| ------ | ------ | ----------------- | ---------------- |
| FF | CC | 0x01 (Get Status) | 0x00 (Pump) |

Serial.Read

| Byte 0 | Byte 1 | Byte 2 | Byte 3 | Byte 4 | Byte 5 | Byte 6 | Byte 7 | Byte 8 | Byte 9 | Byte 10 | Byte 11 | Byte 12 | Byte 13 |
| ------ | ------ | ------------ | ----------- | ---------------- | --------- | ---------- | ---------- | --------- | --------- | --------------- | ------- | ------- | ------- |
| FF | CC | 0x00 | (reserved) | (reserved) | In Liquid Temp_H | In Liquid Temp_L | Out Liquid Temp_H | Out Liquid Temp_L | Pump RPM_H | Pump RPM_L | Fan Exhaust/Intake | Current Cooling Mode | Warnings |

***Byte 3 & 4: Reserved***
Reserved

***Byte 5 & 6 (7 & 8): In/Out Liquid Temp***
1. Using the algorithm below to get the current voltage

vol = 3.3 * ((TH * 100) + TL) / 4096

2. Get the corresponding temperature from the voltage using the following table
[Temperature Chart](https://hackmd.io/@HYTE-ProductTeam/rk3zDI1Mp)

***Byte 9 & 10: Pump RPM***

int RPM = (60 * 1000 / ((Byte 9 * 100 + Byte 10 )/ 10 * 4));

***Byte 11: Fan Exhaust/Intake<font color="#f00">(Determine only on the first power-on)</font>***
Intake: 0x01
Exhaust: 0x02
No-Fans connected: 0x03 (no fans detected on Type-M channel)

***Byte 12: Current Cooling Mode***
The current cooling mode Q60 is running
Software: 0x01
Motherboard: 0x02
Temp Mode: 0x03

***Byte 13: Warning***
0x00: None
0x01: Too many devices connected to a single channel (more than 18) -> Flashing Red (per second)
0x02: Too many devices connected across all channels (more than 34 across 2 ports) -> Constant Red
0x03: Too many LEDs connected on a single channel (more than 249) -> Constant Yellow
0x04: Type-C channel (Port1) current overload -> Flashing Orange (per second)
0x05: Type-M channel (Port2) current overload -> Flashing Orange (per second)

Since this protocol can only return 1 state at a time, we will prioritize the warning as following sequence
03 -> 04 -> 01 -> 02 -> 05
(The detail warning status will return all warning state at the same time, please check here)

Q60 has a total of **15A/12V** and each port can have a maximum of **8A/12V**
Since Q60 has 2 pumps inside the radiator which use 0.4A/12V * 2 = 0.8A/12V, the maximum amperage of the 2 ports is 14.2A/12V
Port1 (Type-C) is designed to connect up to **18 devices**, but if there's current overflow, Nexus Link AmpScale will slow down all connected fans to 2000 RPM
* 10 fans -> 3000 rpm
* \> 10 fans -> 2000 rpm

Light strip current
* LS10 -> 0.2A/12V
* LS30 -> 0.6A/12V
* LN40/60 -> 0.4A/12V
* LN70 -> 0.44A/12V

Fan current
* FP12 Single: 0.7A/12V (3000rpm), 0.2A/12V (2000rpm)
* FP12 Duo: 1.4A/12V (3000rpm), 0.4A/12V (2000rpm)
* FP12 Trio: 2.1A/12V (3000rpm), 0.6A/12V (2000rpm)

Port2 (Type-M) is connected to the **2 fans on the radiator** by default, so we need to maintain the maximum RPM of 3000
If Port2 experiences current overload, it will sequentially disable the extra devices

## 2. Get Channel Info
Q60 can connect to Nexus Link secondary nodes (such as FP12, LS10, LS30)
When the devices are connected, Q60 will know what each device is and will return the corresponding information
Nexus software can use this function to get device info from both Type-C (Port1) and Type-M (Port2) channels

Serial.Write
| Byte 0 | Byte 1 | Byte 2 | Byte 3 |
| ------ | ------ | ----------------- | ---------------- |
| FF | CC | 0x01 (Get Status) | Channel (Port1 or Port2) |

Serial.Read
!*12 bytes is one set for a device (only the very first byte 0 & byte 1 will be FF CC*
Each port can read 19 devices (but the user is only allowed to plug in 18 devices, since we need the 19th one to know if there's more than 18)
This protocol will return 240 bytes (12 more bytes are reserved)

**[FP12 Solo, LS10, LS30, LN4060, LN70]**

| Byte 0 | Byte 1 | Byte 2 | Byte 3 | Byte 4 | Byte 5 | Byte 6 | Byte 7 | Byte 8 | Byte 9 | Byte 10 | Byte 11 |
| ------ | ------ | ----------------- | ---------------- | ------ | ------ | ------ | ------ | ------ | ------ | ------- | ------- |
| FF | CC | Device Count | Device Type | Hardware Version | LED Count | Fan Temp_H | Fan Temp_L | Fan RPM_H | Fan RPM_L | Fan Orientation | Touch |

| Byte 0 + 12n | Byte 1 + 12n | Byte 2 + 12n | Byte 3 + 12n | Byte 4 + 12n | Byte 5 + 12n | Byte 6 + 12n | Byte 7 + 12n | Byte 8 + 12n | Byte 9 + 12n | Byte 10 + 12n | Byte 11 + 12n |
| ------ | ------ | ----------------- | ---------------- | ------ | ------ | ------ | ------ | ------ | ------ | ------- | ------- |
| 00 | 00 | Device Count | Device Type | Hardware Version | LED Count | Fan Temp_H | Fan Temp_L | Fan RPM_H | Fan RPM_L | Fan Orientation | Touch |

***Byte 2: Device Count*** start from 1

***Byte 3: Device Type***
LS10: 0x01
LS30: 0x02
FP12: 0x03
FP12 Duo: 0x04 (v1.0.6.1)
FP12 Trio: 0x05 (v1.0.6.1)
LN4060: 0x06
LN70: 0x07

**[If Device Type 1, 2, 3]**
***Byte 5: LED Count***
LS10: 20 LEDs
LS30: 62 LEDs
LN4060: 40 LEDs (update on 2024/09/20)
LN70: 44 LEDs (update on 2024/09/20)

***Byte 6 & 7: Fan Temp***
1. Using the algorithm below to get the current voltage

vol =3.3 * ((TH* 100) + TL) / 4096

2. Get the corresponding temperature from the voltage using the following table
[Temperature Chart](https://hackmd.io/@HYTE-ProductTeam/SypF_MRekl)

***Byte 8 & 9: Fan RPM***

int RPM = (60 * 1000 / (Byte 8 + (float)Byte 9 / 100)) / 4;

***Byte 10: Fan Orientation***
Facing Back: 0x00
Facing Down: 0x01
Facing Up: 0x02
Facing Front: 0x03

***Byte 11: Touch***
Touch: 0x00
Non-Touch: 0x01 (connect with a cable otherwise no device is detected)

| Byte 0 | Byte 1 | Byte 2 | Byte 3 | Byte 4 | Byte 5 | Byte 6 | Byte 7 | Byte 8 | Byte 9 | Byte 10 | Byte 11 |
| ------ | ------ | ----------------- | ---------------- | ------ | ------ | ------ | ------ | ------ | ------ | ------- | ------- |
| FF | CC | Device Count | Device Type | Hardware Version | LED Count | Fan Temp_H | Fan Temp_L | Fan RPM_H | Fan RPM_L | Fan Orientation | Touch |

---

**[FP12 Duo]**
Since we decided to combine fans as one device, the protocl has been different with FP12 Solo and the light strips(only one device)


| Byte 0 | Byte 1 | Byte 2 | Byte 3 | Byte 4 | Byte 5 | Byte 6 | Byte 7 | Byte 8 | Byte 9 | Byte 10 | Byte 11 |
| ------ | ------ | ----------------- | ---------------- | ------ | ------ | ------ | ------ | ------ | ------ | ------- | ------- |
| FF | CC | Device Count | Device Type | Fan_2 RPM_H | Fan_2 RPM_L | Fan Temp_H | Fan Temp_L | Fan_1 RPM_H | Fan_1 RPM_L | Fan Orientation | Touch |

| Byte 0 + 12n | Byte 1 + 12n | Byte 2 + 12n | Byte 3 + 12n | Byte 4 + 12n | Byte 5 + 12n | Byte 6 + 12n | Byte 7 + 12n | Byte 8 + 12n | Byte 9 + 12n | Byte 10 + 12n | Byte 11 + 12n |
| ------ | ------ | ----------------- | ---------------- | ------ | ------ | ------ | ------ | ------ | ------ | ------- | ------- |
| 00 | 00 | Device Count | Device Type | Fan_2 RPM_H | Fan_2 RPM_L | Fan Temp_H | Fan Temp_L | Fan_1 RPM_H | Fan_1 RPM_L | Fan Orientation | Touch |

***Byte 5 & 6: Fan_2 RPM***

int RPM = (60 * 1000 / (Byte 5 + (float)Byte 6 / 100)) / 4/ 10;

***Byte 6 & 7: Fan Temp***
1. Using the algorithm below to get the current voltage

vol =3.3 * ((TH* 100) + TL) / 4096

2. Get the corresponding temperature from the voltage using the following table
[Temperature Chart](https://hackmd.io/@HYTE-ProductTeam/SypF_MRekl)

***Byte 8 & 9: Fan RPM***

int RPM = (60 * 1000 / (Byte 8 + (float)Byte 9 / 100)) / 4/ 10;

***Byte 10: Fan Orientation***
Facing Back: 0x00
Facing Down: 0x01
Facing Up: 0x02
Facing Front: 0x03

***Byte 11: Touch***
Touch: 0x00
Non-Touch: 0x01 (connect with a cable otherwise no device is detected)

---

**[FP12 Trio]**


| Byte 0 | Byte 1 | Byte 2 | Byte 3 | Byte 4 | Byte 5 | Byte 6 | Byte 7 | Byte 8 | Byte 9 | Byte 10 | Byte 11 |
| ------ | ------ | ----------------- | ---------------- | ------ | ------ | ------ | ------ | ------ | ------ | ------- | ------- |
| FF | CC | Device Count | 0x05 | Fan Orientation + Fan_2 RPM_H | Fan_2 RPM_L | Fan Temp_H | Fan Temp_L | Fan_1 RPM_H | Fan_1 RPM_L | Touch + Fan_3 RPM_H | Fan_3 RPM_L |

| Byte 0 + 12n | Byte 1 + 12n | Byte 2 + 12n | Byte 3 + 12n | Byte 4 + 12n | Byte 5 + 12n | Byte 6 + 12n | Byte 7 + 12n | Byte 8 + 12n | Byte 9 + 12n | Byte 10 + 12n | Byte 11 + 12n |
| ------ | ------ | ----------------- | ---------------- | ------ | ------ | ------ | ------ | ------ | ------ | ------- | ------- |
| 00 | 00 | Device Count | 0x05 | Fan Orientation + Fan_2 RPM_H | Fan_2 RPM_L | Fan Temp_H | Fan Temp_L | Fan_1 RPM_H | Fan_1 RPM_L | Touch + Fan_3 RPM_H | Fan_3 RPM_L |

***Byte 5 & 6: Fan Orientation + Fan_2 RPM***

int Fan Orientation = Byte 5 / 10;
int RPM = (Byte5 % 10) * 1000 + Byte6 * 10;

Facing Back: 0x00
Facing Down: 0x01
Facing Up: 0x02
Facing Front: 0x03

***Byte 6 & 7: Fan Temp***
1. Using the algorithm below to get the current voltage

vol =3.3 * ((TH* 100) + TL) / 4096

2. Get the corresponding temperature from the voltage using the following table
[Temperature Chart](https://hackmd.io/@HYTE-ProductTeam/SypF_MRekl)

***Byte 8 & 9: Fan_1 RPM***

int RPM = (Byte8 % 10) * 1000 + Byte9 * 10;

***Byte 10 & 11: Touch + Fan_3 RPM***

int Touch = Byte10 / 10;
int RPM = (Byte10 % 10) * 1000 + Byte11 * 10;

Touch: 0x00
Non-Touch: 0x01 (connect with a cable otherwise no device is detected)

---

## 3. Set Q60 Current Cooling Mode

Serial.Write
| Byte 0 | Byte 1 | Byte 2 | Byte 3 | Byte 4 | Byte 5 | Byte 6 | Byte 7 | Byte 8 | Byte 9 | Byte 10 | Byte 11 |
| ------ | ------ | ------ | ------ | ------ | ------- | ------- | ------- | ------- | ------- | ------- | ------- |
| FF | CC | 0x02 | 0x00 | MODE | Reserve | Reserve | Reserve | Reserve | Reserve | Reserve |Reserve |

***Byte 4: Mode***
Software: 0x01
Motherboard: 0x02
Temp Mode: 0x03

## 4. Set Pump RPM
! *need to set the Q60 to **software mode** with the command above first to be able to control the pump RPM with this protocol!*

Serial.Write
| Byte 0 | Byte 1 | Byte 2 | Byte 3 | Byte 4 | Byte 5 | Byte 6 | Byte 7 | Byte 8 | Byte 9 | Byte 10 | Byte 11 |
| ------ | ------ | ------ | ------ | ------ | ------------ | -------- | ------------ | ------------ | ------- | ------- | --- |
| FF | CC | 0x02 | 0x00 | 0x00 (pump) | Percentage % | RPM Mode | Target RPM_H | Target RPM_L | Reserve | Reserve |Reserve |

***Byte 6: RPM Mode***
If this byte is set as 0x00, it will use byte 5 as the RPM target percentage. If it is set as 0x01, it will use byte 7 & 8 as the target RPM.
Percentage: 0x00
Target RPM: 0x01

## 5. Set Fan RPM

Serial.Write
| Byte 0 | Byte 1 | Byte 2 | Byte 3 | Byte 4 | Byte 5 | Byte 6 | Byte 7 | Byte 8 | Byte 9 | Byte 10 | Byte 11 | Byte 12 |
| ------ | ------ | ------ | ---------------- | ------------ | ----------- | ---------- | ------------ | ------------ | ------- | ------- | ------- | --- |
| FF | CC | 0x02 | Channel (Port1 or Port2) | Device Count | 0x00 | Percentage % | RPM Mode | Target RPM_H | Target RPM_L | Reserve | Reserve |Reserve |

| Byte 4 + 9n | Byte 5 + 9n | Byte 6 + 9n | Byte 7 + 9n | Byte 8 + 9n | Byte 9 + 9n | Byte 10 + 9n | Byte 11 + 9n | Byte 12 + 9n |
| ------------ | ------ | ------------ | -------- | ------------ | ------------ | ------- | ------- | ------- |
| Device Count | 0x00 | Percentage % | RPM Mode | Target RPM_H | Target RPM_L | Reserve | Reserve | Reserve |

Besides the first 4 bytes, each device is 9 bytes
The complete command will be 18 (devices) * 9 + 4 = 166 bytes

***Byte 4 : Device Count***
Start from 1

***Byte7 : RPM Mode***
Percentage: 0x00
Target RPM: 0x01

## 6. Set Q60 Default Cooling Mode
! *This will be written to the eeprom - please note that the eeprom write endurance is 10000 times*

Serial.Write
| Byte 0 | Byte 1 | Byte 2 | Byte 3 | Byte 4 | Byte 5 | Byte 6 | Byte 7 | Byte 8 | Byte 9 | Byte 10 | Byte 11 | Byte 12 | Byte 13 | Byte 14 | Byte 15 | Byte 16 | Byte 17 |
| ------ | ------ | ------ | ------ | ------------ | ------ | ------ | ------ | ------ | ------ | ------- | ------- | --- | --- | --- | --- | --- | --- |
| FF | CC | 0x03 | 0x00 | Default Mode | Pump1(%) | Pump2(%) | Pump3(%) | Fan1(%) | Fan2(%) | Fan3(%) | Temp1_H | Temp1_L | Temp2_H | Temp2_L | Temp3_H | Temp3_L | SAVE (0x01) |

**Byte 4: Default Mode**
Motherboard: 0x01
Temp Mode: 0x02
! *Even when the default mode is set to motherboard, the rest of the bytes will still change the temp mode curve!*

## 7. Get Q60 Default Cooling Mode
! *This will be written on eeprom - please note that the eeprom write endurance is 10000 times*

Serial.Write
| Byte 0 | Byte 1 | Byte 2 | Byte 3 |
| -------- | -------- | -------- | --- |
| FF | CC | 0x04 | 0x00 |

Serial.Read
| Byte 0 | Byte 1 | Byte 2 | Byte 3 | Byte 4 | Byte 5 | Byte 6 | Byte 7 | Byte 8 | Byte 9 | Byte 10 | Byte 11 | Byte 12 | Byte 13 | Byte 14 | Byte 15 | Byte 16 |
| ------ | ------ | ------ | ------ | ------------ | -------- | -------- | -------- | ------- | ------- | ------- | ------- | ------- | ------- | ------- | ------- | ------- |
| FF | CC | 0x04 | 0x00 | Default Mode | Pump1(%) | Pump2(%) | Pump3(%) | Fan1(%) | Fan2(%) | Fan3(%) | Temp1_H | Temp1_L | Temp2_H | Temp2_L | Temp3_H | Temp3_L |

**Byte 11 & 12 (13 & 14, 15 & 16): Default Mode**
1. Get the corresponding temperature from the voltage using the following table
[Temperature Chart](https://hackmd.io/@HYTE-ProductTeam/rk3zDI1Mp)
2. Calculate Temp_H & Temp_L

For example:
If we want to get 30 degrees
30 degrees = 2.669 voltage
Temp_H = (byte)(int)(2.669 * 10);
Temp_L = (byte)(int)(2.669 * 1000) % 100;

## 8. LED Streaming
Q60 has 4 LED channels (which is not to be confused with the Nexus Link Type-C (Port1) or Type-M (Port2) channels)
We have the default LEDs (HYTE Logo/LCD LEDs) on the same channel
Channel 1 -> Device Port1 (Type-C)
Channel 2 -> Device Port2 (Type-M)
Channel 3: LCD LEDs (42 LEDs)
Channel 4: HYTE Logo (4 LEDs)

! *Once Nexus software starts sending an RGB signal, firmware will automatically stop firmware animations until Nexus software doesn't send the **flag protocol** (Get Pump Info)*

Serial.Write
| Byte 0 | Byte 1 | Byte 2 | Byte 3 | Byte 4 | Byte 5 | Byte 6 |
| ------ | ------ | ------ | ------------- | ------ | ------ | --- |
| FF | EE | 01 | Channel (1~4) | LEDCount_H | LEDCount_L | Reserved |

| Byte 7 | Byte 8 | Byte 9 | ... | Byte | Byte | Byte |
| ------ | ------ | ------ | --- | ---- | ---- | --- |
| G | R | B | ... | G | R | B |

! *Channel 4 needs to send 90 bytes to light up all the LEDs*

---

The HYTE Q60 Protocol is provided under the terms of the GNU General Public License version 2.

## 9. Get Firmware Verion
Serial.Write
| Byte 0 | Byte 1 | Byte 2 |
| ------ | ------ | ------ |
| FF | DD | 02 |

Serial.Read
| Byte 0 | Byte 1 | Byte 2 | Byte 3 | Byte 4 | Byte 5 | Byte 6 | Byte 7 |
| ------ | ------ | ------ | ------ | ------------ | -------- | -------- | -------- |
| FF | DD | 02 | 0x00 | Large Version | Mid Version | Small Version | Hardware Version |

## 10. Get Pump 2 Info
Serial.Write
| Byte 0 | Byte 1 | Byte 2 |
| ------ | ------ | ------ |
| FF | CC | 09 |

Serial.Read
| Byte 0 | Byte 1 | Byte 2 | Byte 3 | Byte 4 | Byte 5 | Byte 6 |
| ------ | ------ | ------ | ------ | ------------ | -------- | -------- |
| FF | CC | 09 | Pump 2 Speed_H | Pump 2 Speed_L | reserved | reserved |

! For Q60, only firmware version after 1.0.7.1 has this function, but all the existing Q60 do not have pump2

## 11. Get Warning Detail
Serial.Write
| Byte 0 | Byte 1 | Byte 2 |
| ------ | ------ | ------ |
| FF | CC | 06 |

Serial.Read
| Byte 0 | Byte 1 | Byte 2 | Byte 3 | Byte 4 | Byte 5 |
| ------ | ------ | ------ | ------ | ------ | ------ |
| FF | CC | 06 | Port 1 (0x00 - 0x0F) | Port 2 | Port 3 |

**[Byte 3 - 5]**: Port 1,2,3 Warning Status (0x00 - 0x0F)

| Byte/Bit | 7 - 4 (Reserved) | 3 (Totoal Device Count 36/54) | 2 (Signal Port Device Count 18) | 1 (Current Overflow) | 0 (Led Count) |
| -------- | ---------------- | ----------------------------- | ------------------------------- | -------------------- | ------------- |
| 0x00 | 0 | 0 | 0 | 0 | 0 |
| 0x01 | 0 | 0 | 0 | 0 | 1 |
| 0x02 | 0 | 0 | 0 | 1 | 0 |
| 0x03 | 0 | 0 | 0 | 1 | 1 |
| 0x04 | 0 | 0 | 1 | 0 | 0 |
| 0x05 | 0 | 0 | 1 | 0 | 1 |
| 0x06 | 0 | 0 | 1 | 1 | 0 |
| 0x07 | 0 | 0 | 1 | 1 | 1 |
| 0x08 | 0 | 1 | 0 | 0 | 0 |
| 0x09 | 0 | 1 | 0 | 0 | 1 |
| 0x0A | 0 | 1 | 0 | 1 | 0 |
| 0x0B | 0 | 1 | 0 | 1 | 1 |
| 0x0C | 0 | 1 | 1 | 0 | 0 |
| 0x0D | 0 | 1 | 1 | 0 | 1 |
| 0x0E | 0 | 1 | 1 | 1 | 0 |
| 0x0F | 0 | 1 | 1 | 1 | 1 |