Hammerspoon/hammerspoon

Document shortcomings of hs.brightness

Open

#1641 opened on Jan 3, 2018

View on GitHub
 (13 comments) (0 reactions) (0 assignees)Objective-C (15,415 stars) (688 forks)batch import
docshelp wanted

Description

Not working as I expect, not sure if it's working as intended. But should have a note in API docs to clear up confusion if it's suppose to be this way.

I expected it to be exactly the same as if I was interacting with the brightness keys or manually adjusting the brightness slider in OS X.

What it actually does for me is just set the brightness correctly via hardware it looks like but ends up being 'temporarily'. But OS X isn't informed, and it's own brightness controls kick in and 'fixes' the value I set.

For example, I via OS X key or slider set the brightness very low. Run hs.brightness.set(70), I see it light up, then immediately the display dims back to very low on it's own. When set to 70 for that brief moment the OS X brightness slider never moves.

If that's not the intention for this, then maybe a note in the docs to explain what the purpose of it is? Because right now I can't think of a usefulness for it's current functionality as setting a new brightness value is only temporary.

MacBook Pro 13" retina 2015 OSX 10.13.2 (high sierra) With / without external monitor tested; same result.

Contributor guide

Tech stack
luaobjective c
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Understanding of hs.brightness module
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Add a note in the hs.brightness API documentation explaining that the set function only temporarily adjusts the brightness until macOS overrides it. The relevant files are likely in the documentation directory, such as extensions/brightness/init.lua or a markdown file under docs/. Check the existing documentation for hs.brightness and insert a cautionary note.