feat(display.go): Add display brightness settings #17
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,22 @@ | ||
| package kvm | ||
|
|
||
| import ( | ||
| "errors" | ||
| "fmt" | ||
| "log" | ||
| "os" | ||
| "strconv" | ||
| "time" | ||
| ) | ||
|
|
||
| var currentScreen = "ui_Boot_Screen" | ||
| var lastWakeTime = time.Now() | ||
| var backlightState = 0 // 0 - NORMAL, 1 - DIMMED, 2 - OFF | ||
|
|
||
| const ( | ||
| TOUCHSCREEN_DEVICE string = "/dev/input/event1" | ||
| BACKLIGHT_CONTROL_CLASS string = "/sys/class/backlight/backlight/brightness" | ||
| ) | ||
|
|
||
| func switchToScreen(screen string) { | ||
| _, err := CallCtrlAction("lv_scr_load", map[string]interface{}{"obj": screen}) | ||
|
|
@@ -65,6 +75,7 @@ func requestDisplayUpdate() { | |
| return | ||
| } | ||
| go func() { | ||
| wakeDisplay() | ||
| fmt.Println("display updating........................") | ||
| //TODO: only run once regardless how many pending updates | ||
| updateDisplay() | ||
|
|
@@ -83,6 +94,109 @@ func updateStaticContents() { | |
| updateLabelIfChanged("ui_Status_Content_Device_Id_Content_Label", GetDeviceID()) | ||
| } | ||
|
|
||
| // setDisplayBrightness sets /sys/class/backlight/backlight/brightness to alter | ||
| // the backlight brightness of the JetKVM hardware's display. | ||
| func setDisplayBrightness(brightness int) error { | ||
| if brightness > 100 || brightness < 0 { | ||
Nevexo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| return errors.New("brightness value out of bounds, must be between 0 and 100") | ||
| } | ||
|
|
||
| // Check the display backlight class is available | ||
| if _, err := os.Stat(BACKLIGHT_CONTROL_CLASS); errors.Is(err, os.ErrNotExist) { | ||
| return errors.New("brightness value cannot be set, possibly not running on JetKVM hardware.") | ||
| } | ||
|
|
||
| // Set the value | ||
| bs := []byte(strconv.Itoa(brightness)) | ||
| err := os.WriteFile(BACKLIGHT_CONTROL_CLASS, bs, 0644) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| fmt.Printf("display: set brightness to %v", brightness) | ||
Nevexo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| return nil | ||
| } | ||
|
|
||
| // displayTimeoutTick checks the time the display was last woken, and compares that to the | ||
| // config's displayTimeout values to decide whether or not to dim/switch off the display. | ||
| func displayTimeoutTick() { | ||
| tn := time.Now() | ||
| td := tn.Sub(lastWakeTime).Milliseconds() | ||
|
|
||
| // fmt.Printf("display: tick: time since wake: %vms, dim after: %v, off after: %v\n", td, config.DisplayDimAfterMs, config.DisplayOffAfterMs) | ||
Nevexo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| if td > config.DisplayOffAfterMs && config.DisplayOffAfterMs != 0 && (backlightState == 1 || backlightState == 0) { | ||
| // Display fully off | ||
|
|
||
| backlightState = 2 | ||
| err := setDisplayBrightness(0) | ||
| if err != nil { | ||
| fmt.Printf("display: timeout: Failed to switch off backlight: %s\n", err) | ||
| } | ||
|
|
||
| } else if td > config.DisplayDimAfterMs && config.DisplayDimAfterMs != 0 && backlightState == 0 { | ||
| // Display dimming | ||
|
|
||
| // Get 50% of max brightness, rounded up. | ||
| dimBright := config.DisplayMaxBrightness / 2 | ||
| fmt.Printf("display: timeout: target dim brightness: %v\n", dimBright) | ||
|
|
||
| backlightState = 1 | ||
| err := setDisplayBrightness(dimBright) | ||
| if err != nil { | ||
| fmt.Printf("display: timeout: Failed to dim backlight: %s\n", err) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // wakeDisplay sets the display brightness back to config.DisplayMaxBrightness and stores the time the display | ||
| // last woke, ready for displayTimeoutTick to put the display back in the dim/off states. | ||
| func wakeDisplay() { | ||
| if backlightState == 0 { | ||
| return | ||
| } | ||
|
|
||
| if config.DisplayMaxBrightness == 0 { | ||
| config.DisplayMaxBrightness = 100 | ||
| } | ||
|
|
||
| err := setDisplayBrightness(config.DisplayMaxBrightness) | ||
| if err != nil { | ||
| fmt.Printf("display wake failed, %s\n", err) | ||
| } | ||
|
|
||
| lastWakeTime = time.Now() | ||
| backlightState = 0 | ||
| } | ||
|
|
||
| // watchTsEvents monitors the touchscreen for events and simply calls wakeDisplay() to ensure the | ||
| // touchscreen interface still works even with LCD dimming/off. | ||
| // TODO: This is quite a hack, really we should be getting an event from jetkvm_native, or the whole display backlight | ||
| // control should be hoisted up to jetkvm_native. | ||
| func watchTsEvents() { | ||
| // Open touchscreen device | ||
| ts, err := os.OpenFile(TOUCHSCREEN_DEVICE, os.O_RDONLY, 0666) | ||
| if err != nil { | ||
| fmt.Printf("display: failed to open touchscreen device: %s\n", err) | ||
| return | ||
| } | ||
|
|
||
| defer ts.Close() | ||
|
|
||
| // Watch for events | ||
| buf := make([]byte, 24) | ||
| for { | ||
| _, err := ts.Read(buf) | ||
| if err != nil { | ||
| fmt.Printf("display: failed to read from touchscreen device: %s\n", err) | ||
| return | ||
| } | ||
|
|
||
| // Touchscreen event, wake the display | ||
| wakeDisplay() | ||
| } | ||
| } | ||
|
|
||
| func init() { | ||
| go func() { | ||
| waitCtrlClientConnected() | ||
|
|
@@ -91,6 +205,22 @@ func init() { | |
| updateStaticContents() | ||
| displayInited = true | ||
| fmt.Println("display inited") | ||
| wakeDisplay() | ||
| requestDisplayUpdate() | ||
| }() | ||
|
|
||
| go func() { | ||
| // Start display auto-sleeping ticker | ||
| ticker := time.NewTicker(1 * time.Second) | ||
|
||
| defer ticker.Stop() | ||
|
|
||
| for { | ||
| select { | ||
| case <-ticker.C: | ||
| displayTimeoutTick() | ||
| } | ||
| } | ||
| }() | ||
|
|
||
| go watchTsEvents() | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Effective Go and the Go stdlib usually prefers lowerCamelCase/UpperCamelCase (depending on whether exported) for constant names. E.g., per https://go.dev/wiki/CodeReviewComments:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! Updated.