-
Notifications
You must be signed in to change notification settings - Fork 28
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
6/7/2020 release - see README.md for details
- Loading branch information
lorne smith
committed
Jun 8, 2020
1 parent
dcc6794
commit 4a0f70a
Showing
679 changed files
with
41,635 additions
and
4,151 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,177 @@ | ||
| <!DOCTYPE html> | ||
| <html> | ||
| <head> | ||
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> | ||
| <title>MAX78000 Documentation</title> | ||
| <style> | ||
| a:hover, a:focus { | ||
| color: #6e2585; | ||
| } | ||
| a:active, a:hover { | ||
| outline: 0; | ||
| } | ||
| a { | ||
| color: #00b2a9; | ||
| text-decoration: none; | ||
| } | ||
| body { | ||
| font-family: Arial,Helvetica,sans-serif; | ||
| color: #6c6f70; | ||
| } | ||
| h1 { | ||
| font-size: 150%; | ||
| color: #000; | ||
| } | ||
| h2 { | ||
| font-size: 125%; | ||
| color: #6e2585; | ||
| } | ||
| </style> | ||
| </head> | ||
|
|
||
| <body> | ||
| <h1>MAX78000 Documentation</h1> | ||
| <hr> | ||
|
|
||
| Please visit Maxim's MAX78000 GitHub repository for: | ||
| <ol> | ||
| <li><a href='https://github.com/MaximIntegratedAI'>The latest versions of all files</a></li> | ||
| <li><a href='https://github.com/MaximIntegratedAI/MaximAI_Documentation/blob/master/MAX78000_Evaluation_Kit/README.md'>Instructions for getting started with the evaluation kit</a></li> | ||
| </ol> | ||
|
|
||
| Additional information can be found in the following links. | ||
|
|
||
| <h2>SDK</h2> | ||
| <ul> | ||
| <li id='periph'></li> | ||
| <li>Toolchain</li> | ||
| <ul> | ||
| <li id='eclipse'></li> | ||
| <li id='gnu-arm'></li> | ||
| <li id='gnu-riscv'></li> | ||
| <li id='mingw'></li> | ||
| <li id='openocd'></li> | ||
| <li id='sbt'></li> | ||
| <li id='bmp-converter'></li> | ||
| <li id='free-rtos'></li> | ||
| </ul> | ||
| </ul> | ||
| <hr> | ||
|
|
||
| <h2>Example Applications</h2> | ||
| The following examples can be found in the <a href='../Examples/MAX78000'>Examples/MAX78000</a> directory of the SDK installation: | ||
| <ul> | ||
| <li><a href='../Examples/MAX78000/ADC/README.md'>ADC</a> - Analog-to-Digital Converter</li> | ||
| <li><a href='../Examples/MAX78000/AES/README.md'>AES</a> - Advanced Encryption Standard</li> | ||
| <li>CNN - Convolutional Neural Network</li> | ||
| <ul> | ||
| <li><a href='../Examples/MAX78000/CNN/cats-vs-dogs-chw/README.md'>cats-vs-dogs-chw</a> - Image Classification using 2 Choices</li> | ||
| <li><a href='../Examples/MAX78000/CNN/cifar-10/README.md'>cifar-10</a> - Object Classification using 10 Choices</li> | ||
| <li><a href='../Examples/MAX78000/CNN/cifar-100/README.md'>cifar-100</a> - Object Classification using 100 Choices</li> | ||
| <li><a href='../Examples/MAX78000/CNN/kws20/README.md'>kws20</a> - Audio Keyword Spotting</li> | ||
| <li><a href='../Examples/MAX78000/CNN/mnist/README.md'>mnist</a> - Handwritten Digit Recognition</li> | ||
| <li><a href='../Examples/MAX78000/CNN/mnist-riscv/README.md'>mnist-riscv</a> - Handwritten Digit Recognition (runs on RISC-V core)</li> | ||
| </ul> | ||
| <li><a href='../Examples/MAX78000/CRC/README.md'>CRC</a> - Cyclic Redundancy Check</li> | ||
| <li><a href='../Examples/MAX78000/DMA/README.md'>DMA</a> - Direct Memory Access</li> | ||
| <li><a href='../Examples/MAX78000/ECC/README.md'>ECC</a> - Error Correction Code</li> | ||
| <li><a href='../Examples/MAX78000/Flash/README.md'>Flash</a> - Flash Memory</li> | ||
| <li><a href='../Examples/MAX78000/GPIO/README.md'>GPIO</a> - General Purpose Input/Output</li> | ||
| <li><a href='../Examples/MAX78000/Hello_World/README.md'>Hello_World</a></li> | ||
| <li><a href='../Examples/MAX78000/ICC/README.md'>ICC</a> - Instruction Cache Controller</li> | ||
| <li><a href='../Examples/MAX78000/Pulse_Train/README.md'>Pulse_Train</a></li> | ||
| <li><a href='../Examples/MAX78000/RTC/README.md'>RTC</a> - Real Time Clock</li> | ||
| <li><a href='../Examples/MAX78000/SPI/README.md'>SPI</a> - Serial Peripheral Interface</li> | ||
| <li><a href='../Examples/MAX78000/TFT_Demo/README.md'>TFT_Demo</a> - Thin-Film Transistor Display</li> | ||
| <li><a href='../Examples/MAX78000/TMR/README.md'>TMR</a> - General Purpose Timer</li> | ||
| <li><a href='../Examples/MAX78000/TRNG/README.md'>TRNG</a> - True Random Number Generator</li> | ||
| <li><a href='../Examples/MAX78000/UART/README.md'>UART</a> - Universal Asynchronous Receive/Transmitter</li> | ||
| <li><a href='../Examples/MAX78000/Watchdog/README.md'>Watchdog</a></li> | ||
| </ul> | ||
| <hr> | ||
|
|
||
| <h2>Device Information</h2> | ||
| Additional information about the MAX78000 can be found in these documents: | ||
| <ul> | ||
| <li><a href='https://github.com/MaximIntegratedAI/MaximAI_Documentation/raw/master/MAX78000/MAX78000 PDS Rev4.pdf'>IC Datasheet</a></li> | ||
| <li><a href='https://github.com/MaximIntegratedAI/MaximAI_Documentation/raw/master/MAX78000/MAX78000 User Guide.pdf'>IC User Guide</a></li> | ||
| <li><a href='https://github.com/MaximIntegratedAI/MaximAI_Documentation/raw/master/MAX78000_Evaluation_Kit/MAX78000 REV A including mods.pdf'>Evaluation Kit Schematatic (Revision A)</a></li> | ||
| </ul> | ||
|
|
||
| <script type="text/javascript"> | ||
|
|
||
| function addLink(testFile, url, passText, failText, dom) | ||
| { | ||
| var img = new Image(); | ||
| img.onerror = function() { | ||
| dom.innerHTML += failText; | ||
| }; | ||
| img.onload = function() { | ||
| dom.innerHTML += '<a href="' + url + '">' + passText + '</a>'; | ||
| }; | ||
| img.src = testFile; | ||
| console.log('Test'); | ||
| console.log(img.currentSrc); | ||
| } | ||
|
|
||
| addLink('../Libraries/PeriphDrivers/Documentation/MAX78000/doc.png', | ||
| '../Libraries/PeriphDrivers/Documentation/MAX78000/index.html', | ||
| 'Peripheral API', | ||
| 'The periheral API documentation has not been installed.', | ||
| document.getElementById('periph') | ||
| ); | ||
|
|
||
| addLink('../Tools/Eclipse/cdt/plugins/org.eclipse.platform_4.13.0.v20190916-1045/splash.bmp', | ||
| '../Tools/Eclipse/cdt/readme/readme_eclipse.html', | ||
| 'Eclipse', | ||
| 'Eclipse has not been installed.', | ||
| document.getElementById('eclipse') | ||
| ); | ||
|
|
||
| addLink('../Tools/GNUTools/blank.bmp', | ||
| 'https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm', | ||
| 'GNU Tools for ARM', | ||
| 'The GNU Tools for ARM have not been installed.', | ||
| document.getElementById('gnu-arm') | ||
| ); | ||
|
|
||
| addLink('../Tools/xPack/blank.bmp', | ||
| '../Tools/xPack/riscv-none-embed-gcc/README.md', | ||
| 'GNU Tools for RISC-V', | ||
| 'The GNU Tools for RISC-V have not been installed.', | ||
| document.getElementById('gnu-riscv') | ||
| ); | ||
|
|
||
| addLink('../Libraries/FreeRTOS/Documentation/blank.bmp', | ||
| '../Libraries/FreeRTOS/readme.txt', | ||
| 'Free-RTOS', | ||
| 'The Free-RTOS libraries have not been installed.', | ||
| document.getElementById('free-rtos') | ||
| ); | ||
| addLink('../Tools/BitmapConverter/docs/blank.bmp', | ||
| '../Tools/BitmapConverter/docs/README.md', | ||
| 'Bitmap Converter', | ||
| 'The bitmap converter has not been installed.', | ||
| document.getElementById('bmp-converter') | ||
| ); | ||
| addLink('../Tools/SBT/docs/blank.bmp', | ||
| '../Tools/SBT/docs/UG7236Rev0_MaximSDK_Secure_Boot_Tool_User_Guide_Preliminary.pdf', | ||
| 'Secure Boot Tools', | ||
| 'The secure boot tools have not been installed.', | ||
| document.getElementById('sbt') | ||
| ); | ||
| addLink('../Tools/OpenOCD/blank.bmp', | ||
| 'http://openocd.org/doc/html/index.html', | ||
| 'OpenOCD', | ||
| 'OpenOCD has not been installed.', | ||
| document.getElementById('openocd') | ||
| ); | ||
| addLink('../Tools/MinGW/msys/1.0/opt/lib/tk8.6/images/logo64.gif', | ||
| 'http://www.mingw.org/', | ||
| 'MinGW', | ||
| 'The MinGW package has not been installed.', | ||
| document.getElementById('mingw') | ||
| ); | ||
| </script> | ||
| </body> | ||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,38 @@ | ||
| ## Description | ||
|
|
||
| TBD<!--TBD--> | ||
| Demonstrates the use of the ADC by continuously monitoring ADC input channel 0. Vary the voltage on the AIN0 input (0 to 0.9V) to observe different readings from the ADC. | ||
|
|
||
| High and low limits are set arbitrarily to demonstrate the detection of overvoltage and undervoltage conditions respectively. If the ADC reading exceeds 0x300, the example will report that the high limit has been reached. If the ADC reading falls below 0x25, the example will report the low limit has been reached. | ||
|
|
||
| Any reading that exceeds the full-scale value of the ADC will have an '*' appended to the value. | ||
|
|
||
| ## Required Connections | ||
|
|
||
| TBD<!--TBD--> | ||
| - Connect a USB cable between the PC and the CN1 (USB/PWR) connector. | ||
| - Connect pins 1 and 2 (P0_1) of the JH1 (UART 0 EN) header. | ||
| - Open an terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1. | ||
| - Apply an input voltage between 0 and 0.9V to pin 1 of the JH3 (ADC IN) header. | ||
|
|
||
| ## Expected Output | ||
|
|
||
| TBD<!--TBD--> | ||
| The Console UART of the device will output these messages: | ||
|
|
||
| ``` | ||
| ADC Example | ||
| 0: 0x0001 | ||
| 0: 0x003f | ||
| 0: 0x01ad | ||
| 0: 0x028d | ||
| 0: 0x0289 | ||
| 0: 0x006a | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.