Redshift: Difference between revisions

From NixOS Wiki
← Older edit
VisualWikitext
imported>Voidless
Added a section on how to use redshift as a user
Layer-09 (talk | contribs)
78 edits
mNo edit summary
 
(8 intermediate revisions by 6 users not shown)
Line 1: Line 1:
== Prerequisites ==
[http://jonls.dk/redshift/ Redshift] is an open-source software application designed to adjust the color temperature of computer displays based on the time of day. Created by Jon Lund Steffensen, Redshift modifies the color temperature to reduce eye strain and improve sleep patterns. This application aims to provide a more comfortable viewing experience by dynamically changing the display's color temperature to match the user's surrounding light conditions.


You can either manually configure a location or specify a location provider such as geoclue2 with the following options:
It does this by gradually shifting the color temperature of the display from cooler (bluer) tones during the day to warmer (redder) tones at night.


* [https://nixos.org/nixos/options.html#location.provider {{ic|location.provider}}]
Users have the flexibility to customize various settings in Redshift. They can specify custom values for day and night color temperatures, adjust the speed of color transitions, and temporarily disable or manually adjust the color temperature.
* [https://nixos.org/nixos/options.html#location.latitude {{ic|location.latitude}}] (Used by the {{ic|manual}} provider.)
* [https://nixos.org/nixos/options.html#location.longitude {{ic|location.longitude}}] (Used by the {{ic|manual}} provider.)


== Installation ==
== Installation ==
==== Using nix-shell ====
<syntaxhighlight lang="bash" start="3">
nix-shell -p redshift
</syntaxhighlight>


Enable <syntaxhighlight lang="nix" inline>services.redshift</syntaxhighlight>.
==== Using Global Configuration ====
Example snippet of <code>configuration.nix</code>:
<syntaxhighlight lang="text">
<syntaxHighlight lang=nix> ...
environment.systemPackages = [
{ config, pkgs, callPackage, ... }: {
  pkgs.redshift
   ...
];
  # All values except 'enable' are optional.
</syntaxhighlight>After modifying your configuration, apply the changes by running:<syntaxhighlight lang="bash">
   services.redshift = {
sudo nixos-rebuild switch
     enable = true;
</syntaxhighlight>
     brightness = {
 
      # Note the string values below.
==== Using Home Configuration ====
      day = "1";
<syntaxhighlight lang="text">
      night = "1";
home.packages = [
    };
  pkgs.redshift
    temperature = {
];
      day = 5500;
</syntaxhighlight>After updating your configuration, apply the changes by running:<syntaxhighlight lang="bash">
      night = 3700;
home-manager switch
    };
</syntaxhighlight>
 
== Configuration ==
==== Basic ====
<syntaxHighlight lang=nix>
services.redshift = {
   enable = true;
   temperature = {
     day = 5500;
     night = 3700;
  };
};
 
services.geoclue2.enable = true;
location.provider = "geoclue2";
</syntaxHighlight>
 
==== Advanced ====
<syntaxHighlight lang=nix>
services.redshift = {
  enable = true;
 
  # Display temperature settings
  temperature = {
    day = 5700;
    night = 3500;
   };
   };
 
  # Location settings (replace with your coordinates)
  latitude = "27.9880614";
  longitude = "86.92521";
 
  # Schedule settings
  settings = {
    dawn-time = "6:00-7:45";
    dusk-time = "18:35-20:15";
  };
 
  # General settings
  brightness = {
    day = "1";
    night = "0.8";
  };
 
  extraOptions = [
    "-v"
    "-m randr"
  ];
};
};
# Setting the location works either by using a provider
services.geoclue2.enable = true;
location.provider = "geoclue2";
# Or like this, which can also be set in services.redshift
location.latitude = "27.9880614";
location.longitude = "86.92521";
</syntaxHighlight>
</syntaxHighlight>


== Usage ==
== Tips and Tricks ==
If <syntaxhighlight lang="nix" inline>services.redshift.enable</syntaxhighlight> is true, the systemd unit <syntaxhighlight inline>redshift.service</syntaxhighlight> is provided. It can either be started by the user level service manager like this:
==== Location of Options ====
The home manager options are defined in the following [https://nix-community.github.io/home-manager/options.xhtml#opt-services.gammastep.enable Home Manager Options Manual].
 
The global options are listed on [https://mynixos.com/search?q=redshift MyNixOS].  
 
==== Usage ====
<syntaxHighlight lang="shell">
<syntaxHighlight lang="shell">
# If services.redshift.enable is true, the systemd unit redshift.service is provided.
# It can either be started by the user level service manager like this:
systemctl --user start redshift
systemctl --user start redshift
</syntaxHighlight>
 
Or permanantly enabled by creating an empty file at
# Or permanantly enabled by creating the empty file
<syntaxHighlight lang="shell">
~/.config/systemd/user/default.target.wants/redshift.service
~/.config/systemd/user/default.target.wants/redshift.service
# After starting the service, make sure to check its status in the service manager:
systemctl --user status redshift
</syntaxHighlight>
</syntaxHighlight>
== Troubleshooting ==
==== Provider is unable to determine location ====
It may happen that redshift gets stuck at ''"Waiting for initial location to become available..."'' when using the {{Ic|geoclue2}} location provider. This may happen when geoclue is unable to determine your location due to missing information. In that case, you may resort to setting the location manually.
== References ==
* https://github.com/jonls/redshift
* https://nix-community.github.io/home-manager/options.xhtml#opt-services.gammastep.enable
* https://mynixos.com/search?q=redshift
[[Category:Applications]]

Latest revision as of 08:08, 5 July 2024

Redshift is an open-source software application designed to adjust the color temperature of computer displays based on the time of day. Created by Jon Lund Steffensen, Redshift modifies the color temperature to reduce eye strain and improve sleep patterns. This application aims to provide a more comfortable viewing experience by dynamically changing the display's color temperature to match the user's surrounding light conditions.

It does this by gradually shifting the color temperature of the display from cooler (bluer) tones during the day to warmer (redder) tones at night.

Users have the flexibility to customize various settings in Redshift. They can specify custom values for day and night color temperatures, adjust the speed of color transitions, and temporarily disable or manually adjust the color temperature.

Installation

Using nix-shell

nix-shell -p redshift

Using Global Configuration

environment.systemPackages = [
  pkgs.redshift
];

After modifying your configuration, apply the changes by running:

sudo nixos-rebuild switch

Using Home Configuration

home.packages = [ 
  pkgs.redshift 
];

After updating your configuration, apply the changes by running:

home-manager switch

Configuration

Basic

services.redshift = {
  enable = true;
  temperature = {
    day = 5500;
    night = 3700;
  };
};

services.geoclue2.enable = true;
location.provider = "geoclue2";

Advanced

services.redshift = {
  enable = true;
  
  # Display temperature settings
  temperature = {
    day = 5700;
    night = 3500;
  };
  
  # Location settings (replace with your coordinates)
  latitude = "27.9880614";
  longitude = "86.92521";
  
  # Schedule settings
  settings = {
    dawn-time = "6:00-7:45";
    dusk-time = "18:35-20:15";
  };
  
  # General settings
  brightness = {
    day = "1";
    night = "0.8";
  };
  
  extraOptions = [
    "-v"
    "-m randr"
  ];
};

# Setting the location works either by using a provider
services.geoclue2.enable = true;
location.provider = "geoclue2";

# Or like this, which can also be set in services.redshift
location.latitude = "27.9880614";
location.longitude = "86.92521";

Tips and Tricks

Location of Options

The home manager options are defined in the following Home Manager Options Manual.

The global options are listed on MyNixOS.

Usage

# If services.redshift.enable is true, the systemd unit redshift.service is provided. 
# It can either be started by the user level service manager like this:
systemctl --user start redshift

# Or permanantly enabled by creating the empty file
~/.config/systemd/user/default.target.wants/redshift.service

# After starting the service, make sure to check its status in the service manager:
systemctl --user status redshift

Troubleshooting

Provider is unable to determine location

It may happen that redshift gets stuck at "Waiting for initial location to become available..." when using the geoclue2 location provider. This may happen when geoclue is unable to determine your location due to missing information. In that case, you may resort to setting the location manually.

References

Retrieved from "https://wiki.nixos.org/w/index.php?title=Redshift&oldid=13727"