nagisa / msi-rgb Goto Github PK

I have the NCT6795D chip on the board.

It's unclear to me if this application is capable of changing the on-board integrated LEDs or if it only controls the LED header...

Anyway, thanks so much!

Like the title says!
Just followed the instructions (install dependencies, build, execute one of the sample commands) and it worked right away.
Works == Change colors of LED strip connected to the JLED1 connector.

Thanks a lot for working this out and sharing!

I have a Hackintosh, built with MSI Z270 M6, running the latest version of macOS. it would be nice to be able to change the colors of my computer while running macOS. Thanks in advance for all and any responses!

I know this utility doesn't work with the B350 Tomahawk, but does it work with the Z370 Tomahawk? Or does it not work with all Tomahawks? Or does it just not work with AMD-based Tomahawks?

I don't have Windows so I can reverse the app, but I'm available to test patches if ever there's work on supporting the x299 Tomahawk AC

Some easier workflow to debug the function calls:

1. Install Api Monitor http://www.rohitab.com/apimonitor,
2. Install MSI Mystic Light,
3. Start MSI Mystic Light,
4. After starting, stop MSI_MysticLight2_service (Services Manager),
5. Run API Monitor v2 32-bit in Admin mode,
6. In API Monitor terminate LED Keeper.exe process,
7. In API Monitor add External DLLs from MSI Mystic Light directory: LEDControl.dll, MBAPI_x86.dll, SMBUS_Engine.dll,
8. Enable monitoring of all functions for these DLLs,
9. Start a new process: LED Keeper.exe from API Monitor, attach using Remote Thread (Extended),
10. Tinker with MSI Mystic Light and see a method calls executed, like: ControlCorsairProDRAMLED, RenesasLEDControlV3, SMB_ByteWrite,
11. Install .NET Reflector,
12. Open in .NET Reflector the LEDKeeper.exe to see all annotated enums and method calls to LEDControl.dll,
13. Cross-check enums with method calls and SMBUS calls.

It seems to work. I have very nice stream of SMB_ByteWrites.

It seems that MSI Mystic Light supports a majority of RGB-controlled devices (RAMs (G.SKILL, Corsair PRO, etc.), GFX, etc.).

So i followed the instructions and ran it on an MSI Z270 Gaming M7 which has the same super I/O in it (Checked with sensors-detect and also found it on the board hidden under the plastic plate). For some reason i cannot get any other led to light up except 'R', If i just turn on green, blue their will be no leds turning on. When i ran the police effect just the red is turning on. The code just executes without any errors, didn't give me the flag warning, except when i change the base port to 2e from the default 4e

Everything works when i activate them via the gaming app, i get all the colors properly working.
And thanks for the awesome work !

I tried the --print-current option, which seemed to be the obvious use, but got this:

hal_j@home ~ % sudo msi-rgb --print-current
Enter Nuclear Launch Code Now:
error: The following required arguments were not provided:
    <RED>
    <GREEN>
    <BLUE>

USAGE:
    msi-rgb <RED> <GREEN> <BLUE> --base-port <BASEPORT> --blink <BLINK> --print-current --duration <STEPDURATION>

For more information try --help
hal_j@home ~ % msi-rgb -V
msi-rgb 0.1.0

Does msi-rgb work with MSI's "Mystic Lights" or does it only control LED strips which are connected to the RGB header?

the new msi mortar board uses the nct6797D. Can msi-rgb work with this superio?

root@M-7A32:~/Work/msi-rgb# cargo build --release
Updating registry https://github.com/rust-lang/crates.io-index
Compiling strsim v0.6.0
Compiling ansi_term v0.10.2
Compiling libc v0.2.34
Compiling vec_map v0.8.0
Compiling cc v1.0.3
Compiling unicode-width v0.1.4
Compiling cfg-if v0.1.2
Compiling bitflags v1.0.1
Compiling rustc-demangle v0.1.5
error: expected ident, found #
--> /root/.cargo/registry/src/github.com-1ecc6299db9ec823/bitflags-1.0.1/src/lib.rs:423:29
|
423 | #[allow(deprecated)]
| ^
|
::: /root/.cargo/registry/src/github.com-1ecc6299db9ec823/bitflags-1.0.1/src/example_generated.rs
|
4 | bitflags! {
| - in this macro invocation

error: Could not compile bitflags.
Build failed, waiting for other jobs to finish...
error: build failed

Whats wrong ?? i Don know where is the problem ?

Mainboard : MSI Gaming Pro Carbon X370
Super I/O Chip : NUVOTON NCT6795D - M
iḿ Using xubuntu : Linux M-7A32 4.10.0-42-generic #46~16.04.1-Ubuntu SMP Mon Dec 4 15:57:59 UTC 2017 x86_64 x86_64 x86_64 GNU/Linux

root@pc:~/msi-rgb/target/release# ./msi-rgb -x 00 00 00 error: could not set the colour caused by: The sI/O chip identifies as d451, which does not seem to be NCT6795D caused by: --ignore-checkflag, which would skip the check, is not specified (may be dangerous); also try--base-port`

root@pc:sensors-detect
# sensors-detect revision 6284 (2015-05-31 14:00:33 +0200)
# System: Micro-Star International Co., Ltd. MS-7B18 [1.0]
# Board: Micro-Star International Co., Ltd. MAG Z390 TOMAHAWK (MS-7B18)
# Kernel: 4.9.0-8-amd64 x86_64
# Processor: Intel(R) Core(TM) i5-9600K CPU @ 3.70GHz (6/158/12)

Some Super I/O chips contain embedded sensors. We have to write to
standard I/O ports to probe them. This is usually safe.
Do you want to scan for Super I/O sensors? (YES/no):
Probing for Super-I/O at 0x2e/0x2f
Trying family `VIA/Winbond/Nuvoton/Fintek'... Yes
Found unknown chip with ID 0xd451

# superidtool - snipped entries with 0xd451

root@pc:~# superiotool -Vd
superiotool r6637
Probing for ITE Super I/O (init=0x87,0x87) at 0x4e...
Failed. Returned data: id=0xd451, rev=0xf
Probing for Nuvoton Super I/O at 0x4e...
Failed. Returned data: chip_id=0xd451
Probing for Nuvoton Super I/O (sid=0xfc) at 0x4e...
Failed. Returned data: sid=0xff, id=0xd451, rev=0x00

Edits to fix formatting...sorry

This utility works just fine with the Z370 PC PRO. Can you please add it to the list?
Thank you 👍

A couple of days ago I've tried to do it in my computer but i couldn't 'cause i doesn't displays it in my RGB app so I am opening this thread to receive the help necessary so I can commit it. Apart from the meteor effect We could have more cool effects like the shown in the MSI RGB web. So please can someone help me?

It being msi-rgb, feel free to ignore this as out of scope, but Gigabyte has an SDK now...

I need a windows app because I don't like to use MSI gaming app, but i want to control the rgb light.

Thank you.

My board seems to have the required NCT6795D chip.

msi-rgb prints no errors but doesn't affect the lights - they stay the default red.

Which MSI motherboards does this utility work on? Also, does it only work on MSI’s AMD motherboards, or does it also work on their Intel motherboards? Does it only work on MSI’s B-series of motherboards, or does it also work on MSI’s Z-series motherboards?

After many tests, this dont work for MSI X370 Gaming pro Carbon (with Debian). Did you plan to make it work for X370 chipsets ? You'll be my savior x)

Just tested this. Working on this board.

As a side note, and this is preliminary, I've been looking at Mystic Light and it seems NCT6779 chips (and another one I can't recall right now) might be supported as well. There seem to be no discernable differences where it concerns the LEDs, but needs further investigation.

No extensive testing, but it worked 1st try... Blue is dim for some reason, but I'm thinking it's my questionable LED strip.

I just got my new mobo and GPUs, and wanted to try msi-rgb on a freshly installed Debian 9 'Stretch'.

Disclaimer: msi-rgb won't work (for the most part) with this motherboard.

However, I was able to control the RAM slot LED blinking and pulsing effect. I cannot change the color, nor turn it off, I can just make it blink or pulse, with any color value (even 0).
Too bad it's only effecting the RAM slot LED when there are so much more LED's on this mobo 😬

Then I thought myself:

Well, I can print the output of various base ports, so I might as well go through them all and check if I can find a FF FF FF FF 00 00 00 00 00 00 00 00 pattern somewhere, and try to update it!

As it turns out, launching the program on base port 64 crashes. I got disconnected from SSH, but I'm not sure if I accidentally crashed the ethernet controller or something else, this was totally try-and-die technique.

Is there any easy way to explore the motherboard memory banks (I don't know how they're called, but I'm referring to the registers where the LED values are stored) without trying to change their values, and then change them "on the fly" to see what happens?

I'm just being curious right now!
It would be great to make msi-rgb multi-motherboard compatible, maybe with a configuration file or so! The potential is here, I think we just need to be able to identify which banks are safe to update for any given motherboard 😊

I'd be glad to help and provide support for mine if you ever want to implement such a config file!

I'm happy it works on x470 Gaming Pro, i use ryzen 2700x on box fun which has fun led and there is also "ring" led, is there any solution to control that ring too?

Hi there so I was wondering if you would have any idea how to get msi-rgb working on an unRAID server? I'm a noob with this stuff and have not been able to figure this out. I read your article about reverse engineering the motherboard and thought it was really cool. I noticing in my google search that MSI now has a SDK for Mystic Light, not sure if that helps with future development.

https://ca.msi.com/Landing/mystic-light-motherboard#extension

Nice writeup and tool - here's some details and reference to additional tools from r/reverseengineering:

Based on an open source driver for other chips in the family, the port writes listed in the blog set registers 0xf0 = 0 and 0xf1 = 0 on logical device 0x12 via Super I/O. The 0x87 writes are Super I/O entry - it's interesting that sending it once works, since that's what flashrom does for the device it supports. Were lm-sensors and and the nct6775 drivers working around some obscure bug, or replicating vendor driver behavior? (Is Super I/O a standard, or a stack of turtles each backwards-compatible with the one below?)

The nct6775 fan/intrusion switch driver partially supports logical devices 0x0a, 0x0b, and 0xd, and lm-sensors focuses on 0x0b. The coreboot superiotool linked from Wikipedia can likely help in further exploration.

As the title says, I think it would be nice to have a GUI for this. Not a super advanced one, but one that you could just open up and configure easily instead of running a command every time.

You might be able to base it off of the MSI gaming app as it would be pretty easy to make something like that in GTK:

Just posting here to confirm that the Z370m mortar is working fine on my system and is able to change colors as its told to. All the examples included in the readme are working fine too.

@user@pc:~/Github/msi-rgb$ cargo build --release
unable to get packages from source

Caused by:
  failed to parse manifest at `/home/user/.cargo/registry/src/github.com-88ac128001ac3a9a/atty-0.2.2/Cargo.toml`

Caused by:
  could not parse input as TOML
/home/user/.cargo/registry/src/github.com-88ac128001ac3a9a/atty-0.2.2/Cargo.toml:12:9 expected a key but found an empty string
/home/user/.cargo/registry/src/github.com-88ac128001ac3a9a/atty-0.2.2/Cargo.toml:12:9-12:10 expected `.`, but found `'`

could you help?

If disabling the subsystem, should RGB fields be required? It was an easy work around. Just adding it for a future fix.

FLAGS:
-x, --disable disable the RGB subsystem altogether

root@pc:~/msi-rgb/target/release# ./msi-rgb -x
error: The following required arguments were not provided:

USAGE:
msi-rgb --base-port --blink --disable --duration

For more information try --help

First of all: Great work! Thank you for this!

I know that with the MSI tool for Windows a mode setting the color depending on the temperature can be chosen. Would this also be possible using your tool? Or would it be necessary to periodically query the temperature sensor and depending on its value set the color?

The program compiled and installed correctly, and I ran the test code (see below)

sudo ./target/release/msi-rgb FF000000 00FF0000 0000FF00
error: could not set the colour
    caused by: The sI/O chip identifies as d451, which does not seem to be NCT6795D
    caused by: `--ignore-check` flag, which would skip the check, is not specified (may be dangerous); also try `--base-port`

I did not try the 'ignore-check' flag as I didn't want to mess anything up, but I did want to see if there was going to be future support for this motherboard. Thanks

# sensors-detect revision 6284 (2015-05-31 14:00:33 +0200)
# System: Micro-Star International Co., Ltd MS-7C02 [1.0]
# Board: Micro-Star International Co., Ltd B450 TOMAHAWK (MS-7C02)
# Kernel: 4.15.0-42-generic x86_64
# Processor: AMD Ryzen 7 2700 Eight-Core Processor (23/8/2)

Some Super I/O chips contain embedded sensors. We have to write to
standard I/O ports to probe them. This is usually safe.
Do you want to scan for Super I/O sensors? (YES/no): yes
.
Trying family `VIA/Winbond/Nuvoton/Fintek'...               Yes
Found unknown chip with ID 0xd451

I have just try tthis soft on my tomahawk artic h270 and it work perfectly. I am on debian 9.5

REALLY THANKS #

This board has the NCT5532D/NCT6779D superIO chip

I own the MSI B350 PC Mate and the tool seems to be functional.

Hello!

I tried msi-rgb with a MSI B450M Bazooka and it worked! I can set colors, blinks and effects as shown in the examples. I'm using Fedora 29 KDE.

But I can only modify a LED strip that flows from half the board to the bottom, along the left-bottom edge of it. The mobo has four leds on the back, always-on in white and not affected by msi-rgb. MSI shows in its site that the official utility changes those LEDs. Perhaps another port to fiddle with them?

This is the output of --verbose command:

sudo ./msi-rgb --verbose ffffffff 88888888 22222222
Bank 12 (d0...100):
ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff
e0 00 00 00 00 00 00 00 ff ff 11 00 04 20 01 40
ff ff 00 00 ff ff 00 00 ff ff 00 00 00 00 19 e2
Bank 09 (20...40):
d3 52 ff 00 00 00 40 13 00 ff 40 01 11 00 00 11
0f ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff
Bank 0b (60...70):
0a 20 0a 40 00 00 ff ff ff ff ff ff ff ff ff ff
Chip identifier is: d352

Thank you four your utility!

msi-rgb does not work properly on the MSI X470 GAMING PRO CARBON.

The problem looks similar to issue #5. The only working color seems to be red, and I can only control the light under my graphics card. Disabling it (-x), blinking in different speeds (-b 1, -b 2, ...) and pulsing does work (-p).

I cannot control the AMD Wraith Prism Cooler LEDs, or any other RGB LEDs in my computer.

Further Information

• Interesting Registers

$ sudo msi-rgb 0 0 0 --print-current
Bank 12 (d0...100):
ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff
e0 00 00 00 02 00 00 00 ff ff 11 00 04 34 01 40
58 e0 1c 0d 50 4f dc b9 e4 aa 75 eb 00 00 20 02
Bank 09 (20...40):
d3 52 ff 00 00 00 40 03 00 ff 58 01 11 00 00 10
0f ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff
Bank 0b (60...70):
0a 20 0a 40 00 00 ff ff ff ff ff ff ff ff ff ff

• dmidecode output

The default, 4e, only changes this LED:

I can disable it and make it pulse but that's it.

2e gives me this error and using --ignore-check doesn't change any LED:

There is a leak i guess on msi website. There you can download Mystic Light Api sdk:

http://download.msi.com/uti_exe/Mystic_Light_2.zip

Maybe they can replace that link, then i can upload to GDrive. I didn't do that for now bec it's not of course safe to trust 3rd party guy for that (me) but i can only upload header and dll files with documentation pdf for be safe. That support would be awesome.

I want that feature in my Linux machine.
In my old Windows partition I could do that but i don't know how to do it here.

Hello there.

I tried your software in an Ubuntu installation running in my MSI B350 Tomahawk + R7 1700 combo, and couldn't get it to run consistently: first of all, I could only get the LEDS to lit with full FFFFFFFF values and couldn't get any colors other than some of the known 7 colors present in the MSI Gaming App; also the leds sometimes just refused to work, or took a long time to respond to the commands. Your Hue Wheel example didn't work at all... the leds just turned off. ¿May this be related to the red leds present in the motherboard, instead of the white ones of the Mortar Artic that you have? They appear to work with every command. As their config is independent of the 'extended' leds in the header, maybe they use another offset or something?

I'm really interested in this, so if I can help you in any way to test for something or check stuff, please let me know.

PS: I contacted MSI for extra color support for this motherboard, and they said that this was a hardware limitation...

Software doesn't appear to do anything on this board.
I am trying to connect a rgb strip to the JLED1 connector on the motherboard

Not supported. The chip is reported as d451:

 sudo ./target/release/msi-rgb FF000000 00FF0000 0000FF00                                                   10:37:47
error: could not set the colour
    caused by: The sI/O chip identifies as d451, which does not seem to be NCT6795D
    caused by: `--ignore-check` flag, which would skip the check, is not specified (may be dangerous); also try `--base-port`

Another question, am I able to set the color of the RAM and Videocard as well with this tool? (Mystic Light allows this). Thanks for your work!

Color is not changed.  😰

EDIT:

I found the Nuvoton NCT6795D Super IO Sensors

EDIT:

$ sudo ./target/release/msi-rgb 0 0 0 --print-current
Bank 12 (d0...100):
ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff
e0 00 00 00 01 00 00 00 ff ff 11 00 04 34 01 40
00 00 00 00 00 00 00 00 00 00 00 00 00 00 19 e2
Bank 09 (20...40):
d3 52 ff 00 00 00 40 03 00 ff 58 01 11 00 00 13
0f ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff
Bank 0b (60...70):
0a 20 0a 40 00 00 ff ff ff ff ff ff ff ff ff ff

• dmidecode

Hello there,

Can this project (add) support for the aforementioned Asus gaming laptops?
Considering that they have support for Aura Sync, is this feasible?

Hey

I do not get the rgb leds changed in other colors
I have an MSI X99A GAMING PRO CARBON
is there a way to customize this motherboard?

I run mint 18.3 Cinnamon version 3.6.7

Compile from source, when I ran the examples the following was returned:

./msi-rgb 206487a9 206487a9 10325476 -ir -ig -ib -d 5
error: could not set the colour
caused by: The sI/O chip identifies as c911, which does not seem to be NCT6795D
caused by: --ignore-check flag, which would skip the check, is not specified (may be dangerous); also try `--base-port

Changed the base port to 2e as suggested in the help page, the following was returned:
./msi-rgb 206487a9 206487a9 10325476 -ir -ig -ib -d 5 --base-port 2e
error: could not set the colour
caused by: The sI/O chip identifies as ffff, which does not seem to be NCT6795D
caused by: --ignore-check flag, which would skip the check, is not specified (may be dangerous); also try --base-port

Hi. I am new to this so hopefully it is me and not the code. I installed Git, Rust, Cargo, and GCC on my machine and then followed the steps provided from this site. I received a failed to build error and cannot tell if it is my machine or the code. I have no idea what all this means. I am running Solus 3.999 with Budgie.

Failed_To_Buid_MSIRGB.txt

would be nice if you could add this board.

msi-rgb 0 0 0 --print-current
Bank 12 (d0...100):
ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff
e0 00 00 00 00 00 00 00 ff ff 11 00 04 34 01 40
00 00 00 00 ff ff ff ff 00 00 00 00 00 00 19 02
Bank 09 (20...40):
d3 52 ff 00 00 00 40 03 00 ff 58 01 11 00 00 13
0f ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff
Bank 0b (60...70):
0a 20 0a 40 00 00 ff ff ff ff ff ff ff ff ff ff

If you need any specific output to help, feel free to answer her :)

I've been messing around with this for a few days now and I can tell its a powerful tool. Well done to everyone involved. However Its extremely difficult to figure out. I'm good enough with the terminal that I can hold my own but I'd like a more detailed set of instructions. The arguments particularly confuse me. I've worked with color before (a little bit of web stuff) but this seems off. I'd really like a document with a bunch of examples on how to use this.

I'd be happy to write this myself but I'm going to need some help mastering the use of this program to begin with. I understand everyone here is volunteering and we all have other, perhaps more demanding, things to handle.

For now I'm going to keep messing around with this program. Once I feel confident using it I'll write out a doc or something to help new users. In the mean time if anyone more confidant with this wants to help me out go ahead. I just need a little explanation.