From 32ec111bd30582ae17a910829ac5b8d3d4e7fcb1 Mon Sep 17 00:00:00 2001
From: patrickelectric <patrickelectric@users.noreply.github.com>
Date: Mon, 4 Mar 2024 11:37:55 +0000
Subject: [PATCH] deploy: 15cd1c81c1261f96984c2610d6dc4e069151684c

---
 python/genindex.html  |   4 ++++
 python/index.html     |  20 ++++++++++++++++++++
 python/objects.inv    | Bin 666 -> 676 bytes
 python/searchindex.js |   2 +-
 4 files changed, 25 insertions(+), 1 deletion(-)

diff --git a/python/genindex.html b/python/genindex.html
index bae20460d..23941c628 100644
--- a/python/genindex.html
+++ b/python/genindex.html
@@ -180,6 +180,10 @@ <h2 id="G">G</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="index.html#bluerobotics_navigator.get_led">get_led() (in module bluerobotics_navigator)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#bluerobotics_navigator.get_pwm_enable">get_pwm_enable() (in module bluerobotics_navigator)</a>
 </li>
   </ul></td>
 </tr></table>
diff --git a/python/index.html b/python/index.html
index c29953126..eee2798c7 100644
--- a/python/index.html
+++ b/python/index.html
@@ -94,6 +94,7 @@
 </ul>
 </li>
 <li><a class="reference internal" href="#bluerobotics_navigator.get_led"><code class="docutils literal notranslate"><span class="pre">get_led()</span></code></a></li>
+<li><a class="reference internal" href="#bluerobotics_navigator.get_pwm_enable"><code class="docutils literal notranslate"><span class="pre">get_pwm_enable()</span></code></a></li>
 <li><a class="reference internal" href="#bluerobotics_navigator.init"><code class="docutils literal notranslate"><span class="pre">init()</span></code></a></li>
 <li><a class="reference internal" href="#bluerobotics_navigator.read_accel"><code class="docutils literal notranslate"><span class="pre">read_accel()</span></code></a></li>
 <li><a class="reference internal" href="#bluerobotics_navigator.read_adc"><code class="docutils literal notranslate"><span class="pre">read_adc()</span></code></a></li>
@@ -360,6 +361,25 @@ <h1>BlueRobotics’s Navigator Library<a class="headerlink" href="#bluerobotics-
 </div>
 </dd></dl>
 
+<dl class="py function">
+<dt class="sig sig-object py" id="bluerobotics_navigator.get_pwm_enable">
+<span class="sig-prename descclassname"><span class="pre">bluerobotics_navigator.</span></span><span class="sig-name descname"><span class="pre">get_pwm_enable</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bluerobotics_navigator.get_pwm_enable" title="Link to this definition"></a></dt>
+<dd><p>Get the PWM chip (PCA9685)’s OE_pin state.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p><cite>True</cite> -&gt; ON, <cite>False</cite> -&gt; OFF.</p>
+</dd>
+<dt class="field-even">Return type<span class="colon">:</span></dt>
+<dd class="field-even"><p>bool</p>
+</dd>
+</dl>
+<p class="rubric">Examples</p>
+<p>Please check <a class="reference internal" href="#bluerobotics_navigator.set_pwm_channel_value" title="bluerobotics_navigator.set_pwm_channel_value"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_pwm_channel_value()</span></code></a></p>
+<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">navigator</span><span class="o">.</span><span class="n">get_pwm_enable</span><span class="p">()</span>
+</pre></div>
+</div>
+</dd></dl>
+
 <dl class="py function">
 <dt class="sig sig-object py" id="bluerobotics_navigator.init">
 <span class="sig-prename descclassname"><span class="pre">bluerobotics_navigator.</span></span><span class="sig-name descname"><span class="pre">init</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bluerobotics_navigator.init" title="Link to this definition"></a></dt>
diff --git a/python/objects.inv b/python/objects.inv
index d9d4c163fe7da58f3f1dc35e5575dac4bf99be5b..4bc13b7fff76730368327120ef44560f067687ff 100644
GIT binary patch
delta 548
zcmV+<0^9wX1*8R#i+|m2n=llB@ADK$o75{%l6HT+>(ZM_?G$a=H8SP|EE${GrVYK?
zYwY#*B!e0PD49ZzeSw7R^L@v$4`3(Z6)2fV!>Eo0d1e_gQUzswTgbHH5G(^GQrJhi
zDfm0v7QPR{MRF31?(R4D#E@1%Ing>;jrsFnL~|kp@K!*KQGYC{49u6LbTjZ54&cB>
zn|$e-zj3TQIMyB<*GR{nY2;FNWVCn79Mz8eD~{j36zD1%*yxUP*ZlY@nmU#~Bwj|c
z_940UA-VA(`QStH(SyXty!x0{AG7LXQhm(nCl8L#9vokAj-MLTBczwV!#Xf(u9Z{j
z*06RqAj>iX6Mu92^LLe?hDmV|TfP)A2$D2=AdG?uW>BC4lE#Em`}INMDRqKl!X2__
zwUT(cAQ>Jm6=+>4z#9w{C5qO-cMYu#lEznS$D$Xl=Z(xVWVN>n0kUL!z>lGQ;=1jB
z{7jlSA13WxrJY<3uasV~Q}8R!U)>$;(?ZGF(Nv5ZCV%wt*)E*Ko;eYYMJJAF^IQWs
z)*YQx=E-_&q&l_rpCucCBi+#_c$TZDri*x`gW-J6S)z!l18ve<PLek3f6bu|4`A4X
zUz>pMUBKVpe{}He;C{3riwwk@ahjxWeajO(w6}{PER}RRk~xVAnVv{g)?wdaO;7d@
m37c}%dmRSb)+TStdO~X;isn<$wpr$f?cb6N7XJVig*^D{I}eBe

delta 538
zcmV+#0_FXr1)2qri+|s4n=llI@ADLvHfdL&B<=q7u1#+ywNtcd*T~o>V9D6jHf`ut
zU!$+LCmGZbK*<zp`yx_=&-eXKY$xEPyaFXtX&BLoz>h4$Mk-X+SB0b%2ed>?P}s-0
zDfkC_E&7O}MS2p9uWvWE*x*(`IMy1i#{79OCOH-Ycq_ohD1Vk#2IfmB*$n(U8#u7>
zCSUsIH;z>R$2x%H!qKs3+Hom6GT!?o$F(Q_?8a}O3g=xku<<qLzWMIEXzEyokOb*u
z9YS&uLUI{G@;QX$O8`lTc?~hGA!aqiq=uN&uK^t20yw_AIsRx+cR=6&8`gnw^ICaD
zw}!R1!Esw=V1E*BKmM)~#4sslvrI7K1S-HZ!Gzdbha*mj7o1@3k)G8`y3+;D+~HDz
z)|CQxgMp%SqBZbcLu=zmyKl9QbzZcdH!{mOI4cCmlI_90hw`aNx@Y&~5jS-qOggwq
zd$~a1l>4=_Q}B@F&;E|~+d}Z!ZYstN6Z-gI7ENl;9DnD=q7!GVd9DE*>yC~Y^JG0X
zQk{BkpCucCBi+&cbC#>8ri=JVqv3GPS*ozAkv8;-<FrlvuQ}4u0gQU^rYZQ<75sg9
z)#&HJeP>G+8HhLIG^D@!mV<t@Zx=%um1Nq<oS;I|6G3Gi^#j&)Z~slOk)zQw*tRx#
cv#lqz1{17EJ_YSH%lx+ETb#k-A4RJqC&V%mWdHyG

diff --git a/python/searchindex.js b/python/searchindex.js
index 099516b81..fc5e4fc98 100644
--- a/python/searchindex.js
+++ b/python/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["index"], "filenames": ["index.rst"], "titles": ["BlueRobotics\u2019s Navigator Library"], "terms": {"thi": 0, "serv": 0, "entri": 0, "point": 0, "embed": 0, "applic": 0, "us": 0, "python": 0, "blue": 0, "robot": 0, "The": 0, "board": 0, "ha": 0, "raspberri": 0, "pi": 0, "hat": 0, "form": 0, "factor": 0, "which": 0, "allow": 0, "you": 0, "easili": 0, "attach": 0, "4": 0, "Then": 0, "can": 0, "unleash": 0, "power": 0, "develop": 0, "new": 0, "solut": 0, "interact": 0, "your": 0, "rov": 0, "hardwar": 0, "offer": 0, "follow": 0, "capabl": 0, "control": 0, "led": 0, "pwm": 0, "puls": 0, "width": 0, "modul": 0, "16": 0, "channel": 0, "measur": 0, "adc": 0, "analog": 0, "digit": 0, "convert": 0, "magnet": 0, "field": 0, "acceler": 0, "angular": 0, "veloc": 0, "temperatur": 0, "pressur": 0, "current": 0, "support": 0, "armv7": 0, "aarch64": 0, "architectur": 0, "ar": 0, "offici": 0, "default": 0, "blueo": 0, "howev": 0, "despit": 0, "hal": 0, "concept": 0, "port": 0, "ad": 0, "long": 0, "platform": 0, "match": 0, "design": 0, "specif": 0, "For": 0, "more": 0, "inform": 0, "includ": 0, "instal": 0, "instruct": 0, "schemat": 0, "pleas": 0, "check": 0, "setup": 0, "guid": 0, "class": 0, "bluerobotics_navig": 0, "adcdata": 0, "an": 0, "arrai": 0, "read": 0, "from": 0, "differ": 0, "adcchannel": 0, "avail": 0, "ch0": 0, "ch1": 0, "ch2": 0, "ch3": 0, "axisdata": 0, "orient": 0, "direct": 0, "ax": 0, "x": 0, "i": 0, "forward": 0, "y": 0, "right": 0, "z": 0, "down": 0, "pwmchannel": 0, "output": 0, "all": 0, "ch10": 0, "ch11": 0, "ch12": 0, "ch13": 0, "ch14": 0, "ch15": 0, "ch16": 0, "ch4": 0, "ch5": 0, "ch6": 0, "ch7": 0, "ch8": 0, "ch9": 0, "userl": 0, "onboard": 0, "user": 0, "led1": 0, "led2": 0, "led3": 0, "get_l": 0, "select": 0, "get": 0, "state": 0, "paramet": 0, "A": 0, "pin": 0, "return": 0, "true": 0, "ON": 0, "fals": 0, "off": 0, "type": 0, "bool": 0, "exampl": 0, "import": 0, "led1_on": 0, "init": 0, "initi": 0, "set": 0, "read_accel": 0, "valu": 0, "icm20689": 0, "chip": 0, "acceleromet": 0, "m": 0, "s\u00b2": 0, "forward_acc": 0, "read_adc": 0, "ads1115": 0, "v": 0, "float32": 0, "adc1_measur": 0, "read_adc_al": 0, "same": 0, "adc_measur": 0, "read_gyro": 0, "gyroscop": 0, "rad": 0, "angular_veloc": 0, "roll_rat": 0, "pitch_rat": 0, "yaw_rat": 0, "read_mag": 0, "local": 0, "strength": 0, "ak09915": 0, "magnetomet": 0, "\u00b5t": 0, "mag_field": 0, "read_pressur": 0, "bmp280": 0, "kpa": 0, "air_pressur": 0, "read_temp": 0, "c": 0, "air_temperatur": 0, "read_temperatur": 0, "self_test": 0, "run": 0, "some": 0, "test": 0, "sensor": 0, "result": 0, "respond": 0, "expect": 0, "sensors_ok": 0, "set_l": 0, "desir": 0, "set_led_al": 0, "green": 0, "red": 0, "set_led_toggl": 0, "toggl": 0, "set_neopixel": 0, "rgb_arrai": 0, "color": 0, "bright": 0, "connect": 0, "neopixel": 0, "uint8": 0, "2d": 0, "contain": 0, "rgb": 0, "each": 0, "compon": 0, "independ": 0, "0": 0, "255": 0, "100": 0, "set_pwm_channel_valu": 0, "duti": 0, "cycl": 0, "proport": 0, "time": 0, "counter": 0, "hard": 0, "code": 0, "turn": 0, "start": 0, "after": 0, "specifi": 0, "count": 0, "where": 0, "full": 0, "defin": 0, "set_pwm_freq_hz": 0, "split": 0, "4096": 0, "segment": 0, "note": 0, "20": 0, "achiev": 0, "819": 0, "To": 0, "durat": 0, "need": 0, "consid": 0, "frequenc": 0, "4095": 0, "pulse_dur": 0, "cycle_period": 0, "As": 0, "50": 0, "hz": 0, "period": 0, "1100": 0, "\u00b5": 0, "5": 0, "requir": 0, "225": 0, "similarli": 0, "1900": 0, "would": 0, "389": 0, "u16": 0, "1000": 0, "2000": 0, "set_pwm_en": 0, "set_pwm_channels_valu": 0, "like": 0, "function": 0, "list": 0, "multipl": 0, "configur": 0, "method": 0, "correspond": 0, "500": 0, "enabl": 0, "disabl": 0, "pca9685": 0, "firmwar": 0, "oe_pin": 0, "freq": 0, "conveni": 0, "wrapper": 0, "around": 0, "set_pwm_freq_prescal": 0, "choos": 0, "closest": 0, "possibl": 0, "pre": 0, "scaler": 0, "servo": 0, "motor": 0, "gener": 0, "work": 0, "best": 0, "between": 0, "200": 0, "flicker": 0, "less": 0, "video": 0, "stream": 0, "when": 0, "driven": 0, "camera": 0, "framer": 0, "e": 0, "g": 0, "30fp": 0, "should": 0, "have": 0, "30": 0, "60": 0, "90": 0, "120": 0, "24": 0, "1526": 0, "low_level": 0, "directli": 0, "pre_scal": 0, "easier": 0, "instead": 0, "prescal": 0, "calcul": 0, "updat": 0, "rate": 0, "formula": 0, "prescale_valu": 0, "round": 0, "clock_freq": 0, "desired_freq": 0, "1": 0, "24_576_000": 0, "5760": 0, "mhz": 0, "clock": 0, "chang": 0, "affect": 0, "so": 0, "thei": 0, "re": 0, "afterward": 0, "minimum": 0, "3": 0, "maximum": 0, "prescalar": 0, "119": 0, "29": 0, "intern": 0, "stop": 0, "oscil": 0, "restart": 0, "wa": 0, "alreadi": 0}, "objects": {"": [[0, 0, 0, "-", "bluerobotics_navigator"]], "bluerobotics_navigator": [[0, 1, 1, "", "ADCData"], [0, 1, 1, "", "AdcChannel"], [0, 1, 1, "", "AxisData"], [0, 1, 1, "", "PwmChannel"], [0, 1, 1, "", "UserLed"], [0, 3, 1, "", "get_led"], [0, 3, 1, "", "init"], [0, 3, 1, "", "read_accel"], [0, 3, 1, "", "read_adc"], [0, 3, 1, "", "read_adc_all"], [0, 3, 1, "", "read_gyro"], [0, 3, 1, "", "read_mag"], [0, 3, 1, "", "read_pressure"], [0, 3, 1, "", "read_temp"], [0, 3, 1, "", "self_test"], [0, 3, 1, "", "set_led"], [0, 3, 1, "", "set_led_all"], [0, 3, 1, "", "set_led_toggle"], [0, 3, 1, "", "set_neopixel"], [0, 3, 1, "", "set_pwm_channel_value"], [0, 3, 1, "", "set_pwm_channels_value"], [0, 3, 1, "", "set_pwm_channels_values"], [0, 3, 1, "", "set_pwm_enable"], [0, 3, 1, "", "set_pwm_freq_hz"], [0, 3, 1, "", "set_pwm_freq_prescale"]], "bluerobotics_navigator.ADCData": [[0, 2, 1, "", "channel"]], "bluerobotics_navigator.AdcChannel": [[0, 2, 1, "", "Ch0"], [0, 2, 1, "", "Ch1"], [0, 2, 1, "", "Ch2"], [0, 2, 1, "", "Ch3"]], "bluerobotics_navigator.AxisData": [[0, 2, 1, "", "x"], [0, 2, 1, "", "y"], [0, 2, 1, "", "z"]], "bluerobotics_navigator.PwmChannel": [[0, 2, 1, "", "All"], [0, 2, 1, "", "Ch1"], [0, 2, 1, "", "Ch10"], [0, 2, 1, "", "Ch11"], [0, 2, 1, "", "Ch12"], [0, 2, 1, "", "Ch13"], [0, 2, 1, "", "Ch14"], [0, 2, 1, "", "Ch15"], [0, 2, 1, "", "Ch16"], [0, 2, 1, "", "Ch2"], [0, 2, 1, "", "Ch3"], [0, 2, 1, "", "Ch4"], [0, 2, 1, "", "Ch5"], [0, 2, 1, "", "Ch6"], [0, 2, 1, "", "Ch7"], [0, 2, 1, "", "Ch8"], [0, 2, 1, "", "Ch9"]], "bluerobotics_navigator.UserLed": [[0, 2, 1, "", "Led1"], [0, 2, 1, "", "Led2"], [0, 2, 1, "", "Led3"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:attribute", "3": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "function", "Python function"]}, "titleterms": {"bluerobot": 0, "": 0, "navig": 0, "librari": 0}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 60}, "alltitles": {"BlueRobotics\u2019s Navigator Library": [[0, "bluerobotics-s-navigator-library"]]}, "indexentries": {"adcdata (class in bluerobotics_navigator)": [[0, "bluerobotics_navigator.ADCData"]], "adcchannel (class in bluerobotics_navigator)": [[0, "bluerobotics_navigator.AdcChannel"]], "all (bluerobotics_navigator.pwmchannel attribute)": [[0, "bluerobotics_navigator.PwmChannel.All"]], "axisdata (class in bluerobotics_navigator)": [[0, "bluerobotics_navigator.AxisData"]], "ch0 (bluerobotics_navigator.adcchannel attribute)": [[0, "bluerobotics_navigator.AdcChannel.Ch0"]], "ch1 (bluerobotics_navigator.adcchannel attribute)": [[0, "bluerobotics_navigator.AdcChannel.Ch1"]], "ch1 (bluerobotics_navigator.pwmchannel attribute)": [[0, "bluerobotics_navigator.PwmChannel.Ch1"]], "ch10 (bluerobotics_navigator.pwmchannel attribute)": [[0, "bluerobotics_navigator.PwmChannel.Ch10"]], "ch11 (bluerobotics_navigator.pwmchannel attribute)": [[0, "bluerobotics_navigator.PwmChannel.Ch11"]], "ch12 (bluerobotics_navigator.pwmchannel attribute)": [[0, "bluerobotics_navigator.PwmChannel.Ch12"]], "ch13 (bluerobotics_navigator.pwmchannel attribute)": [[0, "bluerobotics_navigator.PwmChannel.Ch13"]], "ch14 (bluerobotics_navigator.pwmchannel attribute)": [[0, "bluerobotics_navigator.PwmChannel.Ch14"]], "ch15 (bluerobotics_navigator.pwmchannel attribute)": [[0, "bluerobotics_navigator.PwmChannel.Ch15"]], "ch16 (bluerobotics_navigator.pwmchannel attribute)": [[0, "bluerobotics_navigator.PwmChannel.Ch16"]], "ch2 (bluerobotics_navigator.adcchannel attribute)": [[0, "bluerobotics_navigator.AdcChannel.Ch2"]], "ch2 (bluerobotics_navigator.pwmchannel attribute)": [[0, "bluerobotics_navigator.PwmChannel.Ch2"]], "ch3 (bluerobotics_navigator.adcchannel attribute)": [[0, "bluerobotics_navigator.AdcChannel.Ch3"]], "ch3 (bluerobotics_navigator.pwmchannel attribute)": [[0, "bluerobotics_navigator.PwmChannel.Ch3"]], "ch4 (bluerobotics_navigator.pwmchannel attribute)": [[0, "bluerobotics_navigator.PwmChannel.Ch4"]], "ch5 (bluerobotics_navigator.pwmchannel attribute)": [[0, "bluerobotics_navigator.PwmChannel.Ch5"]], "ch6 (bluerobotics_navigator.pwmchannel attribute)": [[0, "bluerobotics_navigator.PwmChannel.Ch6"]], "ch7 (bluerobotics_navigator.pwmchannel attribute)": [[0, "bluerobotics_navigator.PwmChannel.Ch7"]], "ch8 (bluerobotics_navigator.pwmchannel attribute)": [[0, "bluerobotics_navigator.PwmChannel.Ch8"]], "ch9 (bluerobotics_navigator.pwmchannel attribute)": [[0, "bluerobotics_navigator.PwmChannel.Ch9"]], "led1 (bluerobotics_navigator.userled attribute)": [[0, "bluerobotics_navigator.UserLed.Led1"]], "led2 (bluerobotics_navigator.userled attribute)": [[0, "bluerobotics_navigator.UserLed.Led2"]], "led3 (bluerobotics_navigator.userled attribute)": [[0, "bluerobotics_navigator.UserLed.Led3"]], "pwmchannel (class in bluerobotics_navigator)": [[0, "bluerobotics_navigator.PwmChannel"]], "userled (class in bluerobotics_navigator)": [[0, "bluerobotics_navigator.UserLed"]], "bluerobotics_navigator": [[0, "module-bluerobotics_navigator"]], "channel (bluerobotics_navigator.adcdata attribute)": [[0, "bluerobotics_navigator.ADCData.channel"]], "get_led() (in module bluerobotics_navigator)": [[0, "bluerobotics_navigator.get_led"]], "init() (in module bluerobotics_navigator)": [[0, "bluerobotics_navigator.init"]], "module": [[0, "module-bluerobotics_navigator"]], "read_accel() (in module bluerobotics_navigator)": [[0, "bluerobotics_navigator.read_accel"]], "read_adc() (in module bluerobotics_navigator)": [[0, "bluerobotics_navigator.read_adc"]], "read_adc_all() (in module bluerobotics_navigator)": [[0, "bluerobotics_navigator.read_adc_all"]], "read_gyro() (in module bluerobotics_navigator)": [[0, "bluerobotics_navigator.read_gyro"]], "read_mag() (in module bluerobotics_navigator)": [[0, "bluerobotics_navigator.read_mag"]], "read_pressure() (in module bluerobotics_navigator)": [[0, "bluerobotics_navigator.read_pressure"]], "read_temp() (in module bluerobotics_navigator)": [[0, "bluerobotics_navigator.read_temp"]], "self_test() (in module bluerobotics_navigator)": [[0, "bluerobotics_navigator.self_test"]], "set_led() (in module bluerobotics_navigator)": [[0, "bluerobotics_navigator.set_led"]], "set_led_all() (in module bluerobotics_navigator)": [[0, "bluerobotics_navigator.set_led_all"]], "set_led_toggle() (in module bluerobotics_navigator)": [[0, "bluerobotics_navigator.set_led_toggle"]], "set_neopixel() (in module bluerobotics_navigator)": [[0, "bluerobotics_navigator.set_neopixel"]], "set_pwm_channel_value() (in module bluerobotics_navigator)": [[0, "bluerobotics_navigator.set_pwm_channel_value"]], "set_pwm_channels_value() (in module bluerobotics_navigator)": [[0, "bluerobotics_navigator.set_pwm_channels_value"]], "set_pwm_channels_values() (in module bluerobotics_navigator)": [[0, "bluerobotics_navigator.set_pwm_channels_values"]], "set_pwm_enable() (in module bluerobotics_navigator)": [[0, "bluerobotics_navigator.set_pwm_enable"]], "set_pwm_freq_hz() (in module bluerobotics_navigator)": [[0, "bluerobotics_navigator.set_pwm_freq_hz"]], "set_pwm_freq_prescale() (in module bluerobotics_navigator)": [[0, "bluerobotics_navigator.set_pwm_freq_prescale"]], "x (bluerobotics_navigator.axisdata attribute)": [[0, "bluerobotics_navigator.AxisData.x"]], "y (bluerobotics_navigator.axisdata attribute)": [[0, "bluerobotics_navigator.AxisData.y"]], "z (bluerobotics_navigator.axisdata attribute)": [[0, "bluerobotics_navigator.AxisData.z"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["index"], "filenames": ["index.rst"], "titles": ["BlueRobotics\u2019s Navigator Library"], "terms": {"thi": 0, "serv": 0, "entri": 0, "point": 0, "embed": 0, "applic": 0, "us": 0, "python": 0, "blue": 0, "robot": 0, "The": 0, "board": 0, "ha": 0, "raspberri": 0, "pi": 0, "hat": 0, "form": 0, "factor": 0, "which": 0, "allow": 0, "you": 0, "easili": 0, "attach": 0, "4": 0, "Then": 0, "can": 0, "unleash": 0, "power": 0, "develop": 0, "new": 0, "solut": 0, "interact": 0, "your": 0, "rov": 0, "hardwar": 0, "offer": 0, "follow": 0, "capabl": 0, "control": 0, "led": 0, "pwm": 0, "puls": 0, "width": 0, "modul": 0, "16": 0, "channel": 0, "measur": 0, "adc": 0, "analog": 0, "digit": 0, "convert": 0, "magnet": 0, "field": 0, "acceler": 0, "angular": 0, "veloc": 0, "temperatur": 0, "pressur": 0, "current": 0, "support": 0, "armv7": 0, "aarch64": 0, "architectur": 0, "ar": 0, "offici": 0, "default": 0, "blueo": 0, "howev": 0, "despit": 0, "hal": 0, "concept": 0, "port": 0, "ad": 0, "long": 0, "platform": 0, "match": 0, "design": 0, "specif": 0, "For": 0, "more": 0, "inform": 0, "includ": 0, "instal": 0, "instruct": 0, "schemat": 0, "pleas": 0, "check": 0, "setup": 0, "guid": 0, "class": 0, "bluerobotics_navig": 0, "adcdata": 0, "an": 0, "arrai": 0, "read": 0, "from": 0, "differ": 0, "adcchannel": 0, "avail": 0, "ch0": 0, "ch1": 0, "ch2": 0, "ch3": 0, "axisdata": 0, "orient": 0, "direct": 0, "ax": 0, "x": 0, "i": 0, "forward": 0, "y": 0, "right": 0, "z": 0, "down": 0, "pwmchannel": 0, "output": 0, "all": 0, "ch10": 0, "ch11": 0, "ch12": 0, "ch13": 0, "ch14": 0, "ch15": 0, "ch16": 0, "ch4": 0, "ch5": 0, "ch6": 0, "ch7": 0, "ch8": 0, "ch9": 0, "userl": 0, "onboard": 0, "user": 0, "led1": 0, "led2": 0, "led3": 0, "get_l": 0, "select": 0, "get": 0, "state": 0, "paramet": 0, "A": 0, "pin": 0, "return": 0, "true": 0, "ON": 0, "fals": 0, "off": 0, "type": 0, "bool": 0, "exampl": 0, "import": 0, "led1_on": 0, "get_pwm_en": 0, "chip": 0, "pca9685": 0, "oe_pin": 0, "set_pwm_channel_valu": 0, "init": 0, "initi": 0, "set": 0, "read_accel": 0, "valu": 0, "icm20689": 0, "acceleromet": 0, "m": 0, "s\u00b2": 0, "forward_acc": 0, "read_adc": 0, "ads1115": 0, "v": 0, "float32": 0, "adc1_measur": 0, "read_adc_al": 0, "same": 0, "adc_measur": 0, "read_gyro": 0, "gyroscop": 0, "rad": 0, "angular_veloc": 0, "roll_rat": 0, "pitch_rat": 0, "yaw_rat": 0, "read_mag": 0, "local": 0, "strength": 0, "ak09915": 0, "magnetomet": 0, "\u00b5t": 0, "mag_field": 0, "read_pressur": 0, "bmp280": 0, "kpa": 0, "air_pressur": 0, "read_temp": 0, "c": 0, "air_temperatur": 0, "read_temperatur": 0, "self_test": 0, "run": 0, "some": 0, "test": 0, "sensor": 0, "result": 0, "respond": 0, "expect": 0, "sensors_ok": 0, "set_l": 0, "desir": 0, "set_led_al": 0, "green": 0, "red": 0, "set_led_toggl": 0, "toggl": 0, "set_neopixel": 0, "rgb_arrai": 0, "color": 0, "bright": 0, "connect": 0, "neopixel": 0, "uint8": 0, "2d": 0, "contain": 0, "rgb": 0, "each": 0, "compon": 0, "independ": 0, "0": 0, "255": 0, "100": 0, "duti": 0, "cycl": 0, "proport": 0, "time": 0, "counter": 0, "hard": 0, "code": 0, "turn": 0, "start": 0, "after": 0, "specifi": 0, "count": 0, "where": 0, "full": 0, "defin": 0, "set_pwm_freq_hz": 0, "split": 0, "4096": 0, "segment": 0, "note": 0, "20": 0, "achiev": 0, "819": 0, "To": 0, "durat": 0, "need": 0, "consid": 0, "frequenc": 0, "4095": 0, "pulse_dur": 0, "cycle_period": 0, "As": 0, "50": 0, "hz": 0, "period": 0, "1100": 0, "\u00b5": 0, "5": 0, "requir": 0, "225": 0, "similarli": 0, "1900": 0, "would": 0, "389": 0, "u16": 0, "1000": 0, "2000": 0, "set_pwm_en": 0, "set_pwm_channels_valu": 0, "like": 0, "function": 0, "list": 0, "multipl": 0, "configur": 0, "method": 0, "correspond": 0, "500": 0, "enabl": 0, "disabl": 0, "firmwar": 0, "freq": 0, "conveni": 0, "wrapper": 0, "around": 0, "set_pwm_freq_prescal": 0, "choos": 0, "closest": 0, "possibl": 0, "pre": 0, "scaler": 0, "servo": 0, "motor": 0, "gener": 0, "work": 0, "best": 0, "between": 0, "200": 0, "flicker": 0, "less": 0, "video": 0, "stream": 0, "when": 0, "driven": 0, "camera": 0, "framer": 0, "e": 0, "g": 0, "30fp": 0, "should": 0, "have": 0, "30": 0, "60": 0, "90": 0, "120": 0, "24": 0, "1526": 0, "low_level": 0, "directli": 0, "pre_scal": 0, "easier": 0, "instead": 0, "prescal": 0, "calcul": 0, "updat": 0, "rate": 0, "formula": 0, "prescale_valu": 0, "round": 0, "clock_freq": 0, "desired_freq": 0, "1": 0, "24_576_000": 0, "5760": 0, "mhz": 0, "clock": 0, "chang": 0, "affect": 0, "so": 0, "thei": 0, "re": 0, "afterward": 0, "minimum": 0, "3": 0, "maximum": 0, "prescalar": 0, "119": 0, "29": 0, "intern": 0, "stop": 0, "oscil": 0, "restart": 0, "wa": 0, "alreadi": 0}, "objects": {"": [[0, 0, 0, "-", "bluerobotics_navigator"]], "bluerobotics_navigator": [[0, 1, 1, "", "ADCData"], [0, 1, 1, "", "AdcChannel"], [0, 1, 1, "", "AxisData"], [0, 1, 1, "", "PwmChannel"], [0, 1, 1, "", "UserLed"], [0, 3, 1, "", "get_led"], [0, 3, 1, "", "get_pwm_enable"], [0, 3, 1, "", "init"], [0, 3, 1, "", "read_accel"], [0, 3, 1, "", "read_adc"], [0, 3, 1, "", "read_adc_all"], [0, 3, 1, "", "read_gyro"], [0, 3, 1, "", "read_mag"], [0, 3, 1, "", "read_pressure"], [0, 3, 1, "", "read_temp"], [0, 3, 1, "", "self_test"], [0, 3, 1, "", "set_led"], [0, 3, 1, "", "set_led_all"], [0, 3, 1, "", "set_led_toggle"], [0, 3, 1, "", "set_neopixel"], [0, 3, 1, "", "set_pwm_channel_value"], [0, 3, 1, "", "set_pwm_channels_value"], [0, 3, 1, "", "set_pwm_channels_values"], [0, 3, 1, "", "set_pwm_enable"], [0, 3, 1, "", "set_pwm_freq_hz"], [0, 3, 1, "", "set_pwm_freq_prescale"]], "bluerobotics_navigator.ADCData": [[0, 2, 1, "", "channel"]], "bluerobotics_navigator.AdcChannel": [[0, 2, 1, "", "Ch0"], [0, 2, 1, "", "Ch1"], [0, 2, 1, "", "Ch2"], [0, 2, 1, "", "Ch3"]], "bluerobotics_navigator.AxisData": [[0, 2, 1, "", "x"], [0, 2, 1, "", "y"], [0, 2, 1, "", "z"]], "bluerobotics_navigator.PwmChannel": [[0, 2, 1, "", "All"], [0, 2, 1, "", "Ch1"], [0, 2, 1, "", "Ch10"], [0, 2, 1, "", "Ch11"], [0, 2, 1, "", "Ch12"], [0, 2, 1, "", "Ch13"], [0, 2, 1, "", "Ch14"], [0, 2, 1, "", "Ch15"], [0, 2, 1, "", "Ch16"], [0, 2, 1, "", "Ch2"], [0, 2, 1, "", "Ch3"], [0, 2, 1, "", "Ch4"], [0, 2, 1, "", "Ch5"], [0, 2, 1, "", "Ch6"], [0, 2, 1, "", "Ch7"], [0, 2, 1, "", "Ch8"], [0, 2, 1, "", "Ch9"]], "bluerobotics_navigator.UserLed": [[0, 2, 1, "", "Led1"], [0, 2, 1, "", "Led2"], [0, 2, 1, "", "Led3"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:attribute", "3": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "function", "Python function"]}, "titleterms": {"bluerobot": 0, "": 0, "navig": 0, "librari": 0}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 60}, "alltitles": {"BlueRobotics\u2019s Navigator Library": [[0, "bluerobotics-s-navigator-library"]]}, "indexentries": {"adcdata (class in bluerobotics_navigator)": [[0, "bluerobotics_navigator.ADCData"]], "adcchannel (class in bluerobotics_navigator)": [[0, "bluerobotics_navigator.AdcChannel"]], "all (bluerobotics_navigator.pwmchannel attribute)": [[0, "bluerobotics_navigator.PwmChannel.All"]], "axisdata (class in bluerobotics_navigator)": [[0, "bluerobotics_navigator.AxisData"]], "ch0 (bluerobotics_navigator.adcchannel attribute)": [[0, "bluerobotics_navigator.AdcChannel.Ch0"]], "ch1 (bluerobotics_navigator.adcchannel attribute)": [[0, "bluerobotics_navigator.AdcChannel.Ch1"]], "ch1 (bluerobotics_navigator.pwmchannel attribute)": [[0, "bluerobotics_navigator.PwmChannel.Ch1"]], "ch10 (bluerobotics_navigator.pwmchannel attribute)": [[0, "bluerobotics_navigator.PwmChannel.Ch10"]], "ch11 (bluerobotics_navigator.pwmchannel attribute)": [[0, "bluerobotics_navigator.PwmChannel.Ch11"]], "ch12 (bluerobotics_navigator.pwmchannel attribute)": [[0, "bluerobotics_navigator.PwmChannel.Ch12"]], "ch13 (bluerobotics_navigator.pwmchannel attribute)": [[0, "bluerobotics_navigator.PwmChannel.Ch13"]], "ch14 (bluerobotics_navigator.pwmchannel attribute)": [[0, "bluerobotics_navigator.PwmChannel.Ch14"]], "ch15 (bluerobotics_navigator.pwmchannel attribute)": [[0, "bluerobotics_navigator.PwmChannel.Ch15"]], "ch16 (bluerobotics_navigator.pwmchannel attribute)": [[0, "bluerobotics_navigator.PwmChannel.Ch16"]], "ch2 (bluerobotics_navigator.adcchannel attribute)": [[0, "bluerobotics_navigator.AdcChannel.Ch2"]], "ch2 (bluerobotics_navigator.pwmchannel attribute)": [[0, "bluerobotics_navigator.PwmChannel.Ch2"]], "ch3 (bluerobotics_navigator.adcchannel attribute)": [[0, "bluerobotics_navigator.AdcChannel.Ch3"]], "ch3 (bluerobotics_navigator.pwmchannel attribute)": [[0, "bluerobotics_navigator.PwmChannel.Ch3"]], "ch4 (bluerobotics_navigator.pwmchannel attribute)": [[0, "bluerobotics_navigator.PwmChannel.Ch4"]], "ch5 (bluerobotics_navigator.pwmchannel attribute)": [[0, "bluerobotics_navigator.PwmChannel.Ch5"]], "ch6 (bluerobotics_navigator.pwmchannel attribute)": [[0, "bluerobotics_navigator.PwmChannel.Ch6"]], "ch7 (bluerobotics_navigator.pwmchannel attribute)": [[0, "bluerobotics_navigator.PwmChannel.Ch7"]], "ch8 (bluerobotics_navigator.pwmchannel attribute)": [[0, "bluerobotics_navigator.PwmChannel.Ch8"]], "ch9 (bluerobotics_navigator.pwmchannel attribute)": [[0, "bluerobotics_navigator.PwmChannel.Ch9"]], "led1 (bluerobotics_navigator.userled attribute)": [[0, "bluerobotics_navigator.UserLed.Led1"]], "led2 (bluerobotics_navigator.userled attribute)": [[0, "bluerobotics_navigator.UserLed.Led2"]], "led3 (bluerobotics_navigator.userled attribute)": [[0, "bluerobotics_navigator.UserLed.Led3"]], "pwmchannel (class in bluerobotics_navigator)": [[0, "bluerobotics_navigator.PwmChannel"]], "userled (class in bluerobotics_navigator)": [[0, "bluerobotics_navigator.UserLed"]], "bluerobotics_navigator": [[0, "module-bluerobotics_navigator"]], "channel (bluerobotics_navigator.adcdata attribute)": [[0, "bluerobotics_navigator.ADCData.channel"]], "get_led() (in module bluerobotics_navigator)": [[0, "bluerobotics_navigator.get_led"]], "get_pwm_enable() (in module bluerobotics_navigator)": [[0, "bluerobotics_navigator.get_pwm_enable"]], "init() (in module bluerobotics_navigator)": [[0, "bluerobotics_navigator.init"]], "module": [[0, "module-bluerobotics_navigator"]], "read_accel() (in module bluerobotics_navigator)": [[0, "bluerobotics_navigator.read_accel"]], "read_adc() (in module bluerobotics_navigator)": [[0, "bluerobotics_navigator.read_adc"]], "read_adc_all() (in module bluerobotics_navigator)": [[0, "bluerobotics_navigator.read_adc_all"]], "read_gyro() (in module bluerobotics_navigator)": [[0, "bluerobotics_navigator.read_gyro"]], "read_mag() (in module bluerobotics_navigator)": [[0, "bluerobotics_navigator.read_mag"]], "read_pressure() (in module bluerobotics_navigator)": [[0, "bluerobotics_navigator.read_pressure"]], "read_temp() (in module bluerobotics_navigator)": [[0, "bluerobotics_navigator.read_temp"]], "self_test() (in module bluerobotics_navigator)": [[0, "bluerobotics_navigator.self_test"]], "set_led() (in module bluerobotics_navigator)": [[0, "bluerobotics_navigator.set_led"]], "set_led_all() (in module bluerobotics_navigator)": [[0, "bluerobotics_navigator.set_led_all"]], "set_led_toggle() (in module bluerobotics_navigator)": [[0, "bluerobotics_navigator.set_led_toggle"]], "set_neopixel() (in module bluerobotics_navigator)": [[0, "bluerobotics_navigator.set_neopixel"]], "set_pwm_channel_value() (in module bluerobotics_navigator)": [[0, "bluerobotics_navigator.set_pwm_channel_value"]], "set_pwm_channels_value() (in module bluerobotics_navigator)": [[0, "bluerobotics_navigator.set_pwm_channels_value"]], "set_pwm_channels_values() (in module bluerobotics_navigator)": [[0, "bluerobotics_navigator.set_pwm_channels_values"]], "set_pwm_enable() (in module bluerobotics_navigator)": [[0, "bluerobotics_navigator.set_pwm_enable"]], "set_pwm_freq_hz() (in module bluerobotics_navigator)": [[0, "bluerobotics_navigator.set_pwm_freq_hz"]], "set_pwm_freq_prescale() (in module bluerobotics_navigator)": [[0, "bluerobotics_navigator.set_pwm_freq_prescale"]], "x (bluerobotics_navigator.axisdata attribute)": [[0, "bluerobotics_navigator.AxisData.x"]], "y (bluerobotics_navigator.axisdata attribute)": [[0, "bluerobotics_navigator.AxisData.y"]], "z (bluerobotics_navigator.axisdata attribute)": [[0, "bluerobotics_navigator.AxisData.z"]]}})
\ No newline at end of file