From 12f374c8360b91fd223bdc613fcb4abb6e7fc36b Mon Sep 17 00:00:00 2001 From: FredKellerman Date: Wed, 12 Oct 2022 15:28:02 -0400 Subject: [PATCH] readthedocs edits --- docs/source/getting_started.rst | 1 - docs/source/index.rst | 1 - docs/source/sensors96b_overlay.rst | 98 ------------------------------ 3 files changed, 100 deletions(-) delete mode 100644 docs/source/sensors96b_overlay.rst diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst index 9f3c81e..fabe8af 100644 --- a/docs/source/getting_started.rst +++ b/docs/source/getting_started.rst @@ -131,7 +131,6 @@ To get started using PYNQ, try running the provided example notebooks: * **getting_started**: includes an introduction to using Jupyter notebook with PYNQ, the Python environment, and how to use some basic features of the current platform. * **common**: contains example notebooks on how to download an overlay, how to set the Zynq clocks, how to execute Linux shell commands, and how to use USB devices. -* **sensors96b**: includes example notebooks to use peripherals with the mezzanine board. .. image:: images/example_notebooks.png :height: 600px diff --git a/docs/source/index.rst b/docs/source/index.rst index 134fcd2..0165f4c 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -13,5 +13,4 @@ For more information on PYNQ, please see the PYNQ readthedocs pages: https://pyn :hidden: getting_started - sensors96b_overlay for_more_information diff --git a/docs/source/sensors96b_overlay.rst b/docs/source/sensors96b_overlay.rst deleted file mode 100644 index 0435eb6..0000000 --- a/docs/source/sensors96b_overlay.rst +++ /dev/null @@ -1,98 +0,0 @@ -Sensors96b Overlay -================== - -`96boards `_ is an open set of hardware specifications for ARM based boards to allow manufacturers to provide a common set of features for developers. The Ultra96 follows this specification. - -Sensors96 Mezzanine board -------------------------- - -The `Grove starter kit for 96boards `_ is a mezzanine board that provides interfaces that can be used to connect sensors to the 40 pin header on the Ultra96. The board includes an Arduino header, a 40 pin female header, and a number of `Grove `_ 4 pin headers. - -The mezzanine board has an Arduino compatible microcontroller that is connected to some of the interfaces on the board. - -The interfaces on the mezzanine board are connect to the microcontroller, the 40-pin header, or available to both (shared). Of the interfaces connected to the 40-pin header (i.e. available to the Ultra96), some are connected to PS pins, and others are connected to PL pins. - -The diagram below shows the interfaces and pin mappings to the PS/PL/Arduino. - -.. Warning Some of the interfaces are 5V and some are 3.3V. Make sure that you do not connect 3.3V peripherals to the 5V lines or it may damage your equipment. - -.. image:: images/sensors96_mezzanine.png - :height: 600px - :scale: 75% - :align: center - -The following pins are connected to the Ultra96, and available for use with PYNQ: - -* Pins 3,5,7-34 on the 40-pin header -* Pins D0, D1 on the Arduino interface (5V) -* I2C0 (5V) and I2C1 -* GPIO AB (5V), EF, GH, IJ, KL Grove connectors - -Ultra96 overlay diagram ------------------------ - -The sensors96b overlay is an overlay designed to support the `96boards Sensors mezzanine board `_. The overlay is a simple design providing a number of GPIO and a UART to connect to available interfaces on the mezzanine board. -2x PS I2C are connected to I2C0 and I2C1, PS GPIO are connected to GPIO AB and GF, and PS GPIO are connected to GPIO GH, IJ, KL, through the EMIO. - -.. image:: images/sensors96_block_diagram.png - :align: center - - -96boards sensors kit --------------------- - -A number of peripherals and sensors are provided in the 96 boards sensors kit. - -For examples of using the boards96 sensors board and peripherals, see the notebooks in the corresponding *sensors96b* directory in the Jupyter home area. Note that some of the peripherals are analog, and can only be used with the ADC on the Arduino (the XADC on the Zynq Ultrascale+ is not connected to the Ultra96 40-pin header). - -See the example notebook for details: - -.. code-block:: console - - /sensors96b/sensors_mezzanine_examples.ipynb - - -Rebuilding the Overlay ----------------------- - -The project files for the overlay can be found here: - -.. code-block:: console - - https://github.com/Avnet/Ultra96-PYNQ/tree/master/Ultra96/sensors96b - - -Linux -^^^^^ -To rebuild the overlay, source the Xilinx tools first. Then assuming Ultra96-PYNQ has -been cloned: - -.. code-block:: console - - cd /Ultra96/sensors96b - make - -Windows -^^^^^^^ - -To rebuild from the Vivado GUI, open Vivado. In the Vivado Tcl command line -window, change to the correct directory, and source the Tcl files as -indicated below. - -Assuming Ultra96-PYNQ has been cloned: - -.. code-block:: console - - cd /Ultra96/sensors96b - source ./sensors96b.tcl - -To build from the command line, open the Vivado 2018.3 Tcl Shell, and run the -following: - -.. code-block:: console - - cd /Ultra96/sensors96b - vivado -mode batch -source sensors96b.tcl - -Note that you must change to the overlay directory, as the .tcl files has -relative paths that will break if sourced from a different location.