-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add documentation for Purism Librem and changelogs update
- Loading branch information
Showing
4 changed files
with
174 additions
and
32 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains 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 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 |
|---|---|---|
| @@ -0,0 +1,123 @@ | ||
| --- | ||
| layout: default | ||
| title: Purism Librem | ||
| parent: Device Compatibility | ||
| permalink: /device-compatibility/librem | ||
| --- | ||
| <style> | ||
| .outer-container { | ||
| display: table; | ||
| width: 100%; | ||
| } | ||
| .txt-horizantal-align { | ||
| width: 50%; | ||
| display: table-cell; | ||
| text-align: center; | ||
| } | ||
| </style> | ||
|
|
||
| # Purism Librem | ||
|
|
||
| ## Capability | ||
| * 3 presets: Full Capacity Mode, Balance Mode, and Maximum Life Span mode. | ||
| * Default threshold values of these 3 preset modes are set at 100/95%, 80/75%, and 60/55%. | ||
| * Each preset end threshold value can be customized between 100-80 %, 80-65 %, and 85-50 % respectively. | ||
| * Each preset start threshold value can be customized between is 98-75 %, 83-60 %, and 83-40 % respectively. | ||
| * The difference between end and start threshold cannot be less than 2%. | ||
|
|
||
| ## Dependencies | ||
| Depends on separate kernel module `librem-ec-acpi-dkms`, that need to be installed.<br> | ||
| <https://source.puri.sm/nicole.faerber/librem-ec-acpi-dkms> | ||
|
|
||
| ## Testing charging threshold using command-line | ||
| After installing `librem-ec-acpi-dkms` below sysfs path will be available and charging threshold/mode can be changed. | ||
| Now user will be able to set charging threshold, using commandline and test charging behavior. | ||
| Charging mode can be set by using `echo` command in `terminal`. | ||
| <br> | ||
| <br> | ||
|
|
||
| **For example:**<br>To apply start threshold value of `55`, end threshold value of `60`, command would be. | ||
|
|
||
| Require root privileges | ||
| {: .label .label-yellow .mt-0} | ||
| ```bash | ||
| echo '55' | pkexec tee /sys/class/power_supply/BAT0/charge_control_start_threshold | ||
| echo '60' | pkexec tee /sys/class/power_supply/BAT0/charge_control_end_threshold | ||
| ``` | ||
| <br> | ||
| `sudo` also can be used in place of `pkexec` in the above commands as both `sudo` and `pkexec` can be use to run commands in root mode. To make use of polkit rules, the extension uses `pkexec`. | ||
|
|
||
| The current threshold value can also be read using `cat` command in `terminal`. | ||
| ```bash | ||
| cat /sys/class/power_supply/BAT0/charge_control_start_threshold | ||
| cat /sys/class/power_supply/BAT0/charge_control_end_threshold | ||
| ``` | ||
| <br> | ||
| If charging threshold are applied successfully using above commands, the extension is compatible. | ||
|
|
||
|
|
||
| {: .important-title } | ||
| > Condition for applying threshold | ||
| > | ||
| > * Accepted values for `charge_control_end_threshold` : 1 - 100 | ||
| > * Accepted values for `charge_control_start_threshold` : 0 - 99 | ||
| > * `charge_control_end_threshold` > `charge_control_start_threshold` | ||
| <br> | ||
|
|
||
| {: .note } | ||
| > The sequence of applying threshold in command-line matters, as in whether to set `charge_control_end_threshold` first or the apply `charge_control_end_threshold` first.<br><br> | ||
| > The condition `charge_control_end_threshold > charge_control_start_threshold` must be fulfilled in order for charging threshold to apply. Threshold values will not be accepted if `charge_control_start_threshold` is less than `charge_control_end_threshold`<br> | ||
| > | ||
| >**For example 1: Increase threshold** | ||
| >> Laptops current threshold value is:<br>`charge_control_start_threshold = 75`<br>`charge_control_end_threshold = 80` | ||
| > | ||
| >> User want to apply new threshold value of:<br>`charge_control_start_threshold = 95`<br>`charge_control_end_threshold = 100` | ||
| > | ||
| >>**Incorrect sequence**<br> | ||
| >> ```bash | ||
| echo '95' | pkexec tee /sys/class/power_supply/BAT0/charge_control_start_threshold | ||
| echo '100' | pkexec tee /sys/class/power_supply/BAT0/charge_control_end_threshold | ||
| ``` | ||
| >> Since start_threshold is applied first `charge_control_end_threshold (80)` is less than `charge_control_start_threshold (95)`, so the condition `charge_control_end_threshold > charge_control_start_threshold` is not fulfilled, hence `charge_control_start_threshold` wont be updated. | ||
| > | ||
| >>**Correct sequence**<br> | ||
| >> ```bash | ||
| echo '100' | pkexec tee /sys/class/power_supply/BAT0/charge_control_end_threshold | ||
| echo '95' | pkexec tee /sys/class/power_supply/BAT0/charge_control_start_threshold | ||
| ``` | ||
| >> Since end_threshold is applied first, `charge_control_end_threshold (100)` is greater than `charge_control_start_threshold (75)`, so the condition `charge_control_end_threshold > charge_control_start_threshold` is fulfilled. | ||
| > | ||
| >**For example 2: Decrease threshold** | ||
| >> Laptops current threshold value is:<br>`charge_control_start_threshold = 75`<br>`charge_control_end_threshold = 80` | ||
| > | ||
| >> User want to apply new threshold value of:<br>`charge_control_start_threshold = 55`<br>`charge_control_end_threshold = 60` | ||
| > | ||
| >>**Incorrect sequence**<br> | ||
| >> ```bash | ||
| echo '60' | pkexec tee /sys/class/power_supply/BAT0/charge_control_end_threshold | ||
| echo '55' | pkexec tee /sys/class/power_supply/BAT0/charge_control_start_threshold | ||
| ``` | ||
| >> Since end_threshold is applied first, `charge_control_end_threshold (60)` is less than `charge_control_start_threshold (75)`, hence the condition `charge_control_end_threshold > charge_control_start_threshold` is not fulfilled. So `charge_control_end_threshold` wont be updated. | ||
| > | ||
| >>**Correct sequence**<br> | ||
| >> ```bash | ||
| echo '55' | pkexec tee /sys/class/power_supply/BAT0/charge_control_start_threshold | ||
| echo '60' | pkexec tee /sys/class/power_supply/BAT0/charge_control_end_threshold | ||
| ``` | ||
| >> Since start_threshold is applied first, `charge_control_end_threshold (80)` is greater than `charge_control_start_threshold (55)`, so the condition `charge_control_end_threshold > charge_control_start_threshold` is fulfilled. | ||
| ## Quick Settings | ||
| <br> | ||
| <img src="../assets/images/device-compatibility/librem/quick-settings.png" width="100%"> | ||
| <div class="outer-container"> | ||
| <span class="txt-horizantal-align"><b>Gnome 43 and above</b></span> | ||
| <span class="txt-horizantal-align"><b>Gnome 42</b></span> | ||
| </div> | ||
|
|
||
| ## Extension Preferences | ||
| <br> | ||
| <img src="../assets/images/device-compatibility/librem/settings.png" width="100%"> | ||
| <br> | ||
|
|
||
|
|