add driver_rtc parser

2025-12-24 00:31:11 +02:00 · 2022-09-09 16:28:34 -07:00
parent 65d647bc0a
commit 993fcd989b
4 changed files with 305 additions and 0 deletions
--- a/docs/parsers/proc_driver_rtc.md
+++ b/docs/parsers/proc_driver_rtc.md
@@ -0,0 +1,126 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.proc_driver_rtc"></a>
+
+# jc.parsers.proc\_driver\_rtc
+
+jc - JSON Convert `/proc/driver-rtc` file parser
+
+Usage (cli):
+
+    $ cat /proc/driver_rtc | jc --proc
+
+or
+
+    $ jc /proc/driver_rtc
+
+or
+
+    $ cat /proc/driver_rtc | jc --proc-driver-rtc
+
+Usage (module):
+
+    import jc
+    result = jc.parse('proc', proc_driver_rtc_file)
+
+or
+
+    import jc
+    result = jc.parse('proc_driver_rtc', proc_driver_rtc_file)
+
+Schema:
+
+"yes" and "no" values are converted to true/false. Integer conversions are
+attempted. If you do not want this behavior, then use `--raw` (CLI) or
+`raw=True` (module).
+
+    {
+      "rtc_time":                       string,
+      "rtc_date":                       string,
+      "alrm_time":                      string,
+      "alrm_date":                      string,
+      "alarm_IRQ":                      boolean,
+      "alrm_pending":                   boolean,
+      "update IRQ enabled":             boolean,
+      "periodic IRQ enabled":           boolean,
+      "periodic IRQ frequency":         integer,
+      "max user IRQ frequency":         integer,
+      "24hr":                           boolean,
+      "periodic_IRQ":                   boolean,
+      "update_IRQ":                     boolean,
+      "HPET_emulated":                  boolean,
+      "BCD":                            boolean,
+      "DST_enable":                     boolean,
+      "periodic_freq":                  integer,
+      "batt_status":                    string
+    }
+
+Examples:
+
+    $ cat /proc/driver_rtc | jc --proc -p
+    {
+      "rtc_time": "16:09:21",
+      "rtc_date": "2022-09-03",
+      "alrm_time": "00:00:00",
+      "alrm_date": "2022-09-03",
+      "alarm_IRQ": false,
+      "alrm_pending": false,
+      "update IRQ enabled": false,
+      "periodic IRQ enabled": false,
+      "periodic IRQ frequency": 1024,
+      "max user IRQ frequency": 64,
+      "24hr": true,
+      "periodic_IRQ": false,
+      "update_IRQ": false,
+      "HPET_emulated": true,
+      "BCD": true,
+      "DST_enable": false,
+      "periodic_freq": 1024,
+      "batt_status": "okay"
+    }
+
+    $ cat /proc/driver_rtc | jc --proc -p -r
+    {
+      "rtc_time": "16:09:21",
+      "rtc_date": "2022-09-03",
+      "alrm_time": "00:00:00",
+      "alrm_date": "2022-09-03",
+      "alarm_IRQ": "no",
+      "alrm_pending": "no",
+      "update IRQ enabled": "no",
+      "periodic IRQ enabled": "no",
+      "periodic IRQ frequency": "1024",
+      "max user IRQ frequency": "64",
+      "24hr": "yes",
+      "periodic_IRQ": "no",
+      "update_IRQ": "no",
+      "HPET_emulated": "yes",
+      "BCD": "yes",
+      "DST_enable": "no",
+      "periodic_freq": "1024",
+      "batt_status": "okay"
+    }
+
+<a id="jc.parsers.proc_driver_rtc.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> Dict
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    Dictionary. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)