docs update

teddokano · teddokano · commit 586c131898c9 · 2024-02-12T05:36:38.000+09:00
diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 3466b8de15c9ad714d251ac1d604f536
+config: f1d823471b03cbf8efe419b09248d874
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle
diff --git a/docs/.doctrees/nxp_periph.doctree b/docs/.doctrees/nxp_periph.doctree
diff --git a/docs/_modules/index.html b/docs/_modules/index.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Overview: module code &mdash; mikan 1.14 documentation</title>
+  <title>Overview: module code &mdash; mikan 1.14.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
 
@@ -14,7 +14,7 @@
   
         <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=42a3b5f3"></script>
+        <script src="../_static/documentation_options.js?v=a5781ae5"></script>
         <script src="../_static/doctools.js?v=888ff710"></script>
         <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/js/theme.js"></script>
diff --git a/docs/_modules/nxp_periph/LCD_driver.html b/docs/_modules/nxp_periph/LCD_driver.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>nxp_periph.LCD_driver &mdash; mikan 1.14 documentation</title>
+  <title>nxp_periph.LCD_driver &mdash; mikan 1.14.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
 
@@ -14,7 +14,7 @@
   
         <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=42a3b5f3"></script>
+        <script src="../../_static/documentation_options.js?v=a5781ae5"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/js/theme.js"></script>
diff --git a/docs/_modules/nxp_periph/LED_controller.html b/docs/_modules/nxp_periph/LED_controller.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>nxp_periph.LED_controller &mdash; mikan 1.14 documentation</title>
+  <title>nxp_periph.LED_controller &mdash; mikan 1.14.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
 
@@ -14,7 +14,7 @@
   
         <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=42a3b5f3"></script>
+        <script src="../../_static/documentation_options.js?v=a5781ae5"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/js/theme.js"></script>
@@ -832,7 +832,7 @@ <h1>Source code for nxp_periph.LED_controller</h1><div class="highlight"><pre>
 		<span class="bp">self</span><span class="o">.</span><span class="n">__iref_base</span>	<span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">REG_NAME</span><span class="o">.</span><span class="n">index</span><span class="p">(</span> <span class="s2">&quot;PWM0&quot;</span>  <span class="k">if</span> <span class="n">current_control</span> <span class="k">else</span> <span class="s2">&quot;IREF0&quot;</span> <span class="p">)</span>
 
 		<span class="n">init</span>	<span class="o">=</span>	<span class="p">{</span>
-						<span class="s2">&quot;MODE2&quot;</span>		<span class="p">:</span> <span class="mh">0x18</span><span class="p">,</span>		<span class="c1">#	to forth the channel working when wrror happened</span>
+						<span class="s2">&quot;MODE2&quot;</span>		<span class="p">:</span> <span class="mh">0x18</span><span class="p">,</span>		<span class="c1">#	to forth output channels working when error happened</span>
 						<span class="s2">&quot;LEDOUT0&quot;</span>	<span class="p">:</span> <span class="p">[</span> <span class="mh">0xAA</span> <span class="p">]</span> <span class="o">*</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">CHANNELS</span> <span class="o">//</span> <span class="mi">4</span><span class="p">),</span>
 						<span class="s2">&quot;PWMALL&quot;</span>	<span class="p">:</span> <span class="n">pwm</span><span class="p">,</span>
 						<span class="s2">&quot;IREFALL&quot;</span>	<span class="p">:</span> <span class="n">iref</span>
diff --git a/docs/_modules/nxp_periph/RTC.html b/docs/_modules/nxp_periph/RTC.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>nxp_periph.RTC &mdash; mikan 1.14 documentation</title>
+  <title>nxp_periph.RTC &mdash; mikan 1.14.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
 
@@ -14,7 +14,7 @@
   
         <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=42a3b5f3"></script>
+        <script src="../../_static/documentation_options.js?v=a5781ae5"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/js/theme.js"></script>
@@ -1189,11 +1189,11 @@ <h1>Source code for nxp_periph.RTC</h1><div class="highlight"><pre>
 						<span class="s2">&quot;CLKOUT_Control&quot;</span><span class="p">,</span>
 						<span class="s2">&quot;2nd_Control_Register&quot;</span><span class="p">,</span>
 						<span class="s2">&quot;Scratchpad&quot;</span><span class="p">,</span> <span class="s2">&quot;Version_Register&quot;</span><span class="p">,</span> 
-						<span class="s2">&quot;Vendor_ID_Register&quot;</span><span class="p">,</span> <span class="s2">&quot;Model Register&quot;</span><span class="p">,</span>
+						<span class="s2">&quot;Vendor_ID_Register&quot;</span><span class="p">,</span> <span class="s2">&quot;Model_Register&quot;</span><span class="p">,</span>
 						<span class="s2">&quot;Offset&quot;</span><span class="p">,</span> <span class="s2">&quot;Oscillator&quot;</span><span class="p">,</span> 
 						<span class="s2">&quot;Access_config&quot;</span><span class="p">,</span> 
 						<span class="s2">&quot;Sec_timestp&quot;</span><span class="p">,</span> <span class="s2">&quot;Min_timestp&quot;</span><span class="p">,</span> <span class="s2">&quot;Hour_timestp&quot;</span><span class="p">,</span> <span class="s2">&quot;DayWk_timestp&quot;</span><span class="p">,</span> <span class="s2">&quot;DayMon_timestp&quot;</span><span class="p">,</span> <span class="s2">&quot;Mon_timestp&quot;</span><span class="p">,</span> <span class="s2">&quot;Year_timestp&quot;</span><span class="p">,</span> 
-						<span class="s2">&quot;R_code1&quot;</span><span class="p">,</span> <span class="s2">&quot;R_code1&quot;</span>
+						<span class="s2">&quot;R_code1&quot;</span><span class="p">,</span> <span class="s2">&quot;R_code2&quot;</span>
 						<span class="p">)</span>
 	<span class="n">INT_MASK</span>		<span class="o">=</span> <span class="p">{</span> <span class="s2">&quot;A&quot;</span><span class="p">:</span> <span class="p">[</span><span class="s2">&quot;INT_A_MASK1&quot;</span><span class="p">,</span> <span class="s2">&quot;INT_A_MASK2&quot;</span><span class="p">],</span> <span class="s2">&quot;B&quot;</span><span class="p">:</span> <span class="p">[</span> <span class="s2">&quot;INT_B_MASK1&quot;</span><span class="p">,</span> <span class="s2">&quot;INT_B_MASK2&quot;</span> <span class="p">]</span> <span class="p">}</span>
 	<span class="n">REG_ORDER_DT</span>	<span class="o">=</span> <span class="p">{</span> <span class="s2">&quot;seconds&quot;</span><span class="p">:</span> 	<span class="s2">&quot;Seconds&quot;</span><span class="p">,</span> 
diff --git a/docs/_modules/nxp_periph/accelerometer.html b/docs/_modules/nxp_periph/accelerometer.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>nxp_periph.accelerometer &mdash; mikan 1.14 documentation</title>
+  <title>nxp_periph.accelerometer &mdash; mikan 1.14.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
 
@@ -14,7 +14,7 @@
   
         <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=42a3b5f3"></script>
+        <script src="../../_static/documentation_options.js?v=a5781ae5"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/js/theme.js"></script>
diff --git a/docs/_modules/nxp_periph/interface.html b/docs/_modules/nxp_periph/interface.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>nxp_periph.interface &mdash; mikan 1.14 documentation</title>
+  <title>nxp_periph.interface &mdash; mikan 1.14.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
 
@@ -14,7 +14,7 @@
   
         <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=42a3b5f3"></script>
+        <script src="../../_static/documentation_options.js?v=a5781ae5"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/js/theme.js"></script>
diff --git a/docs/_modules/nxp_periph/protocol_bridge.html b/docs/_modules/nxp_periph/protocol_bridge.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>nxp_periph.protocol_bridge &mdash; mikan 1.14 documentation</title>
+  <title>nxp_periph.protocol_bridge &mdash; mikan 1.14.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
 
@@ -14,7 +14,7 @@
   
         <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=42a3b5f3"></script>
+        <script src="../../_static/documentation_options.js?v=a5781ae5"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/js/theme.js"></script>
diff --git a/docs/_modules/nxp_periph/stepper_motor.html b/docs/_modules/nxp_periph/stepper_motor.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>nxp_periph.stepper_motor &mdash; mikan 1.14 documentation</title>
+  <title>nxp_periph.stepper_motor &mdash; mikan 1.14.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
 
@@ -14,7 +14,7 @@
   
         <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=42a3b5f3"></script>
+        <script src="../../_static/documentation_options.js?v=a5781ae5"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/js/theme.js"></script>
diff --git a/docs/_modules/nxp_periph/temp_sensor.html b/docs/_modules/nxp_periph/temp_sensor.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>nxp_periph.temp_sensor &mdash; mikan 1.14 documentation</title>
+  <title>nxp_periph.temp_sensor &mdash; mikan 1.14.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
 
@@ -14,7 +14,7 @@
   
         <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=42a3b5f3"></script>
+        <script src="../../_static/documentation_options.js?v=a5781ae5"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/js/theme.js"></script>
diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '1.14',
+    VERSION: '1.14.1',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',
diff --git a/docs/genindex.html b/docs/genindex.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Index &mdash; mikan 1.14 documentation</title>
+  <title>Index &mdash; mikan 1.14.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
 
@@ -14,7 +14,7 @@
   
         <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=42a3b5f3"></script>
+        <script src="_static/documentation_options.js?v=a5781ae5"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
diff --git a/docs/index.html b/docs/index.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Welcome to mikan’s documentation! &mdash; mikan 1.14 documentation</title>
+  <title>Welcome to mikan’s documentation! &mdash; mikan 1.14.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
 
@@ -15,7 +15,7 @@
   
         <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=42a3b5f3"></script>
+        <script src="_static/documentation_options.js?v=a5781ae5"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
diff --git a/docs/main.html b/docs/main.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>main module &mdash; mikan 1.14 documentation</title>
+  <title>main module &mdash; mikan 1.14.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
 
@@ -15,7 +15,7 @@
   
         <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=42a3b5f3"></script>
+        <script src="_static/documentation_options.js?v=a5781ae5"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
diff --git a/docs/modules.html b/docs/modules.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>mikan &mdash; mikan 1.14 documentation</title>
+  <title>mikan &mdash; mikan 1.14.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
 
@@ -15,7 +15,7 @@
   
         <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=42a3b5f3"></script>
+        <script src="_static/documentation_options.js?v=a5781ae5"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
diff --git a/docs/nxp_periph.html b/docs/nxp_periph.html
diff --git a/docs/py-modindex.html b/docs/py-modindex.html
diff --git a/docs/search.html b/docs/search.html
diff --git a/docs/searchindex.js b/docs/searchindex.js
diff --git a/docs/test.html b/docs/test.html
