DmPeripheralInstance

EXPERIMENTAL

Experimental

caution

Not production-ready. It may change or be removed without notice. See Lifecycle.

A concrete instance of a peripheral (e.g., SCI0), including available modes.

Common Data Model

• PeripheralInstance — A concrete instance of a peripheral (e.g., SCI0), including available modes.
  • IRI: https://w3id.org/altium/cdm/deviceModel/PeripheralInstance

Member Of

DmAddressBlock object ● DmPeripheral object ● DmPeripheralChanges object

type DmPeripheralInstance {
  addressBlocks: [DmAddressBlock!]!
  channel: String!
  id: String!
  interfaceType: String
  modes: [DmPeripheralMode!]!
  name: String!
  softwareDriverId: String!
  softwareDriverIds: [String!]!
  virtualization: String!
}

Fields

addressBlocks ● [DmAddressBlock!]! non-null object

Address block for the instance.

channel ● String! non-null scalar

The specific channel number or instance identifier for the hardware peripheral (e.g., '0' for CAN0, '3' for GPT3).

id ● String! non-null scalar

Identifier for the peripheral instance.

interfaceType ● String scalar

The logical interface exposed by this peripheral (e.g., UART, I2C, SPI, ADC, PWM).

modes ● [DmPeripheralMode!]! non-null object

Operational modes supported by this peripheral instance.

name ● String! non-null scalar

Display name of the peripheral instance.

softwareDriverId ● String! non-null scalar

ID of configured software driver for the peripheral.

softwareDriverIds ● [String!]! non-null scalar

IDs of available software drivers for the peripheral.

virtualization ● String! non-null scalar

Specifies how this peripheral instance is virtualized, indicating whether the instance represents a single, non-virtualized peripheral or a channel-virtualized peripheral where individual functions act as separate interface instances.