diff mbox series

[v2,2/4] doc: cmd: temperature: add documentation

Message ID 20220812181550.267485-2-robert.marko@sartura.hr
State Changes Requested
Delegated to: Tom Rini
Headers show
Series [v2,1/4] cmd: add temperature command | expand

Commit Message

Robert Marko Aug. 12, 2022, 6:15 p.m. UTC 
Add documentation for the temperature command.

Signed-off-by: Robert Marko <robert.marko@sartura.hr>
---
 doc/usage/cmd/temperature.rst | 50 +++++++++++++++++++++++++++++++++++
 doc/usage/index.rst           |  1 +
 2 files changed, 51 insertions(+)
 create mode 100644 doc/usage/cmd/temperature.rst

Comments

Simon Glass Aug. 13, 2022, 2:58 p.m. UTC | #1 
On Fri, 12 Aug 2022 at 12:16, Robert Marko <robert.marko@sartura.hr> wrote:
>
> Add documentation for the temperature command.
>
> Signed-off-by: Robert Marko <robert.marko@sartura.hr>
> ---
>  doc/usage/cmd/temperature.rst | 50 +++++++++++++++++++++++++++++++++++
>  doc/usage/index.rst           |  1 +
>  2 files changed, 51 insertions(+)
>  create mode 100644 doc/usage/cmd/temperature.rst

Reviewed-by: Simon Glass <sjg@chromium.org>
diff mbox series

Patch

diff --git a/doc/usage/cmd/temperature.rst b/doc/usage/cmd/temperature.rst
new file mode 100644
index 0000000000..a5144ec50f
--- /dev/null
+++ b/doc/usage/cmd/temperature.rst
@@ -0,0 +1,50 @@ 
+.. SPDX-License-Identifier: GPL-2.0-or-later
+
+temperature command
+===================
+
+Synopsis
+--------
+
+::
+
+    temperature list
+    temperature get [thermal device name]
+
+Description
+-----------
+
+The *temperature* command is used to list thermal sensors and get their
+readings.
+
+The 'temperature list' command diplays the available thermal devices.
+
+The 'temperature get' command is used to get the reading in degrees C from
+the desired device which is selected by passing its device name.
+
+    thermal device name
+        device name of thermal sensor to select
+
+Example
+-------
+
+::
+
+
+    => temperature list
+    | Device                        | Driver                        | Parent
+    | tmon@610508110                | sparx5-temp                   | axi@600000000
+    =>
+    => temperature get tmon@610508110
+    tmon@610508110: 42 C
+
+Configuration
+-------------
+
+The *temperature* command is only available if CONFIG_CMD_TEMPERATURE=y.
+
+Return value
+------------
+
+The return value $? is set to 0 (true) if the command succeeded and to 1 (false)
+otherwise.
diff --git a/doc/usage/index.rst b/doc/usage/index.rst
index 2ba8733b92..b6f307b2bd 100644
--- a/doc/usage/index.rst
+++ b/doc/usage/index.rst
@@ -62,6 +62,7 @@  Shell commands
    cmd/scp03
    cmd/setexpr
    cmd/size
+   cmd/temperature
    cmd/true
    cmd/ums
    cmd/wdt