Temperature module, ramp drawstyle uses wrong icon for temperatures near base and warn temperatures #2197

quandangv · 2020-10-07T19:29:41Z

Bug Description

Expected behavior
In the Temperature module documentation, the ramp settings says:

The icon selection will range from base-temperature to warn-temperature,
temperatures above warn-temperature will use the last icon
and temperatures below base-temperature will use ramp-0

This leads the user to think that the last icon is only used for temperatures above warn-temperature, and likewise ramp-0 for temperatures below base-temperature.

Actual behavior

The the last icon is actually used for temperatures slightly below warn-temperature, and ramp-0 for temperatures slightly above base-temperature. This disrupts the style of the module (example).

Reproduction

Using this module and font-awesome:

[module/temp0]
type = internal/temperature
thermal-zone = 0
base-temperature = 40
warn-temperature = 80

format = <ramp><label>
format-warn = <ramp><label-warn>

label = "%temperature-c%"
label-foreground = ${color.temp-shade}
label-background = ${color.bg}
label-padding= 1

label-warn = "%temperature-c%"
label-warn-foreground = ${color.fg-alt}
label-warn-background = ${color.temp-shade}
label-warn-padding = 2
ramp-0 = 
ramp-1 = 
ramp-2 = 
ramp-3 = 
ramp-4 = 
ramp-5 = 
ramp-6 = 
ramp-padding-left = 1
ramp-foreground = ${color.temp-shade}
ramp-background = ${color.bg}
ramp-6-foreground = ${color.fg-alt}
ramp-6-background = ${color.temp-shade}

Which should produce the above output, we can see that the icon in ramp-6 is used for 71C, which is below the warn-temperature of 74C.
This causes the ramp and label nodes to have different styles, making the whole thing ugly.

What I did to fix it

I made the temperature module calculate the variable m_perc as an unbounded-percentage instead of a normal percentage, this will allow temperatures below and above the normal range be reflected in the percentage value.

I wrote a ramp function get_by_percentage_with_border which will use the first and last ramp icons exclusively for percentage values outside the range (0, 100) and used it for the ramp in temperature instead

…n temps

codecov · 2020-10-07T19:35:53Z

Codecov Report

Merging #2197 into master will increase coverage by 3.77%.
The diff coverage is 0.00%.

@@            Coverage Diff             @@
##           master    #2197      +/-   ##
==========================================
+ Coverage    6.94%   10.71%   +3.77%     
==========================================
  Files         153      200      +47     
  Lines       10457    16682    +6225     
==========================================
+ Hits          726     1788    +1062     
- Misses       9731    14894    +5163

Flag	Coverage Δ
#unittests	`10.71% <0.00%> (+3.77%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
include/drawtypes/ramp.hpp	`0.00% <ø> (ø)`
src/drawtypes/ramp.cpp	`0.00% <0.00%> (ø)`
src/modules/temperature.cpp	`0.00% <0.00%> (ø)`
src/components/config_parser.cpp	`45.80% <0.00%> (-2.20%)`	⬇️
src/utils/file.cpp	`31.78% <0.00%> (-2.02%)`	⬇️
include/utils/file.hpp	`71.42% <0.00%> (ø)`
src/ipc.cpp
lib/xpp/include/xpp/generic/resource.hpp	`0.00% <0.00%> (ø)`
lib/xpp/include/xpp/event.hpp	`0.00% <0.00%> (ø)`
...include/gtest/internal/gtest-death-test-internal.h	`8.33% <0.00%> (ø)`
... and 45 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 31096de...c229ab4. Read the comment docs.

quandangv · 2020-10-08T03:39:14Z

The previous commit was commited by mistake, I'm trying to revert it.

I'm sorry for the clumsiness, this is my first time making a pull request.

patrick96

The current behavior was always the intended behavior, namely that ramp-0 to ramp-N are distributed evenly between the base and warn temperatures and anything outside of that range is also represented by either ramp-0 or ramp-N, the documentation was just a bit ambiguous.

But I agree with you that it makes more sense that ramp-0 and ramp-N represent only the edge values (and anything outside the range).

patrick96 · 2020-10-08T16:26:13Z

src/drawtypes/ramp.cpp

  }

+  label_t ramp::get_by_percentage_with_borders(float percentage) {
+    size_t index = percentage * (m_icons.size() - 2) / 100.0f + 1;


For small negative percentages (e.g. -1%), index will be 1 because the float is truncated towards 0. I'd suggest explicitly checking if the percentage >= 100 or <= 0 and returning m_icons.size() -1 and 0 respectively.

quandangv · 2020-10-08T17:25:20Z

Thanks for the insight!
I made the requested change.

patrick96

Looks good now. Thanks :)

Breaking Changes: * The new config parser imposes some restrictions on which characters can be used in section and key names. Users shouldn't be affected by this unless they use one of the following characters in any section or key name: `"'=;#[](){}:.$\%` Please consult [`man 5 polybar`](https://polybar.readthedocs.io/en/latest/man/polybar.5.html) for a full reference of the new config rules. * `internal/temperature`: The first and last ramp element are now only used for `base-temperature` and below and `warn-temperature` and above respectively. This only slightly changes the ranges for which the different ramp levels are responsible for. (#2197) Changelog **Deprecations** * `[settings]`: `throttle-input-for` has been removed. It wasn't a useful option and could cause certain actions (e.g. click commands) to be ignored. (#2117) * All action names used by modules to handle click and scroll events are depercated (#1907). This change mainly affects users of the menu module. Please read the [documentation](https://polybar.readthedocs.io/en/latest/user/actions.html) for instructions on how to migrate. **New Config Options** The `include-directory` key can be used the same as `include-file` and includes all regular files in the given directory. In labels: * `label-NAME-minlen`, `label-NAME-alignment` can be used to pad labels with spaces to the right (alignment set to `left`), left (alignment set to `right`), and both sides (alignment set to `center`). In `internal/backlight`: * `enable-scroll` enables changing the brightness through scrolling. In `internal/github`: * `format-offline` is used when the module cannot connect to the server. * `label-offline` can be used in `format-offline`. * `api-url` can be used to connect to a custom github enterprise instance In `internal/pulseaudio`: * `click-right` and `click-middle` can be used to execute commands when right/middle clicking. * `%decibels%` token can be used in `label-volume` and `label-muted` to show the volume in decibels. **Changes To The Build System** * Allow users to specify python executable when building. (polybar/xpp#27, #2125) * The i3ipcpp submodule no longer rebuilds jsoncpp and just uses whatever version is available. (#2015, polybar/i3ipcpp#9) **Features** * New commandline argument: `-M` / `--list-all-monitors`. Will display all available monitors (even cloned ones). * New log level: `notice`. Used as the default and is used for non-warning messages the user should nevertheless be aware of. (#2027) * config: * New config parser (#1377) * `include-directory` key (#2196), see #1946 * Add error message when an entire section is missing. (#2195) * `-minlen` and `-alignment` properties for labels. (#1546) * Make the `seperator` key in the bar section a label. (#1918) * Better color validation. (#1290) * timer modules: Schedule module updates to be aligned with the update interval. For example, the date module now updates on the minute instead of in the middle of a minute if the interval is set to 60 seconds. (#2123), see #2064 * `custom/menu`: Multiple menu modules per bar (#1907) * `internal/backlight`: Support for changing the brightness through scrolling. This may require additional changes to the system running polybar. (#1957) * `internal/github`: * `format-offline` for when the module cannot connect to the server (#1825), see #1815 * Support for github enterprise instances. (#1841), see #1812 * `internal/network`: Support `Gbit/s` for `%linkspeed%` token. (#2055) * `internal/pulseaudio`: * `click-right` and `click-middle` keys (#1941) * `%decibels%` token (#1894), see #1886 * `internal/xworkspaces`: Proper implementation for `label-occupied`. (#822), see #874, #1444, #1033 **Fixes** * Polybar not executing commands that produce output. (#1680), see #916 * Polybar froze until click commands finished executing (#2248) * Polybar not properly working with mirrored monitors. (#1823), see #1192 and #1794 * Unstable animation framerate (#1683), see #568 * Multiple modules of the same type caused click events not to be delivered to the rigth one (#1907), see #1172 * config: * Seemingly unrelated error messages when BOM character appears in config. (#2166), see #2075 * Fall back to next possible config location if config file doesn't exist (except if `--config` was used). (#2026), see #2016 * iconset: `fuzzy-match` chose first match, even if exact match was available. (#2042), see #2041 * `custom/menu`: Spacing issue (#1656) * `internal/alsa`: Volume didn't go over 100% (#2184), see #2173 * `internal/backlight`: Use amdgpu workaround for all devices starting with `amdgpu_bl`. (#2122) * `internal/battery`: Battery not marked as full if over `full-at` percent. (#2019), see #1622 * `internal/cpu`: More accurate cpu load calculation. (#1955) * `internal/github`: Outdated GitHub API authentication. (#2029), see #2002 * `internal/memory`: Use the correct size prefixes (#2211), see #2023 * `internal/network`: * Wrong up- and downspeed values for non-integer intervals. (#2219) * tun/tap interfaces didn't query their IP addresses. (#1990), see #1986 * Don't crash module if linkspeed cannot be queried. (#1772), see #1211 * `internal/temperature`: * `format-warn` was not used if the temperature was *exactly* `warn-temperature`. (#1897) * `internal/xworkspaces`: * Multi-monitor issue (#1929), see #1764, #1849 * Module sometimes showed too many workspaces (#1984), see #1983 * build: * xpp submodule doesn't work with python 3.9 (polybar/xpp#26) * CMake 3.17+ developer warnings (#2089, polybar/xpp#24, polybar/xpp#25) * gtest compilation failure (#1993), see google/googletest#2678 * Compilation issue in GCC 6. (#1953)

Breaking Changes: * The new config parser imposes some restrictions on which characters can be used in section and key names. Users shouldn't be affected by, this unless they use one of the following characters in any section or key name: `"'=;#[](){}:.$\%` Please consult [`man 5 polybar`](https://polybar.readthedocs.io/en/latest/man/polybar.5.html) for a full reference of the new config rules. * `internal/temperature`: The first and last ramp element are now only used for `base-temperature` and below and `warn-temperature` and above respectively. This only slightly changes the ranges for which the different ramp levels are responsible for. (#2197) Changelog **Deprecations** * `[settings]`: `throttle-input-for` has been removed. It wasn't a useful option and could cause certain actions (e.g. click commands) to be ignored. (#2117) * All action names used by modules to handle click and scroll events are deprecated (#1907). This change mainly affects users of the menu module. Please read the [documentation](https://polybar.readthedocs.io/en/latest/user/actions.html) for instructions on how to migrate. **New Config Options** The `include-directory` key can be used the same as `include-file` and includes all regular files in the given directory. In labels: * `label-NAME-minlen`, `label-NAME-alignment` can be used to pad labels with spaces to the right (alignment set to `left`), left (alignment set to `right`), and both sides (alignment set to `center`). In `internal/backlight`: * `enable-scroll` enables changing the brightness through scrolling. In `internal/github`: * `format-offline` is used when the module cannot connect to the server. * `label-offline` can be used in `format-offline`. * `api-url` can be used to connect to a custom github enterprise instance In `internal/pulseaudio`: * `click-right` and `click-middle` can be used to execute commands when right/middle clicking. * `%decibels%` token can be used in `label-volume` and `label-muted` to show the volume in decibels. **Changes To The Build System** * Allow users to specify python executable when building. (polybar/xpp#27, #2125) * The i3ipcpp submodule no longer rebuilds jsoncpp and just uses whatever version is available. (#2015, polybar/i3ipcpp#9) **Features** * New commandline argument: `-M` / `--list-all-monitors`. Will display all available monitors (even cloned ones). * New log level: `notice`. Used as the default and is used for non-warning messages the user should nevertheless be aware of. (#2027) * config: * New config parser (#1377) * `include-directory` key (#2196), see #1946 * Add error message when an entire section is missing. (#2195) * `-minlen` and `-alignment` properties for labels. (#1546) * Make the `seperator` key in the bar section a label. (#1918) * Better color validation. (#1290) * timer modules: Schedule module updates to be aligned with the update interval. For example, the date module now updates on the minute instead of in the middle of a minute if the interval is set to 60 seconds. (#2123), see #2064 * `custom/menu`: Multiple menu modules per bar (#1907) * `internal/backlight`: Support for changing the brightness through scrolling. This may require additional changes to the system running polybar. (#1957) * `internal/github`: * `format-offline` for when the module cannot connect to the server (#1825), see #1815 * Support for github enterprise instances. (#1841), see #1812 * `internal/network`: Support `Gbit/s` for `%linkspeed%` token. (#2055) * `internal/pulseaudio`: * `click-right` and `click-middle` keys (#1941) * `%decibels%` token (#1894), see #1886 * `internal/xworkspaces`: Proper implementation for `label-occupied`. (#822), see #874, #1444, #1033 **Fixes** * Polybar not executing commands that produce output. (#1680), see #916 * Polybar froze until click commands finished executing (#2248) * Polybar not properly working with mirrored monitors. (#1823), see #1192 and #1794 * Unstable animation framerate (#1683), see #568 * Multiple modules of the same type caused click events not to be delivered to the rigth one (#1907), see #1172 * config: * Seemingly unrelated error messages when BOM character appears in config. (#2166), see #2075 * Fall back to next possible config location if config file doesn't exist (except if `--config` was used). (#2026), see #2016 * iconset: `fuzzy-match` chose first match, even if exact match was available. (#2042), see #2041 * `custom/menu`: Spacing issue (#1656) * `internal/alsa`: Volume didn't go over 100% (#2184), see #2173 * `internal/backlight`: Use amdgpu workaround for all devices starting with `amdgpu_bl`. (#2122) * `internal/battery`: Battery not marked as full if over `full-at` percent. (#2019), see #1622 * `internal/cpu`: More accurate cpu load calculation. (#1955) * `internal/github`: Outdated GitHub API authentication. (#2029), see #2002 * `internal/memory`: Use the correct size prefixes (#2211), see #2023 * `internal/network`: * Wrong up- and downspeed values for non-integer intervals. (#2219) * tun/tap interfaces didn't query their IP addresses. (#1990), see #1986 * Don't crash module if linkspeed cannot be queried. (#1772), see #1211 * `internal/temperature`: * `format-warn` was not used if the temperature was *exactly* `warn-temperature`. (#1897) * `internal/xworkspaces`: * Multi-monitor issue (#1929), see #1764, #1849 * Module sometimes showed too many workspaces (#1984), see #1983 * build: * xpp submodule doesn't work with python 3.9 (polybar/xpp#26) * CMake 3.17+ developer warnings (#2089, polybar/xpp#24, polybar/xpp#25) * gtest compilation failure (#1993), see google/googletest#2678 * Compilation issue in GCC 6. (#1953)

quandangv added 4 commits October 8, 2020 01:56

[Temperature, Ramp] fix wrong icon for temperatures near base and war…

c889ba1

…n temps

[Temperature, Ramp] fix wrong icon for temperatures near base and war…

d51dec0

…n temps

Merge branch 'master' of https://github.com/DRKblade/polybar into master

d6cfc06

Fix minor error

928b798

quandangv marked this pull request as ready for review October 7, 2020 19:35

patrick96 requested changes Oct 8, 2020

View reviewed changes

explicitly check percentage in get_by_percentage_with_borders

2603c8c

Fixed silly error

c229ab4

patrick96 approved these changes Oct 9, 2020

View reviewed changes

patrick96 merged commit 3895ace into polybar:master Oct 9, 2020

patrick96 mentioned this pull request Nov 29, 2020

Release 3.5.0 #2253

Merged

28 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Temperature module, ramp drawstyle uses wrong icon for temperatures near base and warn temperatures #2197

Temperature module, ramp drawstyle uses wrong icon for temperatures near base and warn temperatures #2197

Uh oh!

quandangv commented Oct 7, 2020 •

edited

Loading

Uh oh!

codecov bot commented Oct 7, 2020 •

edited

Loading

Uh oh!

quandangv commented Oct 8, 2020

Uh oh!

patrick96 left a comment

Uh oh!

patrick96 Oct 8, 2020

Uh oh!

quandangv commented Oct 8, 2020

Uh oh!

patrick96 left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Temperature module, ramp drawstyle uses wrong icon for temperatures near base and warn temperatures #2197

Temperature module, ramp drawstyle uses wrong icon for temperatures near base and warn temperatures #2197

Uh oh!

Conversation

quandangv commented Oct 7, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Bug Description

Reproduction

What I did to fix it

Uh oh!

codecov bot commented Oct 7, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

quandangv commented Oct 8, 2020

Uh oh!

patrick96 left a comment

Choose a reason for hiding this comment

Uh oh!

patrick96 Oct 8, 2020

Choose a reason for hiding this comment

Uh oh!

quandangv commented Oct 8, 2020

Uh oh!

patrick96 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

quandangv commented Oct 7, 2020 •

edited

Loading

codecov bot commented Oct 7, 2020 •

edited

Loading