Skip to content

Commit c02afa4

Browse files
Properly attribute rglenn's hardware and code contributions
Clarify division of labor and give proper credit where credit is due: MissCrispenCakes: - Initial hardware design and prototyping - Test PCB design and assembly - 3D enclosure design - Software implementations (Arduino, initial Raspberry Pi) rglenn (@rglenn): - Production-ready PCB designs (KiCad layouts) - Manufacturing-ready Gerber files - I2C system code implementation for hardware testing - Expert soldering and assembly work for prototypes Changes: - AUTHORS.md: Expand contributor sections with specific details - AUTHORS.md: Add humorous but respectful note about soldering assistance ("steady hands and good eyeballs are underrated superpowers!") - README.md: Detail rglenn's specific contributions - hardware/README.md: Update attribution to credit both designers - hardware/pcb/haptic-belt/README.md: NEW - Credit rglenn for production PCB - hardware/pcb/haptic-uhat/README.md: NEW - Credit rglenn for production PCB - paper.md: Expand acknowledgments with specific contributions This ensures proper credit for the production PCB files currently used in manufacturing and for the I2C code that enables hardware testing. Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
1 parent 3a1aebc commit c02afa4

File tree

6 files changed

+153
-16
lines changed

6 files changed

+153
-16
lines changed

AUTHORS.md

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,36 +3,43 @@
33
## Project Lead & Creator
44

55
**MissCrispenCakes** ([@MissCrispenCakes](https://github.com/MissCrispenCakes))
6-
- Project conception and design
7-
- Hardware design (PCBs, enclosures)
6+
- Project conception and system architecture
7+
- Initial hardware design and prototype development
8+
- Test PCB design and assembly
89
- Arduino + Bluetooth implementation
9-
- Raspberry Pi + I2C implementation
10+
- Initial Raspberry Pi implementation
11+
- 3D enclosure design
1012
- Documentation and tutorials
1113
- Repository maintenance
1214

13-
## Contributors
15+
## Core Contributors
1416

15-
This project welcomes contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
16-
17-
### Hardware Contributors
17+
### Hardware Engineering
1818

1919
**rglenn** ([@rglenn](https://github.com/rglenn))
20-
- PCB design updates and improvements
21-
- Hardware design contributions
20+
- **Production PCB designs** - Professional KiCad layouts for manufacturing
21+
- **Gerber file generation** - Ready-to-fabricate PCB files
22+
- **I2C system implementation** - Ported initial system to I2C architecture for PCB testing
23+
- **Hardware testing and validation**
24+
- **Precision assembly work** - Expert soldering for prototype testing (because steady hands and good eyeballs are underrated superpowers when dealing with 0402 components and microscopic traces!)
2225

2326
### Code Contributors
2427

25-
(Contributors will be listed here as they make contributions)
28+
**rglenn** ([@rglenn](https://github.com/rglenn))
29+
- I2C code implementation and testing for hardware validation
30+
31+
(Additional contributors will be listed here as they make contributions)
2632

2733
### Documentation Contributors
2834

2935
(Documentation contributors will be listed here)
3036

3137
## Special Thanks
3238

39+
- **rglenn's steady hands** - For heroically soldering tiny components onto test PCBs when my hands get shaky and my eyeballs get twitchy. Not all heroes wear capes; some wield soldering irons with surgical precision! 🦸‍♂️🔧
3340
- Adafruit Industries for the DRV2605L CircuitPython library
3441
- The OSC (Open Sound Control) community
35-
- Early testers and users who provided feedback
42+
- Early testers and users who provided valuable feedback during development
3643

3744
## How to Be Listed
3845

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -226,12 +226,15 @@ See [OSHWA Certification Guide](docs/OSHWA_CERTIFICATION.md) for step-by-step in
226226

227227
## 🙏 Acknowledgments
228228

229-
- **[@rglenn](https://github.com/rglenn)** for PCB design updates and hardware contributions
229+
- **[@rglenn](https://github.com/rglenn)** for:
230+
- Production-ready PCB designs and Gerber files for manufacturing
231+
- I2C system implementation and hardware testing
232+
- Expert soldering skills for prototype assembly (saving the project from shaky hands and twitchy eyeballs!)
230233
- Research context from tactile feedback and spatial audio studies
231234
- DRV2605L haptic driver library by Adafruit
232235
- OSC protocol implementation using `osc-min` and `python-osc`
233236

234-
See [AUTHORS.md](AUTHORS.md) for a complete list of contributors.
237+
See [AUTHORS.md](AUTHORS.md) for complete contributor details.
235238

236239
## 💖 Support This Project
237240

hardware/README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,13 +77,19 @@ If you manufacture hardware based on these designs, you must maintain this sourc
7777

7878
## Attribution
7979

80-
Hardware designs by **MissCrispenCakes**
80+
**Hardware Designers:**
81+
- **Initial design & prototypes**: MissCrispenCakes
82+
- **Production PCB files & Gerbers**: rglenn ([@rglenn](https://github.com/rglenn))
83+
- **3D enclosures**: MissCrispenCakes
8184

8285
When sharing or manufacturing these designs, please include:
8386
```
84-
Based on On-Body Haptics by MissCrispenCakes
87+
Based on On-Body Haptics by MissCrispenCakes & rglenn
8588
https://github.com/MissCrispenCakes/On-body-haptics
8689
Licensed under CERN-OHL-P v2
90+
91+
Production PCB designs by rglenn
92+
Initial hardware design by MissCrispenCakes
8793
```
8894

8995
## Questions?

hardware/pcb/haptic-belt/README.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Haptic Belt PCB
2+
3+
Wearable haptic belt printed circuit board design.
4+
5+
## Design Credits
6+
7+
- **Initial concept & prototype**: MissCrispenCakes
8+
- **Production PCB design**: rglenn ([@rglenn](https://github.com/rglenn))
9+
- **KiCad layout**: rglenn
10+
- **Gerber files for manufacturing**: rglenn
11+
12+
## License
13+
14+
Licensed under **CERN-OHL-P v2** (CERN Open Hardware License - Permissive)
15+
16+
See [LICENSE-HARDWARE](../../../LICENSE-HARDWARE) for full license text.
17+
18+
## Files
19+
20+
- **kicad/** - KiCad project files (.kicad_pcb, .sch, .pro)
21+
- **gerbers/** - Manufacturing-ready Gerber files
22+
- **docs/** - Schematics, assembly photos, and documentation
23+
24+
## Manufacturing
25+
26+
The Gerber files in the `gerbers/` directory are ready for PCB fabrication at:
27+
- JLCPCB (https://jlcpcb.com/)
28+
- PCBWay (https://www.pcbway.com/)
29+
- OSH Park (https://oshpark.com/)
30+
31+
### Recommended Settings
32+
33+
- **Layers**: 2
34+
- **Thickness**: 1.6mm
35+
- **Surface Finish**: HASL or ENIG
36+
- **Copper Weight**: 1oz
37+
38+
See [hardware assembly guide](../../../docs/hardware/assembly-guide.md) for complete build instructions.
39+
40+
## Attribution
41+
42+
When manufacturing or sharing this design, please include:
43+
44+
```
45+
Haptic Belt PCB Design
46+
Production design by rglenn
47+
Based on On-Body Haptics by MissCrispenCakes
48+
https://github.com/MissCrispenCakes/On-body-haptics
49+
Licensed under CERN-OHL-P v2
50+
```
51+
52+
## Source Location
53+
54+
As required by CERN-OHL-P v2:
55+
56+
**Source Location**: https://github.com/MissCrispenCakes/On-body-haptics/tree/main/hardware/pcb/haptic-belt

hardware/pcb/haptic-uhat/README.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Haptic uHAT PCB
2+
3+
Raspberry Pi HAT (Hardware Attached on Top) for haptic control with I2C multiplexer and DRV2605L drivers.
4+
5+
## Design Credits
6+
7+
- **Initial concept & prototype**: MissCrispenCakes
8+
- **Production PCB design**: rglenn ([@rglenn](https://github.com/rglenn))
9+
- **KiCad layout**: rglenn
10+
- **Gerber files for manufacturing**: rglenn
11+
12+
## License
13+
14+
Licensed under **CERN-OHL-P v2** (CERN Open Hardware License - Permissive)
15+
16+
See [LICENSE-HARDWARE](../../../LICENSE-HARDWARE) for full license text.
17+
18+
## Files
19+
20+
- **kicad/** - KiCad project files (.kicad_pcb, .sch, .pro)
21+
- **gerbers/** - Manufacturing-ready Gerber files
22+
- **docs/** - Schematics, assembly photos, and documentation
23+
24+
## Features
25+
26+
- Raspberry Pi HAT form factor
27+
- TCA9548A I2C multiplexer (8 channels)
28+
- Support for up to 8 DRV2605L haptic drivers
29+
- Adafruit DRV2605L breakout board compatible
30+
- SSD1306 OLED display header
31+
- Power and GPIO breakouts
32+
33+
## Manufacturing
34+
35+
The Gerber files in the `gerbers/` directory are ready for PCB fabrication at:
36+
- JLCPCB (https://jlcpcb.com/)
37+
- PCBWay (https://www.pcbway.com/)
38+
- OSH Park (https://oshpark.com/)
39+
40+
### Recommended Settings
41+
42+
- **Layers**: 2
43+
- **Thickness**: 1.6mm
44+
- **Surface Finish**: HASL or ENIG
45+
- **Copper Weight**: 1oz
46+
47+
See [hardware assembly guide](../../../docs/hardware/assembly-guide.md) for complete build instructions.
48+
49+
## Attribution
50+
51+
When manufacturing or sharing this design, please include:
52+
53+
```
54+
Haptic uHAT PCB Design
55+
Production design by rglenn
56+
Based on On-Body Haptics by MissCrispenCakes
57+
https://github.com/MissCrispenCakes/On-body-haptics
58+
Licensed under CERN-OHL-P v2
59+
```
60+
61+
## Source Location
62+
63+
As required by CERN-OHL-P v2:
64+
65+
**Source Location**: https://github.com/MissCrispenCakes/On-body-haptics/tree/main/hardware/pcb/haptic-uhat

paper.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,6 @@ Community contributions are welcomed through the project's GitHub repository.
123123

124124
# Acknowledgments
125125

126-
This project builds upon the Adafruit DRV2605L CircuitPython library and the broader open-source hardware and software communities. Special thanks to rglenn for PCB design updates and hardware improvements. Thanks to early testers and users who provided valuable feedback during development.
126+
This project builds upon the Adafruit DRV2605L CircuitPython library and the broader open-source hardware and software communities. Special thanks to rglenn for developing the production-ready PCB designs, generating manufacturing-ready Gerber files, implementing the I2C system code for hardware testing, and providing expert assembly and soldering work for prototype validation. Thanks to early testers and users who provided valuable feedback during development.
127127

128128
# References

0 commit comments

Comments
 (0)