equipment/generic_equipment-1.0.0¶

A generic piece of equipment.

Description

Generic placeholder class do describe any kind of equipment with additional metadata. Equipments can be associated with signal sources and data transformations.

Outline

Schema Definitions Examples Original Schema

Schema Definitions ¶

This type is an object with the following properties:

name
string Required
No length restriction
sources
array
No length restriction
Items in the array are restricted to the following types:
data_transformations
array
No length restriction
Items in the array are restricted to the following types:

Examples ¶

A analog to digital conversion equipment with a linear signal transformation.:

!<tag:weldx.bam.de:weldx/equipment/generic_equipment-1.0.0>
  name: Beckhoff ELM3002-0000
  sources: []
  data_transformations:
  - &id004 !<tag:weldx.bam.de:weldx/measurement/data_transformation-1.0.0>
    name: AD conversion current measurement
    input_signal: !<tag:weldx.bam.de:weldx/measurement/signal-1.0.0>
        signal_type: analog
        unit: V
    output_signal: !<tag:weldx.bam.de:weldx/measurement/signal-1.0.0>
      signal_type: digital
      unit: ''
    error: !<tag:weldx.bam.de:weldx/measurement/error-1.0.0>
      deviation: !unit/quantity-1.1.0 {unit: percent, value: 0.01}
    func: !<tag:weldx.bam.de:weldx/core/mathematical_expression-1.0.0>
      expression: a*x + b
      parameters:
        a: !unit/quantity-1.1.0 {unit: 1 / volt, value: 3276.8}
        b: !unit/quantity-1.1.0 {unit: dimensionless, value: 0.0}

Original Schema ¶

%YAML 1.1
---
$schema: "http://stsci.edu/schemas/yaml-schema/draft-01"
id: "http://weldx.bam.de/schemas/weldx/equipment/generic_equipment-1.0.0"
tag: "tag:weldx.bam.de:weldx/equipment/generic_equipment-1.0.0"

title: |
  A generic piece of equipment.
description: |
  Generic placeholder class do describe any kind of equipment with additional metadata.
  Equipments can be associated with signal sources and data transformations.

examples:
  -
    - A analog to digital conversion equipment with a linear signal transformation.
    - |
      !<tag:weldx.bam.de:weldx/equipment/generic_equipment-1.0.0>
        name: Beckhoff ELM3002-0000
        sources: []
        data_transformations:
        - &id004 !<tag:weldx.bam.de:weldx/measurement/data_transformation-1.0.0>
          name: AD conversion current measurement
          input_signal: !<tag:weldx.bam.de:weldx/measurement/signal-1.0.0>
              signal_type: analog
              unit: V
          output_signal: !<tag:weldx.bam.de:weldx/measurement/signal-1.0.0>
            signal_type: digital
            unit: ''
          error: !<tag:weldx.bam.de:weldx/measurement/error-1.0.0>
            deviation: !unit/quantity-1.1.0 {unit: percent, value: 0.01}
          func: !<tag:weldx.bam.de:weldx/core/mathematical_expression-1.0.0>
            expression: a*x + b
            parameters:
              a: !unit/quantity-1.1.0 {unit: 1 / volt, value: 3276.8}
              b: !unit/quantity-1.1.0 {unit: dimensionless, value: 0.0}

type: object
properties:
  name:
    type: string
  sources:
    type: array
    items:
      $ref: "tag:weldx.bam.de:weldx/measurement/source-1.0.0"
  data_transformations:
    type: array
    items:
      $ref: "tag:weldx.bam.de:weldx/measurement/data_transformation-1.0.0"

propertyOrder: [name, sources, data_transformations]
required: [name]

flowStyle: block
...