Initial file upload

.allspice/columns.yml

@@ -0,0 +1,17 @@
+columns:
+  - name: "Part Number"
+    part_attributes: "PN"
+  - name: "Description"
+    part_attributes: "Description"
+  - name: "Manufacturer"
+    part_attributes: "Manufacturer"
+  - name: "Manufacturer Part Number"
+    part_attributes: "Manufacturer Part Number"
+  - name: "Designator"
+    part_attributes: "Part Reference"
+    grouped_values_separator: ", "
+    grouped_values_sort: "asc"
+    remove_rows_matching: "TP|Label|PCB"
+    sort: "asc"
+  - name: "Temperature"
+    part_attributes: "Temperature"

.allspice/component_validation.py

@@ -0,0 +1,112 @@
+#!/usr/bin/env python3
+
+import csv
+import sys
+import logging
+from typing import Optional
+
+from jinja2 import Environment, FileSystemLoader
+
+components_csv_path = sys.argv[1]
+
+MIN_TEMP_C: int = -10
+MAX_TEMP_C: int = 70
+
+class ComponentsWarning:
+    def __init__(self):
+        self.part_number: Optional[str] = None
+        self.refs: list[str] = []
+        self.warnings: list[str] = []
+
+report_context = {
+    "component_warnings": [],
+    "warning_count": 0,
+    "total_components": 0,
+    "min_temp": MIN_TEMP_C,
+    "max_temp": MAX_TEMP_C,
+    }
+
+class CustomFormatter(logging.Formatter):
+    grey = "\x1b[38;20m"
+    yellow = "\x1b[33;20m"
+    red = "\x1b[31;20m"
+    reset = "\x1b[0m"
+    format = "%(levelname)s - %(message)s (%(filename)s:%(lineno)d)"
+
+    FORMATS = {
+        logging.DEBUG: grey + format + reset,
+        logging.INFO: grey + format + reset,
+        logging.WARNING: yellow + format + reset,
+        logging.ERROR: red + format + reset,
+    }
+
+    def format(self, record):
+        log_fmt = self.FORMATS.get(record.levelno)
+        formatter = logging.Formatter(log_fmt)
+        return formatter.format(record)
+
+# Add formatted logging
+logger = logging.getLogger()
+logger.setLevel(logging.INFO)
+ch = logging.StreamHandler()
+
+ch.setFormatter(CustomFormatter())
+logger.addHandler(ch)
+
+with open(components_csv_path, newline="") as components_csv:
+    spamreader = csv.DictReader(components_csv, delimiter=",")
+
+    component_count = 0
+
+    for row in spamreader:
+        component_count += 1
+        component = ComponentsWarning()
+        component.refs = row['Designator'].split(', ')
+        if row["Part Number"] == '':
+            component.warnings.append("No `Part Number` attribute!")
+        elif row["Part Number"] == "NA":
+            logger.warning(f"Designators(s) {row['Designator']} have `NA` Part Number!")
+            component.warnings.append("`NA` `Part Number` attribute!")
+        elif row["Part Number"].startswith("TMP"):
+            logger.warning(
+                f"Designator(s) {row['Designator']} have temporary Part Number!"
+            )
+            component.warnings.append("`TMP*` `Part Number` attribute!")
+        else:
+            component.part_number = row["Part Number"]
+        if row["Temperature"] == "":
+            logger.warning(
+                f"Designators(s) {row['Designator']} have no `Temperature` attribute!"
+            )
+            component.warnings.append("No `Temperature` attribute!")
+        else:
+            try:
+                min_temp, max_temp = [int(x.strip("¡ãC ")) for x in row["Temperature"].split(" to ")]
+            except ValueError:
+                logger.warning(
+                    f"Designators(s) {row['Designator']} have malformed `Temperature` attribute: !"
+                )
+                component.warnings.append(f"Malformed `Temperature` attribute: `{row['Temperature']}`!")
+            else:
+                if min_temp > MIN_TEMP_C:
+                    logger.warning(
+                        f"Designators(s) {row['Designator']} minimum operating temperate `{min_temp}°C` exceeds requirement of `{MIN_TEMP_C}°C`!"
+                    )
+                    component.warnings.append(f"Minimum operating temperate `{min_temp}°C` exceeds requirement of `{MIN_TEMP_C}°C`!")
+                if max_temp < MAX_TEMP_C:
+                    logger.warning(
+                        f"Designators(s) {row['Designator']} maximum operating temperate `{max_temp}°C` doesn't meet requirement of `{MAX_TEMP_C}°C`!"
+                    )
+                    component.warnings.append(f"Maximum operating temperate `{max_temp}°C` doesn't meet requirement of `{MAX_TEMP_C}°C`!")
+        if len(component.warnings):
+            report_context["component_warnings"].append(component)
+            report_context["warning_count"] += 1
+
+    report_context["total_components"] = component_count
+
+# Load Jinja with output HTML template
+template_env = Environment(loader=FileSystemLoader("./.allspice/report_template/"), trim_blocks=True, lstrip_blocks=True)
+template = template_env.get_template("report.template.md")
+
+with open("./.allspice/report.md", mode="w", encoding="utf-8") as report_file:
+    report_file.write(template.render(report_context))

.allspice/report_template/report.template.md

@@ -0,0 +1,21 @@
+## BOM Report
+
+*Checking:*
+
+- *Valid `Part Number` attribute*
+- *Valid `Temperature` attribute within bounds: `{{ min_temp }}°C` to `{{ max_temp }}°C`*
+
+### Warnings
+
+{% for component in component_warnings %}
+**{{ ', '.join(component.refs) }}{% if component.part_number %} ({{ component.part_number }}){%endif%}** warnings:
+
+{% for warning in component.warnings %}
+{{ warning }}
+
+{% endfor %}
+{% endfor %}
+
+### Summary
+
+`{{warning_count}}` of `{{total_components}}` components have warnings

.allspice/review_comment.py

@@ -0,0 +1,51 @@
+#!/usr/bin/env python3
+
+import argparse
+import os
+import sys
+
+from allspice import AllSpice, DesignReview
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(
+        prog="review_comment", description="Comment on a design review with markdown content."
+    )
+    parser.add_argument(
+        "repository", help="The repo containing the project in the form 'owner/repo'"
+    )
+    parser.add_argument(
+        "review_number", help="The design review number'"
+    )
+    parser.add_argument(
+        "source_file",
+        help=(
+            "The path to the source file containing the content to post in the comment body."
+        ),
+    )
+    parser.add_argument(
+        "--allspice_hub_url",
+        help="The URL of your AllSpice Hub instance. Defaults to https://hub.allspice.io.",
+    )
+
+    auth_token = os.environ.get("ALLSPICE_AUTH_TOKEN")
+    if auth_token is None:
+        print("Please set the environment variable ALLSPICE_AUTH_TOKEN")
+        exit(1)
+
+    auth_token = os.environ.get("ALLSPICE_AUTH_TOKEN")
+
+    args = parser.parse_args()
+
+    pr_number = args.review_number
+    repo_owner, repo_name = args.repository.split("/")
+    comment_file = args.source_file
+
+    if args.allspice_hub_url is None:
+        allspice = AllSpice(token_text=auth_token)
+    else:
+        allspice = AllSpice(token_text=auth_token, allspice_hub_url=args.allspice_hub_url)
+
+    design_review = DesignReview.request(allspice, repo_owner, repo_name, pr_number)
+
+    with open(comment_file, "r") as f:
+        design_review.create_comment(f.read())

.allspice/workflows/bom-gen.yml

@@ -0,0 +1,56 @@
+# AllSpice Running common Actions workflow
+# Action triggers on push and issues
+# Action runs "generate-bom-altium" action
+# .allspice/workflows/generate_bom.yml
+name: Generate BOM
+on:
+  pull_request:
+
+jobs:
+  Generate_BOM:
+    runs-on: ubuntu-latest
+    steps:
+     # Checkout is only needed if columns.json is committed in your Altium project repo.
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Generate BOM
+        uses: https://hub.allspice.io/Actions/generate-bom@v0.5
+        with:
+          # The path to the project file in your repo (.PrjPcb for Altium, .DSN for OrCad).
+          source_path: design/BeagleY-AI_SCH_Rev A_240426.DSN
+          # [optional] A path to a YAML file mapping columns to the component attributes
+          # This file must be provided.
+          # Default: 'columns.json'
+          columns: .allspice/columns.yml
+          # [optional] The path to the output file that will be generated.
+          # Default: 'bom.csv'
+          output_file_name: bom.csv
+          # [optional] A comma-separated list of columns to group the BOM by. If empty
+          # or not present, the BOM will be flat.
+          # Default: ''
+          group_by: 'Part Number'         
+      # Print bom.csv to terminal
+      - name: Show BOM
+        run: cat bom.csv
+
+      - name: Upload file as artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: BOM.csv
+          path: bom.csv
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+      # Note: if we add any other dependencies we should include a requirements.txt file
+      - run: pip install jinja2 py-allspice
+
+      - name: Check Components
+        run: .allspice/component_validation.py ./bom.csv
+
+      - name: Comment Results
+        run: .allspice/review_comment.py --allspice_hub_url ${{ github.server_url }} ${{ github.repository }} ${{ github.event.number }} ./.allspice/report.md
+        env:
+          ALLSPICE_AUTH_TOKEN: ${{ github.token }}

LICENSE

@@ -0,0 +1,401 @@
+CC-BY-4.0
+
+Copyright (c) 2024 Seeed Technology Co., Ltd
+Copyright (c) 2024 BeagleBoard.org Foundation
+
+Attribution 4.0 International
+
+=======================================================================
+
+Creative Commons Corporation ("Creative Commons") is not a law firm and
+does not provide legal services or legal advice. Distribution of
+Creative Commons public licenses does not create a lawyer-client or
+other relationship. Creative Commons makes its licenses and related
+information available on an "as-is" basis. Creative Commons gives no
+warranties regarding its licenses, any material licensed under their
+terms and conditions, or any related information. Creative Commons
+disclaims all liability for damages resulting from their use to the
+fullest extent possible.
+
+Using Creative Commons Public Licenses
+
+Creative Commons public licenses provide a standard set of terms and
+conditions that creators and other rights holders may use to share
+original works of authorship and other material subject to copyright
+and certain other rights specified in the public license below. The
+following considerations are for informational purposes only, are not
+exhaustive, and do not form part of our licenses.
+
+     Considerations for licensors: Our public licenses are
+     intended for use by those authorized to give the public
+     permission to use material in ways otherwise restricted by
+     copyright and certain other rights. Our licenses are
+     irrevocable. Licensors should read and understand the terms
+     and conditions of the license they choose before applying it.
+     Licensors should also secure all rights necessary before
+     applying our licenses so that the public can reuse the
+     material as expected. Licensors should clearly mark any
+     material not subject to the license. This includes other CC-
+     licensed material, or material used under an exception or
+     limitation to copyright. More considerations for licensors:
+	wiki.creativecommons.org/Considerations_for_licensors
+
+     Considerations for the public: By using one of our public
+     licenses, a licensor grants the public permission to use the
+     licensed material under specified terms and conditions. If
+     the licensor's permission is not necessary for any reason--for
+     example, because of any applicable exception or limitation to
+     copyright--then that use is not regulated by the license. Our
+     licenses grant only permissions under copyright and certain
+     other rights that a licensor has authority to grant. Use of
+     the licensed material may still be restricted for other
+     reasons, including because others have copyright or other
+     rights in the material. A licensor may make special requests,
+     such as asking that all changes be marked or described.
+     Although not required by our licenses, you are encouraged to
+     respect those requests where reasonable. More_considerations
+     for the public: 
+	wiki.creativecommons.org/Considerations_for_licensees
+
+=======================================================================
+
+Creative Commons Attribution 4.0 International Public License
+
+By exercising the Licensed Rights (defined below), You accept and agree
+to be bound by the terms and conditions of this Creative Commons
+Attribution 4.0 International Public License ("Public License"). To the
+extent this Public License may be interpreted as a contract, You are
+granted the Licensed Rights in consideration of Your acceptance of
+these terms and conditions, and the Licensor grants You such rights in
+consideration of benefits the Licensor receives from making the
+Licensed Material available under these terms and conditions.
+
+
+Section 1 -- Definitions.
+
+  a. Adapted Material means material subject to Copyright and Similar
+     Rights that is derived from or based upon the Licensed Material
+     and in which the Licensed Material is translated, altered,
+     arranged, transformed, or otherwise modified in a manner requiring
+     permission under the Copyright and Similar Rights held by the
+     Licensor. For purposes of this Public License, where the Licensed
+     Material is a musical work, performance, or sound recording,
+     Adapted Material is always produced where the Licensed Material is
+     synched in timed relation with a moving image.
+
+  b. Adapter's License means the license You apply to Your Copyright
+     and Similar Rights in Your contributions to Adapted Material in
+     accordance with the terms and conditions of this Public License.
+
+  c. Copyright and Similar Rights means copyright and/or similar rights
+     closely related to copyright including, without limitation,
+     performance, broadcast, sound recording, and Sui Generis Database
+     Rights, without regard to how the rights are labeled or
+     categorized. For purposes of this Public License, the rights
+     specified in Section 2(b)(1)-(2) are not Copyright and Similar
+     Rights.
+
+  d. Effective Technological Measures means those measures that, in the
+     absence of proper authority, may not be circumvented under laws
+     fulfilling obligations under Article 11 of the WIPO Copyright
+     Treaty adopted on December 20, 1996, and/or similar international
+     agreements.
+
+  e. Exceptions and Limitations means fair use, fair dealing, and/or
+     any other exception or limitation to Copyright and Similar Rights
+     that applies to Your use of the Licensed Material.
+
+  f. Licensed Material means the artistic or literary work, database,
+     or other material to which the Licensor applied this Public
+     License.
+
+  g. Licensed Rights means the rights granted to You subject to the
+     terms and conditions of this Public License, which are limited to
+     all Copyright and Similar Rights that apply to Your use of the
+     Licensed Material and that the Licensor has authority to license.
+
+  h. Licensor means the individual(s) or entity(ies) granting rights
+     under this Public License.
+
+  i. Share means to provide material to the public by any means or
+     process that requires permission under the Licensed Rights, such
+     as reproduction, public display, public performance, distribution,
+     dissemination, communication, or importation, and to make material
+     available to the public including in ways that members of the
+     public may access the material from a place and at a time
+     individually chosen by them.
+
+  j. Sui Generis Database Rights means rights other than copyright
+     resulting from Directive 96/9/EC of the European Parliament and of
+     the Council of 11 March 1996 on the legal protection of databases,
+     as amended and/or succeeded, as well as other essentially
+     equivalent rights anywhere in the world.
+
+  k. You means the individual or entity exercising the Licensed Rights
+     under this Public License. Your has a corresponding meaning.
+
+
+Section 2 -- Scope.
+
+  a. License grant.
+
+       1. Subject to the terms and conditions of this Public License,
+          the Licensor hereby grants You a worldwide, royalty-free,
+          non-sublicensable, non-exclusive, irrevocable license to
+          exercise the Licensed Rights in the Licensed Material to:
+
+            a. reproduce and Share the Licensed Material, in whole or
+               in part; and
+
+            b. produce, reproduce, and Share Adapted Material.
+
+       2. Exceptions and Limitations. For the avoidance of doubt, where
+          Exceptions and Limitations apply to Your use, this Public
+          License does not apply, and You do not need to comply with
+          its terms and conditions.
+
+       3. Term. The term of this Public License is specified in Section
+          6(a).
+
+       4. Media and formats; technical modifications allowed. The
+          Licensor authorizes You to exercise the Licensed Rights in
+          all media and formats whether now known or hereafter created,
+          and to make technical modifications necessary to do so. The
+          Licensor waives and/or agrees not to assert any right or
+          authority to forbid You from making technical modifications
+          necessary to exercise the Licensed Rights, including
+          technical modifications necessary to circumvent Effective
+          Technological Measures. For purposes of this Public License,
+          simply making modifications authorized by this Section 2(a)
+          (4) never produces Adapted Material.
+
+       5. Downstream recipients.
+
+            a. Offer from the Licensor -- Licensed Material. Every
+               recipient of the Licensed Material automatically
+               receives an offer from the Licensor to exercise the
+               Licensed Rights under the terms and conditions of this
+               Public License.
+
+            b. No downstream restrictions. You may not offer or impose
+               any additional or different terms or conditions on, or
+               apply any Effective Technological Measures to, the
+               Licensed Material if doing so restricts exercise of the
+               Licensed Rights by any recipient of the Licensed
+               Material.
+
+       6. No endorsement. Nothing in this Public License constitutes or
+          may be construed as permission to assert or imply that You
+          are, or that Your use of the Licensed Material is, connected
+          with, or sponsored, endorsed, or granted official status by,
+          the Licensor or others designated to receive attribution as
+          provided in Section 3(a)(1)(A)(i).
+
+  b. Other rights.
+
+       1. Moral rights, such as the right of integrity, are not
+          licensed under this Public License, nor are publicity,
+          privacy, and/or other similar personality rights; however, to
+          the extent possible, the Licensor waives and/or agrees not to
+          assert any such rights held by the Licensor to the limited
+          extent necessary to allow You to exercise the Licensed
+          Rights, but not otherwise.
+
+       2. Patent and trademark rights are not licensed under this
+          Public License.
+
+       3. To the extent possible, the Licensor waives any right to
+          collect royalties from You for the exercise of the Licensed
+          Rights, whether directly or through a collecting society
+          under any voluntary or waivable statutory or compulsory
+          licensing scheme. In all other cases the Licensor expressly
+          reserves any right to collect such royalties.
+
+
+Section 3 -- License Conditions.
+
+Your exercise of the Licensed Rights is expressly made subject to the
+following conditions.
+
+  a. Attribution.
+
+       1. If You Share the Licensed Material (including in modified
+          form), You must:
+
+            a. retain the following if it is supplied by the Licensor
+               with the Licensed Material:
+
+                 i. identification of the creator(s) of the Licensed
+                    Material and any others designated to receive
+                    attribution, in any reasonable manner requested by
+                    the Licensor (including by pseudonym if
+                    designated);
+
+                ii. a copyright notice;
+
+               iii. a notice that refers to this Public License;
+
+                iv. a notice that refers to the disclaimer of
+                    warranties;
+
+                 v. a URI or hyperlink to the Licensed Material to the
+                    extent reasonably practicable;
+
+            b. indicate if You modified the Licensed Material and
+               retain an indication of any previous modifications; and
+
+            c. indicate the Licensed Material is licensed under this
+               Public License, and include the text of, or the URI or
+               hyperlink to, this Public License.
+
+       2. You may satisfy the conditions in Section 3(a)(1) in any
+          reasonable manner based on the medium, means, and context in
+          which You Share the Licensed Material. For example, it may be
+          reasonable to satisfy the conditions by providing a URI or
+          hyperlink to a resource that includes the required
+          information.
+
+       3. If requested by the Licensor, You must remove any of the
+          information required by Section 3(a)(1)(A) to the extent
+          reasonably practicable.
+
+       4. If You Share Adapted Material You produce, the Adapter's
+          License You apply must not prevent recipients of the Adapted
+          Material from complying with this Public License.
+
+
+Section 4 -- Sui Generis Database Rights.
+
+Where the Licensed Rights include Sui Generis Database Rights that
+apply to Your use of the Licensed Material:
+
+  a. for the avoidance of doubt, Section 2(a)(1) grants You the right
+     to extract, reuse, reproduce, and Share all or a substantial
+     portion of the contents of the database;
+
+  b. if You include all or a substantial portion of the database
+     contents in a database in which You have Sui Generis Database
+     Rights, then the database in which You have Sui Generis Database
+     Rights (but not its individual contents) is Adapted Material; and
+
+  c. You must comply with the conditions in Section 3(a) if You Share
+     all or a substantial portion of the contents of the database.
+
+For the avoidance of doubt, this Section 4 supplements and does not
+replace Your obligations under this Public License where the Licensed
+Rights include other Copyright and Similar Rights.
+
+
+Section 5 -- Disclaimer of Warranties and Limitation of Liability.
+
+  a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
+     EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
+     AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
+     ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
+     IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
+     WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
+     PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
+     ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
+     KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
+     ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.
+
+  b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
+     TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
+     NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
+     INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
+     COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
+     USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
+     ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
+     DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
+     IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.
+
+  c. The disclaimer of warranties and limitation of liability provided
+     above shall be interpreted in a manner that, to the extent
+     possible, most closely approximates an absolute disclaimer and
+     waiver of all liability.
+
+
+Section 6 -- Term and Termination.
+
+  a. This Public License applies for the term of the Copyright and
+     Similar Rights licensed here. However, if You fail to comply with
+     this Public License, then Your rights under this Public License
+     terminate automatically.
+
+  b. Where Your right to use the Licensed Material has terminated under
+     Section 6(a), it reinstates:
+
+       1. automatically as of the date the violation is cured, provided
+          it is cured within 30 days of Your discovery of the
+          violation; or
+
+       2. upon express reinstatement by the Licensor.
+
+     For the avoidance of doubt, this Section 6(b) does not affect any
+     right the Licensor may have to seek remedies for Your violations
+     of this Public License.
+
+  c. For the avoidance of doubt, the Licensor may also offer the
+     Licensed Material under separate terms or conditions or stop
+     distributing the Licensed Material at any time; however, doing so
+     will not terminate this Public License.
+
+  d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
+     License.
+
+
+Section 7 -- Other Terms and Conditions.
+
+  a. The Licensor shall not be bound by any additional or different
+     terms or conditions communicated by You unless expressly agreed.
+
+  b. Any arrangements, understandings, or agreements regarding the
+     Licensed Material not stated herein are separate from and
+     independent of the terms and conditions of this Public License.
+
+
+Section 8 -- Interpretation.
+
+  a. For the avoidance of doubt, this Public License does not, and
+     shall not be interpreted to, reduce, limit, restrict, or impose
+     conditions on any use of the Licensed Material that could lawfully
+     be made without permission under this Public License.
+
+  b. To the extent possible, if any provision of this Public License is
+     deemed unenforceable, it shall be automatically reformed to the
+     minimum extent necessary to make it enforceable. If the provision
+     cannot be reformed, it shall be severed from this Public License
+     without affecting the enforceability of the remaining terms and
+     conditions.
+
+  c. No term or condition of this Public License will be waived and no
+     failure to comply consented to unless expressly agreed to by the
+     Licensor.
+
+  d. Nothing in this Public License constitutes or may be interpreted
+     as a limitation upon, or waiver of, any privileges and immunities
+     that apply to the Licensor or You, including from the legal
+     processes of any jurisdiction or authority.
+
+
+=======================================================================
+
+Creative Commons is not a party to its public
+licenses. Notwithstanding, Creative Commons may elect to apply one of
+its public licenses to material it publishes and in those instances
+will be considered the “Licensor.” The text of the Creative Commons
+public licenses is dedicated to the public domain under the CC0 Public
+Domain Dedication. Except for the limited purpose of indicating that
+material is shared under a Creative Commons public license or as
+otherwise permitted by the Creative Commons policies published at
+creativecommons.org/policies, Creative Commons does not authorize the
+use of the trademark "Creative Commons" or any other trademark or logo
+of Creative Commons without its prior written consent including,
+without limitation, in connection with any unauthorized modifications
+to any of its public licenses or any other arrangements,
+understandings, or agreements concerning use of licensed material. For
+the avoidance of doubt, this paragraph does not form part of the
+public licenses.
+
+Creative Commons may be contacted at creativecommons.org.
+

README.md

@@ -1,3 +1,55 @@
-# Action-Component-Check-Demo
+# Action Component Check Demo
 
-Check components in design review before merging using Beagle AI (https://beagley-ai.org) reference design.
+*This repository is inteded to demonstrate how to use AllSpice Actions to create a component*
+*check report. The ECAD design files referenced here were not developed by AllSpice.*
+
+BeagleY®-AI is a powerful 64-bit quad core single board computer with GPU, DSP, and vision/deep learning accelerator. 
+
+| Front      |  Back |
+| :-------------------------: | :-------------------------: |
+| <img src="images/beagley-ai-board-front.webp" alt="drawing" width="740"/>  | <img src="images/beagley-ai-board-back.webp" alt="drawing" width="740"/>|
+
+OSHW Certification: https://certification.oshwa.org/us002616.html
+
+Features and purchase information at https://beagley-ai.org
+
+## Features
+
+| Feature               | Description                                                                                                |
+|-----------------------|------------------------------------------------------------------------------------------------------------|
+| Processor             | TI AM67 with Quad core 64-bit Arm® Cortex®-A53, GPU, DSP, and vision/deep learning accelerators            |
+| RAM                   | 4GB LPDDR4                                                                                                 |
+| Wi-Fi                 | BeagleBoard BM3301, 802.11ax Wi-Fi                                                                         |
+| Bluetooth             | Bluetooth Low Energy 5.4 (BLE)                                                                             |
+| USB Ports             | 4 x USB 3.0 TypeA ports supporting simultaneous 5Gbps operation, 1 x USB 2.0 TypeC supports USB 2.0 device |
+| Ethernet              | Gigabit Ethernet, with PoE+ support (requires separate PoE+ HAT)                                           |
+| Camera/Display        | 1 x 4-lane MIPI camera/display transceivers, 1 x 4-lane MIPI camera                                        |
+| Display Output        | 1 x HDMI display, 1 x OLDI display                                                                         |
+| Real-time Clock (RTC) | Supports an external button battery for power failure time retention. it is only populated on EVT samples. |
+| Debug UART            | 1 x 3-pin debug UART                                                                                       |
+| Power                 | 5V/5A DC power via USB-C, with Power Delivery support                                                      |
+| Power Button          | On/Off included                                                                                            |
+| PCIe Interface        | PCI-Express® Gen3 x 1 interface for fast peripherals (requires separate M.2 HAT or other adapter)          |
+| Expansion Connector   | 40-pin header                                                                                              |
+| Fan connector         | 1 x 4-pin fan connector, supports PWM speed control and speed measurement                                  |
+| Storage               | microSD card slot, with support for high-speed SDR104 mode                                                 |
+| Tag Connect           | 1 x JTAG, 1 x Tag Connect for PMIC NVM Programming                                                         |
+
+## Components location
+
+### Front
+
+![BegleY-AI front annotated](images/beagley-ai-board-front-annotated.webp)
+
+
+### Back
+
+![BeagleY-AI back annotated](images/beagley-ai-board-back-annotated.webp)
+
+## Block diagram
+
+![BeagleY-AI Block Diagram](design/BeagleY-AI_Rev_A_BLOCK_DIAGRAM_240426.png)
+
+## Mechanical Drawing
+
+![BeagleY-AI Mechanical Drawing](design/mechanical_drawing.png)

certification/README.md

@@ -0,0 +1,36 @@
+# Certifications
+
+The list below includes all the certification documents for BeagleY-AI
+
+## CE-EMC
+
+* [EED32Q807344_EN_301489_17_report.pdf](CE/CE-EMC/EED32Q807344_EN_301489_17_report.pdf)
+* [EED32Q807345_EN_55032_report.pdf](CE/CE-EMC/EED32Q807345_EN_55032_report.pdf)
+
+## CE-LVD
+
+* [EED31Q807347_Test_Report.pdf](CE/CE-LVD/EED31Q807347_Test_Report.pdf)
+
+## CE-RED
+
+* [EED32Q807342_cert.pdf](CE/CE-RED/EED32Q807342_cert.pdf)
+* [EED32Q80734203_EN_50665.pdf](CE/CE-RED/EED32Q80734203_EN_50665.pdf)
+* [EED32Q80734201_Appendix_Bluetooth_LE.pdf](CE/CE-RED/EED32Q80734201_Appendix_Bluetooth_LE.pdf)
+* [EED32Q80734202_Appendix_2.4G_Wi-Fi.pdf](CE/CE-RED/EED32Q80734202_Appendix_2.4G_Wi-Fi.pdf)
+* [EED32Q80734201_ETSI-EN_300_328_V2.2.2_(2019-07)_Bluetooth_LE_test_report.pdf](CE/CE-RED/EED32Q80734201_ETSI-EN_300_328_V2.2.2_(2019-07)_Bluetooth_LE_test_report.pdf)
+* [EED32Q80734202_ETSI_EN_300_328_V2.2.2_(2019-07)_2.4G_Wi-Fi_test_report.pdf](CE/CE-RED/EED32Q80734202_ETSI_EN_300_328_V2.2.2_(2019-07)_2.4G_Wi-Fi_test_report.pdf)
+
+
+## FCC-SDOC
+
+* [EED32Q807348_FCC_15B_SDOC.pdf](FCC-SDOC/EED32Q807348_FCC_15B_SDOC.pdf)
+* [EED32Q807348_FCC15B_SDOC_report.pdf](FCC-SDOC/EED32Q807348_FCC15B_SDOC_report.pdf)
+
+## ROHS
+
+* [SZ24050223R01_Seeed_BeagleY-AI_ROHS.pdf](ROHS/SZ24050223R01_Seeed_BeagleY-AI_ROHS.pdf)
+
+## REACH
+
+* [SZ24050223R02_Seeed_BeagleY-AI_REACH.pdf](REACH/SZ24050223R02_Seeed_BeagleY-AI_REACH.pdf)
+