https://github.com/peterhellberg/lights

A command line tool for circadian lighting at my desk
https://github.com/peterhellberg/lights

Last synced: 5 months ago
JSON representation

A command line tool for circadian lighting at my desk

• Host: GitHub
• URL: https://github.com/peterhellberg/lights
• Owner: peterhellberg
• License: mit
• Created: 2022-04-28T09:13:07.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2022-11-17T15:18:24.000Z (about 3 years ago)
• Last Synced: 2025-03-04T02:39:15.991Z (12 months ago)
• Language: Go
• Size: 25.4 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 💡💡 `lights`

A command line tool for circadian lighting at my desk.

> Note: This code is meant for my own use, written as a lab day project, do not expect much.

## Circadian Lighting

![Circadian Lighting Diagram](https://www.thelightingpractice.com/wp-content/uploads/2018/08/Sunset-Photo-Academic-Publication-Graphic.jpg)

![Temperature Chart](https://i.imgur.com/NiAdlGj.png)

## Usage

```

lights      # Toggles both of the lights ON or OFF

lights -i   # Show information about the current state

lights -c   # Calculate and set the appropriate circadian lighting values

```

```go

$ lights --help

Usage of lights:

  -af string

    	the address of the Fill Light's HTTP API (default "http://filllight:9123")

  -ak string

    	the address of the Key Light's HTTP API (default "http://keylight:9123")

  -bf value

    	set Fill Light brightness to an absolute (between 0 and 100) or relative (-N or +N) percentage

  -bk value

    	set Key Light brightness to an absolute (between 0 and 100) or relative (-N or +N) percentage

  -c	calculate and set the appropriate circadian lighting values

  -i	display the current status of the lights without changing their state

  -tf value

    	set Fill Light temperature to an absolute (between 2900 and 7000) or relative (-N or +N) degrees

  -tk value

    	set Key Light temperature to an absolute (between 2900 and 7000) or relative (-N or +N) degrees

```

> I have also bound `Ctrl+F11` to toggle the Key Light, and `Ctrl+F12` to toggle the Fill Light.

## Technical details

The heavy lifting is performed by [github.com/mdlayher/keylight](https://github.com/mdlayher/keylight/)



## License (MIT)

Copyright (c) 2022 [Peter Hellberg](https://c7.se)

> Permission is hereby granted, free of charge, to any person obtaining

> a copy of this software and associated documentation files (the

> "Software"), to deal in the Software without restriction, including

> without limitation the rights to use, copy, modify, merge, publish,

> distribute, sublicense, and/or sell copies of the Software, and to

> permit persons to whom the Software is furnished to do so, subject to

> the following conditions:

>

> The above copyright notice and this permission notice shall be

> included in all copies or substantial portions of the Software.

> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE

> LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION

> OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION

> WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.