Feature: New RGB Animation "Starlight Smooth"

[hbbit-dev]

Description

New RGB Matrix animation compatible with all keyboards. Will link a video below. I made a previous pull request to add starlight, starlight dual hue, starlight dual sat, and at the last minute I changed the name of starlight smooth to "riverflow" because it didn't have the randomness I was looking for, it was essentially just an angled wave.

I've sat down and tried again this past week and was able to get it to what I originally had in mind for starlight smooth. LEDs randomly raise and lower in brightness, speed and color can be controlled by the user. Updates to the docs as well.

Types of Changes

• Core
• Bugfix
• New feature
• Enhancement/optimization
• Keyboard (addition or update)
• Keymap/layout/userspace (addition or update)
• Documentation

Issues Fixed or Closed by This PR

• none

Checklist

• My code follows the code style of this project: C, Python
• I have read the PR Checklist document and have made the appropriate changes.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have read the CONTRIBUTING document.
• I have added tests to cover my changes.
• I have tested the changes and verified that they work and don't break anything (as well as I can manage).

Supporting Media

output.mp4

[hbbit-dev]

@filterpaper thank you for these change suggestions, and for fixing my embarrassing typo in the effect name...I have made those changes and tested the animation, still works as expected.

[KarlK90]

@hbbit-dev Thanks for the new effect, looks nice. The code changes LGTM. There is one remaining suggestion from filterpaper that would be worth including?

[filterpaper]

The RGB and HSV structs can be updated to rgb_t and hsv_t with #24476 merged. The effect_runner_i can also be used to reduce code size:

#ifdef ENABLE_RGB_MATRIX_STARLIGHT_SMOOTH
RGB_MATRIX_EFFECT(STARLIGHT_SMOOTH)
#    ifdef RGB_MATRIX_CUSTOM_EFFECT_IMPLS

static uint16_t time_offsets[RGB_MATRIX_LED_COUNT];

hsv_t STARLIGHT_SMOOTH_maths(hsv_t hsv, uint8_t i, uint8_t time) {
    uint16_t time = scale16by8((g_rgb_timer / 2) + time_offsets[i], rgb_matrix_config.speed / 16);
    hsv.v         = scale8(abs8(sin8(time) - 128) * 2, hsv.v);
    return hsv;
}

bool STARLIGHT_SMOOTH(effect_params_t* params) {
    if (params->init) {
        for (uint8_t i = 0; i < RGB_MATRIX_LED_COUNT; i++) {
            time_offsets[i] = random16_max(65000);
        }
    }

    return effect_runner_i(params, &STARLIGHT_SMOOTH_maths);
}

#    endif // RGB_MATRIX_CUSTOM_EFFECT_IMPLS
#endif     // ENABLE_RGB_MATRIX_STARLIGHT_SMOOTH

Replacing time with hsv.h will make the starlight light multi-coloured.

[drashna]

The RGB and HSV structs can be updated to rgb_t and hsv_t with #24476 merged. The effect_runner_i can also be used to reduce code size:

#ifdef ENABLE_RGB_MATRIX_STARLIGHT_SMOOTH
RGB_MATRIX_EFFECT(STARLIGHT_SMOOTH)
#    ifdef RGB_MATRIX_CUSTOM_EFFECT_IMPLS

static uint16_t time_offsets[RGB_MATRIX_LED_COUNT];

hsv_t STARLIGHT_SMOOTH_maths(hsv_t hsv, uint8_t i, uint8_t time) {
    uint16_t time = scale16by8((g_rgb_timer / 2) + time_offsets[i], rgb_matrix_config.speed / 16);
    hsv.v         = scale8(abs8(sin8(time) - 128) * 2, hsv.v);
    return hsv;
}

bool STARLIGHT_SMOOTH(effect_params_t* params) {
    if (params->init) {
        for (uint8_t i = 0; i < RGB_MATRIX_LED_COUNT; i++) {
            time_offsets[i] = random16_max(65000);
        }
    }

    return effect_runner_i(params, &STARLIGHT_SMOOTH_maths);
}

#    endif // RGB_MATRIX_CUSTOM_EFFECT_IMPLS
#endif     // ENABLE_RGB_MATRIX_STARLIGHT_SMOOTH

Replacing time with hsv.h will make the starlight light multi-coloured.

This code block doesn't work, as time is a parameter, so you can't redefine it. (but setting uint16_t time = , and time in the next line to a different name does appear to work)

[filterpaper]

This code block doesn't work, as time is a parameter, so you can't redefine it. (but setting uint16_t time = , and time in the next line to a different name does appear to work)

Corrected:

#ifdef ENABLE_RGB_MATRIX_STARLIGHT_SMOOTH
RGB_MATRIX_EFFECT(STARLIGHT_SMOOTH)
#    ifdef RGB_MATRIX_CUSTOM_EFFECT_IMPLS

static uint16_t time_offsets[RGB_MATRIX_LED_COUNT];

hsv_t STARLIGHT_SMOOTH_math(hsv_t hsv, uint8_t i, uint8_t time) {
    time  = scale16by8((g_rgb_timer / 2) + time_offsets[i], rgb_matrix_config.speed / 16);
    hsv.v = scale8(abs8(sin8(time) - 128) * 2, hsv.v);
    return hsv;
}

bool STARLIGHT_SMOOTH(effect_params_t* params) {
    if (params->init) {
        for (uint8_t i = 0; i < RGB_MATRIX_LED_COUNT; i++) {
            time_offsets[i] = random16_max(65000);
        }
    }

    return effect_runner_i(params, &STARLIGHT_SMOOTH_math);
}

#    endif // RGB_MATRIX_CUSTOM_EFFECT_IMPLS
#endif     // ENABLE_RGB_MATRIX_STARLIGHT_SMOOTH

The existing PR could be merged and it can be refactored with the above later.

[github-actions]

Thank you for your contribution!
This pull request has been automatically marked as stale because it has not had activity in the last 45 days. It will be closed in 30 days if no further activity occurs. Please feel free to give a status update now, or re-open when it's ready.
For maintainers: Please label with bug, awaiting review, breaking_change, in progress, or on hold to prevent the issue from being re-flagged.

[drashna]

Suggested change

	bool STARLIGHT_SMOOTH(effect_params_t* params) {
	RGB_MATRIX_USE_LIMITS(led_min, led_max);
	static uint16_t time_offsets[RGB_MATRIX_LED_COUNT];

[drashna]

Suggested change

	static uint16_t time_offsets[RGB_MATRIX_LED_COUNT] = {0};
	hsv_t STARLIGHT_SMOOTH_math(hsv_t hsv, uint8_t i, uint8_t time) {
	time = scale16by8((g_rgb_timer / 2) + time_offsets[i], rgb_matrix_config.speed / 16);
	hsv.v = scale8(abs8(sin8(time) - 128) * 2, hsv.v);
	return hsv;
	}
	bool STARTLIGHT_SMOOTH(effect_params_t *params) {

[drashna]

Suggested change

	for (uint8_t i = led_min; i < led_max; i++) {
	RGB_MATRIX_TEST_LED_FLAGS();
	uint16_t time = scale16by8((g_rgb_timer / 2) + time_offsets[i], rgb_matrix_config.speed / 16);
	HSV hsv = rgb_matrix_config.hsv;
	hsv.v = scale8(abs8(sin8(time) - 128) * 2, hsv.v);
	RGB rgb = rgb_matrix_hsv_to_rgb(hsv);
	rgb_matrix_set_color(i, rgb.r, rgb.g, rgb.b);
	}
	return rgb_matrix_check_finished_leds(led_max);
	return effect_runner_i (params, &STARLIGHT_SMOOTH_math);