Skip to content

Commit 73ad49e

Browse files
committed
docs: Update README with current architecture and simplified documentation
- Updated mermaid diagram to reflect GUI components and status bar implementation - Removed deprecated CLI tools references - Simplified installation steps by removing CLI build instructions - Revised known issues to reflect current development priorities
1 parent 672a198 commit 73ad49e

File tree

1 file changed

+6
-41
lines changed

1 file changed

+6
-41
lines changed

README.md

Lines changed: 6 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ A comprehensive power monitoring solution for macOS featuring:
1919
```mermaid
2020
graph TD
2121
Suite[Power Management Suite] --> GUI{GUI Application}
22-
Suite --> CLI{CLI Tools}
2322
2423
GUI --> App[appApp.swift]
2524
App --> CV[ContentView.swift]
@@ -32,33 +31,19 @@ graph TD
3231
PFV --> SW["SwiftUI Graphics Pipeline"]
3332
App --> SM[StatusBar Menu]
3433
SM --> POP["Popover Window (NSHostingView)"]
35-
36-
CLI --> PI[power_info]
37-
CLI --> BAT[batt]
38-
BAT --> UDS["Unix Domain Socket"]
39-
BM -.-> BAT
34+
SM --> MM[Menu Items]
4035
4136
classDef swift fill:#F05138,color:white;
4237
classDef objc fill:#4381ff,color:white;
4338
classDef system fill:#666,color:white;
44-
classDef cli fill:#34a853,color:white;
4539
classDef suite fill:#8e44ad,color:white;
4640
4741
class Suite suite
48-
class App,CV,PFV,BM,SW,SM,POP swift
42+
class App,CV,PFV,BM,SW,SM,POP,MM swift
4943
class OC objc
5044
class SMC system
51-
class PI,BAT,CLI,UDS cli
5245
```
5346

54-
### Manual installation steps
55-
1. **GateKeeper Warning Handling**
56-
- **Warning Message**: If you have GateKeeper turned on, you might encounter messages like "batt is can't be opened because it was not downloaded from the App Store" or "batt cannot be opened because the developer cannot be verified". If you don't see this warning, you can skip this step.
57-
- **Solutions**:
58-
- **Recommended**: Go to `System Settings` -> `Privacy & Security` --scroll-down--> `Security` -> `Open Anyway`.
59-
- **Alternative**: Run `sudo spctl --master-disable` to disable GateKeeper entirely.
60-
61-
6247
## Features
6348

6449
### GUI Application
@@ -67,13 +52,6 @@ graph TD
6752
- Adapter power input tracking
6853
- System load/power consumption correlation
6954

70-
### CLI Tools
71-
- `power_info`: Low-level SMC access for power metrics
72-
- `batt`: Advanced battery diagnostics (from [charlie0129/batt](https://github.com/charlie0129/batt))
73-
74-
- `power_info` cli call is replaced by directly invoke in Battery.swift and powerInfo.m
75-
- `batt` cli call is replaced by Unix Domain Socket IPC method via Curl
76-
7755
## Requirements
7856

7957
- macOS 13 Ventura or newer
@@ -90,9 +68,6 @@ cd power-suite
9068
# Build GUI application
9169
xcodebuild -workspace app.xcodeproj/project.xcworkspace -scheme app
9270

93-
# Build CLI tools
94-
cd systemLoad_Claude
95-
make
9671
```
9772

9873
## Usage
@@ -102,25 +77,15 @@ GUI Application:
10277
open app/build/Release/app.app
10378
```
10479

105-
CLI Monitoring:
106-
```bash
107-
# System power stats
108-
./systemLoad_Claude/power_info -c
109-
110-
# Battery health check
111-
./utility/batt health
112-
```
11380

11481
## Known Issues
11582

11683
- **Adapter Voltage Detection**: Current implementation fixes adapter voltage at 20.00V due to missing SMC key in [VirtualSMC documentation](https://github.com/acidanthera/VirtualSMC/blob/master/Docs/SMCKeys.txt). Amperage is calculated using I = P / U. Contributions welcome to identify the correct SMC key.
11784

118-
- **GUI Prototype Limitations**: The current batt GUI (modeled after Aldente Pro) is an early-stage prototype requiring refinement. Specific challenges include:
119-
- Real-time voltage measurement accuracy
120-
- Power adapter data validation
121-
- UI/UX optimization for power management workflows
122-
123-
- **Command+Q not quitting when popover is visible**: When the application is activated via the status bar icon and the popover window is displayed, the standard Command+Q shortcut does not quit the application. This is likely due to the popover being a non-activating panel, preventing the application from becoming the key application to handle the shortcut. An attempt to fix this using a global event monitor was unsuccessful. Further investigation and alternative solutions are needed.
85+
- **UI/UX Optimization**: Ongoing improvements to power management workflows including:
86+
- Enhanced real-time measurement visualization
87+
- Historical data trending
88+
- Customizable power profiles
12489

12590
## Contributing
12691
See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and guidelines.

0 commit comments

Comments
 (0)