Fix paths in workflow trigger (#3)

Reviewed-on: https://git.mercurial-manifold.eu/an.tsouchlos/commonsense-hw/pulls/3
Co-authored-by: Andreas Tsouchlos <an.tsouchlos@gmail.com>
Co-committed-by: Andreas Tsouchlos <an.tsouchlos@gmail.com>

.gitattributes

@@ -0,0 +1,7 @@
+*.csv filter=bom_csv
+*.html filter=bom_html
+*.gbr filter=gerber
+*.gbrjob filter=gbrjob
+*.xml filter=xml
+*.kicad_pcb filter=kicad_pcb_f
+*.net filter=net_filter

.gitconfig

@@ -0,0 +1,20 @@
+[filter "bom_csv"]
+	clean = sed -E 's/^BoM Date:.*$/BoM Date:Date/'
+	smudge = sed -E \"s/BoM Date:Date/BoM Date:,`date +\\\"%a %d %b %Y %X %:::z\\\"`/\"
+[filter "bom_html"]
+	clean = sed -E 's/^<tr><td>BoM Date<\\/td><td>.*$/<tr><td>BoM Date<\\/td><td>Date<\\/td><\\/tr>/'
+	smudge = sed -E \"s/<tr><td>BoM Date<\\/td><td>Date<\\/td><\\/tr>/<tr><td>BoM Date<\\/td><td>`date +\\\"%a %d %b %Y %X %:::z\\\"`<\\/td><\\/tr>/\"
+[filter "gerber"]
+	clean = sed -E -e 's/^%TF.CreationDate,.*$/%TF.CreationDate,Date%/' -e 's/^G04 Created by KiCad.*$/G04 Created by KiCad*/'
+	smudge = sed -E \"s/%TF.CreationDate,Date%/%TF.CreationDate,`date +%Y-%m-%dT%H:%M:%S%:z`/\"
+[filter "gbrjob"]
+	clean = sed -E 's/\"CreationDate\":.*/\"CreationDate\":  \"Date\"/'
+	smudge = sed -E \"s/\\\"CreationDate\\\":  \\\"Date\\\"/\\\"CreationDate\\\":  \\\"`date +%Y-%m-%dT%H:%M:%S%:z`\\\"/\"
+[filter "xml"]
+	clean = sed -E -e 's/^        <date>.*<\\/date>/        <date>Date2<\\/date>/' -e 's/^    <date>.*<\\/date>/    <date>Date1<\\/date>/'
+	smudge = sed -E -e \"s/<date>Date1<\\/date>/<date>`date +\\\"%a %d %b %Y %X %:::z\\\"`<\\/date>/\" -e \"s/<date>Date2<\\/date>/<date>`date +\\\"%Y-%m-%d\\\"`<\\/date>/\"
+[filter "kicad_pcb_f"]
+	clean = sed -E 's/\\(host pcbnew ([[:digit:]]+\\.[[:digit:]]+\\.[[:digit:]]+).*/\\(host pcbnew \\1\\)/'
+[filter "net_filter"]
+	clean = sed -E -e 's/\\(date \\\".*\\\"\\)/\\(date \\\"Date\\\"\\)/'
+	smudge = sed -E -e \"s/\\(date \\\"Date\\\"\\)/\\(date \\\"`date +\\\"%a %d %b %Y %X %:::z\\\"`\\\"\\)/\"

.gitea/workflows/doc-generation.yml

@@ -0,0 +1,23 @@
+name: docs-generation
+
+on:
+  pull_request:
+    paths:
+      - '**.kicad_sch'
+      - '**.kicad_pcb'
+      - '**.kicad_pro'
+
+jobs:
+  docs-generation:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: INTI-CMNB/KiBot@v1.8.1
+      with:
+        config: config.kibot.yaml
+        schema: 'CommonSense.kicad_sch'
+        board: 'CommonSense.kicad_pcb'
+    - name: upload results
+      uses: stefanzweifel/git-auto-commit-action@v5
+      with:
+        commit_message: 'Update Docs'

CommonSense.kicad_pcb

@@ -1117,7 +1117,7 @@
         (effects (font (size 1 1) (thickness 0.15)))
       (tstamp 4d0d0f4e-60f8-40b8-831b-2879064fe6a1)
     )
-    (fp_text value "12pF" (at 0 1.43) (layer "F.Fab") hide
+    (fp_text value "8pF" (at 0 1.43) (layer "F.Fab") hide
         (effects (font (size 1 1) (thickness 0.15)))
       (tstamp af8e39ea-4ab7-49d9-bc2c-bac479dad35e)
     )
@@ -1296,7 +1296,7 @@
         (effects (font (size 1 1) (thickness 0.15)))
       (tstamp c5408479-fcb4-4bb0-868d-04330df6c353)
     )
-    (fp_text value "R" (at 0 1.43) (layer "F.Fab") hide
+    (fp_text value "1k" (at 0 1.43) (layer "F.Fab") hide
         (effects (font (size 1 1) (thickness 0.15)))
       (tstamp 78036180-2815-4af3-b7bb-6cfe9e575331)
     )
@@ -1695,6 +1695,7 @@
     (tags "SHT41-AD1B-R2 ")
     (property "Sheetfile" "CommonSense.kicad_sch")
     (property "Sheetname" "")
+    (property "ki_description" "High-Accuracy, Ultra-Low-Power, 16-bit\nRelative Humidity and Temperature Sensor")
     (property "ki_keywords" "SHT41-AD1B-R2")
     (path "/b1f01907-6dae-49d7-93f3-08443a766ba4")
     (attr smd)
@@ -2096,7 +2097,7 @@
         (effects (font (size 1 1) (thickness 0.15)))
       (tstamp 6aa30f95-9900-4656-a6d3-e758d121ca84)
     )
-    (fp_text value "12pF" (at 0 1.43) (layer "F.Fab") hide
+    (fp_text value "8pF" (at 0 1.43) (layer "F.Fab") hide
         (effects (font (size 1 1) (thickness 0.15)))
       (tstamp 2083d71e-2de1-4e3b-b278-120756276b53)
     )

CommonSense.kicad_sch

@@ -2685,7 +2685,7 @@
     (property "Reference" "C2" (at 104.14 91.44 90)
       (effects (font (size 1.27 1.27)))
     )
-    (property "Value" "12pF" (at 104.14 97.79 90)
+    (property "Value" "19p" (at 104.14 97.79 90)
       (effects (font (size 1.27 1.27)))
     )
     (property "Footprint" "Capacitor_SMD:C_0603_1608Metric" (at 102.87 94.9452 0)
@@ -2802,7 +2802,7 @@
     (property "Reference" "C8" (at 220.98 87.63 90)
       (effects (font (size 1.27 1.27)))
     )
-    (property "Value" "100pF" (at 228.6 87.63 90)
+    (property "Value" "100p" (at 228.6 87.63 90)
       (effects (font (size 1.27 1.27)))
     )
     (property "Footprint" "Capacitor_SMD:C_0603_1608Metric" (at 228.6 89.2048 0)
@@ -3070,7 +3070,7 @@
     (property "Footprint" "encyclopedia_galactica:ECS-.327-12.5-12R-TR" (at 115.57 87.63 0)
       (effects (font (size 1.27 1.27)) hide)
     )
-    (property "Datasheet" "~" (at 115.57 87.63 0)
+    (property "Datasheet" "https://www.mouser.de/datasheet/2/122/ECX-12R-1314062.pdf" (at 115.57 87.63 0)
       (effects (font (size 1.27 1.27)) hide)
     )
     (pin "1" (uuid 5a2aa3bd-5659-4e6a-b123-a1d9ca4228b6))
@@ -3208,7 +3208,7 @@
     (property "Reference" "C1" (at 109.22 85.09 90)
       (effects (font (size 1.27 1.27)))
     )
-    (property "Value" "12pF" (at 104.14 85.09 90)
+    (property "Value" "19p" (at 104.14 85.09 90)
       (effects (font (size 1.27 1.27)))
     )
     (property "Footprint" "Capacitor_SMD:C_0603_1608Metric" (at 102.87 80.3148 0)
@@ -3239,7 +3239,7 @@
     (property "Reference" "C10" (at 248.92 62.23 90)
       (effects (font (size 1.27 1.27)))
     )
-    (property "Value" "8pF" (at 254 62.23 90)
+    (property "Value" "8p" (at 254 62.23 90)
       (effects (font (size 1.27 1.27)))
     )
     (property "Footprint" "Capacitor_SMD:C_0603_1608Metric" (at 255.27 65.0748 0)
@@ -3625,7 +3625,7 @@
     (property "Reference" "C12" (at 245.11 104.14 0)
       (effects (font (size 1.27 1.27)) (justify right))
     )
-    (property "Value" "0.8pF" (at 245.11 106.68 0)
+    (property "Value" "0.8p" (at 245.11 106.68 0)
       (effects (font (size 1.27 1.27)) (justify right))
     )
     (property "Footprint" "Capacitor_SMD:C_0603_1608Metric" (at 249.8852 101.6 0)
@@ -3650,16 +3650,16 @@
     )
   )
 
-  (symbol (lib_id "Device:R") (at 72.39 44.45 0) (mirror y) (unit 1)
+  (symbol (lib_id "Device:R") (at 72.39 44.45 0) (unit 1)
-    (in_bom yes) (on_board yes) (dnp no) (fields_autoplaced)
+    (in_bom yes) (on_board yes) (dnp no)
     (uuid 912785de-b81a-44ce-853b-c26bea5861e7)
     (property "Reference" "R1" (at 69.85 43.18 0)
-      (effects (font (size 1.27 1.27)) (justify left))
+      (effects (font (size 1.27 1.27)) (justify right))
     )
-    (property "Value" "R" (at 69.85 45.72 0)
+    (property "Value" "1k" (at 69.85 45.72 0)
-      (effects (font (size 1.27 1.27)) (justify left))
+      (effects (font (size 1.27 1.27)) (justify right))
     )
-    (property "Footprint" "Resistor_SMD:R_0603_1608Metric" (at 74.168 44.45 90)
+    (property "Footprint" "Resistor_SMD:R_0603_1608Metric" (at 70.612 44.45 90)
       (effects (font (size 1.27 1.27)) hide)
     )
     (property "Datasheet" "~" (at 72.39 44.45 0)
@@ -4177,7 +4177,7 @@
     (property "Reference" "C11" (at 248.92 82.55 90)
       (effects (font (size 1.27 1.27)))
     )
-    (property "Value" "8pF" (at 254 82.55 90)
+    (property "Value" "8p" (at 254 82.55 90)
       (effects (font (size 1.27 1.27)))
     )
     (property "Footprint" "Capacitor_SMD:C_0603_1608Metric" (at 255.27 79.7052 0)

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Andreas Tsouchlos
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,10 +1,17 @@
 # CommonSense
 
-A BLE-based PCB for measuring humidity and temperature
+A BLE-based PCB for measuring humidity and temperature.
 
-## Downloading libraries
+After cloning, the libraries can be downloaded using
-
-After cloning, the libraries have to be downloaded using
 ```bash
 $ git submodule update --init
 ```
+
+## PCB
+
+<img width=400 src="./doc/generated/CommonSense-top.svg" />
+<img width=400 src="./doc/generated/CommonSense-bottom.svg" />
+
+## Schematic
+
+<img src="./doc/generated/CommonSense-schematic.svg" />

config.kibot.yaml

@@ -0,0 +1,50 @@
+kibot:
+  version: 1
+
+outputs:
+  - name: 'schematic pdf'
+    comment: 'Schematic pdf generation'
+    type: 'pdf_sch_print'
+    dir: 'doc/generated'
+  - name: 'schematic svg'
+    comment: 'Schematic pdf generation'
+    type: 'svg_sch_print'
+    dir: 'doc/generated'
+    options:
+      background_color: true
+  - name: 'pcbdraw top svg'
+    comment: 'PCB top image generation'
+    type: 'pcbdraw'
+    dir: 'doc/generated'
+    options:
+      bottom: false
+      style: 'set-blue-cu'
+      show_components: 'none'
+  - name: 'pcbdraw top pdn'
+    comment: 'PCB top image generation'
+    type: 'pcbdraw'
+    dir: 'doc/generated'
+    options:
+      format: 'png'
+      dpi: 600
+      bottom: false
+      style: 'set-blue-cu'
+      show_components: 'none'
+  - name: 'pcbdraw bottom svg'
+    comment: 'PCB bottom image generation'
+    type: 'pcbdraw'
+    options:
+      bottom: true
+      style: 'set-blue-cu'
+      show_components: 'none'
+    dir: 'doc/generated'
+  - name: 'pcbdraw bottom png'
+    comment: 'PCB bottom image generation'
+    type: 'pcbdraw'
+    options:
+      format: 'png'
+      dpi: 600
+      bottom: true
+      style: 'set-blue-cu'
+      show_components: 'none'
+    dir: 'doc/generated'