Skip to content

Commit

Permalink
Merge pull request #25 from Kampi/2.0.5_Dev
Browse files Browse the repository at this point in the history
Hardware release 2.0.5
  • Loading branch information
jakkra committed Jul 17, 2024
2 parents c04a862 + 08bcce4 commit 3c5d049
Show file tree
Hide file tree
Showing 34 changed files with 38,162 additions and 608,107 deletions.
1 change: 0 additions & 1 deletion .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# These are supported funding model platforms

github: [jakkra, Kampi]

81 changes: 81 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
name: Build

on:
push:
pull_request:

jobs:
build:
runs-on: ubuntu-22.04

permissions:
contents: write

env:
KICAD_LIBRARY: /home/runner/work/ZSWatch-HW/ZSWatch-HW/library

strategy:
matrix:
device_type: [Watch, Sensor]
include:
- device_type: Watch
NewImage: 1

steps:
- name: Checkout
uses: actions/checkout@v3
with:
path: .
submodules: recursive

- name: Dependencies
run: |
sudo apt update
wget https://github.com/INTI-CMNB/KiBot/releases/download/v1.6.3/kibot_1.6.3-1_all.deb
sudo apt install ./kibot*_all.deb
wget https://github.com/INTI-CMNB/InteractiveHtmlBom/releases/download/v2.7.0-1/interactivehtmlbom.inti-cmnb_2.7.0-1_all.deb
sudo apt install ./interactivehtmlbom.inti-cmnb_2.7.0-1_all.deb
wget https://github.com/INTI-CMNB/KiAuto/releases/download/v2.2.8/kiauto_2.2.8-1_all.deb
sudo apt install ./kiauto_2.2.8-1_all.deb
sudo add-apt-repository --yes ppa:kicad/kicad-7.0-releases
sudo apt install --install-recommends kicad
git clone https://github.com/Kampi/KiCad.git library
- name: Extract branch name
shell: bash
run: echo "branch=${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}" >> $GITHUB_OUTPUT
id: extract_branch

- name: Initialize
run: |
mkdir -p docs/images/
mkdir production
- name: Generate files
run: |
cd project
kibot -g variant=${{ matrix.device_type }} -d ../production/${{ matrix.device_type }}
- name: Upload Results
uses: actions/upload-artifact@v3
with:
name: ${{ matrix.device_type }}
path: |
production
if-no-files-found: ignore

- if: ${{ matrix.NewImage }}
name: Update image
run: |
git config --local user.name "github-actions[bot]"
git config --local user.email "github-actions[bot]@users.noreply.github.com"
cp production/${{ matrix.device_type }}/docs/images/PCB_Rendering.png docs/images/Image_Complete.png
git add docs/images/Image_Complete.png
git commit -m "Add image from CI/CD action"
git remote set-url origin https://${{ github.actor }}:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}
echo https://${{ github.actor }}:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}
git push origin ${{ steps.extract_branch.outputs.branch }}
29 changes: 0 additions & 29 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,29 +0,0 @@
# For PCBs designed using KiCad: https://www.kicad.org/
# Format documentation: https://kicad.org/help/file-formats/

# Temporary files
*.000
*.bak
*.bck
*.kicad_pcb-bak
*.kicad_sch-bak
*-backups
*.kicad_prl
*.sch-bak
*~
_autosave-*
*.tmp
*-save.pro
*-save.kicad_pcb
fp-info-cache

# Netlist files (exported from Eeschema)
*.net

# Autorouter files (exported from Pcbnew)
*.dsn
*.ses

# Exported BOM files
*.xml
*.csv
35 changes: 35 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,40 @@
# CHANGELOG

## [2.0.5] -

**Added:**

- Add nPM1300 as power management solution
- Add QR code with projects GitHub URL
- Add solder bridge for current measuring
- Add I2S microphone
- Add buzzer
- Add USB support (experimental)
- Add marker for display cable orientation
- Add markers for better IC placements
- Add PCB cutout for BME688 sensor
- Add MX25L51245GZ2I Flash memory
- Add RV-8263-C8 RTC

**Changed:**

- Change value for ISET resistor from 10k to 12k
- Move BTN_2 from P0.30 to P1.10
- Move BTN_3 from P1.12 to P0.31
- Move DRV_VIB_EN from P1.14 to P1.05
- Move BMI270_IN1 from P0.21 to P1.08
- Move BMI270_IN2 from P0.19 to P1.04
- Move DRV_VIB_PWM from P1.15 to P1.05
- Move DRV_VIB_EN from P1.05 to P1.15
- Move BTN_4 from P1.06 to P0.26
- Replace ESDALC6V1W5 with ESDALC6V1P5

**Removed:**

- Remove GPIO pads
- Remove BMP581 INT
- Remove copper under BME688 sensor

## [2.0.4] - 29.10.2023

**Added:**
Expand Down
58 changes: 54 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,80 @@
# ZSWatch Hardware

[![License](https://img.shields.io/badge/License-GPL%203.0-blue.svg)](https://opensource.org/license/gpl-3-0/)
![Badge](https://github.com/jakkra/zswatch-hw/actions/workflows/build.yml/badge.svg?color=yellow)

## Table of Contents

- [ZSWatch Hardware](#zswatch-hardware)
- [Table of Contents](#table-of-contents)
- [About](#about)
- [Dock connector](#dock-connector)
- [Directory structure](#directory-structure)
- [Purchasing](#purchasing)
- [Maintainer](#maintainer)

## About

Hardware repository for the [ZSWatch](https://github.com/jakkra/ZSWatch).

![PCB Top side](/docs/images/Preview.png)
![PCB Top side](/docs/images/Image_Complete.png)

Please check the [wiki](https://github.com/jakkra/ZSWatch/wiki) for more information about the project.

## Dock connector

The pinout for the dock connector is shown below.

<table class="tg">
<thead>
<tr>
<th class="tg-0pky"></th>
<th class="tg-0pky">Pin</th>
<th class="tg-0pky">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tg-0pky" rowspan="5"><img src="docs/images/Dock-Connector.png" alt="Dock connector"></td>
<td class="tg-0pky">1</td>
<td class="tg-0pky">VBUS (+5 V)</td>
</tr>
<tr>
<td class="tg-0pky">2</td>
<td class="tg-0pky">GND</td>
</tr>
<tr>
<td class="tg-0pky">3</td>
<td class="tg-0pky">SEL</td>
</tr>
<tr>
<td class="tg-0lax">4</td>
<td class="tg-0lax">D- / SWDIO</td>
</tr>
<tr>
<td class="tg-0lax">5</td>
<td class="tg-0lax">D+ / SWDCLK</td>
</tr>
</tbody>
</table>

| SEL | Function |
|------|----------------|
|`LOW` | USB |
|`HIGH`| SWD (Default) |

## Directory structure

- `cad`: 3D model of the complete PCB
- `docs`: All kind of project documentation like schematics, BOM, etc.
- `docs`: All kinds of project documentation like schematics, BOM, etc.
- `drawings`: 2D drawings for subcomponents, etc.
- `images`
- `production`: Production files for the PCB
- `PCBWay`: Ordering instructions and production files ready for ordering at [PCBWay](https://www.pcbway.com/)
- `project`: KiCad project for the PCB

## Purchasing

Please open `ZSWatch-navigate.html` and use the files listed under `purchasing` for ordering a PCB.

## Maintainer

- [Daniel Kampert](mailto:daniel.kameprt@kampis-elektroecke.de)
Expand Down
Loading

0 comments on commit 3c5d049

Please sign in to comment.