Equipment#

How to describe lab equipment: the product as an equipment spec, each bench unit as equipment, each addressable slot as a channel.

Spec = the product; equipment = one bench unit (serial, location); channel = one addressable slot on a unit.
Channel identity is deterministic from (unit, index): re-registering a bench never duplicates channels.
Tests point at the unit and channel via equipment_id / channel_id.

Define one#

An equipment spec (the product)#

Python

from battinfo.api import create_equipment_spec

record = create_equipment_spec(
    id="https://w3id.org/battinfo/spec/7d9k-2m4p-8t3x-6nq5",
    name="SkyRC MC3000",
    manufacturer="SkyRC",
    model="MC3000",
    equipment_class="cycler",          # category is data, never a namespace
    channel_count=4,
    supported_chemistries=["NiMH", "Li-ion", "LiFePO4", "Na-ion"],
)

Canonical record

{
  "schema_version": "0.2.0",
  "equipment_spec": {
    "id": "https://w3id.org/battinfo/spec/7d9k-2m4p-8t3x-6nq5",
    "short_id": "7d9k2m",
    "name": "SkyRC MC3000",
    "equipment_class": "cycler",
    "model": "MC3000",
    "channel_count": 4,
    "supported_chemistries": [
      "NiMH",
      "Li-ion",
      "LiFePO4",
      "Na-ion"
    ],
    "manufacturer": {
      "type": "Organization",
      "name": "SkyRC"
    }
  },
  "provenance": {
    "source_type": "datasheet",
    "retrieved_at": 1750000000,
    "battinfo_version": "0.7.0"
  }
}

Known gap

No JSON-LD emitter exists for equipment records yet; the canonical record is the published form.

An equipment unit#

Python

from battinfo.api import create_equipment

record = create_equipment(
    id="https://w3id.org/battinfo/equipment/y9xy-kr0v-y5tn-dfj7",
    spec_id="https://w3id.org/battinfo/spec/7d9k-2m4p-8t3x-6nq5",
    serial_number="MC3K-2026-0001",
    name="Cycler 1",
    location="Lab B",
    status="active",
)

Canonical record

{
  "schema_version": "0.2.0",
  "equipment": {
    "id": "https://w3id.org/battinfo/equipment/y9xy-kr0v-y5tn-dfj7",
    "equipment_spec_id": "https://w3id.org/battinfo/spec/7d9k-2m4p-8t3x-6nq5",
    "short_id": "y9xykr",
    "serial_number": "MC3K-2026-0001",
    "name": "Cycler 1",
    "location": "Lab B",
    "status": "active"
  },
  "provenance": {
    "source_type": "lab",
    "retrieved_at": 1750000000,
    "battinfo_version": "0.7.0"
  }
}

Known gap

No JSON-LD emitter exists for equipment records yet.

A channel on that unit#

Python

from battinfo.api import create_channel

# The channel uid is deterministic from (unit, index): registering the
# same bench twice never duplicates channels.
record = create_channel(
    equipment_id="https://w3id.org/battinfo/equipment/y9xy-kr0v-y5tn-dfj7",
    index=1,
    label="MC3000-A/CH1",
)

Canonical record

{
  "schema_version": "0.2.0",
  "channel": {
    "id": "https://w3id.org/battinfo/channel/7d9k-2m4p-8t3x-6nq5",
    "equipment_id": "https://w3id.org/battinfo/equipment/y9xy-kr0v-y5tn-dfj7",
    "index": 1,
    "short_id": "7d9k2m",
    "label": "MC3000-A/CH1"
  },
  "provenance": {
    "source_type": "lab",
    "retrieved_at": 1750000000,
    "battinfo_version": "0.7.0"
  }
}

Known gap

No JSON-LD emitter exists for channel records yet.

Common examples#

A selection of real, validated records from the packaged examples corpus — each one click away, included from its single source under examples/. The full, living library is the registry: browse it there.

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.

equipment-spec fields#

Schema: equipment-spec.schema.json · required at top level: schema_version, equipment_spec, provenance

Field	Type	Required
`id`	→ SpecIri	yes
`short_id`	→ ShortId
`name`	string	yes
`equipment_class`	string
`model`	string
`channel_count`	integer
`supported_chemistries`	array of string
`property`	→ quantitative-properties
`manufacturer`	→ OrgRef
`supplier`	→ OrgRef
`product_id`	string
`comment`	string

equipment fields#

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

Field	Type	Required
`id`	→ EquipmentIri	yes
`equipment_spec_id`	→ SpecIri	yes
`short_id`	→ ShortId
`serial_number`	string
`name`	string
`location`	string
`commissioned_at`	→ FlexDate
`status`	`active` \| `maintenance` \| `retired` \| `unknown`
`property`	→ quantitative-properties
`comment`	string

channel fields#

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

Field	Type	Required
`id`	→ ChannelIri	yes
`equipment_id`	→ EquipmentIri	yes
`index`	integer	yes
`short_id`	→ ShortId
`label`	string
`status`	`active` \| `maintenance` \| `retired` \| `unknown`
`property`	→ quantitative-properties
`comment`	string