ekfsm 1.1.0a15.post1__tar.gz → 1.2.0a7__tar.gz

ekfsm-1.2.0a7/GitVersion.yml

@@ -0,0 +1,4 @@
+workflow: GitFlow/v1
+branches:
+  main:
+    mode: ContinuousDeployment

{ekfsm-1.1.0a15.post1 → ekfsm-1.2.0a7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ekfsm
-Version: 1.1.0a15.post1
+Version: 1.2.0a7
 Summary: The EKF System Management Library (ekfsm) is a sensor monitoring suite for Compact PCI Serial devices.
 Author-email: Klaus Popp <klaus.popp@ci4rail.com>, Jan Jansen <jan@ekf.de>, Felix Päßler <fp@ekf.de>
 Requires-Python: >=3.10

{ekfsm-1.1.0a15.post1 → ekfsm-1.2.0a7}/docs/build/html/_modules/ekfsm/devices/eeprom.html

@@ -1270,6 +1270,23 @@
     <span class="k">def</span><span class="w"> </span><span class="nf">write_customer_area</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Write data to CCU EEPROM customer area.</span>
+
+<span class="sd">        Parameters</span>
+<span class="sd">        ----------</span>
+<span class="sd">        data</span>
+<span class="sd">            The data to write to the customer area of the CCU EEPROM.</span>
+
+<span class="sd">        Raises</span>
+<span class="sd">        ------</span>
+<span class="sd">        ValueError</span>
+<span class="sd">            If the data exceeds the customer area length.</span>
+
+<span class="sd">        Example</span>
+<span class="sd">        -------</span>
+<span class="sd">        &gt;&gt;&gt; eeprom = EKF_CCU_EEPROM()</span>
+<span class="sd">        &gt;&gt;&gt; eeprom.write_customer_area(b&quot;Hello, World!&quot;)</span>
+<span class="sd">        &gt;&gt;&gt; eeprom.customer_area()</span>
+<span class="sd">        b&#39;Hello, World!\x0e\x0f\x10\xff\xff\xff...&#39;</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">data</span><span class="p">)</span> <span class="o">&gt;</span> <span class="bp">self</span><span class="o">.</span><span class="n">_customer_area_length</span><span class="p">:</span>
             <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;Data exceeds customer area length&quot;</span><span class="p">)</span>

{ekfsm-1.1.0a15.post1 → ekfsm-1.2.0a7}/docs/build/html/_modules/ekfsm/devices/ekf_ccu_uc.html

@@ -134,7 +134,10 @@
     <span class="k">def</span><span class="w"> </span><span class="nf">temperature</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">float</span><span class="p">:</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Get the temperature from the CCU thermal/humidity sensor.</span>
-<span class="sd">        The temperature is read once per second.</span>
+
+<span class="sd">        Note</span>
+<span class="sd">        ----</span>
+<span class="sd">        The CCU reads the temperature once per second.</span>
 
 <span class="sd">        Returns</span>
 <span class="sd">        -------</span>
@@ -411,6 +414,13 @@
 <span class="sd">        progress_callback</span>
 <span class="sd">            A callback function that is called with the current progress in bytes.</span>
 
+<span class="sd">        Example</span>
+<span class="sd">        -------</span>
+<span class="sd">        &gt;&gt;&gt; from ekfsm.devices import EkfCcuUc</span>
+<span class="sd">        &gt;&gt;&gt; ccu = EkfCcuUc(&quot;ccu&quot;)</span>
+<span class="sd">        &gt;&gt;&gt; firmware = open(&quot;fw-ccu-1.0.0.bin&quot;, &quot;rb&quot;).read()</span>
+<span class="sd">        &gt;&gt;&gt; # Load firmware with progress callback</span>
+<span class="sd">        &gt;&gt;&gt; ccu.load_firmware(firmware, progress_callback=lambda x: print(f&quot;Progress: {x} bytes&quot;))</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">with</span> <span class="n">Locker</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">+</span> <span class="s2">&quot;-load_firmware&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">lock</span><span class="p">():</span>
             <span class="n">offset</span> <span class="o">=</span> <span class="mi">0</span>
@@ -536,6 +546,8 @@
 <span class="sd">        This would load a parameterset with just one parameter, the default fan speed. All other parameters will</span>
 <span class="sd">        be set to their default values.</span>
 
+<span class="sd">        Important</span>
+<span class="sd">        ---------</span>
 <span class="sd">        In order to apply the parameterset, the CCU must be restarted.</span>
 
 <span class="sd">        Parameters</span>
@@ -543,6 +555,14 @@
 <span class="sd">        _cfg</span>
 <span class="sd">            The parameterset in JSON format.</span>
 
+<span class="sd">        Example</span>
+<span class="sd">        -------</span>
+<span class="sd">        &gt;&gt;&gt; from ekfsm.devices import EkfCcuUc</span>
+<span class="sd">        &gt;&gt;&gt; ccu = EkfCcuUc(&quot;ccu&quot;)</span>
+<span class="sd">        &gt;&gt;&gt; # Load parameterset</span>
+<span class="sd">        &gt;&gt;&gt; ccu.load_parameterset(&#39;{&quot;version&quot;: &quot;1.0.0&quot;, &quot;parameters&quot;: {&quot;fan-defrpm&quot;: &quot;6000&quot;}}&#39;)</span>
+<span class="sd">        &gt;&gt;&gt; # Restart CCU to apply parameterset</span>
+<span class="sd">        &gt;&gt;&gt; ccu.restart()</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">with</span> <span class="n">Locker</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">+</span> <span class="s2">&quot;-parameterset&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">lock</span><span class="p">():</span>
             <span class="n">cfg</span> <span class="o">=</span> <span class="n">_cfg</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s2">&quot;utf-8&quot;</span><span class="p">)</span>

{ekfsm-1.1.0a15.post1 → ekfsm-1.2.0a7}/docs/build/html/_modules/ekfsm/devices/pmbus.html

@@ -171,9 +171,8 @@
 <span class="sd">    &gt;&gt;&gt; PsuStatus.OK in status</span>
 <span class="sd">    True</span>
 <span class="sd">    &gt;&gt;&gt; # Instead, check if status is OK</span>
-<span class="sd">    &gt;&gt;&gt; status = PsuStatus(0x00)</span>
-<span class="sd">    &gt;&gt;&gt; status</span>
-<span class="sd">    &lt;PsuStatus.OK: 0&gt;</span>
+<span class="sd">    &gt;&gt;&gt; status == PsuStatus(0x00)</span>
+<span class="sd">    False</span>
 <span class="sd">    &gt;&gt;&gt; PsuStatus.OUTPUT_OVERCURRENT in status</span>
 <span class="sd">    False</span>
 <span class="sd">    &quot;&quot;&quot;</span>

{ekfsm-1.1.0a15.post1 → ekfsm-1.2.0a7}/docs/build/html/_modules/ekfsm/lock.html

@@ -71,39 +71,44 @@
            <div itemprop="articleBody">
              
   <h1>Source code for ekfsm.lock</h1><div class="highlight"><pre>
-<span></span><span class="kn">import</span><span class="w"> </span><span class="nn">fcntl</span>
+<span></span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">Some devices or device functions don&#39;t allow concurrent access.</span>
+<span class="sd">The locking mechanism is used to ensure that only one process/thread can</span>
+<span class="sd">access the device (function) at a time.</span>
+
+<span class="sd">Locking granularity is defined by the device.</span>
+<span class="sd">It may be at the device level or function level.</span>
+
+<span class="sd">Application can choose to use the locking mechanism or not.</span>
+<span class="sd">By default, the locking mechanism is enabled and uses the default</span>
+<span class="sd">lockfile root directory ``/var/lock/ekfsm``.</span>
+
+<span class="sd">Use :func:`locking_configure` to enable or disable the locking mechanism or to change</span>
+<span class="sd">the lockfile root directory.</span>
+<span class="sd">&quot;&quot;&quot;</span>
+
+<span class="kn">import</span><span class="w"> </span><span class="nn">fcntl</span>
 <span class="kn">import</span><span class="w"> </span><span class="nn">os</span>
 <span class="kn">from</span><span class="w"> </span><span class="nn">pathlib</span><span class="w"> </span><span class="kn">import</span> <span class="n">Path</span>
 <span class="kn">from</span><span class="w"> </span><span class="nn">contextlib</span><span class="w"> </span><span class="kn">import</span> <span class="n">contextmanager</span>
 
-<span class="c1">#</span>
-<span class="c1"># Some devices or device functions don&#39;t allow concurrent access.</span>
-<span class="c1"># The locking mechanism is used to ensure that only one process/thread can</span>
-<span class="c1"># access the device (function) at a time.</span>
-<span class="c1">#</span>
-<span class="c1"># Locking granularity is defined by the device.</span>
-<span class="c1"># It may be at the device level or function level.</span>
-<span class="c1">#</span>
-<span class="c1"># Application can choose to use the locking mechanism or not.</span>
-<span class="c1"># By default, the locking mechanism is enabled and uses the default</span>
-<span class="c1"># lockfile root directory /var/lock/ekfsm.</span>
-<span class="c1">#</span>
-<span class="c1"># Use locking_configure() to enable or disable the locking mechanism or to change</span>
-<span class="c1"># the lockfile root directory.</span>
-
 <span class="n">USE_LOCK</span> <span class="o">=</span> <span class="kc">True</span>
 <span class="n">LOCKFILE_ROOT</span> <span class="o">=</span> <span class="s2">&quot;/var/lock/ekfsm&quot;</span>
 <span class="n">ALL_LOCKERS</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="s2">&quot;Locker&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>  <span class="c1"># List of all locker instances</span>
 
 
 <div class="viewcode-block" id="locking_configure">
-<a class="viewcode-back" href="../../reference/ekfsm.html#ekfsm.locking_configure">[docs]</a>
+<a class="viewcode-back" href="../../reference/ekfsm.html#ekfsm.lock.locking_configure">[docs]</a>
 <span class="k">def</span><span class="w"> </span><span class="nf">locking_configure</span><span class="p">(</span><span class="n">enable</span><span class="p">:</span> <span class="nb">bool</span><span class="p">,</span> <span class="n">lockfile_root</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">LOCKFILE_ROOT</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Configures the locking mechanism.</span>
 
-<span class="sd">    :param enable: Whether to enable or disable locking.</span>
-<span class="sd">    :param lockfile_root: The root directory for lockfiles. (default: /var/lock/ekfsm)</span>
+<span class="sd">    Parameters</span>
+<span class="sd">    ----------</span>
+<span class="sd">    enable</span>
+<span class="sd">        Whether to enable or disable locking.</span>
+<span class="sd">    lockfile_root</span>
+<span class="sd">        The root directory for lockfiles.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="k">global</span> <span class="n">USE_LOCK</span><span class="p">,</span> <span class="n">LOCKFILE_ROOT</span>
     <span class="n">USE_LOCK</span> <span class="o">=</span> <span class="n">enable</span>
@@ -112,7 +117,7 @@
 
 
 <div class="viewcode-block" id="locking_cleanup">
-<a class="viewcode-back" href="../../reference/ekfsm.html#ekfsm.locking_cleanup">[docs]</a>
+<a class="viewcode-back" href="../../reference/ekfsm.html#ekfsm.lock.locking_cleanup">[docs]</a>
 <span class="k">def</span><span class="w"> </span><span class="nf">locking_cleanup</span><span class="p">():</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Cleans up all lockfiles and closes all lock file descriptors.</span>
@@ -123,6 +128,8 @@
 
 
 
+<div class="viewcode-block" id="Locker">
+<a class="viewcode-back" href="../../reference/ekfsm.html#ekfsm.lock.Locker">[docs]</a>
 <span class="k">class</span><span class="w"> </span><span class="nc">Locker</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    A class that implements a locking mechanism using file locks.</span>
@@ -134,9 +141,12 @@
 
 <span class="sd">    Example</span>
 <span class="sd">    -------</span>
-<span class="sd">    with Locker(&quot;mysharedresourcename&quot;).lock():</span>
-<span class="sd">        # Access the shared resource here</span>
-<span class="sd">        pass</span>
+<span class="sd">    .. code-block:: python</span>
+
+<span class="sd">        with Locker(&quot;mysharedresourcename&quot;).lock():</span>
+<span class="sd">            # Access the shared resource here</span>
+<span class="sd">            pass</span>
+
 <span class="sd">    &quot;&quot;&quot;</span>
 
     <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">module</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
@@ -150,7 +160,20 @@
         <span class="nb">open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">lockfile_path</span><span class="p">,</span> <span class="s2">&quot;a&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
         <span class="n">ALL_LOCKERS</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
 
+<div class="viewcode-block" id="Locker.cleanup">
+<a class="viewcode-back" href="../../reference/ekfsm.html#ekfsm.lock.Locker.cleanup">[docs]</a>
     <span class="k">def</span><span class="w"> </span><span class="nf">cleanup</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Cleans up the lock file and closes the lock file descriptor.</span>
+
+<span class="sd">        Important</span>
+<span class="sd">        ---------</span>
+<span class="sd">        This method should be called when the lock is no longer needed.</span>
+
+<span class="sd">        Note</span>
+<span class="sd">        ----</span>
+<span class="sd">        It is automatically called when the context manager exits.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">if</span> <span class="ow">not</span> <span class="n">USE_LOCK</span><span class="p">:</span>
             <span class="k">return</span>
         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">lock_fd</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
@@ -159,10 +182,21 @@
                 <span class="n">os</span><span class="o">.</span><span class="n">close</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">lock_fd</span><span class="p">)</span>
                 <span class="bp">self</span><span class="o">.</span><span class="n">lock_fd</span> <span class="o">=</span> <span class="kc">None</span>
             <span class="k">except</span> <span class="p">(</span><span class="ne">OSError</span><span class="p">,</span> <span class="ne">AttributeError</span><span class="p">):</span>
-                <span class="k">pass</span>
+                <span class="k">pass</span></div>
 
+
+<div class="viewcode-block" id="Locker.lock">
+<a class="viewcode-back" href="../../reference/ekfsm.html#ekfsm.lock.Locker.lock">[docs]</a>
     <span class="nd">@contextmanager</span>
     <span class="k">def</span><span class="w"> </span><span class="nf">lock</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Locks the resource for exclusive access.</span>
+
+<span class="sd">        Note</span>
+<span class="sd">        ----</span>
+<span class="sd">        This method is a context manager that locks the resource when entered</span>
+<span class="sd">        and releases the lock when exited.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">if</span> <span class="ow">not</span> <span class="n">USE_LOCK</span><span class="p">:</span>
             <span class="k">yield</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">lock_fd</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">lockfile_path</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">O_RDWR</span><span class="p">)</span>
@@ -170,7 +204,9 @@
             <span class="n">fcntl</span><span class="o">.</span><span class="n">flock</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">lock_fd</span><span class="p">,</span> <span class="n">fcntl</span><span class="o">.</span><span class="n">LOCK_EX</span><span class="p">)</span>
             <span class="k">yield</span>
         <span class="k">finally</span><span class="p">:</span>
-            <span class="bp">self</span><span class="o">.</span><span class="n">cleanup</span><span class="p">()</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">cleanup</span><span class="p">()</span></div>
+</div>
+
 </pre></div>
 
            </div>

{ekfsm-1.1.0a15.post1 → ekfsm-1.2.0a7}/docs/build/html/_modules/ekfsm/system.html

@@ -71,13 +71,15 @@
            <div itemprop="articleBody">
              
   <h1>Source code for ekfsm.system</h1><div class="highlight"><pre>
-<span></span><span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">Tuple</span><span class="p">,</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Generator</span>
+<span></span><span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">Tuple</span><span class="p">,</span> <span class="n">Any</span>
 <span class="kn">from</span><span class="w"> </span><span class="nn">pathlib</span><span class="w"> </span><span class="kn">import</span> <span class="n">Path</span>
 <span class="kn">from</span><span class="w"> </span><span class="nn">munch</span><span class="w"> </span><span class="kn">import</span> <span class="n">Munch</span><span class="p">,</span> <span class="n">munchify</span>
 
 <span class="kn">from</span><span class="w"> </span><span class="nn">ekfsm.core.components</span><span class="w"> </span><span class="kn">import</span> <span class="n">SysTree</span>
 <span class="kn">import</span><span class="w"> </span><span class="nn">yaml</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">ekfsm.utils</span><span class="w"> </span><span class="kn">import</span> <span class="n">all_board_cfg_files</span><span class="p">,</span> <span class="n">find_board_config</span>
+
 <span class="kn">from</span><span class="w"> </span><span class="nn">.core.slots</span><span class="w"> </span><span class="kn">import</span> <span class="n">Slot</span><span class="p">,</span> <span class="n">SlotType</span>
 
 <span class="kn">from</span><span class="w"> </span><span class="nn">.config</span><span class="w"> </span><span class="kn">import</span> <span class="n">load_config</span>
@@ -87,39 +89,6 @@
 <span class="kn">from</span><span class="w"> </span><span class="nn">.log</span><span class="w"> </span><span class="kn">import</span> <span class="n">ekfsm_logger</span>
 
 
-<span class="n">_CFG_DIR</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="vm">__file__</span><span class="p">)</span><span class="o">.</span><span class="n">parent</span> <span class="o">/</span> <span class="s2">&quot;boards&quot;</span>
-
-
-<span class="k">def</span><span class="w"> </span><span class="nf">find_board_config</span><span class="p">(</span><span class="n">module_type</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Path</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
-<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
-<span class="sd">    Find a matching board config in `boards/oem/` given the module type specified in</span>
-<span class="sd">    the system configuration file.</span>
-
-<span class="sd">    Parameters</span>
-<span class="sd">    ----------</span>
-<span class="sd">    module_type</span>
-<span class="sd">        Board type specified in the system configuration for a slot.</span>
-<span class="sd">        It must consist of an OEM and the board type, separated by whitespace. Neither</span>
-<span class="sd">        part may contain any other whitespace.</span>
-<span class="sd">    &quot;&quot;&quot;</span>
-    <span class="n">oem</span><span class="p">,</span> <span class="n">board</span> <span class="o">=</span> <span class="n">module_type</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">maxsplit</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
-    <span class="k">if</span> <span class="p">(</span>
-        <span class="n">path</span> <span class="o">:=</span> <span class="n">_CFG_DIR</span> <span class="o">/</span> <span class="s2">&quot;oem&quot;</span> <span class="o">/</span> <span class="n">oem</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">/</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">board</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span><span class="si">}</span><span class="s2">.yaml&quot;</span>
-    <span class="p">)</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
-        <span class="k">return</span> <span class="n">path</span>
-    <span class="k">return</span> <span class="kc">None</span>
-
-
-<span class="k">def</span><span class="w"> </span><span class="nf">all_board_cfg_files</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">Generator</span><span class="p">[</span><span class="n">Path</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">]:</span>
-<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
-<span class="sd">    Generator that recursively yields all *.yaml files in a directory</span>
-<span class="sd">    &quot;&quot;&quot;</span>
-    <span class="n">path</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="n">_CFG_DIR</span><span class="p">)</span>
-    <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">path</span><span class="o">.</span><span class="n">rglob</span><span class="p">(</span><span class="s2">&quot;*.yaml&quot;</span><span class="p">):</span>
-        <span class="k">if</span> <span class="n">item</span><span class="o">.</span><span class="n">is_file</span><span class="p">():</span>
-            <span class="k">yield</span> <span class="n">item</span>
-
-
 <div class="viewcode-block" id="System">
 <a class="viewcode-back" href="../../reference/ekfsm.html#ekfsm.System">[docs]</a>
 <span class="k">class</span><span class="w"> </span><span class="nc">System</span><span class="p">(</span><span class="n">SysTree</span><span class="p">):</span>

ekfsm-1.2.0a7/docs/build/html/_modules/ekfsm/utils.html

@@ -0,0 +1,150 @@
+
+
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" data-content_root="../../">
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>ekfsm.utils &mdash; ekfsm  documentation</title>
+      <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
+      <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
+
+  
+      <script src="../../_static/jquery.js?v=5d32c60e"></script>
+      <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+      <script src="../../_static/documentation_options.js?v=5929fcd5"></script>
+      <script src="../../_static/doctools.js?v=9bcbadda"></script>
+      <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="../../_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="../../genindex.html" />
+    <link rel="search" title="Search" href="../../search.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+          
+          
+          <a href="../../index.html" class="icon icon-home">
+            ekfsm
+          </a>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../intro.html">Introduction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../boards.html">Supported Boards</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../reference/index.html">Reference</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../../index.html">ekfsm</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="../../index.html" class="icon icon-home" aria-label="Home"></a></li>
+          <li class="breadcrumb-item"><a href="../index.html">Module code</a></li>
+      <li class="breadcrumb-item active">ekfsm.utils</li>
+      <li class="wy-breadcrumbs-aside">
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+             
+  <h1>Source code for ekfsm.utils</h1><div class="highlight"><pre>
+<span></span><span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">Generator</span>
+
+
+<span class="kn">from</span><span class="w"> </span><span class="nn">pathlib</span><span class="w"> </span><span class="kn">import</span> <span class="n">Path</span>
+
+<span class="n">_CFG_DIR</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="vm">__file__</span><span class="p">)</span><span class="o">.</span><span class="n">parent</span> <span class="o">/</span> <span class="s2">&quot;boards&quot;</span>
+
+
+<div class="viewcode-block" id="find_board_config">
+<a class="viewcode-back" href="../../reference/ekfsm.html#ekfsm.utils.find_board_config">[docs]</a>
+<span class="k">def</span><span class="w"> </span><span class="nf">find_board_config</span><span class="p">(</span><span class="n">module_type</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Path</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">    Find a matching board config in `boards/oem/` given the module type specified in</span>
+<span class="sd">    the system configuration file.</span>
+
+<span class="sd">    Parameters</span>
+<span class="sd">    ----------</span>
+<span class="sd">    module_type</span>
+<span class="sd">        Board type specified in the system configuration for a slot.</span>
+<span class="sd">        It must consist of an OEM and the board type, separated by whitespace. Neither</span>
+<span class="sd">        part may contain any other whitespace.</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="n">oem</span><span class="p">,</span> <span class="n">board</span> <span class="o">=</span> <span class="n">module_type</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">maxsplit</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
+    <span class="k">if</span> <span class="p">(</span>
+        <span class="n">path</span> <span class="o">:=</span> <span class="n">_CFG_DIR</span> <span class="o">/</span> <span class="s2">&quot;oem&quot;</span> <span class="o">/</span> <span class="n">oem</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">/</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">board</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span><span class="si">}</span><span class="s2">.yaml&quot;</span>
+    <span class="p">)</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
+        <span class="k">return</span> <span class="n">path</span>
+    <span class="k">return</span> <span class="kc">None</span></div>
+
+
+
+<div class="viewcode-block" id="all_board_cfg_files">
+<a class="viewcode-back" href="../../reference/ekfsm.html#ekfsm.utils.all_board_cfg_files">[docs]</a>
+<span class="k">def</span><span class="w"> </span><span class="nf">all_board_cfg_files</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">Generator</span><span class="p">[</span><span class="n">Path</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">]:</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">    Generator that recursively yields all *.yaml files in the config directory.</span>
+
+<span class="sd">    Yields</span>
+<span class="sd">    ------</span>
+<span class="sd">    item: Path</span>
+<span class="sd">        Path to a config file.</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="n">path</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="n">_CFG_DIR</span><span class="p">)</span>
+    <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">path</span><span class="o">.</span><span class="n">rglob</span><span class="p">(</span><span class="s2">&quot;*.yaml&quot;</span><span class="p">):</span>
+        <span class="k">if</span> <span class="n">item</span><span class="o">.</span><span class="n">is_file</span><span class="p">():</span>
+            <span class="k">yield</span> <span class="n">item</span></div>
+
+</pre></div>
+
+           </div>
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2024, Klaus Popp, Felix Päßler, Jan Jansen.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+   
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>

{ekfsm-1.1.0a15.post1 → ekfsm-1.2.0a7}/docs/build/html/_modules/index.html

@@ -93,6 +93,7 @@
 <li><a href="ekfsm/lock.html">ekfsm.lock</a></li>
 <li><a href="ekfsm/log.html">ekfsm.log</a></li>
 <li><a href="ekfsm/system.html">ekfsm.system</a></li>
+<li><a href="ekfsm/utils.html">ekfsm.utils</a></li>
 <li><a href="enum.html">enum</a></li>
 </ul>
 

{ekfsm-1.1.0a15.post1 → ekfsm-1.2.0a7}/docs/build/html/_sources/boards/ekf/ccu.rst.txt

@@ -101,6 +101,25 @@ Fan Controller (Object: `fan`)
 | :meth:`~ekfsm.devices.ekf_ccu_uc.EKFCcuUc.push_temperature` | Tell FAN controller the external temperature | ``65``                    |
 +-------------------------------------------------------------+----------------------------------------------+---------------------------+
 
+Example
+-------
+.. code-block:: python
+
+    # Get the fan status
+    fan_status = ccu.fan.fan_status()
+    print(f"Fan status: {fan_status}")
+
+    # Push the temperature to the fan controller
+    ccu.fan.push_temperature(65)
+    print("Temperature pushed to fan controller.")
+
+    # Wait for one second
+    time.sleep(1)
+
+    # Get the fan status again
+    fan_status = ccu.fan.fan_status()
+    print(f"Fan status: {fan_status}")
+
 
 Inertial Measurement Unit (Object: `imu`)
 =========================================

ekfsm-1.2.0a7/docs/build/html/_sources/boards.rst.txt

@@ -0,0 +1,24 @@
+.. _boards:
+
+=========================
+Supported Boards
+=========================
+
+
+.. toctree::
+    :maxdepth: 1
+    :glob:
+
+    boards/*/*
+
+Accessing Boards
+----------------
+
+Boards are appended to the system object and can be accessed e.g. via `system.ccu`.
+Objects described in the board documentation are available via the boards object.
+
+Example
+~~~~~~~
+>>> from ekfsm import System
+>>> sm = System("path/to/config.yaml")
+>>> sm.ccu.fan.fan_status()

{ekfsm-1.1.0a15.post1 → ekfsm-1.2.0a7}/docs/build/html/_sources/reference/ekfsm.rst.txt

@@ -22,6 +22,10 @@ Locking
 
 .. automodule:: ekfsm.lock
 
+Utils
+-----
+.. automodule:: ekfsm.utils
+
 
 ekfsm.devices package
 =====================