Housings#

How to describe cell housings: a housing-spec is the case set as a product (a CR2032 kit: case, cap, spring, spacer), a housing instance is one physical batch. A cell references it through housing_spec_id, or describes its housing inline.

The spec is the case set as a product (case, cap, terminals, seals, parts); an instance is one physical batch.
The record is the enclosure ASSEMBLY - the case is one part among cap, terminals, seals, and hardware, all listed uniformly under hasConstituent in JSON-LD; cell_format picks the case class (CoinCase, CylindricalCase, …).
parts[] entries type as their EMMO classes (Spring, Spacer, Gasket, SafetyVent, …).
Author with create_housing_spec(...) / create_housing(spec_id=...).

Define one#

The product#

Python

from battinfo.api import create_housing_spec

record = create_housing_spec(
    uid="w2n8-6rkt-4mpv-8hcq",
    name="CR2032 coin housing",
    cell_format="coin",
    case={
        "size_code": "2032",
        "material": "Stainless steel",
        "property": {
            "diameter": {"value": 20, "unit": "mm"},
            "height": {"value": 3.2, "unit": "mm"},
        },
    },
    parts=[
        {"type": "spring", "material": "Stainless steel"},
        {"type": "spacer", "material": "Stainless steel"},
    ],
    source_type="datasheet",
)

Canonical record

{
  "schema_version": "0.2.0",
  "housing_spec": {
    "id": "https://w3id.org/battinfo/spec/7d9k-2m4p-8t3x-6nq5",
    "short_id": "7d9k2m",
    "name": "CR2032 coin housing",
    "cell_format": "coin",
    "case": {
      "size_code": "2032",
      "material": "Stainless steel",
      "property": {
        "diameter": {
          "value": 20,
          "unit": "mm"
        },
        "height": {
          "value": 3.2,
          "unit": "mm"
        }
      }
    },
    "parts": [
      {
        "type": "spring",
        "material": "Stainless steel"
      },
      {
        "type": "spacer",
        "material": "Stainless steel"
      }
    ]
  },
  "provenance": {
    "source_type": "datasheet",
    "retrieved_at": 1750000000,
    "battinfo_version": "0.7.0"
  }
}

JSON-LD

Emitted by record_to_jsonld, hosted-context mode.

{
  "@context": [
    "https://w3id.org/emmo/domain/battery/context",
    {
      "schema": "https://schema.org/",
      "dcterms": "http://purl.org/dc/terms/",
      "battinfo": "https://w3id.org/battinfo/"
    }
  ],
  "@type": [
    "Description",
    "schema:ProductModel",
    "schema:CreativeWork"
  ],
  "isDescriptionFor": {
    "@type": [
      "ElectrochemicalComponent",
      "schema:Product"
    ],
    "hasConstituent": [
      {
        "@type": "CoinCase",
        "schema:size": "2032",
        "schema:material": "Stainless steel",
        "hasProperty": [
          {
            "@type": [
              "Diameter",
              "ConventionalProperty"
            ],
            "skos:prefLabel": "Diameter",
            "hasNumericalPart": {
              "@type": "RealData",
              "hasNumberValue": 20
            },
            "hasMeasurementUnit": "https://w3id.org/emmo#MilliMetre"
          },
          {
            "@type": [
              "Height",
              "ConventionalProperty"
            ],
            "skos:prefLabel": "Height",
            "hasNumericalPart": {
              "@type": "RealData",
              "hasNumberValue": 3.2
            },
            "hasMeasurementUnit": "https://w3id.org/emmo#MilliMetre"
          }
        ]
      },
      {
        "@type": "Spring",
        "schema:material": "Stainless steel"
      },
      {
        "@type": "Spacer",
        "schema:material": "Stainless steel"
      }
    ],
    "skos:prefLabel": "CR2032 coin housing",
    "@id": "https://w3id.org/battinfo/spec/7d9k-2m4p-8t3x-6nq5#described"
  },
  "@id": "https://w3id.org/battinfo/spec/7d9k-2m4p-8t3x-6nq5",
  "schema:name": "CR2032 coin housing"
}

A physical batch#

Python

from battinfo.api import create_housing

record = create_housing(
    uid="x4fm-9tpk-2wqv-5nrh",
    spec_id="https://w3id.org/battinfo/spec/w2n8-6rkt-4mpv-8hcq",
    lot_id="CR2032-KIT-2026-07",
)

Canonical record

{
  "schema_version": "0.2.0",
  "housing": {
    "id": "https://w3id.org/battinfo/housing/7d9k-2m4p-8t3x-6nq5",
    "housing_spec_id": "https://w3id.org/battinfo/spec/y9xy-kr0v-y5tn-dfj7",
    "short_id": "7d9k2m",
    "lot_id": "CR2032-KIT-2026-07"
  },
  "provenance": {
    "source_type": "lab",
    "retrieved_at": 1750000000,
    "battinfo_version": "0.7.0"
  }
}

JSON-LD

Emitted by record_to_jsonld, hosted-context mode.

{
  "@context": [
    "https://w3id.org/emmo/domain/battery/context",
    {
      "schema": "https://schema.org/",
      "dcterms": "http://purl.org/dc/terms/",
      "battinfo": "https://w3id.org/battinfo/"
    }
  ],
  "@type": [
    "ElectrochemicalComponent",
    "schema:Product"
  ],
  "@id": "https://w3id.org/battinfo/housing/7d9k-2m4p-8t3x-6nq5",
  "schema:isVariantOf": {
    "@id": "https://w3id.org/battinfo/spec/y9xy-kr0v-y5tn-dfj7"
  }
}

Fields#

Generated from the packaged JSON Schemas — the same files battinfo validate and the registry’s publish gate enforce. Every record also carries the shared envelope (schema_version, provenance, and optional notes, funding, contributor, license). Quantities are {value, unit} maps and may also carry value_basis (Measured, Conventional, Rated, or Nominal) and conditions (the parameters under which the value holds, each itself a quantity; a qualitative condition may be value_text alone). In JSON-LD, conditions ride a measurement node the quantity isOutputOf; the voltage_reference key instead becomes a hasMetrologicalReference datum on the quantity, beside its unit. When authoring, an instance references its spec with the spec_id= kwarg; the record stores the self-describing <type>_spec_id key shown in the tables below.

housing-spec fields#

Schema: housing-spec.schema.json · required at top level: schema_version, housing_spec, provenance

Field	Type	Required	Description
`id`	→ ComponentSpecIri	yes
`short_id`	→ ShortId
`name`	string	yes	Human-readable name of this housing design (e.g. ‘CR2032 SS316L case’).
`cell_format`	`coin` \| `cylindrical` \| `pouch` \| `prismatic` … (6 values)		Cell format this housing is for.
`case`	→ Case		Main case or can of the housing.
`cap`	→ HardwarePart		Cap or lid part.
`terminals`	array of → Terminal		Electrical terminals, with polarity and material.
`seals`	array of → Seal		Seals and gaskets.
`parts`	array of → HardwarePart		Other hardware parts (springs, spacers, …).
`property`	→ quantitative-properties		Named quantity map of housing-level properties (e.g. mass, wall_thickness). See the property keys reference for the full list of recognised keys.
`manufacturer`	→ OrgRef		Manufacturer of the item.
`supplier`	→ OrgRef		Supplier or vendor the item was sourced from.
`product_id`	string		Manufacturer or supplier product/grade identifier.
`comment`	string		Free-text comment.

housing fields#

Schema: housing.schema.json · required at top level: schema_version, housing, provenance

Field	Type	Required	Description
`id`	→ ComponentIri	yes
`housing_spec_id`	→ ComponentSpecIri	yes	IRI of the housing-spec this physical housing realizes.
`short_id`	→ ShortId
`name`	string		Human-readable label for this physical item (e.g. a lab inventory id).
`lot_id`	string		Manufacturer or supplier lot number.
`batch_id`	string		Internal lab batch identifier, when different from the supplier lot.
`supplier`	→ OrgRef		Supplier or vendor the item was sourced from.
`manufactured_at`	→ FlexDate		Date this item was manufactured.
`datasets`	array of → DatasetLink		Characterization datasets recorded for this physical item.
`property`	→ quantitative-properties		Named quantity map of technical properties (snake_case key to value+unit quantity).
`comment`	string		Free-text comment.