Skip to content

Commit

Permalink
Updated Doxygen documentations.
Browse files Browse the repository at this point in the history
  • Loading branch information
@nthnn
nthnn committed May 16, 2024
1 parent f62bd36 commit 2d337d7
Showing 1 changed file with 14 additions and 48 deletions.
62 changes: 14 additions & 48 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -175,11 +175,11 @@ <h2><a class="anchor" id="autotoc_md6"></a>
<div class="line"><span class="preprocessor">#define TFT_CS 5 </span><span class="comment">// TFT SPI select pin</span></div>
<div class="line"><span class="preprocessor">#define TFT_SCK 18 </span><span class="comment">// TFT SPI clock pin</span></div>
<div class="line"><span class="preprocessor">#define TFT_MOSI 23 </span><span class="comment">// TFT SPI MOSI pin</span></div>
<div class="line"><span class="preprocessor">#define TFT_DC 2 </span><span class="comment">// TFT data/command pin</span></div>
<div class="line"><span class="preprocessor">#define TFT_DC 15 </span><span class="comment">// TFT data/command pin</span></div>
<div class="line"><span class="preprocessor">#define TFT_RESET 4 </span><span class="comment">// TFT reset pin</span></div>
<div class="line"><span class="preprocessor">#define TFT_SPIBUS VSPI_HOST </span><span class="comment">// TFT SPI bus</span></div>
<div class="line"> </div>
<div class="line"><span class="preprocessor">#define SD_CS 15 </span><span class="comment">// SD card chip select pin</span></div>
<div class="line"><span class="preprocessor">#define SD_CS 2 </span><span class="comment">// SD card chip select pin</span></div>
<div class="line"><span class="preprocessor">#define SD_SCK 14 </span><span class="comment">// SD card SPI clock pin</span></div>
<div class="line"><span class="preprocessor">#define SD_MOSI 13 </span><span class="comment">// SD card SPI MOSI pin</span></div>
<div class="line"><span class="preprocessor">#define SD_MISO 12 </span><span class="comment">// SD card SPI MISO pin</span></div>
Expand All @@ -191,12 +191,7 @@ <h2><a class="anchor" id="autotoc_md6"></a>
<div class="line"><span class="comment">// SPI instance for SD card</span></div>
<div class="line">SPIClass sdSpi(HSPI);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Rishka virtual machine instance</span></div>
<div class="line">RishkaVM* vm;</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> setup() {</div>
<div class="line"> Serial.begin(115200);</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Initialize TFT display</span></div>
<div class="line"> DisplayController.begin(TFT_SCK, TFT_MOSI, TFT_DC, TFT_RESET, TFT_CS, TFT_SPIBUS);</div>
<div class="line"> DisplayController.setResolution(<span class="stringliteral">&quot;\&quot;TFT_320x240\&quot; 320 240&quot;</span>);</div>
Expand All @@ -210,55 +205,26 @@ <h2><a class="anchor" id="autotoc_md6"></a>
<div class="line"> sdSpi.begin(SD_SCK, SD_MISO, SD_MOSI, SD_CS);</div>
<div class="line"> <span class="keywordflow">if</span>(!SD.begin(SD_CS, sdSpi, 80000000)) {</div>
<div class="line"> Terminal.println(<span class="stringliteral">&quot;Card \e[94mMount\e[97m Failed&quot;</span>);</div>
<div class="line"> <span class="keywordflow">while</span>(<span class="keyword">true</span>);</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span>(!psramInit()) {</div>
<div class="line"> <span class="comment">// If PSRAM initialization fails,</span></div>
<div class="line"> <span class="comment">// print error message and halt execution</span></div>
<div class="line"> Terminal.println(<span class="stringliteral">&quot;\e[94mCannot\e[97m initialize PSRAM.&quot;</span>);</div>
<div class="line"> <span class="keywordflow">while</span>(<span class="keyword">true</span>);</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Initialize the Rishka VM instance.</span></div>
<div class="line"> vm = <span class="keyword">new</span> RishkaVM();</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Print prompt</span></div>
<div class="line"> Terminal.print(<span class="stringliteral">&quot;\e[32m#~\e[97m &quot;</span>);</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> loop() {</div>
<div class="line"> <span class="comment">// Check if there is data available to read from serial port</span></div>
<div class="line"> <span class="keywordflow">if</span>(!Serial.available())</div>
<div class="line"> <span class="keywordflow">return</span>;</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Read input from serial port</span></div>
<div class="line"> String input = Serial.readString();</div>
<div class="line"> <span class="comment">// Echo input back to serial port</span></div>
<div class="line"> Terminal.print(<span class="stringliteral">&quot;\e[93m&quot;</span>);</div>
<div class="line"> Terminal.print(input);</div>
<div class="line"> Terminal.print(<span class="stringliteral">&quot;\r\e[97m&quot;</span>);</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Initialize Rishka virtual machine</span></div>
<div class="line"> <span class="comment">// Rishka virtual machine instance</span></div>
<div class="line"> RishkaVM* vm = <span class="keyword">new</span> RishkaVM();</div>
<div class="line"> <span class="comment">// Initialize Rishka VM</span></div>
<div class="line"> vm-&gt;initialize(&amp;Terminal);</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Attempt to load specified file into Rishka virtual machine</span></div>
<div class="line"> <span class="keywordflow">if</span>(!vm-&gt;loadFile(input.c_str())) {</div>
<div class="line"> <span class="comment">// If loading file fails, print error message and return</span></div>
<div class="line"> vm-&gt;panic(String(<span class="stringliteral">&quot;Failed to \e[94mload\e[97m specified file: &quot;</span> + input).c_str());</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Print prompt</span></div>
<div class="line"> Terminal.print(<span class="stringliteral">&quot;\r\e[32m#~\e[97m &quot;</span>);</div>
<div class="line"> <span class="keywordflow">return</span>;</div>
<div class="line"> }</div>
<div class="line"> <span class="keywordflow">if</span>(!vm-&gt;loadFile(<span class="stringliteral">&quot;/sysinfo.bin&quot;</span>))</div>
<div class="line"> vm-&gt;panic(<span class="stringliteral">&quot;Failed to \e[94mload\e[97m specified file.&quot;</span>);</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Run loaded program on Rishka virtual machine</span></div>
<div class="line"> <span class="comment">// Run loaded program</span></div>
<div class="line"> vm-&gt;run(0, NULL);</div>
<div class="line"> <span class="comment">// Reset Rishka virtual machine for next execution</span></div>
<div class="line"> <span class="comment">// Reset VM after program execution</span></div>
<div class="line"> vm-&gt;reset();</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Print prompt for next input</span></div>
<div class="line"> Terminal.print(<span class="stringliteral">&quot;\e[32m#~\e[97m &quot;</span>);</div>
<div class="line"><span class="keywordtype">void</span> loop() {</div>
<div class="line"> <span class="comment">// Delay to prevent continuous execution</span></div>
<div class="line"> vTaskDelay(10);</div>
<div class="line">}</div>
</div><!-- fragment --><h2><a class="anchor" id="autotoc_md8"></a>
Contributing</h2>
Expand Down

0 comments on commit 2d337d7

Please sign in to comment.