Skip to content

Commit

Permalink
Update documentation from PR
Browse files Browse the repository at this point in the history
  • Loading branch information
[email protected] committed Aug 22, 2023
1 parent c806118 commit 29bad48
Show file tree
Hide file tree
Showing 29 changed files with 352 additions and 32 deletions.
1 change: 1 addition & 0 deletions content/community-targets/GHI_FEZ_CERB40_NF.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ <h1 id="ghi-fez-cerbb40-nf">GHI FEZ CERBb40 NF</h1>

<p><img src="https://github.com/nanoframework/nf-Community-Targets/blob/main/ChibiOS/GHI_FEZ_CERB40_NF/resources/cerb40.jpg?raw=true" alt="GHI FEZ CERB40"></p>
<hr>
<p><a href="https://cloudsmith.io/%7Enet-nanoframework/repos/nanoframework-images-community-targets/packages/detail/raw/GHI_FEZ_CERB40_NF/latest/"><img src="https://api-prd.cloudsmith.io/v1/badges/version/net-nanoframework/nanoframework-images-community-targets/raw/GHI_FEZ_CERB40_NF/latest/x/?render=true" alt="Latest Version @ Cloudsmith"></a></p>
<h2 id="board-introduction">Board introduction</h2>
<p>The board here used is a GHI Fez Cerb40 based upon an STM32F405RGT6 supporting a 1MB Flash and up to 192KB RAM in a LQFP64 package. On this board the LSE is soldered in case you have a board without the LSE please make sure you have it configured correctly in both the mcuconf.h files for nanoBooter as well as nanoCLR.</p>
<p>The available pins have been set as can be read in the board.h file and it is there where you can set the pin usage for your required use. Visiting the official site <a href="http://www.st.com/content/st_com/en/products/microcontrollers/stm32-32-bit-arm-cortex-mcus/stm32-high-performance-mcus/stm32f4-series/stm32f405-415/stm32f405rg.html">here</a> and per datasheet looking at Table 9. Alternate function mapping you will find possible alternative uses of the various pins. In its initial release the following pin configuration and usage has been verified. Looking at the board from the above (MCU visible) and with the USB connector at the top we have pin 1 on the left hand side.</p>
Expand Down
2 changes: 2 additions & 0 deletions content/community-targets/I2M_ELECTRON_NF.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,8 @@
<h1 id="i2m-electron-nf">I2M Electron nf</h1>

<p><img src="https://raw.githubusercontent.com/nanoframework/nf-Community-Targets/main/ChibiOS/I2M_ELECTRON_NF/resources/IngenuityMicro_Logo.svg" alt="I2M Electron"></p>
<hr>
<p><a href="https://cloudsmith.io/%7Enet-nanoframework/repos/nanoframework-images-community-targets/packages/detail/raw/I2M_ELECTRON_NF/latest/"><img src="https://api-prd.cloudsmith.io/v1/badges/version/net-nanoframework/nanoframework-images-community-targets/raw/I2M_ELECTRON_NF/latest/x/?render=true" alt="Latest Version @ Cloudsmith"></a></p>
<h2 id="electron-community-board">Electron community board</h2>
<p>The board used in this community contribution is a STM32F411CEU6 based board from IngenuityMicro called Electron. The board has only 12 pins of which 3 are already used for 3.3V, 5V and GND, leaving use of only 9 pins.</p>
<p>These pins can be used for:</p>
Expand Down
2 changes: 2 additions & 0 deletions content/community-targets/I2M_OXYGEN_NF.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,8 @@
<h1 id="i2m-oxygen">I2M Oxygen</h1>

<p><img src="https://github.com/nanoframework/nf-Community-Targets/blob/main/ChibiOS/I2M_OXYGEN_NF/resources/oxygen.jpeg?raw=true" alt="I2M Oxygen"></p>
<hr>
<p><a href="https://cloudsmith.io/%7Enet-nanoframework/repos/nanoframework-images-community-targets/packages/detail/raw/I2M_OXYGEN_NF/latest/"><img src="https://api-prd.cloudsmith.io/v1/badges/version/net-nanoframework/nanoframework-images-community-targets/raw/I2M_OXYGEN_NF/latest/x/?render=true" alt="Latest Version @ Cloudsmith"></a></p>
<p>The board used in this community contribution is a STM32F411CEU6 based board from IngenuityMicro called Oxygen. The board has 20 pins for your use. The pins on the opposite side of the USB connector can be used for several add-on boards for f.e. BLE, WiFi (ESP8266).</p>
<p>The pins can be used for several purposes, GPIO, PWM, I2C, SPI, SERIAL, etc.</p>
<p>Further details how the pin out is supposed to work can be found in the resources folder, of course since we know now what MCU pins go to what PCB pins we can change the board.h depending on what you want to achieve with the board.</p>
Expand Down
189 changes: 189 additions & 0 deletions content/community-targets/NESHTEC-NeshNode.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,189 @@
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>

<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>NESHTEC NeshNode | .NET nanoFramework Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="NESHTEC NeshNode | .NET nanoFramework Documentation ">


<link rel="apple-touch-icon" sizes="180x180" href="../../favicons/apple-touch-icon.png">
<link rel="icon" type="image/png" sizes="32x32" href="../../favicons/favicon-32x32.png">
<link rel="icon" type="image/png" sizes="16x16" href="../../favicons/favicon-16x16.png">
<link rel="manifest" href="../../favicons/site.webmanifest">
<link rel="shortcut icon" type="image/x-icon" href="../../favicon.ico">
<link rel="mask-icon" href="../../favicons/safari-pinned-tab.svg" color="#179b88">
<meta name="msapplication-config" content="../../favicons/browserconfig.xml">
<meta name="msapplication-TileColor" content="#222222">
<meta name="theme-color" content="#222222">

<link rel="stylesheet" href="../../styles/docfx.vendor.min.css">
<link rel="stylesheet" href="../../styles/docfx.css">
<link rel="stylesheet" href="../../styles/main.css">
<meta property="docfx:navrel" content="../../toc.html">
<meta property="docfx:tocrel" content="../../x-cross/toc.html">

<meta property="docfx:rel" content="../../">

</head> <body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>

<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>

<a class="navbar-brand" href="../../index.html">
<img id="logo" class="svg" src="../../logo.svg" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>

<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div class="container body-content">

<div id="search-results">
<div class="search-list">Search Results for <span></span></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</div>
<ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">

<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="">
<h1 id="neshtec-neshnode">NESHTEC NeshNode</h1>

<p>NeshNode is a flexible, high performance board featuring a powerful STM32F7 dual core RISC based microcontroller, on-board ethernet, battery charger, lots of I/Os, two MikroE® Click™ sockets and a lot of tiny details, like a robust USB-C connector.</p>
<p>Furthermore, our board has been extensively tested by the independent testing institute <a href="https://www.tuev-nord.de/">TÜV Nord</a> for EMC/EMI (electromagnetic compatibility / interference), which means that it is fully compliant with EU regulations (CE).</p>
<p><img src="../../images/community-targets/NESHTEC-NeshNode-STM32F7-1.1-nf.png" alt="NESHTEC NeshNode"></p>
<hr>
<p><a href="https://cloudsmith.io/%7Enet-nanoframework/repos/nanoframework-images-community-targets/packages/detail/raw/NESHTEC_NESHNODE_V1/latest/"><img src="https://api-prd.cloudsmith.io/v1/badges/version/net-nanoframework/nanoframework-images-community-targets/raw/NESHTEC_NESHNODE_V1/latest/x/?render=true" alt="Latest Version @ Cloudsmith"></a></p>
<h2 id="how-to-get-one">How to get one?</h2>
<p>Just check out our shop, we'll ship the board from Germany:
<a href="https://neshtec.eu/products/neshnode-controllerplatine">https://neshtec.eu/products/neshnode-controllerplatine</a></p>
<p>(We are working on a English translation, sorry about that)</p>
<h2 id="hardware">Hardware</h2>
<p>NeshNode was designed to be used as flexible as possible in professional projects, without having to develop a new board every time. The board is powerful enough for extensive cryptographic tasks, cloud connectivity (like Microsoft Azure IoT Hub) and offers a lot of interfaces.</p>
<h3 id="stm32f765vgt6-microcontroller">STM32F765VGT6 microcontroller</h3>
<p>The board currently uses an ARM Cortex-M7 RISC core based STM32F765VGT6 MCU in a 100 pin package which operates at up to 216 MHz, 2 MB of persistent flash, 512KB SRAM, features a dedicated double precision FPU and also implements a full set of DSP instructions. To increase application security, it also features a MPU (memory protection unit).</p>
<p>See here for more details: <a href="https://www.st.com/en/microcontrollers-microprocessors/stm32f765vg.html">https://www.st.com/en/microcontrollers-microprocessors/stm32f765vg.html</a></p>
<h3 id="ethernet">Ethernet</h3>
<p>Ethernet is supplied by a Microchip LAN8720A, which is a high performance 10BASE-T/100BASE-TX transceiver delivering up to 100 MBit/s, working on a large temperature range: <a href="https://www.microchip.com/en-us/product/lan8720a">https://www.microchip.com/en-us/product/lan8720a</a></p>
<h3 id="mikroe-click--mikrobus">MikroE® Click™ / MikroBus™</h3>
<p>MikroE® has designed a compact interface for which, as of today, there are over 1,000 different so-called Click™ boards of very high quality - giving you the flexibility to easily add whatever kind of additional functionality you might need.</p>
<p>See below (<a href="#pinout">Pinout</a>) for a sample of MikroE®s MikroBus™ layout.</p>
<p>Check out MikroE®'s Click™ board store for some awesome addon boards: <a href="https://www.mikroe.com/click">https://www.mikroe.com/click</a></p>
<p>More information about the Click™ standard can be found on the MikroE®s website: <a href="https://www.mikroe.com">https://www.mikroe.com</a></p>
<h3 id="usb-c-connector">USB-C connector</h3>
<p>This can be used for powering the board, charging the battery (if installed) at the same time. Or you may use the USB-C connector to upload and debug nanoFramework programs from within Visual Studio (or any other IDE supported by nanoFramework) once you flashed the nanoFramework bootloader.</p>
<h3 id="programming-and-debug-interface">Programming and debug interface</h3>
<p>A fully connected programming and debug interface, which comes without headers by default, can be used by native STMicroelectronics tools for the STM32 line of MCUs. For example, you may use STLink for flashing the nanoFramework bootloader, to set fuses and so on.</p>
<h3 id="external-i2c-connector">External I2C connector</h3>
<p>There's a dedicated connector sporting 3V3, GND, SCL, SDA and RST on the rear side of the board. This is supposed to be used for I2C, but you may also reconfigure the pins to act as GPIO.</p>
<h3 id="battery-support">Battery support</h3>
<p>The power management controller (<a href="#ltc3586-power-management">see below, LTC3586</a>) supports LiIon- and LiPo-Batteries. You may use one, but you don't have to. The board automatically detects any installed battery and starts using and charging it, if a sufficent external power supply is available.</p>
<h3 id="ltc3586-power-management">LTC3586 power management</h3>
<p>We use a LTC®3586 (LTC3586) from Linear Technology, which is a highly efficient USB power management and battery charger IC for LiIon and LiPo batteries.</p>
<h3 id="buttons-leds-power-switch">Buttons, LEDs, power switch</h3>
<p>There are three LEDs of which one is used by the power management IC and two can be used at your own discretion. Also, there are 3 buttons of which two can be used for your own needs and one is used for resetting the MCU.</p>
<p>Finally, the board features a physical power switch, thus it can be completely turned off (or on).</p>
<h2 id="pinout">Pinout</h2>
<h3 id="mcu">MCU</h3>
<p><img src="../../images/community-targets/NESHTEC-NeshNode-STM32F7-1.1-pinout-mcu.png" alt="NESHTEC NeshNode pinout MCU"></p>
<h3 id="gpio--side-headers">GPIO / side headers</h3>
<p><img src="../../images/community-targets/NESHTEC-NeshNode-STM32F7-1.1-pinout-sides.png" alt="NESHTEC NeshNode Pinout GPIO / side headers"></p>
<h3 id="programming--debug-interface">Programming / debug interface</h3>
<p><img src="../../images/community-targets/NESHTEC-NeshNode-STM32F7-1.1-pinout-debuginterface.png" alt="NESHTEC NeshNode Pinout Programming and debug interface"></p>
<h3 id="mikroe-click-sockets--mikrobus">MikroE® Click™ sockets / MikroBus™</h3>
<p><img src="../../images/community-targets/NESHTEC-NeshNode-STM32F7-1.1-pinout-mikrobus.png" alt="NESHTEC NeshNode Pinout MikroE® MikroBus™"></p>
<h3 id="ext-i2c-connector">Ext. I2C connector</h3>
<p><img src="../../images/community-targets/NESHTEC-NeshNode-STM32F7-1.1-pinout-i2cconnector.png" alt="NESHTEC NeshNode Pinout External I2C connector"></p>
<h3 id="leds--buttons">LEDs &amp; buttons</h3>
<p><img src="../../images/community-targets/NESHTEC-NeshNode-STM32F7-1.1-pinout-led-button.png" alt="NESHTEC NeshNode Pinout LEDs and buttons"></p>
<h2 id="legal">Legal</h2>
<h3 id="general-disclaimer">General disclaimer</h3>
<p>All information and technical data have been provided to the best of our knowledge. Mistakes can happen and will be corrected as soon as we are aware of them.</p>
<p>Should you find an error, we would be pleased to hear from you! Just drop us an e-mail: <a href="mailto:[email protected]">[email protected]</a>.</p>
<h3 id="trademark-disclaimer">Trademark disclaimer</h3>
<p>All product and company names are trademarks™ or registered® trademarks of their respective holders. Use of them does not imply any affiliation with or endorsement by them.</p>
<ul>
<li>STM32 is a registered trademark of STMicroelectronics International N.V.</li>
<li>MikroE is a registered trademark and MikroBus a trademark of MikroElektronika d.o.o.</li>
<li>Microsoft, Azure and IoT Hub are trademarks or registered trademarks of the Microsoft group of companies.</li>
<li>Microchip is a trademark belonging to Microchip Technology Inc. or one of Microchip’s subsidiaries.</li>
<li>LT, LTC and LTM are registered trademarks of Linear Technology Corporation.</li>
</ul>
<p>All other trademarks are the property of their respective owners.</p>
</article>
</div>

<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/nanoframework/nanoframework.github.io/blob/pages-source/content/community-targets/NESHTEC-NeshNode.md/#L1" class="contribution-link">Improve this Doc</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h5>In This Article</h5>
<div></div>
</nav>
</div>
</div>
</div>
</div>

<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>

<span>Copyright © 2023 nanoFramework Contributors<br>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer> </div>

<script type="text/javascript" src="../../styles/docfx.vendor.min.js"></script>
<script type="text/javascript" src="../../styles/docfx.js"></script>
<script type="text/javascript" src="../../styles/main.js"></script>
</body>
</html>
2 changes: 2 additions & 0 deletions content/community-targets/ST_NUCLEO144_F412ZG_NF.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,8 @@
<h1 id="st-nucleo-f412zg">ST Nucleo F412ZG</h1>

<p><img src="https://www.st.com/bin/ecommerce/api/image.PF262641.en.feature-description-include-personalized-no-cpn-medium.jpg" alt="F12ZG"></p>
<hr>
<p><a href="https://cloudsmith.io/%7Enet-nanoframework/repos/nanoframework-images-community-targets/packages/detail/raw/ST_NUCLEO144_F412ZG_NF/latest/"><img src="https://api-prd.cloudsmith.io/v1/badges/version/net-nanoframework/nanoframework-images-community-targets/raw/ST_NUCLEO144_F412ZG_NF/latest/x/?render=true" alt="Latest Version @ Cloudsmith"></a></p>
<p>The board used in this community contribution is the NUCLEO144_F412ZG board from ST. The board can be purchased from various sources and should be about 20 euros. Further information on the Nucleo144 boards can be found in the user manuals UM1727 or UM1974 over at the <a href="https://www.st.com">ST website</a>.</p>
<p>Some basic information abstracted from ST:</p>
<ul>
Expand Down
2 changes: 2 additions & 0 deletions content/community-targets/ST_NUCLEO64_F401RE_NF.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,8 @@
<h1 id="st-nucleo-64-f401re-nf">ST Nucleo 64 F401RE NF</h1>

<p><img src="https://www.st.com/bin/ecommerce/api/image.PF260000.en.feature-description-include-personalized-no-cpn-medium.jpg" alt="ST Nucleo 64_F401RE NF"></p>
<hr>
<p><a href="https://cloudsmith.io/%7Enet-nanoframework/repos/nanoframework-images-community-targets/packages/detail/raw/ST_NUCLEO64_F401RE_NF/latest/"><img src="https://api-prd.cloudsmith.io/v1/badges/version/net-nanoframework/nanoframework-images-community-targets/raw/ST_NUCLEO64_F401RE_NF/latest/x/?render=true" alt="Latest Version @ Cloudsmith"></a></p>
<p>The board used in this community contribution is the NUCLEO64_F401RE board from ST. The board can be purchased from various sources and should be about 20 euros. Further information on the Nucleo64 boards can be found in the user manual UM1724 over at the <a href="https://www.st.com">ST website</a>. The board used here is of revision c as can be found on the board's lower backside sticker. The board MB1136 C-02 is configured to use ST-LINK MCO as clock input for HSE so we have an HSE of 8 MHz. Plus X2 is mounted so we do have an LSE as well. This is reflected in the mcuconf.h in both nanoBooter and nanoCLR paths. If it is chosen to activate LSE as this is a for more accurate clock for RTC, the board.h file needs to be adjusted accordingly to use 32768 frequency for LSE.</p>
<p>I prepared a custom made a 4-wire jumper to USB cable by cutting off one end (Type A part) and figuring out the required D+, D-, 5V and GND. These need to be connected as follows:</p>
<p>USB V5 -&gt; Can be ignored
Expand Down
Loading

0 comments on commit 29bad48

Please sign in to comment.