sirboard - GitLite

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #llm #android #machine-learning #deep-learning #linux #docker #macos #java #windows #awesome-list

sirboard

(★ 51)

Open hardware: 107 KiCad PCB designs — SMD-to-THT breakout adapters, ATTiny/ATMega/ESP development boards, and a 39-part sensor line on a common JST-SH connector.

파일 탐색기

최종 버전 다운로드 (.zip)

- - ci.yml
- favicon.ico
- icon-128.png
- icon-16.png
- icon-180.png
- icon-192.png
- icon-256.png
- icon-32.png
- icon-48.png
- icon-512.png
- icon-64.png
- icon-96.png
- icon.svg
- logo.svg
- open-source-hardware-white.svg
- open-source-hardware.svg
- sirboard-mark-small.svg
- sirboard-mark.svg
- sirboard.svg
- BOARDS.md
- BREAKOUTS.md
- FRITZING.md
- GETTING-STARTED.md
- LIBRARIES.md
- MANUFACTURING.md
- MODULES.md
- OVERVIEW.md
- SENSORS.md
- - CRYSTAL-RESONATOR-3Pin_3.0x1.1.svg
- - HLGA6.svg
- - MINIMELF.svg
- - B3U-1000P.svg
- - UFL.svg
- README.md
- check-render.mjs
- package.json
- sync-docs.sh
- - docs.css
  - og-card.png
  - sirboard.css
  - vulos-logo.png
- - boards.md
  - breakouts.md
  - contributing.md
  - fritzing.md
  - getting-started.md
  - libraries.md
  - manufacturing.md
  - modules.md
  - overview.md
  - sensors.md
- docs.html
- index.html
- conftest.py
- test_repo_integrity.py
.gitignore
CONTRIBUTING.md
LICENSE-APACHE
LICENSE-MIT
pytest.ini
README.md
requirements-dev.txt

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/vul-os/sirboard

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd sirboard

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

cd scripts

이 프로젝트의 관련 파일이 하위 폴더 안에 있어서, 먼저 그 폴더로 이동합니다.

npm install

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

npm start

개발/실행 서버를 켭니다.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<p align="center">
  <img src="brand/sirboard-mark.svg" width="88" alt="SirBoard">
</p>

<h1 align="center">SirBoard</h1>

<p align="center">
  <b>Open hardware for people who would rather prototype than reflow.</b><br>
  107 PCB designs — breakout adapters, development boards and a 39-part sensor line.<br>
  Routed in KiCad. Black soldermask, ENIG gold, 0.1&Prime; pitch.
</p>

## Brand

The mark in [`brand/`](brand/) is the source of truth. Every icon this repo
ships — favicon, PWA and app icons, the mark in the README and on the site — is
rendered from `brand/logo.svg` rather than redrawn, so there is one approved
drawing and no second copy to drift.

Copy it outward, never edit a derived copy, and never edit `brand/` to match
something downstream.

<p align="center">
  <a href="https://vulos.org/projects/sirboard"><b>vulos.org/projects/sirboard</b></a>
  ·
  <a href="docs/OVERVIEW.md">Docs</a>
  ·
  <a href="LICENSE-MIT">MIT OR Apache-2.0</a>
</p>

<p align="center">
  <a href="https://www.oshwa.org/definition/">
    <img src="brand/open-source-hardware.svg" width="76" alt="Open Source Hardware">
  </a>
</p>

<p align="center">
  <img src="Boards/Microcontrollers/SirTiny/ATTinyX16/ATTinyX16_Iso.jpg" width="47%" alt="SirTiny ATTinyX16 development board">
  <img src="Boards/Microcontrollers/SirIoT/ESP32/ESP32_Iso.jpg" width="47%" alt="SirIoT ESP32 board">
</p>

---

Most interesting silicon ships in a package that will not sit on a breadboard.
SirBoard answers that in three layers: **bare adapters** you solder the part
onto yourself, **modules** with the part already placed and supported, and
**development boards** with a microcontroller, regulator, USB and headers.

## What's here

| Directory | Contents |
|---|---|
| [`Boards/Breakout/`](Boards/Breakout) | **21 adapters** — QFN, TQFP, SOIC, SOT, USB, MicroSD, coin cells, ESP module carriers |
| [`Boards/Microcontrollers/`](Boards/Microcontrollers) | ATTiny, ATMega328PB/32U4/1284P, ESP32/ESP8266 and SIMCom GNSS carriers |
| [`Boards/Interface/`](Boards/Interface) | USB-to-UART bridges, level shifters, port expanders, a USBASP programmer |
| [`Boards/Sensors/`](Boards/Sensors) | **SirBlue** — 39 digital sensors on one 4-pin JST-SH connector, plus two earlier collections (DigitalSensors 12, AnalogueSensors 2) |
| [`Boards/Modules/`](Boards/Modules) | EEPROM, FRAM, real-time clocks — 5 designs |
| [`Fritzing/`](Fritzing) | 60 hand-drawn breadboard SVGs |

## Quick start

```bash
git clone git@github.com:vul-os/sirboard.git
cd sirboard

# most designs ship a plotted PDF and renders — no tools needed to read one
open Boards/Microcontrollers/SirTiny/ATTinyX16/ATTinyX16.pdf

# or open the project itself
kicad Boards/Microcontrollers/SirTiny/ATTinyX16/ATTinyX16.pro
```

These are **KiCad 5** files (board format `20171130`). KiCad 6 through 9 open
them and offer to convert on save.

## What state is this in?

Hardware repositories rot by ambiguity, so here it is plainly.

**Can you get these made? Yes.** Every one of the 107 designs is fully routed
2-layer copper with a board outline, and plots to gerbers from source with
`kicad-cli` or File → Plot. Nothing here needs a blind via, a buried via,
controlled impedance or a non-standard stack-up, and every outline fits inside a
100 × 100 mm panel. Seven of the fine-pitch breakouts need a 5 mil process
rather than 6 mil — they are named in
[Manufacturing](docs/MANUFACTURING.md#the-5-mil-figure-is-not-decoration--quote-it-to-the-fab).

**What is *not* claimed.** No DRC or ERC report is committed for any board, and
no fabrication or bring-up log exists in this repository. The `_Front`/`_Back`/
`_Iso` images are KiCad 3D-viewer renders, not photographs of assembled boards —
so do not read them as proof that a given design was built and worked. Treat
every design as prototype-grade: **run DRC yourself and read the schematic
before you spend money on a panel.** The catalogue has shipped at least one
unconnected trace in the past (commit `28e6714`, on the TQFP48 breakout), which
is exactly the class of defect a DRC run catches and a render does not.

**Is it maintained?** The designs are stable rather than actively developed. Two
directories under `Boards/` hold a README and no design —
[`Sensors/SirRed`](Boards/Sensors/SirRed) (an analogue line on a 3-pin JST-SH)
and [`Modules/SirReference`](Boards/Modules/SirReference) (voltage references) —
and they are stated intent, not work in progress; neither is counted in the 107.
What *is* maintained is the repository's honesty:
[CI](.github/workflows/ci.yml) gates the counts, coverage tables and fab
figures in these docs against the actual `.kicad_pcb` files on every push, so a
claim here cannot quietly drift away from the copper. Fixes to existing designs
are the most welcome kind of change.

## The sensor line

Every [SirBlue](Boards/Sensors/SirBlue) board carries the same 4-pin 1.00 mm JST-SH
connector — `GND · VCC · SDA · SCL` — and the same outline. One cable fits all
39 parts, so swapping an accelerometer for a time-of-flight ranger is a
connector move rather than a rewire. A
[TCA9548A](Boards/Interface/SirExpand/TCA9548A) multiplexer handles the address
collisions when you want eight of the same part.

## We don't ship driver libraries

Every part here is a standard part with a maintained driver already in the
wild, and [`docs/LIBRARIES.md`](docs/LIBRARIES.md) names the one to install for
each — Adafruit, Pololu, SparkFun, MCUdude's cores, TinyGSM, RTClib.

SirBoard used to fork them. Those forks accumulated no functional changes and
drifted up to 384 commits behind upstream, so they were retired. A stale
driver shipped under our name is worse than no driver at all.

## Documentation

| | |
|---|---|
| [Overview](docs/OVERVIEW.md) | What SirBoard is and how the repository is laid out |
| [Getting started](docs/GETTING-STARTED.md) | Open a design, wire a sensor, install a driver |
| [Breakout adapters](docs/BREAKOUTS.md) | The 21 footprints, and how to pick one |
| [Development boards](docs/BOARDS.md) | Nine families, with the core to install for each |
| [Sensors](docs/SENSORS.md) | The full SirBlue line |
| [Modules](docs/MODULES.md) | Storage, timekeeping, reference |
| [Fritzing parts](docs/FRITZING.md) | The breadboard artwork |
| [Driver libraries](docs/LIBRARIES.md) | Part → upstream library, verified |
| [Manufacturing](docs/MANUFACTURING.md) | Stack-up, gerber export, assembly notes |

## One repository

Every product line lives in this repository, with its full history intact —
`git log -- Boards/Microcontrollers/SirTiny` returns SirTiny's own commits, and
`git blame` still names whoever drew the trace.

## Contributing

Fixes to existing designs are the most welcome kind of change — see
[CONTRIBUTING.md](CONTRIBUTING.md). Commit the KiCad sources and the renders,
never the backups or `fp-info-cache`.

## Licence

[MIT](LICENSE-MIT) OR [Apache-2.0](LICENSE-APACHE) — © VulOS. Fabricate these
designs, modify them, sell the boards. SirBoard is a Vulos project; source and
issues at [github.com/vul-os/sirboard](https://github.com/vul-os/sirboard).

---

<p align="center">
  <sub>Part of <a href="https://vulos.org">Vulos</a> — open by design.</sub>
</p>