From b48a99a247cf28ecbf46864f9f41f92c8828d1f7 Mon Sep 17 00:00:00 2001
From: Alexandru Costache <alexandru@balena.io>
Date: Mon, 4 Nov 2024 15:57:44 +0200
Subject: [PATCH] README: Add fan profile and power mode info to docs

This commit adds detailed information for the
new power and cooling configuration options
available for Jetson Orin devices.

Signed-off-by: Alexandru Costache <alexandru@balena.io>
Change-type: patch
---
 README.md | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)

diff --git a/README.md b/README.md
index 7ed226de61..52eea7abcb 100644
--- a/README.md
+++ b/README.md
@@ -315,6 +315,41 @@ The following example contains two custom udev rules that will create `/etc/udev
 }
 ```
 
+#### fan
+
+An object that defines thermal related configuration. Available for Jetson Orin devices running Jetpack 6 or newer, balenaOS v6.1.24 or newer and Supervisor v16.10.0 or newer.
+
+##### fan.profile
+
+(string) A string which will be used to select the desired cooling profile. Supported values are "quiet" and "cool". At runtime, this
+configuration option should be set through the API or from your balenaCloud dashboard.
+
+```json
+"os": {
+ "fan": {
+  "profile":"cool"
+ }
+}
+```
+
+#### power
+
+An object that defines power consumption related configuration. Available for Jetson Orin devices running Jetpack 6 or newer, balenaOS v6.1.24 or newer and Supervisor v16.10.0 or newer.
+
+##### power.mode
+
+(string) A string which will be used to select the desired power mode. Supported values for Jetpack 6 and newer are "low", "mid" and "high", where "low"
+is the lowest power consumption mode while "high" corresponds to MAXN or the highest available power mode for your device type. At runtime, this
+configuration option should be set through the API or from your balenaCloud dashboard, and it will cause a device reboot.
+
+```json
+"os": {
+ "power": {
+  "mode":"high"
+ }
+}
+```
+
 ### installer
 
 An object that configures the behaviour of the balenaOS installer image.