JSON api output format (#95)

* JSON output format (`--output-format` NATURAL, JSON) * Add normalized output format to service runtime * Add an "all" print option and set it to default. * Add active status print
TamtamHero · Jan 29, 2025 · f7b48eb · f7b48eb
1 parent f492140
commit f7b48eb
Show file tree

Hide file tree

Showing 3 changed files with 227 additions and 45 deletions.
diff --git a/doc/commands.md b/doc/commands.md
@@ -10,9 +10,10 @@ fw-fanctrl [commands and options]
 
 First, the global options
 
-| Option                    | Optional | Choices | Default | Description                                                                    |
-|---------------------------|----------|---------|---------|--------------------------------------------------------------------------------|
-| --socket-controller, --sc | yes      | unix    | unix    | the socket controller to use for communication between the cli and the service |
+| Option                    | Optional | Choices       | Default | Description                                                                    |
+|---------------------------|----------|---------------|---------|--------------------------------------------------------------------------------|
+| --socket-controller, --sc | yes      | unix          | unix    | the socket controller to use for communication between the cli and the service |
+| --output-format           | yes      | NATURAL, JSON | NATURAL | the client socket controller output format                                     |
 
 **run**
 
@@ -57,12 +58,13 @@ resume the service
 
 print the selected information
 
-| Option             | Optional | Choices              | Default | Description            |
-|--------------------|----------|----------------------|---------|------------------------|
-| \<print_selection> | yes      | current, list, speed | current | what should be printed |
+| Option             | Optional | Choices                   | Default | Description            |
+|--------------------|----------|---------------------------|---------|------------------------|
+| \<print_selection> | yes      | all, current, list, speed | all     | what should be printed |
 
 | Choice  | Description                      |
 |---------|----------------------------------|
+| all     | All details                      |
 | current | The current strategy being used  |
 | list    | List available strategies        |
 | speed   | The current fan speed percentage |