si-schema v0.1.0
Schema reference

Enums

The fixed vocabularies used across si-schema. Validators must enforce these; subcategories stay free-text so the schema can grow with projects.

Download si_schema.schema.json Download vendor.si_schema.schema.json

FunctionCategory — six top-level categories

CategoryMeaningSuggested subcategories
commandActuation request issued by the control authority.Start/Stop, Speed reference, Power reference
permissionInterlock / readiness / authorisation condition.Start Permission, Shaft Lock status, Ready/Not ready
feedbackMeasured/observed value reported back from the actuator.Speed, Power, Position, Status
protectionSafety-related trip / shutdown / emergency signal.Emergency Stop, Trip/Shutdown
modeOperating-mode selection or indication.Local/Remote, Main/Backup, Gas/Diesel
monitoringContinuous condition monitoring (non-safety).Power flow, Available power, Temperature, Overload, Voltage

Other enums (current schema)

enums.yaml
YAML
LinkType:
  - hardwired
  - serial
  - network       # Ethernet / fieldbus
  - wireless

SignalType:
	- digital
	- analog
	- can
	- i2c
	- 1-wire
	- uart

SignalCategory:
	- command
	- permission_interlock
	- feedback
	- safety
	- mode
	- monitoring

PortDirection:
	- in
	- out
	- undefined

PortType:
	- signal
	- can_tc
	- analog
	- resistor
	- 4-20mA
	- 0-10V
	- serial
	- network

ConnectionType:
	- physical
	- logical
	- control
	- data
	- status

MappingKind:
	- discrete
	- linear

Direction:
	- in
	- out

DataType:
  - digital
  - analog_4_20ma
  - analog_0_10v
  - analog_potentiometer
  - serial
  - network

SignalSubtype:
  # digital
  - no             # normally open
  - nc             # normally closed
  - steady
  - pulse
  # analog
  - sine_cosine
  - single_ended
  - differential

ArtifactRole:
	- si_internal
	- integration_contract
	- exchange_projection

ArtifactStatus:
	- draft
	- released
	- deprecated
	- withdrawn

CompatibilityClass:
	- none
	- backward
	- forward
	- full

PartyKind:
	- vendor
	- integrator
	- shipyard
	- shipowner
	- class_society
	- analytics_provider
	- operator

ProtocolFamily:
	- modbus_rtu
	- modbus_tcp
	- canopen
	- nmea0183
	- nmea2000
	- opcua
	- profinet
	- ethernet_ip
	- vendor_specific

ExchangePattern:
	- cyclic
	- polled
	- event_driven
	- handshake

AccessMode:
	- read
	- write
	- read_write

OperatingMode:
	- local
	- remote
	- auto
	- manual
	- degraded
	- emergency

AlarmPriority:
	- critical
	- high
	- medium
	- low

LifecycleState:
	- active
	- deprecated
	- withdrawn

TransformationRule:
	- sample
	- average
	- derive
	- filter
	- threshold
	- command
	- passthrough

ProvenanceKind:
	- measured
	- computed
	- estimated
	- inferred
	- manual

AggregationType:
	- instantaneous
	- average
	- minimum
	- maximum
	- sum

SignalOrderConvention:
  - "SC"          # Start Condition (precondition / interlock)
  - "TC"          # Trip Condition (safety trip; evaluated continuously)
  - "<n>"         # plain ordinal step
  - "<n>-Main"
  - "<n>-Backup"
  - "<n>-Start"
  - "<n>-Stop"

# ── Contract-layer enums (physical link, network, addressing) ──

InterfaceMedium:
  - hardwired
  - serial
  - network
  - wireless

ContactType:
  - dry
  - wet

LogicType:
  - sourcing
  - sinking
  - differential
  - isolated

WireCount:
  - 2_wire
  - 3_wire
  - 4_wire

RedundancyRole:
  - none
  - primary
  - secondary
  - dual_homed

SecurityMode:
  - none
  - tls
  - dtls
  - vpn

TimeSyncSource:
  - none
  - ntp
  - ptp
  - gps

AddressingKind:
  - modbus
  - canopen
  - nmea0183
  - nmea2000
  - opcua
  - vendor
Release note. Enums span both the original SI signal model and the contract layer (artifact governance, protocol bindings, lifecycle, lineage and semantic provenance).