Open Know-How

Open Source Hardware project metadata

Type object
File match okh.json okh.toml okh.yaml okh.yml *.okh.json *.okh.toml *.okh.yaml *.okh.yml
Schema URL https://catalog.lintel.tools/schemas/schemastore/open-know-how/latest.json
Source https://www.schemastore.org/okh.json

Validate with Lintel

npx @lintel/lintel check
Type: object

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.

Properties

function string required

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

Examples: "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."
license string required

A valid SPDX license expression

licensor stringMulti | agent[] | agent required

organization/individual behind the hardware design (holder of intellectual property)

Examples: "John Doe <[email protected]>", "Jane Doe (FSF) <[email protected]>", "Michael Mueller <[email protected]>", "Jinz Jixxer (OSI) <[email protected]>", "Pru Ner (GNU) <[email protected]>", ["John Doe <[email protected]>","Jane Doe (FSF) <[email protected]>"], {"email":"[email protected]","name":"John Doe"}, {"email":"[email protected]","memberOf":"FSF","name":"Jane Doe"}, [{"email":"[email protected]","name":"John Doe"},{"email":"[email protected]","memberOf":"FSF","name":"Jane Doe"}]
name string required

working title of the OSH Module or Part

okhv enum required

version of OKH specification the OSH projects metadata follows (different version → different data fields in this file). In the past this was 'OKH-LOSHv1.0' for a long time; now it should be a minor version release of the OKH spec, e.g. '2.4'.

Values: "OKH-LOSHv1.0" "2.3" "2.4"
repo string required
format=uripattern=^https?://
$schema string

Link to OKH JSON-Schema

Values: "https://json.schemastore.org/okh.schema.json" "https://w3id.org/oseg/schema/okh.schema.json"
auxiliary relPathOrWebUrlMulti

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)

Examples: "lib/lib1.lib", ".mdlrc", ["lib/lib1.lib",".mdlrc"]
bom relPathOrWebUrlMulti

URL or repo-relative path to the bill of materials

Examples: "sBoM.csv", "BOM.csv", "bom.csv"
contribution-guide string
Any of: webUrl string, relPath string
cpc-patent-class string | string[]
Examples: "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"]
documentation-language language[] | language

IETF BCP 47 language tag(s)

documentation-readiness-level const: "ODRL-1" | const: "ODRL-2" | const: "ODRL-3" | const: "ODRL-3*" | const: "ODRL-4"

ODRL-ID representing the development stage of the documentation; get it from: https://w3id.org/oseg/ont/otrl

Default: "ODRL-1"
export relPathOrWebUrlMulti

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)

Examples: "3D-parts/assembly.stp", "public/user-manual.pdf", ["3D-parts/assembly.stp","public/user-manual.pdf"]
forkOf string
format=uripattern=^https?://
image image | image[]
manufacturing-instructions relPathOrWebUrl | relPathOrWebUrl[]
mass number

Mass of the part in g (grams).

exclusiveMin=0
organization stringMulti | organization | organization[]
Examples: "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 object

Outer dimensions of the OSH module or part in mm (millimeters), which completely encompass the product.

3 nested properties
depth number required
exclusiveMin=0
height number required
exclusiveMin=0
width number required
exclusiveMin=0
part part[]

physical component(s) of this open source hardware module, for which technical documentation (design files etc.) is available under a free/open license

publication doiOrWebUrl | doiOrWebUrl[]
rdf object
2 nested properties
namespace string required
Examples: "http://w3id.org/my-org/projects/proj-x#", "http://w3id.org/my-comp/projects/proj-x#"
prefix string
Examples: "prjx", "myorg-prjx", "mycomp-prjx"
release string
Any of: webUrl string, relPath string
software software[]

associated software package(s) used to operate this piece of open source hardware

source relPathOrWebUrlMulti

relative or absolute path to source file (e.g. native CAD file);
multiple inputs possible (with one entry each)

Examples: "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"]
standard-compliance string | string[]
technology-readiness-level const: "OTRL-1" | const: "OTRL-2" | const: "OTRL-3" | const: "OTRL-4" | const: "OTRL-5" | const: "OTRL-6"

OTRL-ID representing the development stage of the OSH module; get it from: https://w3id.org/oseg/ont/otrl

Default: "OTRL-1"
tsdc stringMulti

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)

Examples: "ASM", "MEC", "CIR", "PCB", "WEL", "3DP", "LAS", "CNC", ["ASM","MEC","CIR"]
version string

version of this Module, preferably following the semantic versioning-scheme v2.0.0

Examples: "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"

All of

1. variant
2. variant

Definitions

agent person | organization

A person or organization

auxiliary relPathOrWebUrl | relPathOrWebUrl[]
bom relPathOrWebUrl | relPathOrWebUrl[]
cpcId string | string[]
Examples:
  • "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" ]
date string
Examples:
  • "2000-04-06"
  • "0001-0-0"
  • "1984-10-1"
doi string
Examples:
  • "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"
doiOrWebUrl doi | webUrl
doiOrWebUrlMulti doiOrWebUrl | doiOrWebUrl[]
export relPathOrWebUrl | relPathOrWebUrl[]
lang-text object

a text and the language it is written in

text string required

the text content

language string required

Language as a BCP 47 language tag

Examples: "en", "de", "es", "zh"
pattern=^(((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})+))$
image relPathOrWebUrl | imageObject
imageMulti image | image[]
imageObject object

a single image reference (project relative path or absolute URL), optionally with additional meta-data

Examples:
  • { "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/assets/media/img/photo-white-bg.png", "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/assets/media/img/photo-white-bg.png", "depicts": { "text": "A photo of the finished hardware, taken with a white background.", "language": "en" } }
  • { "location": "res/assets/media/img/photo-white-bg.png", "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" } ] }
location string required
Any of: webUrl string, relPath string
depicts string | lang-text | lang-text[]

Human 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
slots string[]

Denotes 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.

tags string[]

Links to a tag fit to describe the image. The available tags are predefined, see the OKH image tags; 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 have multiple tags and each tag can be used by multiple images even within a single project.

language string

Language as a BCP 47 language tag

Examples:
  • "en"
  • "de"
  • "es"
  • "zh"
languageMulti language[] | language

IETF BCP 47 language tag(s)

mass number

Mass of the part in g (grams).

name string

working title of the OSH Module or Part

organization object

An organization such as a school, NGO, corporation, club, etc.

email string
Examples: "[email protected]", "[email protected]", "[email protected]"
format=email
name string

Name of the organization

url string
format=uripattern=^https?://
organizationMulti stringMulti | organization | organization[]
Examples:
  • "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" } ]
outerDimensions object

Outer dimensions of the OSH module or part in mm (millimeters), which completely encompass the product.

depth number required
exclusiveMin=0
height number required
exclusiveMin=0
width number required
exclusiveMin=0
part object

a physical component of an open source hardware module, for which technical documentation (design files etc.) is available under a free/open license

name string required

working title of the OSH Module or Part

auxiliary relPathOrWebUrlMulti

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)

Examples: "lib/lib1.lib", ".mdlrc", ["lib/lib1.lib",".mdlrc"]
export relPathOrWebUrlMulti

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)

Examples: "3D-parts/assembly.stp", "public/user-manual.pdf", ["3D-parts/assembly.stp","public/user-manual.pdf"]
image image | image[]
mass number

Mass of the part in g (grams).

exclusiveMin=0
outer-dimensions object

Outer dimensions of the OSH module or part in mm (millimeters), which completely encompass the product.

3 nested properties
depth number required
exclusiveMin=0
height number required
exclusiveMin=0
width number required
exclusiveMin=0
source relPathOrWebUrlMulti

relative or absolute path to source file (e.g. native CAD file);
multiple inputs possible (with one entry each)

Examples: "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"]
tsdc stringMulti

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)

Examples: "ASM", "MEC", "CIR", "PCB", "WEL", "3DP", "LAS", "CNC", ["ASM","MEC","CIR"]
person object

A person (alive, dead, undead, or fictional)

email string
Examples: "[email protected]", "[email protected]", "[email protected]"
format=email
name string

Full name of the person

url string
format=uripattern=^https?://
rdfNamespace object
namespace string required
Examples: "http://w3id.org/my-org/projects/proj-x#", "http://w3id.org/my-comp/projects/proj-x#"
prefix string
Examples: "prjx", "myorg-prjx", "mycomp-prjx"
relPath string
relPathOrWebUrl string
relPathOrWebUrlMulti relPathOrWebUrl | relPathOrWebUrl[]
software object
release string required
Any of: webUrl string, relPath string
installation-guide string
Any of: webUrl string, relPath string
source relPathOrWebUrl | relPathOrWebUrl[]
spdxLicenseExpression string

A valid SPDX license expression

stringMulti string | string[]
tsdc string | string[]
webUrl string
webUrlMulti webUrl | webUrl[]