Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@mkalkbrenner
mkalkbrenner committed Jan 26, 2024
1 parent 49ee1c9 commit 9526458
Show file tree
Hide file tree
Showing 14 changed files with 333 additions and 245 deletions.
298 changes: 152 additions & 146 deletions docs/html/_ze_d_m_d_8h_source.html
View file

Large diffs are not rendered by default.

96 changes: 47 additions & 49 deletions docs/html/_ze_d_m_d_comm_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -195,56 +195,54 @@
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> </div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> <span class="keywordtype">void</span> Run();</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> <span class="keywordtype">void</span> QueueCommand(<span class="keywordtype">char</span> command, uint8_t* buffer, <span class="keywordtype">int</span> size, uint16_t width,</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> uint16_t height);</div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> <span class="keywordtype">void</span> QueueRgb565Command(<span class="keywordtype">char</span> command, uint16_t* buffer, <span class="keywordtype">int</span> size,</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> uint16_t width, uint16_t height);</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> <span class="keywordtype">void</span> QueueCommand(<span class="keywordtype">char</span> command, uint8_t* buffer, <span class="keywordtype">int</span> size,</div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> int8_t streamId = -1, <span class="keywordtype">bool</span> delayed = <span class="keyword">false</span>);</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> <span class="keywordtype">void</span> QueueCommand(<span class="keywordtype">char</span> command);</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> <span class="keywordtype">void</span> QueueCommand(<span class="keywordtype">char</span> command, uint8_t value);</div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> <span class="keywordtype">bool</span> FillDelayed();</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> </div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> uint16_t GetWidth();</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> uint16_t GetHeight();</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> </div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> <span class="keyword">protected</span>:</div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> StreamBytes(<a class="code hl_struct" href="struct_ze_d_m_d_frame.html">ZeDMDFrame</a>* pFrame);</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> Reset();</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> </div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> uint16_t m_zonesBytesLimit = 0;</div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> uint8_t m_zoneWidth = 8;</div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> uint8_t m_zoneHeight = 4;</div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span> </div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span> <span class="keywordtype">void</span> Log(<span class="keyword">const</span> <span class="keywordtype">char</span>* format, ...);</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> uint16_t height, uint8_t bytes = 3);</div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> <span class="keywordtype">void</span> QueueCommand(<span class="keywordtype">char</span> command, uint8_t* buffer, <span class="keywordtype">int</span> size,</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> int8_t streamId = -1, <span class="keywordtype">bool</span> delayed = <span class="keyword">false</span>);</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> <span class="keywordtype">void</span> QueueCommand(<span class="keywordtype">char</span> command);</div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> <span class="keywordtype">void</span> QueueCommand(<span class="keywordtype">char</span> command, uint8_t value);</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> <span class="keywordtype">bool</span> FillDelayed();</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> </div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> uint16_t GetWidth();</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> uint16_t GetHeight();</div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> </div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> <span class="keyword">protected</span>:</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> StreamBytes(<a class="code hl_struct" href="struct_ze_d_m_d_frame.html">ZeDMDFrame</a>* pFrame);</div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> Reset();</div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> </div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> uint16_t m_zonesBytesLimit = 0;</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> uint8_t m_zoneWidth = 8;</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> uint8_t m_zoneHeight = 4;</div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> </div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span> <span class="keywordtype">void</span> Log(<span class="keyword">const</span> <span class="keywordtype">char</span>* format, ...);</div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> </div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span> <span class="keywordtype">bool</span> Connect(<span class="keywordtype">char</span>* pName);</div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> </div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span> <span class="keywordtype">bool</span> Connect(<span class="keywordtype">char</span>* pName);</div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span> </div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> ZeDMD_LogCallback m_logCallback = <span class="keyword">nullptr</span>;</div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> <span class="keyword">const</span> <span class="keywordtype">void</span>* m_logUserData = <span class="keyword">nullptr</span>;</div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> uint64_t m_zoneHashes[128] = {0};</div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span> uint16_t m_width = 128;</div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> uint16_t m_height = 32;</div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span> int8_t m_streamId = -1;</div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span> int8_t m_lastStreamId = -1;</div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span> uint8_t m_flowControlCounter = 0;</div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span> <span class="keywordtype">char</span> m_ignoredDevices[10][32] = {0};</div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span> uint8_t m_ignoredDevicesCounter = 0;</div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span> <span class="keywordtype">char</span> m_device[32] = {0};</div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span><span class="preprocessor">#if !((defined(__APPLE__) &amp;&amp; ((defined(TARGET_OS_IOS) &amp;&amp; TARGET_OS_IOS) || \</span></div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span><span class="preprocessor"> (defined(TARGET_OS_TV) &amp;&amp; TARGET_OS_TV))) || \</span></div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span><span class="preprocessor"> defined(__ANDROID__))</span></div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span> <span class="keyword">struct </span>sp_port* m_pSerialPort;</div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span> <span class="keyword">struct </span>sp_port_config* m_pSerialPortConfig;</div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span> std::queue&lt;ZeDMDFrame&gt; m_frames;</div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span> std::thread* m_pThread;</div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno"> 154</span> std::mutex m_frameQueueMutex;</div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno"> 155</span> uint8_t m_frameCounter = 0;</div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno"> 156</span> std::queue&lt;ZeDMDFrame&gt; m_delayedFrames;</div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno"> 157</span> std::mutex m_delayedFrameMutex;</div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno"> 158</span> <span class="keywordtype">bool</span> m_delayedFrameReady = <span class="keyword">false</span>;</div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno"> 159</span>};</div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span> ZeDMD_LogCallback m_logCallback = <span class="keyword">nullptr</span>;</div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span> <span class="keyword">const</span> <span class="keywordtype">void</span>* m_logUserData = <span class="keyword">nullptr</span>;</div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> uint64_t m_zoneHashes[128] = {0};</div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> uint16_t m_width = 128;</div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> uint16_t m_height = 32;</div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span> int8_t m_streamId = -1;</div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> int8_t m_lastStreamId = -1;</div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span> uint8_t m_flowControlCounter = 0;</div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span> <span class="keywordtype">char</span> m_ignoredDevices[10][32] = {0};</div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span> uint8_t m_ignoredDevicesCounter = 0;</div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span> <span class="keywordtype">char</span> m_device[32] = {0};</div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span><span class="preprocessor">#if !((defined(__APPLE__) &amp;&amp; ((defined(TARGET_OS_IOS) &amp;&amp; TARGET_OS_IOS) || \</span></div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span><span class="preprocessor"> (defined(TARGET_OS_TV) &amp;&amp; TARGET_OS_TV))) || \</span></div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span><span class="preprocessor"> defined(__ANDROID__))</span></div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span> <span class="keyword">struct </span>sp_port* m_pSerialPort;</div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span> <span class="keyword">struct </span>sp_port_config* m_pSerialPortConfig;</div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span> std::queue&lt;ZeDMDFrame&gt; m_frames;</div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span> std::thread* m_pThread;</div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span> std::mutex m_frameQueueMutex;</div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span> uint8_t m_frameCounter = 0;</div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno"> 154</span> std::queue&lt;ZeDMDFrame&gt; m_delayedFrames;</div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno"> 155</span> std::mutex m_delayedFrameMutex;</div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno"> 156</span> <span class="keywordtype">bool</span> m_delayedFrameReady = <span class="keyword">false</span>;</div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno"> 157</span>};</div>
</div>
<div class="ttc" id="aclass_ze_d_m_d_comm_html"><div class="ttname"><a href="class_ze_d_m_d_comm.html">ZeDMDComm</a></div><div class="ttdef"><b>Definition</b> ZeDMDComm.h:89</div></div>
<div class="ttc" id="astruct_ze_d_m_d_frame_html"><div class="ttname"><a href="struct_ze_d_m_d_frame.html">ZeDMDFrame</a></div><div class="ttdef"><b>Definition</b> ZeDMDComm.h:63</div></div>
Expand Down
Loading

0 comments on commit 9526458

Please sign in to comment.