Skip to content

Commit 7cb7f9a

Browse files
committed
ato documentation
1 parent 595cb40 commit 7cb7f9a

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,22 @@ Heatsink:
3232
3D model + PDF in mech/SV-LED-214E
3333

3434
# Atopile usage
35+
[Atopile Docs](https://docs.atopile.io/latest/)
3536

37+
Atopile makes it easy to adapt this design for use with other diodes, drivers, BMS circuits, etc.
38+
39+
To change the LED package:
40+
41+
1: Fork this repo
42+
43+
2: Install [atopile from pypi](https://pypi.org/project/atopile/0.2.5/) with uv (recommended), pipx, or virtual fish. There is also a VCS extension for those inclined. Follow the instructions in the ato docs on setting up the kicad plugin,usually just ```$ ato configure```
44+
45+
3: find diodes you want/diodes using the package you want on the JLCPCB parts library, LCSC, or with [this tool](https://yaqwsx.github.io/jlcparts/#/) and install them into your project directory with
46+
```$ ato install --jlcpcb <LCSC_ID>```
47+
For example, to install [WS2812B Neopixels](https://jlcpcb.com/partdetail/Worldsemi-WS2812B2020/C965555) with LCSC ID C965555:
48+
```$ ato install --jlcpcb C965555```
49+
50+
4: open uv-lamp.ato in a text editor. import the module/component you've installed, eg:
51+
```from "WS2812B_minus_2020.ato" import WS2812B_minus_2020```
52+
check the pin names in the component ato file, and configure and interfaces you need. For other UV diodes, just ensure the pins are labeled A (anode) and K (cathode) and replace the components assigned to led1-led3:
53+
```led1 = new M3535N1UVS8U06_minus_365NM -> led1 = new <COMPONENT>```

0 commit comments

Comments
 (0)