Catalogs
The words a project defines for itself: kinds, layers, tags, colours and port types.
On this page: kind · layer · tag · color · port-type · wire
The project vocabulary: kinds, layers, tags, colors and port types. Undeclared kinds, layers and tags that are used are added automatically.
kind#
An element kind for the kinds catalog (kinds.yaml).
- Keywords:
kind - Set: the model
- Where: top level
- Syntax:
kind id "Label" { icon "«P»" }
| Property | Value | Meaning |
|---|---|---|
description |
text | Prose description. $…$ and $$…$$ are LaTeX math; a ```latex block is kept as LaTeX. |
icon |
string | Short icon text shown on the canvas. |
color |
color name | A palette color id, or a literal "#rrggbb". |
kind ecu "ECU" { icon "«E»"; description "Electronic control unit." }
layer#
An abstraction layer (layers.yaml). Declare most abstract first: the order is the meaning.
- Keywords:
layer - Set: the model
- Where: top level
- Syntax:
layer id "Label"
| Property | Value | Meaning |
|---|---|---|
description |
text | Prose description. $…$ and $$…$$ are LaTeX math; a ```latex block is kept as LaTeX. |
layer logical "Logical"
layer physical "Physical"
tag#
A tag for the tag catalog (tags.yaml).
- Keywords:
tag - Set: the model
- Where: top level
- Syntax:
tag id "Label" { group status }
| Property | Value | Meaning |
|---|---|---|
description |
text | Prose description. $…$ and $$…$$ are LaTeX math; a ```latex block is kept as LaTeX. |
color |
color name | A palette color id, or a literal "#rrggbb". |
group |
ident | Tag type (tag-types.yaml) the tag belongs to. |
tag safety "Safety-critical" { group domain; color red }
color#
A palette color (colors.yaml). One value, or light/dark per theme.
- Keywords:
color(old spelling:colour) - Set: the model
- Where: top level
- Syntax:
color id = "#rrggbb" | color id { light "#…"; dark "#…" }
| Property | Value | Meaning |
|---|---|---|
light |
string | Light-theme value. |
dark |
string | Dark-theme value. |
color brand = "#0b6e4f"
color alert { light "#c62828"; dark "#ef5350" }
port-type#
A port type (types.yaml): the kind of connection a port offers, with its wires and timing.
- Keywords:
port-type(old spellings:porttype,bus) - Set: the model
- Where: top level
- Syntax:
port-type id "Label" { color …; handling message; wire … }
| Property | Value | Meaning |
|---|---|---|
description |
text | Prose description. $…$ and $$…$$ are LaTeX math; a ```latex block is kept as LaTeX. |
color |
color name | A palette color id, or a literal "#rrggbb". |
handling |
http | message |
What an in port of this type answers: http (method+path) or message. |
latency |
duration | Transit latency (simulation timing). |
bitrate |
any | Bitrate in bit/s, e.g. 1Mbps or 1000000. |
jitter |
duration | Random jitter added to latency. |
memory-mapped |
bool | A memory-mapped bus (AXI, a register file): its ports are read and written as addresses (Arche memoryMapped). |
potential |
any | A physical port's potential (across) variable and its unit: equal at every port linked together (a voltage, a velocity, a temperature, a pressure). A port type with a potential and a flow is physical: its links connect parts with no direction, and archec physics solves the network. |
flow |
any | A physical port's flow (through) variable and its unit: the flows into the ports linked together add up to zero (Kirchhoff). Positive into the part. |
port-type can-fd "CAN FD" {
color amber
handling message
bitrate 2Mbps
wire canh "CAN_H" inout
wire canl "CAN_L" inout
}
wire#
One conductor of a port type.
- Keywords:
wire - Set: the model
- Where: inside
port-type - Syntax:
wire id "Name" [in|out|inout] { signal "3V3 CMOS" }
| Property | Value | Meaning |
|---|---|---|
description |
text | Prose description. $…$ and $$…$$ are LaTeX math; a ```latex block is kept as LaTeX. |
signal |
string | Electrical signal standard. |
wire sclk "SCLK" out { signal "3V3 CMOS" }