diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml deleted file mode 100644 index ff0787a..0000000 --- a/.github/workflows/documentation.yml +++ /dev/null @@ -1,103 +0,0 @@ -name: Documentation - -on: - push: - branches: - - main - workflow_dispatch: - inputs: - version: - description: "Design version" - required: true - default: "pre-release" - -env: - # Set this to the base filename of your project. - BaseFileName: MS20-VCF - # Set this to your local timezone. See https://www.wikiwand.com/en/List_of_tz_database_time_zones for valid strings. - Timezone: Europe/Paris - # Set this to the output folder for all of the generated files. Unless you have a very - # good reason to change this you should leave it as KiBotOutput. - BOMFolder: bom - # Set this to the output folder for all of the generated files. Unless you have a very - # good reason to change this you should leave it as KiBotOutput. - DocFolder: documentation - # Set this to the output folder for all of the generated files. Unless you have a very - # good reason to change this you should leave it as KiBotOutput. - GerberFolder: gerber - # Set this to the version to include in the schematic and PCB. Since this - # script runs outside of the release process it can't pull a version - # number automatically from GitHub.. - Version: pre-release - -jobs: - Documentation-global: - - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v3 - - # Get the current date - - name: Get current date - id: date_only - run: echo "{date_only}={$(TZ='${{ env.Timezone }}' date +'%Y-%m-%d')}" >> $GITHUB_OUTPUT - - - name: Generate schematic documentation - uses: INTI-CMNB/KiBot@v2_k6 - with: - # Required - kibot config file - config: .kibot/config_doc_global.kibot.yaml - dir: ${{ env.DocFolder }} - schema: kicad-global/${{ env.BaseFileName }}.kicad_sch - board: kicad-global/${{ env.BaseFileName }}.kicad_pcb - - # Archive all the artifacts from output and attach to the action's results. - - name: Archive production artifacts - uses: actions/upload-artifact@v3 - with: - name: ${{ env.BaseFileName }}-Doc-${{ github.event.inputs.version }}-${{ steps.date_only.outputs.date_only }} - path: ${{ env.DocFolder }}/** - - #Commit all the outputs to folder - - name: Add & Commit - uses: EndBug/add-and-commit@v9.1.1 - with: - default_author: github_actions - message: 'add main BoM and images' - pull: '--ff-only' - #tag: ${{ env.Version }} - - BOM-jack: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v3 - - # Get the current date - - name: Get current date - id: date_only - run: echo "{date_only}={$(TZ='${{ env.Timezone }}' date +'%Y-%m-%d')}" >> $GITHUB_OUTPUT - - - name: Generate schematic documentation - uses: INTI-CMNB/KiBot@v2_k6 - with: - # Required - kibot config file - config: .kibot/config_bom_jack.kibot.yaml - dir: ${{ env.DocFolder }} - schema: kicad-global/${{ env.BaseFileName }}.kicad_sch - board: fabrication/jackboard/${{ env.BaseFileName }}.kicad_pcb - - # Archive all the artifacts from output and attach to the action's results. - - name: Archive production artifacts - uses: actions/upload-artifact@v3 - with: - name: ${{ env.BaseFileName }}-jackboard-${{ github.event.inputs.version }}-${{ steps.date_only.outputs.date_only }} - path: ${{ env.DocFolder }}/** - - #Commit all the outputs to folder - - name: Add & Commit - uses: EndBug/add-and-commit@v9.1.1 - with: - default_author: github_actions - message: 'add jack BoM' - pull: '--ff-only' - #tag: ${{ env.Version }} diff --git a/.github/workflows/gerber.yml b/.github/workflows/gerber.yml deleted file mode 100644 index dfafaa4..0000000 --- a/.github/workflows/gerber.yml +++ /dev/null @@ -1,100 +0,0 @@ -name: Gerber - -on: - push: - branches: - - main - workflow_dispatch: - inputs: - version: - description: "Design version" - required: true - default: "pre-release" - -env: - # Set this to the base filename of your project. - BaseFileName: MS20-VCF - # Set this to your local timezone. See https://www.wikiwand.com/en/List_of_tz_database_time_zones for valid strings. - Timezone: Europe/Paris - # Set this to the output folder for all of the generated files. Unless you have a very - # good reason to change this you should leave it as KiBotOutput. - BOMFolder: bom - # Set this to the output folder for all of the generated files. Unless you have a very - # good reason to change this you should leave it as KiBotOutput. - DocFolder: documentation - # Set this to the output folder for all of the generated files. Unless you have a very - # good reason to change this you should leave it as KiBotOutput. - GerberFolder: gerber - # Set this to the version to include in the schematic and PCB. Since this - # script runs outside of the release process it can't pull a version - # number automatically from GitHub.. - Version: pre-release - -jobs: - Gerber-front: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v3 - - # Get the current date - - name: Get current date - id: date_only - run: echo "{date_only}={$(TZ='${{ env.Timezone }}' date +'%Y-%m-%d')}" >> $GITHUB_OUTPUT - - - name: Generate gerber documentation - uses: INTI-CMNB/KiBot@v2_k6 - with: - # Required - kibot config file - config: .kibot/config_fab_front.kibot.yaml - dir: ${{ env.GerberFolder }} - board: fabrication/front/${{ env.BaseFileName }}.kicad_pcb - - # Archive all the artifacts from output and attach to the action's results. - - name: Archive production artifacts - uses: actions/upload-artifact@v3 - with: - name: ${{ env.BaseFileName }}-Front-${{ github.event.inputs.version }}-${{ steps.date_only.outputs.date_only }} - path: ${{ env.GerberFolder }}/** - - #Commit all the outputs to folder - - name: Add & Commit - uses: EndBug/add-and-commit@v9.1.1 - with: - default_author: github_actions - message: 'add front gerber' - pull: '--ff-only' - #tag: ${{ env.Version }} - - Gerber-jack: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v3 - - # Get the current date - - name: Get current date - id: date_only - run: echo "{date_only}={$(TZ='${{ env.Timezone }}' date +'%Y-%m-%d')}" >> $GITHUB_OUTPUT - - - name: Generate gerber documentation - uses: INTI-CMNB/KiBot@v2_k6 - with: - # Required - kibot config file - config: .kibot/config_fab_jack.kibot.yaml - dir: ${{ env.GerberFolder }} - board: fabrication/jackboard/${{ env.BaseFileName }}.kicad_pcb - - # Archive all the artifacts from output and attach to the action's results. - - name: Archive production artifacts - uses: actions/upload-artifact@v3 - with: - name: ${{ env.BaseFileName }}-jackboard-${{ github.event.inputs.version }}-${{ steps.date_only.outputs.date_only }} - path: ${{ env.GerberFolder }}/** - - #Commit all the outputs to folder - - name: Add & Commit - uses: EndBug/add-and-commit@v9.1.1 - with: - default_author: github_actions - message: 'add jack gerber' - pull: '--ff-only' - #tag: ${{ env.Version }} diff --git a/.github/workflows/jekyll-gh-pages.yml b/.github/workflows/jekyll-gh-pages.yml index 542bb77..10c2c0d 100644 --- a/.github/workflows/jekyll-gh-pages.yml +++ b/.github/workflows/jekyll-gh-pages.yml @@ -1,9 +1,14 @@ # Sample workflow for building and deploying a Jekyll site to GitHub Pages name: Deploy Jekyll with GitHub Pages dependencies preinstalled -on: push +on: + # Runs on pushes targeting the default branch + push: + branches: ["main"] + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: -# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages permissions: contents: read pages: write @@ -20,16 +25,16 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Setup Pages - uses: actions/configure-pages@v2 + uses: actions/configure-pages@v5 - name: Build with Jekyll uses: actions/jekyll-build-pages@v1 with: source: ./ destination: ./_site - name: Upload artifact - uses: actions/upload-pages-artifact@v1 + uses: actions/upload-pages-artifact@v3 # Deployment job deploy: @@ -38,8 +43,7 @@ jobs: url: ${{ steps.deployment.outputs.page_url }} runs-on: ubuntu-latest needs: build - if: github.ref == 'refs/heads/main' steps: - name: Deploy to GitHub Pages id: deployment - uses: actions/deploy-pages@v1 + uses: actions/deploy-pages@v4 diff --git a/.kibot/Populate.md b/.kibot/Populate.md deleted file mode 100644 index a5e286b..0000000 --- a/.kibot/Populate.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -layout: single ---- - -# Populate Manual for MS20-VCF - -Follow this manual to populate the PCB: - -The basic rule is, always go from the smallest to the highest component on the board ! - -- [[front | ]] This is the front side of the board we are populating -- [[back | ]] This is the back side of the board we are populating, and we are gonna start by this side. -- [[back | U1 ]] Start by the SMD components, here U1. -- [[back | FB2, FB1, R4 ]] After U1, do the beads and the resistor -- [[back | C9, C10, C5 ]] Do all the ceramic capacitors -- [[back | C6, C3, C2 ]] Finish the capacitors with the electrolytic ones, watch out for their orientation, they are polarized. -- [[back | D1, J5, ResLv1, ResVol1 ]] Finish the back by putting the trimmers, the power LED and the power connector. The LED shouldn't touch the backside of the PCB. - -The back is done, we can flip the PCB and start the front ! - -- [[front | ]] -- [[front | D2, D3, D4, D5, D6, D7 ]] First, populate all the diodes. -- [[front | R2, R6, R7, R11, R15, R16, R1, R3, R12, R13, R5, R9, R20, R8, R21, R22, R10, R19, R14, R17, R18 ]] You then can do all the resistors (by value so you don't make mistakes) -- [[front | Q1, Q2 ]] You then can add the transitors, watch out for their orientation. -- [[front | U2 ]] Add the socket for the TL072, making sure you get the orientation right. Don't add the Tl072 yet, you'll add it at the end. -- [[front | C1, C4 , C7, C8]] Add the capacitors - -The last step concern the jacks, potentiometers and switches. Basically, anything that is accessible throught the front panel. You first place them. - -:warning: DO NOT SOLDER THEM YET :warning: - -(this is really important !!) - -- [[front | SW1, CUTCV1, CUTOFF1, Res1, J6, J7, J8]] Do Not Solder Them! place them first and put the front panel in place. *For the pot **CUTCV1**, use the small 100k pot (not D shaped)* The other pots are for CUTOFF1 and Res1. You'll be able to put the" knobs of your choice on those. - -You then put in place the front panel, making sure everything fits. Once all the jack sockets and switches are fastenned to the front panel, you can solder them, and only then !!! - -## Conclusion - -This is the end of the build, if yoy have any questions, don't hesitate ! diff --git a/.kibot/config_bom_jack.kibot.yaml b/.kibot/config_bom_jack.kibot.yaml deleted file mode 100644 index c753b7f..0000000 --- a/.kibot/config_bom_jack.kibot.yaml +++ /dev/null @@ -1,31 +0,0 @@ - -kibot: - version: 1 - -outputs: - - -- name: basic_ibom - comment: Interactive HTML BoM - type: ibom - dir: bom - output_id: -jack - -- name: render_3d - comment: "How to draw a step" - type: render_3d - run_by_default: false - options: - format: png - ray_tracing: true - zoom: 3 - -- name: Populate - comment: "Guide de montage PCB" - type: populate - dir: guide-jack - output_id: -jack - options: - renderer: render_3d - format: md - input: .kibot/Populate.md \ No newline at end of file diff --git a/.kibot/config_doc_global.kibot.yaml b/.kibot/config_doc_global.kibot.yaml deleted file mode 100644 index 344e73b..0000000 --- a/.kibot/config_doc_global.kibot.yaml +++ /dev/null @@ -1,78 +0,0 @@ -# This is a working example. -# For a more complete reference use `--example` -kibot: - version: 1 - -outputs: - -- name: generic_bom_xlsx - comment: Generic Bill of Materials in XLSX format - type: bom - dir: bom - options: - format: XLSX - columns: - - Row - - Description - - References - - Value - - Footprint - - Quantity Per PCB - - Comment - group_fields: - - Value - - Footprint - count_smd_tht: true - xlsx: - logo: false - -- name: basic_ibom - comment: Interactive HTML BoM - type: ibom - dir: bom - output_id: -global - -- name: basic_pcbdraw_png_set_black_hasl_top - comment: PCB 2D render in PNG format, using set-black-hasl style - type: pcbdraw - dir: image - options: - style: set-black-hasl - format: png - -- name: basic_pdf_sch_print - comment: Schematic in PDF format - type: pdf_sch_print - dir: image -- name: basic_svg_sch_print - comment: Schematic in SVG format - type: svg_sch_print - dir: image - -- name: basic_render_3d_top - comment: 3D view from top - type: render_3d - dir: image - options: - ray_tracing: true - orthographic: true - zoom: 3 -- name: basic_render_3d_30deg - comment: 3D view from 30 degrees - type: render_3d - dir: image - output_id: 30deg - options: - ray_tracing: true - rotate_x: 3 - rotate_z: -2 - zoom: 3 -- name: basic_render_3d_bottom - comment: 3D view from bottom - type: render_3d - dir: image - options: - ray_tracing: true - orthographic: true - view: bottom - zoom: 3 diff --git a/Gemfile b/Gemfile index 1722f4f..96a1e3a 100644 --- a/Gemfile +++ b/Gemfile @@ -5,5 +5,6 @@ source 'https://rubygems.org' group :jekyll_plugins do gem "jekyll-include-cache" gem "jemoji" + gem "github-pages" end diff --git a/_config.yml b/_config.yml index 7a045a4..9f1dae8 100644 --- a/_config.yml +++ b/_config.yml @@ -1,4 +1,4 @@ -remote_theme: "mmistakes/minimal-mistakes@4.24.0" +remote_theme: "mmistakes/minimal-mistakes@4.26.2" liquid: error_mode: strict diff --git a/documentation/MS20-VCF_V1.2--Schematic.pdf b/documentation/MS20-VCF_V1.2--Schematic.pdf new file mode 100644 index 0000000..7f7b728 Binary files /dev/null and b/documentation/MS20-VCF_V1.2--Schematic.pdf differ diff --git a/documentation/bom/MS20-VCF-bom.xlsx b/documentation/bom/MS20-VCF-bom.xlsx deleted file mode 100644 index b69f876..0000000 Binary files a/documentation/bom/MS20-VCF-bom.xlsx and /dev/null differ diff --git a/documentation/bom/MS20-VCF-ibom-jack.html b/documentation/bom/MS20-VCF-ibom-jack.html deleted file mode 100644 index a444e63..0000000 --- a/documentation/bom/MS20-VCF-ibom-jack.html +++ /dev/null @@ -1,4428 +0,0 @@ - - - - - - - Interactive BOM for KiCAD - - - - - - -
-
-
-
- -
- - - -
- -
- - - - - - - - -
-
-
- - - -
-
- - - -
-
- - - -
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Board statsFrontBackTotal
Components~~~
Groups~~~
SMD pads~~~
TH pads~
- - - - - - - -
Checkboxes
-
-
-
- -
-
-
Save board image
-
- - X - -
- -
- - -
-
-
- Config and checkbox state -
- - -
-
-
- Save bom table as -
- - -
-
-
-
-
-
- - - - - - - - - - - -
- Title - - Revision -
- Company - - Date -
-
-
-
-
-
- - -
- -
-
-
- - - - - -
-
-
-
-
- - - - -
-
-
-
- - - - -
-
-
-
-
- - - - diff --git a/documentation/bom/MS20-VCF_V1.2--BoM.xlsx b/documentation/bom/MS20-VCF_V1.2--BoM.xlsx new file mode 100644 index 0000000..11071f1 Binary files /dev/null and b/documentation/bom/MS20-VCF_V1.2--BoM.xlsx differ diff --git a/documentation/bom/MS20-VCF-ibom-global.html b/documentation/bom/MS20-VCF_V1.2--iBoM.html similarity index 50% rename from documentation/bom/MS20-VCF-ibom-global.html rename to documentation/bom/MS20-VCF_V1.2--iBoM.html index ba7a905..1899001 100644 --- a/documentation/bom/MS20-VCF-ibom-global.html +++ b/documentation/bom/MS20-VCF_V1.2--iBoM.html @@ -148,7 +148,7 @@ .button-container { font-size: 0; - margin: 10px 10px 10px 0px; + margin: 0.4rem 0.4rem 0.4rem 0; } .dark .button-container { @@ -179,7 +179,7 @@ width: 100%; max-width: 1000px; border: none; - padding: 5px; + padding: 3px; } .fileinfo .title { @@ -539,7 +539,7 @@ .menu { position: relative; display: inline-block; - margin: 10px 10px 10px 0px; + margin: 0.4rem 0.4rem 0.4rem 0; } .menu-content { @@ -613,21 +613,74 @@ } .topmostdiv { + display: flex; + flex-direction: column; width: 100%; - height: 100%; background-color: white; transition: background-color 0.3s; + min-height: 100%; } #top { - height: 78px; + display: flex; + flex-wrap: wrap; + justify-content: flex-end; + align-items: center; +} + +#topdivider { border-bottom: 2px solid black; + display: flex; + justify-content: center; + align-items: center; } -.dark #top { +.dark #topdivider { border-bottom: 2px solid #ccc; } +#topdivider>div { + position: relative; +} + +#toptoggle { + cursor: pointer; + user-select: none; + position: absolute; + padding: 0.1rem 0.3rem; + top: -0.4rem; + left: -1rem; + font-size: 1.4rem; + line-height: 60%; + border: 1px solid black; + border-radius: 1rem; + background-color: #fff; + z-index: 100; +} + +.flipped { + transform: rotate(0.5turn); +} + +.dark #toptoggle { + border: 1px solid #fff; + background-color: #222; +} + +#fileinfodiv { + flex: 20rem 1 0; + overflow: auto; +} + +#bomcontrols { + display: flex; + flex-direction: row-reverse; +} + +#bomcontrols>* { + flex-shrink: 0; +} + #dbg { display: block; } @@ -812,6 +865,35 @@ border: 1px solid #00b9fd; } +.bom-color { + width: 20%; +} + +.color-column input { + width: 1.6rem; + height: 1rem; + border: 1px solid black; + cursor: pointer; + padding: 0; +} + +/* removes default styling from input color element */ +::-webkit-color-swatch { + border: none; +} + +::-webkit-color-swatch-wrapper { + padding: 0; +} + +::-moz-color-swatch, +::-moz-focus-inner { + border: none; +} + +::-moz-focus-inner { + padding: 0; +}