Open Know How (OKH) ontology

Either a module (MOSH) or Part (POSH); more component types may be added in the future

• module ^c
• part ^c
• software ^c

… of a module or a part; This follows the same logic as the "bounding-box" in computer graphics, but in the physical world. This is commonly used to calculate (or at least estimate) how many items of a manufactured module or part can be packed into storage space of known dimensions.

• http://purl.org/dc/dcmitype/StillImage
• http://schema.org/ImageObject
• http://w3id.org/oseg/ont/ods#File
• http://xmlns.com/foaf/0.1/Image

source file holding this projects OKH data in TOML format, from which RDF is generated

• http://schema.org/TextDigitalDocument
• http://w3id.org/oseg/ont/ods#File

Module of Open Source Hardware (MOSH)

Piece of Open Source Hardware (POSH)

scientific (that is: peer reviewed) publication that contains the design files

Software (including firmware) needed to run & use the OSH

• http://purl.org/dc/dcmitype/Software
• component ^c

official standard used in the design (not e.g. DIN SPEC 3105-1)

Metadata addressing functionality, such as dimensions, material, weight, RPM,… (not standardized)

production-relevant metadata, such as material, manufacturing technology, outer dimensions, smallest tolerance, finest surface roughness

• mass [g] ^dp
• outer dimensions ^op
• manufacturing process ^dp
• material ^dp
• smallest tolerance class ^op

Links to a standard the subject complies with

Indicates the development stage of the documentation using the ODRL definitions; see the OTRL ontology.

• http://w3id.org/oseg/ont/otrl#ODRL1
• http://w3id.org/oseg/ont/otrl#ODRL2
• http://w3id.org/oseg/ont/otrl#ODRL3
• http://w3id.org/oseg/ont/otrl#ODRL3Star
• http://w3id.org/oseg/ont/otrl#ODRL4

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.

Indicates that this project was split of (aka forked) from an other project at some point in the past

This links to files associated with the subject, which classify neither as source nor as export, but are still useful in the repository

• https://file-hosting-service.org/accounts/my_project/res/media/img/project_logo.svg

• kicad_libs/cool_3rd_party_parts.lib

• res/media/img/project_logo.svg

• res/txt/usage_stats.csv

links to the corresponding Bill of Materials, which is a list or table of the parts required to build a component

• bom.csv

• src/elec/bom.csv

• src/mech/bom.csv

Links to sub-components of the Module. In the case of that sub-component being an external Module, it has to refer to a snapshot of the RDF object representing that OKH Module. Each sub-component should also appear in the BoM.

links to the corresponding Contribution Guide

Links to a file that was generated/exported from a source file of the project

• gen/elec/converter/pcb.svg

• gen/elec/converter/schema.svg

• gen/mech/3D-parts/drawing.pdf

• gen/mech/3D-parts/drawing.png

• gen/mech/3D-parts/model2.stl

• gen/mech/3D-parts/part1.stp

• https://file-hosting-service.org/accounts/my_project/gen/elec/converter/pcb.svg
• https://my-orgs-server.org/projects/my_project/gen/mech/3D-parts/model2.stl
• https://my-projs-server.org/files/gen/mech/3D-parts/part1.stp

links to the corresponding Image

Links to the source TOML manifest file for (this) RDF data

Links to a file containing a manual/instructions of some kind, that explain how to manufacture the hardware.

doc/assembly/main.md

defined through width, depth and height in mm

• Format ^p
• production metadata ^p

design files of this OSH module have been peer reviewed in the linked-to scientific publication

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

• README

• README-JP

• README-JP.md

• README.md

• README.txt

Links to a file that forms part of the sources of the project; meaning, these are the primary files the designers and other contributors of the project are working on.

• https://my-orgs-server.org/projects/my_project/src/mech/3D-parts/model2.fcstd
• https://my-projs-server.org/files/src/elec/converter/proj1.kicad_pro
• https://repo-hosting-service.org/accounts/my_account/my_project/src/mech/3D-parts/part1.fcstd

• src/elec/converter/proj1.kicad_pro

• src/mech/3D-parts/model2.fcstd

• src/mech/3D-parts/part1.fcstd

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.

doc/usr/main.md

organization of the licensor or that represents (some of) the contributors of the project

according to the ISO 286 standard

Indicates the development stage of the hardware design using the OTRL definitions; see the OTRL ontology.

• http://w3id.org/oseg/ont/otrl#OTRL1
• http://w3id.org/oseg/ont/otrl#OTRL2
• http://w3id.org/oseg/ont/otrl#OTRL3
• http://w3id.org/oseg/ont/otrl#OTRL4
• http://w3id.org/oseg/ont/otrl#OTRL5
• http://w3id.org/oseg/ont/otrl#OTRL6

Applicable Technology-specific Documentation Criteria, according to DIN SPEC 3105-1, e.g. tsdc:3DP

• http://w3id.org/oseg/ont/tsdc/core#3DP
• http://w3id.org/oseg/ont/tsdc/core#ASM
• http://w3id.org/oseg/ont/tsdc/core#CMP

connects specific versions of Modules with their versionless superclass

A permanent URL to a valid attestation; evidence of completeness and compliance to OSH principles, for example from OSHWA, FSF, or DIN SPEC 3105.

Issuing conformity assessment bodies according to DIN SPEC 3105-2:

• Open Hardware Observatory
• Open Source Ecology Germany

OSHWA:

• OSHWA certification programme

FSF (computing only):

• Hardware Devices that Support GNU/Linux

Cooperative Patent Classification identifier (CPC-ID) of the International Patent Classification (IPC) that describes best the field of technology of the OSH module. To find the meaning of one, or to find one fitting to your project, please use this resource: https://worldwide.espacenet.com/classification

D03D 35/00

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 not available
• to be able to put it as a caption next to the image

• Description ^p
• http://schema.org/abstract
• http://xmlns.com/foaf/0.1/depicts

The outer depth of the product

denotes the language of the documentation. The concrete format is an IETF language tag following the BCP 47 standard; e.g. "en-GB"

• de

• de-DE

• en

• en-GB

• en-US

• es

The digital object identifier (DOI) associated with the publication

What does the hardware actually do, what problem does it solve, for whom, under which conditions etc.

If you wish that someone finds & uses your OSH - specifically e.g. for solving a concrete medical issue - include relevant keywords in this field.

Optional: description of input, output and interfaces

mass of the component in g

The outer height of the product

Working title of the OSH component

• Title ^p
• label ^ap

The version of the OKH specification the OSH projects metadata claims to follow. Different version → different data fields in this file. This describes the scraped-dataset, so it refers to the OKH version the original meta-data at the source adheres to, meaning the e.g. the TOML manifest manually created yb the project maintainers, or the OKH v1 YAML manifest generated by the hosting platforms API.

The OKH version the final RDF data adheres to, is specified by the OKH IRI it uses, and simultaneously by the version defined in the owl:Ontology element that is located at that IRI.

In general, this property will link to the same or an earlier version of the OKH spec, compared to the version defined by the OKH namespace IRI in the RDF version of a projects data.

URL to release

document identifier for the technical standard

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

• 0.0.1-24-g6a8a3a7

• 1.0.0

• 1.0.0-alpha

• 1.0.0-alpha.1

• 1.0.0-alpha.beta

• 1.0.0-beta

• 1.0.0-beta.11

• 1.0.0-beta.2

• 1.0.0-rc.1

• 2.3.4

• 6a8a3a7

• baf0e65d8d93e1b64e883dfd2ffc5b838a22ca25

• v0.3.1

The outer width of the product