This is a JSON-Schema which can validate an 'okh.toml' file, which holds an Open Source Hardware (OSH) projects Open Know-How (OKH) meta-data.
No Additional PropertiesIf the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"3DP"
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"PCB"
Must contain a minimum of 2 items
Must contain a maximum of 2 items
Link to OKH JSON-Schema
reference to one or multiple valid attestation(s) that the documentation is complete and fully qualifies as open source hardware;
issuing conformity assessment bodies according to DIN SPEC 3105-2:
- Open Hardware Observatory
- Open Source Ecology Germany
- OSHWA certification programme
^https?://
^[a-z]*:
^//
(?:.*/)?\.\.(?:/.*)?
relative or absolute path to files that are neither source files nor their exports, but still useful in the repository (e.g. KiCAD library files);
multiple inputs possible (with one entry each)
^https?://
^[a-z]*:
^//
(?:.*/)?\.\.(?:/.*)?
"lib/lib1.lib"
".mdlrc"
[
"lib/lib1.lib",
".mdlrc"
]
URL or repo-relative path to the bill of materials
^https?://
^[a-z]*:
^//
(?:.*/)?\.\.(?:/.*)?
"sBoM.csv"
"BOM.csv"
"bom.csv"
repo-relative path to the contribution guide
^https?://
^[a-z]*:
^//
(?:.*/)?\.\.(?:/.*)?
"CONTRIBUTING.md"
"CONTRIB.md"
"CONTRIBUTING"
"CONTRIB"
patent class identifier of the Cooperative Patent Classification that describes best the field of technology of the OSH module.
Get it from here: https://worldwide.espacenet.com/classification
^[A-HY][0-9]{2}[A-HJ-NP-Z]( ?[12]?[0-9]{1,3}[/][0-9]{2,6})?$
^[A-HY][0-9]{2}[A-HJ-NP-Z]( ?[12]?[0-9]{1,3}[/][0-9]{2,6})?$
"A01B33/00"
"A41G"
"A01"
"A"
"B23K"
"B25J9/026"
"B62K"
"B63C"
"D03D 35/00"
"D03D 5/00"
"D06B"
"F16M 11/2078"
"F16M11/2078"
"G01N"
"G05B"
"G06C 7/02"
"H01H"
"H01Q"
"H02J"
"H02J 1/00"
"H04"
"H04W"
"H05K"
"Y02P"
"H02J 1/00"
"H02J 1/12"
"H02J 1/123"
"H02J 1/1234"
"H02J 1/12345"
"H02J 1/123456"
[
"D03D 35/00",
"D03D 5/00"
]
IETF BCP 47 language tag for the language in which the documentation is written
Language as a BCP 47 language tag
Must match regular expression:^(((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang))|((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+))$
"en"
"de"
"es"
"zh"
Language as a BCP 47 language tag
Same definition as documentation-language_anyOf_i0_itemsODRL-ID representing the development stage of the documentation; get it from: https://w3id.org/oseg/ont/otrl
Published information under free open source license
Specific value:"ODRL-1"
Provision of documentation files and in editable formats enabling collaboration development
Specific value:"ODRL-2"
Complete documentation as per DIN SPEC 3105-1
Specific value:"ODRL-3"
Public evidence of documentation maturity
Specific value:"ODRL-3*"
Product qualification documents published enabling decentralized commercial distribution
Specific value:"ODRL-4"
relative or absolute path to export file (e.g. STEP export of 3D model or PDF export of drawing);
multiple inputs possible (with one entry each)
^https?://
^[a-z]*:
^//
(?:.*/)?\.\.(?:/.*)?
"3D-parts/assembly.stp"
"public/user-manual.pdf"
[
"3D-parts/assembly.stp",
"public/user-manual.pdf"
]
functional description, e.g. what it actually does, what problem it solves, for whom, under which conditions etc.
So if you wish that someone finds & uses your OSH specifically e.g. for COVID-19-crisis response, include relevant keywords in this field
"A fully programmable, impeccably built, open source, split mechanical keyboard designed for extreme productivity and ergonomics."
"A Handibot tool is a new kind of portable, digitally-controlled power tool for cutting, drilling, carving, and many other machining operations - the first Universal Digital Power Tool (UDPT) - or just, a Smart Tool. If you're familiar with industrial CNC (computer numerically controlled) equipment, think of the Handibot tool as a portable version of CNC. "
"A tandem bicycle, with practically the same size, weight, and cost of a standard bicycle."
"CARLA is a resistant bicycle trailer, which can be coupled with any regular bike and can transport easily 150 kg load. CARLA distinguishes itself for the outstanding agility and a very small turning circle. CARLA bicycle trailer is very well in tune with e-bikes for example, with a mid-motor."
"FarmBot Genesis is top-of-the-line FarmBot model designed with the most features and flexibility. It is suitable for growing food with the highest level of precision, running complex experiments, and capable of being easily modified and extended to do more."
"Flipper Zero is a multi tool device for geeks with a curious personality of a cyber-dolphin who really loves to hack. It can interact with digital systems in real life and grow while you are hacking. The idea of Flipper Zero is to combine all the phreaking hardware tools you'd need for hacking on the go."
"GEK Gasifier comes as an assemble-yourself kit that provides stand-alone wood gas for a variety of end uses."
"Inkplate 6 is a powerful, Wi-Fi enabled ESP32 based six-inch e-paper display - recycled from a Kindle e-reader."
"KORUZA innovates the design of a free-space optical communication system reusing mass produced Small Form-factor Pluggable (SFP) electro-optical transceivers, combining the latest advances in low-cost 3D printing using the Fused Deposition Modelling (F DM) method with bare-minimum custom electronics design."
"LittleRP is an Open Source Resin 3D Printer "
"mechanical setup for the COSI Measure"
"MNT Reform is the radical, ultimate open hardware laptop, designed and assembled in Berlin."
"OpenEVSE supplies open source charging station hardware and software solutions to manufactures and individuals. "
"OpenROV is a DIY telerobotics community centered around underwater exploration & adventure."
"Opentrons makes robots for biologists. The robots automate experiments that would otherwise be done by hand, allowing our users to spend more time pursuing answers to the 21st century's most important questions, and less time pipetting."
"The AXIOM Beta is an open source, open hardware, professional-grade digital film camera made by apertus°. It is designed to be modular e.g. interchangeable sensor front end etc. and supports recording at 4K resolution."
"The Corne is a 40% split mechanical USB general purpose keyboard. It is made up of two halves with 3x6 column staggered keys and 3 thumb keys. It has full RGB back-lighting, and is fully programmable using the popular Open Source QMK firmware. The basic design principles are, to have a minimal, ergonomically arranged set of keys that are all reachable by moving a finger by at most a distance of one key in diagonal."
"The Corne keyboard is a split keyboard with 3x6 column staggered keys and 3 thumb keys, based on Helix. Crkbd stands for Corne Keyboard."
"The Electric Eel Wheel is an affordable electric spinning wheel that is revolutionizing the fiber world! The uptake is controlled with a unique scotch tension design and the yarn flows through a clever flyer assembly. It is an extremely light and portable design."
"The goal of GliaX-Faceshield is to create a low cost, high quality, reusable face shield that can be quickly deployed."
"The Lasersaur is a beautiful laser cutter with an outstanding price-performance ratio. We designed it to fill the need of makers, designers, architects and researchers who want a safe and highly-capable machine. Unlike others it's open source and comes fully loaded with knowledge to run, maintain, and modify."
"The robot having functional characteristics of animal such as Run, Walk, Crawl, Walk and run in different heights and take push ups operated autonomously and via android app."
"This charge controller is a so-called maximum power point tracker (MPPT), which automatically adapts its input voltage to the connected solar panel to extracts as much power as possible. The MPPT function can only be achieved using a DC/DC converter, which is the core part of the charge controller PCB. It can be recognized by the large inductor and the large electrolytic input and output filter capacitors."
one or more image references, with or without additional meta-data
a single image reference (project relative path or absolute URL), optionally with additional meta-data
No Additional Properties{
"location": "res/media/img/logo.svg",
"depicts": "This OSH projects logo"
}
{
"location": "res/media/img/liquid-flow.svg",
"depicts": "A diagram depicting the flow of the different liquids through the machine in an abstract manner"
}
{
"location": "res/media/img/liquid-flow.svg",
"depicts": "A photo of the finished hardware, taken with a white background."
}
{
"location": "res/media/img/liquid-flow.svg",
"depicts": {
"text": "A photo of the finished hardware, taken with a white background.",
"language": "en"
}
}
{
"location": "res/media/img/liquid-flow.svg",
"depicts": [
{
"text": "A photo of the finished hardware, taken with a white background.",
"language": "en"
},
{
"text": "Ein Foto der fertigen Maschiene, aufgenommen vor einem weissen Hintergrund.",
"language": "de"
}
]
}
Project relative path or absolute URL linking to the image file
Same definition as attestation_anyOf_i0Human oriented description of what is visible in the image.
This matters for example:
- for visually impaired or blind people
- in case the image is for some reason not available
- to put as a caption next to the image
a text and the language it is written in
No Additional Propertiesthe text content
The BCP 47 language tag the content is written in
Same definition as documentation-language_anyOf_i0_itemsa text and the language it is written in
Same definition as image_anyOf_i1_depicts_anyOf_i1Denotes the slot the image fills within the subject it belongs to.
You may also think of it as the 'role' the image plays for its parent.
The available slots are predefined,
see the OKH image slots;
there you will also read about the ability to define custom ones,
though you might also consider proposing a new common tag
in an issue.
An image can fill multiple slots,
but each slot can be filled at most once.
This is useful for things like the projects icon,
or the left-side view of the 3D model.
^c_[0-9a-z._-]+$
a single image reference (project relative path or absolute URL), optionally with additional meta-data
Same definition as image_anyOf_i1"res/media/img/logo.svg"
"res/media/img/liquid-flow.svg"
"res/assets/media/img/hw-photo.png"
"https://image-hoster-xzy.net/accounts/our-user/our-project/our-image.png"
[
"res/media/img/logo.svg",
"res/media/img/liquid-flow.svg",
"res/assets/media/img/hw-photo.png",
"https://image-hoster-xzy.net/accounts/our-user/our-project/our-image.png"
]
{
"location": "res/media/img/logo.svg",
"depicts": "This OSH projects logo"
}
{
"location": "res/media/img/liquid-flow.svg",
"depicts": "A diagram depicting the flow of the different liquids through the machine in an abstract manner"
}
{
"location": "res/media/img/liquid-flow.svg",
"depicts": "A photo of the finished hardware, taken with a white background"
}
{
"location": "https://image-hoster-xzy.net/accounts/our-user/our-project/our-image.png",
"depicts": "Community supplied photo of the underbelly of our machine"
}
[
{
"location": "res/media/img/logo.svg",
"depicts": "This OSH projects logo"
},
{
"location": "res/media/img/liquid-flow.svg",
"depicts": "A diagram depicting the flow of the different liquids through the machine in an abstract manner"
},
{
"location": "res/media/img/liquid-flow.svg",
"depicts": "A photo of the finished hardware, taken with a white background."
},
{
"location": "https://image-hoster-xzy.net/accounts/our-user/our-project/our-image.png",
"depicts": "Community supplied photo of the underbelly of our machine"
}
]
An SPDX license _expression
(see: https://spdx.github.io/spdx-spec/v2-draft/SPDX-license-expressions/),
usually a single SPDX license ID
(see complete list: https://spdx.org/licenses/),
or a combination of those,
combined with AND or OR.
If your license is not SPDX registered (yet),
use a custom string prefixed with 'LicenseRef-',
for example 'LicenseRef-MyVeryOwnLicense-1.3';
please use the 'SPDX identifier' from
https://scancode-licensedb.aboutcode.org/,
if your license is there but not SPDX registered.
Use 'LicenseRef-NOASSERTION' if no license is specified,
'LicenseRef-NONE' if no license is specified
(which usually means: all rights reserved),
or 'LicenseRef-AllRightsReserved' or similar
for projects clearly indicating that they are proprietary.
"GPL-3.0-or-later"
"AGPL-3.0-or-later"
"GPL-3.0-only"
"AGPL-3.0-only"
"0BSD"
"CC0-1.0"
"CC-BY-SA-4.0"
"CC-BY-4.0"
"Unlicense"
"LicenseRef-NOASSERTION"
"LicenseRef-NONE"
"LicenseRef-AllRightsReserved"
"LicenseRef-RandomNonSpdxRegisteredLicense"
"LicenseRef-MyVeryOwnLicense"
organization/individual behind the hardware design (holder of intellectual property)
A person or organization
A person (alive, dead, undead, or fictional)
E-Mail of the person
"jane.doe@email.com"
"john.doe@email.com"
"ester.something@good.org"
Full name of the person
An organization such as a school, NGO, corporation, club, etc.
Name of the organization
"John Doe <john.doe@email.com>"
"Jane Doe (FSF) <jane.doe@email.com>"
"Michael Mueller <mm@email.com>"
"Jinz Jixxer (OSI) <jj@email.com>"
"Pru Ner (GNU) <abc@email.com>"
[
"John Doe <john.doe@email.com>",
"Jane Doe (FSF) <jane.doe@email.com>"
]
{
"email": "john.doe@email.com",
"name": "John Doe"
}
{
"email": "jane.doe@email.com",
"memberOf": "FSF",
"name": "Jane Doe"
}
[
{
"email": "john.doe@email.com",
"name": "John Doe"
},
{
"email": "jane.doe@email.com",
"memberOf": "FSF",
"name": "Jane Doe"
}
]
URL or repo-relative path to manufacturing instructions; multiple inputs possible (with one entry each)
^https?://
^[a-z]*:
^//
(?:.*/)?\.\.(?:/.*)?
"Documentation/Assembly_Guide/AssemblyGuide.md"
Mass of the part in g (grams).
Value must be strictly greater than 0
Working title of the OSH component
version of OKH specification the OSH projects metadata follows (different version → different data fields in this file)
Specific value:"OKH-LOSHv1.0"
organization of the licensor or that represents (some of) the contributors of to project
An organization such as a school, NGO, corporation, club, etc.
Same definition as licensor_anyOf_i1_items_anyOf_i1An organization such as a school, NGO, corporation, club, etc.
Same definition as licensor_anyOf_i1_items_anyOf_i1"Free Software Foundation"
"Open Source Initiative"
"Open Source Hardware Association"
"Open Source Ecology"
"Open Source Ecology Germany"
[
"Free Software Foundation",
"Open Source Initiative"
]
{
"name": "Free Software Foundation",
"url": "https://www.fsf.org"
}
[
{
"name": "Free Software Foundation",
"url": "https://www.fsf.org"
},
{
"name": "Open Source Ecology Germany",
"url": "https://ose-germany.de"
}
]
Outer dimensions of the OSH module or part in mm (millimeters), which completely encompass the product.
No Additional PropertiesValue must be strictly greater than 0
Value must be strictly greater than 0
Value must be strictly greater than 0
physical component of this open source hardware module, for which technical documentation (design files etc.) is available under a free/open license
No Additional Itemsrelative or absolute path to files that are neither source files nor their exports, but still useful in the repository (e.g. KiCAD library files);
multiple inputs possible (with one entry each)
relative or absolute path to export file (e.g. STEP export of 3D model or PDF export of drawing);
multiple inputs possible (with one entry each)
one or more image references, with or without additional meta-data
Same definition as imageOuter dimensions of the OSH module or part in mm (millimeters), which completely encompass the product.
Same definition as outer-dimensionsrelative or absolute path to source file (e.g. native CAD file);
multiple inputs possible (with one entry each)
^https?://
^[a-z]*:
^//
(?:.*/)?\.\.(?:/.*)?
"3D-parts/assembly.asm"
"pcb/main.pro"
"pcb/main.kicad_pcb"
"cad/part-x/model.fcstd"
[
"pcb/main.kicad_pcb",
"cad/part-x/model.fcstd"
]
identifier of the applying Technology-specific Documentation Criteria (TsDC) according to DIN SPEC 3105-1 - get it from: https://w3id.org/oseg/ont/tsdc/core - multiple inputs possible (with one entry each)
"ASM"
"MEC"
"CIR"
"PCB"
"WEL"
"3DP"
"LAS"
"CNC"
[
"ASM",
"MEC",
"CIR"
]
The DOI(s) of one or multiple associated publication(s)
^(doi: |DOI: |https://doi.org/)?10\.\d{4,9}\/[-._;()/:a-zA-Z0-9]+$
"https://doi.org/10.1080/10509585.2015.1092083"
"10.1080/10509585.2015.1092083"
"doi: 10.1080/10509585.2015.1092083"
"DOI: 10.1080/10509585.2015.1092083"
repo-relative path (or absolute HTTP(S) URL) to to the corresponding ReadMe, which is the (human) entry-point into (the sources of) an OSH project
No Additional Properties"http://w3id.org/my-org/projects/proj-x#"
"http://w3id.org/my-comp/projects/proj-x#"
"prjx"
"myorg-prjx"
"mycomp-prjx"
repo-relative path (or absolute HTTP(S) URL) to to the corresponding ReadMe, which is the (human) entry-point into (the sources of) an OSH project
^https?://
^[a-z]*:
^//
(?:.*/)?\.\.(?:/.*)?
"README.md"
"README.txt"
"README"
"README-JP.md"
"README-JP"
[
"README-EN.md",
"README-JP.md"
]
URL or repo local path to the release package of this version of the OSH module
Same definition as attestation_anyOf_i0URL to the (human browsable) place where development happens;
typically a (git) repository or Wiki page.
Following this link, people should be able to contribute to the development:
reporting issues, suggesting changes, connecting to the team etc.
associated software package used to operate this piece of open source hardware
No Additional Itemsunambiguous reference to the installation guide for the corresponding software release
^https?://
^[a-z]*:
^//
(?:.*/)?\.\.(?:/.*)?
"https://github.com/arduino/ArduinoCore-mbed/blob/a2c06d768f5ebb6821ae6505b2032ee58f4ef70d/README.md"
unambiguous reference to the software release used for this version of the OSH module
^https?://
^[a-z]*:
^//
(?:.*/)?\.\.(?:/.*)?
"https://github.com/arduino/ArduinoCore-mbed/releases/tag/1.3.2"
relative or absolute path to source file (e.g. native CAD file);
multiple inputs possible (with one entry each)
document-number of the official standard the OSH module complies;
multiple inputs possible (with one entry each)
"DIN SPEC 3105"
"DIN EN 1335"
"ISO 1337"
[
"DIN SPEC 3105",
"ISO 1337"
]
OTRL-ID representing the development stage of the OSH module; get it from: https://w3id.org/oseg/ont/otrl
Product idea; needs are identified and initial specifications are defined
Specific value:"OTRL-1"
Mature product concept has been formulated
Specific value:"OTRL-2"
Product model is developed
Specific value:"OTRL-3"
Full functional prototype is built and tested
Specific value:"OTRL-4"
Fairly reliable processes identified and characterized
Specific value:"OTRL-5"
Certificate marking conformity assessment or comparable
Specific value:"OTRL-6"
identifier of the applying Technology-specific Documentation Criteria (TsDC) according to DIN SPEC 3105-1 - get it from: https://w3id.org/oseg/ont/tsdc/core - multiple inputs possible (with one entry each)
Same definition as tsdcURL or repo-relative path to user manual
^https?://
^[a-z]*:
^//
(?:.*/)?\.\.(?:/.*)?
"Documentation/User_Guide/UserGuide.md"
version of this Module, preferably following the semantic versioning-scheme v2.0.0
"2.3.4"
"1.0.0-alpha"
"1.0.0-alpha.1"
"1.0.0-alpha.beta"
"1.0.0-beta"
"1.0.0-beta.2"
"1.0.0-beta.11"
"1.0.0-rc.1"
"1.0.0"
"0.0.1-24-g6a8a3a7"
"v0.3.1"
"6a8a3a7"
"baf0e65d8d93e1b64e883dfd2ffc5b838a22ca25"