|
| 1 | +# OSHWA Certification Guide |
| 2 | + |
| 3 | +Guide for getting your On-Body Haptics project officially certified by the Open Source Hardware Association (OSHWA). |
| 4 | + |
| 5 | +## ✅ Compliance Status |
| 6 | + |
| 7 | +**Your project ALREADY MEETS all OSHWA requirements!** |
| 8 | + |
| 9 | +### Requirements Checklist |
| 10 | + |
| 11 | +- ✅ **Open Source Hardware License**: CERN-OHL-P v2 (OSHWA-approved) |
| 12 | +- ✅ **Open Source Software License**: MIT (OSHWA-approved) |
| 13 | +- ✅ **Design Files Provided**: KiCad source files, OpenSCAD files |
| 14 | +- ✅ **Manufacturing Files**: Gerber files for PCB production |
| 15 | +- ✅ **Documentation Links**: Clear links to design files in README and hardware/README.md |
| 16 | +- ✅ **Source Location**: Repository URL specified in LICENSE-HARDWARE |
| 17 | +- ✅ **Component Datasheets**: Third-party component datasheets included |
| 18 | +- ✅ **Clear Licensing**: Dual licensing clearly explained |
| 19 | +- ✅ **Version Control**: Git repository with full history |
| 20 | + |
| 21 | +## What is OSHWA Certification? |
| 22 | + |
| 23 | +The Open Source Hardware Association provides a **free self-certification program** that: |
| 24 | + |
| 25 | +- Gives your project an official **Open Source Hardware (OSHW) certification mark** |
| 26 | +- Provides a **unique identifier (UID)** for your project (e.g., US000123) |
| 27 | +- Lists your project in the **official OSHWA directory** |
| 28 | +- Lets you **legally use the OSHW logo** on hardware and documentation |
| 29 | +- Increases visibility and credibility in the open hardware community |
| 30 | + |
| 31 | +## About CERN-OHL-P v2 |
| 32 | + |
| 33 | +Your hardware license (CERN-OHL-P v2) is **one of the seven OSHWA-recommended licenses**: |
| 34 | + |
| 35 | +**OSHWA-Approved Licenses:** |
| 36 | +- ✅ **CERN-OHL** (Permissive, Weakly Reciprocal, Strongly Reciprocal) - **← You use this!** |
| 37 | +- ✅ TAPR Open Hardware License |
| 38 | +- ✅ GNU General Public License (GPL) |
| 39 | +- ✅ Creative Commons Attribution-ShareAlike (CC BY-SA) |
| 40 | +- ✅ FreeBSD License |
| 41 | +- ✅ MIT License |
| 42 | +- ✅ Creative Commons Attribution (CC BY) |
| 43 | + |
| 44 | +**Why CERN-OHL-P is excellent:** |
| 45 | +- Only hardware-specific license approved by Open Source Initiative (OSI) |
| 46 | +- Designed for hardware, software, and documentation together |
| 47 | +- Version 2 is modern (2020) and well-maintained |
| 48 | +- "P" (Permissive) variant allows maximum freedom for users |
| 49 | + |
| 50 | +**No license change needed!** You're already using an optimal license. |
| 51 | + |
| 52 | +## How to Get Certified |
| 53 | + |
| 54 | +### Step 1: Prepare Your Information |
| 55 | + |
| 56 | +You'll need: |
| 57 | + |
| 58 | +1. **Project Name**: On-Body Haptics |
| 59 | +2. **Your Name/Organization**: MissCrispenCakes (or your real name if you prefer) |
| 60 | +3. **Project URL**: https://github.com/MissCrispenCakes/On-body-haptics |
| 61 | +4. **Hardware License**: CERN-OHL-P-2.0 |
| 62 | +5. **Software License**: MIT |
| 63 | +6. **Documentation License**: MIT (same as software) |
| 64 | +7. **Country**: USA (or your country) |
| 65 | +8. **Project Description**: "Open-source wearable haptic feedback systems for spatial audio, VR/AR, and interactive installations." |
| 66 | + |
| 67 | +9. **Links to Design Files**: |
| 68 | + - Hardware designs: https://github.com/MissCrispenCakes/On-body-haptics/tree/main/hardware |
| 69 | + - PCB KiCad files: https://github.com/MissCrispenCakes/On-body-haptics/tree/main/hardware/pcb |
| 70 | + - Gerber files: Available in each PCB subdirectory |
| 71 | + - 3D enclosures: https://github.com/MissCrispenCakes/On-body-haptics/tree/main/hardware/enclosures |
| 72 | + - Bill of Materials: https://github.com/MissCrispenCakes/On-body-haptics/blob/main/hardware/bom.xlsx |
| 73 | + |
| 74 | +10. **Project Type**: Select "wearable technology" or "haptic device" |
| 75 | + |
| 76 | +### Step 2: Self-Certify Online |
| 77 | + |
| 78 | +1. Go to **https://certification.oshwa.org/** |
| 79 | + |
| 80 | +2. Click **"Certify a Project"** or **"Apply for Certification"** |
| 81 | + |
| 82 | +3. Fill out the **Certification Mark License Agreement**: |
| 83 | + - Read and agree to the terms |
| 84 | + - Confirm all parts under your control are open source |
| 85 | + - Confirm third-party components have accessible datasheets |
| 86 | + - Agree to yearly renewal emails |
| 87 | + |
| 88 | +4. Submit the form |
| 89 | + |
| 90 | +5. **You'll receive a unique OSHW UID immediately!** |
| 91 | + - Format: `US000XXX` (if in USA) or `XX000XXX` (for other countries) |
| 92 | + - Example: `US000789` |
| 93 | + |
| 94 | +6. Your project will be listed in the **OSHWA Directory**: https://certification.oshwa.org/list.html |
| 95 | + |
| 96 | +### Step 3: Add the OSHW Certification Mark |
| 97 | + |
| 98 | +Once certified, you **CAN and SHOULD** use the official OSHW logo! |
| 99 | + |
| 100 | +#### Where to Use the Logo |
| 101 | + |
| 102 | +You can use the OSHW certification mark on: |
| 103 | + |
| 104 | +1. **Hardware itself** - Silkscreen on PCB, printed on enclosure |
| 105 | +2. **README.md** - Badge at the top |
| 106 | +3. **Hardware documentation** - Hardware README, assembly guide |
| 107 | +4. **Product website** - If you have one |
| 108 | +5. **Product packaging** - If you sell kits |
| 109 | + |
| 110 | +#### Logo Design Files |
| 111 | + |
| 112 | +Download official logo files from: **https://github.com/oshwa/certification-mark** |
| 113 | + |
| 114 | +Available formats: |
| 115 | +- **SVG** - Vector (best for scaling) |
| 116 | +- **PNG** - Raster (web use) |
| 117 | +- **EPS** - Print production |
| 118 | + |
| 119 | +#### Logo Usage Rules |
| 120 | + |
| 121 | +**Colors:** |
| 122 | +- **Preferred**: Graphite + Coral (brand colors) |
| 123 | +- **Alternative**: Black, white, or gray when color isn't possible |
| 124 | + |
| 125 | +**UID Display:** |
| 126 | +- The logo is required |
| 127 | +- Your unique ID (e.g., `US000123`) is optional but **highly recommended** |
| 128 | + |
| 129 | +**Plaintext:** |
| 130 | +- Where graphics aren't possible, use: `[OSHW] US000123` |
| 131 | +- Similar to how © can be written as (c) |
| 132 | + |
| 133 | +#### Logo Placement Examples |
| 134 | + |
| 135 | +**On PCB Silkscreen:** |
| 136 | +``` |
| 137 | +┌─────────────────────┐ |
| 138 | +│ │ |
| 139 | +│ On-Body Haptics │ |
| 140 | +│ [OSHW] US000XXX │ |
| 141 | +│ │ |
| 142 | +└─────────────────────┘ |
| 143 | +``` |
| 144 | + |
| 145 | +**In README.md:** |
| 146 | +```markdown |
| 147 | +[](https://certification.oshwa.org/us000xxx.html) |
| 148 | +``` |
| 149 | + |
| 150 | +**On 3D Printed Enclosure:** |
| 151 | +- Emboss or print the OSHW logo on the case |
| 152 | +- Include UID on label or embossed text |
| 153 | + |
| 154 | +### Step 4: Update Project Documentation |
| 155 | + |
| 156 | +After certification, update these files: |
| 157 | + |
| 158 | +1. **README.md** - Add OSHW badge near the top (see Step 3) |
| 159 | + |
| 160 | +2. **hardware/README.md** - Add certification notice: |
| 161 | + ```markdown |
| 162 | + ## OSHWA Certification |
| 163 | + |
| 164 | + This project is certified as Open Source Hardware by OSHWA. |
| 165 | + |
| 166 | + Certification UID: **US000XXX** |
| 167 | + |
| 168 | + [](https://certification.oshwa.org/us000xxx.html) |
| 169 | + ``` |
| 170 | + |
| 171 | +3. **CITATION.cff** - Add OSHWA identifier: |
| 172 | + ```yaml |
| 173 | + identifiers: |
| 174 | + - type: other |
| 175 | + value: "OSHW-US000XXX" |
| 176 | + description: "OSHWA Open Source Hardware Certification" |
| 177 | + ``` |
| 178 | +
|
| 179 | +4. **PCB designs** - Add OSHW logo to silkscreen (for next PCB revision) |
| 180 | +
|
| 181 | +5. **3D enclosure** - Update OpenSCAD/STL to include logo emboss |
| 182 | +
|
| 183 | +### Step 5: Maintain Certification |
| 184 | +
|
| 185 | +**Annual Renewal:** |
| 186 | +- OSHWA will send yearly renewal emails |
| 187 | +- Confirm your project still meets requirements |
| 188 | +- Update documentation links if your repo moved |
| 189 | +- **It's free** - no fees for renewal |
| 190 | +
|
| 191 | +**Version Updates:** |
| 192 | +- When you release new hardware versions, you can: |
| 193 | + - Update the existing certification (for minor changes) |
| 194 | + - Register a new certification UID (for major new designs) |
| 195 | +
|
| 196 | +## Benefits of Certification |
| 197 | +
|
| 198 | +Once certified, you get: |
| 199 | +
|
| 200 | +1. **Credibility** - Official recognition from OSHWA |
| 201 | +2. **Discoverability** - Listed in OSHWA directory |
| 202 | +3. **Logo Usage** - Legal permission to use OSHW mark |
| 203 | +4. **Community** - Join the global open hardware movement |
| 204 | +5. **Academic Recognition** - Some institutions recognize OSHW certification |
| 205 | +6. **Grant Eligibility** - Some open hardware grants require OSHWA certification |
| 206 | +
|
| 207 | +## Timeline |
| 208 | +
|
| 209 | +- **Certification application**: 10-15 minutes |
| 210 | +- **Approval**: Immediate (it's self-certification!) |
| 211 | +- **Logo download and integration**: 30-60 minutes |
| 212 | +- **Total time**: Less than 2 hours to be fully certified! |
| 213 | +
|
| 214 | +## Frequently Asked Questions |
| 215 | +
|
| 216 | +### Do I need to pay for certification? |
| 217 | +**No!** OSHWA certification is completely free, including renewal. |
| 218 | +
|
| 219 | +### What if I use third-party components (ICs, modules)? |
| 220 | +That's fine! As long as: |
| 221 | +- The parts YOU designed are open source (✅ you do this) |
| 222 | +- Third-party components have accessible datasheets (✅ you provide these) |
| 223 | +
|
| 224 | +### Can I use the logo before certification? |
| 225 | +**No.** You must complete certification before using the OSHW certification mark. However, you can say "open source hardware" without the mark. |
| 226 | +
|
| 227 | +### What if I make changes to my hardware? |
| 228 | +- **Minor changes** (bug fixes, component substitutions): Update existing certification |
| 229 | +- **Major redesign**: Consider getting a new UID for the new version |
| 230 | +- You can have multiple certified versions |
| 231 | +
|
| 232 | +### Do I need to certify software separately? |
| 233 | +No. OSHWA certification covers the complete project (hardware + software + docs). Your MIT license for software is already OSHWA-approved. |
| 234 | +
|
| 235 | +### Can I use multiple licenses? |
| 236 | +Yes! Your dual licensing (MIT + CERN-OHL-P) is perfect and fully compliant. |
| 237 | +
|
| 238 | +## Resources |
| 239 | +
|
| 240 | +- **OSHWA Certification**: https://certification.oshwa.org/ |
| 241 | +- **OSHWA Definition**: https://oshwa.org/definition/ |
| 242 | +- **Certification Requirements**: https://certification.oshwa.org/requirements.html |
| 243 | +- **Logo Files**: https://github.com/oshwa/certification-mark |
| 244 | +- **Certified Projects Directory**: https://certification.oshwa.org/list.html |
| 245 | +- **OSHWA FAQ**: https://oshwa.org/resources/open-source-hardware-faq/ |
| 246 | +
|
| 247 | +## Next Steps |
| 248 | +
|
| 249 | +**You're ready to certify right now!** |
| 250 | +
|
| 251 | +1. Go to https://certification.oshwa.org/ |
| 252 | +2. Fill out the 10-minute self-certification form |
| 253 | +3. Get your unique OSHW UID |
| 254 | +4. Download and add the logo to your project |
| 255 | +5. Update README.md and hardware documentation |
| 256 | +6. Announce your certification! 🎉 |
| 257 | +
|
| 258 | +--- |
| 259 | +
|
| 260 | +**Questions?** |
| 261 | +- OSHWA Contact: [email protected] |
| 262 | +- GitHub Discussions: https://github.com/MissCrispenCakes/On-body-haptics/discussions |
0 commit comments