Skip to content

Commit

Permalink
Version 0.5.1
Browse files Browse the repository at this point in the history
* New example added: Simple Clock
* Fixes in documentation and comments
* NixieOs library 0.2.0 is required
  • Loading branch information
lexus2k committed May 21, 2017
1 parent 4ab74f7 commit cda1930
Show file tree
Hide file tree
Showing 126 changed files with 763 additions and 1,750 deletions.
19 changes: 9 additions & 10 deletions docs/annotated.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Nixie Library
&#160;<span id="projectnumber">0.2.0</span>
&#160;<span id="projectnumber">0.5.1</span>
</div>
<div id="projectbrief">Nixie Library to develop Nixie Clock</div>
</td>
Expand Down Expand Up @@ -75,15 +75,14 @@
<tr id="row_6_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nixie_h_t_u21.html" target="_self">NixieHTU21</a></td><td class="desc"></td></tr>
<tr id="row_7_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nixie_ldr_gl5528.html" target="_self">NixieLdrGl5528</a></td><td class="desc"><a class="el" href="class_nixie_ldr_gl5528.html" title="NixieLdrGl5528 interacts with light sensor. ">NixieLdrGl5528</a> interacts with light sensor </td></tr>
<tr id="row_8_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nixie_led.html" target="_self">NixieLed</a></td><td class="desc"></td></tr>
<tr id="row_9_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nixie_library.html" target="_self">NixieLibrary</a></td><td class="desc"></td></tr>
<tr id="row_10_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_nixie_melody.html" target="_self">NixieMelody</a></td><td class="desc"></td></tr>
<tr id="row_11_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nixie_pwm_rgb_led.html" target="_self">NixiePwmRgbLed</a></td><td class="desc"></td></tr>
<tr id="row_12_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nixie_soft_rgb_led.html" target="_self">NixieSoftRgbLed</a></td><td class="desc"></td></tr>
<tr id="row_13_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nixie_tube.html" target="_self">NixieTube</a></td><td class="desc"></td></tr>
<tr id="row_14_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_simple_client_i2c.html" target="_self">SimpleClientI2c</a></td><td class="desc"></td></tr>
<tr id="row_15_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_s_nixie_color.html" target="_self">SNixieColor</a></td><td class="desc"></td></tr>
<tr id="row_16_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_s_nixie_sampling_note.html" target="_self">SNixieSamplingNote</a></td><td class="desc"></td></tr>
<tr id="row_17_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_s_nixie_tempo_note.html" target="_self">SNixieTempoNote</a></td><td class="desc"></td></tr>
<tr id="row_9_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_nixie_melody.html" target="_self">NixieMelody</a></td><td class="desc"></td></tr>
<tr id="row_10_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nixie_pwm_rgb_led.html" target="_self">NixiePwmRgbLed</a></td><td class="desc"></td></tr>
<tr id="row_11_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nixie_soft_rgb_led.html" target="_self">NixieSoftRgbLed</a></td><td class="desc"></td></tr>
<tr id="row_12_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nixie_tube.html" target="_self">NixieTube</a></td><td class="desc"></td></tr>
<tr id="row_13_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_simple_client_i2c.html" target="_self">SimpleClientI2c</a></td><td class="desc"></td></tr>
<tr id="row_14_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_s_nixie_color.html" target="_self">SNixieColor</a></td><td class="desc"></td></tr>
<tr id="row_15_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_s_nixie_sampling_note.html" target="_self">SNixieSamplingNote</a></td><td class="desc"></td></tr>
<tr id="row_16_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_s_nixie_tempo_note.html" target="_self">SNixieTempoNote</a></td><td class="desc"></td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
Expand Down
2 changes: 1 addition & 1 deletion docs/class_ds3231-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Nixie Library
&#160;<span id="projectnumber">0.2.0</span>
&#160;<span id="projectnumber">0.5.1</span>
</div>
<div id="projectbrief">Nixie Library to develop Nixie Clock</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/class_ds3231.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Nixie Library
&#160;<span id="projectnumber">0.2.0</span>
&#160;<span id="projectnumber">0.5.1</span>
</div>
<div id="projectbrief">Nixie Library to develop Nixie Clock</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/class_k155_i_d1-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Nixie Library
&#160;<span id="projectnumber">0.2.0</span>
&#160;<span id="projectnumber">0.5.1</span>
</div>
<div id="projectbrief">Nixie Library to develop Nixie Clock</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/class_k155_i_d1.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Nixie Library
&#160;<span id="projectnumber">0.2.0</span>
&#160;<span id="projectnumber">0.5.1</span>
</div>
<div id="projectbrief">Nixie Library to develop Nixie Clock</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/class_nixie_analog_buttons-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Nixie Library
&#160;<span id="projectnumber">0.2.0</span>
&#160;<span id="projectnumber">0.5.1</span>
</div>
<div id="projectbrief">Nixie Library to develop Nixie Clock</div>
</td>
Expand Down
45 changes: 24 additions & 21 deletions docs/class_nixie_analog_buttons.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Nixie Library
&#160;<span id="projectnumber">0.2.0</span>
&#160;<span id="projectnumber">0.5.1</span>
</div>
<div id="projectbrief">Nixie Library to develop Nixie Clock</div>
</td>
Expand Down Expand Up @@ -67,6 +67,8 @@
<div class="title">NixieAnalogButtons Class Reference</div> </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="nixie__buttons_8h_source.html">nixie_buttons.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
Expand Down Expand Up @@ -110,8 +112,9 @@
<tr class="separator:aae1c79db6ffd5c8c632b41c38a69bf4c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p>Definition at line <a class="el" href="nixie__buttons_8h_source.html#l00041">41</a> of file <a class="el" href="nixie__buttons_8h_source.html">nixie_buttons.h</a>.</p>
<div class="textblock"><p>Class to process ADC line, which ADC buttons are connected to. </p>

<p>Definition at line <a class="el" href="nixie__buttons_8h_source.html#l00044">44</a> of file <a class="el" href="nixie__buttons_8h_source.html">nixie_buttons.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a60879cbb64788bfdf4b5ece9feaf885f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a60879cbb64788bfdf4b5ece9feaf885f">&sect;&nbsp;</a></span>NixieAnalogButtons()</h2>
Expand Down Expand Up @@ -161,7 +164,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a60879cbb64788bfdf4b5ece9
</dd>
</dl>

<p>Definition at line <a class="el" href="nixie__buttons_8h_source.html#l00052">52</a> of file <a class="el" href="nixie__buttons_8h_source.html">nixie_buttons.h</a>.</p>
<p>Definition at line <a class="el" href="nixie__buttons_8h_source.html#l00055">55</a> of file <a class="el" href="nixie__buttons_8h_source.html">nixie_buttons.h</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -190,7 +193,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a0386eaac926e10c2f0b42f3a
</div><div class="memdoc">
<p>Disables Up action if button is pressed now. Useful to prevent button release action, when we need to process hold state only. </p>

<p>Definition at line <a class="el" href="nixie__buttons_8h_source.html#l00150">150</a> of file <a class="el" href="nixie__buttons_8h_source.html">nixie_buttons.h</a>.</p>
<p>Definition at line <a class="el" href="nixie__buttons_8h_source.html#l00153">153</a> of file <a class="el" href="nixie__buttons_8h_source.html">nixie_buttons.h</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -218,7 +221,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a00f537cbe025660d38142316
</div><div class="memdoc">
<p>Returns number of milliseconds passed between button down and up events. To find the button id, which this value is valid for, call isButtonUp method. </p>

<p>Definition at line <a class="el" href="nixie__buttons_8h_source.html#l00144">144</a> of file <a class="el" href="nixie__buttons_8h_source.html">nixie_buttons.h</a>.</p>
<p>Definition at line <a class="el" href="nixie__buttons_8h_source.html#l00147">147</a> of file <a class="el" href="nixie__buttons_8h_source.html">nixie_buttons.h</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -264,7 +267,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a0f95dd1d7788a0a7cb1e3150
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 - if n doesn't correspond to button id, being held number of milliseconds between button down event and specified time for N button. </dd></dl>

<p>Definition at line <a class="el" href="nixie__buttons_8h_source.html#l00159">159</a> of file <a class="el" href="nixie__buttons_8h_source.html">nixie_buttons.h</a>.</p>
<p>Definition at line <a class="el" href="nixie__buttons_8h_source.html#l00162">162</a> of file <a class="el" href="nixie__buttons_8h_source.html">nixie_buttons.h</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -293,7 +296,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#adce37b37fdecc59a3dc78058
</div><div class="memdoc">
<p>Initializes state of the object. Must be called in setup() function. </p>

<p>Definition at line <a class="el" href="nixie__buttons_8h_source.html#l00062">62</a> of file <a class="el" href="nixie__buttons_8h_source.html">nixie_buttons.h</a>.</p>
<p>Definition at line <a class="el" href="nixie__buttons_8h_source.html#l00065">65</a> of file <a class="el" href="nixie__buttons_8h_source.html">nixie_buttons.h</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -322,7 +325,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a531bbfad470da3bcea708499
</div><div class="memdoc">
<p>Returns true if button is being down </p>

<p>Definition at line <a class="el" href="nixie__buttons_8h_source.html#l00128">128</a> of file <a class="el" href="nixie__buttons_8h_source.html">nixie_buttons.h</a>.</p>
<p>Definition at line <a class="el" href="nixie__buttons_8h_source.html#l00131">131</a> of file <a class="el" href="nixie__buttons_8h_source.html">nixie_buttons.h</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -351,7 +354,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ab002057db2c6380dfd5c84bc
</div><div class="memdoc">
<p>Returns true if button is being up </p>

<p>Definition at line <a class="el" href="nixie__buttons_8h_source.html#l00133">133</a> of file <a class="el" href="nixie__buttons_8h_source.html">nixie_buttons.h</a>.</p>
<p>Definition at line <a class="el" href="nixie__buttons_8h_source.html#l00136">136</a> of file <a class="el" href="nixie__buttons_8h_source.html">nixie_buttons.h</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -397,7 +400,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a8e34dede66f09a8c1785d78b
</dl>
<dl class="section return"><dt>Returns</dt><dd>true or false </dd></dl>

<p>Definition at line <a class="el" href="nixie__buttons_8h_source.html#l00097">97</a> of file <a class="el" href="nixie__buttons_8h_source.html">nixie_buttons.h</a>.</p>
<p>Definition at line <a class="el" href="nixie__buttons_8h_source.html#l00100">100</a> of file <a class="el" href="nixie__buttons_8h_source.html">nixie_buttons.h</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -450,7 +453,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a29da38313c70eb046802995b
</dl>
<dl class="section return"><dt>Returns</dt><dd>true or false </dd></dl>

<p>Definition at line <a class="el" href="nixie__buttons_8h_source.html#l00106">106</a> of file <a class="el" href="nixie__buttons_8h_source.html">nixie_buttons.h</a>.</p>
<p>Definition at line <a class="el" href="nixie__buttons_8h_source.html#l00109">109</a> of file <a class="el" href="nixie__buttons_8h_source.html">nixie_buttons.h</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -485,7 +488,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a11e31cf79bd4214a73f77011
</dl>
<dl class="section return"><dt>Returns</dt><dd>true or false </dd></dl>

<p>Definition at line <a class="el" href="nixie__buttons_8h_source.html#l00089">89</a> of file <a class="el" href="nixie__buttons_8h_source.html">nixie_buttons.h</a>.</p>
<p>Definition at line <a class="el" href="nixie__buttons_8h_source.html#l00092">92</a> of file <a class="el" href="nixie__buttons_8h_source.html">nixie_buttons.h</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -531,7 +534,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a1c7a0982fb72a6b2e5f87669
</dl>
<dl class="section return"><dt>Returns</dt><dd>true or false </dd></dl>

<p>Definition at line <a class="el" href="nixie__buttons_8h_source.html#l00123">123</a> of file <a class="el" href="nixie__buttons_8h_source.html">nixie_buttons.h</a>.</p>
<p>Definition at line <a class="el" href="nixie__buttons_8h_source.html#l00126">126</a> of file <a class="el" href="nixie__buttons_8h_source.html">nixie_buttons.h</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -559,7 +562,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a2644c79b049e321299ccba7e
</div><div class="memdoc">
<p>Returns true whever there are all buttons are up now </p>

<p>Definition at line <a class="el" href="nixie__buttons_8h_source.html#l00138">138</a> of file <a class="el" href="nixie__buttons_8h_source.html">nixie_buttons.h</a>.</p>
<p>Definition at line <a class="el" href="nixie__buttons_8h_source.html#l00141">141</a> of file <a class="el" href="nixie__buttons_8h_source.html">nixie_buttons.h</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -594,7 +597,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a8c3fa33ccd6bba44753eeb41
</dl>
<dl class="section return"><dt>Returns</dt><dd>true or false </dd></dl>

<p>Definition at line <a class="el" href="nixie__buttons_8h_source.html#l00069">69</a> of file <a class="el" href="nixie__buttons_8h_source.html">nixie_buttons.h</a>.</p>
<p>Definition at line <a class="el" href="nixie__buttons_8h_source.html#l00072">72</a> of file <a class="el" href="nixie__buttons_8h_source.html">nixie_buttons.h</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -622,7 +625,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a471fa668e6d26008829ba175
</div><div class="memdoc">
<p>Returns true if any button or their combination is pressed. </p><dl class="section return"><dt>Returns</dt><dd>true or false </dd></dl>

<p>Definition at line <a class="el" href="nixie__buttons_8h_source.html#l00075">75</a> of file <a class="el" href="nixie__buttons_8h_source.html">nixie_buttons.h</a>.</p>
<p>Definition at line <a class="el" href="nixie__buttons_8h_source.html#l00078">78</a> of file <a class="el" href="nixie__buttons_8h_source.html">nixie_buttons.h</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -667,7 +670,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#af068026b45f0adcd134410d2
</dd>
</dl>

<p>Definition at line <a class="el" href="nixie__buttons_8h_source.html#l00082">82</a> of file <a class="el" href="nixie__buttons_8h_source.html">nixie_buttons.h</a>.</p>
<p>Definition at line <a class="el" href="nixie__buttons_8h_source.html#l00085">85</a> of file <a class="el" href="nixie__buttons_8h_source.html">nixie_buttons.h</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -701,7 +704,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#aa3351ece21b500e23f070af7
</dd>
</dl>

<p>Definition at line <a class="el" href="nixie__buttons_8h_source.html#l00174">174</a> of file <a class="el" href="nixie__buttons_8h_source.html">nixie_buttons.h</a>.</p>
<p>Definition at line <a class="el" href="nixie__buttons_8h_source.html#l00177">177</a> of file <a class="el" href="nixie__buttons_8h_source.html">nixie_buttons.h</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -735,7 +738,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#aae1c79db6ffd5c8c632b41c3
</dd>
</dl>

<p>Definition at line <a class="el" href="nixie__buttons_8h_source.html#l00189">189</a> of file <a class="el" href="nixie__buttons_8h_source.html">nixie_buttons.h</a>.</p>
<p>Definition at line <a class="el" href="nixie__buttons_8h_source.html#l00192">192</a> of file <a class="el" href="nixie__buttons_8h_source.html">nixie_buttons.h</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -769,7 +772,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a131f0b153d57044411251065
</dd>
</dl>

<p>Definition at line <a class="el" href="nixie__buttons_8h_source.html#l00181">181</a> of file <a class="el" href="nixie__buttons_8h_source.html">nixie_buttons.h</a>.</p>
<p>Definition at line <a class="el" href="nixie__buttons_8h_source.html#l00184">184</a> of file <a class="el" href="nixie__buttons_8h_source.html">nixie_buttons.h</a>.</p>

</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/class_nixie_audio_channel-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Nixie Library
&#160;<span id="projectnumber">0.2.0</span>
&#160;<span id="projectnumber">0.5.1</span>
</div>
<div id="projectbrief">Nixie Library to develop Nixie Clock</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/class_nixie_audio_channel.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Nixie Library
&#160;<span id="projectnumber">0.2.0</span>
&#160;<span id="projectnumber">0.5.1</span>
</div>
<div id="projectbrief">Nixie Library to develop Nixie Clock</div>
</td>
Expand Down
Loading

0 comments on commit cda1930

Please sign in to comment.