Skip to content

Commit 7c1b988

Browse files
committed
EXAMPLES: Add more
Signed-off-by: Daniel Schaefer <[email protected]>
1 parent 53bbee0 commit 7c1b988

File tree

1 file changed

+57
-3
lines changed

1 file changed

+57
-3
lines changed

EXAMPLES.md

+57-3
Original file line numberDiff line numberDiff line change
@@ -128,21 +128,36 @@ Positions:
128128
## Check temperatures and fan speed
129129

130130
```
131-
> sudo ./target/debug/framework_tool --thermal
131+
> sudo framework_tool --thermal
132132
F75303_Local: 43 C
133133
F75303_CPU: 44 C
134134
F75303_DDR: 39 C
135135
APU: 62 C
136136
Fan Speed: 0 RPM
137137
```
138138

139-
## Check sensors (ALS and G-Sensor)
139+
## Check sensors
140+
141+
### Ambient Light (Framework 13, Framework 16)
140142

141143
```
142-
> sudo ./target/debug/framework_tool --sensors
144+
> sudo framework_tool --sensors
143145
ALS: 76 Lux
144146
```
145147

148+
### Accelerometer (Framework 12)
149+
```
150+
> sudo framework_tool --sensors
151+
ALS: 0 Lux
152+
Accelerometers:
153+
Status Bit: 140 0x8C
154+
Present: true
155+
Busy: true
156+
Lid Angle: 122 Deg
157+
Sensor 1: X: 0.00G Y: 0.84G, Z: 0.52G
158+
Sensor 2: X: -0.03G Y: 0.00G, Z: 1.01G
159+
```
160+
146161
## Set custom fan duty/RPM
147162

148163
```
@@ -296,6 +311,45 @@ Battery Status
296311
> sudo framework_tool --charge-current-limit 2000 80
297312
```
298313

314+
## EC Console
315+
316+
```
317+
# Get recent EC console logs and watch for more
318+
> framework_tool.exe --console follow
319+
[53694.741000 Battery 62% (Display 61.1 %) / 3h:18 to empty]
320+
[53715.010000 Battery 62% (Display 61.0 %) / 3h:21 to empty]
321+
[53734.281200 Battery 62% (Display 60.9 %) / 3h:18 to empty]
322+
[53738.037200 Battery 61% (Display 60.9 %) / 3h:6 to empty]
323+
[53752.301500 Battery 61% (Display 60.8 %) / 3h:15 to empty]
324+
```
325+
326+
## Keyboard backlight
327+
328+
```
329+
# Check current keyboard backlight brightness
330+
> framework_tool.exe --kblight
331+
Keyboard backlight: 5%
332+
333+
# Set keyboard backlight brightness
334+
# Off
335+
> framework_tool.exe --kblight 0
336+
# 20%
337+
> framework_tool.exe --kblight 20
338+
```
339+
340+
## RGB LED (Framework Desktop)
341+
342+
```
343+
# To set three LEDs to red, green, blue
344+
sudo framework_tool --rgbkbd 0 0xFF0000 0x00FF00 0x0000FF
345+
346+
# To clear 8 LEDs
347+
sudo framework_tool --rgbkbd 0 0 0 0 0 0 0 0 0
348+
349+
# Just turn the 3rd LED red
350+
sudo framework_tool --rgbkbd 2 0xFF0000
351+
```
352+
299353
## Stylus (Framework 12)
300354

301355
```

0 commit comments

Comments
 (0)