Thanks to visit codestin.com
Credit goes to github.com

Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions Jenkinsfile
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,8 @@ pipeline {
--rm \
-v ${WORKSPACE}:/build \
-e EXCLUDE_PATTERNS="/build/doc/exclude_patterns.inc" \
ghcr.io/xmos/doc_builder:v3.0.0"""
// DISABLED UNTIL SVG SUPPORT ADDED TO DOC_BUILDER
// -e PDF=1
-e PDF=1 \
ghcr.io/xmos/doc_builder:v3.0.0"""
archiveArtifacts artifacts: "doc/_build/**", allowEmptyArchive: true
}
} // Build Docs
Expand Down
6 changes: 3 additions & 3 deletions doc/1_programming_guide/01_Introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ The FWK_Camera alongside with the Explorer board architecture provides the follo
- Low-resolution filtering
- Supported cameras:
- IMX219
- GC2145 [*]_
- GC2145 [0]_

This repository contains a set of tools for image acquisition, processing, and transmission.
The architecture, viewed from a high level, is composed of the following elements:
Expand All @@ -56,7 +56,7 @@ Getting Started

To start using the FWK_Camera, you can proceed to the Quick Start Guide, go to:

:ref:`QS_FWKC`.
:ref:`QS_FWKC`.

Additional Resources
---------------------
Expand All @@ -67,4 +67,4 @@ Additional Resources
- IMX219 datasheet: `IMX219`_


.. [*] With Hardware modifications.
.. [0] With Hardware modifications.
4 changes: 2 additions & 2 deletions doc/1_programming_guide/02_Architecture_and_Design.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ From a Hardware point of view, fwk_camera is composed of the following modules:
#. Camera connector : 15-PIN MIPI CSI connector for the camera module. (compatible with Raspberry Pi).
#. Mipi Shim : Xmos MIPI hardware to convert MIPI signals to Xcore ports.
#. Xcore : Xmos Xcore processor to process the MIPI signals.
#. Xtag Host connector : USB connector to connect to the host.
#. xTag Host connector : USB connector to connect to the host.

Software Architecture
-------------------------
From a Software point of view, fwk_camera is composed of the following modules:

.. figure:: images/2_object_diagram.svg
.. figure:: images/2_object_diagram.png
:alt: fwk_camera object diagram
:figclass: custom-class

Expand Down
29 changes: 18 additions & 11 deletions doc/2_quick_start_guide/Quick_Start_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Hardware requirements:
- XCORE.AI EVALUATION KIT (XK-EVK-XU316)
- Camera module
- Camera ribbon connector
- 2xMicro USB cable (Power supply and Xtag)
- Xtag debugger and cable
- 2xMicro USB cable (Power supply and xTag)
- xTag debugger and cable

Software requirements:
^^^^^^^^^^^^^^^^^^^^^^^
Expand All @@ -30,12 +30,18 @@ Run the RAW camera demo
This demo uses the RAW camera module to capture a RAW8 image and save it to a .raw file.
Then, this image can be decoded using the python script ``python decode_raw8.py``.

.. note::
Make sure xscope_fileio is installed. See /utils/README.rst section for more details
.. warning::
Make sure xscope_fileio is installed. See utils/README.rst section for more details

#. Ensure that the camera is connected to the board
#. Connect Power Supply and Xtag debugger
#. Build the example using the following commands:
1. Ensure that the camera is connected to the board
2. Connect Power Supply and xTag debugger
3. Install python requirements. From the root of the repository run:

.. code-block:: console

pip install -r requirements.txt

4. Build the example using the following commands:

.. tab:: Linux and Mac

Expand All @@ -52,17 +58,18 @@ Then, this image can be decoded using the python script ``python decode_raw8.py`
ninja -C build example_take_picture_raw


4. Run the example using the following command:
5. Run the example using the following command:

.. code-block:: console

python python/run_xscope_bin.py build/examples/take_picture_raw/example_take_picture_raw.xe

5. You should see the camera comminucating with the host and the image being saved to a .raw file
6. To decode the image use the following command:
6. You should see the camera comminucating with the host and the image being saved to a .raw file.

7. To decode the image use the following command:

.. code-block:: console

python python/decode_raw8.py

7. You should see the decoded image displayed on the screen
8. You should see the decoded image displayed on the screen
1 change: 1 addition & 0 deletions doc/exclude_patterns.inc
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# The following patterns are to be excluded from the documentation build
tests
modules
sensors